@fluidframework/odsp-driver 2.0.0-dev-rc.5.0.0.263932 → 2.0.0-dev-rc.5.0.0.267932

package/src/odspDocumentStorageManager.ts

@@ -7,11 +7,15 @@ import { performance } from "@fluid-internal/client-utils";
 import { LogLevel } from "@fluidframework/core-interfaces";
 import { assert, delay } from "@fluidframework/core-utils/internal";
 import { promiseRaceWithWinner } from "@fluidframework/driver-base/internal";
+import { ISummaryTree } from "@fluidframework/driver-definitions";
 import {
 	FetchSource,
 	ISnapshot,
 	ISnapshotFetchOptions,
 	ISummaryContext,
+	ICreateBlobResponse,
+	IVersion,
+	ISnapshotTree,
 } from "@fluidframework/driver-definitions/internal";
 import { NonRetryableError, RateLimiter } from "@fluidframework/driver-utils/internal";
 import {
@@ -21,7 +25,6 @@ import {
 	OdspErrorTypes,
 	getKeyForCacheEntry,
 } from "@fluidframework/odsp-driver-definitions/internal";
-import * as api from "@fluidframework/protocol-definitions";
 import {
 	ITelemetryLoggerExt,
 	PerformanceEvent,
@@ -117,7 +120,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 		return this._isFirstSnapshotFromNetwork;
 	}
 
-	public async createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse> {
+	public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {
 		this.checkAttachmentPOSTUrl();
 
 		const response = await getWithRetryForTokenRefresh(async (options) => {
@@ -138,7 +141,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 				},
 				async (event) => {
 					const res = await this.createBlobRateLimiter.schedule(async () =>
-						this.epochTracker.fetchAndParseAsJSON<api.ICreateBlobResponse>(
+						this.epochTracker.fetchAndParseAsJSON<ICreateBlobResponse>(
 							url,
 							{
 								body: file,
@@ -208,10 +211,10 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 	}
 
 	public async getSnapshotTree(
-		version?: api.IVersion,
+		version?: IVersion,
 		scenarioName?: string,
 		// eslint-disable-next-line @rushstack/no-new-null
-	): Promise<api.ISnapshotTree | null> {
+	): Promise<ISnapshotTree | null> {
 		if (!this.snapshotUrl) {
 			// eslint-disable-next-line unicorn/no-null
 			return null;
@@ -446,7 +449,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 		count: number,
 		scenarioName?: string,
 		fetchSource?: FetchSource,
-	): Promise<api.IVersion[]> {
+	): Promise<IVersion[]> {
 		// Regular load workflow uses blobId === documentID to indicate "latest".
 		if (blobid !== this.documentId && blobid) {
 			// FluidFetch & FluidDebugger tools use empty sting to query for versions
@@ -685,7 +688,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 	}
 
 	public async uploadSummaryWithContext(
-		summary: api.ISummaryTree,
+		summary: ISummaryTree,
 		context: ISummaryContext,
 	): Promise<string> {
 		this.checkSnapshotUrl();
@@ -804,7 +807,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 	protected async fetchTreeFromSnapshot(
 		id: string,
 		scenarioName?: string,
-	): Promise<api.ISnapshotTree | undefined> {
+	): Promise<ISnapshotTree | undefined> {
 		return getWithRetryForTokenRefresh(async (options) => {
 			const storageToken = await this.getStorageToken(options, "ReadCommit");
 			const snapshotDownloader = async (

package/src/odspDocumentStorageServiceBase.ts

@@ -4,6 +4,11 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
+import {
+	ISequencedDocumentMessage,
+	ISummaryHandle,
+	ISummaryTree,
+} from "@fluidframework/driver-definitions";
 import {
 	FetchSource,
 	FiveDaysMs,
@@ -13,9 +18,11 @@ import {
 	ISnapshotFetchOptions,
 	ISummaryContext,
 	LoaderCachingPolicy,
+	ISnapshotTree,
+	ICreateBlobResponse,
+	IVersion,
 } from "@fluidframework/driver-definitions/internal";
 import { maximumCacheDurationMs } from "@fluidframework/odsp-driver-definitions/internal";
-import * as api from "@fluidframework/protocol-definitions";
 import { IConfigProvider } from "@fluidframework/telemetry-utils/internal";
 
 class BlobCache {
@@ -139,20 +146,20 @@ export abstract class OdspDocumentStorageServiceBase implements IDocumentStorage
 			maximumCacheDurationMs: maximumCacheDurationMsInEffect,
 		};
 	}
-	protected readonly commitCache: Map<string, api.ISnapshotTree> = new Map();
+	protected readonly commitCache: Map<string, ISnapshotTree> = new Map();
 
-	private _ops: api.ISequencedDocumentMessage[] | undefined;
+	private _ops: ISequencedDocumentMessage[] | undefined;
 
 	private _snapshotSequenceNumber: number | undefined;
 
 	protected readonly blobCache = new BlobCache();
 
-	public set ops(ops: api.ISequencedDocumentMessage[] | undefined) {
+	public set ops(ops: ISequencedDocumentMessage[] | undefined) {
 		assert(this._ops === undefined, 0x0a5 /* "Trying to set ops when they are already set!" */);
 		this._ops = ops;
 	}
 
-	public get ops(): api.ISequencedDocumentMessage[] | undefined {
+	public get ops(): ISequencedDocumentMessage[] | undefined {
 		return this._ops;
 	}
 
@@ -160,7 +167,7 @@ export abstract class OdspDocumentStorageServiceBase implements IDocumentStorage
 		return this._snapshotSequenceNumber;
 	}
 
-	public abstract createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+	public abstract createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
 
 	private async readBlobCore(blobId: string): Promise<ArrayBuffer> {
 		const { blobContent, evicted } = this.blobCache.getBlob(blobId);
@@ -174,10 +181,10 @@ export abstract class OdspDocumentStorageServiceBase implements IDocumentStorage
 	}
 
 	public async getSnapshotTree(
-		version?: api.IVersion,
+		version?: IVersion,
 		scenarioName?: string,
 		// eslint-disable-next-line @rushstack/no-new-null
-	): Promise<api.ISnapshotTree | null> {
+	): Promise<ISnapshotTree | null> {
 		let id: string;
 		if (version?.id) {
 			id = version.id;
@@ -208,18 +215,18 @@ export abstract class OdspDocumentStorageServiceBase implements IDocumentStorage
 		count: number,
 		scenarioName?: string,
 		fetchSource?: FetchSource,
-	): Promise<api.IVersion[]>;
+	): Promise<IVersion[]>;
 
 	public abstract uploadSummaryWithContext(
-		summary: api.ISummaryTree,
+		summary: ISummaryTree,
 		context: ISummaryContext,
 	): Promise<string>;
 
-	public async downloadSummary(commit: api.ISummaryHandle): Promise<api.ISummaryTree> {
+	public async downloadSummary(commit: ISummaryHandle): Promise<ISummaryTree> {
 		throw new Error("Not implemented yet");
 	}
 
-	protected setRootTree(id: string, tree: api.ISnapshotTree): void {
+	protected setRootTree(id: string, tree: ISnapshotTree): void {
 		this.commitCache.set(id, tree);
 	}
 
@@ -227,7 +234,7 @@ export abstract class OdspDocumentStorageServiceBase implements IDocumentStorage
 		this.blobCache.addBlobs(blobs);
 	}
 
-	private async readTree(id: string, scenarioName?: string): Promise<api.ISnapshotTree | null> {
+	private async readTree(id: string, scenarioName?: string): Promise<ISnapshotTree | null> {
 		let tree = this.commitCache.get(id);
 		if (!tree) {
 			tree = await this.fetchTreeFromSnapshot(id, scenarioName);
@@ -240,22 +247,21 @@ export abstract class OdspDocumentStorageServiceBase implements IDocumentStorage
 	protected abstract fetchTreeFromSnapshot(
 		id: string,
 		scenarioName?: string,
-	): Promise<api.ISnapshotTree | undefined>;
+	): Promise<ISnapshotTree | undefined>;
 
-	protected combineProtocolAndAppSnapshotTree(
-		snapshotTree: api.ISnapshotTree,
-	): api.ISnapshotTree {
+	protected combineProtocolAndAppSnapshotTree(snapshotTree: ISnapshotTree): ISnapshotTree {
 		// When we upload the container snapshot, we upload appTree in ".app" and protocol tree in ".protocol"
 		// So when we request the snapshot we get ".app" as tree and not as commit node as in the case just above.
 		const hierarchicalAppTree = snapshotTree.trees[".app"];
 		const hierarchicalProtocolTree = snapshotTree.trees[".protocol"];
-		const summarySnapshotTree: api.ISnapshotTree = {
+		const summarySnapshotTree: ISnapshotTree = {
 			blobs: {
 				...hierarchicalAppTree.blobs,
 			},
 			trees: {
 				...hierarchicalAppTree.trees,
 			},
+			id: snapshotTree.id,
 		};
 
 		// The app tree could have a .protocol in that case we want to server protocol to override it.

package/src/odspPublicUtils.ts

@@ -4,7 +4,8 @@
  */
 
 import { IsoBuffer, hashFile } from "@fluid-internal/client-utils";
-import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
+import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions";
+import { ISnapshotTree } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Creates a unique and stable id for a document stored in ODSP which doesn't expose the driveId and itemId of

package/src/odspSnapshotParser.ts

@@ -5,8 +5,7 @@
 
 import { stringToBuffer } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
-import { ISnapshot } from "@fluidframework/driver-definitions/internal";
-import * as api from "@fluidframework/protocol-definitions";
+import { ISnapshot, ISnapshotTree } from "@fluidframework/driver-definitions/internal";
 
 import { IOdspSnapshot, IOdspSnapshotCommit } from "./contracts.js";
 
@@ -17,10 +16,10 @@ import { IOdspSnapshot, IOdspSnapshotCommit } from "./contracts.js";
  * @param blobsShaToPathCache - Map with blobs sha as keys and values as path of the blob.
  * @returns the hierarchical tree
  */
-function buildHierarchy(flatTree: IOdspSnapshotCommit): api.ISnapshotTree {
-	const lookup: { [path: string]: api.ISnapshotTree } = {};
+function buildHierarchy(flatTree: IOdspSnapshotCommit): ISnapshotTree {
+	const lookup: { [path: string]: ISnapshotTree } = {};
 	// id is required for root tree as it will be used to determine the version we loaded from.
-	const root: api.ISnapshotTree = { id: flatTree.id, blobs: {}, trees: {} };
+	const root: ISnapshotTree = { id: flatTree.id, blobs: {}, trees: {} };
 	lookup[""] = root;
 
 	for (const entry of flatTree.entries) {
@@ -33,7 +32,7 @@ function buildHierarchy(flatTree: IOdspSnapshotCommit): api.ISnapshotTree {
 
 		// Add in either the blob or tree
 		if (entry.type === "tree") {
-			const newTree: api.ISnapshotTree = {
+			const newTree: ISnapshotTree = {
 				blobs: {},
 				trees: {},
 				unreferenced: entry.unreferenced,

package/src/odspSummaryUploadManager.ts

@@ -5,11 +5,11 @@
 
 import { Uint8ArrayToString } from "@fluid-internal/client-utils";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
+import { ISummaryTree, SummaryType, SummaryObject } from "@fluidframework/driver-definitions";
 import { ISummaryContext } from "@fluidframework/driver-definitions/internal";
 import { isCombinedAppAndProtocolSummary } from "@fluidframework/driver-utils/internal";
 import { InstrumentedStorageTokenFetcher } from "@fluidframework/odsp-driver-definitions/internal";
 import { getGitType } from "@fluidframework/protocol-base";
-import * as api from "@fluidframework/protocol-definitions";
 import {
 	ITelemetryLoggerExt,
 	MonitoringContext,
@@ -49,10 +49,7 @@ export class OdspSummaryUploadManager {
 		this.mc = loggerToMonitoringContext(logger);
 	}
 
-	public async writeSummaryTree(
-		tree: api.ISummaryTree,
-		context: ISummaryContext,
-	): Promise<string> {
+	public async writeSummaryTree(tree: ISummaryTree, context: ISummaryContext): Promise<string> {
 		// If the last proposed handle is not the proposed handle of the acked summary(could happen when the last summary get nacked),
 		// then re-initialize the caches with the previous ones else just update the previous caches with the caches from acked summary.
 		// Don't bother logging if lastSummaryProposalHandle hasn't been set before; only log on a positive mismatch.
@@ -82,7 +79,7 @@ export class OdspSummaryUploadManager {
 	private async writeSummaryTreeCore(
 		parentHandle: string | undefined,
 		referenceSequenceNumber: number,
-		tree: api.ISummaryTree,
+		tree: ISummaryTree,
 	): Promise<IWriteSummaryResponse> {
 		const containsProtocolTree = isCombinedAppAndProtocolSummary(tree);
 		const { snapshotTree, blobs } = await this.convertSummaryToSnapshotTree(
@@ -161,7 +158,7 @@ export class OdspSummaryUploadManager {
 	 */
 	private async convertSummaryToSnapshotTree(
 		parentHandle: string | undefined,
-		tree: api.ISummaryTree,
+		tree: ISummaryTree,
 		rootNodeName: string,
 		markUnreferencedNodes: boolean = this.mc.config.getBoolean(
 			"Fluid.Driver.Odsp.MarkUnreferencedNodes",
@@ -189,7 +186,7 @@ export class OdspSummaryUploadManager {
 			let unreferenced: true | undefined;
 			let groupId: string | undefined;
 			switch (summaryObject.type) {
-				case api.SummaryType.Tree: {
+				case SummaryType.Tree: {
 					const result = await this.convertSummaryToSnapshotTree(
 						parentHandle,
 						summaryObject,
@@ -201,7 +198,7 @@ export class OdspSummaryUploadManager {
 					blobs += result.blobs;
 					break;
 				}
-				case api.SummaryType.Blob: {
+				case SummaryType.Blob: {
 					value =
 						typeof summaryObject.content === "string"
 							? {
@@ -217,7 +214,7 @@ export class OdspSummaryUploadManager {
 					blobs++;
 					break;
 				}
-				case api.SummaryType.Handle: {
+				case SummaryType.Handle: {
 					if (!parentHandle) {
 						throw new Error("Parent summary does not exist to reference by handle.");
 					}
@@ -229,14 +226,14 @@ export class OdspSummaryUploadManager {
 					id = `${parentHandle}/${pathKey}`;
 					break;
 				}
-				case api.SummaryType.Attachment: {
+				case SummaryType.Attachment: {
 					id = summaryObject.id;
 					break;
 				}
 				default: {
 					unreachableCase(
 						summaryObject,
-						`Unknown type: ${(summaryObject as api.SummaryObject).type}`,
+						`Unknown type: ${(summaryObject as SummaryObject).type}`,
 					);
 				}
 			}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "2.0.0-dev-rc.5.0.0.263932";
+export const pkgVersion = "2.0.0-dev-rc.5.0.0.267932";

package/src/retryErrorsStorageAdapter.ts

@@ -4,6 +4,7 @@
  */
 
 import { IDisposable } from "@fluidframework/core-interfaces";
+import { ISummaryHandle, ISummaryTree } from "@fluidframework/driver-definitions";
 import {
 	FetchSource,
 	IDocumentStorageService,
@@ -11,14 +12,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 {
 	ITelemetryLoggerExt,
 	LoggingError,