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

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,11 +7,13 @@ import {
 	IThrottlingWarning,
 	IDriverErrorBase,
 	IAuthorizationError,
+	// eslint-disable-next-line import/no-deprecated
 	DriverErrorType,
 	ILocationRedirectionError,
 	IResolvedUrl,
+	DriverErrorTypes,
 } from "@fluidframework/driver-definitions";
-import { ITelemetryProperties } from "@fluidframework/common-definitions";
+import { ITelemetryProperties } from "@fluidframework/core-interfaces";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
 
 export enum OnlineStatus {
@@ -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/networkUtils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryErrorEvent } from "@fluidframework/common-definitions";
+import { ITelemetryErrorEvent } from "@fluidframework/core-interfaces";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { isOnline, OnlineStatus, canRetryOnError } from "./network";
 

package/src/packageVersion.ts

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

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 { ITelemetryProperties } from "@fluidframework/common-definitions";
+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;
@@ -309,9 +310,10 @@ export class ParallelRequests<T> {
 				if (to === this.latestRequested) {
 					// we can go after full chunk at the end if we received partial chunk, or more than asked
 					// Also if we got more than we asked to, we can actually use those ops!
-					if (payload.length !== 0) {
-						this.results.set(from, payload);
-						from += payload.length;
+					while (payload.length !== 0) {
+						const data = payload.splice(0, requestedLength);
+						this.results.set(from, data);
+						from += data.length;
 					}
 
 					this.latestRequested = from;
@@ -403,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>,
@@ -528,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";