@fluidframework/driver-utils 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "2.0.0-dev.2.3.0.115467",
+  "version": "2.0.0-dev.4.1.0.148229",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,33 +14,6 @@
   "main": "dist/index.js",
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:genver": "gen-version",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "npm run prettier:fix",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-    "test": "npm run test:mocha",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir .",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
   "nyc": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -63,43 +36,72 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/gitresources": "^0.1038.2000",
-    "@fluidframework/protocol-base": "^0.1038.2000",
+    "@fluidframework/common-utils": "^1.1.1",
+    "@fluidframework/core-interfaces": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/driver-definitions": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/gitresources": "^0.1039.1000",
+    "@fluidframework/protocol-base": "^0.1039.1000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.4.1.0.148229",
     "axios": "^0.26.0",
     "url": "^0.11.0",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.7.0",
+    "@fluid-tools/build-cli": "^0.13.1",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.7.0",
-    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.2.2.0",
-    "@fluidframework/eslint-config-fluid": "^1.2.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@fluidframework/build-tools": "^0.13.1",
+    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.4.0.0",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/runtime-utils": "2.0.0-dev.4.1.0.148229",
+    "@microsoft/api-extractor": "^7.34.4",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.0",
-    "concurrently": "^6.2.0",
+    "@types/node": "^14.18.38",
+    "@types/sinon": "^7.0.13",
+    "concurrently": "^7.6.0",
     "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.2",
+    "cross-env": "^7.0.3",
     "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
+    "rimraf": "^4.4.0",
+    "sinon": "^7.4.2",
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.3.0",
-    "baselineRange": ">=2.0.0-internal.2.2.0 <2.0.0-internal.2.3.0",
-    "baselineVersion": "2.0.0-internal.2.2.0",
     "broken": {}
+  },
+  "scripts": {
+    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha:multireport": "cross-env FLUID_TEST_MULTIREPORT=1 npm run test:mocha",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   }
-}
+}

package/prettier.config.cjs

@@ -4,5 +4,5 @@
  */
 
 module.exports = {
-    ...require("@fluidframework/build-common/prettier.config.cjs"),
+	...require("@fluidframework/build-common/prettier.config.cjs"),
 };

package/src/buildSnapshotTree.ts

@@ -6,57 +6,60 @@
 import { assert, stringToBuffer } from "@fluidframework/common-utils";
 import * as git from "@fluidframework/gitresources";
 import {
-    FileMode,
-    ISnapshotTree,
-    ITreeEntry,
-    TreeEntry,
+	FileMode,
+	ISnapshotTree,
+	ITreeEntry,
+	TreeEntry,
 } from "@fluidframework/protocol-definitions";
 import { buildHierarchy } from "@fluidframework/protocol-base";
 import { v4 as uuid } from "uuid";
 
 function flattenCore(
-    path: string,
-    treeEntries: ITreeEntry[],
-    blobMap: Map<string, ArrayBufferLike>,
+	path: string,
+	treeEntries: ITreeEntry[],
+	blobMap: Map<string, ArrayBufferLike>,
 ): git.ITreeEntry[] {
-    const entries: git.ITreeEntry[] = [];
-    for (const treeEntry of treeEntries) {
-        const subPath = `${path}${treeEntry.path}`;
+	const entries: git.ITreeEntry[] = [];
+	for (const treeEntry of treeEntries) {
+		const subPath = `${path}${treeEntry.path}`;
 
-        if (treeEntry.type === TreeEntry.Blob) {
-            const blob = treeEntry.value;
-            const buffer = stringToBuffer(blob.contents, blob.encoding);
-            const id = uuid();
-            blobMap.set(id, buffer);
+		if (treeEntry.type === TreeEntry.Blob) {
+			const blob = treeEntry.value;
+			const buffer = stringToBuffer(blob.contents, blob.encoding);
+			const id = uuid();
+			blobMap.set(id, buffer);
 
-            const entry: git.ITreeEntry = {
-                mode: FileMode[treeEntry.mode],
-                path: subPath,
-                sha: id,
-                size: 0,
-                type: "blob",
-                url: "",
-            };
-            entries.push(entry);
-        } else if (treeEntry.type === TreeEntry.Tree) {
-            assert(treeEntry.type === TreeEntry.Tree, 0x101 /* "Unexpected tree entry type on flatten!" */);
-            const t = treeEntry.value;
-            const entry: git.ITreeEntry = {
-                mode: FileMode[treeEntry.mode],
-                path: subPath,
-                sha: "",
-                size: -1,
-                type: "tree",
-                url: "",
-            };
-            entries.push(entry);
+			const entry: git.ITreeEntry = {
+				mode: FileMode[treeEntry.mode],
+				path: subPath,
+				sha: id,
+				size: 0,
+				type: "blob",
+				url: "",
+			};
+			entries.push(entry);
+		} else if (treeEntry.type === TreeEntry.Tree) {
+			assert(
+				treeEntry.type === TreeEntry.Tree,
+				0x101 /* "Unexpected tree entry type on flatten!" */,
+			);
+			const t = treeEntry.value;
+			const entry: git.ITreeEntry = {
+				mode: FileMode[treeEntry.mode],
+				path: subPath,
+				sha: "",
+				size: -1,
+				type: "tree",
+				url: "",
+			};
+			entries.push(entry);
 
-            const subTreeEntries = flattenCore(`${subPath}/`, t.entries, blobMap);
-            entries.push(...subTreeEntries);
-        }
-    }
+			const subTreeEntries = flattenCore(`${subPath}/`, t.entries, blobMap);
+			entries.push(...subTreeEntries);
+		}
+	}
 
-    return entries;
+	return entries;
 }
 
 /**
@@ -67,12 +70,12 @@ function flattenCore(
  * @returns A flatten with of the ITreeEntry
  */
 function flatten(tree: ITreeEntry[], blobMap: Map<string, ArrayBufferLike>): git.ITree {
-    const entries = flattenCore("", tree, blobMap);
-    return {
-        sha: "",
-        tree: entries,
-        url: "",
-    };
+	const entries = flattenCore("", tree, blobMap);
+	return {
+		sha: "",
+		tree: entries,
+		url: "",
+	};
 }
 
 /**
@@ -84,9 +87,9 @@ function flatten(tree: ITreeEntry[], blobMap: Map<string, ArrayBufferLike>): git
  * @returns the hierarchical tree
  */
 export function buildSnapshotTree(
-    entries: ITreeEntry[],
-    blobMap: Map<string, ArrayBufferLike>,
+	entries: ITreeEntry[],
+	blobMap: Map<string, ArrayBufferLike>,
 ): ISnapshotTree {
-    const flattened = flatten(entries, blobMap);
-    return buildHierarchy(flattened);
+	const flattened = flatten(entries, blobMap);
+	return buildHierarchy(flattened);
 }

package/src/documentStorageServiceProxy.ts

@@ -4,62 +4,68 @@
  */
 
 import {
-    FetchSource,
-    IDocumentStorageService,
-    IDocumentStorageServicePolicies,
-    ISummaryContext,
+	FetchSource,
+	IDocumentStorageService,
+	IDocumentStorageServicePolicies,
+	ISummaryContext,
 } from "@fluidframework/driver-definitions";
 import {
-    ICreateBlobResponse,
-    ISnapshotTree,
-    ISummaryHandle,
-    ISummaryTree,
-    IVersion,
+	ICreateBlobResponse,
+	ISnapshotTree,
+	ISummaryHandle,
+	ISummaryTree,
+	IVersion,
 } from "@fluidframework/protocol-definitions";
 
 export class DocumentStorageServiceProxy implements IDocumentStorageService {
-    private _policies: IDocumentStorageServicePolicies | undefined;
+	private _policies: IDocumentStorageServicePolicies | undefined;
 
-    public set policies(policies: IDocumentStorageServicePolicies | undefined) {
-        this._policies = policies;
-    }
+	public set policies(policies: IDocumentStorageServicePolicies | undefined) {
+		this._policies = policies;
+	}
 
-    public get policies() {
-        return this._policies ?? this.internalStorageService.policies;
-    }
+	public get policies() {
+		return this._policies ?? this.internalStorageService.policies;
+	}
 
-    public get repositoryUrl(): string {
-        return this.internalStorageService.repositoryUrl;
-    }
+	public get repositoryUrl(): string {
+		return this.internalStorageService.repositoryUrl;
+	}
 
-    constructor(protected readonly internalStorageService: IDocumentStorageService) { }
+	constructor(protected readonly internalStorageService: IDocumentStorageService) {}
 
-    public async getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null> {
-        return this.internalStorageService.getSnapshotTree(version, scenarioName);
-    }
+	public async getSnapshotTree(
+		version?: IVersion,
+		scenarioName?: string,
+	): Promise<ISnapshotTree | null> {
+		return this.internalStorageService.getSnapshotTree(version, scenarioName);
+	}
 
-    public async getVersions(
-        versionId: string | null,
-        count: number,
-        scenarioName?: string,
-        fetchSource?: FetchSource,
-    ): Promise<IVersion[]> {
-        return this.internalStorageService.getVersions(versionId, count, scenarioName, fetchSource);
-    }
+	public async getVersions(
+		versionId: string | null,
+		count: number,
+		scenarioName?: string,
+		fetchSource?: FetchSource,
+	): Promise<IVersion[]> {
+		return this.internalStorageService.getVersions(versionId, count, scenarioName, fetchSource);
+	}
 
-    public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {
-        return this.internalStorageService.uploadSummaryWithContext(summary, context);
-    }
+	public async uploadSummaryWithContext(
+		summary: ISummaryTree,
+		context: ISummaryContext,
+	): Promise<string> {
+		return this.internalStorageService.uploadSummaryWithContext(summary, context);
+	}
 
-    public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {
-        return this.internalStorageService.downloadSummary(handle);
-    }
+	public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {
+		return this.internalStorageService.downloadSummary(handle);
+	}
 
-    public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {
-        return this.internalStorageService.createBlob(file);
-    }
+	public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {
+		return this.internalStorageService.createBlob(file);
+	}
 
-    public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-        return this.internalStorageService.readBlob(blobId);
-    }
+	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
+		return this.internalStorageService.readBlob(blobId);
+	}
 }

package/src/error.ts

@@ -8,12 +8,10 @@ import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
 
 /** Error indicating an API is being used improperly resulting in an invalid operation. */
 export class UsageError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
-    readonly errorType = DriverErrorType.usageError;
-    readonly canRetry = false;
+	readonly errorType = DriverErrorType.usageError;
+	readonly canRetry = false;
 
-    constructor(
-        message: string,
-    ) {
-        super(message, { usageError: true });
-    }
+	constructor(message: string) {
+		super(message, { usageError: true });
+	}
 }

package/src/fluidResolvedUrl.ts

@@ -5,11 +5,22 @@
 
 import { IResolvedUrl, IFluidResolvedUrl } from "@fluidframework/driver-definitions";
 
-export const isFluidResolvedUrl =
-    (resolved: IResolvedUrl | undefined): resolved is IFluidResolvedUrl => resolved?.type === "fluid";
+/**
+ * @deprecated In the next major release all IResolvedUrl will be IFluidResolvedUrl,
+ * so this method is no longer necessary.
+ */
+export const isFluidResolvedUrl = (
+	resolved: IResolvedUrl | undefined,
+): resolved is IFluidResolvedUrl => resolved?.type === "fluid";
 
-export function ensureFluidResolvedUrl(resolved: IResolvedUrl | undefined): asserts resolved is IFluidResolvedUrl {
-    if (!isFluidResolvedUrl(resolved)) {
-        throw new Error(`resolved is not a Fluid url. Type: ${resolved?.type}`);
-    }
+/**
+ * @deprecated In the next major release all IResolvedUrl will be IFluidResolvedUrl,
+ * so this method is no longer necessary.
+ */
+export function ensureFluidResolvedUrl(
+	resolved: IResolvedUrl | undefined,
+): asserts resolved is IFluidResolvedUrl {
+	if (!isFluidResolvedUrl(resolved)) {
+		throw new Error(`resolved is not a Fluid url. Type: ${resolved?.type}`);
+	}
 }

package/src/index.ts

@@ -3,22 +3,12 @@
  * Licensed under the MIT License.
  */
 
-export { BlobAggregationStorage, SnapshotExtractor } from "./blobAggregationStorage";
-export { BlobCacheStorageService } from "./blobCacheStorageService";
 export { buildSnapshotTree } from "./buildSnapshotTree";
 export { DocumentStorageServiceProxy } from "./documentStorageServiceProxy";
-export { EmptyDocumentDeltaStorageService } from "./emptyDocumentDeltaStorageService";
 export { UsageError } from "./error";
 export { ensureFluidResolvedUrl, isFluidResolvedUrl } from "./fluidResolvedUrl";
 export { InsecureUrlResolver } from "./insecureUrlResolver";
-export {
-	canBeCoalescedByService,
-	isRuntimeMessage,
-	isUnpackedRuntimeMessage,
-	MessageType2,
-} from "./messageRecognition";
-export { MultiDocumentServiceFactory } from "./multiDocumentServiceFactory";
-export { configurableUrlResolver, MultiUrlResolver } from "./multiUrlResolver";
+export { canBeCoalescedByService, isRuntimeMessage, MessageType2 } from "./messageRecognition";
 export {
 	AuthorizationError,
 	canRetryOnError,
@@ -30,7 +20,6 @@ export {
 	GenericNetworkError,
 	getRetryDelayFromError,
 	getRetryDelaySecondsFromError,
-	IAnyDriverError,
 	isOnline,
 	LocationRedirectionError,
 	NetworkErrorBasic,
@@ -39,7 +28,7 @@ export {
 	RetryableError,
 	ThrottlingError,
 } from "./network";
-export { logNetworkFailure, waitForConnectedState } from "./networkUtils";
+export { logNetworkFailure } from "./networkUtils";
 export {
 	emptyMessageStream,
 	ParallelRequests,
@@ -54,8 +43,9 @@ export { readAndParse } from "./readAndParse";
 export { IProgress, runWithRetry } from "./runWithRetry";
 export {
 	combineAppAndProtocolSummary,
+	CombinedAppAndProtocolSummary,
 	getDocAttributesFromProtocolSummary,
 	getQuorumValuesFromProtocolSummary,
+	isCombinedAppAndProtocolSummary,
 } from "./summaryForCreateNew";
 export { convertSummaryTreeToSnapshotITree } from "./treeConversions";
-export { convertSnapshotAndBlobsToSummaryTree, ISummaryTreeAssemblerProps, SummaryTreeAssembler } from "./treeUtils";