@fluidframework/odsp-driver 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.2.0.0.245554

package/lib/{retryErrorsStorageAdapter.mjs → retryErrorsStorageAdapter.js}

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { LoggingError } from "@fluidframework/telemetry-utils";
-import { runWithRetry } from "./retryUtils.mjs";
+import { LoggingError, UsageError } from "@fluidframework/telemetry-utils";
+import { runWithRetry } from "./retryUtils.js";
 export class RetryErrorsStorageAdapter {
     constructor(internalStorageService, logger) {
         this.internalStorageService = internalStorageService;
@@ -19,13 +19,18 @@ export class RetryErrorsStorageAdapter {
     dispose() {
         this._disposed = true;
     }
-    get repositoryUrl() {
-        return this.internalStorageService.repositoryUrl;
-    }
     // eslint-disable-next-line @rushstack/no-new-null
     async getSnapshotTree(version) {
         return this.runWithRetry(async () => this.internalStorageService.getSnapshotTree(version), "storage_getSnapshotTree");
     }
+    async getSnapshot(snapshotFetchOptions) {
+        return this.runWithRetry(async () => {
+            if (this.internalStorageService.getSnapshot !== undefined) {
+                return this.internalStorageService.getSnapshot(snapshotFetchOptions);
+            }
+            throw new UsageError("getSnapshot should exist in storage adapter in ODSP driver");
+        }, "storage_getSnapshot");
+    }
     async readBlob(id) {
         return this.runWithRetry(async () => this.internalStorageService.readBlob(id), "storage_readBlob");
     }
@@ -56,4 +61,4 @@ export class RetryErrorsStorageAdapter {
         return runWithRetry(api, callName, this.logger, () => this.checkStorageDisposed());
     }
 }
-//# sourceMappingURL=retryErrorsStorageAdapter.mjs.map
+//# sourceMappingURL=retryErrorsStorageAdapter.js.map

package/lib/retryErrorsStorageAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryErrorsStorageAdapter.js","sourceRoot":"","sources":["../src/retryErrorsStorageAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAuB,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAiBhG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,OAAO,yBAAyB;IAErC,YACkB,sBAA+C,EAC/C,MAA2B;QAD3B,2BAAsB,GAAtB,sBAAsB,CAAyB;QAC/C,WAAM,GAAN,MAAM,CAAqB;QAHrC,cAAS,GAAG,KAAK,CAAC;IAIvB,CAAC;IAEJ,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;IAC7C,CAAC;IACD,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IACM,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,eAAe,CAAC,OAAkB;QAC9C,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,EAChE,yBAAyB,CACzB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,oBAA4C;QACpE,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI,IAAI,CAAC,sBAAsB,CAAC,WAAW,KAAK,SAAS,EAAE;gBAC1D,OAAO,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;aACrE;YACD,MAAM,IAAI,UAAU,CAAC,4DAA4D,CAAC,CAAC;QACpF,CAAC,EAAE,qBAAqB,CAAC,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC/B,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,EACpD,kBAAkB,CAClB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,WAAW;IACvB,kDAAkD;IAClD,SAAwB,EACxB,KAAa,EACb,YAAqB,EACrB,WAAyB;QAEzB,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CACV,IAAI,CAAC,sBAAsB,CAAC,WAAW,CACtC,SAAS,EACT,KAAK,EACL,YAAY,EACZ,WAAW,CACX,EACF,qBAAqB,CACrB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACpC,OAAqB,EACrB,OAAwB;QAExB,4DAA4D;QAC5D,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClF,kCAAkC,CAClC,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAClD,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,MAAM,CAAC,EAC/D,yBAAyB,CACzB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QAC5C,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,EACxD,oBAAoB,CACpB,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC3B,IAAI,IAAI,CAAC,SAAS,EAAE;YACnB,4DAA4D;YAC5D,MAAM,IAAI,YAAY,CAAC,2CAA2C,EAAE;gBACnE,QAAQ,EAAE,KAAK;aACf,CAAC,CAAC;SACH;IACF,CAAC;IAEO,KAAK,CAAC,YAAY,CAAI,GAAqB,EAAE,QAAgB;QACpE,OAAO,YAAY,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACpF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { LoggingError, ITelemetryLoggerExt, UsageError } from \"@fluidframework/telemetry-utils\";\nimport {\n\tFetchSource,\n\tIDocumentStorageService,\n\tIDocumentStorageServicePolicies,\n\tISnapshot,\n\tISnapshotFetchOptions,\n\tISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport {\n\tICreateBlobResponse,\n\tISnapshotTree,\n\tISummaryHandle,\n\tISummaryTree,\n\tIVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IDisposable } from \"@fluidframework/core-interfaces\";\nimport { runWithRetry } from \"./retryUtils.js\";\n\nexport class RetryErrorsStorageAdapter implements IDocumentStorageService, IDisposable {\n\tprivate _disposed = false;\n\tconstructor(\n\t\tprivate readonly internalStorageService: IDocumentStorageService,\n\t\tprivate readonly logger: ITelemetryLoggerExt,\n\t) {}\n\n\tpublic get policies(): IDocumentStorageServicePolicies | undefined {\n\t\treturn this.internalStorageService.policies;\n\t}\n\tpublic get disposed(): boolean {\n\t\treturn this._disposed;\n\t}\n\tpublic dispose(): void {\n\t\tthis._disposed = true;\n\t}\n\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tpublic async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalStorageService.getSnapshotTree(version),\n\t\t\t\"storage_getSnapshotTree\",\n\t\t);\n\t}\n\n\tpublic async getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot> {\n\t\treturn this.runWithRetry(async () => {\n\t\t\tif (this.internalStorageService.getSnapshot !== undefined) {\n\t\t\t\treturn this.internalStorageService.getSnapshot(snapshotFetchOptions);\n\t\t\t}\n\t\t\tthrow new UsageError(\"getSnapshot should exist in storage adapter in ODSP driver\");\n\t\t}, \"storage_getSnapshot\");\n\t}\n\n\tpublic async readBlob(id: string): Promise<ArrayBufferLike> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalStorageService.readBlob(id),\n\t\t\t\"storage_readBlob\",\n\t\t);\n\t}\n\n\tpublic async getVersions(\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tversionId: string | null,\n\t\tcount: number,\n\t\tscenarioName?: string,\n\t\tfetchSource?: FetchSource,\n\t): Promise<IVersion[]> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () =>\n\t\t\t\tthis.internalStorageService.getVersions(\n\t\t\t\t\tversionId,\n\t\t\t\t\tcount,\n\t\t\t\t\tscenarioName,\n\t\t\t\t\tfetchSource,\n\t\t\t\t),\n\t\t\t\"storage_getVersions\",\n\t\t);\n\t}\n\n\tpublic async uploadSummaryWithContext(\n\t\tsummary: ISummaryTree,\n\t\tcontext: ISummaryContext,\n\t): Promise<string> {\n\t\t// Creation flow with attachment blobs - need to do retries!\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalStorageService.uploadSummaryWithContext(summary, context),\n\t\t\t\"storage_uploadSummaryWithContext\",\n\t\t);\n\t}\n\n\tpublic async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalStorageService.downloadSummary(handle),\n\t\t\t\"storage_downloadSummary\",\n\t\t);\n\t}\n\n\tpublic async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalStorageService.createBlob(file),\n\t\t\t\"storage_createBlob\",\n\t\t);\n\t}\n\n\tprivate checkStorageDisposed(): void {\n\t\tif (this._disposed) {\n\t\t\t// pre-0.58 error message: storageServiceDisposedCannotRetry\n\t\t\tthrow new LoggingError(\"Storage Service is disposed. Cannot retry\", {\n\t\t\t\tcanRetry: false,\n\t\t\t});\n\t\t}\n\t}\n\n\tprivate async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {\n\t\treturn runWithRetry(api, callName, this.logger, () => this.checkStorageDisposed());\n\t}\n}\n"]}

package/lib/{retryUtils.d.mts → retryUtils.d.ts}

@@ -7,4 +7,4 @@ import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
  * This method retries only for retriable coherency and service read only errors.
  */
 export declare function runWithRetry<T>(api: () => Promise<T>, callName: string, logger: ITelemetryLoggerExt, checkDisposed?: () => void): Promise<T>;
-//# sourceMappingURL=retryUtils.d.mts.map
+//# sourceMappingURL=retryUtils.d.ts.map

package/lib/retryUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryUtils.d.ts","sourceRoot":"","sources":["../src/retryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAOtE;;GAEG;AACH,wBAAsB,YAAY,CAAC,CAAC,EACnC,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,mBAAmB,EAC3B,aAAa,CAAC,EAAE,MAAM,IAAI,GACxB,OAAO,CAAC,CAAC,CAAC,CAgFZ"}

package/lib/{retryUtils.mjs → retryUtils.js}

@@ -5,8 +5,8 @@
 import { performance } from "@fluid-internal/client-utils";
 import { delay } from "@fluidframework/core-utils";
 import { canRetryOnError, getRetryDelayFromError } from "@fluidframework/driver-utils";
-import { OdspErrorType } from "@fluidframework/odsp-driver-definitions";
-import { Odsp409Error } from "./epochTracker.mjs";
+import { OdspErrorTypes } from "@fluidframework/odsp-driver-definitions";
+import { Odsp409Error } from "./epochTracker.js";
 /**
  * This method retries only for retriable coherency and service read only errors.
  */
@@ -29,11 +29,14 @@ export async function runWithRetry(api, callName, logger, checkDisposed) {
                 }, lastError);
             }
             return result;
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }
         catch (error) {
             const canRetry = canRetryOnError(error);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             const coherencyError = error?.[Odsp409Error] === true;
-            const serviceReadonlyError = error?.errorType === OdspErrorType.serviceReadOnly;
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            const serviceReadonlyError = error?.errorType === OdspErrorTypes.serviceReadOnly;
             // logging the first failed retry instead of every attempt. We want to avoid filling telemetry
             // when we have tight loop of retrying in offline mode, but we also want to know what caused
             // the failure in the first place
@@ -64,6 +67,7 @@ export async function runWithRetry(api, callName, logger, checkDisposed) {
                     duration: performance.now() - start, // record total wait time.
                 }, error);
                 // Fail hard.
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
                 error.canRetry = false;
                 throw error;
             }
@@ -74,4 +78,4 @@ export async function runWithRetry(api, callName, logger, checkDisposed) {
         }
     }
 }
-//# sourceMappingURL=retryUtils.mjs.map
+//# sourceMappingURL=retryUtils.js.map

package/lib/retryUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryUtils.js","sourceRoot":"","sources":["../src/retryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CACjC,GAAqB,EACrB,QAAgB,EAChB,MAA2B,EAC3B,aAA0B;IAE1B,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,IAAI,SAAkB,CAAC;IACvB,KAAK,IAAI,QAAQ,GAAG,CAAC,GAAI,QAAQ,EAAE,EAAE;QACpC,IAAI,aAAa,KAAK,SAAS,EAAE;YAChC,aAAa,EAAE,CAAC;SAChB;QACD,IAAI;YACH,MAAM,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;YAC3B,IAAI,QAAQ,GAAG,CAAC,EAAE;gBACjB,MAAM,CAAC,kBAAkB,CACxB;oBACC,SAAS,EAAE,iBAAiB;oBAC5B,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;iBACnC,EACD,SAAS,CACT,CAAC;aACF;YACD,OAAO,MAAM,CAAC;YACd,8DAA8D;SAC9D;QAAC,OAAO,KAAU,EAAE;YACpB,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;YAExC,sEAAsE;YACtE,MAAM,cAAc,GAAG,KAAK,EAAE,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;YACtD,sEAAsE;YACtE,MAAM,oBAAoB,GAAG,KAAK,EAAE,SAAS,KAAK,cAAc,CAAC,eAAe,CAAC;YAEjF,8FAA8F;YAC9F,4FAA4F;YAC5F,iCAAiC;YACjC,IAAI,QAAQ,KAAK,CAAC,EAAE;gBACnB,MAAM,CAAC,kBAAkB,CACxB;oBACC,SAAS,EAAE,GAAG,QAAQ,cAAc;oBACpC,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,0BAA0B;iBAC/D,EACD,KAAK,CACL,CAAC;aACF;YAED,wGAAwG;YACxG,oGAAoG;YACpG,yBAAyB;YACzB,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,oBAAoB,CAAC,IAAI,QAAQ,CAAC,EAAE;gBAC5D,MAAM,KAAK,CAAC;aACZ;YAED,+EAA+E;YAC/E,oFAAoF;YACpF,uEAAuE;YACvE,IAAI,QAAQ,KAAK,CAAC,EAAE;gBACnB,MAAM,CAAC,cAAc,CACpB;oBACC,SAAS,EAAE,cAAc;wBACxB,CAAC,CAAC,8BAA8B;wBAChC,CAAC,CAAC,oCAAoC;oBACvC,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,0BAA0B;iBAC/D,EACD,KAAK,CACL,CAAC;gBACF,aAAa;gBACb,sEAAsE;gBACtE,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC;gBACvB,MAAM,KAAK,CAAC;aACZ;YAED,UAAU,GAAG,sBAAsB,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC;YACzD,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;YACpC,UAAU,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YACrD,SAAS,GAAG,KAAK,CAAC;SAClB;KACD;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLoggerExt } from \"@fluidframework/telemetry-utils\";\nimport { performance } from \"@fluid-internal/client-utils\";\nimport { delay } from \"@fluidframework/core-utils\";\nimport { canRetryOnError, getRetryDelayFromError } from \"@fluidframework/driver-utils\";\nimport { OdspErrorTypes } from \"@fluidframework/odsp-driver-definitions\";\nimport { Odsp409Error } from \"./epochTracker.js\";\n\n/**\n * This method retries only for retriable coherency and service read only errors.\n */\nexport async function runWithRetry<T>(\n\tapi: () => Promise<T>,\n\tcallName: string,\n\tlogger: ITelemetryLoggerExt,\n\tcheckDisposed?: () => void,\n): Promise<T> {\n\tlet retryAfter = 1000;\n\tconst start = performance.now();\n\tlet lastError: unknown;\n\tfor (let attempts = 1; ; attempts++) {\n\t\tif (checkDisposed !== undefined) {\n\t\t\tcheckDisposed();\n\t\t}\n\t\ttry {\n\t\t\tconst result = await api();\n\t\t\tif (attempts > 1) {\n\t\t\t\tlogger.sendTelemetryEvent(\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: \"MultipleRetries\",\n\t\t\t\t\t\tcallName,\n\t\t\t\t\t\tattempts,\n\t\t\t\t\t\tduration: performance.now() - start,\n\t\t\t\t\t},\n\t\t\t\t\tlastError,\n\t\t\t\t);\n\t\t\t}\n\t\t\treturn result;\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t} catch (error: any) {\n\t\t\tconst canRetry = canRetryOnError(error);\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\tconst coherencyError = error?.[Odsp409Error] === true;\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\tconst serviceReadonlyError = error?.errorType === OdspErrorTypes.serviceReadOnly;\n\n\t\t\t// logging the first failed retry instead of every attempt. We want to avoid filling telemetry\n\t\t\t// when we have tight loop of retrying in offline mode, but we also want to know what caused\n\t\t\t// the failure in the first place\n\t\t\tif (attempts === 1) {\n\t\t\t\tlogger.sendTelemetryEvent(\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: `${callName}_firstFailed`,\n\t\t\t\t\t\tcallName,\n\t\t\t\t\t\tattempts,\n\t\t\t\t\t\tduration: performance.now() - start, // record total wait time.\n\t\t\t\t\t},\n\t\t\t\t\terror,\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// Retry for retriable 409 coherency errors or serviceReadOnly errors. These errors are always retriable\n\t\t\t// unless someone specifically set canRetry = false on the error like in fetchSnapshot() flow. So in\n\t\t\t// that case don't retry.\n\t\t\tif (!((coherencyError || serviceReadonlyError) && canRetry)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\n\t\t\t// SPO itself does number of retries internally before returning 409 to client.\n\t\t\t// That multiplied to 5 suggests need to reconsider current design, as client spends\n\t\t\t// too much time / bandwidth doing the same thing without any progress.\n\t\t\tif (attempts === 5) {\n\t\t\t\tlogger.sendErrorEvent(\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: coherencyError\n\t\t\t\t\t\t\t? \"CoherencyErrorTooManyRetries\"\n\t\t\t\t\t\t\t: \"ServiceReadonlyErrorTooManyRetries\",\n\t\t\t\t\t\tcallName,\n\t\t\t\t\t\tattempts,\n\t\t\t\t\t\tduration: performance.now() - start, // record total wait time.\n\t\t\t\t\t},\n\t\t\t\t\terror,\n\t\t\t\t);\n\t\t\t\t// Fail hard.\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\t\terror.canRetry = false;\n\t\t\t\tthrow error;\n\t\t\t}\n\n\t\t\tretryAfter = getRetryDelayFromError(error) ?? retryAfter;\n\t\t\tawait delay(Math.floor(retryAfter));\n\t\t\tretryAfter += (retryAfter / 4) * (1 + Math.random());\n\t\t\tlastError = error;\n\t\t}\n\t}\n}\n"]}

package/lib/{socketModule.d.mts → socketModule.d.ts}

@@ -4,4 +4,4 @@
  */
 import { io } from "socket.io-client";
 export declare const SocketIOClientStatic: typeof io;
-//# sourceMappingURL=socketModule.d.mts.map
+//# sourceMappingURL=socketModule.d.ts.map

package/lib/socketModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketModule.d.ts","sourceRoot":"","sources":["../src/socketModule.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAItC,eAAO,MAAM,oBAAoB,WAAK,CAAC"}

package/lib/{socketModule.mjs → socketModule.js}

@@ -3,5 +3,7 @@
  * Licensed under the MIT License.
  */
 import { io } from "socket.io-client";
+// Import is required for side-effects.
+// eslint-disable-next-line unicorn/prefer-export-from
 export const SocketIOClientStatic = io;
-//# sourceMappingURL=socketModule.mjs.map
+//# sourceMappingURL=socketModule.js.map

package/lib/socketModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketModule.js","sourceRoot":"","sources":["../src/socketModule.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAEtC,uCAAuC;AACvC,sDAAsD;AACtD,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { io } from \"socket.io-client\";\n\n// Import is required for side-effects.\n// eslint-disable-next-line unicorn/prefer-export-from\nexport const SocketIOClientStatic = io;\n"]}

package/lib/test/buildOdspShareLinkReqParams.spec.js

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { SharingLinkRole, SharingLinkScope } from "@fluidframework/odsp-driver-definitions";
+import { buildOdspShareLinkReqParams } from "../odspUtils.js";
+describe("buildOdspShareLinkReqParams", () => {
+    it("Should return appropriate query parameters when only scope is provided", async () => {
+        const result = buildOdspShareLinkReqParams({ scope: SharingLinkScope.organization });
+        assert.strictEqual(result, `createLinkScope=${SharingLinkScope.organization}`);
+    });
+    it("Should return appropriate query parameters when both scope and link role are provided", async () => {
+        const result = buildOdspShareLinkReqParams({
+            scope: SharingLinkScope.organization,
+            role: SharingLinkRole.view,
+        });
+        assert.strictEqual(result, `createLinkScope=${SharingLinkScope.organization}&createLinkRole=${SharingLinkRole.view}`);
+    });
+    it("Should return undefined when the input is undefined", async () => {
+        const result = buildOdspShareLinkReqParams(undefined);
+        assert.strictEqual(result, undefined);
+    });
+});
+//# sourceMappingURL=buildOdspShareLinkReqParams.spec.js.map

package/lib/test/buildOdspShareLinkReqParams.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildOdspShareLinkReqParams.spec.js","sourceRoot":"","sources":["../../src/test/buildOdspShareLinkReqParams.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAE9D,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,wEAAwE,EAAE,KAAK,IAAI,EAAE;QACvF,MAAM,MAAM,GAAG,2BAA2B,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC;QACrF,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,mBAAmB,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACtG,MAAM,MAAM,GAAG,2BAA2B,CAAC;YAC1C,KAAK,EAAE,gBAAgB,CAAC,YAAY;YACpC,IAAI,EAAE,eAAe,CAAC,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,WAAW,CACjB,MAAM,EACN,mBAAmB,gBAAgB,CAAC,YAAY,mBAAmB,eAAe,CAAC,IAAI,EAAE,CACzF,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,MAAM,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"node:assert\";\nimport { SharingLinkRole, SharingLinkScope } from \"@fluidframework/odsp-driver-definitions\";\nimport { buildOdspShareLinkReqParams } from \"../odspUtils.js\";\n\ndescribe(\"buildOdspShareLinkReqParams\", () => {\n\tit(\"Should return appropriate query parameters when only scope is provided\", async () => {\n\t\tconst result = buildOdspShareLinkReqParams({ scope: SharingLinkScope.organization });\n\t\tassert.strictEqual(result, `createLinkScope=${SharingLinkScope.organization}`);\n\t});\n\n\tit(\"Should return appropriate query parameters when both scope and link role are provided\", async () => {\n\t\tconst result = buildOdspShareLinkReqParams({\n\t\t\tscope: SharingLinkScope.organization,\n\t\t\trole: SharingLinkRole.view,\n\t\t});\n\t\tassert.strictEqual(\n\t\t\tresult,\n\t\t\t`createLinkScope=${SharingLinkScope.organization}&createLinkRole=${SharingLinkRole.view}`,\n\t\t);\n\t});\n\n\tit(\"Should return undefined when the input is undefined\", async () => {\n\t\tconst result = buildOdspShareLinkReqParams(undefined);\n\t\tassert.strictEqual(result, undefined);\n\t});\n});\n"]}

package/lib/test/createNewUtilsTests.spec.js

@@ -0,0 +1,221 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import * as api from "@fluidframework/protocol-definitions";
+import { bufferToString } from "@fluid-internal/client-utils";
+import { SharingLinkRole, SharingLinkScope, } from "@fluidframework/odsp-driver-definitions";
+import { createChildLogger } from "@fluidframework/telemetry-utils";
+import { convertCreateNewSummaryTreeToTreeAndBlobs } from "../createNewUtils.js";
+import { createNewFluidFile } from "../createFile.js";
+import { createNewContainerOnExistingFile } from "../createNewContainerOnExistingFile.js";
+import { EpochTracker } from "../epochTracker.js";
+import { getHashedDocumentId } from "../odspPublicUtils.js";
+import { createCacheSnapshotKey } from "../odspUtils.js";
+import { LocalPersistentCache } from "../odspCache.js";
+import { mockFetchOk } from "./mockFetch.js";
+const createUtLocalCache = () => new LocalPersistentCache();
+describe("Create New Utils Tests", () => {
+    const documentAttributes = {
+        minimumSequenceNumber: 0,
+        sequenceNumber: 0,
+    };
+    const blobContent = "testing";
+    const createSummary = () => {
+        const summary = {
+            type: api.SummaryType.Tree,
+            tree: {},
+        };
+        summary.tree[".app"] = {
+            type: api.SummaryType.Tree,
+            tree: {
+                attributes: {
+                    type: api.SummaryType.Blob,
+                    content: blobContent,
+                },
+            },
+        };
+        summary.tree[".protocol"] = {
+            type: api.SummaryType.Tree,
+            tree: {
+                attributes: {
+                    type: api.SummaryType.Blob,
+                    content: JSON.stringify(documentAttributes),
+                },
+            },
+        };
+        return summary;
+    };
+    const siteUrl = "https://microsoft.sharepoint-df.com/siteUrl";
+    const driveId = "driveId";
+    const itemId = "itemId";
+    const resolvedUrl = {
+        siteUrl,
+        driveId,
+        itemId,
+        odspResolvedUrl: true,
+    };
+    const filePath = "path";
+    let newFileParams;
+    let hashedDocumentId;
+    let localCache;
+    let fileEntry;
+    let epochTracker;
+    before(async () => {
+        hashedDocumentId = await getHashedDocumentId(driveId, itemId);
+        fileEntry = {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        };
+    });
+    beforeEach(async () => {
+        localCache = createUtLocalCache();
+        // use null logger here as we expect errors
+        epochTracker = new EpochTracker(localCache, {
+            docId: hashedDocumentId,
+            resolvedUrl,
+        }, createChildLogger());
+        newFileParams = {
+            type: "New",
+            driveId,
+            siteUrl,
+            filePath,
+            filename: "filename",
+        };
+    });
+    afterEach(async () => {
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    const test = (snapshot) => {
+        const snapshotTree = snapshot.snapshotTree;
+        assert.strictEqual(Object.entries(snapshotTree.trees).length, 2, "app and protocol should be there");
+        assert.strictEqual(snapshot.blobContents.size, 2, "2 blobs should be there");
+        const appTree = snapshotTree.trees[".app"];
+        const protocolTree = snapshotTree.trees[".protocol"];
+        assert(appTree !== undefined, "App tree should be there");
+        assert(protocolTree !== undefined, "Protocol tree should be there");
+        const appTreeBlobId = appTree.blobs.attributes;
+        const appTreeBlobValBuffer = snapshot.blobContents.get(appTreeBlobId);
+        assert(appTreeBlobValBuffer !== undefined, "app blob value should exist");
+        const appTreeBlobVal = bufferToString(appTreeBlobValBuffer, "utf8");
+        assert(appTreeBlobVal === blobContent, "Blob content should match");
+        const docAttributesBlobId = protocolTree.blobs.attributes;
+        const docAttributesBuffer = snapshot.blobContents.get(docAttributesBlobId);
+        assert(docAttributesBuffer !== undefined, "protocol attributes blob value should exist");
+        const docAttributesBlobValue = bufferToString(docAttributesBuffer, "utf8");
+        assert(docAttributesBlobValue === JSON.stringify(documentAttributes), "Blob content should match");
+        assert(snapshot.ops.length === 0, "No ops should be there");
+        assert(snapshot.sequenceNumber === 0, "Seq number should be 0");
+    };
+    it("Should convert as expected and check contents", async () => {
+        const snapshot = convertCreateNewSummaryTreeToTreeAndBlobs(createSummary(), "");
+        test(snapshot);
+    });
+    it("Should cache converted summary during createNewFluidFile", async () => {
+        const odspResolvedUrl = await mockFetchOk(async () => createNewFluidFile(async (_options) => "token", newFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, true /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */), { itemId: "itemId1", id: "Summary handle" }, { "x-fluid-epoch": "epoch1" });
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const snapshot = await epochTracker.get(createCacheSnapshotKey(odspResolvedUrl));
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        test(snapshot);
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    it("Should cache converted summary during createNewContainerOnExistingFile", async () => {
+        const existingFileParams = {
+            type: "Existing",
+            itemId: "itemId1",
+            siteUrl,
+            driveId,
+        };
+        const odspResolvedUrl = await mockFetchOk(async () => createNewContainerOnExistingFile(async (_options) => "token", existingFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, true /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */), { itemId: "itemId1", id: "Summary handle" }, { "x-fluid-epoch": "epoch1" });
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const snapshot = await epochTracker.get(createCacheSnapshotKey(odspResolvedUrl));
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        test(snapshot);
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    it("Should save 'sharing' information received during createNewFluidFile", async () => {
+        const createLinkType = {
+            scope: SharingLinkScope.users,
+            role: SharingLinkRole.edit,
+        };
+        newFileParams.createLinkType = createLinkType;
+        // Test that sharing link is set appropriately when it is received in the response from ODSP
+        const mockSharingLinkData = {
+            localizedDescription: "Specific users with the link can view",
+            iconUrl: "https://mock.icon.url",
+            scope: "organization",
+            type: "view",
+            webUrl: "https://mock.url",
+            blocksDownload: false,
+            createOnly: false,
+            status: "Created",
+            createdDateTime: "2022-05-18T02:58:17.0256105Z",
+        };
+        const mockSharingData = {
+            shareId: "c40e6f0a-666e-48bf-9509-066900a73b2b",
+            sharingLink: mockSharingLinkData,
+        };
+        let odspResolvedUrl = await mockFetchOk(async () => createNewFluidFile(async (_options) => "token", newFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, false /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */, undefined /* isClpCompliantApp */, true /* enableSingleRequestForShareLinkWithCreate */), {
+            itemId: "mockItemId",
+            id: "mockId",
+            sharing: mockSharingData,
+            sharingLinkErrorReason: undefined,
+        }, { "x-fluid-epoch": "epoch1" });
+        assert.deepStrictEqual(odspResolvedUrl.shareLinkInfo?.createLink, {
+            shareId: mockSharingData.shareId,
+            link: {
+                role: mockSharingData.sharingLink.type,
+                ...mockSharingData.sharingLink,
+            },
+            error: undefined,
+        });
+        // Test that error message is set appropriately when it is received in the response from ODSP
+        const mockSharingError = {
+            error: {
+                code: "invalidRequest",
+                message: "Invalid request",
+                innerError: {
+                    code: "invalidRequest",
+                    errorType: "expected",
+                    message: "The CreateLinkScope 'asdf' is not valid or supported.",
+                    stackTrace: "Exceptions.InvalidRequestException",
+                    throwSite: "",
+                },
+            },
+        };
+        odspResolvedUrl = await mockFetchOk(async () => createNewFluidFile(async (_options) => "token", newFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, false /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */, undefined /* isClpCompliantApp */, true /* enableSingleRequestForShareLinkWithCreate */), {
+            itemId: "mockItemId",
+            id: "mockId",
+            sharingLinkErrorReason: "mockError",
+            sharing: mockSharingError,
+        }, { "x-fluid-epoch": "epoch1" });
+        assert.deepStrictEqual(odspResolvedUrl.shareLinkInfo?.createLink, {
+            shareId: undefined,
+            link: undefined,
+            error: mockSharingError.error,
+        });
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    it("Should set the isClpCompliantApp prop on resolved url if already present when createNewFluidFile", async () => {
+        const odspResolvedUrl1 = await mockFetchOk(async () => createNewFluidFile(async (_options) => "token", newFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, true /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */, true /* isClpCompliantApp */), { itemId: "itemId1", id: "Summary handle" }, { "x-fluid-epoch": "epoch1" });
+        assert(odspResolvedUrl1.isClpCompliantApp, "isClpCompliantApp should be set");
+        const odspResolvedUrl2 = await mockFetchOk(async () => createNewFluidFile(async (_options) => "token", newFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, true /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */, undefined /* isClpCompliantApp */), { itemId: "itemId1", id: "Summary handle" }, { "x-fluid-epoch": "epoch1" });
+        assert(!odspResolvedUrl2.isClpCompliantApp, "isClpCompliantApp should be falsy");
+        await epochTracker.removeEntries().catch(() => { });
+    });
+    it("Should set the isClpCompliantApp prop on resolved url if already present when createNewContainerOnExistingFile", async () => {
+        const existingFileParams = {
+            type: "Existing",
+            itemId: "itemId1",
+            siteUrl,
+            driveId,
+        };
+        const odspResolvedUrl1 = await mockFetchOk(async () => createNewContainerOnExistingFile(async (_options) => "token", existingFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, true /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */, true /* isClpCompliantApp */), { itemId: "itemId1", id: "Summary handle" }, { "x-fluid-epoch": "epoch1" });
+        assert(odspResolvedUrl1.isClpCompliantApp, "isClpCompliantApp should be set");
+        const odspResolvedUrl2 = await mockFetchOk(async () => createNewFluidFile(async (_options) => "token", newFileParams, createChildLogger(), createSummary(), epochTracker, fileEntry, true /* createNewCaching */, false /* forceAccessTokenViaAuthorizationHeader */, undefined /* isClpCompliantApp */), { itemId: "itemId1", id: "Summary handle" }, { "x-fluid-epoch": "epoch1" });
+        assert(!odspResolvedUrl2.isClpCompliantApp, "isClpCompliantApp should be falsy");
+        await epochTracker.removeEntries().catch(() => { });
+    });
+});
+//# sourceMappingURL=createNewUtilsTests.spec.js.map

package/lib/test/createNewUtilsTests.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createNewUtilsTests.spec.js","sourceRoot":"","sources":["../../src/test/createNewUtilsTests.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAIN,eAAe,EACf,gBAAgB,GAChB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,yCAAyC,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,gCAAgC,EAAE,MAAM,wCAAwC,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAgB,sBAAsB,EAAqB,MAAM,iBAAiB,CAAC;AAC1F,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,kBAAkB,GAAG,GAAyB,EAAE,CAAC,IAAI,oBAAoB,EAAE,CAAC;AAElF,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACvC,MAAM,kBAAkB,GAA4B;QACnD,qBAAqB,EAAE,CAAC;QACxB,cAAc,EAAE,CAAC;KACjB,CAAC;IACF,MAAM,WAAW,GAAG,SAAS,CAAC;IAC9B,MAAM,aAAa,GAAG,GAAqB,EAAE;QAC5C,MAAM,OAAO,GAAqB;YACjC,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI;YAC1B,IAAI,EAAE,EAAE;SACR,CAAC;QAEF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG;YACtB,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI;YAC1B,IAAI,EAAE;gBACL,UAAU,EAAE;oBACX,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI;oBAC1B,OAAO,EAAE,WAAW;iBACpB;aACD;SACD,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG;YAC3B,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI;YAC1B,IAAI,EAAE;gBACL,UAAU,EAAE;oBACX,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI;oBAC1B,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;iBAC3C;aACD;SACD,CAAC;QACF,OAAO,OAAO,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,6CAA6C,CAAC;IAC9D,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC;IACxB,MAAM,WAAW,GAAG;QACnB,OAAO;QACP,OAAO;QACP,MAAM;QACN,eAAe,EAAE,IAAI;KACU,CAAC;IACjC,MAAM,QAAQ,GAAG,MAAM,CAAC;IACxB,IAAI,aAA2B,CAAC;IAChC,IAAI,gBAAwB,CAAC;IAC7B,IAAI,UAAgC,CAAC;IACrC,IAAI,SAAqB,CAAC;IAC1B,IAAI,YAA0B,CAAC;IAE/B,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9D,SAAS,GAAG;YACX,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACrB,UAAU,GAAG,kBAAkB,EAAE,CAAC;QAClC,2CAA2C;QAC3C,YAAY,GAAG,IAAI,YAAY,CAC9B,UAAU,EACV;YACC,KAAK,EAAE,gBAAgB;YACvB,WAAW;SACX,EACD,iBAAiB,EAAE,CACnB,CAAC;QACF,aAAa,GAAG;YACf,IAAI,EAAE,KAAK;YACX,OAAO;YACP,OAAO;YACP,QAAQ;YACR,QAAQ,EAAE,UAAU;SACpB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,CAAC,QAAmB,EAAQ,EAAE;QAC1C,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;QAC3C,MAAM,CAAC,WAAW,CACjB,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,MAAM,EACzC,CAAC,EACD,kCAAkC,CAClC,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,EAAE,yBAAyB,CAAC,CAAC;QAE7E,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrD,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,0BAA0B,CAAC,CAAC;QAC1D,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAEpE,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;QAC/C,MAAM,oBAAoB,GAAG,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACtE,MAAM,CAAC,oBAAoB,KAAK,SAAS,EAAE,6BAA6B,CAAC,CAAC;QAC1E,MAAM,cAAc,GAAG,cAAc,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;QACpE,MAAM,CAAC,cAAc,KAAK,WAAW,EAAE,2BAA2B,CAAC,CAAC;QAEpE,MAAM,mBAAmB,GAAG,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC;QAC1D,MAAM,mBAAmB,GAAG,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAC3E,MAAM,CAAC,mBAAmB,KAAK,SAAS,EAAE,6CAA6C,CAAC,CAAC;QACzF,MAAM,sBAAsB,GAAG,cAAc,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;QAC3E,MAAM,CACL,sBAAsB,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAC7D,2BAA2B,CAC3B,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,wBAAwB,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,CAAC,cAAc,KAAK,CAAC,EAAE,wBAAwB,CAAC,CAAC;IACjE,CAAC,CAAC;IAEF,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,QAAQ,GAAG,yCAAyC,CAAC,aAAa,EAAE,EAAE,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,eAAe,GAAG,MAAM,WAAW,CACxC,KAAK,IAAI,EAAE,CACV,kBAAkB,CACjB,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,aAAa,EACb,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,IAAI,CAAC,sBAAsB,EAC3B,KAAK,CAAC,4CAA4C,CAClD,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAC3C,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,mEAAmE;QACnE,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,CAAC;QACjF,iEAAiE;QACjE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACf,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,KAAK,IAAI,EAAE;QACvF,MAAM,kBAAkB,GAAsB;YAC7C,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,SAAS;YACjB,OAAO;YACP,OAAO;SACP,CAAC;QACF,MAAM,eAAe,GAAG,MAAM,WAAW,CACxC,KAAK,IAAI,EAAE,CACV,gCAAgC,CAC/B,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,kBAAkB,EAClB,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,IAAI,CAAC,sBAAsB,EAC3B,KAAK,CAAC,4CAA4C,CAClD,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAC3C,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,mEAAmE;QACnE,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,CAAC;QACjF,iEAAiE;QACjE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACf,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,cAAc,GAAqB;YACxC,KAAK,EAAE,gBAAgB,CAAC,KAAK;YAC7B,IAAI,EAAE,eAAe,CAAC,IAAI;SAC1B,CAAC;QACF,aAAa,CAAC,cAAc,GAAG,cAAc,CAAC;QAE9C,4FAA4F;QAC5F,MAAM,mBAAmB,GAAG;YAC3B,oBAAoB,EAAE,uCAAuC;YAC7D,OAAO,EAAE,uBAAuB;YAChC,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,KAAK;YACrB,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,SAAS;YACjB,eAAe,EAAE,8BAA8B;SAC/C,CAAC;QACF,MAAM,eAAe,GAAG;YACvB,OAAO,EAAE,sCAAsC;YAC/C,WAAW,EAAE,mBAAmB;SAChC,CAAC;QACF,IAAI,eAAe,GAAG,MAAM,WAAW,CACtC,KAAK,IAAI,EAAE,CACV,kBAAkB,CACjB,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,aAAa,EACb,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,KAAK,CAAC,sBAAsB,EAC5B,KAAK,CAAC,4CAA4C,EAClD,SAAS,CAAC,uBAAuB,EACjC,IAAI,CAAC,+CAA+C,CACpD,EACF;YACC,MAAM,EAAE,YAAY;YACpB,EAAE,EAAE,QAAQ;YACZ,OAAO,EAAE,eAAe;YACxB,sBAAsB,EAAE,SAAS;SACjC,EACD,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,aAAa,EAAE,UAAU,EAAE;YACjE,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,IAAI,EAAE;gBACL,IAAI,EAAE,eAAe,CAAC,WAAW,CAAC,IAAI;gBACtC,GAAG,eAAe,CAAC,WAAW;aAC9B;YACD,KAAK,EAAE,SAAS;SAChB,CAAC,CAAC;QAEH,6FAA6F;QAC7F,MAAM,gBAAgB,GAAG;YACxB,KAAK,EAAE;gBACN,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,iBAAiB;gBAC1B,UAAU,EAAE;oBACX,IAAI,EAAE,gBAAgB;oBACtB,SAAS,EAAE,UAAU;oBACrB,OAAO,EAAE,uDAAuD;oBAChE,UAAU,EAAE,oCAAoC;oBAChD,SAAS,EAAE,EAAE;iBACb;aACD;SACD,CAAC;QACF,eAAe,GAAG,MAAM,WAAW,CAClC,KAAK,IAAI,EAAE,CACV,kBAAkB,CACjB,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,aAAa,EACb,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,KAAK,CAAC,sBAAsB,EAC5B,KAAK,CAAC,4CAA4C,EAClD,SAAS,CAAC,uBAAuB,EACjC,IAAI,CAAC,+CAA+C,CACpD,EACF;YACC,MAAM,EAAE,YAAY;YACpB,EAAE,EAAE,QAAQ;YACZ,sBAAsB,EAAE,WAAW;YACnC,OAAO,EAAE,gBAAgB;SACzB,EACD,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,aAAa,EAAE,UAAU,EAAE;YACjE,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,gBAAgB,CAAC,KAAK;SAC7B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kGAAkG,EAAE,KAAK,IAAI,EAAE;QACjH,MAAM,gBAAgB,GAAG,MAAM,WAAW,CACzC,KAAK,IAAI,EAAE,CACV,kBAAkB,CACjB,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,aAAa,EACb,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,IAAI,CAAC,sBAAsB,EAC3B,KAAK,CAAC,4CAA4C,EAClD,IAAI,CAAC,uBAAuB,CAC5B,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAC3C,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,iCAAiC,CAAC,CAAC;QAE9E,MAAM,gBAAgB,GAAG,MAAM,WAAW,CACzC,KAAK,IAAI,EAAE,CACV,kBAAkB,CACjB,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,aAAa,EACb,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,IAAI,CAAC,sBAAsB,EAC3B,KAAK,CAAC,4CAA4C,EAClD,SAAS,CAAC,uBAAuB,CACjC,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAC3C,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,mCAAmC,CAAC,CAAC;QACjF,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gHAAgH,EAAE,KAAK,IAAI,EAAE;QAC/H,MAAM,kBAAkB,GAAsB;YAC7C,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,SAAS;YACjB,OAAO;YACP,OAAO;SACP,CAAC;QACF,MAAM,gBAAgB,GAAG,MAAM,WAAW,CACzC,KAAK,IAAI,EAAE,CACV,gCAAgC,CAC/B,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,kBAAkB,EAClB,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,IAAI,CAAC,sBAAsB,EAC3B,KAAK,CAAC,4CAA4C,EAClD,IAAI,CAAC,uBAAuB,CAC5B,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAC3C,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,iCAAiC,CAAC,CAAC;QAE9E,MAAM,gBAAgB,GAAG,MAAM,WAAW,CACzC,KAAK,IAAI,EAAE,CACV,kBAAkB,CACjB,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,EAC3B,aAAa,EACb,iBAAiB,EAAE,EACnB,aAAa,EAAE,EACf,YAAY,EACZ,SAAS,EACT,IAAI,CAAC,sBAAsB,EAC3B,KAAK,CAAC,4CAA4C,EAClD,SAAS,CAAC,uBAAuB,CACjC,EACF,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAC3C,EAAE,eAAe,EAAE,QAAQ,EAAE,CAC7B,CAAC;QACF,MAAM,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,mCAAmC,CAAC,CAAC;QACjF,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"node:assert\";\nimport { ISnapshot } from \"@fluidframework/driver-definitions\";\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport {\n\tIFileEntry,\n\tIOdspResolvedUrl,\n\tISharingLinkKind,\n\tSharingLinkRole,\n\tSharingLinkScope,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { convertCreateNewSummaryTreeToTreeAndBlobs } from \"../createNewUtils.js\";\nimport { createNewFluidFile } from \"../createFile.js\";\nimport { createNewContainerOnExistingFile } from \"../createNewContainerOnExistingFile.js\";\nimport { EpochTracker } from \"../epochTracker.js\";\nimport { getHashedDocumentId } from \"../odspPublicUtils.js\";\nimport { INewFileInfo, createCacheSnapshotKey, IExistingFileInfo } from \"../odspUtils.js\";\nimport { LocalPersistentCache } from \"../odspCache.js\";\nimport { mockFetchOk } from \"./mockFetch.js\";\n\nconst createUtLocalCache = (): LocalPersistentCache => new LocalPersistentCache();\n\ndescribe(\"Create New Utils Tests\", () => {\n\tconst documentAttributes: api.IDocumentAttributes = {\n\t\tminimumSequenceNumber: 0,\n\t\tsequenceNumber: 0,\n\t};\n\tconst blobContent = \"testing\";\n\tconst createSummary = (): api.ISummaryTree => {\n\t\tconst summary: api.ISummaryTree = {\n\t\t\ttype: api.SummaryType.Tree,\n\t\t\ttree: {},\n\t\t};\n\n\t\tsummary.tree[\".app\"] = {\n\t\t\ttype: api.SummaryType.Tree,\n\t\t\ttree: {\n\t\t\t\tattributes: {\n\t\t\t\t\ttype: api.SummaryType.Blob,\n\t\t\t\t\tcontent: blobContent,\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t\tsummary.tree[\".protocol\"] = {\n\t\t\ttype: api.SummaryType.Tree,\n\t\t\ttree: {\n\t\t\t\tattributes: {\n\t\t\t\t\ttype: api.SummaryType.Blob,\n\t\t\t\t\tcontent: JSON.stringify(documentAttributes),\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t\treturn summary;\n\t};\n\n\tconst siteUrl = \"https://microsoft.sharepoint-df.com/siteUrl\";\n\tconst driveId = \"driveId\";\n\tconst itemId = \"itemId\";\n\tconst resolvedUrl = {\n\t\tsiteUrl,\n\t\tdriveId,\n\t\titemId,\n\t\todspResolvedUrl: true,\n\t} as unknown as IOdspResolvedUrl;\n\tconst filePath = \"path\";\n\tlet newFileParams: INewFileInfo;\n\tlet hashedDocumentId: string;\n\tlet localCache: LocalPersistentCache;\n\tlet fileEntry: IFileEntry;\n\tlet epochTracker: EpochTracker;\n\n\tbefore(async () => {\n\t\thashedDocumentId = await getHashedDocumentId(driveId, itemId);\n\t\tfileEntry = {\n\t\t\tdocId: hashedDocumentId,\n\t\t\tresolvedUrl,\n\t\t};\n\t});\n\n\tbeforeEach(async () => {\n\t\tlocalCache = createUtLocalCache();\n\t\t// use null logger here as we expect errors\n\t\tepochTracker = new EpochTracker(\n\t\t\tlocalCache,\n\t\t\t{\n\t\t\t\tdocId: hashedDocumentId,\n\t\t\t\tresolvedUrl,\n\t\t\t},\n\t\t\tcreateChildLogger(),\n\t\t);\n\t\tnewFileParams = {\n\t\t\ttype: \"New\",\n\t\t\tdriveId,\n\t\t\tsiteUrl,\n\t\t\tfilePath,\n\t\t\tfilename: \"filename\",\n\t\t};\n\t});\n\n\tafterEach(async () => {\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tconst test = (snapshot: ISnapshot): void => {\n\t\tconst snapshotTree = snapshot.snapshotTree;\n\t\tassert.strictEqual(\n\t\t\tObject.entries(snapshotTree.trees).length,\n\t\t\t2,\n\t\t\t\"app and protocol should be there\",\n\t\t);\n\t\tassert.strictEqual(snapshot.blobContents.size, 2, \"2 blobs should be there\");\n\n\t\tconst appTree = snapshotTree.trees[\".app\"];\n\t\tconst protocolTree = snapshotTree.trees[\".protocol\"];\n\t\tassert(appTree !== undefined, \"App tree should be there\");\n\t\tassert(protocolTree !== undefined, \"Protocol tree should be there\");\n\n\t\tconst appTreeBlobId = appTree.blobs.attributes;\n\t\tconst appTreeBlobValBuffer = snapshot.blobContents.get(appTreeBlobId);\n\t\tassert(appTreeBlobValBuffer !== undefined, \"app blob value should exist\");\n\t\tconst appTreeBlobVal = bufferToString(appTreeBlobValBuffer, \"utf8\");\n\t\tassert(appTreeBlobVal === blobContent, \"Blob content should match\");\n\n\t\tconst docAttributesBlobId = protocolTree.blobs.attributes;\n\t\tconst docAttributesBuffer = snapshot.blobContents.get(docAttributesBlobId);\n\t\tassert(docAttributesBuffer !== undefined, \"protocol attributes blob value should exist\");\n\t\tconst docAttributesBlobValue = bufferToString(docAttributesBuffer, \"utf8\");\n\t\tassert(\n\t\t\tdocAttributesBlobValue === JSON.stringify(documentAttributes),\n\t\t\t\"Blob content should match\",\n\t\t);\n\n\t\tassert(snapshot.ops.length === 0, \"No ops should be there\");\n\t\tassert(snapshot.sequenceNumber === 0, \"Seq number should be 0\");\n\t};\n\n\tit(\"Should convert as expected and check contents\", async () => {\n\t\tconst snapshot = convertCreateNewSummaryTreeToTreeAndBlobs(createSummary(), \"\");\n\t\ttest(snapshot);\n\t});\n\n\tit(\"Should cache converted summary during createNewFluidFile\", async () => {\n\t\tconst odspResolvedUrl = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewFluidFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\tnewFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\ttrue /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t),\n\t\t\t{ itemId: \"itemId1\", id: \"Summary handle\" },\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\tconst snapshot = await epochTracker.get(createCacheSnapshotKey(odspResolvedUrl));\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\ttest(snapshot);\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tit(\"Should cache converted summary during createNewContainerOnExistingFile\", async () => {\n\t\tconst existingFileParams: IExistingFileInfo = {\n\t\t\ttype: \"Existing\",\n\t\t\titemId: \"itemId1\",\n\t\t\tsiteUrl,\n\t\t\tdriveId,\n\t\t};\n\t\tconst odspResolvedUrl = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewContainerOnExistingFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\texistingFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\ttrue /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t),\n\t\t\t{ itemId: \"itemId1\", id: \"Summary handle\" },\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\tconst snapshot = await epochTracker.get(createCacheSnapshotKey(odspResolvedUrl));\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\ttest(snapshot);\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tit(\"Should save 'sharing' information received during createNewFluidFile\", async () => {\n\t\tconst createLinkType: ISharingLinkKind = {\n\t\t\tscope: SharingLinkScope.users,\n\t\t\trole: SharingLinkRole.edit,\n\t\t};\n\t\tnewFileParams.createLinkType = createLinkType;\n\n\t\t// Test that sharing link is set appropriately when it is received in the response from ODSP\n\t\tconst mockSharingLinkData = {\n\t\t\tlocalizedDescription: \"Specific users with the link can view\",\n\t\t\ticonUrl: \"https://mock.icon.url\",\n\t\t\tscope: \"organization\",\n\t\t\ttype: \"view\",\n\t\t\twebUrl: \"https://mock.url\",\n\t\t\tblocksDownload: false,\n\t\t\tcreateOnly: false,\n\t\t\tstatus: \"Created\",\n\t\t\tcreatedDateTime: \"2022-05-18T02:58:17.0256105Z\",\n\t\t};\n\t\tconst mockSharingData = {\n\t\t\tshareId: \"c40e6f0a-666e-48bf-9509-066900a73b2b\",\n\t\t\tsharingLink: mockSharingLinkData,\n\t\t};\n\t\tlet odspResolvedUrl = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewFluidFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\tnewFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\tfalse /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t\tundefined /* isClpCompliantApp */,\n\t\t\t\t\ttrue /* enableSingleRequestForShareLinkWithCreate */,\n\t\t\t\t),\n\t\t\t{\n\t\t\t\titemId: \"mockItemId\",\n\t\t\t\tid: \"mockId\",\n\t\t\t\tsharing: mockSharingData,\n\t\t\t\tsharingLinkErrorReason: undefined,\n\t\t\t},\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\tassert.deepStrictEqual(odspResolvedUrl.shareLinkInfo?.createLink, {\n\t\t\tshareId: mockSharingData.shareId,\n\t\t\tlink: {\n\t\t\t\trole: mockSharingData.sharingLink.type,\n\t\t\t\t...mockSharingData.sharingLink,\n\t\t\t},\n\t\t\terror: undefined,\n\t\t});\n\n\t\t// Test that error message is set appropriately when it is received in the response from ODSP\n\t\tconst mockSharingError = {\n\t\t\terror: {\n\t\t\t\tcode: \"invalidRequest\",\n\t\t\t\tmessage: \"Invalid request\",\n\t\t\t\tinnerError: {\n\t\t\t\t\tcode: \"invalidRequest\",\n\t\t\t\t\terrorType: \"expected\",\n\t\t\t\t\tmessage: \"The CreateLinkScope 'asdf' is not valid or supported.\",\n\t\t\t\t\tstackTrace: \"Exceptions.InvalidRequestException\",\n\t\t\t\t\tthrowSite: \"\",\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t\todspResolvedUrl = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewFluidFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\tnewFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\tfalse /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t\tundefined /* isClpCompliantApp */,\n\t\t\t\t\ttrue /* enableSingleRequestForShareLinkWithCreate */,\n\t\t\t\t),\n\t\t\t{\n\t\t\t\titemId: \"mockItemId\",\n\t\t\t\tid: \"mockId\",\n\t\t\t\tsharingLinkErrorReason: \"mockError\",\n\t\t\t\tsharing: mockSharingError,\n\t\t\t},\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\tassert.deepStrictEqual(odspResolvedUrl.shareLinkInfo?.createLink, {\n\t\t\tshareId: undefined,\n\t\t\tlink: undefined,\n\t\t\terror: mockSharingError.error,\n\t\t});\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tit(\"Should set the isClpCompliantApp prop on resolved url if already present when createNewFluidFile\", async () => {\n\t\tconst odspResolvedUrl1 = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewFluidFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\tnewFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\ttrue /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t\ttrue /* isClpCompliantApp */,\n\t\t\t\t),\n\t\t\t{ itemId: \"itemId1\", id: \"Summary handle\" },\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\tassert(odspResolvedUrl1.isClpCompliantApp, \"isClpCompliantApp should be set\");\n\n\t\tconst odspResolvedUrl2 = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewFluidFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\tnewFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\ttrue /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t\tundefined /* isClpCompliantApp */,\n\t\t\t\t),\n\t\t\t{ itemId: \"itemId1\", id: \"Summary handle\" },\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\tassert(!odspResolvedUrl2.isClpCompliantApp, \"isClpCompliantApp should be falsy\");\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n\n\tit(\"Should set the isClpCompliantApp prop on resolved url if already present when createNewContainerOnExistingFile\", async () => {\n\t\tconst existingFileParams: IExistingFileInfo = {\n\t\t\ttype: \"Existing\",\n\t\t\titemId: \"itemId1\",\n\t\t\tsiteUrl,\n\t\t\tdriveId,\n\t\t};\n\t\tconst odspResolvedUrl1 = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewContainerOnExistingFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\texistingFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\ttrue /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t\ttrue /* isClpCompliantApp */,\n\t\t\t\t),\n\t\t\t{ itemId: \"itemId1\", id: \"Summary handle\" },\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\tassert(odspResolvedUrl1.isClpCompliantApp, \"isClpCompliantApp should be set\");\n\n\t\tconst odspResolvedUrl2 = await mockFetchOk(\n\t\t\tasync () =>\n\t\t\t\tcreateNewFluidFile(\n\t\t\t\t\tasync (_options) => \"token\",\n\t\t\t\t\tnewFileParams,\n\t\t\t\t\tcreateChildLogger(),\n\t\t\t\t\tcreateSummary(),\n\t\t\t\t\tepochTracker,\n\t\t\t\t\tfileEntry,\n\t\t\t\t\ttrue /* createNewCaching */,\n\t\t\t\t\tfalse /* forceAccessTokenViaAuthorizationHeader */,\n\t\t\t\t\tundefined /* isClpCompliantApp */,\n\t\t\t\t),\n\t\t\t{ itemId: \"itemId1\", id: \"Summary handle\" },\n\t\t\t{ \"x-fluid-epoch\": \"epoch1\" },\n\t\t);\n\t\tassert(!odspResolvedUrl2.isClpCompliantApp, \"isClpCompliantApp should be falsy\");\n\t\tawait epochTracker.removeEntries().catch(() => {});\n\t});\n});\n"]}

package/lib/test/deltaStorageService.spec.js

@@ -0,0 +1,176 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { OdspDeltaStorageService, OdspDeltaStorageWithCache } from "../odspDeltaStorageService.js";
+import { LocalPersistentCache } from "../odspCache.js";
+import { EpochTracker } from "../epochTracker.js";
+import { mockFetchOk } from "./mockFetch.js";
+const createUtLocalCache = () => new LocalPersistentCache(2000);
+const createUtEpochTracker = (fileEntry, logger) => new EpochTracker(createUtLocalCache(), fileEntry, logger);
+describe("DeltaStorageService", () => {
+    /*
+     * Use fake urls so we don't accidental make real calls that make our tests flakey.
+     * Using microsoft.com as the domain so we don't send traffic somewhere hostile on accident.
+     */
+    const deltaStorageBasePath = "https://fake.microsoft.com";
+    const deltaStorageRelativePath = "/drives/testdrive/items/testitem/opStream";
+    const testDeltaStorageUrl = `${deltaStorageBasePath}${deltaStorageRelativePath}`;
+    const siteUrl = "https://fake.microsoft.com";
+    const driveId = "testdrive";
+    const itemId = "testitem";
+    const resolvedUrl = {
+        siteUrl,
+        driveId,
+        itemId,
+        odspResolvedUrl: true,
+    };
+    const fileEntry = { docId: "docId", resolvedUrl };
+    it("Should build the correct sharepoint delta url with auth", async () => {
+        const logger = new MockLogger();
+        const deltaStorageService = new OdspDeltaStorageService(testDeltaStorageUrl, async (_refresh) => "?access_token=123", createUtEpochTracker(fileEntry, logger), logger.toTelemetryLogger());
+        const actualDeltaUrl = deltaStorageService.buildUrl(3, 8);
+        const expectedDeltaUrl = `${deltaStorageBasePath}/drives/testdrive/items/testitem/opStream?ump=1&filter=sequenceNumber%20ge%203%20and%20sequenceNumber%20le%207`;
+        assert.equal(actualDeltaUrl, expectedDeltaUrl, "The constructed delta url is invalid");
+        logger.assertMatchNone([{ category: "error" }]);
+    });
+    describe("Get Returns Response With Op Envelope", () => {
+        const expectedDeltaFeedResponse = {
+            value: [
+                {
+                    op: {
+                        clientId: "present-place",
+                        clientSequenceNumber: 71,
+                        contents: null,
+                        minimumSequenceNumber: 1,
+                        referenceSequenceNumber: 1,
+                        sequenceNumber: 1,
+                        text: "",
+                        user: {
+                            id: "Unruffled Bose",
+                        },
+                    },
+                    sequenceNumber: 1,
+                },
+                {
+                    op: {
+                        clientId: "present-place",
+                        clientSequenceNumber: 71,
+                        contents: null,
+                        minimumSequenceNumber: 1,
+                        referenceSequenceNumber: 1,
+                        sequenceNumber: 2,
+                        type: "noop",
+                        user: {
+                            id: "Unruffled Bose",
+                        },
+                    },
+                    sequenceNumber: 2,
+                },
+            ],
+        };
+        let deltaStorageService;
+        const logger = new MockLogger();
+        before(() => {
+            deltaStorageService = new OdspDeltaStorageService(testDeltaStorageUrl, async (_refresh) => "", createUtEpochTracker(fileEntry, logger), logger.toTelemetryLogger());
+        });
+        afterEach(() => {
+            logger.assertMatchNone([{ category: "error" }]);
+        });
+        it("Should deserialize the delta feed response correctly", async () => {
+            const { messages, partialResult } = await mockFetchOk(async () => deltaStorageService.get(2, 8, {}), expectedDeltaFeedResponse);
+            assert(!partialResult, "partialResult === false");
+            assert.equal(messages.length, 2, "Deserialized feed response is not of expected length");
+            assert.equal(messages[0].sequenceNumber, 1, "First element of feed response has invalid sequence number");
+            assert.equal(messages[1].sequenceNumber, 2, "Second element of feed response has invalid sequence number");
+            assert.equal(messages[1].type, "noop", "Second element of feed response has invalid op type");
+        });
+    });
+    describe("Get Returns Response With Op Envelope", () => {
+        const expectedDeltaFeedResponse = {
+            value: [
+                {
+                    clientId: "present-place",
+                    clientSequenceNumber: 71,
+                    contents: null,
+                    minimumSequenceNumber: 1,
+                    referenceSequenceNumber: 1,
+                    sequenceNumber: 1,
+                    text: "",
+                    user: {
+                        id: "Unruffled Bose",
+                    },
+                },
+                {
+                    clientId: "present-place",
+                    clientSequenceNumber: 71,
+                    contents: null,
+                    minimumSequenceNumber: 1,
+                    referenceSequenceNumber: 1,
+                    sequenceNumber: 2,
+                    type: "noop",
+                    user: {
+                        id: "Unruffled Bose",
+                    },
+                },
+            ],
+        };
+        let deltaStorageService;
+        const logger = new MockLogger();
+        before(() => {
+            deltaStorageService = new OdspDeltaStorageService(testDeltaStorageUrl, async (_refresh) => "", createUtEpochTracker(fileEntry, logger), logger.toTelemetryLogger());
+        });
+        afterEach(() => {
+            logger.assertMatchNone([{ category: "error" }]);
+        });
+        it("Should deserialize the delta feed response correctly", async () => {
+            const { messages, partialResult } = await mockFetchOk(async () => deltaStorageService.get(2, 8, {}), expectedDeltaFeedResponse);
+            assert(!partialResult, "partialResult === false");
+            assert.equal(messages.length, 2, "Deserialized feed response is not of expected length");
+            assert.equal(messages[0].sequenceNumber, 1, "First element of feed response has invalid sequence number");
+            assert.equal(messages[1].sequenceNumber, 2, "Second element of feed response has invalid sequence number");
+            assert.equal(messages[1].type, "noop", "Second element of feed response has invalid op type");
+        });
+    });
+    describe("DeltaStorageServiceWith Cache Tests", () => {
+        const logger = new MockLogger();
+        afterEach(() => {
+            logger.assertMatchNone([{ category: "error" }]);
+        });
+        it("FirstCacheMiss should update to first miss op seq number correctly", async () => {
+            const deltasFetchResult = { messages: [], partialResult: false };
+            let count = 0;
+            const getCached = async (from, to) => {
+                if (count === 0) {
+                    count += 1;
+                    return [
+                        {
+                            clientId: "present-place",
+                            clientSequenceNumber: 71,
+                            contents: null,
+                            minimumSequenceNumber: 1,
+                            referenceSequenceNumber: 1,
+                            sequenceNumber: from,
+                            type: "dds",
+                            timestamp: Date.now(),
+                        },
+                    ];
+                }
+                count += 1;
+                assert.fail("Should not reach here");
+            };
+            const odspDeltaStorageServiceWithCache = new OdspDeltaStorageWithCache([], logger.toTelemetryLogger(), 1000, 1, async (from, to, props, reason) => deltasFetchResult, async (from, to) => getCached(from, to), (from, to) => [], (ops) => { }, () => ({
+                isFirstSnapshotFromNetwork: false,
+            }));
+            const messages = odspDeltaStorageServiceWithCache.fetchMessages(1, undefined);
+            const batch1 = await messages.read();
+            const batch2 = await messages.read();
+            assert(count === 1, "There should be only 1 cache access");
+            assert(batch1.done === false, "Firt batch should have returned 1 op");
+            assert(batch2.done === true, "No ops should be present in second batch");
+        });
+    });
+});
+//# sourceMappingURL=deltaStorageService.spec.js.map