@fluidframework/routerlicious-driver 2.0.0-dev.5.3.2.178189 → 2.0.0-dev.6.4.0.191258

package/src/r11sSnapshotParser.ts

@@ -4,9 +4,8 @@
  */
 
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { IWholeFlatSummary, IWholeFlatSummaryTree } from "@fluidframework/server-services-client";
-import { stringToBuffer } from "@fluidframework/common-utils";
-import { INormalizedWholeSummary } from "./contracts";
+import { stringToBuffer } from "@fluid-internal/client-utils";
+import { INormalizedWholeSnapshot, IWholeFlatSnapshot, IWholeFlatSnapshotTree } from "./contracts";
 
 /**
  * Build a tree hierarchy from a flat tree.
@@ -16,7 +15,7 @@ import { INormalizedWholeSummary } from "./contracts";
  * @returns the heirarchical tree
  */
 function buildHierarchy(
-	flatTree: IWholeFlatSummaryTree,
+	flatTree: IWholeFlatSnapshotTree,
 	treePrefixToRemove: string,
 ): ISnapshotTree {
 	const lookup: { [path: string]: ISnapshotTree } = {};
@@ -54,30 +53,30 @@ function buildHierarchy(
 }
 
 /**
- * Converts existing IWholeFlatSummary to snapshot tree, blob array, and sequence number.
+ * Converts existing IWholeFlatSnapshot to snapshot tree, blob array, and sequence number.
  *
- * @param flatSummary - flat summary
+ * @param flatSnapshot - flat snapshot
  * @param treePrefixToRemove - tree prefix to strip. By default we are stripping ".app" prefix
  * @returns snapshot tree, blob array, and sequence number
  */
-export function convertWholeFlatSummaryToSnapshotTreeAndBlobs(
-	flatSummary: IWholeFlatSummary,
+export function convertWholeFlatSnapshotToSnapshotTreeAndBlobs(
+	flatSnapshot: IWholeFlatSnapshot,
 	treePrefixToRemove: string = ".app",
-): INormalizedWholeSummary {
+): INormalizedWholeSnapshot {
 	const blobs = new Map<string, ArrayBuffer>();
-	if (flatSummary.blobs) {
-		flatSummary.blobs.forEach((blob) => {
+	if (flatSnapshot.blobs) {
+		flatSnapshot.blobs.forEach((blob) => {
 			blobs.set(blob.id, stringToBuffer(blob.content, blob.encoding ?? "utf-8"));
 		});
 	}
-	const flatSummaryTree = flatSummary.trees?.[0];
-	const sequenceNumber = flatSummaryTree?.sequenceNumber;
-	const snapshotTree = buildHierarchy(flatSummaryTree, treePrefixToRemove);
+	const flatSnapshotTree = flatSnapshot.trees?.[0];
+	const sequenceNumber = flatSnapshotTree?.sequenceNumber;
+	const snapshotTree = buildHierarchy(flatSnapshotTree, treePrefixToRemove);
 
 	return {
 		blobs,
 		snapshotTree,
 		sequenceNumber,
-		id: flatSummary.id,
+		id: flatSnapshot.id,
 	};
 }

package/src/restWrapper.ts

@@ -7,19 +7,21 @@ import { ITelemetryProperties } from "@fluidframework/core-interfaces";
 import {
 	ITelemetryLoggerExt,
 	PerformanceEvent,
-	TelemetryLogger,
+	numberFromString,
 } from "@fluidframework/telemetry-utils";
-import { assert, fromUtf8ToBase64, performance } from "@fluidframework/common-utils";
-import { RateLimiter } from "@fluidframework/driver-utils";
+import { assert } from "@fluidframework/core-utils";
+import { fromUtf8ToBase64, performance } from "@fluid-internal/client-utils";
+import { GenericNetworkError, NonRetryableError, RateLimiter } from "@fluidframework/driver-utils";
 import {
+	CorrelationIdHeaderName,
+	DriverVersionHeaderName,
 	getAuthorizationTokenFromCredentials,
 	RestLessClient,
 } from "@fluidframework/server-services-client";
 import fetch from "cross-fetch";
 import type { AxiosRequestConfig, AxiosRequestHeaders } from "axios";
 import safeStringify from "json-stringify-safe";
-import { v4 as uuid } from "uuid";
-import { throwR11sNetworkError } from "./errorUtils";
+import { RouterliciousErrorTypes, throwR11sNetworkError } from "./errorUtils";
 import { ITokenProvider, ITokenResponse } from "./tokens";
 import { pkgVersion as driverVersion } from "./packageVersion";
 import { QueryStringType, RestWrapper } from "./restWrapperBase";
@@ -52,9 +54,9 @@ export interface IR11sResponse<T> {
 }
 
 /**
- * A utility function to create a r11s response without any additional props as we might not have them always.
- * @param content - response which is equivalent to content.
- * @returns - a r11s response without any extra props.
+ * A utility function to create a Routerlicious response without any additional props as we might not have them always.
+ * @param content - Response which is equivalent to content.
+ * @returns A Routerlicious response without any extra props.
  */
 export function createR11sResponseFromContent<T>(content: T): IR11sResponse<T> {
 	return {
@@ -84,12 +86,12 @@ export function getPropsToLogFromResponse(headers: {
 	// We rename headers so that otel doesn't scrub them away. Otel doesn't allow
 	// certain characters in headers including '-'
 	const headersToLog: LoggingHeader[] = [
-		{ headerName: "x-correlation-id", logName: "requestCorrelationId" },
+		{ headerName: CorrelationIdHeaderName, logName: "requestCorrelationId" },
 		{ headerName: "content-encoding", logName: "contentEncoding" },
 		{ headerName: "content-type", logName: "contentType" },
 	];
 	const additionalProps: ITelemetryProperties = {
-		contentsize: TelemetryLogger.numberFromString(headers.get("content-length")),
+		contentsize: numberFromString(headers.get("content-length")),
 	};
 	headersToLog.forEach((header) => {
 		const headerValue = headers.get(header.headerName);
@@ -136,9 +138,24 @@ export class RouterliciousRestWrapper extends RestWrapper {
 			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);
-				throwR11sNetworkError(
-					isNetworkError ? `NetworkError: ${error.message}` : safeStringify(error),
-				);
+				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;
 			});
 			return {
 				response: result,
@@ -209,17 +226,13 @@ export class RouterliciousRestWrapper extends RestWrapper {
 	): Promise<Record<string, string>> {
 		const token = await this.getToken();
 		assert(token !== undefined, 0x679 /* token should be present */);
-		const correlationId = requestHeaders?.["x-correlation-id"] ?? uuid();
-
-		return {
+		const headers: Record<string, string> = {
 			...requestHeaders,
-			// TODO: replace header names with CorrelationIdHeaderName and DriverVersionHeaderName from services-client
-			// NOTE: Can correlationId actually be number | true?
-			"x-correlation-id": correlationId as string,
-			"x-driver-version": driverVersion,
+			[DriverVersionHeaderName]: driverVersion,
 			// NOTE: If this.authorizationHeader is undefined, should "Authorization" be removed entirely?
-			"Authorization": this.getAuthorizationHeader(token),
+			Authorization: this.getAuthorizationHeader(token),
 		};
+		return headers;
 	}
 
 	public async getToken(): Promise<ITokenResponse> {

package/src/retriableGitManager.ts

@@ -5,7 +5,6 @@
 
 import type * as git from "@fluidframework/gitresources";
 import {
-	IWholeFlatSummary,
 	IWholeSummaryPayload,
 	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
@@ -13,6 +12,7 @@ import { runWithRetry } from "@fluidframework/driver-utils";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { IGitManager } from "./storageContracts";
 import { IR11sResponse } from "./restWrapper";
+import { IWholeFlatSnapshot } from "./contracts";
 
 export class RetriableGitManager implements IGitManager {
 	constructor(
@@ -70,9 +70,9 @@ export class RetriableGitManager implements IGitManager {
 		);
 	}
 
-	public async getSummary(sha: string): Promise<IR11sResponse<IWholeFlatSummary>> {
+	public async getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>> {
 		return this.runWithRetry(
-			async () => this.internalGitManager.getSummary(sha),
+			async () => this.internalGitManager.getSnapshot(sha),
 			"gitManager_getSummary",
 		);
 	}

package/src/shreddedSummaryDocumentStorageService.ts

@@ -4,13 +4,13 @@
  */
 
 import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
-import { stringToBuffer, Uint8ArrayToString } from "@fluidframework/common-utils";
+import { stringToBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
 import {
 	IDocumentStorageService,
 	ISummaryContext,
 	IDocumentStorageServicePolicies,
 } from "@fluidframework/driver-definitions";
-import { buildHierarchy } from "@fluidframework/protocol-base";
+import { buildGitTreeHierarchy } from "@fluidframework/protocol-base";
 import {
 	ICreateBlobResponse,
 	ISnapshotTreeEx,
@@ -125,7 +125,7 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
 				return response;
 			},
 		);
-		const tree = buildHierarchy(rawTree, this.blobsShaCache, true);
+		const tree = buildGitTreeHierarchy(rawTree, this.blobsShaCache, true);
 		await this.snapshotTreeCache?.put(this.getCacheKey(tree.id), {
 			id: requestVersion.id,
 			snapshotTree: tree,

package/src/storageContracts.ts

@@ -6,12 +6,12 @@
 import * as git from "@fluidframework/gitresources";
 import * as api from "@fluidframework/protocol-definitions";
 import {
-	IWholeFlatSummary,
 	IWholeSummaryPayload,
 	IWholeSummaryPayloadType,
 	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
 import { IR11sResponse } from "./restWrapper";
+import { IWholeFlatSnapshot } from "./contracts";
 
 /**
  * Interface to a generic Git provider
@@ -26,7 +26,7 @@ export interface IHistorian {
 		summary: IWholeSummaryPayload,
 		initial?: boolean,
 	): Promise<IR11sResponse<IWriteSummaryResponse>>;
-	getSummary(sha: string): Promise<IR11sResponse<IWholeFlatSummary>>;
+	getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>>;
 }
 
 export interface IGitManager {
@@ -39,7 +39,7 @@ export interface IGitManager {
 		summary: IWholeSummaryPayload,
 		initial?: boolean,
 	): Promise<IR11sResponse<IWriteSummaryResponse>>;
-	getSummary(sha: string): Promise<IR11sResponse<IWholeFlatSummary>>;
+	getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>>;
 }
 
 /**

package/src/summaryTreeUploadManager.ts

@@ -3,13 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import {
-	assert,
-	gitHashFile,
-	IsoBuffer,
-	Uint8ArrayToString,
-	unreachableCase,
-} from "@fluidframework/common-utils";
+import { gitHashFile, IsoBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
+import { assert, unreachableCase } from "@fluidframework/core-utils";
 import { ICreateTreeEntry } from "@fluidframework/gitresources";
 import { getGitMode, getGitType } from "@fluidframework/protocol-base";
 import {

package/src/treeUtils.ts

@@ -3,14 +3,15 @@
  * Licensed under the MIT License.
  */
 
-import { assert, IsoBuffer } from "@fluidframework/common-utils";
+import { IsoBuffer } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils";
 import {
 	SummaryType,
 	ISnapshotTree,
 	ISummaryTree,
 	SummaryObject,
 } from "@fluidframework/protocol-definitions";
-import { INormalizedWholeSummary } from "./contracts";
+import { INormalizedWholeSnapshot } from "./contracts";
 
 /**
  * Summary tree assembler props
@@ -107,7 +108,7 @@ export function convertSnapshotAndBlobsToSummaryTree(
 	return assembler.summary;
 }
 
-export function evalBlobsAndTrees(snapshot: INormalizedWholeSummary) {
+export function evalBlobsAndTrees(snapshot: INormalizedWholeSnapshot) {
 	const trees = countTreesInSnapshotTree(snapshot.snapshotTree);
 	const numBlobs = snapshot.blobs.size;
 	let encodedBlobsSize = 0;

package/src/wholeSummaryDocumentStorageService.ts

@@ -4,12 +4,8 @@
  */
 
 import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
-import {
-	assert,
-	performance,
-	stringToBuffer,
-	Uint8ArrayToString,
-} from "@fluidframework/common-utils";
+import { performance, stringToBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils";
 import { getW3CData, promiseRaceWithWinner } from "@fluidframework/driver-base";
 import {
 	IDocumentStorageService,
@@ -23,7 +19,6 @@ import {
 	ISummaryTree,
 	IVersion,
 } from "@fluidframework/protocol-definitions";
-import { IWholeFlatSummary } from "@fluidframework/server-services-client";
 import { ICache, InMemoryCache } from "./cache";
 import { IRouterliciousDriverPolicies } from "./policies";
 import {
@@ -35,8 +30,8 @@ import { GitManager } from "./gitManager";
 import { WholeSummaryUploadManager } from "./wholeSummaryUploadManager";
 import { ISummaryUploadManager } from "./storageContracts";
 import { IR11sResponse } from "./restWrapper";
-import { INormalizedWholeSummary } from "./contracts";
-import { convertWholeFlatSummaryToSnapshotTreeAndBlobs } from "./r11sSnapshotParser";
+import { INormalizedWholeSnapshot, IWholeFlatSnapshot } from "./contracts";
+import { convertWholeFlatSnapshotToSnapshotTreeAndBlobs } from "./r11sSnapshotParser";
 
 const latestSnapshotId: string = "latest";
 
@@ -59,7 +54,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 		public readonly policies: IDocumentStorageServicePolicies,
 		private readonly driverPolicies?: IRouterliciousDriverPolicies,
 		private readonly blobCache: ICache<ArrayBufferLike> = new InMemoryCache(),
-		private readonly snapshotTreeCache: ICache<INormalizedWholeSummary> = new InMemoryCache(),
+		private readonly snapshotTreeCache: ICache<INormalizedWholeSnapshot> = new InMemoryCache(),
 		private readonly noCacheGitManager?: GitManager,
 		private readonly getStorageManager: (
 			disableCache?: boolean,
@@ -243,7 +238,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 	}
 
 	public async downloadSummary(summaryHandle: ISummaryHandle): Promise<ISummaryTree> {
-		const wholeFlatSummary = await PerformanceEvent.timedExecAsync(
+		const wholeFlatSnapshot = await PerformanceEvent.timedExecAsync(
 			this.logger,
 			{
 				eventName: "getWholeFlatSummary",
@@ -251,7 +246,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 			},
 			async (event) => {
 				const manager = await this.getStorageManager();
-				const response = await manager.getSummary(summaryHandle.handle);
+				const response = await manager.getSnapshot(summaryHandle.handle);
 				event.end({
 					size: response.content.trees[0]?.entries.length,
 				});
@@ -259,8 +254,8 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 			},
 		);
 
-		const { blobs, snapshotTree } = convertWholeFlatSummaryToSnapshotTreeAndBlobs(
-			wholeFlatSummary,
+		const { blobs, snapshotTree } = convertWholeFlatSnapshotToSnapshotTreeAndBlobs(
+			wholeFlatSnapshot,
 			"",
 		);
 		return convertSnapshotAndBlobsToSummaryTree(snapshotTree, blobs);
@@ -291,7 +286,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 		versionId: string,
 		disableCache?: boolean,
 		scenarioName?: string,
-	): Promise<INormalizedWholeSummary> {
+	): Promise<INormalizedWholeSnapshot> {
 		const normalizedWholeSummary = await PerformanceEvent.timedExecAsync(
 			this.logger,
 			{
@@ -301,12 +296,12 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 			},
 			async (event) => {
 				const manager = await this.getStorageManager(disableCache);
-				const response: IR11sResponse<IWholeFlatSummary> = await manager.getSummary(
+				const response: IR11sResponse<IWholeFlatSnapshot> = await manager.getSnapshot(
 					versionId,
 				);
 				const start = performance.now();
-				const snapshot: INormalizedWholeSummary =
-					convertWholeFlatSummaryToSnapshotTreeAndBlobs(response.content);
+				const snapshot: INormalizedWholeSnapshot =
+					convertWholeFlatSnapshotToSnapshotTreeAndBlobs(response.content);
 				const snapshotConversionTime = performance.now() - start;
 				validateBlobsAndTrees(snapshot.snapshotTree);
 				const { trees, numBlobs, encodedBlobsSize } = evalBlobsAndTrees(snapshot);
@@ -333,7 +328,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 	}
 
 	private async initializeFromSnapshot(
-		normalizedWholeSummary: INormalizedWholeSummary,
+		normalizedWholeSummary: INormalizedWholeSnapshot,
 	): Promise<string> {
 		const snapshotId = normalizedWholeSummary.id;
 		assert(snapshotId !== undefined, 0x275 /* "Root tree should contain the id" */);