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

package/src/errorUtils.ts

@@ -3,25 +3,51 @@
  * Licensed under the MIT License.
  */
 
-import { DriverError } from "@fluidframework/driver-definitions";
+import {
+	DriverError,
+	IDriverErrorBase,
+	DriverErrorTypes,
+} 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";
 
 /**
  * Routerlicious Error types
  * Different error types that may be thrown by the routerlicious driver
  */
+export const RouterliciousErrorTypes = {
+	// Inherit base driver error types
+	...DriverErrorTypes,
+
+	/**
+	 * SSL Certificate Error.
+	 */
+	sslCertError: "sslCertError",
+} as const;
+export type RouterliciousErrorTypes =
+	typeof RouterliciousErrorTypes[keyof typeof RouterliciousErrorTypes];
+
+/**
+ * Routerlicious Error types
+ * Different error types that may be thrown by the routerlicious driver
+ *
+ * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
+ */
 export enum RouterliciousErrorType {
 	/**
 	 * File not found, or file deleted during session
 	 */
 	fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
 
+	/**
+	 * SSL Certificate Error.
+	 */
 	sslCertError = "sslCertError",
 }
 
@@ -55,61 +81,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

@@ -3,16 +3,16 @@
  * Licensed under the MIT License.
  */
 
-import { fromUtf8ToBase64 } from "@fluidframework/common-utils";
+import { fromUtf8ToBase64 } from "@fluid-internal/client-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;
@@ -65,7 +65,7 @@ export class Historian implements IHistorian {
 	): Promise<IR11sResponse<git.ICommitDetails[]>> {
 		return this.restWrapper
 			.get<git.ICommitDetails[]>(`/commits`, this.getQueryString({ count, sha }))
-			.catch((error) =>
+			.catch(async (error) =>
 				error.statusCode === 400 || error.statusCode === 404
 					? {
 							content: [],
@@ -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/index.ts

@@ -8,7 +8,7 @@ export { DefaultTokenProvider } from "./defaultTokenProvider";
 export { ITokenProvider, ITokenResponse, ITokenService } from "./tokens";
 
 // Errors
-export { RouterliciousErrorType } from "./errorUtils";
+export { RouterliciousErrorType, RouterliciousErrorTypes } from "./errorUtils";
 
 // Factory
 export {

package/src/mapWithExpiration.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 
 /**
  * An extension of Map that expires (deletes) entries after a period of inactivity.

package/src/nullBlobStorageService.ts

@@ -27,17 +27,17 @@ export class NullBlobStorageService implements IDocumentStorageService {
 		summary: api.ISummaryTree,
 		context: ISummaryContext,
 	): Promise<string> {
-		return Promise.reject(new Error("Invalid operation"));
+		throw new Error("Invalid operation");
 	}
 
 	public async downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree> {
-		return Promise.reject(new Error("Invalid operation"));
+		throw new Error("Invalid operation");
 	}
 
 	public async createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse> {
-		return Promise.reject(new Error("Null blob storage can not create blob"));
+		throw new Error("Null blob storage can not create blob");
 	}
 	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-		return Promise.reject(new Error("Null blob storage can not read blob"));
+		throw new Error("Null blob storage can not read blob");
 	}
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "2.0.0-dev.5.2.0.169897";
+export const pkgVersion = "2.0.0-dev.6.4.0.191258";

package/src/policies.ts

@@ -36,7 +36,7 @@ export interface IRouterliciousDriverPolicies {
 	 * Enable service endpoint discovery when creating or joining a session.
 	 * Default: false
 	 */
-	enableDiscovery?: boolean;
+	enableDiscovery: boolean;
 	/**
 	 * Enable using RestLess which avoids CORS preflight requests.
 	 * Default: true
@@ -54,4 +54,10 @@ export interface IRouterliciousDriverPolicies {
 	 * Default: true
 	 */
 	enableLongPollingDowngrade: boolean;
+	/**
+	 * Indicates that the container is ephemeral.
+	 * Artifacts relates to the container are limited to container lifetime.
+	 * Default: false
+	 */
+	isEphemeralContainer: boolean;
 }

package/src/r11sSnapshotParser.ts

@@ -4,19 +4,18 @@
  */
 
 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 heirarchy from a flat tree.
+ * Build a tree hierarchy from a flat tree.
  *
  * @param flatTree - a flat tree
  * @param treePrefixToRemove - tree prefix to strip
  * @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

@@ -3,23 +3,25 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryProperties } from "@fluidframework/common-definitions";
+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;