@fluidframework/odsp-driver 2.0.0-dev.1.4.5.105745 → 2.0.0-dev.2.2.0.111723

package/.eslintrc.js

@@ -5,7 +5,7 @@
 
 module.exports = {
     "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
+        require.resolve("@fluidframework/eslint-config-fluid"), "prettier"
     ],
     "parserOptions": {
         "project": ["./tsconfig.json", "./src/test/tsconfig.json"]

package/dist/compactSnapshotParser.d.ts

@@ -6,10 +6,17 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { ISnapshotContents } from "./odspPublicUtils";
 export declare const snapshotMinReadVersion = "1.0";
 export declare const currentReadVersion = "1.0";
+/**
+ * The parsing is significantly faster if the position of props is well known instead of dynamic. So these variables
+ * represents how many times slower parsing path is executed. This will be then logged into telemetry.
+ */
+export interface ISnapshotContentsWithProps extends ISnapshotContents {
+    telemetryProps: Record<string, number>;
+}
 /**
  * Converts snapshot from binary compact representation to tree/blobs/ops.
  * @param buffer - Compact snapshot to be parsed into tree/blobs/ops.
  * @returns - tree, blobs and ops from the snapshot.
  */
-export declare function parseCompactSnapshotResponse(buffer: Uint8Array, logger: ITelemetryLogger): ISnapshotContents;
+export declare function parseCompactSnapshotResponse(buffer: Uint8Array, logger: ITelemetryLogger): ISnapshotContentsWithProps;
 //# sourceMappingURL=compactSnapshotParser.d.ts.map

package/dist/compactSnapshotParser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compactSnapshotParser.d.ts","sourceRoot":"","sources":["../src/compactSnapshotParser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AActD,eAAO,MAAM,sBAAsB,QAAQ,CAAC;AAC5C,eAAO,MAAM,kBAAkB,QAAQ,CAAC;AAgKxC;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,CA0B5G"}
+{"version":3,"file":"compactSnapshotParser.d.ts","sourceRoot":"","sources":["../src/compactSnapshotParser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAetD,eAAO,MAAM,sBAAsB,QAAQ,CAAC;AAC5C,eAAO,MAAM,kBAAkB,QAAQ,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACjE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAsKD;;;;GAIG;AACH,wBAAgB,4BAA4B,CACxC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,gBAAgB,GACzB,0BAA0B,CAoC5B"}

package/dist/compactSnapshotParser.js

@@ -8,6 +8,7 @@ exports.parseCompactSnapshotResponse = exports.currentReadVersion = exports.snap
 const common_utils_1 = require("@fluidframework/common-utils");
 const ReadBufferUtils_1 = require("./ReadBufferUtils");
 const zipItDataRepresentationUtils_1 = require("./zipItDataRepresentationUtils");
+const odspUtils_1 = require("./odspUtils");
 exports.snapshotMinReadVersion = "1.0";
 exports.currentReadVersion = "1.0";
 /**
@@ -16,6 +17,7 @@ exports.currentReadVersion = "1.0";
  */
 function readBlobSection(node) {
     (0, zipItDataRepresentationUtils_1.assertNodeCoreInstance)(node, "TreeBlobs should be of type NodeCore");
+    let slowBlobStructureCount = 0;
     const blobs = new Map();
     for (const blob of node) {
         (0, zipItDataRepresentationUtils_1.assertNodeCoreInstance)(blob, "blob should be node");
@@ -33,12 +35,13 @@ function readBlobSection(node) {
         /**
          * More generalized workflow
          */
+        slowBlobStructureCount += 1;
         const records = (0, zipItDataRepresentationUtils_1.getNodeProps)(blob);
         (0, zipItDataRepresentationUtils_1.assertBlobCoreInstance)(records.data, "data should be of BlobCore type");
         const id = (0, zipItDataRepresentationUtils_1.getStringInstance)(records.id, "blob id should be string");
         blobs.set(id, records.data.arrayBuffer);
     }
-    return blobs;
+    return { blobs, slowBlobStructureCount };
 }
 /**
  * Recreates ops section of the tree.
@@ -61,6 +64,7 @@ function readOpsSection(node) {
  * @param node - tree node to de-serialize from
  */
 function readTreeSection(node) {
+    let slowTreeStructureCount = 0;
     const trees = {};
     const snapshotTree = {
         blobs: {},
@@ -80,7 +84,9 @@ function readTreeSection(node) {
                 // "name": <node name>
                 // "children": <blob id>
                 if (content === "children") {
-                    trees[treeNode.getString(1)] = readTreeSection(treeNode.getNode(3));
+                    const result = readTreeSection(treeNode.getNode(3));
+                    trees[treeNode.getString(1)] = result.snapshotTree;
+                    slowTreeStructureCount += result.slowTreeStructureCount;
                     continue;
                 }
                 // "name": <node name>
@@ -105,7 +111,9 @@ function readTreeSection(node) {
             if (length === 6 &&
                 treeNode.getMaybeString(2) === "unreferenced" &&
                 treeNode.getMaybeString(4) === "children") {
-                trees[treeNode.getString(1)] = readTreeSection(treeNode.getNode(5));
+                const result = readTreeSection(treeNode.getNode(5));
+                trees[treeNode.getString(1)] = result.snapshotTree;
+                slowTreeStructureCount += result.slowTreeStructureCount;
                 (0, common_utils_1.assert)(treeNode.getBool(3), 0x3db /* Unreferenced if present should be true */);
                 snapshotTree.unreferenced = true;
                 continue;
@@ -114,6 +122,7 @@ function readTreeSection(node) {
         /**
          * More generalized workflow
          */
+        slowTreeStructureCount += 1;
         const records = (0, zipItDataRepresentationUtils_1.getNodeProps)(treeNode);
         if (records.unreferenced !== undefined) {
             (0, zipItDataRepresentationUtils_1.assertBoolInstance)(records.unreferenced, "Unreferenced flag should be bool");
@@ -126,13 +135,15 @@ function readTreeSection(node) {
         }
         else if (records.children !== undefined) {
             (0, zipItDataRepresentationUtils_1.assertNodeCoreInstance)(records.children, "Trees should be of type NodeCore");
-            trees[path] = readTreeSection(records.children);
+            const result = readTreeSection(records.children);
+            trees[path] = result.snapshotTree;
+            slowTreeStructureCount += result.slowTreeStructureCount;
         }
         else {
             trees[path] = { blobs: {}, trees: {} };
         }
     }
-    return snapshotTree;
+    return { snapshotTree, slowTreeStructureCount };
 }
 /**
  * Recreates snapshot tree out of tree representation.
@@ -143,12 +154,13 @@ function readSnapshotSection(node) {
     const records = (0, zipItDataRepresentationUtils_1.getNodeProps)(node);
     (0, zipItDataRepresentationUtils_1.assertNodeCoreInstance)(records.treeNodes, "TreeNodes should be of type NodeCore");
     (0, zipItDataRepresentationUtils_1.assertNumberInstance)(records.sequenceNumber, "sequenceNumber should be of type number");
-    const snapshotTree = readTreeSection(records.treeNodes);
+    const { snapshotTree, slowTreeStructureCount } = readTreeSection(records.treeNodes);
     snapshotTree.id = (0, zipItDataRepresentationUtils_1.getStringInstance)(records.id, "snapshotId should be string");
     const sequenceNumber = records.sequenceNumber.valueOf();
     return {
         sequenceNumber,
         snapshotTree,
+        slowTreeStructureCount,
     };
 }
 /**
@@ -157,7 +169,7 @@ function readSnapshotSection(node) {
  * @returns - tree, blobs and ops from the snapshot.
  */
 function parseCompactSnapshotResponse(buffer, logger) {
-    const builder = zipItDataRepresentationUtils_1.TreeBuilder.load(new ReadBufferUtils_1.ReadBuffer(buffer), logger);
+    const { builder, telemetryProps } = zipItDataRepresentationUtils_1.TreeBuilder.load(new ReadBufferUtils_1.ReadBuffer(buffer), logger);
     (0, common_utils_1.assert)(builder.length === 1, 0x219 /* "1 root should be there" */);
     const root = builder.getNode(0);
     const records = (0, zipItDataRepresentationUtils_1.getNodeProps)(root);
@@ -169,7 +181,10 @@ function parseCompactSnapshotResponse(buffer, logger) {
     (0, common_utils_1.assert)(parseFloat(exports.snapshotMinReadVersion) >= parseFloat(mrv), 0x20f /* "Driver min read version should >= to server minReadVersion" */);
     (0, common_utils_1.assert)(parseFloat(cv) >= parseFloat(exports.snapshotMinReadVersion), 0x210 /* "Snapshot should be created with minReadVersion or above" */);
     (0, common_utils_1.assert)(exports.currentReadVersion === cv, 0x2c2 /* "Create Version should be equal to currentReadVersion" */);
-    return Object.assign(Object.assign({}, readSnapshotSection(records.snapshot)), { blobs: readBlobSection(records.blobs), ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [], latestSequenceNumber: records.lsn });
+    const [snapshot, durationSnapshotTree] = (0, odspUtils_1.measure)(() => readSnapshotSection(records.snapshot));
+    const [blobs, durationBlobs] = (0, odspUtils_1.measure)(() => readBlobSection(records.blobs));
+    return Object.assign(Object.assign(Object.assign({}, snapshot), blobs), { ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [], latestSequenceNumber: records.lsn, telemetryProps: Object.assign(Object.assign({}, telemetryProps), { durationSnapshotTree,
+            durationBlobs, slowTreeStructureCount: snapshot.slowTreeStructureCount, slowBlobStructureCount: blobs.slowBlobStructureCount }) });
 }
 exports.parseCompactSnapshotResponse = parseCompactSnapshotResponse;
 //# sourceMappingURL=compactSnapshotParser.js.map

package/dist/compactSnapshotParser.js.map

@@ -1 +1 @@
-{"version":3,"file":"compactSnapshotParser.js","sourceRoot":"","sources":["../src/compactSnapshotParser.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAItD,uDAA+C;AAC/C,iFAUwC;AAE3B,QAAA,sBAAsB,GAAG,KAAK,CAAC;AAC/B,QAAA,kBAAkB,GAAG,KAAK,CAAC;AAOxC;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAe;IACpC,IAAA,qDAAsB,EAAC,IAAI,EAAE,sCAAsC,CAAC,CAAC;IACrE,MAAM,KAAK,GAA6B,IAAI,GAAG,EAAE,CAAC;IAClD,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;QACrB,IAAA,qDAAsB,EAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;QAEpD;;;;WAIG;QACH,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;YAC3F,oBAAoB;YACpB,iBAAiB;YACjB,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;YAC1D,SAAS;SACZ;QAED;;WAEG;QACH,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;QACnC,IAAA,qDAAsB,EAAC,OAAO,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;QACxE,MAAM,EAAE,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,EAAE,EAAE,0BAA0B,CAAC,CAAC;QACrE,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KAC3C;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,IAAe;IACnC,IAAA,qDAAsB,EAAC,IAAI,EAAE,mCAAmC,CAAC,CAAC;IAClE,MAAM,GAAG,GAAgC,EAAE,CAAC;IAC5C,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;IACnC,IAAA,mDAAoB,EAAC,OAAO,CAAC,mBAAmB,EAAE,+BAA+B,CAAC,CAAC;IACnF,IAAA,qDAAsB,EAAC,OAAO,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;IAClE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QAC5C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KACrD;IACD,IAAA,qBAAM,EAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAClE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAChD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAc;IACnC,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,MAAM,YAAY,GAAkB;QAChC,KAAK,EAAE,EAAE;QACT,KAAK;KACR,CAAC;IACF,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE;QACzB,IAAA,qDAAsB,EAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAC;QAE/D;;;;WAIG;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC/B,IAAI,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;YACtD,IAAI,MAAM,KAAK,CAAC,EAAE;gBACd,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBAC3C,sBAAsB;gBACtB,wBAAwB;gBACxB,IAAI,OAAO,KAAK,UAAU,EAAE;oBACxB,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;oBACpE,SAAS;iBACZ;gBACD,sBAAsB;gBACtB,qBAAqB;gBACrB,IAAI,OAAO,KAAK,OAAO,EAAE;oBACrB,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBAClE,SAAS;iBACZ;aACJ;YAED,sBAAsB;YACtB,gBAAgB;YAChB,qBAAqB;YACrB,IAAI,MAAM,KAAK,CAAC;gBACR,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,UAAU;gBACzC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE;gBAC5C,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAClE,SAAS;aACZ;YAED,sBAAsB;YACtB,uBAAuB;YACvB,wBAAwB;YACxB,IAAI,MAAM,KAAK,CAAC;gBACR,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,cAAc;gBAC7C,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;gBAC/C,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,IAAA,qBAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBAChF,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;gBACjC,SAAS;aACZ;SACJ;QAED;;WAEG;QACH,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;YACpC,IAAA,iDAAkB,EAAC,OAAO,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC;YAC7E,IAAA,qBAAM,EAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YACnF,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;SACpC;QAED,MAAM,IAAI,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;QAC3E,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;YAC7B,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;SAC9F;aAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE;YACvC,IAAA,qDAAsB,EAAC,OAAO,CAAC,QAAQ,EAAE,kCAAkC,CAAC,CAAC;YAC7E,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SACnD;aAAM;YACH,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;SAC1C;KACJ;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,IAAe;IACxC,IAAA,qDAAsB,EAAC,IAAI,EAAE,qCAAqC,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;IAEnC,IAAA,qDAAsB,EAAC,OAAO,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;IAClF,IAAA,mDAAoB,EAAC,OAAO,CAAC,cAAc,EAAE,yCAAyC,CAAC,CAAC;IACxF,MAAM,YAAY,GAAkB,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvE,YAAY,CAAC,EAAE,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,EAAE,EAAE,6BAA6B,CAAC,CAAC;IAC/E,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;IACxD,OAAO;QACH,cAAc;QACd,YAAY;KACf,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAgB,4BAA4B,CAAC,MAAkB,EAAE,MAAwB;IACrF,MAAM,OAAO,GAAG,0CAAW,CAAC,IAAI,CAAC,IAAI,4BAAU,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IACjE,IAAA,qBAAM,EAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhC,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,GAAG,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,GAAG,EAAE,iCAAiC,CAAC,CAAC;IAC9E,MAAM,EAAE,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,EAAE,EAAE,gCAAgC,CAAC,CAAC;IAC3E,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS,EAAE;QAC3B,IAAA,mDAAoB,EAAC,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC;KAC/D;IAED,IAAA,qBAAM,EAAC,UAAU,CAAC,8BAAsB,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,EACxD,KAAK,CAAC,kEAAkE,CAAC,CAAC;IAC9E,IAAA,qBAAM,EAAC,UAAU,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,8BAAsB,CAAC,EACvD,KAAK,CAAC,+DAA+D,CAAC,CAAC;IAC3E,IAAA,qBAAM,EAAC,0BAAkB,KAAK,EAAE,EAC5B,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAExE,uCACO,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,KACxC,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,EACrC,GAAG,EAAE,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,EACvE,oBAAoB,EAAE,OAAO,CAAC,GAAG,IACnC;AACN,CAAC;AA1BD,oEA0BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\nimport { ReadBuffer } from \"./ReadBufferUtils\";\nimport {\n    assertBlobCoreInstance,\n    getStringInstance,\n    assertBoolInstance,\n    assertNodeCoreInstance,\n    assertNumberInstance,\n    getNodeProps,\n    NodeCore,\n    NodeTypes,\n    TreeBuilder,\n} from \"./zipItDataRepresentationUtils\";\n\nexport const snapshotMinReadVersion = \"1.0\";\nexport const currentReadVersion = \"1.0\";\n\ninterface ISnapshotSection {\n    snapshotTree: ISnapshotTree;\n    sequenceNumber: number;\n}\n\n/**\n * Recreates blobs section of the tree.\n * @param node - tree node to read blob section from\n */\nfunction readBlobSection(node: NodeTypes) {\n    assertNodeCoreInstance(node, \"TreeBlobs should be of type NodeCore\");\n    const blobs: Map<string, ArrayBuffer> = new Map();\n    for (const blob of node) {\n        assertNodeCoreInstance(blob, \"blob should be node\");\n\n        /**\n         * Perf optimization - the most common cases!\n         * This is essentially unrolling code below for faster processing\n         * It speeds up tree parsing by 2-3x times!\n         */\n        if (blob.length === 4 && blob.getMaybeString(0) === \"id\" && blob.getMaybeString(2) === \"data\") {\n            // \"id\": <node name>\n            // \"data\": <blob>\n            blobs.set(blob.getString(1), blob.getBlob(3).arrayBuffer);\n            continue;\n        }\n\n        /**\n         * More generalized workflow\n         */\n        const records = getNodeProps(blob);\n        assertBlobCoreInstance(records.data, \"data should be of BlobCore type\");\n        const id = getStringInstance(records.id, \"blob id should be string\");\n        blobs.set(id, records.data.arrayBuffer);\n    }\n    return blobs;\n}\n\n/**\n * Recreates ops section of the tree.\n * @param node - tree node to read ops section from\n */\nfunction readOpsSection(node: NodeTypes) {\n    assertNodeCoreInstance(node, \"Deltas should be of type NodeCore\");\n    const ops: ISequencedDocumentMessage[] = [];\n    const records = getNodeProps(node);\n    assertNumberInstance(records.firstSequenceNumber, \"Seq number should be a number\");\n    assertNodeCoreInstance(records.deltas, \"Deltas should be a Node\");\n    for (let i = 0; i < records.deltas.length; ++i) {\n        ops.push(JSON.parse(records.deltas.getString(i)));\n    }\n    assert(records.firstSequenceNumber.valueOf() === ops[0].sequenceNumber,\n        0x280 /* \"Validate first op seq number\" */);\n    return ops;\n}\n\n/**\n * Recreates snapshot tree out of tree representation.\n * @param node - tree node to de-serialize from\n */\nfunction readTreeSection(node: NodeCore) {\n    const trees = {};\n    const snapshotTree: ISnapshotTree = {\n        blobs: {},\n        trees,\n    };\n    for (const treeNode of node) {\n        assertNodeCoreInstance(treeNode, \"tree nodes should be nodes\");\n\n        /**\n         * Perf optimization - the most common cases!\n         * This is essentially unrolling code below for faster processing\n         * It speeds up tree parsing by 2-3x times!\n         */\n         const length = treeNode.length;\n         if (length > 0 && treeNode.getMaybeString(0) === \"name\") {\n            if (length === 4) {\n                const content = treeNode.getMaybeString(2);\n                // \"name\": <node name>\n                // \"children\": <blob id>\n                if (content === \"children\") {\n                    trees[treeNode.getString(1)] = readTreeSection(treeNode.getNode(3));\n                    continue;\n                }\n                // \"name\": <node name>\n                // \"value\": <blob id>\n                if (content === \"value\") {\n                    snapshotTree.blobs[treeNode.getString(1)] = treeNode.getString(3);\n                    continue;\n                }\n            }\n\n            // \"name\": <node name>\n            // \"nodeType\": 3\n            // \"value\": <blob id>\n            if (length === 6 &&\n                    treeNode.getMaybeString(2) === \"nodeType\" &&\n                    treeNode.getMaybeString(4) === \"value\") {\n                snapshotTree.blobs[treeNode.getString(1)] = treeNode.getString(5);\n                continue;\n            }\n\n            // \"name\": <node name>\n            // \"unreferenced\": true\n            // \"children\": <blob id>\n            if (length === 6 &&\n                    treeNode.getMaybeString(2) === \"unreferenced\" &&\n                    treeNode.getMaybeString(4) === \"children\") {\n                trees[treeNode.getString(1)] = readTreeSection(treeNode.getNode(5));\n                assert(treeNode.getBool(3), 0x3db /* Unreferenced if present should be true */);\n                snapshotTree.unreferenced = true;\n                continue;\n            }\n        }\n\n        /**\n         * More generalized workflow\n         */\n        const records = getNodeProps(treeNode);\n\n        if (records.unreferenced !== undefined) {\n            assertBoolInstance(records.unreferenced, \"Unreferenced flag should be bool\");\n            assert(records.unreferenced, 0x281 /* \"Unreferenced if present should be true\" */);\n            snapshotTree.unreferenced = true;\n        }\n\n        const path = getStringInstance(records.name, \"Path name should be string\");\n        if (records.value !== undefined) {\n            snapshotTree.blobs[path] = getStringInstance(records.value, \"Blob value should be string\");\n        } else if (records.children !== undefined) {\n            assertNodeCoreInstance(records.children, \"Trees should be of type NodeCore\");\n            trees[path] = readTreeSection(records.children);\n        } else {\n            trees[path] = { blobs: {}, trees: {} };\n        }\n    }\n    return snapshotTree;\n}\n\n/**\n * Recreates snapshot tree out of tree representation.\n * @param node - tree node to de-serialize from\n */\nfunction readSnapshotSection(node: NodeTypes): ISnapshotSection {\n    assertNodeCoreInstance(node, \"Snapshot should be of type NodeCore\");\n    const records = getNodeProps(node);\n\n    assertNodeCoreInstance(records.treeNodes, \"TreeNodes should be of type NodeCore\");\n    assertNumberInstance(records.sequenceNumber, \"sequenceNumber should be of type number\");\n    const snapshotTree: ISnapshotTree = readTreeSection(records.treeNodes);\n    snapshotTree.id = getStringInstance(records.id, \"snapshotId should be string\");\n    const sequenceNumber = records.sequenceNumber.valueOf();\n    return {\n        sequenceNumber,\n        snapshotTree,\n    };\n}\n\n/**\n * Converts snapshot from binary compact representation to tree/blobs/ops.\n * @param buffer - Compact snapshot to be parsed into tree/blobs/ops.\n * @returns - tree, blobs and ops from the snapshot.\n */\nexport function parseCompactSnapshotResponse(buffer: Uint8Array, logger: ITelemetryLogger): ISnapshotContents {\n    const builder = TreeBuilder.load(new ReadBuffer(buffer), logger);\n    assert(builder.length === 1, 0x219 /* \"1 root should be there\" */);\n    const root = builder.getNode(0);\n\n    const records = getNodeProps(root);\n\n    const mrv = getStringInstance(records.mrv, \"minReadVersion should be string\");\n    const cv = getStringInstance(records.cv, \"createVersion should be string\");\n    if (records.lsn !== undefined) {\n        assertNumberInstance(records.lsn, \"lsn should be a number\");\n    }\n\n    assert(parseFloat(snapshotMinReadVersion) >= parseFloat(mrv),\n        0x20f /* \"Driver min read version should >= to server minReadVersion\" */);\n    assert(parseFloat(cv) >= parseFloat(snapshotMinReadVersion),\n        0x210 /* \"Snapshot should be created with minReadVersion or above\" */);\n    assert(currentReadVersion === cv,\n        0x2c2 /* \"Create Version should be equal to currentReadVersion\" */);\n\n    return {\n        ...readSnapshotSection(records.snapshot),\n        blobs: readBlobSection(records.blobs),\n        ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [],\n        latestSequenceNumber: records.lsn,\n    };\n}\n"]}
+{"version":3,"file":"compactSnapshotParser.js","sourceRoot":"","sources":["../src/compactSnapshotParser.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAItD,uDAA+C;AAC/C,iFAUwC;AACxC,2CAAsC;AAEzB,QAAA,sBAAsB,GAAG,KAAK,CAAC;AAC/B,QAAA,kBAAkB,GAAG,KAAK,CAAC;AAUxC;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAe;IACpC,IAAA,qDAAsB,EAAC,IAAI,EAAE,sCAAsC,CAAC,CAAC;IACrE,IAAI,sBAAsB,GAAG,CAAC,CAAC;IAC/B,MAAM,KAAK,GAA6B,IAAI,GAAG,EAAE,CAAC;IAClD,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;QACrB,IAAA,qDAAsB,EAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;QAEpD;;;;WAIG;QACH,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;YAC3F,oBAAoB;YACpB,iBAAiB;YACjB,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;YAC1D,SAAS;SACZ;QAED;;WAEG;QACH,sBAAsB,IAAI,CAAC,CAAC;QAC5B,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;QACnC,IAAA,qDAAsB,EAAC,OAAO,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;QACxE,MAAM,EAAE,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,EAAE,EAAE,0BAA0B,CAAC,CAAC;QACrE,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KAC3C;IACD,OAAO,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,IAAe;IACnC,IAAA,qDAAsB,EAAC,IAAI,EAAE,mCAAmC,CAAC,CAAC;IAClE,MAAM,GAAG,GAAgC,EAAE,CAAC;IAC5C,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;IACnC,IAAA,mDAAoB,EAAC,OAAO,CAAC,mBAAmB,EAAE,+BAA+B,CAAC,CAAC;IACnF,IAAA,qDAAsB,EAAC,OAAO,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;IAClE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QAC5C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KACrD;IACD,IAAA,qBAAM,EAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAClE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAChD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAc;IACnC,IAAI,sBAAsB,GAAG,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,MAAM,YAAY,GAAkB;QAChC,KAAK,EAAE,EAAE;QACT,KAAK;KACR,CAAC;IACF,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE;QACzB,IAAA,qDAAsB,EAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAC;QAE/D;;;;WAIG;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC/B,IAAI,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;YACtD,IAAI,MAAM,KAAK,CAAC,EAAE;gBACd,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBAC3C,sBAAsB;gBACtB,wBAAwB;gBACxB,IAAI,OAAO,KAAK,UAAU,EAAE;oBACxB,MAAM,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;oBACpD,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC;oBACnD,sBAAsB,IAAI,MAAM,CAAC,sBAAsB,CAAC;oBACxD,SAAS;iBACZ;gBACD,sBAAsB;gBACtB,qBAAqB;gBACrB,IAAI,OAAO,KAAK,OAAO,EAAE;oBACrB,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBAClE,SAAS;iBACZ;aACJ;YAED,sBAAsB;YACtB,gBAAgB;YAChB,qBAAqB;YACrB,IAAI,MAAM,KAAK,CAAC;gBACR,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,UAAU;gBACzC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE;gBAC5C,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAClE,SAAS;aACZ;YAED,sBAAsB;YACtB,uBAAuB;YACvB,wBAAwB;YACxB,IAAI,MAAM,KAAK,CAAC;gBACR,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,cAAc;gBAC7C,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;gBAC/C,MAAM,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpD,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC;gBACnD,sBAAsB,IAAI,MAAM,CAAC,sBAAsB,CAAC;gBACxD,IAAA,qBAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBAChF,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;gBACjC,SAAS;aACZ;SACJ;QAED;;WAEG;QACH,sBAAsB,IAAI,CAAC,CAAC;QAC5B,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;YACpC,IAAA,iDAAkB,EAAC,OAAO,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC;YAC7E,IAAA,qBAAM,EAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YACnF,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;SACpC;QAED,MAAM,IAAI,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;QAC3E,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;YAC7B,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC;SAC9F;aAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE;YACvC,IAAA,qDAAsB,EAAC,OAAO,CAAC,QAAQ,EAAE,kCAAkC,CAAC,CAAC;YAC7E,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACjD,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC;YAClC,sBAAsB,IAAI,MAAM,CAAC,sBAAsB,CAAC;SAC3D;aAAM;YACH,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;SAC1C;KACJ;IACD,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,IAAe;IACxC,IAAA,qDAAsB,EAAC,IAAI,EAAE,qCAAqC,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;IAEnC,IAAA,qDAAsB,EAAC,OAAO,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;IAClF,IAAA,mDAAoB,EAAC,OAAO,CAAC,cAAc,EAAE,yCAAyC,CAAC,CAAC;IACxF,MAAM,EAAE,YAAY,EAAE,sBAAsB,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACpF,YAAY,CAAC,EAAE,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,EAAE,EAAE,6BAA6B,CAAC,CAAC;IAC/E,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;IACxD,OAAO;QACH,cAAc;QACd,YAAY;QACZ,sBAAsB;KACzB,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAgB,4BAA4B,CACxC,MAAkB,EAClB,MAAwB;IAExB,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,0CAAW,CAAC,IAAI,CAAC,IAAI,4BAAU,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IACrF,IAAA,qBAAM,EAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhC,MAAM,OAAO,GAAG,IAAA,2CAAY,EAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,GAAG,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,GAAG,EAAE,iCAAiC,CAAC,CAAC;IAC9E,MAAM,EAAE,GAAG,IAAA,gDAAiB,EAAC,OAAO,CAAC,EAAE,EAAE,gCAAgC,CAAC,CAAC;IAC3E,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS,EAAE;QAC3B,IAAA,mDAAoB,EAAC,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC;KAC/D;IAED,IAAA,qBAAM,EAAC,UAAU,CAAC,8BAAsB,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,EACxD,KAAK,CAAC,kEAAkE,CAAC,CAAC;IAC9E,IAAA,qBAAM,EAAC,UAAU,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,8BAAsB,CAAC,EACvD,KAAK,CAAC,+DAA+D,CAAC,CAAC;IAC3E,IAAA,qBAAM,EAAC,0BAAkB,KAAK,EAAE,EAC5B,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAExE,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC,GAAG,IAAA,mBAAO,EAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9F,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,IAAA,mBAAO,EAAC,GAAG,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAE7E,qDACO,QAAQ,GACR,KAAK,KACR,GAAG,EAAE,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,EACvE,oBAAoB,EAAE,OAAO,CAAC,GAAG,EACjC,cAAc,kCACP,cAAc,KACjB,oBAAoB;YACpB,aAAa,EACb,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,EACvD,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,OAE1D;AACN,CAAC;AAvCD,oEAuCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\nimport { ReadBuffer } from \"./ReadBufferUtils\";\nimport {\n    assertBlobCoreInstance,\n    getStringInstance,\n    assertBoolInstance,\n    assertNodeCoreInstance,\n    assertNumberInstance,\n    getNodeProps,\n    NodeCore,\n    NodeTypes,\n    TreeBuilder,\n} from \"./zipItDataRepresentationUtils\";\nimport { measure } from \"./odspUtils\";\n\nexport const snapshotMinReadVersion = \"1.0\";\nexport const currentReadVersion = \"1.0\";\n\n/**\n * The parsing is significantly faster if the position of props is well known instead of dynamic. So these variables\n * represents how many times slower parsing path is executed. This will be then logged into telemetry.\n */\nexport interface ISnapshotContentsWithProps extends ISnapshotContents {\n    telemetryProps: Record<string, number>;\n}\n\n/**\n * Recreates blobs section of the tree.\n * @param node - tree node to read blob section from\n */\nfunction readBlobSection(node: NodeTypes) {\n    assertNodeCoreInstance(node, \"TreeBlobs should be of type NodeCore\");\n    let slowBlobStructureCount = 0;\n    const blobs: Map<string, ArrayBuffer> = new Map();\n    for (const blob of node) {\n        assertNodeCoreInstance(blob, \"blob should be node\");\n\n        /**\n         * Perf optimization - the most common cases!\n         * This is essentially unrolling code below for faster processing\n         * It speeds up tree parsing by 2-3x times!\n         */\n        if (blob.length === 4 && blob.getMaybeString(0) === \"id\" && blob.getMaybeString(2) === \"data\") {\n            // \"id\": <node name>\n            // \"data\": <blob>\n            blobs.set(blob.getString(1), blob.getBlob(3).arrayBuffer);\n            continue;\n        }\n\n        /**\n         * More generalized workflow\n         */\n        slowBlobStructureCount += 1;\n        const records = getNodeProps(blob);\n        assertBlobCoreInstance(records.data, \"data should be of BlobCore type\");\n        const id = getStringInstance(records.id, \"blob id should be string\");\n        blobs.set(id, records.data.arrayBuffer);\n    }\n    return { blobs, slowBlobStructureCount };\n}\n\n/**\n * Recreates ops section of the tree.\n * @param node - tree node to read ops section from\n */\nfunction readOpsSection(node: NodeTypes) {\n    assertNodeCoreInstance(node, \"Deltas should be of type NodeCore\");\n    const ops: ISequencedDocumentMessage[] = [];\n    const records = getNodeProps(node);\n    assertNumberInstance(records.firstSequenceNumber, \"Seq number should be a number\");\n    assertNodeCoreInstance(records.deltas, \"Deltas should be a Node\");\n    for (let i = 0; i < records.deltas.length; ++i) {\n        ops.push(JSON.parse(records.deltas.getString(i)));\n    }\n    assert(records.firstSequenceNumber.valueOf() === ops[0].sequenceNumber,\n        0x280 /* \"Validate first op seq number\" */);\n    return ops;\n}\n\n/**\n * Recreates snapshot tree out of tree representation.\n * @param node - tree node to de-serialize from\n */\nfunction readTreeSection(node: NodeCore) {\n    let slowTreeStructureCount = 0;\n    const trees = {};\n    const snapshotTree: ISnapshotTree = {\n        blobs: {},\n        trees,\n    };\n    for (const treeNode of node) {\n        assertNodeCoreInstance(treeNode, \"tree nodes should be nodes\");\n\n        /**\n         * Perf optimization - the most common cases!\n         * This is essentially unrolling code below for faster processing\n         * It speeds up tree parsing by 2-3x times!\n         */\n         const length = treeNode.length;\n         if (length > 0 && treeNode.getMaybeString(0) === \"name\") {\n            if (length === 4) {\n                const content = treeNode.getMaybeString(2);\n                // \"name\": <node name>\n                // \"children\": <blob id>\n                if (content === \"children\") {\n                    const result = readTreeSection(treeNode.getNode(3));\n                    trees[treeNode.getString(1)] = result.snapshotTree;\n                    slowTreeStructureCount += result.slowTreeStructureCount;\n                    continue;\n                }\n                // \"name\": <node name>\n                // \"value\": <blob id>\n                if (content === \"value\") {\n                    snapshotTree.blobs[treeNode.getString(1)] = treeNode.getString(3);\n                    continue;\n                }\n            }\n\n            // \"name\": <node name>\n            // \"nodeType\": 3\n            // \"value\": <blob id>\n            if (length === 6 &&\n                    treeNode.getMaybeString(2) === \"nodeType\" &&\n                    treeNode.getMaybeString(4) === \"value\") {\n                snapshotTree.blobs[treeNode.getString(1)] = treeNode.getString(5);\n                continue;\n            }\n\n            // \"name\": <node name>\n            // \"unreferenced\": true\n            // \"children\": <blob id>\n            if (length === 6 &&\n                    treeNode.getMaybeString(2) === \"unreferenced\" &&\n                    treeNode.getMaybeString(4) === \"children\") {\n                const result = readTreeSection(treeNode.getNode(5));\n                trees[treeNode.getString(1)] = result.snapshotTree;\n                slowTreeStructureCount += result.slowTreeStructureCount;\n                assert(treeNode.getBool(3), 0x3db /* Unreferenced if present should be true */);\n                snapshotTree.unreferenced = true;\n                continue;\n            }\n        }\n\n        /**\n         * More generalized workflow\n         */\n        slowTreeStructureCount += 1;\n        const records = getNodeProps(treeNode);\n\n        if (records.unreferenced !== undefined) {\n            assertBoolInstance(records.unreferenced, \"Unreferenced flag should be bool\");\n            assert(records.unreferenced, 0x281 /* \"Unreferenced if present should be true\" */);\n            snapshotTree.unreferenced = true;\n        }\n\n        const path = getStringInstance(records.name, \"Path name should be string\");\n        if (records.value !== undefined) {\n            snapshotTree.blobs[path] = getStringInstance(records.value, \"Blob value should be string\");\n        } else if (records.children !== undefined) {\n            assertNodeCoreInstance(records.children, \"Trees should be of type NodeCore\");\n            const result = readTreeSection(records.children);\n            trees[path] = result.snapshotTree;\n            slowTreeStructureCount += result.slowTreeStructureCount;\n        } else {\n            trees[path] = { blobs: {}, trees: {} };\n        }\n    }\n    return { snapshotTree, slowTreeStructureCount };\n}\n\n/**\n * Recreates snapshot tree out of tree representation.\n * @param node - tree node to de-serialize from\n */\nfunction readSnapshotSection(node: NodeTypes) {\n    assertNodeCoreInstance(node, \"Snapshot should be of type NodeCore\");\n    const records = getNodeProps(node);\n\n    assertNodeCoreInstance(records.treeNodes, \"TreeNodes should be of type NodeCore\");\n    assertNumberInstance(records.sequenceNumber, \"sequenceNumber should be of type number\");\n    const { snapshotTree, slowTreeStructureCount } = readTreeSection(records.treeNodes);\n    snapshotTree.id = getStringInstance(records.id, \"snapshotId should be string\");\n    const sequenceNumber = records.sequenceNumber.valueOf();\n    return {\n        sequenceNumber,\n        snapshotTree,\n        slowTreeStructureCount,\n    };\n}\n\n/**\n * Converts snapshot from binary compact representation to tree/blobs/ops.\n * @param buffer - Compact snapshot to be parsed into tree/blobs/ops.\n * @returns - tree, blobs and ops from the snapshot.\n */\nexport function parseCompactSnapshotResponse(\n    buffer: Uint8Array,\n    logger: ITelemetryLogger,\n): ISnapshotContentsWithProps {\n    const { builder, telemetryProps } = TreeBuilder.load(new ReadBuffer(buffer), logger);\n    assert(builder.length === 1, 0x219 /* \"1 root should be there\" */);\n    const root = builder.getNode(0);\n\n    const records = getNodeProps(root);\n\n    const mrv = getStringInstance(records.mrv, \"minReadVersion should be string\");\n    const cv = getStringInstance(records.cv, \"createVersion should be string\");\n    if (records.lsn !== undefined) {\n        assertNumberInstance(records.lsn, \"lsn should be a number\");\n    }\n\n    assert(parseFloat(snapshotMinReadVersion) >= parseFloat(mrv),\n        0x20f /* \"Driver min read version should >= to server minReadVersion\" */);\n    assert(parseFloat(cv) >= parseFloat(snapshotMinReadVersion),\n        0x210 /* \"Snapshot should be created with minReadVersion or above\" */);\n    assert(currentReadVersion === cv,\n        0x2c2 /* \"Create Version should be equal to currentReadVersion\" */);\n\n    const [snapshot, durationSnapshotTree] = measure(() => readSnapshotSection(records.snapshot));\n    const [blobs, durationBlobs] = measure(() => readBlobSection(records.blobs));\n\n    return {\n        ...snapshot,\n        ...blobs,\n        ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [],\n        latestSequenceNumber: records.lsn,\n        telemetryProps: {\n            ...telemetryProps,\n            durationSnapshotTree,\n            durationBlobs,\n            slowTreeStructureCount: snapshot.slowTreeStructureCount,\n            slowBlobStructureCount: blobs.slowBlobStructureCount,\n        },\n    };\n}\n"]}

package/dist/compactSnapshotWriter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compactSnapshotWriter.d.ts","sourceRoot":"","sources":["../src/compactSnapshotWriter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AA8HtD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,gBAAgB,EAAE,iBAAiB,GAAG,UAAU,CAyBxF"}
+{"version":3,"file":"compactSnapshotWriter.d.ts","sourceRoot":"","sources":["../src/compactSnapshotWriter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AA8HtD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,gBAAgB,EAAE,iBAAiB,GAAG,UAAU,CA2BxF"}

package/dist/compactSnapshotWriter.js

@@ -120,13 +120,15 @@ function writeOpsSection(rootNode, ops) {
  * @returns - ReadBuffer - binary representation of the data.
  */
 function convertToCompactSnapshot(snapshotContents) {
-    var _a;
     const builder = new WriteBufferUtils_1.TreeBuilderSerializer();
     // Create the root node.
     const rootNode = builder.addNode();
     (0, common_utils_1.assert)(snapshotContents.sequenceNumber !== undefined, 0x21c /* "Seq number should be provided" */);
-    const latestSequenceNumber = ((_a = snapshotContents.latestSequenceNumber) !== null && _a !== void 0 ? _a : snapshotContents.ops.length > 0) ?
-        snapshotContents.ops[snapshotContents.ops.length - 1].sequenceNumber : snapshotContents.sequenceNumber;
+    let latestSequenceNumber = snapshotContents.latestSequenceNumber;
+    if (latestSequenceNumber === undefined) {
+        latestSequenceNumber = snapshotContents.ops.length > 0 ?
+            snapshotContents.ops[snapshotContents.ops.length - 1].sequenceNumber : snapshotContents.sequenceNumber;
+    }
     writeSnapshotProps(rootNode, latestSequenceNumber);
     writeSnapshotSection(rootNode, snapshotContents.snapshotTree, snapshotContents.sequenceNumber);
     // Add Blobs

package/dist/compactSnapshotWriter.js.map

@@ -1 +1 @@
-{"version":3,"file":"compactSnapshotWriter.js","sourceRoot":"","sources":["../src/compactSnapshotWriter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsE;AAEtE,mEAAiE;AAEjE,yDAA2D;AAC3D,iFAMwC;AAExC;;;;EAIE;AACF,SAAS,kBAAkB,CAAC,IAAc,EAAE,oBAA4B;IACpE,IAAA,gDAAiB,EAAC,IAAI,EAAE,KAAK,EAAE,8CAAsB,CAAC,CAAC;IACvD,IAAA,gDAAiB,EAAC,IAAI,EAAE,IAAI,EAAE,8CAAsB,CAAC,CAAC;IACtD,IAAA,gDAAiB,EAAC,IAAI,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC;AACzD,CAAC;AAED;;;;EAIE;AACF,SAAS,iBAAiB,CAAC,YAAsB,EAAE,KAAuC;;IACtF,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,KAAK,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,KAAK,EAAE;QACvC,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;QACrC,IAAA,0DAA2B,EAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC3D,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,IAAI,YAAY,WAAW,EAAE;YAC7B,QAAQ,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1C;aAAM;YACH,QAAQ,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,OAAO,CAAC,CAAC,CAAC,CAAC;SAC7F;KACJ;AACL,CAAC;AAED;;;;EAIE;AACF,SAAS,gBAAgB,CAAC,YAAsB,EAAE,YAA2B;IACzE,YAAY,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,oBAAoB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,oBAAoB,CAAC,SAAmB,EAAE,YAA2B;IAC1E,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QAC5D,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;QACrC,+EAA+E;QAC/E,2FAA2F;QAC3F,uCAAuC;QACvC,IAAA,0DAA2B,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACpD,IAAI,YAAY,CAAC,YAAY,EAAE;YAC3B,IAAA,8CAAe,EAAC,QAAQ,EAAE,cAAc,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;SACxE;QACD,iEAAiE;QACjE,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,QAAQ,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YACzC,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3C,oBAAoB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;SAC1C;KACJ;IAED,IAAI,YAAY,CAAC,KAAK,EAAE;QACpB,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;YACzD,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;YACrC,IAAA,0DAA2B,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YACpD,IAAA,0DAA2B,EAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;SACtD;KACJ;AACL,CAAC;AAED;;;;;;EAME;AACF,SAAS,oBAAoB,CACzB,QAAkB,EAClB,YAA2B,EAC3B,sBAA8B;IAE9B,QAAQ,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;IAExC,MAAM,UAAU,GAAG,YAAY,CAAC,EAAE,CAAC;IACnC,IAAA,qBAAM,EAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC/E,IAAA,gDAAiB,EAAC,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAClD,IAAA,gDAAiB,EAAC,YAAY,EAAE,SAAS,EAAE,YAAY,sBAAsB,EAAE,CAAC,CAAC;IACjF,IAAA,gDAAiB,EAAC,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;IAE1E,YAAY;IACZ,gBAAgB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AACjD,CAAC;AAED;;;;EAIE;AACF,SAAS,eAAe,CAAC,QAAkB,EAAE,GAAgC;IACzE,IAAI,mBAAuC,CAAC;IAC5C,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;QAChB,mBAAmB,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;KAC/C;IACD,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACnC,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QACnC,IAAA,gDAAiB,EAAC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,CAAC,CAAC;QACvE,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YACf,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;KACN;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,wBAAwB,CAAC,gBAAmC;;IACxE,MAAM,OAAO,GAAG,IAAI,wCAAqB,EAAE,CAAC;IAC5C,wBAAwB;IACxB,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IACnC,IAAA,qBAAM,EAAC,gBAAgB,CAAC,cAAc,KAAK,SAAS,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IAEnG,MAAM,oBAAoB,GAAG,CAAA,MAAA,gBAAgB,CAAC,oBAAoB,mCAC9D,gBAAgB,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAC,CAAC;QACjC,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC;IAE3G,kBAAkB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IAEnD,oBAAoB,CAChB,QAAQ,EACR,gBAAgB,CAAC,YAAY,EAC7B,gBAAgB,CAAC,cAAc,CAClC,CAAC;IAEF,YAAY;IACZ,iBAAiB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEpD,2BAA2B;IAC3B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAEhD,OAAO,OAAO,CAAC,SAAS,EAAE,CAAC;AAC/B,CAAC;AAzBD,4DAyBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, stringToBuffer } from \"@fluidframework/common-utils\";\nimport { IBlob, ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { snapshotMinReadVersion } from \"./compactSnapshotParser\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\nimport { TreeBuilderSerializer } from \"./WriteBufferUtils\";\nimport {\n    addBoolProperty,\n    addNumberProperty,\n    addStringProperty,\n    addDictionaryStringProperty,\n    NodeCore,\n} from \"./zipItDataRepresentationUtils\";\n\n/**\n * Writes header section of the snapshot.\n * @param node - snapshot node to serialize to\n * @param latestSequenceNumber - latest seq number of the container.\n*/\nfunction writeSnapshotProps(node: NodeCore, latestSequenceNumber: number) {\n    addStringProperty(node, \"mrv\", snapshotMinReadVersion);\n    addStringProperty(node, \"cv\", snapshotMinReadVersion);\n    addNumberProperty(node, \"lsn\", latestSequenceNumber);\n}\n\n/**\n * Represents blobs in the tree.\n * @param snapshotNode - node to serialize to.\n * @param blobs - blobs that is being serialized\n*/\nfunction writeBlobsSection(snapshotNode: NodeCore, blobs: Map<string, IBlob | ArrayBuffer>) {\n    snapshotNode.addDictionaryString(\"blobs\");\n    const blobsNode = snapshotNode.addNode(\"list\");\n    for (const [storageBlobId, blob] of blobs) {\n        const blobNode = blobsNode.addNode();\n        addDictionaryStringProperty(blobNode, \"id\", storageBlobId);\n        blobNode.addString(\"data\");\n        if (blob instanceof ArrayBuffer) {\n            blobNode.addBlob(new Uint8Array(blob));\n        } else {\n            blobNode.addBlob(new Uint8Array(stringToBuffer(blob.contents, blob.encoding ?? \"utf-8\")));\n        }\n    }\n}\n\n/**\n * Represents and serializes tree part of the snapshot\n * @param snapshotNode - tree node to serialize to\n * @param snapshotTree - snapshot tree that is being serialized\n*/\nfunction writeTreeSection(snapshotNode: NodeCore, snapshotTree: ISnapshotTree) {\n    snapshotNode.addDictionaryString(\"treeNodes\");\n    const treesNode = snapshotNode.addNode(\"list\");\n    writeTreeSectionCore(treesNode, snapshotTree);\n}\n\nfunction writeTreeSectionCore(treesNode: NodeCore, snapshotTree: ISnapshotTree) {\n    for (const [path, value] of Object.entries(snapshotTree.trees)) {\n        const treeNode = treesNode.addNode();\n        // Many leaf nodes in the tree have same names like \"content\", \"body\", \"header\"\n        // We could be smarter here and not use dictionary where we are sure reuse is unlikely, but\n        // it does not feel like it's worth it.\n        addDictionaryStringProperty(treeNode, \"name\", path);\n        if (snapshotTree.unreferenced) {\n            addBoolProperty(treeNode, \"unreferenced\", snapshotTree.unreferenced);\n        }\n        // Only write children prop if either blobs or trees are present.\n        if (Object.keys(value.blobs).length > 0 || Object.keys(value.trees).length > 0) {\n            treeNode.addDictionaryString(\"children\");\n            const childNode = treeNode.addNode(\"list\");\n            writeTreeSectionCore(childNode, value);\n        }\n    }\n\n    if (snapshotTree.blobs) {\n        for (const [path, id] of Object.entries(snapshotTree.blobs)) {\n            const blobNode = treesNode.addNode();\n            addDictionaryStringProperty(blobNode, \"name\", path);\n            addDictionaryStringProperty(blobNode, \"value\", id);\n        }\n    }\n}\n\n/**\n * Represents (serializes) snapshot tree as generalizes tree\n * @param rootNode - tree node to serialize to\n * @param snapshotTree - snapshot tree that is being serialized\n * @param blobs - blobs mapping of the snapshot\n * @param snapshotSequenceNumber - seq number at which snapshot is taken\n*/\nfunction writeSnapshotSection(\n    rootNode: NodeCore,\n    snapshotTree: ISnapshotTree,\n    snapshotSequenceNumber: number,\n) {\n    rootNode.addDictionaryString(\"snapshot\");\n    const snapshotNode = rootNode.addNode();\n\n    const snapshotId = snapshotTree.id;\n    assert(snapshotId !== undefined, 0x21b /* \"Snapshot id should be provided\" */);\n    addStringProperty(snapshotNode, \"id\", snapshotId);\n    addStringProperty(snapshotNode, \"message\", `Snapshot@${snapshotSequenceNumber}`);\n    addNumberProperty(snapshotNode, \"sequenceNumber\", snapshotSequenceNumber);\n\n    // Add Trees\n    writeTreeSection(snapshotNode, snapshotTree);\n}\n\n/**\n * Represents ops in the tree.\n * @param rootNode - node to serialize to.\n * @param ops - ops that is being serialized\n*/\nfunction writeOpsSection(rootNode: NodeCore, ops: ISequencedDocumentMessage[]) {\n    let firstSequenceNumber: number | undefined;\n    if (ops.length > 0) {\n        firstSequenceNumber = ops[0].sequenceNumber;\n    }\n    if (firstSequenceNumber !== undefined) {\n        rootNode.addDictionaryString(\"deltas\");\n        const opsNode = rootNode.addNode();\n        addNumberProperty(opsNode, \"firstSequenceNumber\", firstSequenceNumber);\n        opsNode.addDictionaryString(\"deltas\");\n        const deltaNode = opsNode.addNode(\"list\");\n        ops.forEach((op) => {\n            deltaNode.addString(JSON.stringify(op));\n        });\n    }\n}\n\n/**\n * Converts trees/blobs/ops to binary compact representation.\n * @param snapshotContents - snapshot tree contents to serialize\n * @returns - ReadBuffer - binary representation of the data.\n */\nexport function convertToCompactSnapshot(snapshotContents: ISnapshotContents): Uint8Array {\n    const builder = new TreeBuilderSerializer();\n    // Create the root node.\n    const rootNode = builder.addNode();\n    assert(snapshotContents.sequenceNumber !== undefined, 0x21c /* \"Seq number should be provided\" */);\n\n    const latestSequenceNumber = snapshotContents.latestSequenceNumber ??\n        snapshotContents.ops.length > 0 ?\n        snapshotContents.ops[snapshotContents.ops.length - 1].sequenceNumber : snapshotContents.sequenceNumber;\n\n    writeSnapshotProps(rootNode, latestSequenceNumber);\n\n    writeSnapshotSection(\n        rootNode,\n        snapshotContents.snapshotTree,\n        snapshotContents.sequenceNumber,\n    );\n\n    // Add Blobs\n    writeBlobsSection(rootNode, snapshotContents.blobs);\n\n    // Then write the ops node.\n    writeOpsSection(rootNode, snapshotContents.ops);\n\n    return builder.serialize();\n}\n"]}
+{"version":3,"file":"compactSnapshotWriter.js","sourceRoot":"","sources":["../src/compactSnapshotWriter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsE;AAEtE,mEAAiE;AAEjE,yDAA2D;AAC3D,iFAMwC;AAExC;;;;EAIE;AACF,SAAS,kBAAkB,CAAC,IAAc,EAAE,oBAA4B;IACpE,IAAA,gDAAiB,EAAC,IAAI,EAAE,KAAK,EAAE,8CAAsB,CAAC,CAAC;IACvD,IAAA,gDAAiB,EAAC,IAAI,EAAE,IAAI,EAAE,8CAAsB,CAAC,CAAC;IACtD,IAAA,gDAAiB,EAAC,IAAI,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC;AACzD,CAAC;AAED;;;;EAIE;AACF,SAAS,iBAAiB,CAAC,YAAsB,EAAE,KAAuC;;IACtF,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,KAAK,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,KAAK,EAAE;QACvC,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;QACrC,IAAA,0DAA2B,EAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC3D,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,IAAI,YAAY,WAAW,EAAE;YAC7B,QAAQ,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1C;aAAM;YACH,QAAQ,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,OAAO,CAAC,CAAC,CAAC,CAAC;SAC7F;KACJ;AACL,CAAC;AAED;;;;EAIE;AACF,SAAS,gBAAgB,CAAC,YAAsB,EAAE,YAA2B;IACzE,YAAY,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,oBAAoB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,oBAAoB,CAAC,SAAmB,EAAE,YAA2B;IAC1E,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QAC5D,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;QACrC,+EAA+E;QAC/E,2FAA2F;QAC3F,uCAAuC;QACvC,IAAA,0DAA2B,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACpD,IAAI,YAAY,CAAC,YAAY,EAAE;YAC3B,IAAA,8CAAe,EAAC,QAAQ,EAAE,cAAc,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;SACxE;QACD,iEAAiE;QACjE,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,QAAQ,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YACzC,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3C,oBAAoB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;SAC1C;KACJ;IAED,IAAI,YAAY,CAAC,KAAK,EAAE;QACpB,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;YACzD,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;YACrC,IAAA,0DAA2B,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YACpD,IAAA,0DAA2B,EAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;SACtD;KACJ;AACL,CAAC;AAED;;;;;;EAME;AACF,SAAS,oBAAoB,CACzB,QAAkB,EAClB,YAA2B,EAC3B,sBAA8B;IAE9B,QAAQ,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;IAExC,MAAM,UAAU,GAAG,YAAY,CAAC,EAAE,CAAC;IACnC,IAAA,qBAAM,EAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC/E,IAAA,gDAAiB,EAAC,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAClD,IAAA,gDAAiB,EAAC,YAAY,EAAE,SAAS,EAAE,YAAY,sBAAsB,EAAE,CAAC,CAAC;IACjF,IAAA,gDAAiB,EAAC,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;IAE1E,YAAY;IACZ,gBAAgB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AACjD,CAAC;AAED;;;;EAIE;AACF,SAAS,eAAe,CAAC,QAAkB,EAAE,GAAgC;IACzE,IAAI,mBAAuC,CAAC;IAC5C,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;QAChB,mBAAmB,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;KAC/C;IACD,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACnC,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QACnC,IAAA,gDAAiB,EAAC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,CAAC,CAAC;QACvE,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YACf,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;KACN;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,wBAAwB,CAAC,gBAAmC;IACxE,MAAM,OAAO,GAAG,IAAI,wCAAqB,EAAE,CAAC;IAC5C,wBAAwB;IACxB,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IACnC,IAAA,qBAAM,EAAC,gBAAgB,CAAC,cAAc,KAAK,SAAS,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IAEnG,IAAI,oBAAoB,GAAG,gBAAgB,CAAC,oBAAoB,CAAC;IACjE,IAAI,oBAAoB,KAAK,SAAS,EAAE;QACpC,oBAAoB,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACpD,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC;KAC9G;IAED,kBAAkB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IAEnD,oBAAoB,CAChB,QAAQ,EACR,gBAAgB,CAAC,YAAY,EAC7B,gBAAgB,CAAC,cAAc,CAClC,CAAC;IAEF,YAAY;IACZ,iBAAiB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEpD,2BAA2B;IAC3B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAEhD,OAAO,OAAO,CAAC,SAAS,EAAE,CAAC;AAC/B,CAAC;AA3BD,4DA2BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, stringToBuffer } from \"@fluidframework/common-utils\";\nimport { IBlob, ISequencedDocumentMessage, ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { snapshotMinReadVersion } from \"./compactSnapshotParser\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\nimport { TreeBuilderSerializer } from \"./WriteBufferUtils\";\nimport {\n    addBoolProperty,\n    addNumberProperty,\n    addStringProperty,\n    addDictionaryStringProperty,\n    NodeCore,\n} from \"./zipItDataRepresentationUtils\";\n\n/**\n * Writes header section of the snapshot.\n * @param node - snapshot node to serialize to\n * @param latestSequenceNumber - latest seq number of the container.\n*/\nfunction writeSnapshotProps(node: NodeCore, latestSequenceNumber: number) {\n    addStringProperty(node, \"mrv\", snapshotMinReadVersion);\n    addStringProperty(node, \"cv\", snapshotMinReadVersion);\n    addNumberProperty(node, \"lsn\", latestSequenceNumber);\n}\n\n/**\n * Represents blobs in the tree.\n * @param snapshotNode - node to serialize to.\n * @param blobs - blobs that is being serialized\n*/\nfunction writeBlobsSection(snapshotNode: NodeCore, blobs: Map<string, IBlob | ArrayBuffer>) {\n    snapshotNode.addDictionaryString(\"blobs\");\n    const blobsNode = snapshotNode.addNode(\"list\");\n    for (const [storageBlobId, blob] of blobs) {\n        const blobNode = blobsNode.addNode();\n        addDictionaryStringProperty(blobNode, \"id\", storageBlobId);\n        blobNode.addString(\"data\");\n        if (blob instanceof ArrayBuffer) {\n            blobNode.addBlob(new Uint8Array(blob));\n        } else {\n            blobNode.addBlob(new Uint8Array(stringToBuffer(blob.contents, blob.encoding ?? \"utf-8\")));\n        }\n    }\n}\n\n/**\n * Represents and serializes tree part of the snapshot\n * @param snapshotNode - tree node to serialize to\n * @param snapshotTree - snapshot tree that is being serialized\n*/\nfunction writeTreeSection(snapshotNode: NodeCore, snapshotTree: ISnapshotTree) {\n    snapshotNode.addDictionaryString(\"treeNodes\");\n    const treesNode = snapshotNode.addNode(\"list\");\n    writeTreeSectionCore(treesNode, snapshotTree);\n}\n\nfunction writeTreeSectionCore(treesNode: NodeCore, snapshotTree: ISnapshotTree) {\n    for (const [path, value] of Object.entries(snapshotTree.trees)) {\n        const treeNode = treesNode.addNode();\n        // Many leaf nodes in the tree have same names like \"content\", \"body\", \"header\"\n        // We could be smarter here and not use dictionary where we are sure reuse is unlikely, but\n        // it does not feel like it's worth it.\n        addDictionaryStringProperty(treeNode, \"name\", path);\n        if (snapshotTree.unreferenced) {\n            addBoolProperty(treeNode, \"unreferenced\", snapshotTree.unreferenced);\n        }\n        // Only write children prop if either blobs or trees are present.\n        if (Object.keys(value.blobs).length > 0 || Object.keys(value.trees).length > 0) {\n            treeNode.addDictionaryString(\"children\");\n            const childNode = treeNode.addNode(\"list\");\n            writeTreeSectionCore(childNode, value);\n        }\n    }\n\n    if (snapshotTree.blobs) {\n        for (const [path, id] of Object.entries(snapshotTree.blobs)) {\n            const blobNode = treesNode.addNode();\n            addDictionaryStringProperty(blobNode, \"name\", path);\n            addDictionaryStringProperty(blobNode, \"value\", id);\n        }\n    }\n}\n\n/**\n * Represents (serializes) snapshot tree as generalizes tree\n * @param rootNode - tree node to serialize to\n * @param snapshotTree - snapshot tree that is being serialized\n * @param blobs - blobs mapping of the snapshot\n * @param snapshotSequenceNumber - seq number at which snapshot is taken\n*/\nfunction writeSnapshotSection(\n    rootNode: NodeCore,\n    snapshotTree: ISnapshotTree,\n    snapshotSequenceNumber: number,\n) {\n    rootNode.addDictionaryString(\"snapshot\");\n    const snapshotNode = rootNode.addNode();\n\n    const snapshotId = snapshotTree.id;\n    assert(snapshotId !== undefined, 0x21b /* \"Snapshot id should be provided\" */);\n    addStringProperty(snapshotNode, \"id\", snapshotId);\n    addStringProperty(snapshotNode, \"message\", `Snapshot@${snapshotSequenceNumber}`);\n    addNumberProperty(snapshotNode, \"sequenceNumber\", snapshotSequenceNumber);\n\n    // Add Trees\n    writeTreeSection(snapshotNode, snapshotTree);\n}\n\n/**\n * Represents ops in the tree.\n * @param rootNode - node to serialize to.\n * @param ops - ops that is being serialized\n*/\nfunction writeOpsSection(rootNode: NodeCore, ops: ISequencedDocumentMessage[]) {\n    let firstSequenceNumber: number | undefined;\n    if (ops.length > 0) {\n        firstSequenceNumber = ops[0].sequenceNumber;\n    }\n    if (firstSequenceNumber !== undefined) {\n        rootNode.addDictionaryString(\"deltas\");\n        const opsNode = rootNode.addNode();\n        addNumberProperty(opsNode, \"firstSequenceNumber\", firstSequenceNumber);\n        opsNode.addDictionaryString(\"deltas\");\n        const deltaNode = opsNode.addNode(\"list\");\n        ops.forEach((op) => {\n            deltaNode.addString(JSON.stringify(op));\n        });\n    }\n}\n\n/**\n * Converts trees/blobs/ops to binary compact representation.\n * @param snapshotContents - snapshot tree contents to serialize\n * @returns - ReadBuffer - binary representation of the data.\n */\nexport function convertToCompactSnapshot(snapshotContents: ISnapshotContents): Uint8Array {\n    const builder = new TreeBuilderSerializer();\n    // Create the root node.\n    const rootNode = builder.addNode();\n    assert(snapshotContents.sequenceNumber !== undefined, 0x21c /* \"Seq number should be provided\" */);\n\n    let latestSequenceNumber = snapshotContents.latestSequenceNumber;\n    if (latestSequenceNumber === undefined) {\n        latestSequenceNumber = snapshotContents.ops.length > 0 ?\n            snapshotContents.ops[snapshotContents.ops.length - 1].sequenceNumber : snapshotContents.sequenceNumber;\n    }\n\n    writeSnapshotProps(rootNode, latestSequenceNumber);\n\n    writeSnapshotSection(\n        rootNode,\n        snapshotContents.snapshotTree,\n        snapshotContents.sequenceNumber,\n    );\n\n    // Add Blobs\n    writeBlobsSection(rootNode, snapshotContents.blobs);\n\n    // Then write the ops node.\n    writeOpsSection(rootNode, snapshotContents.ops);\n\n    return builder.serialize();\n}\n"]}

package/dist/contracts.d.ts

@@ -49,6 +49,11 @@ export interface IOdspSocketError {
      * The client should wait this many seconds before retrying its request
      */
     retryAfter?: number;
+    /**
+     * Any error supplied by the socket containing codes and inner errors with further
+     * details about the error.
+     */
+    error?: any;
 }
 /**
  * Interface for delta storage response.

package/dist/contracts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IAEpC,EAAE,EAAE,MAAM,CAAC;IAIX,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,wBAAwB,EAAE,CAAC;CACvE;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,GAAG,CAAC,yBAAyB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mCAAmC;IAChD,KAAK,EAAE,uBAAuB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AAEH,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,0BAA0B,GAAG,2BAA2B,CAAC;AAE5F,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;CACpC;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IACzE,KAAK,EAAE,oBAAoB,CAAC;IAE5B,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,2BAA4B,SAAQ,yBAAyB;IAC1E,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEvE,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC;CAChC;AAED;;;;GAIG;AAEH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,sBAAsB,GAC5B,0BAA0B,GAC1B,4BAA4B,GAC5B,0BAA0B,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,CAAC,CAAC;CACd;AAED,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,GAAG,CAAC,yBAAyB,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC3D,cAAc,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IAEpC,EAAE,EAAE,MAAM,CAAC;IAIX,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,wBAAwB,EAAE,CAAC;CACvE;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,GAAG,CAAC,yBAAyB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mCAAmC;IAChD,KAAK,EAAE,uBAAuB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AAEH,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,0BAA0B,GAAG,2BAA2B,CAAC;AAE5F,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;CACpC;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IACzE,KAAK,EAAE,oBAAoB,CAAC;IAE5B,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,2BAA4B,SAAQ,yBAAyB;IAC1E,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEvE,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC;CAChC;AAED;;;;GAIG;AAEH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,sBAAsB,GAC5B,0BAA0B,GAC1B,4BAA4B,GAC5B,0BAA0B,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,CAAC,CAAC;CACd;AAED,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,GAAG,CAAC,yBAAyB,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC3D,cAAc,EAAE,MAAM,CAAC;CAC1B"}

package/dist/contracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAsNU,QAAA,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { HostStoragePolicy } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\n\n/**\n * Socket storage discovery api response\n */\nexport interface ISocketStorageDiscovery {\n    // The id of the web socket\n    id: string;\n\n    // SPO gives us runtimeTenantId, we remap it to tenantId\n    // See getSocketStorageDiscovery\n    runtimeTenantId?: string;\n    tenantId: string;\n\n    snapshotStorageUrl: string;\n    deltaStorageUrl: string;\n\n    /**\n     * PUSH URL\n     */\n    deltaStreamSocketUrl: string;\n\n    /**\n     * The access token for PushChannel. Optionally returned, depending on implementation.\n     * OneDrive for Consumer implementation returns it and OneDrive for Business implementation\n     * does not return it and instead expects token to be returned via `getWebsocketToken` callback\n     * passed as a parameter to `OdspDocumentService.create()` factory.\n     */\n    socketToken?: string;\n\n    /**\n     * This is the time within which client has to refresh the session on (ODSP) relay service.\n     */\n    refreshSessionDurationSeconds?: number;\n}\n\n/**\n * Interface for error responses for the WebSocket connection\n */\nexport interface IOdspSocketError {\n    /**\n     * An error code number for the error that occurred\n     * It will be a valid HTTP status code\n     */\n    code: number;\n\n    /**\n     * A message about the error that occurred for debugging / logging purposes\n     * This should not be displayed to the user directly\n     */\n    message: string;\n\n    /**\n     * Optional Retry-After time in seconds\n     * The client should wait this many seconds before retrying its request\n     */\n    retryAfter?: number;\n}\n\n/**\n * Interface for delta storage response.\n * Contains either SequencedDocumentMessages or SequencedDeltaOpMessage.\n */\nexport interface IDeltaStorageGetResponse {\n    value: api.ISequencedDocumentMessage[] | ISequencedDeltaOpMessage[];\n}\n\nexport interface ISequencedDeltaOpMessage {\n    op: api.ISequencedDocumentMessage;\n    sequenceNumber: number;\n}\n\nexport interface IDocumentStorageGetVersionsResponse {\n    value: IDocumentStorageVersion[];\n}\n\nexport interface IDocumentStorageVersion {\n    id: string;\n}\n\n/**\n *\n * Data structures that form ODSP Summary\n *\n */\n\nexport interface IOdspSummaryPayload {\n    type: \"container\" | \"channel\";\n    message: string;\n    sequenceNumber: number;\n    entries: OdspSummaryTreeEntry[];\n}\n\nexport interface IWriteSummaryResponse {\n    id: string;\n}\n\nexport type OdspSummaryTreeEntry = IOdspSummaryTreeValueEntry | IOdspSummaryTreeHandleEntry;\n\nexport interface IOdspSummaryTreeBaseEntry {\n    path: string;\n    type: \"blob\" | \"tree\" | \"commit\";\n}\n\nexport interface IOdspSummaryTreeValueEntry extends IOdspSummaryTreeBaseEntry {\n    value: OdspSummaryTreeValue;\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSummaryTreeHandleEntry extends IOdspSummaryTreeBaseEntry {\n    id: string;\n}\n\nexport type OdspSummaryTreeValue = IOdspSummaryTree | IOdspSummaryBlob;\n\nexport interface IOdspSummaryTree {\n    type: \"tree\";\n    entries?: OdspSummaryTreeEntry[];\n}\n\nexport interface IOdspSummaryBlob {\n    type: \"blob\";\n    content: string;\n    encoding: \"base64\" | \"utf-8\";\n}\n\n/**\n *\n * Data structures that form ODSP Snapshot\n *\n */\n\nexport interface IOdspSnapshotTreeEntryTree {\n    path: string;\n    type: \"tree\";\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSnapshotTreeEntryCommit {\n    id: string;\n    path: string;\n    type: \"commit\";\n}\n\nexport interface IOdspSnapshotTreeEntryBlob {\n    id: string;\n    path: string;\n    type: \"blob\";\n}\n\nexport type IOdspSnapshotTreeEntry =\n    | IOdspSnapshotTreeEntryTree\n    | IOdspSnapshotTreeEntryCommit\n    | IOdspSnapshotTreeEntryBlob;\n\nexport interface IOdspSnapshotCommit {\n    entries: IOdspSnapshotTreeEntry[];\n    id: string;\n    sequenceNumber: number;\n}\n\n/**\n * Blob content, represents blobs in downloaded snapshot.\n */\nexport interface IOdspSnapshotBlob {\n    content: string;\n    // SPO only uses \"base64\" today for download.\n    // We are adding undefined too, as temp way to roundtrip strings unchanged.\n    encoding: \"base64\" | undefined;\n    id: string;\n    size: number;\n}\n\nexport interface IOdspSnapshot {\n    id: string;\n    trees: IOdspSnapshotCommit[];\n    blobs?: IOdspSnapshotBlob[];\n    ops?: ISequencedDeltaOpMessage[];\n}\n\n/**\n * Same as HostStoragePolicy, but adds options that are internal to runtime.\n * All fields should be optional.\n */\nexport interface HostStoragePolicyInternal extends HostStoragePolicy {\n    summarizerClient?: boolean;\n}\n\nexport interface ICreateFileResponse {\n    \"@odata.context\": string;\n    driveId: string;\n    id: string;\n    itemId: string;\n    itemUrl: string;\n    sequenceNumber: number;\n    // sharing object contains shareId, sharingLink data or error in the response\n    sharing?: any;\n    sharingLink?: string;\n    sharingLinkErrorReason?: string;\n}\n\nexport interface IVersionedValueWithEpoch {\n    value: any;\n    fluidEpoch: string;\n    // This is same as \"persistedCacheValueVersion\" below. This represents the version of data stored in cache.\n    version: 3;\n}\n\nexport const persistedCacheValueVersion = 3;\n\nexport interface IGetOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds. Currently never set by PUSH */\n    retryAfter?: number;\n    messages?: api.ISequencedDocumentMessage[];\n}\n\nexport interface IFlushOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds */\n    retryAfter?: number;\n    lastPersistedSequenceNumber?: number;\n}\n\n/**\n * Represents the cached snapshot value.\n */\nexport interface ISnapshotCachedEntry extends ISnapshotContents {\n    cacheEntryTime: number;\n}\n"]}
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA4NU,QAAA,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { HostStoragePolicy } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\n\n/**\n * Socket storage discovery api response\n */\nexport interface ISocketStorageDiscovery {\n    // The id of the web socket\n    id: string;\n\n    // SPO gives us runtimeTenantId, we remap it to tenantId\n    // See getSocketStorageDiscovery\n    runtimeTenantId?: string;\n    tenantId: string;\n\n    snapshotStorageUrl: string;\n    deltaStorageUrl: string;\n\n    /**\n     * PUSH URL\n     */\n    deltaStreamSocketUrl: string;\n\n    /**\n     * The access token for PushChannel. Optionally returned, depending on implementation.\n     * OneDrive for Consumer implementation returns it and OneDrive for Business implementation\n     * does not return it and instead expects token to be returned via `getWebsocketToken` callback\n     * passed as a parameter to `OdspDocumentService.create()` factory.\n     */\n    socketToken?: string;\n\n    /**\n     * This is the time within which client has to refresh the session on (ODSP) relay service.\n     */\n    refreshSessionDurationSeconds?: number;\n}\n\n/**\n * Interface for error responses for the WebSocket connection\n */\nexport interface IOdspSocketError {\n    /**\n     * An error code number for the error that occurred\n     * It will be a valid HTTP status code\n     */\n    code: number;\n\n    /**\n     * A message about the error that occurred for debugging / logging purposes\n     * This should not be displayed to the user directly\n     */\n    message: string;\n\n    /**\n     * Optional Retry-After time in seconds\n     * The client should wait this many seconds before retrying its request\n     */\n    retryAfter?: number;\n\n    /**\n     * Any error supplied by the socket containing codes and inner errors with further\n     * details about the error.\n     */\n    error?: any;\n}\n\n/**\n * Interface for delta storage response.\n * Contains either SequencedDocumentMessages or SequencedDeltaOpMessage.\n */\nexport interface IDeltaStorageGetResponse {\n    value: api.ISequencedDocumentMessage[] | ISequencedDeltaOpMessage[];\n}\n\nexport interface ISequencedDeltaOpMessage {\n    op: api.ISequencedDocumentMessage;\n    sequenceNumber: number;\n}\n\nexport interface IDocumentStorageGetVersionsResponse {\n    value: IDocumentStorageVersion[];\n}\n\nexport interface IDocumentStorageVersion {\n    id: string;\n}\n\n/**\n *\n * Data structures that form ODSP Summary\n *\n */\n\nexport interface IOdspSummaryPayload {\n    type: \"container\" | \"channel\";\n    message: string;\n    sequenceNumber: number;\n    entries: OdspSummaryTreeEntry[];\n}\n\nexport interface IWriteSummaryResponse {\n    id: string;\n}\n\nexport type OdspSummaryTreeEntry = IOdspSummaryTreeValueEntry | IOdspSummaryTreeHandleEntry;\n\nexport interface IOdspSummaryTreeBaseEntry {\n    path: string;\n    type: \"blob\" | \"tree\" | \"commit\";\n}\n\nexport interface IOdspSummaryTreeValueEntry extends IOdspSummaryTreeBaseEntry {\n    value: OdspSummaryTreeValue;\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSummaryTreeHandleEntry extends IOdspSummaryTreeBaseEntry {\n    id: string;\n}\n\nexport type OdspSummaryTreeValue = IOdspSummaryTree | IOdspSummaryBlob;\n\nexport interface IOdspSummaryTree {\n    type: \"tree\";\n    entries?: OdspSummaryTreeEntry[];\n}\n\nexport interface IOdspSummaryBlob {\n    type: \"blob\";\n    content: string;\n    encoding: \"base64\" | \"utf-8\";\n}\n\n/**\n *\n * Data structures that form ODSP Snapshot\n *\n */\n\nexport interface IOdspSnapshotTreeEntryTree {\n    path: string;\n    type: \"tree\";\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSnapshotTreeEntryCommit {\n    id: string;\n    path: string;\n    type: \"commit\";\n}\n\nexport interface IOdspSnapshotTreeEntryBlob {\n    id: string;\n    path: string;\n    type: \"blob\";\n}\n\nexport type IOdspSnapshotTreeEntry =\n    | IOdspSnapshotTreeEntryTree\n    | IOdspSnapshotTreeEntryCommit\n    | IOdspSnapshotTreeEntryBlob;\n\nexport interface IOdspSnapshotCommit {\n    entries: IOdspSnapshotTreeEntry[];\n    id: string;\n    sequenceNumber: number;\n}\n\n/**\n * Blob content, represents blobs in downloaded snapshot.\n */\nexport interface IOdspSnapshotBlob {\n    content: string;\n    // SPO only uses \"base64\" today for download.\n    // We are adding undefined too, as temp way to roundtrip strings unchanged.\n    encoding: \"base64\" | undefined;\n    id: string;\n    size: number;\n}\n\nexport interface IOdspSnapshot {\n    id: string;\n    trees: IOdspSnapshotCommit[];\n    blobs?: IOdspSnapshotBlob[];\n    ops?: ISequencedDeltaOpMessage[];\n}\n\n/**\n * Same as HostStoragePolicy, but adds options that are internal to runtime.\n * All fields should be optional.\n */\nexport interface HostStoragePolicyInternal extends HostStoragePolicy {\n    summarizerClient?: boolean;\n}\n\nexport interface ICreateFileResponse {\n    \"@odata.context\": string;\n    driveId: string;\n    id: string;\n    itemId: string;\n    itemUrl: string;\n    sequenceNumber: number;\n    // sharing object contains shareId, sharingLink data or error in the response\n    sharing?: any;\n    sharingLink?: string;\n    sharingLinkErrorReason?: string;\n}\n\nexport interface IVersionedValueWithEpoch {\n    value: any;\n    fluidEpoch: string;\n    // This is same as \"persistedCacheValueVersion\" below. This represents the version of data stored in cache.\n    version: 3;\n}\n\nexport const persistedCacheValueVersion = 3;\n\nexport interface IGetOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds. Currently never set by PUSH */\n    retryAfter?: number;\n    messages?: api.ISequencedDocumentMessage[];\n}\n\nexport interface IFlushOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds */\n    retryAfter?: number;\n    lastPersistedSequenceNumber?: number;\n}\n\n/**\n * Represents the cached snapshot value.\n */\nexport interface ISnapshotCachedEntry extends ISnapshotContents {\n    cacheEntryTime: number;\n}\n"]}

package/dist/epochTracker.d.ts

@@ -74,7 +74,12 @@ export declare class EpochTracker implements IPersistedFileCache {
     private fileEntryFromEntry;
 }
 export declare class EpochTrackerWithRedemption extends EpochTracker {
+    protected readonly cache: IPersistedCache;
+    protected readonly fileEntry: IFileEntry;
+    protected readonly logger: ITelemetryLogger;
+    protected readonly clientIsSummarizer?: boolean | undefined;
     private readonly treesLatestDeferral;
+    constructor(cache: IPersistedCache, fileEntry: IFileEntry, logger: ITelemetryLogger, clientIsSummarizer?: boolean | undefined);
     protected validateEpochFromResponse(epochFromResponse: string | undefined, fetchType: FetchType, fromCache?: boolean): void;
     get(entry: IEntry): Promise<any>;
     fetchAndParseAsJSON<T>(url: string, fetchOptions: {

package/dist/epochTracker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"epochTracker.d.ts","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAEH,WAAW,EAGd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAGH,MAAM,EACN,UAAU,EACV,eAAe,EAIlB,MAAM,yCAAyC,CAAC;AAQjD,OAAO,EAA0E,aAAa,EAAE,MAAM,aAAa,CAAC;AACpH,OAAO,EACH,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACrB,MAAM,aAAa,CAAC;AAMtB,oBAAY,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,cAAc,GAC1G,aAAa,GAAG,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAE1D,oBAAY,iBAAiB,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpD,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAG3C,eAAO,MAAM,2BAA2B,EAAE,MAAgC,CAAC;AAE3E;;;;;GAKG;AACH,qBAAa,YAAa,YAAW,mBAAmB;IAShD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe;IACzC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IACxC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB;IAC3C,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAX1C,OAAO,CAAC,WAAW,CAAqB;IAExC,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAS;IACtD,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC,OAAO,CAAC,iBAAiB,CAAK;gBAEP,KAAK,EAAE,eAAe,EACtB,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,CAAC,qBAAS;IAa5C,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,iBAAiB;IAclE,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAyCF,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAmB7B,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3C,IAAW,UAAU,uBAEpB;IAEY,qBAAqB,CAAC,OAAO,EAAE,UAAU;IAWtD;;;;;;;OAOG;IACU,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAI5B;;;;;;;OAOG;IACU,KAAK,CACd,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;YAKV,SAAS;IAqDvB;;;;;;;OAOG;IACU,UAAU,CACnB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,EACvC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;IAKxB,OAAO,CAAC,iBAAiB;IAkCzB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,yBAAyB;IAajC,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,iBAAiB,EAC5B,SAAS,GAAE,OAAe;YAahB,kBAAkB;IA6BhC,OAAO,CAAC,sBAAsB;IAY9B,OAAO,CAAC,kBAAkB;CAG7B;AAED,qBAAa,0BAA2B,SAAQ,YAAY;IACxD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAwB;IAE5D,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe;IAUjB,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAuBF,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,EACvC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAgD/B;AAED,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,UAAU,CAAC;IAClB,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED,wBAAgB,yBAAyB,CACrC,iBAAiB,EAAE,eAAe,EAClC,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,CAAC,EAAE,OAAO,GAAG,gBAAgB,CASlD"}
+{"version":3,"file":"epochTracker.d.ts","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAEH,WAAW,EAGd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAGH,MAAM,EACN,UAAU,EACV,eAAe,EAIlB,MAAM,yCAAyC,CAAC;AAQjD,OAAO,EAA0E,aAAa,EAAE,MAAM,aAAa,CAAC;AACpH,OAAO,EACH,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACrB,MAAM,aAAa,CAAC;AAMtB,oBAAY,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,cAAc,GAC1G,aAAa,GAAG,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAE1D,oBAAY,iBAAiB,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpD,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAG3C,eAAO,MAAM,2BAA2B,EAAE,MAAgC,CAAC;AAE3E;;;;;GAKG;AACH,qBAAa,YAAa,YAAW,mBAAmB;IAShD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe;IACzC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IACxC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB;IAC3C,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAX1C,OAAO,CAAC,WAAW,CAAqB;IAExC,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAS;IACtD,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC,OAAO,CAAC,iBAAiB,CAAK;gBAEP,KAAK,EAAE,eAAe,EACtB,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,CAAC,qBAAS;IAa5C,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,iBAAiB;IAclE,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAyCF,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAmB7B,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3C,IAAW,UAAU,uBAEpB;IAEY,qBAAqB,CAAC,OAAO,EAAE,UAAU;IAWtD;;;;;;;OAOG;IACU,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAI5B;;;;;;;OAOG;IACU,KAAK,CACd,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;YAKV,SAAS;IAqDvB;;;;;;;OAOG;IACU,UAAU,CACnB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,EACvC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;IAKxB,OAAO,CAAC,iBAAiB;IAkCzB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,yBAAyB;IAajC,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,iBAAiB,EAC5B,SAAS,GAAE,OAAe;YAahB,kBAAkB;IA6BhC,OAAO,CAAC,sBAAsB;IAY9B,OAAO,CAAC,kBAAkB;CAG7B;AAED,qBAAa,0BAA2B,SAAQ,YAAY;IAIpD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe;IACzC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IACxC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB;IAC3C,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAN1C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAwB;gBAGrC,KAAK,EAAE,eAAe,EACtB,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,CAAC,qBAAS;IAOnD,SAAS,CAAC,yBAAyB,CAC/B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe;IAUjB,GAAG,CACZ,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAuBF,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,EACvC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAgD/B;AAED,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,UAAU,CAAC;IAClB,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED,wBAAgB,yBAAyB,CACrC,iBAAiB,EAAE,eAAe,EAClC,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,CAAC,EAAE,OAAO,GAAG,gBAAgB,CASlD"}

package/dist/epochTracker.js

@@ -17,8 +17,8 @@ const contractsPublic_1 = require("./contractsPublic");
 const packageVersion_1 = require("./packageVersion");
 const odspLocationRedirection_1 = require("./odspLocationRedirection");
 exports.Odsp409Error = "Odsp409Error";
-// Please update the README file in odsp-driver-definitions if you change the defaultCacheExpiryTimeoutMs.
-exports.defaultCacheExpiryTimeoutMs = 2 * 24 * 60 * 60 * 1000;
+// Must be less than policy of 5 days
+exports.defaultCacheExpiryTimeoutMs = 2 * 24 * 60 * 60 * 1000; // 2 days in ms
 /**
  * This class is a wrapper around fetch calls. It adds epoch to the request made so that the
  * server can match it with its epoch value in order to match the version.
@@ -36,7 +36,7 @@ class EpochTracker {
         this.networkCallNumber = 1;
         // Limits the max number of concurrent requests to 24.
         this.rateLimiter = new driver_utils_1.RateLimiter(24);
-        // We need this for GC testing until we properly plumb through the snapshot expiration policy (see PR #11168)
+        // Matches the TestOverride logic for the policy defined in odspDocumentStorageServiceBase.ts
         this.snapshotCacheExpiryTimeoutMs =
             (0, telemetry_utils_1.loggerToMonitoringContext)(logger).config.getBoolean("Fluid.Driver.Odsp.TestOverride.DisableSnapshotCache")
                 ? 0
@@ -309,9 +309,15 @@ class EpochTracker {
 }
 exports.EpochTracker = EpochTracker;
 class EpochTrackerWithRedemption extends EpochTracker {
-    constructor() {
-        super(...arguments);
+    constructor(cache, fileEntry, logger, clientIsSummarizer) {
+        super(cache, fileEntry, logger, clientIsSummarizer);
+        this.cache = cache;
+        this.fileEntry = fileEntry;
+        this.logger = logger;
+        this.clientIsSummarizer = clientIsSummarizer;
         this.treesLatestDeferral = new common_utils_1.Deferred();
+        // Handles the rejected promise within treesLatestDeferral.
+        this.treesLatestDeferral.promise.catch(() => { });
     }
     validateEpochFromResponse(epochFromResponse, fetchType, fromCache = false) {
         super.validateEpochFromResponse(epochFromResponse, fetchType, fromCache);