@fluidframework/routerlicious-driver 2.0.0-internal.5.3.2 → 2.0.0-internal.5.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/routerlicious-driver",
-  "version": "2.0.0-internal.5.3.2",
+  "version": "2.0.0-internal.5.4.0",
   "description": "Socket.IO + Git implementation of Fluid service API",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,15 +37,15 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.5.3.2 <2.0.0-internal.5.4.0",
-    "@fluidframework/driver-base": ">=2.0.0-internal.5.3.2 <2.0.0-internal.5.4.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.5.3.2 <2.0.0-internal.5.4.0",
-    "@fluidframework/driver-utils": ">=2.0.0-internal.5.3.2 <2.0.0-internal.5.4.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
+    "@fluidframework/driver-base": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
+    "@fluidframework/driver-utils": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
     "@fluidframework/gitresources": "^0.1039.1000",
     "@fluidframework/protocol-base": "^0.1039.1000",
     "@fluidframework/protocol-definitions": "^1.1.0",
     "@fluidframework/server-services-client": "^0.1039.1000",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.5.3.2 <2.0.0-internal.5.4.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
     "cross-fetch": "^3.1.5",
     "json-stringify-safe": "5.0.1",
     "socket.io-client": "^4.6.1",
@@ -57,12 +57,12 @@
     "@fluidframework/build-common": "^1.2.0",
     "@fluidframework/build-tools": "^0.21.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.5.3.2 <2.0.0-internal.5.4.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.5.4.0 <2.0.0-internal.5.5.0",
     "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@2.0.0-internal.5.2.0",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/mocha": "^9.1.1",
     "@types/nock": "^9.3.0",
-    "@types/node": "^14.18.38",
+    "@types/node": "^16.18.38",
     "@types/sinon": "^7.0.13",
     "@types/url-parse": "1.4.4",
     "@types/uuid": "^8.3.0",
@@ -94,7 +94,7 @@
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
     "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "clean": "rimraf --glob \"dist\" \"lib\" \"*.tsbuildinfo\" \"*.build.log\"",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",

package/src/contracts.ts

@@ -5,10 +5,54 @@
 
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
 
+/*
+ *
+ * Whole Snapshot Download Data Structures
+ *
+ */
+
+export interface IWholeFlatSnapshotTreeEntryTree {
+	path: string;
+	type: "tree";
+	// Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.
+	unreferenced?: true;
+}
+
+export interface IWholeFlatSnapshotTreeEntryBlob {
+	id: string;
+	path: string;
+	type: "blob";
+}
+
+export type IWholeFlatSnapshotTreeEntry =
+	| IWholeFlatSnapshotTreeEntryTree
+	| IWholeFlatSnapshotTreeEntryBlob;
+
+export interface IWholeFlatSnapshotTree {
+	entries: IWholeFlatSnapshotTreeEntry[];
+	id: string;
+	sequenceNumber: number;
+}
+
+export interface IWholeFlatSnapshotBlob {
+	content: string;
+	encoding: "base64" | "utf-8";
+	id: string;
+	size: number;
+}
+
+export interface IWholeFlatSnapshot {
+	// The same as the id of the first snapshot tree in the trees array.
+	id: string;
+	// Receive an array of snapshot trees for future-proofing, however, always length 1 for now.
+	trees: IWholeFlatSnapshotTree[];
+	blobs?: IWholeFlatSnapshotBlob[];
+}
+
 /**
  * Normalized Whole Summary with decoded blobs and unflattened snapshot tree.
  */
-export interface INormalizedWholeSummary {
+export interface INormalizedWholeSnapshot {
 	blobs: Map<string, ArrayBuffer>;
 	snapshotTree: ISnapshotTree;
 	sequenceNumber: number | undefined;

package/src/deltaStorageService.ts

@@ -22,7 +22,14 @@ import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry
 import { DocumentStorageService } from "./documentStorageService";
 import { RestWrapper } from "./restWrapperBase";
 
-const MaxBatchDeltas = 5000; // Maximum number of ops we can fetch at a time
+/**
+ * Maximum number of ops we can fetch at a time. This should be kept at 2k, as
+ * server determines whether to try to fallback to long-term storage if the ops range requested is larger than
+ * what they have locally available in short-term storage. So if we request 2k ops, they know it is not a
+ * specific request and they don't fall to long term storage which takes time.
+ * Please coordinate to AFR team if this value need to be changed.
+ */
+const MaxBatchDeltas = 2000;
 
 /**
  * Storage service limited to only being able to fetch documents for a specific document

package/src/documentService.ts

@@ -27,7 +27,7 @@ import { pkgVersion as driverVersion } from "./packageVersion";
 import { GitManager } from "./gitManager";
 import { Historian } from "./historian";
 import { RestWrapper } from "./restWrapperBase";
-import { INormalizedWholeSummary } from "./contracts";
+import { INormalizedWholeSnapshot } from "./contracts";
 
 /**
  * Amount of time between discoveries within which we don't need to rediscover on re-connect.
@@ -67,7 +67,7 @@ export class DocumentService implements api.IDocumentService {
 		private readonly documentStorageServicePolicies: api.IDocumentStorageServicePolicies,
 		private readonly driverPolicies: IRouterliciousDriverPolicies,
 		private readonly blobCache: ICache<ArrayBufferLike>,
-		private readonly wholeSnapshotTreeCache: ICache<INormalizedWholeSummary>,
+		private readonly wholeSnapshotTreeCache: ICache<INormalizedWholeSnapshot>,
 		private readonly shreddedSummaryTreeCache: ICache<ISnapshotTreeVersion>,
 		private readonly discoverFluidResolvedUrl: () => Promise<api.IResolvedUrl>,
 		private storageRestWrapper: RouterliciousStorageRestWrapper,

package/src/documentServiceFactory.ts

@@ -21,7 +21,7 @@ import {
 	isCombinedAppAndProtocolSummary,
 	RateLimiter,
 } from "@fluidframework/driver-utils";
-import { ChildLogger, PerformanceEvent } from "@fluidframework/telemetry-utils";
+import { createChildLogger, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { ISession } from "@fluidframework/server-services-client";
 import { DocumentService } from "./documentService";
 import { IRouterliciousDriverPolicies } from "./policies";
@@ -37,7 +37,7 @@ import { parseFluidUrl, replaceDocumentIdInPath, getDiscoveredFluidResolvedUrl }
 import { ICache, InMemoryCache, NullCache } from "./cache";
 import { pkgVersion as driverVersion } from "./packageVersion";
 import { ISnapshotTreeVersion } from "./definitions";
-import { INormalizedWholeSummary } from "./contracts";
+import { INormalizedWholeSnapshot } from "./contracts";
 
 const maximumSnapshotCacheDurationMs: FiveDaysMs = 432_000_000; // 5 days in ms
 
@@ -60,7 +60,7 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
 export class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
 	private readonly driverPolicies: IRouterliciousDriverPolicies;
 	private readonly blobCache: ICache<ArrayBufferLike>;
-	private readonly wholeSnapshotTreeCache: ICache<INormalizedWholeSummary> = new NullCache();
+	private readonly wholeSnapshotTreeCache: ICache<INormalizedWholeSnapshot> = new NullCache();
 	private readonly shreddedSummaryTreeCache: ICache<ISnapshotTreeVersion> = new NullCache();
 
 	constructor(
@@ -77,7 +77,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 		this.blobCache = new InMemoryCache<ArrayBufferLike>();
 		if (this.driverPolicies.enableInternalSummaryCaching) {
 			if (this.driverPolicies.enableWholeSummaryUpload) {
-				this.wholeSnapshotTreeCache = new InMemoryCache<INormalizedWholeSummary>(
+				this.wholeSnapshotTreeCache = new InMemoryCache<INormalizedWholeSnapshot>(
 					snapshotCacheExpiryMs,
 				);
 			} else {
@@ -119,7 +119,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 		const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);
 		const quorumValues = getQuorumValuesFromProtocolSummary(protocolSummary);
 
-		const logger2 = ChildLogger.create(logger, "RouterliciousDriver");
+		const logger2 = createChildLogger({ logger, namespace: "RouterliciousDriver" });
 		const ordererTokenFetcher = toInstrumentedR11sOrdererTokenFetcher(
 			tenantId,
 			undefined /* documentId */,
@@ -247,8 +247,12 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 				`Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`,
 			);
 		}
-		const logger2 = ChildLogger.create(logger, "RouterliciousDriver", {
-			all: { driverVersion },
+		const logger2 = createChildLogger({
+			logger,
+			namespace: "RouterliciousDriver",
+			properties: {
+				all: { driverVersion },
+			},
 		});
 
 		const ordererTokenFetcher = toInstrumentedR11sOrdererTokenFetcher(

package/src/documentStorageService.ts

@@ -20,7 +20,7 @@ import { WholeSummaryDocumentStorageService } from "./wholeSummaryDocumentStorag
 import { ShreddedSummaryDocumentStorageService } from "./shreddedSummaryDocumentStorageService";
 import { GitManager } from "./gitManager";
 import { ISnapshotTreeVersion } from "./definitions";
-import { INormalizedWholeSummary } from "./contracts";
+import { INormalizedWholeSnapshot } from "./contracts";
 
 export class DocumentStorageService extends DocumentStorageServiceProxy {
 	private _logTailSha: string | undefined = undefined;
@@ -36,7 +36,7 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
 		policies: IDocumentStorageServicePolicies,
 		driverPolicies?: IRouterliciousDriverPolicies,
 		blobCache?: ICache<ArrayBufferLike>,
-		snapshotTreeCache?: ICache<INormalizedWholeSummary>,
+		snapshotTreeCache?: ICache<INormalizedWholeSnapshot>,
 		shreddedSummaryTreeCache?: ICache<ISnapshotTreeVersion>,
 		noCacheGitManager?: GitManager,
 		getStorageManager?: (disableCache?: boolean) => Promise<GitManager>,
@@ -80,7 +80,7 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
 		policies: IDocumentStorageServicePolicies,
 		driverPolicies?: IRouterliciousDriverPolicies,
 		blobCache?: ICache<ArrayBufferLike>,
-		snapshotTreeCache?: ICache<INormalizedWholeSummary>,
+		snapshotTreeCache?: ICache<INormalizedWholeSnapshot>,
 		shreddedSummaryTreeCache?: ICache<ISnapshotTreeVersion>,
 		public noCacheGitManager?: GitManager,
 		getStorageManager?: (disableCache?: boolean) => Promise<GitManager>,

package/src/errorUtils.ts

@@ -3,13 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { DriverError } from "@fluidframework/driver-definitions";
+import { DriverError, IDriverErrorBase } from "@fluidframework/driver-definitions";
 import {
 	NonRetryableError,
 	GenericNetworkError,
 	createGenericNetworkError,
 	AuthorizationError,
 } from "@fluidframework/driver-utils";
+import { IFluidErrorBase } from "@fluidframework/telemetry-utils";
 import { pkgVersion as driverVersion } from "./packageVersion";
 
 /**
@@ -55,61 +56,53 @@ export interface IR11sSocketError {
 	retryAfterMs?: number;
 }
 
-export interface IR11sError {
+export interface IR11sError extends Omit<IDriverErrorBase, "errorType"> {
 	readonly errorType: RouterliciousErrorType;
-	readonly message: string;
-	canRetry: boolean;
 }
 
 export type R11sError = DriverError | IR11sError;
 
 export function createR11sNetworkError(
 	errorMessage: string,
-	statusCode?: number,
+	statusCode: number,
 	retryAfterMs?: number,
-): R11sError {
+): IFluidErrorBase & R11sError {
+	let error: IFluidErrorBase & R11sError;
 	const props = { statusCode, driverVersion };
 	switch (statusCode) {
-		case undefined:
-			// 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
-			if (errorMessage.includes("failed, reason: self signed certificate")) {
-				return new NonRetryableError(
-					errorMessage,
-					RouterliciousErrorType.sslCertError,
-					props,
-				);
-			}
-			return new GenericNetworkError(
-				errorMessage,
-				errorMessage.startsWith("NetworkError"),
-				props,
-			);
 		case 401:
 		// The first 401 is manually retried in RouterliciousRestWrapper with a refreshed token,
 		// so we treat repeat 401s the same as 403.
 		case 403:
-			return new AuthorizationError(errorMessage, undefined, undefined, props);
+			error = new AuthorizationError(errorMessage, undefined, undefined, props);
+			break;
 		case 404:
 			const errorType = RouterliciousErrorType.fileNotFoundOrAccessDeniedError;
-			return new NonRetryableError(errorMessage, errorType, props);
+			error = new NonRetryableError(errorMessage, errorType, props);
+			break;
 		case 429:
-			return createGenericNetworkError(errorMessage, { canRetry: true, retryAfterMs }, props);
+			error = createGenericNetworkError(
+				errorMessage,
+				{ canRetry: true, retryAfterMs },
+				props,
+			);
+			break;
 		case 500:
 		case 502:
-			return new GenericNetworkError(errorMessage, true, props);
+			error = new GenericNetworkError(errorMessage, true, props);
+			break;
 		default:
 			const retryInfo = { canRetry: retryAfterMs !== undefined, retryAfterMs };
-			return createGenericNetworkError(errorMessage, retryInfo, props);
+			error = createGenericNetworkError(errorMessage, retryInfo, props);
+			break;
 	}
+	error.addTelemetryProperties({ endpointReached: true });
+	return error;
 }
 
 export function throwR11sNetworkError(
 	errorMessage: string,
-	statusCode?: number,
+	statusCode: number,
 	retryAfterMs?: number,
 ): never {
 	const networkError = createR11sNetworkError(errorMessage, statusCode, retryAfterMs);

package/src/gitManager.ts

@@ -5,12 +5,12 @@
 
 import * as resources from "@fluidframework/gitresources";
 import {
-	IWholeFlatSummary,
 	IWholeSummaryPayload,
 	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
 import { IGitManager, IHistorian } from "./storageContracts";
 import { IR11sResponse, createR11sResponseFromContent } from "./restWrapper";
+import { IWholeFlatSnapshot } from "./contracts";
 
 export class GitManager implements IGitManager {
 	private readonly blobCache = new Map<string, resources.IBlob>();
@@ -110,7 +110,7 @@ export class GitManager implements IGitManager {
 		return this.historian.createSummary(summary, initial);
 	}
 
-	public async getSummary(sha: string): Promise<IR11sResponse<IWholeFlatSummary>> {
-		return this.historian.getSummary(sha);
+	public async getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>> {
+		return this.historian.getSnapshot(sha);
 	}
 }

package/src/historian.ts

@@ -6,13 +6,13 @@
 import { fromUtf8ToBase64 } from "@fluidframework/common-utils";
 import * as git from "@fluidframework/gitresources";
 import {
-	IWholeFlatSummary,
 	IWholeSummaryPayload,
 	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
 import { QueryStringType, RestWrapper } from "./restWrapperBase";
 import { IR11sResponse } from "./restWrapper";
 import { IHistorian } from "./storageContracts";
+import { IWholeFlatSnapshot } from "./contracts";
 
 export interface ICredentials {
 	user: string;
@@ -98,8 +98,8 @@ export class Historian implements IHistorian {
 		);
 	}
 
-	public async getSummary(sha: string): Promise<IR11sResponse<IWholeFlatSummary>> {
-		return this.restWrapper.get<IWholeFlatSummary>(
+	public async getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>> {
+		return this.restWrapper.get<IWholeFlatSnapshot>(
 			`/git/summaries/${sha}`,
 			this.getQueryString(),
 		);

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "2.0.0-internal.5.3.2";
+export const pkgVersion = "2.0.0-internal.5.4.0";

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 { 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,20 @@ 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 { 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 { RouterliciousErrorType, throwR11sNetworkError } from "./errorUtils";
 import { ITokenProvider, ITokenResponse } from "./tokens";
 import { pkgVersion as driverVersion } from "./packageVersion";
 import { QueryStringType, RestWrapper } from "./restWrapperBase";
@@ -84,12 +85,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 +137,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, RouterliciousErrorType.sslCertError, {
+							driverVersion,
+					  })
+					: new GenericNetworkError(
+							errorMessage,
+							errorMessage.startsWith("NetworkError"),
+							{ driverVersion },
+					  );
+				throw err;
 			});
 			return {
 				response: result,
@@ -209,17 +225,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/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/treeUtils.ts

@@ -10,7 +10,7 @@ import {
 	ISummaryTree,
 	SummaryObject,
 } from "@fluidframework/protocol-definitions";
-import { INormalizedWholeSummary } from "./contracts";
+import { INormalizedWholeSnapshot } from "./contracts";
 
 /**
  * Summary tree assembler props
@@ -107,7 +107,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;