refactor(driver-utils): Promote eslint config from "minimalDeprecated" to "recommended" and fix violations (microsoft#26304)

Part of a larger effort to remove the "minimalDeprecated" configuration.

Also adds a missing dev dependency on `@types/lz4js`.

Author: Josmithr

packages/loader/driver-utils/eslint.config.mts

@@ -4,10 +4,10 @@
  */
 
 import type { Linter } from "eslint";
-import { minimalDeprecated } from "../../../common/build/eslint-config-fluid/flat.mts";
+import { recommended } from "../../../common/build/eslint-config-fluid/flat.mts";
 
 const config: Linter.Config[] = [
-	...minimalDeprecated,
+	...recommended,
 	{
 		rules: {
 			"import-x/no-nodejs-modules": ["error"],

packages/loader/driver-utils/package.json

@@ -133,6 +133,7 @@
 		"@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.81.0",
 		"@fluidframework/eslint-config-fluid": "workspace:~",
 		"@microsoft/api-extractor": "7.52.11",
+		"@types/lz4js": "^0.2.0",
 		"@types/mocha": "^10.0.10",
 		"@types/node": "~20.19.30",
 		"@types/sinon": "^17.0.3",

packages/loader/driver-utils/src/adapters/compression/documentServiceCompressionAdapter.ts

@@ -3,14 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IDocumentService,
 	IDocumentStorageService,
 } from "@fluidframework/driver-definitions/internal";
 
 import { DocumentServiceProxy } from "../../documentServiceProxy.js";
 
-import { ICompressionStorageConfig } from "./compressionTypes.js";
+import type { ICompressionStorageConfig } from "./compressionTypes.js";
 import { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from "./summaryblob/index.js";
 
 export class DocumentServiceCompressionAdapter extends DocumentServiceProxy {

packages/loader/driver-utils/src/adapters/compression/documentServiceFactoryCompressionAdapter.ts

@@ -3,17 +3,17 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
-import { ISummaryTree } from "@fluidframework/driver-definitions";
-import {
+import type { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { ISummaryTree } from "@fluidframework/driver-definitions";
+import type {
 	IDocumentService,
 	IDocumentServiceFactory,
 	IResolvedUrl,
 } from "@fluidframework/driver-definitions/internal";
 
 import { DocumentServiceFactoryProxy } from "../../documentServiceFactoryProxy.js";
 
-import { ICompressionStorageConfig } from "./compressionTypes.js";
+import type { ICompressionStorageConfig } from "./compressionTypes.js";
 import { DocumentServiceCompressionAdapter } from "./documentServiceCompressionAdapter.js";
 import { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from "./summaryblob/index.js";
 

packages/loader/driver-utils/src/adapters/compression/index.ts

@@ -5,7 +5,7 @@
 
 export {
 	SummaryCompressionAlgorithm,
-	ICompressionStorageConfig,
+	type ICompressionStorageConfig,
 	DefaultCompressionStorageConfig,
 } from "./compressionTypes.js";
 export { DocumentServiceFactoryCompressionAdapter } from "./documentServiceFactoryCompressionAdapter.js";

packages/loader/driver-utils/src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts

@@ -6,13 +6,13 @@
 import { type Buffer, IsoBuffer } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
 import {
-	ISummaryBlob,
-	ISummaryHandle,
-	ISummaryTree,
-	SummaryObject,
+	type ISummaryBlob,
+	type ISummaryHandle,
+	type ISummaryTree,
+	type SummaryObject,
 	SummaryType,
 } from "@fluidframework/driver-definitions";
-import {
+import type {
 	IDocumentStorageService,
 	ISummaryContext,
 	ISnapshotTree,
@@ -74,10 +74,10 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 * @param blob - The maybe compressed blob.
 	 */
 	private static readAlgorithmFromBlob(blob: ArrayBufferLike): number {
-		return !this.hasPrefix(blob)
-			? SummaryCompressionAlgorithm.None
-			: // eslint-disable-next-line no-bitwise
-				IsoBuffer.from(blob)[0] & 0x0f;
+		return this.hasPrefix(blob)
+			? // eslint-disable-next-line no-bitwise
+				IsoBuffer.from(blob)[0] & 0x0f
+			: SummaryCompressionAlgorithm.None;
 	}
 
 	/**
@@ -202,7 +202,7 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 		} else if (algorithm === SummaryCompressionAlgorithm.None) {
 			maybeCompressed = file;
 		} else if (algorithm === SummaryCompressionAlgorithm.LZ4) {
-			const compressed = compress(file) as ArrayBufferLike;
+			const compressed = compress(file as Uint8Array) as ArrayBufferLike;
 			maybeCompressed = compressed;
 		} else {
 			throw new Error(`Unknown Algorithm ${config.algorithm}`);
@@ -221,8 +221,9 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 */
 	private static decodeBlob(file: ArrayBufferLike): ArrayBufferLike {
 		let decompressed: ArrayBufferLike;
-		let originalBlob;
-		let algorithm;
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: use a real type
+		let originalBlob: any;
+		let algorithm: SummaryCompressionAlgorithm;
 		if (this.hasPrefix(file)) {
 			algorithm = DocumentStorageServiceCompressionAdapter.readAlgorithmFromBlob(file);
 			originalBlob = this.removePrefixFromBlobIfPresent(file);
@@ -231,8 +232,10 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 			originalBlob = file;
 		}
 		if (algorithm === SummaryCompressionAlgorithm.None) {
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 			decompressed = originalBlob;
 		} else if (algorithm === SummaryCompressionAlgorithm.LZ4) {
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment
 			decompressed = decompress(originalBlob) as ArrayBufferLike;
 		} else {
 			throw new Error(`Unknown Algorithm ${algorithm}`);
@@ -267,12 +270,13 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 		}
 		let clone: object | undefined;
 		for (const key of Object.keys(input)) {
-			const value = input[key];
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+			const value: SummaryObject = input[key];
 
 			if (Boolean(value) && typeof value === "object") {
 				const replaced = this.recursivelyReplace(
 					isEncode,
-					value as SummaryObject,
+					value,
 					encoder,
 					decoder,
 					config,
@@ -396,13 +400,13 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 */
 	public override async readBlob(id: string): Promise<ArrayBufferLike> {
 		const originalBlob = await super.readBlob(id);
-		if (!this._isCompressionEnabled) {
-			return originalBlob;
-		} else {
+		if (this._isCompressionEnabled) {
 			const decompressedBlob =
 				DocumentStorageServiceCompressionAdapter.decodeBlob(originalBlob);
 			//			console.log(`Miso summary-blob Blob read END : ${id} ${decompressedBlob.byteLength}`);
 			return decompressedBlob;
+		} else {
+			return originalBlob;
 		}
 	}
 
@@ -451,14 +455,14 @@ export class DocumentStorageServiceCompressionAdapter extends DocumentStorageSer
 	 */
 	public override async downloadSummary(id: ISummaryHandle): Promise<ISummaryTree> {
 		const summary = await super.downloadSummary(id);
-		return !this._isCompressionEnabled
-			? summary
-			: (DocumentStorageServiceCompressionAdapter.recursivelyReplace(
+		return this._isCompressionEnabled
+			? (DocumentStorageServiceCompressionAdapter.recursivelyReplace(
 					false,
 					summary,
 					DocumentStorageServiceCompressionAdapter.blobEncoder,
 					DocumentStorageServiceCompressionAdapter.blobDecoder,
 					this._config,
-				) as ISummaryTree);
+				) as ISummaryTree)
+			: summary;
 	}
 }

packages/loader/driver-utils/src/adapters/index.ts

@@ -5,7 +5,7 @@
 
 export {
 	SummaryCompressionAlgorithm,
-	ICompressionStorageConfig,
+	type ICompressionStorageConfig,
 	DefaultCompressionStorageConfig,
 	blobHeadersBlobName,
 } from "./compression/index.js";

packages/loader/driver-utils/src/adapters/predefinedAdapters.ts

@@ -4,12 +4,12 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
-import { IDocumentServiceFactory } from "@fluidframework/driver-definitions/internal";
+import type { IDocumentServiceFactory } from "@fluidframework/driver-definitions/internal";
 
 import {
 	DefaultCompressionStorageConfig,
 	DocumentServiceFactoryCompressionAdapter,
-	ICompressionStorageConfig,
+	type ICompressionStorageConfig,
 } from "./compression/index.js";
 
 /**
@@ -67,9 +67,12 @@ function applyStorageCompressionInternal(
  * This method checks whether given objects contains
  * a properties expected for the interface ICompressionStorageConfig.
  */
-export function isCompressionConfig(config: any): config is ICompressionStorageConfig {
+export function isCompressionConfig(config: unknown): config is ICompressionStorageConfig {
 	return (
 		config !== undefined &&
-		(config.algorithm !== undefined || config.minSizeToCompress !== undefined)
+		typeof config === "object" &&
+		config !== null &&
+		((config as Partial<ICompressionStorageConfig>).algorithm !== undefined ||
+			(config as Partial<ICompressionStorageConfig>).minSizeToCompress !== undefined)
 	);
 }

packages/loader/driver-utils/src/blob.ts

@@ -3,13 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import {
-	FileMode,
-	IAttachment,
-	IBlob,
-	ITree,
-	TreeEntry,
-} from "@fluidframework/driver-definitions/internal";
+import type { IAttachment, IBlob, ITree } from "@fluidframework/driver-definitions/internal";
+import { FileMode, TreeEntry } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Basic implementation of a blob ITreeEntry
@@ -29,6 +24,7 @@ export class BlobTreeEntry {
 	constructor(
 		public readonly path: string,
 		contents: string,
+		// eslint-disable-next-line unicorn/text-encoding-identifier-case
 		encoding: "utf-8" | "base64" = "utf-8",
 	) {
 		this.value = { contents, encoding };

packages/loader/driver-utils/src/buildSnapshotTree.ts

@@ -7,10 +7,10 @@ import { stringToBuffer } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
 import {
 	FileMode,
-	IGitTree,
-	IGitTreeEntry,
-	ISnapshotTree,
-	ITreeEntry,
+	type IGitTree,
+	type IGitTreeEntry,
+	type ISnapshotTree,
+	type ITreeEntry,
 	TreeEntry,
 } from "@fluidframework/driver-definitions/internal";
 import { v4 as uuid } from "uuid";
@@ -33,7 +33,7 @@ function flattenCore(
 			blobMap.set(id, buffer);
 
 			const entry: IGitTreeEntry = {
-				mode: FileMode[treeEntry.mode],
+				mode: FileMode[treeEntry.mode] as string,
 				path: subPath,
 				sha: id,
 				size: 0,
@@ -48,7 +48,7 @@ function flattenCore(
 			);
 			const t = treeEntry.value;
 			const entry: IGitTreeEntry = {
-				mode: FileMode[treeEntry.mode],
+				mode: FileMode[treeEntry.mode] as string,
 				path: subPath,
 				sha: "",
 				size: -1,