@fluidframework/driver-utils 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.0

package/src/documentStorageServiceProxy.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { ISummaryHandle, ISummaryTree } from "@fluidframework/driver-definitions";
 import {
 	FetchSource,
 	IDocumentStorageService,
@@ -10,14 +11,10 @@ import {
 	ISnapshot,
 	ISnapshotFetchOptions,
 	ISummaryContext,
-} from "@fluidframework/driver-definitions/internal";
-import {
 	ICreateBlobResponse,
 	ISnapshotTree,
-	ISummaryHandle,
-	ISummaryTree,
 	IVersion,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 /**
@@ -58,7 +55,12 @@ export class DocumentStorageServiceProxy implements IDocumentStorageService {
 		scenarioName?: string,
 		fetchSource?: FetchSource,
 	): Promise<IVersion[]> {
-		return this.internalStorageService.getVersions(versionId, count, scenarioName, fetchSource);
+		return this.internalStorageService.getVersions(
+			versionId,
+			count,
+			scenarioName,
+			fetchSource,
+		);
 	}
 
 	public async uploadSummaryWithContext(

package/src/error.ts

@@ -3,7 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { DriverErrorTypes, IDriverErrorBase } from "@fluidframework/driver-definitions/internal";
+import {
+	DriverErrorTypes,
+	IDriverErrorBase,
+} from "@fluidframework/driver-definitions/internal";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils/internal";
 
 /**

package/src/index.ts

@@ -8,7 +8,11 @@ export { BlobTreeEntry, TreeTreeEntry, AttachmentTreeEntry } from "./blob.js";
 export { DocumentStorageServiceProxy } from "./documentStorageServiceProxy.js";
 export { UsageError } from "./error.js";
 export { InsecureUrlResolver } from "./insecureUrlResolver.js";
-export { canBeCoalescedByService, isRuntimeMessage, MessageType2 } from "./messageRecognition.js";
+export {
+	canBeCoalescedByService,
+	isRuntimeMessage,
+	MessageType2,
+} from "./messageRecognition.js";
 export {
 	AuthorizationError,
 	canRetryOnError,
@@ -55,3 +59,4 @@ export {
 	blobHeadersBlobName,
 } from "./adapters/index.js";
 export { getSnapshotTree, isInstanceOfISnapshot } from "./storageUtils.js";
+export { buildGitTreeHierarchy, getGitMode, getGitType } from "./protocol/index.js";

package/src/insecureUrlResolver.ts

@@ -138,7 +138,10 @@ export class InsecureUrlResolver implements IUrlResolver {
 		return response;
 	}
 
-	public async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {
+	public async getAbsoluteUrl(
+		resolvedUrl: IResolvedUrl,
+		relativeUrl: string,
+	): Promise<string> {
 		const parsedUrl = new URL(resolvedUrl.url);
 		const [, , documentId] = parsedUrl.pathname?.split("/") ?? [];
 		// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions

package/src/messageRecognition.ts

@@ -4,10 +4,10 @@
  */
 
 import {
-	IDocumentMessage,
 	ISequencedDocumentMessage,
+	IDocumentMessage,
 	MessageType,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
 
 /**
  * Tells if message was sent by container runtime

package/src/network.ts

@@ -52,7 +52,10 @@ export type DriverErrorTelemetryProps = ITelemetryBaseProperties & {
  * Generic network error class.
  * @internal
  */
-export class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
+export class GenericNetworkError
+	extends LoggingError
+	implements IDriverErrorBase, IFluidErrorBase
+{
 	/**
 	 * {@inheritDoc @fluidframework/telemetry-utils#IFluidErrorBase.errorType}
 	 */
@@ -145,7 +148,10 @@ export class LocationRedirectionError
 /**
  * @internal
  */
-export class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
+export class NetworkErrorBasic<T extends string>
+	extends LoggingError
+	implements IFluidErrorBase
+{
 	constructor(
 		message: string,
 		readonly errorType: T,
@@ -186,7 +192,10 @@ export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
  * Throttling error class - used to communicate all throttling errors
  * @internal
  */
-export class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {
+export class ThrottlingError
+	extends LoggingError
+	implements IThrottlingWarning, IFluidErrorBase
+{
 	readonly errorType = DriverErrorTypes.throttlingError;
 	readonly canRetry = true;
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-rc.4.0.6";
+export const pkgVersion = "2.0.0-rc.5.0.0";

package/src/parallelRequests.ts

@@ -10,11 +10,18 @@ import {
 	IDeltasFetchResult,
 	IStream,
 	IStreamResult,
+	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
-import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils/internal";
+import {
+	ITelemetryLoggerExt,
+	PerformanceEvent,
+} from "@fluidframework/telemetry-utils/internal";
 
-import { canRetryOnError, createGenericNetworkError, getRetryDelayFromError } from "./network.js";
+import {
+	canRetryOnError,
+	createGenericNetworkError,
+	getRetryDelayFromError,
+} from "./network.js";
 import { logNetworkFailure } from "./networkUtils.js";
 // For now, this package is versioned and released in unison with the specific drivers
 import { pkgVersion as driverVersion } from "./packageVersion.js";
@@ -204,13 +211,7 @@ export class ParallelRequests<T> {
 
 			this.requests++;
 
-			const promise = this.requestCallback(
-				this.requests,
-				from,
-				to,
-				this.to !== undefined,
-				{},
-			);
+			const promise = this.requestCallback(this.requests, from, to, this.to !== undefined, {});
 
 			// dispatch any prior received data
 			this.dispatch();
@@ -439,9 +440,7 @@ async function getSingleOpBatch(
 
 		try {
 			// Issue async request for deltas
-			const { messages, partialResult } = await get(
-				{ ...props, retry } /* telemetry props */,
-			);
+			const { messages, partialResult } = await get({ ...props, retry } /* telemetry props */);
 
 			// If we got messages back, return them.  Return regardless of whether we got messages back if we didn't
 			// specify a "to", since we don't have an expectation of how many to receive.

package/src/prefetchDocumentStorageService.ts

@@ -3,8 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { LoaderCachingPolicy } from "@fluidframework/driver-definitions/internal";
-import { ISnapshotTree, IVersion } from "@fluidframework/protocol-definitions";
+import {
+	LoaderCachingPolicy,
+	ISnapshotTree,
+	IVersion,
+} from "@fluidframework/driver-definitions/internal";
 
 import { DocumentStorageServiceProxy } from "./documentStorageServiceProxy.js";
 import { canRetryOnError } from "./network.js";

package/src/protocol/README.md

@@ -0,0 +1,11 @@
+# @fluidframework/driver-utils/src/protocol
+
+These files should not be changed unless the Fluid service itself is changed, and
+should be aligned with the service side definitions contained here:
+
+server/routerlicious/packages/protocol-base
+
+## Notes
+
+The file names in this directory align with those in server/protocol-base to facilitate
+copying/synchronization in the future, if desireable.

package/src/protocol/gitHelper.ts

@@ -0,0 +1,98 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { unreachableCase } from "@fluidframework/core-utils/internal";
+import {
+	FileMode,
+	IGitTree,
+	ISnapshotTreeEx,
+	SummaryType,
+	SummaryObject,
+} from "@fluidframework/driver-definitions/internal";
+
+/**
+ * Take a summary object and returns its git mode.
+ *
+ * @param value - summary object
+ * @returns the git mode of summary object
+ * @internal
+ */
+export function getGitMode(value: SummaryObject): string {
+	const type = value.type === SummaryType.Handle ? value.handleType : value.type;
+	switch (type) {
+		case SummaryType.Blob:
+		case SummaryType.Attachment:
+			return FileMode.File;
+		case SummaryType.Tree:
+			return FileMode.Directory;
+		default:
+			unreachableCase(type, `Unknown type: ${type}`);
+	}
+}
+
+/**
+ * Take a summary object and returns its type.
+ *
+ * @param value - summary object
+ * @returns the type of summary object
+ * @internal
+ */
+export function getGitType(value: SummaryObject): "blob" | "tree" {
+	const type = value.type === SummaryType.Handle ? value.handleType : value.type;
+
+	switch (type) {
+		case SummaryType.Blob:
+		case SummaryType.Attachment:
+			return "blob";
+		case SummaryType.Tree:
+			return "tree";
+		default:
+			unreachableCase(type, `Unknown type: ${type}`);
+	}
+}
+
+/**
+ * NOTE: Renamed from `buildHierarchy` to `buildGitTreeHierarchy`. There is usage of this function in loader and driver layer.
+ * Build a tree hierarchy base on a flat tree
+ *
+ * @param flatTree - a flat tree
+ * @param blobsShaToPathCache - Map with blobs sha as keys and values as path of the blob.
+ * @param removeAppTreePrefix - Remove `.app/` from beginning of paths when present
+ * @returns the hierarchical tree
+ * @internal
+ */
+export function buildGitTreeHierarchy(
+	flatTree: IGitTree,
+	blobsShaToPathCache: Map<string, string> = new Map<string, string>(),
+	removeAppTreePrefix = false,
+): ISnapshotTreeEx {
+	const lookup: { [path: string]: ISnapshotTreeEx } = {};
+	const root: ISnapshotTreeEx = { id: flatTree.sha, blobs: {}, trees: {} };
+	lookup[""] = root;
+
+	for (const entry of flatTree.tree) {
+		const entryPath = removeAppTreePrefix ? entry.path.replace(/^\.app\//, "") : entry.path;
+		const lastIndex = entryPath.lastIndexOf("/");
+		const entryPathDir = entryPath.slice(0, Math.max(0, lastIndex));
+		const entryPathBase = entryPath.slice(lastIndex + 1);
+
+		// The flat output is breadth-first so we can assume we see tree nodes prior to their contents
+		const node = lookup[entryPathDir];
+
+		// Add in either the blob or tree
+		if (entry.type === "tree") {
+			const newTree = { id: entry.sha, blobs: {}, commits: {}, trees: {} };
+			node.trees[decodeURIComponent(entryPathBase)] = newTree;
+			lookup[entryPath] = newTree;
+		} else if (entry.type === "blob") {
+			node.blobs[decodeURIComponent(entryPathBase)] = entry.sha;
+			blobsShaToPathCache.set(entry.sha, `/${entryPath}`);
+		} else {
+			throw new Error("Unknown entry type!!");
+		}
+	}
+
+	return root;
+}

package/src/protocol/index.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { buildGitTreeHierarchy, getGitMode, getGitType } from "./gitHelper.js";

package/src/storageUtils.ts

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

package/src/summaryForCreateNew.ts

@@ -3,13 +3,11 @@
  * Licensed under the MIT License.
  */
 
+import { ISummaryBlob, ISummaryTree, SummaryType } from "@fluidframework/driver-definitions";
 import {
 	ICommittedProposal,
 	IDocumentAttributes,
-	ISummaryBlob,
-	ISummaryTree,
-	SummaryType,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
 
 /**
  * Defines the current layout of an .app + .protocol summary tree

package/src/treeConversions.ts

@@ -5,7 +5,8 @@
 
 import { Uint8ArrayToString } from "@fluid-internal/client-utils";
 import { unreachableCase } from "@fluidframework/core-utils/internal";
-import { ISummaryTree, ITree, ITreeEntry, SummaryType } from "@fluidframework/protocol-definitions";
+import { ISummaryTree, SummaryType } from "@fluidframework/driver-definitions";
+import { ITree, ITreeEntry } from "@fluidframework/driver-definitions/internal";
 
 import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "./blob.js";
 import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew.js";
@@ -22,7 +23,7 @@ export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): IT
 		? [
 				...Object.entries(summaryTree.tree[".protocol"].tree),
 				...Object.entries(summaryTree.tree[".app"].tree),
-		  ]
+			]
 		: Object.entries(summaryTree.tree);
 
 	for (const [key, value] of allSummaryEntries) {

package/tsconfig.json

@@ -5,5 +5,7 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
+		"exactOptionalPropertyTypes": false,
+		"noUncheckedIndexedAccess": false,
 	},
 }

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}