@fluidframework/routerlicious-driver 2.1.0-276985 → 2.1.0

package/src/restWrapper.ts

@@ -28,19 +28,19 @@ import safeStringify from "json-stringify-safe";
 import type { AxiosRequestConfig, RawAxiosRequestHeaders } from "./axios.cjs";
 import { RouterliciousErrorTypes, throwR11sNetworkError } from "./errorUtils.js";
 import { pkgVersion as driverVersion } from "./packageVersion.js";
-import { QueryStringType, RestWrapper } from "./restWrapperBase.js";
+import { addOrUpdateQueryParams, type QueryStringType } from "./queryStringUtils.js";
+import { RestWrapper } from "./restWrapperBase.js";
 import { ITokenProvider, ITokenResponse } from "./tokens.js";
 
 type AuthorizationHeaderGetter = (token: ITokenResponse) => string;
 export type TokenFetcher = (refresh?: boolean) => Promise<ITokenResponse>;
 
-const axiosRequestConfigToFetchRequestConfig = (
-	requestConfig: AxiosRequestConfig,
-): [RequestInfo, RequestInit] => {
-	const requestInfo: string =
-		requestConfig.baseURL !== undefined
-			? `${requestConfig.baseURL}${requestConfig.url ?? ""}`
-			: requestConfig.url ?? "";
+const buildRequestUrl = (requestConfig: AxiosRequestConfig) =>
+	requestConfig.baseURL !== undefined
+		? `${requestConfig.baseURL ?? ""}${requestConfig.url ?? ""}`
+		: requestConfig.url ?? "";
+
+const axiosBuildRequestInitConfig = (requestConfig: AxiosRequestConfig): RequestInit => {
 	const requestInit: RequestInit = {
 		method: requestConfig.method,
 		// NOTE: I believe that although the Axios type permits non-string values in the header, here we are
@@ -48,7 +48,7 @@ const axiosRequestConfigToFetchRequestConfig = (
 		headers: requestConfig.headers as Record<string, string>,
 		body: requestConfig.data,
 	};
-	return [requestInfo, requestInit];
+	return requestInit;
 };
 
 export interface IR11sResponse<T> {
@@ -109,10 +109,17 @@ export function getPropsToLogFromResponse(headers: {
 	return additionalProps;
 }
 
-export class RouterliciousRestWrapper extends RestWrapper {
+class RouterliciousRestWrapper extends RestWrapper {
 	private readonly restLess = new RestLessClient();
 	private token: ITokenResponse | undefined;
 
+	/**
+	 * A locally maintained map which saves the number of retries for any REST api call made through restWrapper.
+	 * It uses the href of the request url as a key against which it saves the retry counts. Retries are only counted in case of failures.
+	 * This feature is added to enable FRS to have more telemetry insights into whether the requests are being retried from same client or multiple.
+	 */
+	private readonly retryCounter = new Map<string, number>();
+
 	constructor(
 		logger: ITelemetryLoggerExt,
 		private readonly rateLimiter: RateLimiter,
@@ -131,36 +138,64 @@ export class RouterliciousRestWrapper extends RestWrapper {
 		statusCode: number,
 		canRetry = true,
 	): Promise<IR11sResponse<T>> {
+		if (requestConfig.params) {
+			// delete the retry param, if any. We do this to ensure there is no retry added by any of callers, which would conflict with the one we maintain here in the retryCounter map.
+			delete requestConfig.params.retry;
+		}
+
+		// Build the complete request url including baseUrl, url and query params. (all except 'retry' query param)
+		let completeRequestUrl = addOrUpdateQueryParams(
+			buildRequestUrl(requestConfig),
+			requestConfig.params,
+		);
+
+		// Check whether this request has been made before or if it is a retry.
+		// requestKey is built using the HTTP method appended with the complete URL ommitting the 'retry' param
+		const requestKey = `${requestConfig.method ?? ""}|${completeRequestUrl.href}`;
+		const requestRetryCount = this.retryCounter.get(requestKey);
+		if (requestRetryCount) {
+			completeRequestUrl = addOrUpdateQueryParams(completeRequestUrl, {
+				retry: requestRetryCount,
+			});
+		}
+
 		const config = {
 			...requestConfig,
 			headers: await this.generateHeaders(requestConfig.headers),
 		};
 
 		const translatedConfig = this.useRestLess ? this.restLess.translate(config) : config;
-		const fetchRequestConfig = axiosRequestConfigToFetchRequestConfig(translatedConfig);
+		const fetchRequestConfig = axiosBuildRequestInitConfig(translatedConfig);
 
 		const res = await this.rateLimiter.schedule(async () => {
 			const perfStart = performance.now();
-			const result = await fetch(...fetchRequestConfig).catch(async (error) => {
-				// Browser Fetch throws a TypeError on network error, `node-fetch` throws a FetchError
-				const isNetworkError = ["TypeError", "FetchError"].includes(error?.name);
-				const errorMessage = isNetworkError
-					? `NetworkError: ${error.message}`
-					: safeStringify(error);
-				// If a service is temporarily down or a browser resource limit is reached, RestWrapper will throw
-				// a network error with no status code (e.g. err:ERR_CONN_REFUSED or err:ERR_FAILED) and
-				// the error message will start with NetworkError as defined in restWrapper.ts
-				// If there exists a self-signed SSL certificates error, throw a NonRetryableError
-				// TODO: instead of relying on string matching, filter error based on the error code like we do for websocket connections
-				const err = errorMessage.includes("failed, reason: self signed certificate")
-					? new NonRetryableError(errorMessage, RouterliciousErrorTypes.sslCertError, {
-							driverVersion,
-						})
-					: new GenericNetworkError(errorMessage, errorMessage.startsWith("NetworkError"), {
-							driverVersion,
-						});
-				throw err;
-			});
+			const result = await fetch(completeRequestUrl, fetchRequestConfig).catch(
+				async (error) => {
+					// on failure, add the request entry into the retryCounter map to count the subsequent retries, if any
+					this.retryCounter.set(requestKey, requestRetryCount ? requestRetryCount + 1 : 1);
+
+					// Browser Fetch throws a TypeError on network error, `node-fetch` throws a FetchError
+					const isNetworkError = ["TypeError", "FetchError"].includes(error?.name);
+					const errorMessage = isNetworkError
+						? `NetworkError: ${error.message}`
+						: safeStringify(error);
+					// If a service is temporarily down or a browser resource limit is reached, RestWrapper will throw
+					// a network error with no status code (e.g. err:ERR_CONN_REFUSED or err:ERR_FAILED) and
+					// the error message will start with NetworkError as defined in restWrapper.ts
+					// If there exists a self-signed SSL certificates error, throw a NonRetryableError
+					// TODO: instead of relying on string matching, filter error based on the error code like we do for websocket connections
+					const err = errorMessage.includes("failed, reason: self signed certificate")
+						? new NonRetryableError(errorMessage, RouterliciousErrorTypes.sslCertError, {
+								driverVersion,
+								retryCount: requestRetryCount,
+							})
+						: new GenericNetworkError(errorMessage, errorMessage.startsWith("NetworkError"), {
+								driverVersion,
+								retryCount: requestRetryCount,
+							});
+					throw err;
+				},
+			);
 			return {
 				response: result,
 				duration: performance.now() - perfStart,
@@ -184,13 +219,14 @@ export class RouterliciousRestWrapper extends RestWrapper {
 
 		// Success
 		if (response.ok || response.status === statusCode) {
+			// on successful response, remove the entry from the retryCounter map
+			this.retryCounter.delete(requestKey);
 			const result = responseBody as T;
 			const headers = headersToMap(response.headers);
 			return {
 				content: result,
 				headers,
-				// eslint-disable-next-line @typescript-eslint/no-base-to-string
-				requestUrl: fetchRequestConfig[0].toString(),
+				requestUrl: completeRequestUrl.href,
 				propsToLog: {
 					...getPropsToLogFromResponse(headers),
 					bodySize,
@@ -200,17 +236,24 @@ export class RouterliciousRestWrapper extends RestWrapper {
 				},
 			};
 		}
+
 		// Failure
+		// on failure, add the request entry into the retryCounter map to count the subsequent retries
+		this.retryCounter.set(requestKey, requestRetryCount ? requestRetryCount + 1 : 1);
+
 		if (response.status === 401 && canRetry) {
 			// Refresh Authorization header and retry once
 			this.token = await this.fetchRefreshedToken(true /* refreshToken */);
-			return this.request<T>(config, statusCode, false);
+			return this.request<T>({ ...config }, statusCode, false);
 		}
 		if (response.status === 429 && responseBody?.retryAfter > 0) {
 			// Retry based on retryAfter[Seconds]
 			return new Promise<IR11sResponse<T>>((resolve, reject) =>
 				setTimeout(() => {
-					this.request<T>(config, statusCode).then(resolve).catch(reject);
+					// use the original request URL without the retryCount appended
+					this.request<T>({ ...config }, statusCode)
+						.then(resolve)
+						.catch(reject);
 				}, responseBody.retryAfter * 1000),
 			);
 		}

package/src/restWrapperBase.ts

@@ -4,6 +4,7 @@
  */
 
 import type { AxiosRequestConfig, AxiosRequestHeaders } from "./axios.cjs";
+import { type QueryStringType } from "./queryStringUtils.js";
 import { IR11sResponse } from "./restWrapper.js";
 
 export abstract class RestWrapper {
@@ -14,6 +15,12 @@ export abstract class RestWrapper {
 		protected readonly maxContentLength = 1000 * 1024 * 1024,
 	) {}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async get<T>(
 		url: string,
 		queryString?: QueryStringType,
@@ -32,11 +39,19 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "GET",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 200);
 	}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param requestBody - requestBody
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async post<T>(
 		url: string,
 		requestBody: any,
@@ -57,11 +72,18 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "POST",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 201);
 	}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async delete<T>(
 		url: string,
 		queryString?: QueryStringType,
@@ -80,11 +102,19 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "DELETE",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 204);
 	}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param requestBody - requestBody
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async patch<T>(
 		url: string,
 		requestBody: any,
@@ -105,7 +135,8 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "PATCH",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 200);
 	}
@@ -115,32 +146,4 @@ export abstract class RestWrapper {
 		statusCode: number,
 		addNetworkCallProps?: boolean,
 	): Promise<IR11sResponse<T>>;
-
-	protected generateQueryString(queryStringValues?: QueryStringType) {
-		if (this.defaultQueryString || queryStringValues) {
-			const queryStringMap = { ...this.defaultQueryString, ...queryStringValues };
-
-			return getQueryString(queryStringMap);
-		}
-
-		return "";
-	}
-}
-
-/**
- * Generates query string from the given query parameters.
- * @param queryParams - Query parameters from which to create a query.
- */
-export function getQueryString(queryParams: QueryStringType): string {
-	let queryString = "";
-	for (const key of Object.keys(queryParams)) {
-		if (queryParams[key] !== undefined) {
-			const startChar = queryString === "" ? "?" : "&";
-			queryString += `${startChar}${key}=${encodeURIComponent(queryParams[key])}`;
-		}
-	}
-
-	return queryString;
 }
-
-export type QueryStringType = Record<string, string | number | boolean>;

package/src/shreddedSummaryDocumentStorageService.ts

@@ -98,13 +98,14 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
 
 	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null> {
 		let requestVersion = version;
-		if (!requestVersion) {
+		if (requestVersion === undefined) {
 			const versions = await this.getVersions(this.id, 1);
-			if (versions.length === 0) {
+			const firstVersion = versions[0];
+			if (firstVersion === undefined) {
 				return null;
 			}
 
-			requestVersion = versions[0];
+			requestVersion = firstVersion;
 		}
 
 		const cachedSnapshotTree = await this.snapshotTreeCache?.get(

package/src/summaryTreeUploadManager.ts

@@ -41,8 +41,7 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
 		previousFullSnapshot: ISnapshotTreeEx | undefined,
 	): Promise<string> {
 		const entries = await Promise.all(
-			Object.keys(summaryTree.tree).map(async (key) => {
-				const entry = summaryTree.tree[key];
+			Object.entries(summaryTree.tree).map(async ([key, entry]) => {
 				const pathHandle = await this.writeSummaryTreeObject(entry, previousFullSnapshot);
 				const treeEntry: IGitCreateTreeEntry = {
 					mode: getGitMode(entry),
@@ -123,8 +122,8 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
 		/** Previous snapshot, subtree relative to this path part */
 		previousSnapshot: ISnapshotTreeEx,
 	): string {
-		assert(path.length > 0, 0x0b3 /* "Expected at least 1 path part" */);
 		const key = path[0];
+		assert(path.length > 0 && key !== undefined, 0x0b3 /* "Expected at least 1 path part" */);
 		if (path.length === 1) {
 			switch (handleType) {
 				case SummaryType.Blob: {
@@ -147,6 +146,7 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
 					throw Error(`Unexpected handle summary object type: "${handleType}".`);
 			}
 		}
-		return this.getIdFromPathCore(handleType, path.slice(1), previousSnapshot.trees[key]);
+		// TODO why are we non null asserting here?
+		return this.getIdFromPathCore(handleType, path.slice(1), previousSnapshot.trees[key]!);
 	}
 }

package/src/urlUtils.ts

@@ -20,11 +20,13 @@ export const getDiscoveredFluidResolvedUrl = (
 	session: ISession,
 ): IResolvedUrl => {
 	const discoveredOrdererUrl = new URL(session.ordererUrl);
-	const deltaStorageUrl = new URL(resolvedUrl.endpoints.deltaStorageUrl);
+	// TODO why are we non null asserting here?
+	const deltaStorageUrl = new URL(resolvedUrl.endpoints.deltaStorageUrl!);
 	deltaStorageUrl.host = discoveredOrdererUrl.host;
 
 	const discoveredStorageUrl = new URL(session.historianUrl);
-	const storageUrl = new URL(resolvedUrl.endpoints.storageUrl);
+	// TODO why are we non null asserting here?
+	const storageUrl = new URL(resolvedUrl.endpoints.storageUrl!);
 	storageUrl.host = discoveredStorageUrl.host;
 
 	const parsedUrl = new URL(resolvedUrl.url);

package/src/wholeSummaryDocumentStorageService.ts

@@ -161,13 +161,14 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 	// eslint-disable-next-line @rushstack/no-new-null
 	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
 		let requestVersion = version;
-		if (!requestVersion) {
+		if (requestVersion === undefined) {
 			const versions = await this.getVersions(this.id, 1);
-			if (versions.length === 0) {
+			const firstVersion = versions[0];
+			if (firstVersion === undefined) {
 				return null;
 			}
 
-			requestVersion = versions[0];
+			requestVersion = firstVersion;
 		}
 
 		let normalizedWholeSnapshot = await this.snapshotTreeCache.get(

package/tsconfig.json

@@ -6,6 +6,5 @@
 		"rootDir": "./src",
 		"outDir": "./lib",
 		"exactOptionalPropertyTypes": false,
-		"noUncheckedIndexedAccess": false,
 	},
 }

package/api-extractor/api-extractor-lint-beta.esm.json

@@ -1,5 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
-	"mainEntryPointFilePath": "<projectFolder>/lib/beta.d.ts"
-}

package/beta.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
- */
-
-export * from "./lib/beta.js";

package/dist/beta.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
- */
-
-export {
-	// @public APIs
-	ITokenProvider, 
-	ITokenResponse
-} from "./index.js";

package/lib/beta.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
- */
-
-export {
-	// @public APIs
-	ITokenProvider, 
-	ITokenResponse
-} from "./index.js";