@fluidframework/container-loader 2.0.0-dev-rc.1.0.0.225277 → 2.0.0-dev-rc.1.0.0.232845

package/lib/utils.mjs

@@ -4,10 +4,10 @@
  */
 import { parse } from "url";
 import { v4 as uuid } from "uuid";
-import { stringToBuffer, Uint8ArrayToArrayBuffer } from "@fluid-internal/client-utils";
-import { assert, unreachableCase } from "@fluidframework/core-utils";
+import { Uint8ArrayToString, stringToBuffer } from "@fluid-internal/client-utils";
+import { assert, compareArrays, unreachableCase } from "@fluidframework/core-utils";
 import { SummaryType } from "@fluidframework/protocol-definitions";
-import { LoggingError } from "@fluidframework/telemetry-utils";
+import { LoggingError, UsageError } from "@fluidframework/telemetry-utils";
 import { isCombinedAppAndProtocolSummary, } from "@fluidframework/driver-utils";
 import { DriverErrorTypes } from "@fluidframework/driver-definitions";
 /**
@@ -50,19 +50,14 @@ export function combineAppAndProtocolSummary(appSummary, protocolSummary) {
     return createNewSummary;
 }
 /**
- * Converts summary tree (for upload) to snapshot tree (for download).
- * Summary tree blobs contain contents, but snapshot tree blobs normally
- * contain IDs pointing to storage. This will create 2 blob entries in the
- * snapshot tree for each blob in the summary tree. One will be the regular
- * path pointing to a uniquely generated ID. Then there will be another
- * entry with the path as that uniquely generated ID, and value as the
- * blob contents as a base-64 string.
- * @param summary - summary to convert
+ * Converts a summary to snapshot tree and separate its blob contents
+ * to align detached container format with IPendingContainerState
+ * @param summary - ISummaryTree
  */
-function convertSummaryToSnapshotWithEmbeddedBlobContents(summary) {
+function convertSummaryToSnapshotAndBlobs(summary) {
+    let blobContents = {};
     const treeNode = {
         blobs: {},
-        blobsContents: {},
         trees: {},
         id: uuid(),
         unreferenced: summary.unreferenced,
@@ -72,8 +67,9 @@ function convertSummaryToSnapshotWithEmbeddedBlobContents(summary) {
         const summaryObject = summary.tree[key];
         switch (summaryObject.type) {
             case SummaryType.Tree: {
-                treeNode.trees[key] =
-                    convertSummaryToSnapshotWithEmbeddedBlobContents(summaryObject);
+                const { tree, blobs } = convertSummaryToSnapshotAndBlobs(summaryObject);
+                treeNode.trees[key] = tree;
+                blobContents = { ...blobContents, ...blobs };
                 break;
             }
             case SummaryType.Attachment:
@@ -82,10 +78,10 @@ function convertSummaryToSnapshotWithEmbeddedBlobContents(summary) {
             case SummaryType.Blob: {
                 const blobId = uuid();
                 treeNode.blobs[key] = blobId;
-                const contentBuffer = typeof summaryObject.content === "string"
-                    ? stringToBuffer(summaryObject.content, "utf8")
-                    : Uint8ArrayToArrayBuffer(summaryObject.content);
-                treeNode.blobsContents[blobId] = contentBuffer;
+                const contentString = summaryObject.content instanceof Uint8Array
+                    ? Uint8ArrayToString(summaryObject.content)
+                    : summaryObject.content;
+                blobContents[blobId] = contentString;
                 break;
             }
             case SummaryType.Handle:
@@ -96,38 +92,109 @@ function convertSummaryToSnapshotWithEmbeddedBlobContents(summary) {
             }
         }
     }
-    return treeNode;
+    return { tree: treeNode, blobs: blobContents };
 }
 /**
- * Combine and convert protocol and app summary tree to format which is readable by container while rehydrating.
+ * Converts summary parts into a SnapshotTree and its blob contents.
  * @param protocolSummaryTree - Protocol Summary Tree
  * @param appSummaryTree - App Summary Tree
  */
-export function convertProtocolAndAppSummaryToSnapshotTree(protocolSummaryTree, appSummaryTree) {
-    // Shallow copy is fine, since we are doing a deep clone below.
+function convertProtocolAndAppSummaryToSnapshotAndBlobs(protocolSummaryTree, appSummaryTree) {
     const combinedSummary = {
         type: SummaryType.Tree,
         tree: { ...appSummaryTree.tree },
     };
     combinedSummary.tree[".protocol"] = protocolSummaryTree;
-    const snapshotTreeWithBlobContents = convertSummaryToSnapshotWithEmbeddedBlobContents(combinedSummary);
+    const snapshotTreeWithBlobContents = convertSummaryToSnapshotAndBlobs(combinedSummary);
     return snapshotTreeWithBlobContents;
 }
-// This function converts the snapshot taken in detached container(by serialize api) to snapshotTree with which
-// a detached container can be rehydrated.
-export const getSnapshotTreeFromSerializedContainer = (detachedContainerSnapshot) => {
-    assert(isCombinedAppAndProtocolSummary(detachedContainerSnapshot), 0x1e0 /* "Protocol and App summary trees should be present" */);
+export const getSnapshotTreeAndBlobsFromSerializedContainer = (detachedContainerSnapshot) => {
+    assert(isCombinedAppAndProtocolSummary(detachedContainerSnapshot), "Protocol and App summary trees should be present");
     const protocolSummaryTree = detachedContainerSnapshot.tree[".protocol"];
     const appSummaryTree = detachedContainerSnapshot.tree[".app"];
-    const snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToSnapshotTree(protocolSummaryTree, appSummaryTree);
+    const snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToSnapshotAndBlobs(protocolSummaryTree, appSummaryTree);
     return snapshotTreeWithBlobContents;
 };
 export function getProtocolSnapshotTree(snapshot) {
     return ".protocol" in snapshot.trees ? snapshot.trees[".protocol"] : snapshot;
 }
+export const combineSnapshotTreeAndSnapshotBlobs = (baseSnapshot, snapshotBlobs) => {
+    const blobsContents = {};
+    // Process blobs in the current level
+    for (const [, id] of Object.entries(baseSnapshot.blobs)) {
+        if (snapshotBlobs[id]) {
+            blobsContents[id] = stringToBuffer(snapshotBlobs[id], "utf8");
+        }
+    }
+    // Recursively process trees in the current level
+    const trees = {};
+    for (const [path, tree] of Object.entries(baseSnapshot.trees)) {
+        trees[path] = combineSnapshotTreeAndSnapshotBlobs(tree, snapshotBlobs);
+    }
+    // Create a new snapshot tree with blob contents and processed trees
+    const snapshotTreeWithBlobContents = {
+        ...baseSnapshot,
+        blobsContents,
+        trees,
+    };
+    return snapshotTreeWithBlobContents;
+};
 export function isDeltaStreamConnectionForbiddenError(error) {
     return (typeof error === "object" &&
         error !== null &&
         error?.errorType === DriverErrorTypes.deltaStreamConnectionForbidden);
 }
+/**
+ * Validates format in parsed string get from detached container
+ * serialization using IPendingDetachedContainerState format.
+ */
+function isPendingDetachedContainerState(detachedContainerState) {
+    if (detachedContainerState?.attached === undefined ||
+        detachedContainerState?.baseSnapshot === undefined ||
+        detachedContainerState?.snapshotBlobs === undefined ||
+        detachedContainerState?.hasAttachmentBlobs === undefined) {
+        return false;
+    }
+    return true;
+}
+export function getDetachedContainerStateFromSerializedContainer(serializedContainer) {
+    const hasBlobsSummaryTree = ".hasAttachmentBlobs";
+    const parsedContainerState = JSON.parse(serializedContainer);
+    if (isPendingDetachedContainerState(parsedContainerState)) {
+        return parsedContainerState;
+    }
+    else if (isCombinedAppAndProtocolSummary(parsedContainerState)) {
+        const { tree, blobs } = getSnapshotTreeAndBlobsFromSerializedContainer(parsedContainerState);
+        const detachedContainerState = {
+            attached: false,
+            baseSnapshot: tree,
+            snapshotBlobs: blobs,
+            hasAttachmentBlobs: parsedContainerState.tree[hasBlobsSummaryTree] !== undefined,
+        };
+        return detachedContainerState;
+    }
+    else {
+        throw new UsageError("Cannot rehydrate detached container. Incorrect format");
+    }
+}
+/**
+ * Ensures only a single instance of the provided async function is running.
+ * If there are multiple calls they will all get the same promise to wait on.
+ */
+export const runSingle = (func) => {
+    let running;
+    // don't mark this function async, so we return the same promise,
+    // rather than one that is wrapped due to async
+    // eslint-disable-next-line @typescript-eslint/promise-function-async
+    return (...args) => {
+        if (running !== undefined) {
+            if (!compareArrays(running.args, args)) {
+                return Promise.reject(new UsageError("Subsequent calls cannot use different arguments."));
+            }
+            return running.result;
+        }
+        running = { args, result: func(...args).finally(() => (running = undefined)) };
+        return running.result;
+    };
+};
 //# sourceMappingURL=utils.mjs.map

package/lib/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,KAAK,EAAE,MAAM,KAAK;OACpB,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM;OAC1B,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,8BAA8B;OAC/E,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,4BAA4B;OAC7D,EAA+B,WAAW,EAAE,MAAM,sCAAsC;OACxF,EAAE,YAAY,EAAE,MAAM,iCAAiC;OACvD,EAGN,+BAA+B,GAC/B,MAAM,8BAA8B;OAC9B,EAAE,gBAAgB,EAAE,MAAM,oCAAoC;AAoCrE;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B,CAAC,GAAW;IACxD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACxC,MAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,CAAC;KACnD;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,2BAA2B,CAAC;IAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,KAAK,EAAE,MAAM,KAAK,CAAC;QACzB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAiB,EAAE;QAClF,CAAC,CAAC,SAAS,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAC3C,UAAwB,EACxB,eAA6B;IAE7B,MAAM,CACL,CAAC,+BAA+B,CAAC,UAAU,CAAC,EAC5C,KAAK,CAAC,6CAA6C,CACnD,CAAC;IACF,MAAM,CACL,CAAC,+BAA+B,CAAC,eAAe,CAAC,EACjD,KAAK,CAAC,kDAAkD,CACxD,CAAC;IACF,MAAM,gBAAgB,GAAkC;QACvD,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE;YACL,WAAW,EAAE,eAAe;YAC5B,MAAM,EAAE,UAAU;SAClB;KACD,CAAC;IACF,OAAO,gBAAgB,CAAC;AACzB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,gDAAgD,CACxD,OAAqB;IAErB,MAAM,QAAQ,GAAkC;QAC/C,KAAK,EAAE,EAAE;QACT,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE;QACT,EAAE,EAAE,IAAI,EAAE;QACV,YAAY,EAAE,OAAO,CAAC,YAAY;KAClC,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACvB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,QAAQ,aAAa,CAAC,IAAI,EAAE;YAC3B,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC;oBAClB,gDAAgD,CAAC,aAAa,CAAC,CAAC;gBACjE,MAAM;aACN;YACD,KAAK,WAAW,CAAC,UAAU;gBAC1B,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC;gBACvC,MAAM;YACP,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC;gBACtB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;gBAC7B,MAAM,aAAa,GAClB,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ;oBACxC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC;oBAC/C,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACnD,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC;gBAC/C,MAAM;aACN;YACD,KAAK,WAAW,CAAC,MAAM;gBACtB,MAAM,IAAI,YAAY,CACrB,+DAA+D,CAC/D,CAAC;gBACF,MAAM;YACP,OAAO,CAAC,CAAC;gBACR,eAAe,CAAC,aAAa,EAAE,qBAAsB,aAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;aACnF;SACD;KACD;IACD,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACzD,mBAAiC,EACjC,cAA4B;IAE5B,+DAA+D;IAC/D,MAAM,eAAe,GAAiB;QACrC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE;KAChC,CAAC;IAEF,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,mBAAmB,CAAC;IACxD,MAAM,4BAA4B,GACjC,gDAAgD,CAAC,eAAe,CAAC,CAAC;IACnE,OAAO,4BAA4B,CAAC;AACrC,CAAC;AAED,+GAA+G;AAC/G,0CAA0C;AAC1C,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACrD,yBAAuC,EACP,EAAE;IAClC,MAAM,CACL,+BAA+B,CAAC,yBAAyB,CAAC,EAC1D,KAAK,CAAC,wDAAwD,CAC9D,CAAC;IACF,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9D,MAAM,4BAA4B,GAAG,0CAA0C,CAC9E,mBAAmB,EACnB,cAAc,CACd,CAAC;IACF,OAAO,4BAA4B,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,UAAU,uBAAuB,CAAC,QAAuB;IAC9D,OAAO,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC/E,CAAC;AAED,MAAM,UAAU,qCAAqC,CACpD,KAAU;IAEV,OAAO,CACN,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,KAAK,EAAE,SAAS,KAAK,gBAAgB,CAAC,8BAA8B,CACpE,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { parse } from \"url\";\nimport { v4 as uuid } from \"uuid\";\nimport { stringToBuffer, Uint8ArrayToArrayBuffer } from \"@fluid-internal/client-utils\";\nimport { assert, unreachableCase } from \"@fluidframework/core-utils\";\nimport { ISummaryTree, ISnapshotTree, SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { LoggingError } from \"@fluidframework/telemetry-utils\";\nimport {\n\tCombinedAppAndProtocolSummary,\n\tDeltaStreamConnectionForbiddenError,\n\tisCombinedAppAndProtocolSummary,\n} from \"@fluidframework/driver-utils\";\nimport { DriverErrorTypes } from \"@fluidframework/driver-definitions\";\n\n// This is used when we rehydrate a container from the snapshot. Here we put the blob contents\n// in separate property: blobContents.\nexport interface ISnapshotTreeWithBlobContents extends ISnapshotTree {\n\tblobsContents: { [path: string]: ArrayBufferLike };\n\ttrees: { [path: string]: ISnapshotTreeWithBlobContents };\n}\n\n/**\n * Interface to represent the parsed parts of IResolvedUrl.url to help\n * in getting info about different parts of the url.\n * May not be compatible or relevant for any Url Resolver\n * @internal\n */\nexport interface IParsedUrl {\n\t/**\n\t * It is combination of tenantid/docId part of the url.\n\t */\n\tid: string;\n\t/**\n\t * It is the deep link path in the url.\n\t */\n\tpath: string;\n\t/**\n\t * Query string part of the url.\n\t */\n\tquery: string;\n\t/**\n\t * Null means do not use snapshots, undefined means load latest snapshot\n\t * otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.\n\t * If needed, can add undefined which is treated by Container.load() as load latest snapshot.\n\t */\n\tversion: string | null | undefined;\n}\n\n/**\n * Utility api to parse the IResolvedUrl.url into specific parts like querystring, path to get\n * deep link info etc.\n * Warning - This function may not be compatible with any Url Resolver's resolved url. It works\n * with urls of type: protocol://<string>/.../..?<querystring>\n * @param url - This is the IResolvedUrl.url part of the resolved url.\n * @returns The IParsedUrl representing the input URL, or undefined if the format was not supported\n * @internal\n */\nexport function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined {\n\tconst parsed = parse(url, true);\n\tif (typeof parsed.pathname !== \"string\") {\n\t\tthrow new LoggingError(\"Failed to parse pathname\");\n\t}\n\tconst query = parsed.search ?? \"\";\n\tconst regex = /^\\/([^/]*\\/[^/]*)(\\/?.*)$/;\n\tconst match = regex.exec(parsed.pathname);\n\treturn match?.length === 3\n\t\t? { id: match[1], path: match[2], query, version: parsed.query.version as string }\n\t\t: undefined;\n}\n\n/**\n * Combine the app summary and protocol summary in 1 tree.\n * @param appSummary - Summary of the app.\n * @param protocolSummary - Summary of the protocol.\n * @internal\n */\nexport function combineAppAndProtocolSummary(\n\tappSummary: ISummaryTree,\n\tprotocolSummary: ISummaryTree,\n): CombinedAppAndProtocolSummary {\n\tassert(\n\t\t!isCombinedAppAndProtocolSummary(appSummary),\n\t\t0x5a8 /* app summary is already a combined tree! */,\n\t);\n\tassert(\n\t\t!isCombinedAppAndProtocolSummary(protocolSummary),\n\t\t0x5a9 /* protocol summary is already a combined tree! */,\n\t);\n\tconst createNewSummary: CombinedAppAndProtocolSummary = {\n\t\ttype: SummaryType.Tree,\n\t\ttree: {\n\t\t\t\".protocol\": protocolSummary,\n\t\t\t\".app\": appSummary,\n\t\t},\n\t};\n\treturn createNewSummary;\n}\n\n/**\n * Converts summary tree (for upload) to snapshot tree (for download).\n * Summary tree blobs contain contents, but snapshot tree blobs normally\n * contain IDs pointing to storage. This will create 2 blob entries in the\n * snapshot tree for each blob in the summary tree. One will be the regular\n * path pointing to a uniquely generated ID. Then there will be another\n * entry with the path as that uniquely generated ID, and value as the\n * blob contents as a base-64 string.\n * @param summary - summary to convert\n */\nfunction convertSummaryToSnapshotWithEmbeddedBlobContents(\n\tsummary: ISummaryTree,\n): ISnapshotTreeWithBlobContents {\n\tconst treeNode: ISnapshotTreeWithBlobContents = {\n\t\tblobs: {},\n\t\tblobsContents: {},\n\t\ttrees: {},\n\t\tid: uuid(),\n\t\tunreferenced: summary.unreferenced,\n\t};\n\tconst keys = Object.keys(summary.tree);\n\tfor (const key of keys) {\n\t\tconst summaryObject = summary.tree[key];\n\n\t\tswitch (summaryObject.type) {\n\t\t\tcase SummaryType.Tree: {\n\t\t\t\ttreeNode.trees[key] =\n\t\t\t\t\tconvertSummaryToSnapshotWithEmbeddedBlobContents(summaryObject);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase SummaryType.Attachment:\n\t\t\t\ttreeNode.blobs[key] = summaryObject.id;\n\t\t\t\tbreak;\n\t\t\tcase SummaryType.Blob: {\n\t\t\t\tconst blobId = uuid();\n\t\t\t\ttreeNode.blobs[key] = blobId;\n\t\t\t\tconst contentBuffer =\n\t\t\t\t\ttypeof summaryObject.content === \"string\"\n\t\t\t\t\t\t? stringToBuffer(summaryObject.content, \"utf8\")\n\t\t\t\t\t\t: Uint8ArrayToArrayBuffer(summaryObject.content);\n\t\t\t\ttreeNode.blobsContents[blobId] = contentBuffer;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase SummaryType.Handle:\n\t\t\t\tthrow new LoggingError(\n\t\t\t\t\t\"No handles should be there in summary in detached container!!\",\n\t\t\t\t);\n\t\t\t\tbreak;\n\t\t\tdefault: {\n\t\t\t\tunreachableCase(summaryObject, `Unknown tree type ${(summaryObject as any).type}`);\n\t\t\t}\n\t\t}\n\t}\n\treturn treeNode;\n}\n\n/**\n * Combine and convert protocol and app summary tree to format which is readable by container while rehydrating.\n * @param protocolSummaryTree - Protocol Summary Tree\n * @param appSummaryTree - App Summary Tree\n */\nexport function convertProtocolAndAppSummaryToSnapshotTree(\n\tprotocolSummaryTree: ISummaryTree,\n\tappSummaryTree: ISummaryTree,\n): ISnapshotTreeWithBlobContents {\n\t// Shallow copy is fine, since we are doing a deep clone below.\n\tconst combinedSummary: ISummaryTree = {\n\t\ttype: SummaryType.Tree,\n\t\ttree: { ...appSummaryTree.tree },\n\t};\n\n\tcombinedSummary.tree[\".protocol\"] = protocolSummaryTree;\n\tconst snapshotTreeWithBlobContents =\n\t\tconvertSummaryToSnapshotWithEmbeddedBlobContents(combinedSummary);\n\treturn snapshotTreeWithBlobContents;\n}\n\n// This function converts the snapshot taken in detached container(by serialize api) to snapshotTree with which\n// a detached container can be rehydrated.\nexport const getSnapshotTreeFromSerializedContainer = (\n\tdetachedContainerSnapshot: ISummaryTree,\n): ISnapshotTreeWithBlobContents => {\n\tassert(\n\t\tisCombinedAppAndProtocolSummary(detachedContainerSnapshot),\n\t\t0x1e0 /* \"Protocol and App summary trees should be present\" */,\n\t);\n\tconst protocolSummaryTree = detachedContainerSnapshot.tree[\".protocol\"];\n\tconst appSummaryTree = detachedContainerSnapshot.tree[\".app\"];\n\tconst snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToSnapshotTree(\n\t\tprotocolSummaryTree,\n\t\tappSummaryTree,\n\t);\n\treturn snapshotTreeWithBlobContents;\n};\n\nexport function getProtocolSnapshotTree(snapshot: ISnapshotTree): ISnapshotTree {\n\treturn \".protocol\" in snapshot.trees ? snapshot.trees[\".protocol\"] : snapshot;\n}\n\nexport function isDeltaStreamConnectionForbiddenError(\n\terror: any,\n): error is DeltaStreamConnectionForbiddenError {\n\treturn (\n\t\ttypeof error === \"object\" &&\n\t\terror !== null &&\n\t\terror?.errorType === DriverErrorTypes.deltaStreamConnectionForbidden\n\t);\n}\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,KAAK,EAAE,MAAM,KAAK;OACpB,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM;OAC1B,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,8BAA8B;OAC1E,EAAE,MAAM,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,4BAA4B;OAC5E,EAA+B,WAAW,EAAE,MAAM,sCAAsC;OACxF,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,iCAAiC;OACnE,EAGN,+BAA+B,GAC/B,MAAM,8BAA8B;OAC9B,EAAE,gBAAgB,EAAE,MAAM,oCAAoC;AAsCrE;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B,CAAC,GAAW;IACxD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACxC,MAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,CAAC;KACnD;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,2BAA2B,CAAC;IAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,KAAK,EAAE,MAAM,KAAK,CAAC;QACzB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAiB,EAAE;QAClF,CAAC,CAAC,SAAS,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAC3C,UAAwB,EACxB,eAA6B;IAE7B,MAAM,CACL,CAAC,+BAA+B,CAAC,UAAU,CAAC,EAC5C,KAAK,CAAC,6CAA6C,CACnD,CAAC;IACF,MAAM,CACL,CAAC,+BAA+B,CAAC,eAAe,CAAC,EACjD,KAAK,CAAC,kDAAkD,CACxD,CAAC;IACF,MAAM,gBAAgB,GAAkC;QACvD,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE;YACL,WAAW,EAAE,eAAe;YAC5B,MAAM,EAAE,UAAU;SAClB;KACD,CAAC;IACF,OAAO,gBAAgB,CAAC;AACzB,CAAC;AAED;;;;GAIG;AACH,SAAS,gCAAgC,CAAC,OAAqB;IAI9D,IAAI,YAAY,GAA8B,EAAE,CAAC;IACjD,MAAM,QAAQ,GAAkB;QAC/B,KAAK,EAAE,EAAE;QACT,KAAK,EAAE,EAAE;QACT,EAAE,EAAE,IAAI,EAAE;QACV,YAAY,EAAE,OAAO,CAAC,YAAY;KAClC,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACvB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,QAAQ,aAAa,CAAC,IAAI,EAAE;YAC3B,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,gCAAgC,CAAC,aAAa,CAAC,CAAC;gBACxE,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;gBAC3B,YAAY,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE,CAAC;gBAC7C,MAAM;aACN;YACD,KAAK,WAAW,CAAC,UAAU;gBAC1B,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC;gBACvC,MAAM;YACP,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC;gBACtB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;gBAC7B,MAAM,aAAa,GAClB,aAAa,CAAC,OAAO,YAAY,UAAU;oBAC1C,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAC,OAAO,CAAC;oBAC3C,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC;gBAC1B,YAAY,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC;gBACrC,MAAM;aACN;YACD,KAAK,WAAW,CAAC,MAAM;gBACtB,MAAM,IAAI,YAAY,CACrB,+DAA+D,CAC/D,CAAC;gBACF,MAAM;YACP,OAAO,CAAC,CAAC;gBACR,eAAe,CAAC,aAAa,EAAE,qBAAsB,aAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;aACnF;SACD;KACD;IACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,SAAS,8CAA8C,CACtD,mBAAiC,EACjC,cAA4B;IAE5B,MAAM,eAAe,GAAiB;QACrC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,IAAI,EAAE,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE;KAChC,CAAC;IAEF,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,mBAAmB,CAAC;IACxD,MAAM,4BAA4B,GAAG,gCAAgC,CAAC,eAAe,CAAC,CAAC;IACvF,OAAO,4BAA4B,CAAC;AACrC,CAAC;AAED,MAAM,CAAC,MAAM,8CAA8C,GAAG,CAC7D,yBAAuC,EACqB,EAAE;IAC9D,MAAM,CACL,+BAA+B,CAAC,yBAAyB,CAAC,EAC1D,kDAAkD,CAClD,CAAC;IACF,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9D,MAAM,4BAA4B,GAAG,8CAA8C,CAClF,mBAAmB,EACnB,cAAc,CACd,CAAC;IACF,OAAO,4BAA4B,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,UAAU,uBAAuB,CAAC,QAAuB;IAC9D,OAAO,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC/E,CAAC;AAED,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAClD,YAA2B,EAC3B,aAAwC,EACR,EAAE;IAClC,MAAM,aAAa,GAAwC,EAAE,CAAC;IAE9D,qCAAqC;IACrC,KAAK,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QACxD,IAAI,aAAa,CAAC,EAAE,CAAC,EAAE;YACtB,aAAa,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;SAC9D;KACD;IAED,iDAAiD;IACjD,MAAM,KAAK,GAAsD,EAAE,CAAC;IACpE,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QAC9D,KAAK,CAAC,IAAI,CAAC,GAAG,mCAAmC,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;KACvE;IAED,oEAAoE;IACpE,MAAM,4BAA4B,GAAkC;QACnE,GAAG,YAAY;QACf,aAAa;QACb,KAAK;KACL,CAAC;IAEF,OAAO,4BAA4B,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,UAAU,qCAAqC,CACpD,KAAU;IAEV,OAAO,CACN,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,KAAK,EAAE,SAAS,KAAK,gBAAgB,CAAC,8BAA8B,CACpE,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,+BAA+B,CACvC,sBAAsD;IAEtD,IACC,sBAAsB,EAAE,QAAQ,KAAK,SAAS;QAC9C,sBAAsB,EAAE,YAAY,KAAK,SAAS;QAClD,sBAAsB,EAAE,aAAa,KAAK,SAAS;QACnD,sBAAsB,EAAE,kBAAkB,KAAK,SAAS,EACvD;QACD,OAAO,KAAK,CAAC;KACb;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,MAAM,UAAU,gDAAgD,CAC/D,mBAA2B;IAE3B,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;IAClD,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC7D,IAAI,+BAA+B,CAAC,oBAAoB,CAAC,EAAE;QAC1D,OAAO,oBAAoB,CAAC;KAC5B;SAAM,IAAI,+BAA+B,CAAC,oBAAoB,CAAC,EAAE;QACjE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GACpB,8CAA8C,CAAC,oBAAoB,CAAC,CAAC;QACtE,MAAM,sBAAsB,GAAmC;YAC9D,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,IAAI;YAClB,aAAa,EAAE,KAAK;YACpB,kBAAkB,EAAE,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,SAAS;SAChF,CAAC;QACF,OAAO,sBAAsB,CAAC;KAC9B;SAAM;QACN,MAAM,IAAI,UAAU,CAAC,uDAAuD,CAAC,CAAC;KAC9E;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAqB,IAAgC,EAAE,EAAE;IACjF,IAAI,OAKQ,CAAC;IACb,iEAAiE;IACjE,+CAA+C;IAC/C,qEAAqE;IACrE,OAAO,CAAC,GAAG,IAAO,EAAE,EAAE;QACrB,IAAI,OAAO,KAAK,SAAS,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;gBACvC,OAAO,OAAO,CAAC,MAAM,CACpB,IAAI,UAAU,CAAC,kDAAkD,CAAC,CAClE,CAAC;aACF;YACD,OAAO,OAAO,CAAC,MAAM,CAAC;SACtB;QACD,OAAO,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC;QAC/E,OAAO,OAAO,CAAC,MAAM,CAAC;IACvB,CAAC,CAAC;AACH,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { parse } from \"url\";\nimport { v4 as uuid } from \"uuid\";\nimport { Uint8ArrayToString, stringToBuffer } from \"@fluid-internal/client-utils\";\nimport { assert, compareArrays, unreachableCase } from \"@fluidframework/core-utils\";\nimport { ISummaryTree, ISnapshotTree, SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { LoggingError, UsageError } from \"@fluidframework/telemetry-utils\";\nimport {\n\tCombinedAppAndProtocolSummary,\n\tDeltaStreamConnectionForbiddenError,\n\tisCombinedAppAndProtocolSummary,\n} from \"@fluidframework/driver-utils\";\nimport { DriverErrorTypes } from \"@fluidframework/driver-definitions\";\nimport { ISerializableBlobContents } from \"./containerStorageAdapter\";\nimport { IPendingDetachedContainerState } from \"./container\";\n\n// This is used when we rehydrate a container from the snapshot. Here we put the blob contents\n// in separate property: blobContents.\nexport interface ISnapshotTreeWithBlobContents extends ISnapshotTree {\n\tblobsContents: { [path: string]: ArrayBufferLike };\n\ttrees: { [path: string]: ISnapshotTreeWithBlobContents };\n}\n\n/**\n * Interface to represent the parsed parts of IResolvedUrl.url to help\n * in getting info about different parts of the url.\n * May not be compatible or relevant for any Url Resolver\n * @internal\n */\nexport interface IParsedUrl {\n\t/**\n\t * It is combination of tenantid/docId part of the url.\n\t */\n\tid: string;\n\t/**\n\t * It is the deep link path in the url.\n\t */\n\tpath: string;\n\t/**\n\t * Query string part of the url.\n\t */\n\tquery: string;\n\t/**\n\t * Null means do not use snapshots, undefined means load latest snapshot\n\t * otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.\n\t * If needed, can add undefined which is treated by Container.load() as load latest snapshot.\n\t */\n\tversion: string | null | undefined;\n}\n\n/**\n * Utility api to parse the IResolvedUrl.url into specific parts like querystring, path to get\n * deep link info etc.\n * Warning - This function may not be compatible with any Url Resolver's resolved url. It works\n * with urls of type: protocol://<string>/.../..?<querystring>\n * @param url - This is the IResolvedUrl.url part of the resolved url.\n * @returns The IParsedUrl representing the input URL, or undefined if the format was not supported\n * @internal\n */\nexport function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined {\n\tconst parsed = parse(url, true);\n\tif (typeof parsed.pathname !== \"string\") {\n\t\tthrow new LoggingError(\"Failed to parse pathname\");\n\t}\n\tconst query = parsed.search ?? \"\";\n\tconst regex = /^\\/([^/]*\\/[^/]*)(\\/?.*)$/;\n\tconst match = regex.exec(parsed.pathname);\n\treturn match?.length === 3\n\t\t? { id: match[1], path: match[2], query, version: parsed.query.version as string }\n\t\t: undefined;\n}\n\n/**\n * Combine the app summary and protocol summary in 1 tree.\n * @param appSummary - Summary of the app.\n * @param protocolSummary - Summary of the protocol.\n * @internal\n */\nexport function combineAppAndProtocolSummary(\n\tappSummary: ISummaryTree,\n\tprotocolSummary: ISummaryTree,\n): CombinedAppAndProtocolSummary {\n\tassert(\n\t\t!isCombinedAppAndProtocolSummary(appSummary),\n\t\t0x5a8 /* app summary is already a combined tree! */,\n\t);\n\tassert(\n\t\t!isCombinedAppAndProtocolSummary(protocolSummary),\n\t\t0x5a9 /* protocol summary is already a combined tree! */,\n\t);\n\tconst createNewSummary: CombinedAppAndProtocolSummary = {\n\t\ttype: SummaryType.Tree,\n\t\ttree: {\n\t\t\t\".protocol\": protocolSummary,\n\t\t\t\".app\": appSummary,\n\t\t},\n\t};\n\treturn createNewSummary;\n}\n\n/**\n * Converts a summary to snapshot tree and separate its blob contents\n * to align detached container format with IPendingContainerState\n * @param summary - ISummaryTree\n */\nfunction convertSummaryToSnapshotAndBlobs(summary: ISummaryTree): {\n\ttree: ISnapshotTree;\n\tblobs: ISerializableBlobContents;\n} {\n\tlet blobContents: ISerializableBlobContents = {};\n\tconst treeNode: ISnapshotTree = {\n\t\tblobs: {},\n\t\ttrees: {},\n\t\tid: uuid(),\n\t\tunreferenced: summary.unreferenced,\n\t};\n\tconst keys = Object.keys(summary.tree);\n\tfor (const key of keys) {\n\t\tconst summaryObject = summary.tree[key];\n\n\t\tswitch (summaryObject.type) {\n\t\t\tcase SummaryType.Tree: {\n\t\t\t\tconst { tree, blobs } = convertSummaryToSnapshotAndBlobs(summaryObject);\n\t\t\t\ttreeNode.trees[key] = tree;\n\t\t\t\tblobContents = { ...blobContents, ...blobs };\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase SummaryType.Attachment:\n\t\t\t\ttreeNode.blobs[key] = summaryObject.id;\n\t\t\t\tbreak;\n\t\t\tcase SummaryType.Blob: {\n\t\t\t\tconst blobId = uuid();\n\t\t\t\ttreeNode.blobs[key] = blobId;\n\t\t\t\tconst contentString: string =\n\t\t\t\t\tsummaryObject.content instanceof Uint8Array\n\t\t\t\t\t\t? Uint8ArrayToString(summaryObject.content)\n\t\t\t\t\t\t: summaryObject.content;\n\t\t\t\tblobContents[blobId] = contentString;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase SummaryType.Handle:\n\t\t\t\tthrow new LoggingError(\n\t\t\t\t\t\"No handles should be there in summary in detached container!!\",\n\t\t\t\t);\n\t\t\t\tbreak;\n\t\t\tdefault: {\n\t\t\t\tunreachableCase(summaryObject, `Unknown tree type ${(summaryObject as any).type}`);\n\t\t\t}\n\t\t}\n\t}\n\treturn { tree: treeNode, blobs: blobContents };\n}\n\n/**\n * Converts summary parts into a SnapshotTree and its blob contents.\n * @param protocolSummaryTree - Protocol Summary Tree\n * @param appSummaryTree - App Summary Tree\n */\nfunction convertProtocolAndAppSummaryToSnapshotAndBlobs(\n\tprotocolSummaryTree: ISummaryTree,\n\tappSummaryTree: ISummaryTree,\n): { tree: ISnapshotTree; blobs: ISerializableBlobContents } {\n\tconst combinedSummary: ISummaryTree = {\n\t\ttype: SummaryType.Tree,\n\t\ttree: { ...appSummaryTree.tree },\n\t};\n\n\tcombinedSummary.tree[\".protocol\"] = protocolSummaryTree;\n\tconst snapshotTreeWithBlobContents = convertSummaryToSnapshotAndBlobs(combinedSummary);\n\treturn snapshotTreeWithBlobContents;\n}\n\nexport const getSnapshotTreeAndBlobsFromSerializedContainer = (\n\tdetachedContainerSnapshot: ISummaryTree,\n): { tree: ISnapshotTree; blobs: ISerializableBlobContents } => {\n\tassert(\n\t\tisCombinedAppAndProtocolSummary(detachedContainerSnapshot),\n\t\t\"Protocol and App summary trees should be present\",\n\t);\n\tconst protocolSummaryTree = detachedContainerSnapshot.tree[\".protocol\"];\n\tconst appSummaryTree = detachedContainerSnapshot.tree[\".app\"];\n\tconst snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToSnapshotAndBlobs(\n\t\tprotocolSummaryTree,\n\t\tappSummaryTree,\n\t);\n\treturn snapshotTreeWithBlobContents;\n};\n\nexport function getProtocolSnapshotTree(snapshot: ISnapshotTree): ISnapshotTree {\n\treturn \".protocol\" in snapshot.trees ? snapshot.trees[\".protocol\"] : snapshot;\n}\n\nexport const combineSnapshotTreeAndSnapshotBlobs = (\n\tbaseSnapshot: ISnapshotTree,\n\tsnapshotBlobs: ISerializableBlobContents,\n): ISnapshotTreeWithBlobContents => {\n\tconst blobsContents: { [path: string]: ArrayBufferLike } = {};\n\n\t// Process blobs in the current level\n\tfor (const [, id] of Object.entries(baseSnapshot.blobs)) {\n\t\tif (snapshotBlobs[id]) {\n\t\t\tblobsContents[id] = stringToBuffer(snapshotBlobs[id], \"utf8\");\n\t\t}\n\t}\n\n\t// Recursively process trees in the current level\n\tconst trees: { [path: string]: ISnapshotTreeWithBlobContents } = {};\n\tfor (const [path, tree] of Object.entries(baseSnapshot.trees)) {\n\t\ttrees[path] = combineSnapshotTreeAndSnapshotBlobs(tree, snapshotBlobs);\n\t}\n\n\t// Create a new snapshot tree with blob contents and processed trees\n\tconst snapshotTreeWithBlobContents: ISnapshotTreeWithBlobContents = {\n\t\t...baseSnapshot,\n\t\tblobsContents,\n\t\ttrees,\n\t};\n\n\treturn snapshotTreeWithBlobContents;\n};\n\nexport function isDeltaStreamConnectionForbiddenError(\n\terror: any,\n): error is DeltaStreamConnectionForbiddenError {\n\treturn (\n\t\ttypeof error === \"object\" &&\n\t\terror !== null &&\n\t\terror?.errorType === DriverErrorTypes.deltaStreamConnectionForbidden\n\t);\n}\n\n/**\n * Validates format in parsed string get from detached container\n * serialization using IPendingDetachedContainerState format.\n */\nfunction isPendingDetachedContainerState(\n\tdetachedContainerState: IPendingDetachedContainerState,\n): detachedContainerState is IPendingDetachedContainerState {\n\tif (\n\t\tdetachedContainerState?.attached === undefined ||\n\t\tdetachedContainerState?.baseSnapshot === undefined ||\n\t\tdetachedContainerState?.snapshotBlobs === undefined ||\n\t\tdetachedContainerState?.hasAttachmentBlobs === undefined\n\t) {\n\t\treturn false;\n\t}\n\treturn true;\n}\n\nexport function getDetachedContainerStateFromSerializedContainer(\n\tserializedContainer: string,\n): IPendingDetachedContainerState {\n\tconst hasBlobsSummaryTree = \".hasAttachmentBlobs\";\n\tconst parsedContainerState = JSON.parse(serializedContainer);\n\tif (isPendingDetachedContainerState(parsedContainerState)) {\n\t\treturn parsedContainerState;\n\t} else if (isCombinedAppAndProtocolSummary(parsedContainerState)) {\n\t\tconst { tree, blobs } =\n\t\t\tgetSnapshotTreeAndBlobsFromSerializedContainer(parsedContainerState);\n\t\tconst detachedContainerState: IPendingDetachedContainerState = {\n\t\t\tattached: false,\n\t\t\tbaseSnapshot: tree,\n\t\t\tsnapshotBlobs: blobs,\n\t\t\thasAttachmentBlobs: parsedContainerState.tree[hasBlobsSummaryTree] !== undefined,\n\t\t};\n\t\treturn detachedContainerState;\n\t} else {\n\t\tthrow new UsageError(\"Cannot rehydrate detached container. Incorrect format\");\n\t}\n}\n\n/**\n * Ensures only a single instance of the provided async function is running.\n * If there are multiple calls they will all get the same promise to wait on.\n */\nexport const runSingle = <A extends any[], R>(func: (...args: A) => Promise<R>) => {\n\tlet running:\n\t\t| {\n\t\t\t\targs: A;\n\t\t\t\tresult: Promise<R>;\n\t\t  }\n\t\t| undefined;\n\t// don't mark this function async, so we return the same promise,\n\t// rather than one that is wrapped due to async\n\t// eslint-disable-next-line @typescript-eslint/promise-function-async\n\treturn (...args: A) => {\n\t\tif (running !== undefined) {\n\t\t\tif (!compareArrays(running.args, args)) {\n\t\t\t\treturn Promise.reject(\n\t\t\t\t\tnew UsageError(\"Subsequent calls cannot use different arguments.\"),\n\t\t\t\t);\n\t\t\t}\n\t\t\treturn running.result;\n\t\t}\n\t\trunning = { args, result: func(...args).finally(() => (running = undefined)) };\n\t\treturn running.result;\n\t};\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-dev-rc.1.0.0.225277",
+  "version": "2.0.0-dev-rc.1.0.0.232845",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -19,7 +19,7 @@
       },
       "require": {
         "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
+        "default": "./dist/index.js"
       }
     },
     "./test/container": {
@@ -29,7 +29,7 @@
       },
       "require": {
         "types": "./dist/container.d.ts",
-        "default": "./dist/container.cjs"
+        "default": "./dist/container.js"
       }
     },
     "./test/contracts": {
@@ -39,7 +39,7 @@
       },
       "require": {
         "types": "./dist/contracts.d.ts",
-        "default": "./dist/contracts.cjs"
+        "default": "./dist/contracts.js"
       }
     },
     "./test/connectionManager": {
@@ -49,7 +49,7 @@
       },
       "require": {
         "types": "./dist/connectionManager.d.ts",
-        "default": "./dist/connectionManager.cjs"
+        "default": "./dist/connectionManager.js"
       }
     },
     "./test/deltaManager": {
@@ -59,7 +59,7 @@
       },
       "require": {
         "types": "./dist/deltaManager.d.ts",
-        "default": "./dist/deltaManager.cjs"
+        "default": "./dist/deltaManager.js"
       }
     },
     "./test/utils": {
@@ -69,7 +69,7 @@
       },
       "require": {
         "types": "./dist/utils.d.ts",
-        "default": "./dist/utils.cjs"
+        "default": "./dist/utils.js"
       }
     },
     "./alpha": {
@@ -79,7 +79,7 @@
       },
       "require": {
         "types": "./dist/container-loader-alpha.d.ts",
-        "default": "./dist/index.cjs"
+        "default": "./dist/index.js"
       }
     },
     "./beta": {
@@ -89,7 +89,7 @@
       },
       "require": {
         "types": "./dist/container-loader-beta.d.ts",
-        "default": "./dist/index.cjs"
+        "default": "./dist/index.js"
       }
     },
     "./internal": {
@@ -99,7 +99,7 @@
       },
       "require": {
         "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
+        "default": "./dist/index.js"
       }
     },
     "./public": {
@@ -109,11 +109,11 @@
       },
       "require": {
         "types": "./dist/container-loader-public.d.ts",
-        "default": "./dist/index.cjs"
+        "default": "./dist/index.js"
       }
     }
   },
-  "main": "dist/index.cjs",
+  "main": "dist/index.js",
   "module": "lib/index.mjs",
   "types": "dist/index.d.ts",
   "c8": {
@@ -137,15 +137,16 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/protocol-base": "^3.0.0-223236",
-    "@fluidframework/protocol-definitions": "^3.1.0-223007",
-    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/protocol-base": "^3.1.0-231702",
+    "@fluidframework/protocol-definitions": "^3.2.0-231454",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.232845",
+    "@ungap/structured-clone": "^1.2.0",
     "debug": "^4.3.4",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
@@ -154,20 +155,21 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-private/test-loader-utils": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluid-private/test-loader-utils": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluid-tools/build-cli": "^0.29.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/build-tools": "^0.29.0",
     "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.8.0.0",
-    "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.225277",
-    "@microsoft/api-extractor": "^7.38.3",
+    "@fluidframework/eslint-config-fluid": "^3.3.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.232845",
+    "@microsoft/api-extractor": "^7.39.1",
     "@types/debug": "^4.1.5",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "@types/sinon": "^7.0.13",
+    "@types/ungap__structured-clone": "^1.2.0",
     "c8": "^8.0.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -195,7 +197,11 @@
     }
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "InterfaceDeclaration_IContainerExperimental": {
+        "forwardCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
@@ -207,7 +213,7 @@
     "build:docs": "fluid-build . --task api",
     "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
     "build:genver": "gen-version",
-    "build:test": "tsc-multi --config ./tsc-multi.test.json",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
     "check:are-the-types-wrong": "attw --pack . --entrypoints .",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
@@ -223,7 +229,7 @@
     "test:coverage": "c8 npm test",
     "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc-multi --config ../../../common/build/build-common/tsc-multi.cjs.json",
+    "tsc": "tsc",
     "tsc:watch": "tsc --watch",
     "typetests:gen": "fluid-type-test-generator",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"

package/src/attachment.ts

@@ -0,0 +1,219 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AttachState } from "@fluidframework/container-definitions";
+import { CombinedAppAndProtocolSummary } from "@fluidframework/driver-utils";
+import { ISnapshotTree, ISummaryTree } from "@fluidframework/protocol-definitions";
+import { assert } from "@fluidframework/core-utils";
+import { IDocumentStorageService } from "@fluidframework/driver-definitions";
+import { getSnapshotTreeAndBlobsFromSerializedContainer } from "./utils";
+import { ISerializableBlobContents } from "./containerStorageAdapter";
+import { IDetachedBlobStorage } from ".";
+
+/**
+ * The default state a newly created detached container will have.
+ * All but the state are optional and undefined, they just exist
+ * to make the union easy to deal with for both Detached types
+ */
+export interface DetachedDefaultData {
+	readonly state: AttachState.Detached;
+	readonly blobs?: undefined;
+	readonly summary?: undefined;
+	readonly redirectTable?: undefined;
+}
+
+/**
+ * This always follows DetachedDefaultData when there are
+ * outstanding blobs in the detached blob storage.
+ * The redirect table will get filled up to include data
+ * about the blobs as they are uploaded.
+ */
+export interface DetachedDataWithOutstandingBlobs {
+	readonly state: AttachState.Detached;
+	readonly blobs: "outstanding";
+	readonly summary?: undefined;
+	readonly redirectTable: Map<string, string>;
+}
+
+/**
+ * This state always follows DetachedDataWithOutstandingBlobs.
+ * It signals that all outstanding blobs are done being uploaded,
+ * so the container can move to the attaching state.
+ */
+export interface AttachingDataWithBlobs {
+	readonly state: AttachState.Attaching;
+	readonly blobs: "done";
+	readonly summary: CombinedAppAndProtocolSummary;
+}
+
+/**
+ * This always follows DefaultDetachedState when there are
+ * no blobs in the detached blob storage. Because there are
+ * no blobs we can immediately get the summary and transition
+ * to the attaching state.
+ */
+export interface AttachingDataWithoutBlobs {
+	readonly state: AttachState.Attaching;
+	readonly summary: CombinedAppAndProtocolSummary;
+	readonly blobs: "none";
+}
+
+/**
+ * The final attachment state which signals the container is fully attached.
+ * The baseSnapshotAndBlobs will only be enabled when offline load is enabled.
+ */
+export interface AttachedData {
+	readonly state: AttachState.Attached;
+	readonly snapshot?: {
+		tree: ISnapshotTree;
+		blobs: ISerializableBlobContents;
+	};
+}
+
+/**
+ * A union of all the attachment data types for
+ * tracking across all container attachment states
+ */
+export type AttachmentData =
+	| DetachedDefaultData
+	| DetachedDataWithOutstandingBlobs
+	| AttachingDataWithoutBlobs
+	| AttachingDataWithBlobs
+	| AttachedData;
+
+/**
+ * The data and services necessary for runRetriableAttachProcess.
+ */
+export interface AttachProcessProps {
+	/**
+	 * The initial attachment data this call should start with
+	 */
+	readonly initialAttachmentData: Exclude<AttachmentData, AttachedData>;
+
+	/**
+	 * The caller should use this callback to keep track of the current
+	 * attachment data, and perform any other operations necessary
+	 * for dealing with attachment state changes, like emitting events
+	 *
+	 * @param attachmentData - the updated attachment data	 */
+	readonly setAttachmentData: (attachmentData: AttachmentData) => void;
+
+	/**
+	 * The caller should create and or get services based on the data, and its own information.
+	 * @param data - the data to create services from,
+	 * the summary property being the most relevant part of the data.
+	 * @returns A compatible storage service
+	 */
+	readonly createOrGetStorageService: (
+		data: ISummaryTree | undefined,
+	) => Promise<Pick<IDocumentStorageService, "createBlob" | "uploadSummaryWithContext">>;
+
+	/**
+	 * The detached blob storage if it exists.
+	 */
+	readonly detachedBlobStorage?: Pick<IDetachedBlobStorage, "getBlobIds" | "readBlob" | "size">;
+
+	/**
+	 * The caller should create the attachment summary for the container.
+	 * @param redirectTable - Maps local blob ids to remote blobs ids.
+	 * @returns The attachment summary for the container.
+	 */
+	readonly createAttachmentSummary: (
+		redirectTable?: Map<string, string>,
+	) => CombinedAppAndProtocolSummary;
+
+	/**
+	 * Whether offline load is enabled or not.
+	 */
+	readonly offlineLoadEnabled: boolean;
+}
+
+/**
+ * Executes the attach process state machine based on the provided data and services.
+ * This method is retriable on failure. Based on the provided initialAttachmentData
+ * this method will resume the attachment process and attempt to complete it.
+ *
+ * @param props - The data and services necessary to run the attachment process
+ */
+export const runRetriableAttachProcess = async (props: AttachProcessProps): Promise<void> => {
+	const {
+		detachedBlobStorage,
+		createOrGetStorageService,
+		setAttachmentData,
+		createAttachmentSummary,
+		offlineLoadEnabled,
+	} = props;
+	let currentData: AttachmentData = props.initialAttachmentData;
+
+	if (currentData.blobs === undefined) {
+		// If attachment blobs were uploaded in detached state we will go through a different attach flow
+		const outstandingAttachmentBlobs =
+			detachedBlobStorage !== undefined && detachedBlobStorage.size > 0;
+		// Determine the next phase of attaching which depends on if there are attachment blobs
+		// if there are, we will stay detached, so an empty file can be created, and the blobs
+		// uploaded, otherwise we will get the summary to create the file with and move to attaching
+		currentData = outstandingAttachmentBlobs
+			? {
+					state: AttachState.Detached,
+					blobs: "outstanding",
+					redirectTable: new Map<string, string>(),
+			  }
+			: {
+					state: AttachState.Attaching,
+					summary: props.createAttachmentSummary(),
+					blobs: "none",
+			  };
+		setAttachmentData(currentData);
+	}
+
+	// this has to run here, as it is what creates the file
+	// and we need to file for all possible cases after this point
+	const storage = await createOrGetStorageService(currentData.summary);
+
+	if (currentData.blobs === "outstanding") {
+		const { redirectTable } = currentData;
+		// upload blobs to storage
+		assert(!!detachedBlobStorage, 0x24e /* "assertion for type narrowing" */);
+
+		// build a table mapping IDs assigned locally to IDs assigned by storage and pass it to runtime to
+		// support blob handles that only know about the local IDs
+		while (redirectTable.size < detachedBlobStorage.size) {
+			const newIds = detachedBlobStorage.getBlobIds().filter((id) => !redirectTable.has(id));
+			for (const id of newIds) {
+				const blob = await detachedBlobStorage.readBlob(id);
+				const response = await storage.createBlob(blob);
+				redirectTable.set(id, response.id);
+			}
+		}
+		setAttachmentData(
+			(currentData = {
+				state: AttachState.Attaching,
+				summary: createAttachmentSummary(redirectTable),
+				blobs: "done",
+			}),
+		);
+	}
+
+	assert(currentData.state === AttachState.Attaching, "must be attaching by this point");
+
+	if (currentData.blobs === "done") {
+		// done means outstanding blobs were uploaded.
+		// in that case an empty file was created, the blobs were uploaded
+		// and now this finally uploads the summary
+		await storage.uploadSummaryWithContext(currentData.summary, {
+			referenceSequenceNumber: 0,
+			ackHandle: undefined,
+			proposalHandle: undefined,
+		});
+	}
+
+	setAttachmentData(
+		(currentData = {
+			state: AttachState.Attached,
+			snapshot: offlineLoadEnabled
+				? getSnapshotTreeAndBlobsFromSerializedContainer(currentData.summary)
+				: undefined,
+		}),
+	);
+};