/*
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
* Licensed under the MIT License.
|
*/
|
|
import { NetworkResponse } from "./NetworkResponse.js";
|
import { ServerAuthorizationTokenResponse } from "../response/ServerAuthorizationTokenResponse.js";
|
import * as Constants from "../utils/Constants.js";
|
import { CacheManager } from "../cache/CacheManager.js";
|
import { ServerError } from "../error/ServerError.js";
|
import {
|
getRequestThumbprint,
|
RequestThumbprint,
|
} from "./RequestThumbprint.js";
|
import { ThrottlingEntity } from "../cache/entities/ThrottlingEntity.js";
|
import { BaseAuthRequest } from "../request/BaseAuthRequest.js";
|
|
/** @internal */
|
export class ThrottlingUtils {
|
/**
|
* Prepares a RequestThumbprint to be stored as a key.
|
* @param thumbprint
|
*/
|
static generateThrottlingStorageKey(thumbprint: RequestThumbprint): string {
|
return `${Constants.THROTTLING_PREFIX}.${JSON.stringify(thumbprint)}`;
|
}
|
|
/**
|
* Performs necessary throttling checks before a network request.
|
* @param cacheManager
|
* @param thumbprint
|
*/
|
static preProcess(
|
cacheManager: CacheManager,
|
thumbprint: RequestThumbprint,
|
correlationId: string
|
): void {
|
const key = ThrottlingUtils.generateThrottlingStorageKey(thumbprint);
|
const value = cacheManager.getThrottlingCache(key, correlationId);
|
|
if (value) {
|
if (value.throttleTime < Date.now()) {
|
cacheManager.removeItem(key, correlationId);
|
return;
|
}
|
throw new ServerError(
|
value.errorCodes?.join(" ") || "",
|
value.errorMessage,
|
value.subError
|
);
|
}
|
}
|
|
/**
|
* Performs necessary throttling checks after a network request.
|
* @param cacheManager
|
* @param thumbprint
|
* @param response
|
*/
|
static postProcess(
|
cacheManager: CacheManager,
|
thumbprint: RequestThumbprint,
|
response: NetworkResponse<ServerAuthorizationTokenResponse>,
|
correlationId: string
|
): void {
|
if (
|
ThrottlingUtils.checkResponseStatus(response) ||
|
ThrottlingUtils.checkResponseForRetryAfter(response)
|
) {
|
const thumbprintValue: ThrottlingEntity = {
|
throttleTime: ThrottlingUtils.calculateThrottleTime(
|
parseInt(
|
response.headers[Constants.HeaderNames.RETRY_AFTER]
|
)
|
),
|
error: response.body.error,
|
errorCodes: response.body.error_codes,
|
errorMessage: response.body.error_description,
|
subError: response.body.suberror,
|
};
|
cacheManager.setThrottlingCache(
|
ThrottlingUtils.generateThrottlingStorageKey(thumbprint),
|
thumbprintValue,
|
correlationId
|
);
|
}
|
}
|
|
/**
|
* Checks a NetworkResponse object's status codes against 429 or 5xx
|
* @param response
|
*/
|
static checkResponseStatus(
|
response: NetworkResponse<ServerAuthorizationTokenResponse>
|
): boolean {
|
return (
|
response.status === 429 ||
|
(response.status >= 500 && response.status < 600)
|
);
|
}
|
|
/**
|
* Checks a NetworkResponse object's RetryAfter header
|
* @param response
|
*/
|
static checkResponseForRetryAfter(
|
response: NetworkResponse<ServerAuthorizationTokenResponse>
|
): boolean {
|
if (response.headers) {
|
return (
|
response.headers.hasOwnProperty(
|
Constants.HeaderNames.RETRY_AFTER
|
) &&
|
(response.status < 200 || response.status >= 300)
|
);
|
}
|
return false;
|
}
|
|
/**
|
* Calculates the Unix-time value for a throttle to expire given throttleTime in seconds.
|
* @param throttleTime
|
*/
|
static calculateThrottleTime(throttleTime: number): number {
|
const time = throttleTime <= 0 ? 0 : throttleTime;
|
|
const currentSeconds = Date.now() / 1000;
|
return Math.floor(
|
Math.min(
|
currentSeconds +
|
(time || Constants.DEFAULT_THROTTLE_TIME_SECONDS),
|
currentSeconds + Constants.DEFAULT_MAX_THROTTLE_TIME_SECONDS
|
) * 1000
|
);
|
}
|
|
static removeThrottle(
|
cacheManager: CacheManager,
|
clientId: string,
|
request: BaseAuthRequest,
|
homeAccountIdentifier?: string
|
): void {
|
const thumbprint = getRequestThumbprint(
|
clientId,
|
request,
|
homeAccountIdentifier
|
);
|
const key = this.generateThrottlingStorageKey(thumbprint);
|
cacheManager.removeItem(key, request.correlationId);
|
}
|
}
|
