@fluidframework/driver-utils 2.81.1 → 2.82.0

package/src/prefetchDocumentStorageService.ts

@@ -28,6 +28,7 @@ export class PrefetchDocumentStorageService extends DocumentStorageServiceProxy
 		}
 	}
 
+	// eslint-disable-next-line @rushstack/no-new-null -- TODO: use `undefined` instead
 	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
 		const p = this.internalStorageService.getSnapshotTree(version);
 		if (this.prefetchEnabled) {
@@ -67,12 +68,13 @@ export class PrefetchDocumentStorageService extends DocumentStorageServiceProxy
 			// 2. Prevent unhandled rejection warning for fire-and-forget prefetch
 			// Note: Callers who await the cached promise will still see the rejection
 			prefetchedBlobPFromStorage.catch((error) => {
-				if (canRetryOnError(error)) {
-					// Only clear cache if our promise is still the cached one
-					// (avoids race condition with concurrent requests)
-					if (this.prefetchCache.get(blobId) === prefetchedBlobPFromStorage) {
-						this.prefetchCache.delete(blobId);
-					}
+				// Only clear cache if our promise is still the cached one
+				// (avoids race condition with concurrent requests)
+				if (
+					canRetryOnError(error) &&
+					this.prefetchCache.get(blobId) === prefetchedBlobPFromStorage
+				) {
+					this.prefetchCache.delete(blobId);
 				}
 			});
 			this.prefetchCache.set(blobId, prefetchedBlobPFromStorage);
@@ -105,10 +107,8 @@ export class PrefetchDocumentStorageService extends DocumentStorageServiceProxy
 					// since cachedRead is async and returns a separate promise chain.
 					this.cachedRead(blob).catch(() => {});
 				}
-			} else if (!blobKey.startsWith("deltas")) {
-				if (blob !== null) {
-					secondary.push(blob);
-				}
+			} else if (!blobKey.startsWith("deltas") && blob !== null) {
+				secondary.push(blob);
 			}
 		}
 

package/src/protocol/gitHelper.ts

@@ -6,10 +6,10 @@
 import { unreachableCase } from "@fluidframework/core-utils/internal";
 import {
 	FileMode,
-	IGitTree,
-	ISnapshotTreeEx,
+	type IGitTree,
+	type ISnapshotTreeEx,
+	type SummaryObject,
 	SummaryType,
-	SummaryObject,
 } from "@fluidframework/driver-definitions/internal";
 
 /**
@@ -23,12 +23,15 @@ export function getGitMode(value: SummaryObject): string {
 	const type = value.type === SummaryType.Handle ? value.handleType : value.type;
 	switch (type) {
 		case SummaryType.Blob:
-		case SummaryType.Attachment:
+		case SummaryType.Attachment: {
 			return FileMode.File;
-		case SummaryType.Tree:
+		}
+		case SummaryType.Tree: {
 			return FileMode.Directory;
-		default:
+		}
+		default: {
 			unreachableCase(type, `Unknown type: ${type}`);
+		}
 	}
 }
 
@@ -44,12 +47,15 @@ export function getGitType(value: SummaryObject): "blob" | "tree" {
 
 	switch (type) {
 		case SummaryType.Blob:
-		case SummaryType.Attachment:
+		case SummaryType.Attachment: {
 			return "blob";
-		case SummaryType.Tree:
+		}
+		case SummaryType.Tree: {
 			return "tree";
-		default:
+		}
+		default: {
 			unreachableCase(type, `Unknown type: ${type}`);
+		}
 	}
 }
 

package/src/readAndParse.ts

@@ -4,7 +4,7 @@
  */
 
 import { bufferToString } from "@fluid-internal/client-utils";
-import { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
+import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Read a blob from {@link @fluidframework/driver-definitions#IDocumentStorageService} and

package/src/runWithRetry.ts

@@ -6,7 +6,10 @@
 import { performanceNow } from "@fluid-internal/client-utils";
 import { delay } from "@fluidframework/core-utils/internal";
 import { DriverErrorTypes } from "@fluidframework/driver-definitions/internal";
-import { ITelemetryLoggerExt, isFluidError } from "@fluidframework/telemetry-utils/internal";
+import {
+	isFluidError,
+	type ITelemetryLoggerExt,
+} from "@fluidframework/telemetry-utils/internal";
 
 import { NonRetryableError, canRetryOnError, getRetryDelayFromError } from "./network.js";
 import { pkgVersion } from "./packageVersion.js";
@@ -41,10 +44,12 @@ export interface IProgress {
 	 * as well as information provided by service (like 429 error asking to wait for some time before retry)
 	 * @param error - error object returned from the call.
 	 */
-	onRetry?(delayInMs: number, error: any): void;
+	onRetry?(delayInMs: number, error: unknown): void;
 }
 
 /**
+ * Runs the provided API call with automatic retry logic.
+ *
  * @internal
  */
 export async function runWithRetry<T>(
@@ -59,14 +64,14 @@ export async function runWithRetry<T>(
 	let retryAfterMs = 500; // has to be positive!
 	let numRetries = 0;
 	const startTime = performanceNow();
-	let lastError: any;
+	let lastError: unknown;
 	do {
 		try {
 			result = await api(progress.cancel);
 			success = true;
-		} catch (err) {
+		} catch (error) {
 			// If it is not retriable, then just throw the error.
-			if (!canRetryOnError(err)) {
+			if (!canRetryOnError(error)) {
 				logger.sendTelemetryEvent(
 					{
 						eventName: `${fetchCallName}_cancel`,
@@ -74,21 +79,22 @@ export async function runWithRetry<T>(
 						duration: performanceNow() - startTime,
 						fetchCallName,
 					},
-					err,
+					error,
 				);
-				throw err;
+				throw error;
 			}
 
 			if (progress.cancel?.aborted === true) {
+				const abortReason = progress.cancel.reason as string;
 				logger.sendTelemetryEvent(
 					{
 						eventName: `${fetchCallName}_runWithRetryAborted`,
 						retry: numRetries,
 						duration: performanceNow() - startTime,
 						fetchCallName,
-						reason: progress.cancel.reason,
+						reason: abortReason,
 					},
-					err,
+					error,
 				);
 				throw new NonRetryableError(
 					"runWithRetry was Aborted",
@@ -96,7 +102,7 @@ export async function runWithRetry<T>(
 					{
 						driverVersion: pkgVersion,
 						fetchCallName,
-						reason: progress.cancel.reason,
+						reason: abortReason,
 					},
 				);
 			}
@@ -111,16 +117,16 @@ export async function runWithRetry<T>(
 						duration: performanceNow() - startTime,
 						fetchCallName,
 					},
-					err,
+					error,
 				);
 			}
 
 			numRetries++;
-			lastError = err;
+			lastError = error;
 			// Wait for the calculated time before retrying.
-			retryAfterMs = calculateMaxWaitTime(retryAfterMs, err);
+			retryAfterMs = calculateMaxWaitTime(retryAfterMs, error);
 			if (progress.onRetry) {
-				progress.onRetry(retryAfterMs, err);
+				progress.onRetry(retryAfterMs, error);
 			}
 			await delay(retryAfterMs);
 		}

package/src/storageUtils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ISnapshot, ISnapshotTree } from "@fluidframework/driver-definitions/internal";
+import type { ISnapshot, ISnapshotTree } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Utility API to check if the type of snapshot contents is `ISnapshot`.

package/src/summaryForCreateNew.ts

@@ -3,8 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import { ISummaryBlob, ISummaryTree, SummaryType } from "@fluidframework/driver-definitions";
 import {
+	type ISummaryBlob,
+	type ISummaryTree,
+	SummaryType,
+} from "@fluidframework/driver-definitions";
+import type {
 	ICommittedProposal,
 	IDocumentAttributes,
 } from "@fluidframework/driver-definitions/internal";

package/src/treeConversions.ts

@@ -5,8 +5,8 @@
 
 import { Uint8ArrayToString } from "@fluid-internal/client-utils";
 import { unreachableCase } from "@fluidframework/core-utils/internal";
-import { ISummaryTree, SummaryType } from "@fluidframework/driver-definitions";
-import { ITree, ITreeEntry } from "@fluidframework/driver-definitions/internal";
+import { type ISummaryTree, SummaryType } from "@fluidframework/driver-definitions";
+import type { ITree, ITreeEntry } from "@fluidframework/driver-definitions/internal";
 
 import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "./blob.js";
 import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew.js";
@@ -31,6 +31,7 @@ export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): IT
 		switch (value.type) {
 			case SummaryType.Blob: {
 				let parsedContent: string;
+				// eslint-disable-next-line unicorn/text-encoding-identifier-case
 				let encoding: "utf-8" | "base64" = "utf-8";
 				if (typeof value.content === "string") {
 					parsedContent = value.content;
@@ -56,8 +57,9 @@ export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): IT
 				throw new Error("Should not have Handle type in summary tree");
 			}
 
-			default:
+			default: {
 				unreachableCase(value, "Unexpected summary tree type");
+			}
 		}
 	}
 	return {

package/biome.jsonc

@@ -1,4 +0,0 @@
-{
-	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
-	"extends": ["../../../biome.jsonc"]
-}