@fluidframework/driver-utils 2.0.0-internal.5.3.2 → 2.0.0-internal.6.0.0

package/src/runWithRetry.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { ITelemetryLoggerExt, isFluidError } from "@fluidframework/telemetry-utils";
 import { delay, performance } from "@fluidframework/common-utils";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
 import { canRetryOnError, getRetryDelayFromError } from "./network";
@@ -80,13 +80,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 },
+					{
+						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 +114,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 +137,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.