@fluidframework/driver-utils 2.0.0-dev.5.3.2.178189 → 2.0.0-dev.6.4.0.191457

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "2.0.0-dev.5.3.2.178189",
+  "version": "2.0.0-dev.6.4.0.191457",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,7 +14,7 @@
   "main": "dist/index.js",
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
-  "nyc": {
+  "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
     "exclude": [
@@ -35,30 +35,31 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/core-interfaces": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/driver-definitions": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/gitresources": "^0.1039.1000",
-    "@fluidframework/protocol-base": "^0.1039.1000",
+    "@fluid-internal/client-utils": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/core-interfaces": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/core-utils": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/driver-definitions": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/gitresources": "^1.0.1",
+    "@fluidframework/protocol-base": "^1.0.1",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.5.3.2.178189",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.6.4.0.191457",
     "axios": "^0.26.0",
     "lz4js": "^0.2.0",
     "url": "^0.11.0",
-    "uuid": "^8.3.1"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.21.0",
-    "@fluidframework/build-common": "^1.2.0",
-    "@fluidframework/build-tools": "^0.21.0",
-    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.5.2.0",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.5.3.2.178189",
+    "@fluid-tools/build-cli": "^0.22.0",
+    "@fluidframework/build-common": "^2.0.0",
+    "@fluidframework/build-tools": "^0.22.0",
+    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.6.3.0",
+    "@fluidframework/eslint-config-fluid": "^2.1.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.6.4.0.191457",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.38",
+    "@types/node": "^16.18.38",
     "@types/sinon": "^7.0.13",
-    "concurrently": "^7.6.0",
+    "c8": "^7.7.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.6.0",
@@ -66,7 +67,6 @@
     "mocha-json-output-reporter": "^2.0.1",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
-    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
     "rimraf": "^4.4.0",
     "sinon": "^7.4.2",
@@ -84,7 +84,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' '_api-extractor-temp' 'nyc'",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
@@ -93,9 +93,8 @@
     "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:multireport": "cross-env FLUID_TEST_MULTIREPORT=1 npm run test:mocha",
+    "test:coverage": "c8 npm test",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "typetests:gen": "fluid-type-test-generator",

package/src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { IsoBuffer, assert } from "@fluidframework/common-utils";
+import { IsoBuffer } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils";
 import { IDocumentStorageService, ISummaryContext } from "@fluidframework/driver-definitions";
 import {
 	ISnapshotTree,
@@ -47,9 +48,9 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	}
 
 	/**
-	 * This method returns true if there is a compression markup byte in the blob, otherwise false.
+	 * This method returns `true` if there is a compression markup byte in the blob, otherwise `false`.
 	 * @param blob - The blob to compress.
-	 * @returns - True if there is a compression markup byte in the blob, otherwise false.
+	 * @returns `true` if there is a compression markup byte in the blob, otherwise `false`.
 	 */
 	private static hasPrefix(blob: ArrayBufferLike): boolean {
 		const firstByte = IsoBuffer.from(blob)[0];
@@ -72,7 +73,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * This method writes the given algorithm to the blob as the first byte.
 	 * @param blob - The blob to write the algorithm to.
 	 * @param algorithm - The algorithm to write.
-	 * @returns - The blob with the algorithm as the first byte.
+	 * @returns The blob with the algorithm as the first byte.
 	 */
 	private static writeAlgorithmToBlob(blob: ArrayBufferLike, algorithm: number): ArrayBufferLike {
 		if (algorithm === SummaryCompressionAlgorithm.None) {
@@ -96,7 +97,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	/**
 	 * This method removes the algorithm markup prefix from the blob (1 byte)
 	 * @param blob - The blob to remove the prefix from.
-	 * @returns - The blob without the prefix.
+	 * @returns The blob without the prefix.
 	 */
 	private static removePrefixFromBlobIfPresent(blob: ArrayBufferLike): ArrayBufferLike {
 		const blobView = new Uint8Array(blob);
@@ -108,7 +109,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * it is just returned as is. If the parameter is string, it is converted to Uint8Array using
 	 * TextEncoder.
 	 * @param input - The input to convert to Uint8Array.
-	 * @returns - The Uint8Array representation of the input.
+	 * @returns The Uint8Array representation of the input.
 	 */
 	private static toBinaryArray(input: string | Uint8Array): Uint8Array {
 		return typeof input === "string" ? new TextEncoder().encode(input) : input;
@@ -119,7 +120,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * containing  the compression algorithm.
 	 * @param input - The summary object to encode.
 	 * @param config - The config containing the compression algorithm.
-	 * @returns - The summary object with the encoded blob.
+	 * @returns The summary object with the encoded blob.
 	 */
 	private static readonly blobEncoder = (
 		input: SummaryObject,
@@ -146,7 +147,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	/**
 	 * This method decodes the blob inside the given summary object of the SummaryType.Blob type.
 	 * @param input - The summary object to decode.
-	 * @returns - The summary object with the decoded blob.
+	 * @returns The summary object with the decoded blob.
 	 */
 	private static readonly blobDecoder = (input: SummaryObject): SummaryObject => {
 		if (input.type === SummaryType.Blob) {
@@ -170,7 +171,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * This method encodes the given blob according to the given config.
 	 * @param file - The blob to encode.
 	 * @param config - The config to use for encoding.
-	 * @returns - The encoded blob.
+	 * @returns The encoded blob.
 	 */
 	private static encodeBlob(
 		file: ArrayBufferLike,
@@ -199,7 +200,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	/**
 	 * This method decodes the given blob.
 	 * @param file - The blob to decode.
-	 * @returns - The decoded blob.
+	 * @returns The decoded blob.
 	 */
 	private static decodeBlob(file: ArrayBufferLike): ArrayBufferLike {
 		let decompressed: ArrayBufferLike;
@@ -231,7 +232,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * @param decoder - The decoder function to use.
 	 * @param config - The config to use for encoding.
 	 * @param context - The summary context.
-	 * @returns - The summary object with the encoded/decoded blob.
+	 * @returns The summary object with the encoded/decoded blob.
 	 */
 	private static recursivelyReplace(
 		isEncode: boolean,
@@ -274,7 +275,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * it returns the summary tree containing that blob.
 	 *
 	 * @param summary - The summary tree to traverse.
-	 * @returns - The summary tree containing the metadata blob.
+	 * @returns The summary tree containing the metadata blob.
 	 */
 	private static findMetadataHolderSummary(summary: ISummaryTree): ISummaryTree | undefined {
 		assert(typeof summary === "object", 0x6f7 /* summary must be a non-null object */);
@@ -298,7 +299,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * This method obtains the summary tree containing the metadata blob. It returns the content
 	 * of the tree atribute.
 	 * @param summary - The summary tree to traverse.
-	 * @returns - The content of the tree attribute of the summary tree containing the metadata blob.
+	 * @returns The content of the tree attribute of the summary tree containing the metadata blob.
 	 */
 	private static getMetadataHolderTree(summary: ISummaryTree) {
 		const metadataHolder = this.findMetadataHolderSummary(summary);
@@ -325,7 +326,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * it checks, if the SummaryTree holder of that object also contains the compression markup blob. If it is found,
 	 * it returns true, otherwise false.
 	 * @param snapshot - The snapshot tree to traverse.
-	 * @returns - True if the compression markup blob is found, otherwise false.
+	 * @returns True if the compression markup blob is found, otherwise false.
 	 */
 	private static hasCompressionMarkup(snapshot: ISnapshotTree): boolean {
 		assert(typeof snapshot === "object", 0x6f9 /* snapshot must be a non-null object */);
@@ -353,7 +354,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * This method performs compression of the blobs in the summary tree.
 	 * @param summary - The summary tree to compress.
 	 * @param config - The compression config.
-	 * @returns - The compressed summary tree.
+	 * @returns The compressed summary tree.
 	 */
 	public static compressSummary(
 		summary: ISummaryTree,
@@ -374,7 +375,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	/**
 	 * This method read blob from the storage and decompresses it if it is compressed.
 	 * @param id - The id of the blob to read.
-	 * @returns - The decompressed blob.
+	 * @returns The decompressed blob.
 	 */
 	public override async readBlob(id: string): Promise<ArrayBufferLike> {
 		const originalBlob = await super.readBlob(id);
@@ -394,7 +395,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * algorithm byte prefix and store them.
 	 * @param version - The version of the snapshot tree to load.
 	 * @param scenarioName - The scenario name of the snapshot tree to load.
-	 * @returns - The snapshot tree.
+	 * @returns The snapshot tree.
 	 */
 	public override async getSnapshotTree(
 		version?: IVersion | undefined,
@@ -413,7 +414,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * This method uploads the summary to the storage. It performs compression of the blobs in the summary tree.
 	 * @param summary - The summary tree to upload.
 	 * @param context - The summary context.
-	 * @returns - The ID of the uploaded summary.
+	 * @returns The ID of the uploaded summary.
 	 */
 	public override async uploadSummaryWithContext(
 		summary: ISummaryTree,
@@ -429,7 +430,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	/**
 	 * This method downloads the summary from the storage and then applies decompression on the compressed blobs.
 	 * @param id - The ID of the summary to be downloaded
-	 * @returns - The summary with decompressed blobs
+	 * @returns The summary with decompressed blobs
 	 */
 	public override async downloadSummary(id: ISummaryHandle): Promise<ISummaryTree> {
 		const summary = await super.downloadSummary(id);

package/src/adapters/predefinedAdapters.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 import { IDocumentServiceFactory } from "@fluidframework/driver-definitions";
 import {
 	DocumentServiceFactoryCompressionAdapter,
@@ -16,7 +16,7 @@ import {
  * must be enabled by setting the config to true or by passing a compression config object.
  * @param documentServiceFactory - The document service factory to apply compression to.
  * @param config - The compression configuration.
- * @returns - The document service factory possibly with compression applied.
+ * @returns The document service factory possibly with compression applied.
  */
 export function applyStorageCompression(
 	documentServiceFactory: IDocumentServiceFactory,
@@ -43,11 +43,13 @@ export function applyStorageCompression(
  * This method applies compression to the given document service factory.
  * @param documentServiceFactory - The document service factory to apply compression to.
  * @param config - The compression configuration.
- * @returns - The document service factory with compression applied.
+ * @returns The document service factory with compression applied.
  */
 function applyStorageCompressionInternal(
 	constructor: new (
+		// eslint-disable-next-line @typescript-eslint/no-shadow
 		documentServiceFactory: IDocumentServiceFactory,
+		// eslint-disable-next-line @typescript-eslint/no-shadow
 		config: ICompressionStorageConfig,
 	) => IDocumentServiceFactory,
 	documentServiceFactory: IDocumentServiceFactory,

package/src/buildSnapshotTree.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { assert, stringToBuffer } from "@fluidframework/common-utils";
+import { stringToBuffer } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils";
 import * as git from "@fluidframework/gitresources";
 import {
 	FileMode,
@@ -11,7 +12,7 @@ import {
 	ITreeEntry,
 	TreeEntry,
 } from "@fluidframework/protocol-definitions";
-import { buildHierarchy } from "@fluidframework/protocol-base";
+import { buildGitTreeHierarchy } from "@fluidframework/protocol-base";
 import { v4 as uuid } from "uuid";
 
 function flattenCore(
@@ -91,5 +92,5 @@ export function buildSnapshotTree(
 	blobMap: Map<string, ArrayBufferLike>,
 ): ISnapshotTree {
 	const flattened = flatten(entries, blobMap);
-	return buildHierarchy(flattened);
+	return buildGitTreeHierarchy(flattened);
 }

package/src/documentStorageServiceProxy.ts

@@ -54,7 +54,6 @@ export class DocumentStorageServiceProxy implements IDocumentStorageService {
 		summary: ISummaryTree,
 		context: ISummaryContext,
 	): Promise<string> {
-		console.log(`Summary uploaded:  ${JSON.stringify(summary).length} bytes`);
 		return this.internalStorageService.uploadSummaryWithContext(summary, context);
 	}
 

package/src/error.ts

@@ -3,11 +3,13 @@
  * Licensed under the MIT License.
  */
 
+// eslint-disable-next-line import/no-deprecated
 import { DriverErrorType, IDriverErrorBase } from "@fluidframework/driver-definitions";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
 
 /** Error indicating an API is being used improperly resulting in an invalid operation. */
 export class UsageError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
+	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.usageError;
 	readonly canRetry = false;
 

package/src/index.ts

@@ -40,9 +40,8 @@ export {
 export { PrefetchDocumentStorageService } from "./prefetchDocumentStorageService";
 export { RateLimiter } from "./rateLimiter";
 export { readAndParse } from "./readAndParse";
-export { IProgress, runWithRetry } from "./runWithRetry";
+export { calculateMaxWaitTime, IProgress, runWithRetry } from "./runWithRetry";
 export {
-	combineAppAndProtocolSummary,
 	CombinedAppAndProtocolSummary,
 	getDocAttributesFromProtocolSummary,
 	getQuorumValuesFromProtocolSummary,

package/src/insecureUrlResolver.ts

@@ -4,7 +4,7 @@
  */
 
 import { parse } from "url";
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 import { IRequest } from "@fluidframework/core-interfaces";
 import { IResolvedUrl, IUrlResolver, DriverHeader } from "@fluidframework/driver-definitions";
 import Axios from "axios";

package/src/network.ts

@@ -7,9 +7,11 @@ import {
 	IThrottlingWarning,
 	IDriverErrorBase,
 	IAuthorizationError,
+	// eslint-disable-next-line import/no-deprecated
 	DriverErrorType,
 	ILocationRedirectionError,
 	IResolvedUrl,
+	DriverErrorTypes,
 } from "@fluidframework/driver-definitions";
 import { ITelemetryProperties } from "@fluidframework/core-interfaces";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
@@ -43,6 +45,7 @@ export type DriverErrorTelemetryProps = ITelemetryProperties & {
  * Generic network error class.
  */
 export class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
+	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.genericNetworkError;
 
 	constructor(message: string, readonly canRetry: boolean, props: DriverErrorTelemetryProps) {
@@ -57,6 +60,7 @@ export class FluidInvalidSchemaError
 	extends LoggingError
 	implements IDriverErrorBase, IFluidErrorBase
 {
+	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.fluidInvalidSchema;
 	readonly canRetry = false;
 
@@ -69,6 +73,7 @@ export class DeltaStreamConnectionForbiddenError
 	extends LoggingError
 	implements IDriverErrorBase, IFluidErrorBase
 {
+	// eslint-disable-next-line import/no-deprecated
 	static readonly errorType = DriverErrorType.deltaStreamConnectionForbidden;
 	readonly errorType = DeltaStreamConnectionForbiddenError.errorType;
 	readonly canRetry = false;
@@ -84,6 +89,7 @@ export class AuthorizationError
 	extends LoggingError
 	implements IAuthorizationError, IFluidErrorBase
 {
+	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.authorizationError;
 	readonly canRetry = false;
 
@@ -102,6 +108,7 @@ export class LocationRedirectionError
 	extends LoggingError
 	implements ILocationRedirectionError, IFluidErrorBase
 {
+	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.locationRedirection;
 	readonly canRetry = false;
 
@@ -142,6 +149,7 @@ export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
  * Throttling error class - used to communicate all throttling errors
  */
 export class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {
+	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.throttlingError;
 	readonly canRetry = true;
 
@@ -155,7 +163,7 @@ export class ThrottlingError extends LoggingError implements IThrottlingWarning,
 }
 
 export const createWriteError = (message: string, props: DriverErrorTelemetryProps) =>
-	new NonRetryableError(message, DriverErrorType.writeError, props);
+	new NonRetryableError(message, DriverErrorTypes.writeError, props);
 
 export function createGenericNetworkError(
 	message: string,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-dev.5.3.2.178189";
+export const pkgVersion = "2.0.0-dev.6.4.0.191457";

package/src/parallelRequests.ts

@@ -2,8 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { assert, Deferred, performance } from "@fluidframework/common-utils";
+import { performance } from "@fluid-internal/client-utils";
 import { ITelemetryProperties } from "@fluidframework/core-interfaces";
+import { assert, Deferred } from "@fluidframework/core-utils";
 import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IDeltasFetchResult, IStream, IStreamResult } from "@fluidframework/driver-definitions";
@@ -27,7 +28,7 @@ type WorkingState = "working" | "done" | "canceled";
  * @param payloadSize - batch size
  * @param logger - logger to use
  * @param requestCallback - callback to request batches
- * @returns - Queue that can be used to retrieve data
+ * @returns Queue that can be used to retrieve data
  */
 export class ParallelRequests<T> {
 	private latestRequested: number;
@@ -404,7 +405,7 @@ const waitForOnline = async (): Promise<void> => {
  * @param logger - logger object to use to log progress & errors
  * @param signal - cancelation signal
  * @param scenarioName - reason for fetching ops
- * @returns - an object with resulting ops and cancellation / partial result flags
+ * @returns An object with resulting ops and cancellation / partial result flags
  */
 async function getSingleOpBatch(
 	get: (telemetryProps: ITelemetryProperties) => Promise<IDeltasFetchResult>,
@@ -529,7 +530,7 @@ async function getSingleOpBatch(
  * @param logger - Logger to log progress and errors
  * @param signal - Cancelation signal
  * @param scenarioName - Reason for fetching ops
- * @returns - Messages fetched
+ * @returns Messages fetched
  */
 export function requestOps(
 	get: (

package/src/rateLimiter.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 
 export class RateLimiter {
 	private readonly tasks: (() => void)[] = [];

package/src/readAndParse.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { bufferToString } from "@fluidframework/common-utils";
+import { bufferToString } from "@fluid-internal/client-utils";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 
 /**

package/src/runWithRetry.ts

@@ -3,9 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
-import { delay, performance } from "@fluidframework/common-utils";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
+import { ITelemetryLoggerExt, isFluidError } from "@fluidframework/telemetry-utils";
+import { performance } from "@fluid-internal/client-utils";
+import { delay } from "@fluidframework/core-utils";
+import { DriverErrorTypes } from "@fluidframework/driver-definitions";
 import { canRetryOnError, getRetryDelayFromError } from "./network";
 import { pkgVersion } from "./packageVersion";
 import { NonRetryableError } from ".";
@@ -80,13 +81,20 @@ export async function runWithRetry<T>(
 						retry: numRetries,
 						duration: performance.now() - startTime,
 						fetchCallName,
+						// TODO: Remove when typescript version of the repo contains the AbortSignal.reason property (AB#5045)
+						reason: (progress.cancel as AbortSignal & { reason: any }).reason,
 					},
 					err,
 				);
 				throw new NonRetryableError(
 					"runWithRetry was Aborted",
-					DriverErrorType.genericError,
-					{ driverVersion: pkgVersion, fetchCallName },
+					DriverErrorTypes.genericError,
+					{
+						driverVersion: pkgVersion,
+						fetchCallName,
+						// TODO: Remove when typescript version of the repo contains the AbortSignal.reason property (AB#5045)
+						reason: (progress.cancel as AbortSignal & { reason: any }).reason,
+					},
 				);
 			}
 
@@ -107,8 +115,9 @@ export async function runWithRetry<T>(
 			numRetries++;
 			lastError = err;
 			// If the error is throttling error, then wait for the specified time before retrying.
-			// If the waitTime is not specified, then we start with retrying immediately to max of 8s.
-			retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);
+			retryAfterMs =
+				getRetryDelayFromError(err) ??
+				Math.min(retryAfterMs * 2, calculateMaxWaitTime(err));
 			if (progress.onRetry) {
 				progress.onRetry(retryAfterMs, err);
 			}
@@ -129,3 +138,19 @@ export async function runWithRetry<T>(
 	// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 	return result!;
 }
+
+const MaxReconnectDelayInMsWhenEndpointIsReachable = 30000;
+const MaxReconnectDelayInMsWhenEndpointIsNotReachable = 8000;
+
+/**
+ * In case endpoint(service or socket) is not reachable, then we maybe offline or may have got some transient error
+ * not related to endpoint, in that case we want to try at faster pace and hence the max wait is lesser 8s as compared
+ * to when endpoint is reachable in which case it is 30s.
+ * @param error - error based on which we decide max wait time.
+ * @returns Max wait time.
+ */
+export function calculateMaxWaitTime(error: unknown): number {
+	return isFluidError(error) && error.getTelemetryProperties().endpointReached === true
+		? MaxReconnectDelayInMsWhenEndpointIsReachable
+		: MaxReconnectDelayInMsWhenEndpointIsNotReachable;
+}

package/src/summaryForCreateNew.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
 import {
 	ISummaryTree,
 	SummaryType,
@@ -46,36 +45,6 @@ export function isCombinedAppAndProtocolSummary(
 	return true;
 }
 
-/**
- * Combine the app summary and protocol summary in 1 tree.
- * @param appSummary - Summary of the app.
- * @param protocolSummary - Summary of the protocol.
- * @internal
- *
- * @deprecated 2.0.0-internal.3.4.0 - Not intended for public use.  Will be moved to container-loader and no longer exported in an upcoming release.
- */
-export function combineAppAndProtocolSummary(
-	appSummary: ISummaryTree,
-	protocolSummary: ISummaryTree,
-): CombinedAppAndProtocolSummary {
-	assert(
-		!isCombinedAppAndProtocolSummary(appSummary),
-		0x5a8 /* app summary is already a combined tree! */,
-	);
-	assert(
-		!isCombinedAppAndProtocolSummary(protocolSummary),
-		0x5a9 /* protocol summary is already a combined tree! */,
-	);
-	const createNewSummary: CombinedAppAndProtocolSummary = {
-		type: SummaryType.Tree,
-		tree: {
-			".protocol": protocolSummary,
-			".app": appSummary,
-		},
-	};
-	return createNewSummary;
-}
-
 /**
  * Extract the attributes from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.

package/src/treeConversions.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { Uint8ArrayToString, unreachableCase } from "@fluidframework/common-utils";
+import { Uint8ArrayToString } from "@fluid-internal/client-utils";
+import { unreachableCase } from "@fluidframework/core-utils";
 import { ISummaryTree, ITree, ITreeEntry, SummaryType } from "@fluidframework/protocol-definitions";
 import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "./blob";
 import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew";