@fluidframework/driver-utils 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.0

package/src/runWithRetry.ts

@@ -14,7 +14,7 @@ import { NonRetryableError } from ".";
 /**
  * Interface describing an object passed to various network APIs.
  * It allows caller to control cancellation, as well as learn about any delays.
- * @public
+ * @internal
  */
 export interface IProgress {
 	/**
@@ -45,7 +45,7 @@ export interface IProgress {
 }
 
 /**
- * @public
+ * @internal
  */
 export async function runWithRetry<T>(
 	api: (cancel?: AbortSignal) => Promise<T>,
@@ -55,7 +55,8 @@ export async function runWithRetry<T>(
 ): Promise<T> {
 	let result: T | undefined;
 	let success = false;
-	let retryAfterMs = 1000; // has to be positive!
+	// We double this value in first try in when we calculate time to wait for in "calculateMaxWaitTime" function.
+	let retryAfterMs = 500; // has to be positive!
 	let numRetries = 0;
 	const startTime = performance.now();
 	let lastError: any;
@@ -116,10 +117,8 @@ export async function runWithRetry<T>(
 
 			numRetries++;
 			lastError = err;
-			// If the error is throttling error, then wait for the specified time before retrying.
-			retryAfterMs =
-				getRetryDelayFromError(err) ??
-				Math.min(retryAfterMs * 2, calculateMaxWaitTime(err));
+			// Wait for the calculated time before retrying.
+			retryAfterMs = calculateMaxWaitTime(retryAfterMs, err);
 			if (progress.onRetry) {
 				progress.onRetry(retryAfterMs, err);
 			}
@@ -141,19 +140,27 @@ export async function runWithRetry<T>(
 	return result!;
 }
 
-const MaxReconnectDelayInMsWhenEndpointIsReachable = 30000;
+const MaxReconnectDelayInMsWhenEndpointIsReachable = 60000;
 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.
- * @public
+ * Calculates time to wait for after an error based on the error and wait time for previous iteration.
+ * 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 60s.
+ * @param delayMs - wait time for previous iteration
+ * @param error - error based on which we decide wait time.
+ * @returns Wait time to wait for.
+ * @internal
  */
-export function calculateMaxWaitTime(error: unknown): number {
-	return isFluidError(error) && error.getTelemetryProperties().endpointReached === true
-		? MaxReconnectDelayInMsWhenEndpointIsReachable
-		: MaxReconnectDelayInMsWhenEndpointIsNotReachable;
+export function calculateMaxWaitTime(delayMs: number, error: unknown): number {
+	const retryDelayFromError = getRetryDelayFromError(error);
+	let newDelayMs = Math.max(retryDelayFromError ?? 0, delayMs * 2);
+	newDelayMs = Math.min(
+		delayMs,
+		isFluidError(error) && error.getTelemetryProperties().endpointReached === true
+			? MaxReconnectDelayInMsWhenEndpointIsReachable
+			: MaxReconnectDelayInMsWhenEndpointIsNotReachable,
+	);
+	return newDelayMs;
 }

package/src/summaryForCreateNew.ts

@@ -49,7 +49,7 @@ export function isCombinedAppAndProtocolSummary(
 /**
  * Extract the attributes from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
- * @public
+ * @internal
  */
 export function getDocAttributesFromProtocolSummary(
 	protocolSummary: ISummaryTree,
@@ -61,7 +61,7 @@ export function getDocAttributesFromProtocolSummary(
 /**
  * Extract quorum values from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
- * @public
+ * @internal
  */
 export function getQuorumValuesFromProtocolSummary(
 	protocolSummary: ISummaryTree,

package/src/treeConversions.ts

@@ -12,7 +12,7 @@ import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew";
 /**
  * Converts ISummaryTree to ITree format.
  * @param summaryTree - summary tree in ISummaryTree format
- * @public
+ * @internal
  */
 export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree {
 	const entries: ITreeEntry[] = [];