@fluidframework/odsp-driver 0.58.2000 → 0.58.3000-61081

package/dist/compactSnapshotParser.d.ts

@@ -5,6 +5,7 @@
 import { ISnapshotContents } from "./odspUtils";
 import { ReadBuffer } from "./ReadBufferUtils";
 export declare const snapshotMinReadVersion = "1.0";
+export declare const currentReadVersion = "1.0";
 /**
  * Converts snapshot from binary compact representation to tree/blobs/ops.
  * @param buffer - Compact snapshot to be parsed into tree/blobs/ops.

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,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAW/C,eAAO,MAAM,sBAAsB,QAAQ,CAAC;AA4F5C;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,UAAU,GAAG,iBAAiB,CAwBlF"}
+{"version":3,"file":"compactSnapshotParser.d.ts","sourceRoot":"","sources":["../src/compactSnapshotParser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAY/C,eAAO,MAAM,sBAAsB,QAAQ,CAAC;AAC5C,eAAO,MAAM,kBAAkB,QAAQ,CAAC;AA+FxC;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,UAAU,GAAG,iBAAiB,CAoBlF"}

package/dist/compactSnapshotParser.js

@@ -4,15 +4,17 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCompactSnapshotResponse = exports.snapshotMinReadVersion = void 0;
+exports.parseCompactSnapshotResponse = exports.currentReadVersion = exports.snapshotMinReadVersion = void 0;
 const common_utils_1 = require("@fluidframework/common-utils");
 const zipItDataRepresentationUtils_1 = require("./zipItDataRepresentationUtils");
 exports.snapshotMinReadVersion = "1.0";
+exports.currentReadVersion = "1.0";
 /**
  * Recreates blobs section of the tree.
  * @param node - tree node to read blob section from
  */
 function readBlobSection(node) {
+    zipItDataRepresentationUtils_1.assertNodeCoreInstance(node, "TreeBlobs should be of type NodeCore");
     const blobs = new Map();
     for (let count = 0; count < node.length; ++count) {
         const blob = node.getNode(count);
@@ -28,6 +30,7 @@ function readBlobSection(node) {
  * @param node - tree node to read ops section from
  */
 function readOpsSection(node) {
+    zipItDataRepresentationUtils_1.assertNodeCoreInstance(node, "Deltas should be of type NodeCore");
     const ops = [];
     const records = zipItDataRepresentationUtils_1.getAndValidateNodeProps(node, ["firstSequenceNumber", "deltas"]);
     zipItDataRepresentationUtils_1.assertNumberInstance(records.firstSequenceNumber, "Seq number should be a number");
@@ -75,6 +78,7 @@ function readTreeSection(node) {
  * @param node - tree node to de-serialize from
  */
 function readSnapshotSection(node) {
+    zipItDataRepresentationUtils_1.assertNodeCoreInstance(node, "Snapshot should be of type NodeCore");
     const records = zipItDataRepresentationUtils_1.getAndValidateNodeProps(node, ["id", "sequenceNumber", "treeNodes"]);
     zipItDataRepresentationUtils_1.assertNodeCoreInstance(records.treeNodes, "TreeNodes should be of type NodeCore");
     zipItDataRepresentationUtils_1.assertNumberInstance(records.sequenceNumber, "sequenceNumber should be of type number");
@@ -96,15 +100,13 @@ function parseCompactSnapshotResponse(buffer) {
     const builder = zipItDataRepresentationUtils_1.TreeBuilder.load(buffer);
     common_utils_1.assert(builder.length === 1, 0x219 /* "1 root should be there" */);
     const root = builder.getNode(0);
-    const records = zipItDataRepresentationUtils_1.getAndValidateNodeProps(root, ["mrv", "cv", "snapshot", "blobs", "deltas"]);
+    const records = zipItDataRepresentationUtils_1.getAndValidateNodeProps(root, ["mrv", "cv", "snapshot", "blobs", "deltas"], false);
     zipItDataRepresentationUtils_1.assertBlobCoreInstance(records.mrv, "minReadVersion should be of BlobCore type");
     zipItDataRepresentationUtils_1.assertBlobCoreInstance(records.cv, "createVersion should be of BlobCore type");
     common_utils_1.assert(exports.snapshotMinReadVersion >= records.mrv.toString(), 0x20f /* "Driver min read version should >= to server minReadVersion" */);
     common_utils_1.assert(records.cv.toString() >= exports.snapshotMinReadVersion, 0x210 /* "Snapshot should be created with minReadVersion or above" */);
-    zipItDataRepresentationUtils_1.assertNodeCoreInstance(records.snapshot, "Snapshot should be of type NodeCore");
-    zipItDataRepresentationUtils_1.assertNodeCoreInstance(records.blobs, "TreeBlobs should be of type NodeCore");
-    zipItDataRepresentationUtils_1.assertNodeCoreInstance(records.deltas, "Deltas should be of type NodeCore");
-    return Object.assign(Object.assign({}, readSnapshotSection(records.snapshot)), { blobs: readBlobSection(records.blobs), ops: readOpsSection(records.deltas) });
+    common_utils_1.assert(exports.currentReadVersion === records.cv.toString(), "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) : [] });
 }
 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,iFAQwC;AAE3B,QAAA,sBAAsB,GAAG,KAAK,CAAC;AAO5C;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAc;IACnC,MAAM,KAAK,GAA6B,IAAI,GAAG,EAAE,CAAC;IAClD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,sDAAuB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9D,qDAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;QACxE,qDAAsB,CAAC,OAAO,CAAC,EAAE,EAAE,oCAAoC,CAAC,CAAC;QACzE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KAC9D;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,IAAc;IAClC,MAAM,GAAG,GAAgC,EAAE,CAAC;IAC5C,MAAM,OAAO,GAAG,sDAAuB,CAAC,IAAI,EAAE,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC,CAAC;IACjF,mDAAoB,CAAC,OAAO,CAAC,mBAAmB,EAAE,+BAA+B,CAAC,CAAC;IACnF,qDAAsB,CAAC,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,qBAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACpH,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAc;IACnC,MAAM,YAAY,GAAkB;QAChC,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,EAAE;KACZ,CAAC;IACF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,sDAAuB,CAAC,QAAQ,EAC5C,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1D,qDAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;YAC7B,qDAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,CAAC;YACvE,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;SACvD;aAAM;YACH,qDAAsB,CAAC,OAAO,CAAC,QAAQ,EAAE,kCAAkC,CAAC,CAAC;YAC7E,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SAChE;QACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;YACpC,iDAAkB,CAAC,OAAO,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC;YAC7E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YACpD,qBAAM,CAAC,YAAY,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAC3E,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC;SAC5C;KACJ;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,IAAc;IACvC,MAAM,OAAO,GAAG,sDAAuB,CAAC,IAAI,EACxC,CAAC,IAAI,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC,CAAC;IAE3C,qDAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;IAClF,mDAAoB,CAAC,OAAO,CAAC,cAAc,EAAE,yCAAyC,CAAC,CAAC;IACxF,qDAAsB,CAAC,OAAO,CAAC,EAAE,EAAE,+BAA+B,CAAC,CAAC;IACpE,MAAM,YAAY,GAAkB,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvE,YAAY,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;IACxC,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;IAC3D,MAAM,OAAO,GAAG,0CAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,qBAAM,CAAC,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,sDAAuB,CAAC,IAAI,EACxC,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IAElD,qDAAsB,CAAC,OAAO,CAAC,GAAG,EAAE,2CAA2C,CAAC,CAAC;IACjF,qDAAsB,CAAC,OAAO,CAAC,EAAE,EAAE,0CAA0C,CAAC,CAAC;IAC/E,qBAAM,CAAC,8BAAsB,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,EACnD,KAAK,CAAC,kEAAkE,CAAC,CAAC;IAC9E,qBAAM,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,8BAAsB,EAClD,KAAK,CAAC,+DAA+D,CAAC,CAAC;IAE3E,qDAAsB,CAAC,OAAO,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;IAChF,qDAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,sCAAsC,CAAC,CAAC;IAC9E,qDAAsB,CAAC,OAAO,CAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;IAE5E,uCACO,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,KACxC,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,EACrC,GAAG,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,IACrC;AACN,CAAC;AAxBD,oEAwBC","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 { ISnapshotContents } from \"./odspUtils\";\nimport { ReadBuffer } from \"./ReadBufferUtils\";\nimport {\n    assertBlobCoreInstance,\n    assertBoolInstance,\n    assertNodeCoreInstance,\n    assertNumberInstance,\n    getAndValidateNodeProps,\n    NodeCore,\n    TreeBuilder,\n} from \"./zipItDataRepresentationUtils\";\n\nexport const snapshotMinReadVersion = \"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: NodeCore) {\n    const blobs: Map<string, ArrayBuffer> = new Map();\n    for (let count = 0; count < node.length; ++count) {\n        const blob = node.getNode(count);\n        const records = getAndValidateNodeProps(blob, [\"id\", \"data\"]);\n        assertBlobCoreInstance(records.data, \"data should be of BlobCore type\");\n        assertBlobCoreInstance(records.id, \"blob id should be of BlobCore type\");\n        blobs.set(records.id.toString(), 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: NodeCore) {\n    const ops: ISequencedDocumentMessage[] = [];\n    const records = getAndValidateNodeProps(node, [\"firstSequenceNumber\", \"deltas\"]);\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, 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 snapshotTree: ISnapshotTree = {\n        blobs: {},\n        commits: {},\n        trees: {},\n    };\n    for (let count = 0; count < node.length; count++) {\n        const treeNode = node.getNode(count);\n        const records = getAndValidateNodeProps(treeNode,\n            [\"name\", \"value\", \"children\", \"unreferenced\"], false);\n        assertBlobCoreInstance(records.name, \"Path should be of BlobCore\");\n        const path = records.name.toString();\n        if (records.value !== undefined) {\n            assertBlobCoreInstance(records.value, \"Blob value should be BlobCore\");\n            snapshotTree.blobs[path] = records.value.toString();\n        } else {\n            assertNodeCoreInstance(records.children, \"Trees should be of type NodeCore\");\n            snapshotTree.trees[path] = readTreeSection(records.children);\n        }\n        if (records.unreferenced !== undefined) {\n            assertBoolInstance(records.unreferenced, \"Unreferenced flag should be bool\");\n            const unreferenced = records.unreferenced.valueOf();\n            assert(unreferenced, 0x281 /* \"Unreferenced if present should be true\" */);\n            snapshotTree.unreferenced = unreferenced;\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: NodeCore): ISnapshotSection {\n    const records = getAndValidateNodeProps(node,\n        [\"id\", \"sequenceNumber\", \"treeNodes\"]);\n\n    assertNodeCoreInstance(records.treeNodes, \"TreeNodes should be of type NodeCore\");\n    assertNumberInstance(records.sequenceNumber, \"sequenceNumber should be of type number\");\n    assertBlobCoreInstance(records.id, \"snapshotId should be BlobCore\");\n    const snapshotTree: ISnapshotTree = readTreeSection(records.treeNodes);\n    snapshotTree.id = records.id.toString();\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: ReadBuffer): ISnapshotContents {\n    const builder = TreeBuilder.load(buffer);\n    assert(builder.length === 1, 0x219 /* \"1 root should be there\" */);\n    const root = builder.getNode(0);\n\n    const records = getAndValidateNodeProps(root,\n        [\"mrv\", \"cv\", \"snapshot\", \"blobs\", \"deltas\"]);\n\n    assertBlobCoreInstance(records.mrv, \"minReadVersion should be of BlobCore type\");\n    assertBlobCoreInstance(records.cv, \"createVersion should be of BlobCore type\");\n    assert(snapshotMinReadVersion >= records.mrv.toString(),\n        0x20f /* \"Driver min read version should >= to server minReadVersion\" */);\n    assert(records.cv.toString() >= snapshotMinReadVersion,\n        0x210 /* \"Snapshot should be created with minReadVersion or above\" */);\n\n    assertNodeCoreInstance(records.snapshot, \"Snapshot should be of type NodeCore\");\n    assertNodeCoreInstance(records.blobs, \"TreeBlobs should be of type NodeCore\");\n    assertNodeCoreInstance(records.deltas, \"Deltas should be of type NodeCore\");\n\n    return {\n        ...readSnapshotSection(records.snapshot),\n        blobs: readBlobSection(records.blobs),\n        ops: readOpsSection(records.deltas),\n    };\n}\n"]}
+{"version":3,"file":"compactSnapshotParser.js","sourceRoot":"","sources":["../src/compactSnapshotParser.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAItD,iFASwC;AAE3B,QAAA,sBAAsB,GAAG,KAAK,CAAC;AAC/B,QAAA,kBAAkB,GAAG,KAAK,CAAC;AAOxC;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAe;IACpC,qDAAsB,CAAC,IAAI,EAAE,sCAAsC,CAAC,CAAC;IACrE,MAAM,KAAK,GAA6B,IAAI,GAAG,EAAE,CAAC;IAClD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,sDAAuB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9D,qDAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;QACxE,qDAAsB,CAAC,OAAO,CAAC,EAAE,EAAE,oCAAoC,CAAC,CAAC;QACzE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KAC9D;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,IAAe;IACnC,qDAAsB,CAAC,IAAI,EAAE,mCAAmC,CAAC,CAAC;IAClE,MAAM,GAAG,GAAgC,EAAE,CAAC;IAC5C,MAAM,OAAO,GAAG,sDAAuB,CAAC,IAAI,EAAE,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC,CAAC;IACjF,mDAAoB,CAAC,OAAO,CAAC,mBAAmB,EAAE,+BAA+B,CAAC,CAAC;IACnF,qDAAsB,CAAC,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,qBAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACpH,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,IAAc;IACnC,MAAM,YAAY,GAAkB;QAChC,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,EAAE;KACZ,CAAC;IACF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,sDAAuB,CAAC,QAAQ,EAC5C,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1D,qDAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;YAC7B,qDAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,CAAC;YACvE,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;SACvD;aAAM;YACH,qDAAsB,CAAC,OAAO,CAAC,QAAQ,EAAE,kCAAkC,CAAC,CAAC;YAC7E,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SAChE;QACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;YACpC,iDAAkB,CAAC,OAAO,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC;YAC7E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YACpD,qBAAM,CAAC,YAAY,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAC3E,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC;SAC5C;KACJ;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,IAAe;IACxC,qDAAsB,CAAC,IAAI,EAAE,qCAAqC,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,sDAAuB,CAAC,IAAI,EACxC,CAAC,IAAI,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC,CAAC;IAE3C,qDAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;IAClF,mDAAoB,CAAC,OAAO,CAAC,cAAc,EAAE,yCAAyC,CAAC,CAAC;IACxF,qDAAsB,CAAC,OAAO,CAAC,EAAE,EAAE,+BAA+B,CAAC,CAAC;IACpE,MAAM,YAAY,GAAkB,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvE,YAAY,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;IACxC,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;IAC3D,MAAM,OAAO,GAAG,0CAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,qBAAM,CAAC,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,sDAAuB,CAAC,IAAI,EACxC,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;IAEzD,qDAAsB,CAAC,OAAO,CAAC,GAAG,EAAE,2CAA2C,CAAC,CAAC;IACjF,qDAAsB,CAAC,OAAO,CAAC,EAAE,EAAE,0CAA0C,CAAC,CAAC;IAC/E,qBAAM,CAAC,8BAAsB,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,EACnD,KAAK,CAAC,kEAAkE,CAAC,CAAC;IAC9E,qBAAM,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,8BAAsB,EAClD,KAAK,CAAC,+DAA+D,CAAC,CAAC;IAC3E,qBAAM,CAAC,0BAAkB,KAAK,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,sDAAsD,CAAC,CAAC;IAC7G,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,IACzE;AACN,CAAC;AApBD,oEAoBC","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 { ISnapshotContents } from \"./odspUtils\";\nimport { ReadBuffer } from \"./ReadBufferUtils\";\nimport {\n    assertBlobCoreInstance,\n    assertBoolInstance,\n    assertNodeCoreInstance,\n    assertNumberInstance,\n    getAndValidateNodeProps,\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 (let count = 0; count < node.length; ++count) {\n        const blob = node.getNode(count);\n        const records = getAndValidateNodeProps(blob, [\"id\", \"data\"]);\n        assertBlobCoreInstance(records.data, \"data should be of BlobCore type\");\n        assertBlobCoreInstance(records.id, \"blob id should be of BlobCore type\");\n        blobs.set(records.id.toString(), 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 = getAndValidateNodeProps(node, [\"firstSequenceNumber\", \"deltas\"]);\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, 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 snapshotTree: ISnapshotTree = {\n        blobs: {},\n        commits: {},\n        trees: {},\n    };\n    for (let count = 0; count < node.length; count++) {\n        const treeNode = node.getNode(count);\n        const records = getAndValidateNodeProps(treeNode,\n            [\"name\", \"value\", \"children\", \"unreferenced\"], false);\n        assertBlobCoreInstance(records.name, \"Path should be of BlobCore\");\n        const path = records.name.toString();\n        if (records.value !== undefined) {\n            assertBlobCoreInstance(records.value, \"Blob value should be BlobCore\");\n            snapshotTree.blobs[path] = records.value.toString();\n        } else {\n            assertNodeCoreInstance(records.children, \"Trees should be of type NodeCore\");\n            snapshotTree.trees[path] = readTreeSection(records.children);\n        }\n        if (records.unreferenced !== undefined) {\n            assertBoolInstance(records.unreferenced, \"Unreferenced flag should be bool\");\n            const unreferenced = records.unreferenced.valueOf();\n            assert(unreferenced, 0x281 /* \"Unreferenced if present should be true\" */);\n            snapshotTree.unreferenced = unreferenced;\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 = getAndValidateNodeProps(node,\n        [\"id\", \"sequenceNumber\", \"treeNodes\"]);\n\n    assertNodeCoreInstance(records.treeNodes, \"TreeNodes should be of type NodeCore\");\n    assertNumberInstance(records.sequenceNumber, \"sequenceNumber should be of type number\");\n    assertBlobCoreInstance(records.id, \"snapshotId should be BlobCore\");\n    const snapshotTree: ISnapshotTree = readTreeSection(records.treeNodes);\n    snapshotTree.id = records.id.toString();\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: ReadBuffer): ISnapshotContents {\n    const builder = TreeBuilder.load(buffer);\n    assert(builder.length === 1, 0x219 /* \"1 root should be there\" */);\n    const root = builder.getNode(0);\n\n    const records = getAndValidateNodeProps(root,\n        [\"mrv\", \"cv\", \"snapshot\", \"blobs\", \"deltas\"], false);\n\n    assertBlobCoreInstance(records.mrv, \"minReadVersion should be of BlobCore type\");\n    assertBlobCoreInstance(records.cv, \"createVersion should be of BlobCore type\");\n    assert(snapshotMinReadVersion >= records.mrv.toString(),\n        0x20f /* \"Driver min read version should >= to server minReadVersion\" */);\n    assert(records.cv.toString() >= snapshotMinReadVersion,\n        0x210 /* \"Snapshot should be created with minReadVersion or above\" */);\n    assert(currentReadVersion === records.cv.toString(), \"Create Version should be equal to currentReadVersion\");\n    return {\n        ...readSnapshotSection(records.snapshot),\n        blobs: readBlobSection(records.blobs),\n        ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [],\n    };\n}\n"]}

package/dist/epochTracker.d.ts

@@ -39,14 +39,26 @@ export declare class EpochTracker implements IPersistedFileCache {
      * @param fetchOptions - fetch options for request containing body, headers etc.
      * @param fetchType - method for which fetch is called.
      * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
      */
     fetchAndParseAsJSON<T>(url: string, fetchOptions: RequestInit, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<T>>;
+    /**
+     * Api to fetch the response for given request and parse it as json.
+     * @param url - url of the request
+     * @param fetchOptions - fetch options for request containing body, headers etc.
+     * @param fetchType - method for which fetch is called.
+     * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
+     */
+    fetch(url: string, fetchOptions: RequestInit, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<Response>>;
+    private fetchCore;
     /**
      * Api to fetch the response as it is for given request.
      * @param url - url of the request
      * @param fetchOptions - fetch options for request containing body, headers etc.
      * @param fetchType - method for which fetch is called.
      * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
      */
     fetchArray(url: string, fetchOptions: {
         [index: string]: any;

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,EAAmB,WAAW,EAAqB,MAAM,8BAA8B,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAGH,MAAM,EACN,UAAU,EACV,eAAe,EAElB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAA6D,aAAa,EAAE,MAAM,aAAa,CAAC;AACvG,OAAO,EACH,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACrB,MAAM,aAAa,CAAC;AAKtB,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;IAQhD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe;IACzC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IACxC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB;IAT/C,OAAO,CAAC,WAAW,CAAqB;IAExC,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;IAOxC,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;;;;;;OAMG;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;IA0B5B;;;;;;OAMG;IACU,UAAU,CACnB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;IA2BxB,OAAO,CAAC,iBAAiB;IAkCzB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,yBAAyB;IAQjC,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;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,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,GAAG,gBAAgB,CAU9C"}
+{"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,EAAmB,WAAW,EAAqB,MAAM,8BAA8B,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAGH,MAAM,EACN,UAAU,EACV,eAAe,EAElB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAA0E,aAAa,EAAE,MAAM,aAAa,CAAC;AACpH,OAAO,EACH,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACrB,MAAM,aAAa,CAAC;AAKtB,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;IAQhD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,eAAe;IACzC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IACxC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB;IAT/C,OAAO,CAAC,WAAW,CAAqB;IAExC,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;IAOxC,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;IAiCvB;;;;;;;OAOG;IACU,UAAU,CACnB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,SAAS,EAAE,SAAS,EACpB,SAAS,GAAE,OAAe,EAC1B,WAAW,CAAC,EAAE,MAAM;IAKxB,OAAO,CAAC,iBAAiB;IAkCzB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,yBAAyB;IAQjC,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;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EACpC,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,GAAG,gBAAgB,CAU9C"}

package/dist/epochTracker.js

@@ -135,13 +135,28 @@ class EpochTracker {
      * @param fetchOptions - fetch options for request containing body, headers etc.
      * @param fetchType - method for which fetch is called.
      * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
      */
     async fetchAndParseAsJSON(url, fetchOptions, fetchType, addInBody = false, fetchReason) {
+        return this.fetchCore(url, fetchOptions, odspUtils_1.fetchAndParseAsJSONHelper, fetchType, addInBody, fetchReason);
+    }
+    /**
+     * Api to fetch the response for given request and parse it as json.
+     * @param url - url of the request
+     * @param fetchOptions - fetch options for request containing body, headers etc.
+     * @param fetchType - method for which fetch is called.
+     * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
+     */
+    async fetch(url, fetchOptions, fetchType, addInBody = false, fetchReason) {
+        return this.fetchCore(url, fetchOptions, odspUtils_1.fetchHelper, fetchType, addInBody, fetchReason);
+    }
+    async fetchCore(url, fetchOptions, fetcher, fetchType, addInBody = false, fetchReason) {
         const clientCorrelationId = this.formatClientCorrelationId(fetchReason);
         // Add epoch in fetch request.
         this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);
         let epochFromResponse;
-        return this.rateLimiter.schedule(async () => odspUtils_1.fetchAndParseAsJSONHelper(url, fetchOptions)).then((response) => {
+        return this.rateLimiter.schedule(async () => fetcher(url, fetchOptions)).then((response) => {
             epochFromResponse = response.headers.get("x-fluid-epoch");
             this.validateEpochFromResponse(epochFromResponse, fetchType);
             response.propsToLog.XRequestStatsHeader = clientCorrelationId;
@@ -165,29 +180,10 @@ class EpochTracker {
      * @param fetchOptions - fetch options for request containing body, headers etc.
      * @param fetchType - method for which fetch is called.
      * @param addInBody - Pass True if caller wants to add epoch in post body.
+     * @param fetchReason - fetch reason to add to the request.
      */
     async fetchArray(url, fetchOptions, fetchType, addInBody = false, fetchReason) {
-        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);
-        // Add epoch in fetch request.
-        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);
-        let epochFromResponse;
-        return this.rateLimiter.schedule(async () => odspUtils_1.fetchArray(url, fetchOptions)).then((response) => {
-            epochFromResponse = response.headers.get("x-fluid-epoch");
-            this.validateEpochFromResponse(epochFromResponse, fetchType);
-            response.propsToLog.XRequestStatsHeader = clientCorrelationId;
-            return response;
-        }).catch(async (error) => {
-            // Get the server epoch from error in case we don't have it as if undefined we won't be able
-            // to mark it as epoch error.
-            if (epochFromResponse === undefined) {
-                epochFromResponse = error.serverEpoch;
-            }
-            await this.checkForEpochError(error, epochFromResponse, fetchType);
-            throw error;
-        }).catch((error) => {
-            const fluidError = telemetry_utils_1.normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId } });
-            throw fluidError;
-        });
+        return this.fetchCore(url, fetchOptions, odspUtils_1.fetchArray, fetchType, addInBody, fetchReason);
     }
     addEpochInRequest(fetchOptions, addInBody, clientCorrelationId) {
         const isClpCompliantApp = odspUtils_1.getOdspResolvedUrl(this.fileEntry.resolvedUrl).isClpCompliantApp;

package/dist/epochTracker.js.map

@@ -1 +1 @@
-{"version":3,"file":"epochTracker.js","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAClC,+DAAgE;AAEhE,+DAA+F;AAE/F,qFAOiD;AACjD,2EAAqE;AACrE,qEAAiG;AACjG,2CAAuG;AAMvG,2CAAmF;AACnF,uDAA0D;AAC1D,qDAA+D;AAOlD,QAAA,YAAY,GAAG,cAAc,CAAC;AAE3C,0GAA0G;AAC7F,QAAA,2BAA2B,GAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE3E;;;;;GAKG;AACH,MAAa,YAAY;IAOrB,YACuB,KAAsB,EACtB,SAAqB,EACrB,MAAwB;QAFxB,UAAK,GAAL,KAAK,CAAiB;QACtB,cAAS,GAAT,SAAS,CAAY;QACrB,WAAM,GAAN,MAAM,CAAkB;QAN9B,aAAQ,GAAG,SAAI,EAAE,CAAC;QACnC,8DAA8D;QACtD,sBAAiB,GAAG,CAAC,CAAC;QAM1B,sDAAsD;QACtD,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAW,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,+BAA+B;IACxB,QAAQ,CAAC,KAAa,EAAE,SAAkB,EAAE,SAA4B;QAC3E,qBAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACnE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;YACI,SAAS,EAAE,uBAAuB;YAClC,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;;QAEb,IAAI;YACA,8FAA8F;YAC9F,MAAM,KAAK,GAA6B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7F,0EAA0E;YAC1E,sCAAsC;YACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,sCAA0B,EAAE;gBACrE,OAAO,SAAS,CAAC;aACpB;YACD,qBAAM,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;YACrF,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnD,4FAA4F;gBAC5F,qCAAqC;aACpC;iBAAM,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,UAAU,EAAE;gBAC9C,OAAO,SAAS,CAAC;aACpB;YACD,gGAAgG;YAChG,wDAAwD;YACxD,IAAI,KAAK,CAAC,IAAI,KAAK,qCAAW,EAAE;gBAC5B,MAAM,SAAS,SAAG,KAAK,CAAC,KAAK,0CAAE,cAAc,CAAC;gBAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,GAAG,SAAS,IAAI,mCAA2B,EAAE;oBACnF,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;wBACI,SAAS,EAAE,0BAA0B;wBACrC,QAAQ,EAAE,WAAW,GAAG,SAAS;wBACjC,aAAa,EAAE,mCAA2B;qBAC7C,CAAC,CAAC;oBACP,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;oBAC3B,OAAO,SAAS,CAAC;iBACpB;aACJ;YACD,+DAA+D;YAC/D,OAAO,KAAK,CAAC,KAAK,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACtF,OAAO,SAAS,CAAC;SACpB;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,KAAU;;QACtC,qBAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC/D,uGAAuG;QACvG,wCAAwC;QACxC,IAAI,KAAK,CAAC,IAAI,KAAK,qCAAW,EAAE;YAC5B,KAAK,CAAC,cAAc,SAAG,KAAK,CAAC,cAAc,mCAAI,IAAI,CAAC,GAAG,EAAE,CAAC;SAC7D;QACD,MAAM,IAAI,GAA6B;YACnC,KAAK;YACL,OAAO,EAAE,sCAA0B;YACnC,UAAU,EAAE,IAAI,CAAC,WAAW;SAC/B,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;aACtD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACpF,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;IAEM,KAAK,CAAC,aAAa;QACtB,IAAI;YACA,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACzD;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,EAAE,KAAK,CAAC,CAAC;SAC1E;IACL,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,OAAmB;QAClD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,qBAAM,CAAC,KAAK,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnF,IAAI;YACA,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;SACjD;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACpD,MAAM,KAAK,CAAC;SACf;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAyB,EACzB,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxE,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAqC,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC5B,KAAK,IAAI,EAAE,CAAC,qCAAyB,CAAI,GAAG,EAAE,YAAY,CAAC,CAC9D,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC1D,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,UAAU,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;YAC9D,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,4FAA4F;YAC5F,6BAA6B;YAC7B,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,iBAAiB,GAAI,KAAoB,CAAC,WAAW,CAAC;aACzD;YACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACnE,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,UAAU,GAAG,gCAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAC;YACjG,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACnB,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxE,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAqC,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC5B,KAAK,IAAI,EAAE,CAAC,sBAAU,CAAC,GAAG,EAAE,YAAY,CAAC,CAC5C,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC1D,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,UAAU,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;YAC9D,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,4FAA4F;YAC5F,6BAA6B;YAC7B,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,iBAAiB,GAAI,KAAoB,CAAC,WAAW,CAAC;aACzD;YACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACnE,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,UAAU,GAAG,gCAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAC;YACjG,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,iBAAiB,CACrB,YAAyB,EACzB,SAAkB,EAClB,mBAA2B;QAE3B,MAAM,iBAAiB,GAAG,8BAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC;QAC3F,IAAI,SAAS,EAAE;YACX,MAAM,OAAO,GAA4B,EAAE,CAAC;YAC5C,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB,CAAC;YAChD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9C;YACD,IAAI,iBAAiB,EAAE;gBACnB,OAAO,CAAC,uCAAqB,CAAC,iBAAiB,CAAC,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;aACnF;YACD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;SAC9C;aAAM;YACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;gBAC3C,YAAY,CAAC,OAAO,qBACb,YAAY,CAAC,OAAO,CAC1B,CAAC;gBACF,qBAAM,CAAC,YAAY,CAAC,OAAO,KAAK,SAAS,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBACxF,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YACpC,CAAC,CAAC;YACF,SAAS,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;YACjD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;aAC/C;YACD,IAAI,iBAAiB,EAAE;gBACnB,SAAS,CAAC,uCAAqB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;aACpF;SACJ;IACL,CAAC;IAEO,cAAc,CAAC,YAAyB,EAAE,OAAgC;QAC9E,0EAA0E;QAC1E,wDAAwD;QACxD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC/B,qBAAM,CAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;QACpC,qBAAM,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtG,MAAM,UAAU,GAAG,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,UAAU,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;YAChC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEO,yBAAyB,CAAC,WAAoB;QAClD,MAAM,KAAK,GAAa,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE,EAAE,iBAAiB,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QACnG,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,eAAe,WAAW,EAAE,CAAC,CAAC;SAC5C;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAES,yBAAyB,CAC/B,iBAAqC,EACrC,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,MAAM,KAAK,CAAC;SACf;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;aAC1D;SACJ;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC5B,KAAc,EACd,iBAA4C,EAC5C,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,IAAI,8BAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,oCAAe,CAAC,wBAAwB,EAAE;YACrF,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;YAClE,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,UAAU,CAAC,sBAAsB,CAAC;oBAC9B,SAAS;oBACT,WAAW,EAAE,IAAI,CAAC,UAAU;oBAC5B,SAAS;iBACZ,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,UAAU,CAAC,CAAC;gBAClF,kFAAkF;gBAClF,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,MAAM,UAAU,CAAC;aACpB;YACD,wGAAwG;YACxG,0GAA0G;YAC1G,cAAc;YACd,MAAM,IAAI,8BAAe,CACrB,kBAAkB,KAAK,CAAC,OAAO,EAAE,EACjC,CAAC,CAAC,uBAAuB,EACzB,EAAE,CAAC,oBAAY,CAAC,EAAE,IAAI,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;SAChD;IACL,CAAC;IAEO,sBAAsB,CAAC,iBAA4C;QACvE,8FAA8F;QAC9F,sFAAsF;QACtF,iGAAiG;QACjG,IAAI,IAAI,CAAC,UAAU,IAAI,iBAAiB,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,iBAAiB,CAAC,EAAE;YACjF,6EAA6E;YAC7E,yEAAyE;YACzE,OAAO,IAAI,gCAAiB,CACxB,gBAAgB,EAAE,oCAAe,CAAC,wBAAwB,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;SACtF;IACL,CAAC;IAEO,kBAAkB,CAAC,KAAa;QACpC,uCAAY,KAAK,KAAE,IAAI,EAAE,IAAI,CAAC,SAAS,IAAG;IAC9C,CAAC;CACJ;AA1TD,oCA0TC;AAED,MAAa,0BAA2B,SAAQ,YAAY;IAA5D;;QACqB,wBAAmB,GAAG,IAAI,uBAAQ,EAAQ,CAAC;IA8FhE,CAAC;IA5Fa,yBAAyB,CAC/B,iBAAqC,EACrC,SAAoB,EACpB,YAAqB,KAAK;QAE1B,KAAK,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAEzE,8GAA8G;QAC9G,0GAA0G;QAC1G,oBAAoB;QACpB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;QAEb,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE9B,uDAAuD;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,qCAAW,EAAE;YAC5B,MAAM,GAAG,MAAM;iBACV,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACZ,iGAAiG;gBACjG,8FAA8F;gBAC9F,IAAI,KAAK,KAAK,SAAS,EAAE;oBACrB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;iBACtC;gBACD,+DAA+D;gBAC/D,OAAO,KAAK,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACb,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvC,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;SACV;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,sGAAsG;QACtG,uGAAuG;QACvG,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC;QAEvD,IAAI;YACA,OAAO,MAAM,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;SACnG;QAAC,OAAO,KAAK,EAAE;YACZ,+FAA+F;YAC/F,8EAA8E;YAC9E,8EAA8E;YAC9E,IAAI,SAAS,KAAK,aAAa,EAAE;gBAC7B,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC1C;YACD,IAAI,SAAS,KAAK,aAAa,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,SAAS,EAAE;gBAC9F,MAAM,KAAK,CAAC;aACf;SACJ;QAED,gDAAgD;QAChD,yEAAyE;QACzE,wFAAwF;QAExF,gGAAgG;QAChG,wEAAwE;QACxE,+EAA+E;QAC/E,wGAAwG;QACxG,0BAA0B;QAC1B,MAAM,kCAAgB,CAAC,cAAc,CACjC,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,qBAAqB,EAAE,EACpC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,0BAA0B;YACjD,IAAI,KAAoC,CAAC;YACzC,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;gBAC7C,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;gBAC3B,QAAQ;gBACR,kFAAkF;gBAClF,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;aAAC,CAAC,CAAC;YAC1E,IAAI,GAAG,KAAK,UAAU,EAAE;gBACpB,KAAK,CAAC,MAAM,EAAE,CAAC;aAClB;QACL,CAAC,EACD,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACjF,CAAC;CACJ;AA/FD,gEA+FC;AAOD,SAAgB,yBAAyB,CACrC,iBAAkC,EAClC,kBAAuC,EACvC,SAAqB,EACrB,MAAwB;IAExB,MAAM,YAAY,GAAG,IAAI,0BAA0B,CAAC,iBAAiB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,OAAO;QACH,KAAK,kCACE,kBAAkB,KACrB,cAAc,EAAE,YAAY,GAC/B;QACD,YAAY;KACf,CAAC;AACN,CAAC;AAdD,8DAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ThrottlingError, RateLimiter, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { IConnected } from \"@fluidframework/protocol-definitions\";\nimport {\n    snapshotKey,\n    ICacheEntry,\n    IEntry,\n    IFileEntry,\n    IPersistedCache,\n    IOdspError,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { PerformanceEvent, isFluidError, normalizeError } from \"@fluidframework/telemetry-utils\";\nimport { fetchAndParseAsJSONHelper, fetchArray, getOdspResolvedUrl, IOdspResponse } from \"./odspUtils\";\nimport {\n    IOdspCache,\n    INonPersistentCache,\n    IPersistedFileCache,\n } from \"./odspCache\";\nimport { IVersionedValueWithEpoch, persistedCacheValueVersion } from \"./contracts\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\nexport type FetchType = \"blob\" | \"createBlob\" | \"createFile\" | \"joinSession\" | \"ops\" | \"test\" | \"snapshotTree\" |\n    \"treesLatest\" | \"uploadSummary\" | \"push\" | \"versions\";\n\nexport type FetchTypeInternal = FetchType | \"cache\";\n\nexport const Odsp409Error = \"Odsp409Error\";\n\n// Please update the README file in odsp-driver-definitions if you change the defaultCacheExpiryTimeoutMs.\nexport const defaultCacheExpiryTimeoutMs: number = 2 * 24 * 60 * 60 * 1000;\n\n/**\n * This class is a wrapper around fetch calls. It adds epoch to the request made so that the\n * server can match it with its epoch value in order to match the version.\n * It also validates the epoch value received in response of fetch calls. If the epoch does not match,\n * then it also clears all the cached entries for the given container.\n */\nexport class EpochTracker implements IPersistedFileCache {\n    private _fluidEpoch: string | undefined;\n\n    public readonly rateLimiter: RateLimiter;\n    private readonly driverId = uuid();\n    // This tracks the request number made by the driver instance.\n    private networkCallNumber = 1;\n    constructor(\n        protected readonly cache: IPersistedCache,\n        protected readonly fileEntry: IFileEntry,\n        protected readonly logger: ITelemetryLogger,\n    ) {\n        // Limits the max number of concurrent requests to 24.\n        this.rateLimiter = new RateLimiter(24);\n    }\n\n    // public for UT purposes only!\n    public setEpoch(epoch: string, fromCache: boolean, fetchType: FetchTypeInternal) {\n        assert(this._fluidEpoch === undefined, 0x1db /* \"epoch exists\" */);\n        this._fluidEpoch = epoch;\n\n        this.logger.sendTelemetryEvent(\n            {\n                eventName: \"EpochLearnedFirstTime\",\n                epoch,\n                fetchType,\n                fromCache,\n            },\n        );\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        try {\n            // Return undefined so that the ops/snapshots are grabbed from the server instead of the cache\n            const value: IVersionedValueWithEpoch = await this.cache.get(this.fileEntryFromEntry(entry));\n            // Version mismatch between what the runtime expects and what it recieved.\n            // The cached value should not be used\n            if (value === undefined || value.version !== persistedCacheValueVersion) {\n                return undefined;\n            }\n            assert(value.fluidEpoch !== undefined, 0x1dc /* \"all entries have to have epoch\" */);\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(value.fluidEpoch, true, \"cache\");\n            // Epoch mismatch, the cached value is considerably different from what the current state of\n            // the runtime and should not be used\n            } else if (this._fluidEpoch !== value.fluidEpoch) {\n                return undefined;\n            }\n            // Expire the cached snapshot if it's older than the defaultCacheExpiryTimeoutMs and immediately\n            // expire all old caches that do not have cacheEntryTime\n            if (entry.type === snapshotKey) {\n                const cacheTime = value.value?.cacheEntryTime;\n                const currentTime = Date.now();\n                if (cacheTime === undefined || currentTime - cacheTime >= defaultCacheExpiryTimeoutMs) {\n                    this.logger.sendTelemetryEvent(\n                        {\n                            eventName: \"odspVersionsCacheExpired\",\n                            duration: currentTime - cacheTime,\n                            maxCacheAgeMs: defaultCacheExpiryTimeoutMs,\n                        });\n                    await this.removeEntries();\n                    return undefined;\n                }\n            }\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return value.value;\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"cacheFetchError\", type: entry.type }, error);\n            return undefined;\n        }\n    }\n\n    public async put(entry: IEntry, value: any) {\n        assert(this._fluidEpoch !== undefined, 0x1dd /* \"no epoch\" */);\n        // For snapshots, the value should have the cacheEntryTime. This will be used to expire snapshots older\n        // than the defaultCacheExpiryTimeoutMs.\n        if (entry.type === snapshotKey) {\n            value.cacheEntryTime = value.cacheEntryTime ?? Date.now();\n        }\n        const data: IVersionedValueWithEpoch = {\n            value,\n            version: persistedCacheValueVersion,\n            fluidEpoch: this._fluidEpoch,\n        };\n        return this.cache.put(this.fileEntryFromEntry(entry), data)\n            .catch((error) => {\n                this.logger.sendErrorEvent({ eventName: \"cachePutError\", type: entry.type }, error);\n                throw error;\n            });\n    }\n\n    public async removeEntries(): Promise<void> {\n        try {\n            return await this.cache.removeEntries(this.fileEntry);\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"removeCacheEntries\" }, error);\n        }\n    }\n\n    public get fluidEpoch() {\n        return this._fluidEpoch;\n    }\n\n    public async validateEpochFromPush(details: IConnected) {\n        const epoch = details.epoch;\n        assert(epoch !== undefined, 0x09d /* \"Connection details should contain epoch\" */);\n        try {\n            this.validateEpochFromResponse(epoch, \"push\");\n        } catch (error) {\n            await this.checkForEpochError(error, epoch, \"push\");\n            throw error;\n        }\n    }\n\n    /**\n     * Api to fetch the response for given request and parse it as json.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     */\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: RequestInit,\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);\n        // Add epoch in fetch request.\n        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);\n        let epochFromResponse: string | undefined;\n        return this.rateLimiter.schedule(\n            async () => fetchAndParseAsJSONHelper<T>(url, fetchOptions),\n        ).then((response) => {\n            epochFromResponse = response.headers.get(\"x-fluid-epoch\");\n            this.validateEpochFromResponse(epochFromResponse, fetchType);\n            response.propsToLog.XRequestStatsHeader = clientCorrelationId;\n            return response;\n        }).catch(async (error) => {\n            // Get the server epoch from error in case we don't have it as if undefined we won't be able\n            // to mark it as epoch error.\n            if (epochFromResponse === undefined) {\n                epochFromResponse = (error as IOdspError).serverEpoch;\n            }\n            await this.checkForEpochError(error, epochFromResponse, fetchType);\n            throw error;\n        }).catch((error) => {\n            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});\n            throw fluidError;\n        });\n    }\n\n    /**\n     * Api to fetch the response as it is for given request.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     */\n    public async fetchArray(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ) {\n        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);\n        // Add epoch in fetch request.\n        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);\n        let epochFromResponse: string | undefined;\n        return this.rateLimiter.schedule(\n            async () => fetchArray(url, fetchOptions),\n        ).then((response) => {\n            epochFromResponse = response.headers.get(\"x-fluid-epoch\");\n            this.validateEpochFromResponse(epochFromResponse, fetchType);\n            response.propsToLog.XRequestStatsHeader = clientCorrelationId;\n            return response;\n        }).catch(async (error) => {\n            // Get the server epoch from error in case we don't have it as if undefined we won't be able\n            // to mark it as epoch error.\n            if (epochFromResponse === undefined) {\n                epochFromResponse = (error as IOdspError).serverEpoch;\n            }\n            await this.checkForEpochError(error, epochFromResponse, fetchType);\n            throw error;\n        }).catch((error) => {\n            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});\n            throw fluidError;\n        });\n    }\n\n    private addEpochInRequest(\n        fetchOptions: RequestInit,\n        addInBody: boolean,\n        clientCorrelationId: string,\n    ) {\n        const isClpCompliantApp = getOdspResolvedUrl(this.fileEntry.resolvedUrl).isClpCompliantApp;\n        if (addInBody) {\n            const headers: {[key: string]: string} = {};\n            headers[\"X-RequestStats\"] = clientCorrelationId;\n            if (this.fluidEpoch !== undefined) {\n                headers[\"x-fluid-epoch\"] = this.fluidEpoch;\n            }\n            if (isClpCompliantApp) {\n                headers[ClpCompliantAppHeader.isClpCompliantApp] = isClpCompliantApp.toString();\n            }\n            this.addParamInBody(fetchOptions, headers);\n        } else {\n            const addHeader = (key: string, val: string) => {\n                fetchOptions.headers = {\n                    ...fetchOptions.headers,\n                };\n                assert(fetchOptions.headers !== undefined, 0x282 /* \"Headers should be present now\" */);\n                fetchOptions.headers[key] = val;\n            };\n            addHeader(\"X-RequestStats\", clientCorrelationId);\n            if (this.fluidEpoch !== undefined) {\n                addHeader(\"x-fluid-epoch\", this.fluidEpoch);\n            }\n            if (isClpCompliantApp) {\n                addHeader(ClpCompliantAppHeader.isClpCompliantApp, isClpCompliantApp.toString());\n            }\n        }\n    }\n\n    private addParamInBody(fetchOptions: RequestInit, headers: {[key: string]: string}) {\n        // We use multi part form request for post body where we want to use this.\n        // So extract the form boundary to mark the end of form.\n        const body = fetchOptions.body;\n        assert(typeof body === \"string\", 0x21d /* \"body is not string\" */);\n        const splitBody = body.split(\"\\r\\n\");\n        const firstLine = splitBody.shift();\n        assert(firstLine !== undefined && firstLine.startsWith(\"--\"), 0x21e /* \"improper boundary format\" */);\n        const formParams = [firstLine];\n        Object.entries(headers).forEach(([key, value]) => {\n            formParams.push(`${key}: ${value}`);\n        });\n        splitBody.forEach((value: string) => {\n            formParams.push(value);\n        });\n        fetchOptions.body = formParams.join(\"\\r\\n\");\n    }\n\n    private formatClientCorrelationId(fetchReason?: string) {\n        const items: string[] = [`driverId=${this.driverId}`, `RequestNumber=${this.networkCallNumber++}`];\n        if (fetchReason !== undefined) {\n            items.push(`fetchReason=${fetchReason}`);\n        }\n        return items.join(\", \");\n    }\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        const error = this.checkForEpochErrorCore(epochFromResponse);\n        if (error !== undefined) {\n            throw error;\n        }\n        if (epochFromResponse !== undefined) {\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(epochFromResponse, fromCache, fetchType);\n            }\n        }\n    }\n\n    private async checkForEpochError(\n        error: unknown,\n        epochFromResponse: string | null | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        if (isFluidError(error) && error.errorType === DriverErrorType.fileOverwrittenInStorage) {\n            const epochError = this.checkForEpochErrorCore(epochFromResponse);\n            if (epochError !== undefined) {\n                epochError.addTelemetryProperties({\n                    fromCache,\n                    clientEpoch: this.fluidEpoch,\n                    fetchType,\n                });\n                this.logger.sendErrorEvent({ eventName: \"fileOverwrittenInStorage\" }, epochError);\n                // If the epoch mismatches, then clear all entries for such file entry from cache.\n                await this.removeEntries();\n                throw epochError;\n            }\n            // If it was categorized as epoch error but the epoch returned in response matches with the client epoch\n            // then it was coherency 409, so rethrow it as throttling error so that it can retried. Default throttling\n            // time is 1s.\n            throw new ThrottlingError(\n                `Coherency 409: ${error.message}`,\n                1 /* retryAfterSeconds */,\n                { [Odsp409Error]: true, driverVersion });\n        }\n    }\n\n    private checkForEpochErrorCore(epochFromResponse: string | null | undefined) {\n        // If epoch is undefined, then don't compare it because initially for createNew or TreesLatest\n        // initializes this value. Sometimes response does not contain epoch as it is still in\n        // implementation phase at server side. In that case also, don't compare it with our epoch value.\n        if (this.fluidEpoch && epochFromResponse && (this.fluidEpoch !== epochFromResponse)) {\n            // This is similar in nature to how fluidEpochMismatchError (409) is handled.\n            // Difference - client detected mismatch, instead of server detecting it.\n            return new NonRetryableError(\n                \"Epoch mismatch\", DriverErrorType.fileOverwrittenInStorage, { driverVersion });\n        }\n    }\n\n    private fileEntryFromEntry(entry: IEntry): ICacheEntry {\n        return { ...entry, file: this.fileEntry };\n    }\n}\n\nexport class EpochTrackerWithRedemption extends EpochTracker {\n    private readonly treesLatestDeferral = new Deferred<void>();\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchType,\n        fromCache: boolean = false,\n    ) {\n        super.validateEpochFromResponse(epochFromResponse, fetchType, fromCache);\n\n        // Any successful call means we have access to a file, i.e. any redemption that was required already happened.\n        // That covers cases of \"treesLatest\" as well as \"getVersions\" or \"createFile\" - all the ways we can start\n        // exploring a file.\n        this.treesLatestDeferral.resolve();\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        let result = super.get(entry);\n\n        // equivalence of what happens in fetchAndParseAsJSON()\n        if (entry.type === snapshotKey) {\n            result = result\n                .then((value) => {\n                    // If there is nothing in cache, we need to wait for network call to complete (and do redemption)\n                    // Otherwise file was redeemed in prior session, so if joinSession failed, we should not retry\n                    if (value !== undefined) {\n                        this.treesLatestDeferral.resolve();\n                    }\n                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n                    return value;\n                })\n                .catch((error) => {\n                    this.treesLatestDeferral.reject(error);\n                    throw error;\n                });\n        }\n        return result;\n    }\n\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        // Optimize the flow if we know that treesLatestDeferral was already completed by the timer we started\n        // joinSession call. If we did - there is no reason to repeat the call as it will fail with same error.\n        const completed = this.treesLatestDeferral.isCompleted;\n\n        try {\n            return await super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody, fetchReason);\n        } catch (error) {\n            // Only handling here treesLatest. If createFile failed, we should never try to do joinSession.\n            // Similar, if getVersions failed, we should not do any further storage calls.\n            // So treesLatest is the only call that can have parallel joinSession request.\n            if (fetchType === \"treesLatest\") {\n                this.treesLatestDeferral.reject(error);\n            }\n            if (fetchType !== \"joinSession\" || error.statusCode < 401 || error.statusCode > 404 || completed) {\n                throw error;\n            }\n        }\n\n        // It is joinSession failing with 401..404 error\n        // Repeat after waiting for treeLatest succeeding (or fail if it failed).\n        // No special handling after first call - if file has been deleted, then it's game over.\n\n        // Ensure we have some safety here - we do not want to deadlock if we got logic somewhere wrong.\n        // If we waited too long, we will log error event and proceed with call.\n        // It may result in failure for user, but refreshing document would address it.\n        // Thus we use rather long timeout (not to get these failures as much as possible), but not large enough\n        // to unblock the process.\n        await PerformanceEvent.timedExecAsync(\n            this.logger,\n            { eventName: \"JoinSessionSyncWait\" },\n            async (event) => {\n                const timeoutRes = 51; // anything will work here\n                let timer: ReturnType<typeof setTimeout>;\n                const timeoutP = new Promise<number>((resolve) => {\n                    timer = setTimeout(() => { resolve(timeoutRes); }, 15000);\n                });\n                const res = await Promise.race([\n                    timeoutP,\n                    // cancel timeout to unblock UTs (otherwise Node process does not exit for 15 sec)\n                    this.treesLatestDeferral.promise.finally(() => clearTimeout(timer))]);\n                if (res === timeoutRes) {\n                    event.cancel();\n                }\n            },\n            { start: true, end: true, cancel: \"generic\" });\n        return super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody);\n    }\n}\n\nexport interface ICacheAndTracker {\n    cache: IOdspCache;\n    epochTracker: EpochTracker;\n}\n\nexport function createOdspCacheAndTracker(\n    persistedCacheArg: IPersistedCache,\n    nonpersistentCache: INonPersistentCache,\n    fileEntry: IFileEntry,\n    logger: ITelemetryLogger): ICacheAndTracker\n{\n    const epochTracker = new EpochTrackerWithRedemption(persistedCacheArg, fileEntry, logger);\n    return {\n        cache: {\n            ...nonpersistentCache,\n            persistedCache: epochTracker,\n        },\n        epochTracker,\n    };\n}\n"]}
+{"version":3,"file":"epochTracker.js","sourceRoot":"","sources":["../src/epochTracker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAClC,+DAAgE;AAEhE,+DAA+F;AAE/F,qFAOiD;AACjD,2EAAqE;AACrE,qEAAiG;AACjG,2CAAoH;AAMpH,2CAAmF;AACnF,uDAA0D;AAC1D,qDAA+D;AAOlD,QAAA,YAAY,GAAG,cAAc,CAAC;AAE3C,0GAA0G;AAC7F,QAAA,2BAA2B,GAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE3E;;;;;GAKG;AACH,MAAa,YAAY;IAOrB,YACuB,KAAsB,EACtB,SAAqB,EACrB,MAAwB;QAFxB,UAAK,GAAL,KAAK,CAAiB;QACtB,cAAS,GAAT,SAAS,CAAY;QACrB,WAAM,GAAN,MAAM,CAAkB;QAN9B,aAAQ,GAAG,SAAI,EAAE,CAAC;QACnC,8DAA8D;QACtD,sBAAiB,GAAG,CAAC,CAAC;QAM1B,sDAAsD;QACtD,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAW,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,+BAA+B;IACxB,QAAQ,CAAC,KAAa,EAAE,SAAkB,EAAE,SAA4B;QAC3E,qBAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACnE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;YACI,SAAS,EAAE,uBAAuB;YAClC,KAAK;YACL,SAAS;YACT,SAAS;SACZ,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;;QAEb,IAAI;YACA,8FAA8F;YAC9F,MAAM,KAAK,GAA6B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7F,0EAA0E;YAC1E,sCAAsC;YACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,sCAA0B,EAAE;gBACrE,OAAO,SAAS,CAAC;aACpB;YACD,qBAAM,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;YACrF,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnD,4FAA4F;gBAC5F,qCAAqC;aACpC;iBAAM,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,UAAU,EAAE;gBAC9C,OAAO,SAAS,CAAC;aACpB;YACD,gGAAgG;YAChG,wDAAwD;YACxD,IAAI,KAAK,CAAC,IAAI,KAAK,qCAAW,EAAE;gBAC5B,MAAM,SAAS,SAAG,KAAK,CAAC,KAAK,0CAAE,cAAc,CAAC;gBAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,GAAG,SAAS,IAAI,mCAA2B,EAAE;oBACnF,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B;wBACI,SAAS,EAAE,0BAA0B;wBACrC,QAAQ,EAAE,WAAW,GAAG,SAAS;wBACjC,aAAa,EAAE,mCAA2B;qBAC7C,CAAC,CAAC;oBACP,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;oBAC3B,OAAO,SAAS,CAAC;iBACpB;aACJ;YACD,+DAA+D;YAC/D,OAAO,KAAK,CAAC,KAAK,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACtF,OAAO,SAAS,CAAC;SACpB;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,KAAU;;QACtC,qBAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC/D,uGAAuG;QACvG,wCAAwC;QACxC,IAAI,KAAK,CAAC,IAAI,KAAK,qCAAW,EAAE;YAC5B,KAAK,CAAC,cAAc,SAAG,KAAK,CAAC,cAAc,mCAAI,IAAI,CAAC,GAAG,EAAE,CAAC;SAC7D;QACD,MAAM,IAAI,GAA6B;YACnC,KAAK;YACL,OAAO,EAAE,sCAA0B;YACnC,UAAU,EAAE,IAAI,CAAC,WAAW;SAC/B,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;aACtD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YACpF,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;IAEM,KAAK,CAAC,aAAa;QACtB,IAAI;YACA,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACzD;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,EAAE,KAAK,CAAC,CAAC;SAC1E;IACL,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,OAAmB;QAClD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,qBAAM,CAAC,KAAK,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnF,IAAI;YACA,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;SACjD;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACpD,MAAM,KAAK,CAAC;SACf;IACL,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAyB,EACzB,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,OAAO,IAAI,CAAC,SAAS,CAAI,GAAG,EAAE,YAAY,EAAE,qCAAyB,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IAC9G,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CACd,GAAW,EACX,YAAyB,EACzB,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,OAAO,IAAI,CAAC,SAAS,CAAW,GAAG,EAAE,YAAY,EAAE,uBAAW,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IACvG,CAAC;IAEO,KAAK,CAAC,SAAS,CACnB,GAAW,EACX,YAAoC,EACpC,OAAyF,EACzF,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxE,8BAA8B;QAC9B,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAqC,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC5B,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,CAAC,CACzC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC1D,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,UAAU,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;YAC9D,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,4FAA4F;YAC5F,6BAA6B;YAC7B,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,iBAAiB,GAAI,KAAoB,CAAC,WAAW,CAAC;aACzD;YACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACnE,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,UAAU,GAAG,gCAAc,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAC;YACjG,MAAM,UAAU,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CACnB,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,OAAO,IAAI,CAAC,SAAS,CAAc,GAAG,EAAE,YAAY,EAAE,sBAAU,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IACzG,CAAC;IAEO,iBAAiB,CACrB,YAAyB,EACzB,SAAkB,EAClB,mBAA2B;QAE3B,MAAM,iBAAiB,GAAG,8BAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC;QAC3F,IAAI,SAAS,EAAE;YACX,MAAM,OAAO,GAA4B,EAAE,CAAC;YAC5C,OAAO,CAAC,gBAAgB,CAAC,GAAG,mBAAmB,CAAC;YAChD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9C;YACD,IAAI,iBAAiB,EAAE;gBACnB,OAAO,CAAC,uCAAqB,CAAC,iBAAiB,CAAC,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;aACnF;YACD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;SAC9C;aAAM;YACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;gBAC3C,YAAY,CAAC,OAAO,qBACb,YAAY,CAAC,OAAO,CAC1B,CAAC;gBACF,qBAAM,CAAC,YAAY,CAAC,OAAO,KAAK,SAAS,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBACxF,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YACpC,CAAC,CAAC;YACF,SAAS,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;YACjD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC/B,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;aAC/C;YACD,IAAI,iBAAiB,EAAE;gBACnB,SAAS,CAAC,uCAAqB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;aACpF;SACJ;IACL,CAAC;IAEO,cAAc,CAAC,YAAyB,EAAE,OAAgC;QAC9E,0EAA0E;QAC1E,wDAAwD;QACxD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC/B,qBAAM,CAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;QACpC,qBAAM,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtG,MAAM,UAAU,GAAG,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,UAAU,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;YAChC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEO,yBAAyB,CAAC,WAAoB;QAClD,MAAM,KAAK,GAAa,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE,EAAE,iBAAiB,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QACnG,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,eAAe,WAAW,EAAE,CAAC,CAAC;SAC5C;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAES,yBAAyB,CAC/B,iBAAqC,EACrC,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,MAAM,KAAK,CAAC;SACf;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;aAC1D;SACJ;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC5B,KAAc,EACd,iBAA4C,EAC5C,SAA4B,EAC5B,YAAqB,KAAK;QAE1B,IAAI,8BAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,oCAAe,CAAC,wBAAwB,EAAE;YACrF,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;YAClE,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,UAAU,CAAC,sBAAsB,CAAC;oBAC9B,SAAS;oBACT,WAAW,EAAE,IAAI,CAAC,UAAU;oBAC5B,SAAS;iBACZ,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,UAAU,CAAC,CAAC;gBAClF,kFAAkF;gBAClF,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,MAAM,UAAU,CAAC;aACpB;YACD,wGAAwG;YACxG,0GAA0G;YAC1G,cAAc;YACd,MAAM,IAAI,8BAAe,CACrB,kBAAkB,KAAK,CAAC,OAAO,EAAE,EACjC,CAAC,CAAC,uBAAuB,EACzB,EAAE,CAAC,oBAAY,CAAC,EAAE,IAAI,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;SAChD;IACL,CAAC;IAEO,sBAAsB,CAAC,iBAA4C;QACvE,8FAA8F;QAC9F,sFAAsF;QACtF,iGAAiG;QACjG,IAAI,IAAI,CAAC,UAAU,IAAI,iBAAiB,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,iBAAiB,CAAC,EAAE;YACjF,6EAA6E;YAC7E,yEAAyE;YACzE,OAAO,IAAI,gCAAiB,CACxB,gBAAgB,EAAE,oCAAe,CAAC,wBAAwB,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;SACtF;IACL,CAAC;IAEO,kBAAkB,CAAC,KAAa;QACpC,uCAAY,KAAK,KAAE,IAAI,EAAE,IAAI,CAAC,SAAS,IAAG;IAC9C,CAAC;CACJ;AAnUD,oCAmUC;AAED,MAAa,0BAA2B,SAAQ,YAAY;IAA5D;;QACqB,wBAAmB,GAAG,IAAI,uBAAQ,EAAQ,CAAC;IA8FhE,CAAC;IA5Fa,yBAAyB,CAC/B,iBAAqC,EACrC,SAAoB,EACpB,YAAqB,KAAK;QAE1B,KAAK,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAEzE,8GAA8G;QAC9G,0GAA0G;QAC1G,oBAAoB;QACpB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,GAAG,CACZ,KAAa;QAEb,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE9B,uDAAuD;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,qCAAW,EAAE;YAC5B,MAAM,GAAG,MAAM;iBACV,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACZ,iGAAiG;gBACjG,8FAA8F;gBAC9F,IAAI,KAAK,KAAK,SAAS,EAAE;oBACrB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;iBACtC;gBACD,+DAA+D;gBAC/D,OAAO,KAAK,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACb,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvC,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;SACV;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC5B,GAAW,EACX,YAAoC,EACpC,SAAoB,EACpB,YAAqB,KAAK,EAC1B,WAAoB;QAEpB,sGAAsG;QACtG,uGAAuG;QACvG,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC;QAEvD,IAAI;YACA,OAAO,MAAM,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;SACnG;QAAC,OAAO,KAAK,EAAE;YACZ,+FAA+F;YAC/F,8EAA8E;YAC9E,8EAA8E;YAC9E,IAAI,SAAS,KAAK,aAAa,EAAE;gBAC7B,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC1C;YACD,IAAI,SAAS,KAAK,aAAa,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,SAAS,EAAE;gBAC9F,MAAM,KAAK,CAAC;aACf;SACJ;QAED,gDAAgD;QAChD,yEAAyE;QACzE,wFAAwF;QAExF,gGAAgG;QAChG,wEAAwE;QACxE,+EAA+E;QAC/E,wGAAwG;QACxG,0BAA0B;QAC1B,MAAM,kCAAgB,CAAC,cAAc,CACjC,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,qBAAqB,EAAE,EACpC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,0BAA0B;YACjD,IAAI,KAAoC,CAAC;YACzC,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;gBAC7C,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;gBAC3B,QAAQ;gBACR,kFAAkF;gBAClF,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;aAAC,CAAC,CAAC;YAC1E,IAAI,GAAG,KAAK,UAAU,EAAE;gBACpB,KAAK,CAAC,MAAM,EAAE,CAAC;aAClB;QACL,CAAC,EACD,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC,mBAAmB,CAAI,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACjF,CAAC;CACJ;AA/FD,gEA+FC;AAOD,SAAgB,yBAAyB,CACrC,iBAAkC,EAClC,kBAAuC,EACvC,SAAqB,EACrB,MAAwB;IAExB,MAAM,YAAY,GAAG,IAAI,0BAA0B,CAAC,iBAAiB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,OAAO;QACH,KAAK,kCACE,kBAAkB,KACrB,cAAc,EAAE,YAAY,GAC/B;QACD,YAAY;KACf,CAAC;AACN,CAAC;AAdD,8DAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ThrottlingError, RateLimiter, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { IConnected } from \"@fluidframework/protocol-definitions\";\nimport {\n    snapshotKey,\n    ICacheEntry,\n    IEntry,\n    IFileEntry,\n    IPersistedCache,\n    IOdspError,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { PerformanceEvent, isFluidError, normalizeError } from \"@fluidframework/telemetry-utils\";\nimport { fetchAndParseAsJSONHelper, fetchArray, fetchHelper, getOdspResolvedUrl, IOdspResponse } from \"./odspUtils\";\nimport {\n    IOdspCache,\n    INonPersistentCache,\n    IPersistedFileCache,\n } from \"./odspCache\";\nimport { IVersionedValueWithEpoch, persistedCacheValueVersion } from \"./contracts\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\nexport type FetchType = \"blob\" | \"createBlob\" | \"createFile\" | \"joinSession\" | \"ops\" | \"test\" | \"snapshotTree\" |\n    \"treesLatest\" | \"uploadSummary\" | \"push\" | \"versions\";\n\nexport type FetchTypeInternal = FetchType | \"cache\";\n\nexport const Odsp409Error = \"Odsp409Error\";\n\n// Please update the README file in odsp-driver-definitions if you change the defaultCacheExpiryTimeoutMs.\nexport const defaultCacheExpiryTimeoutMs: number = 2 * 24 * 60 * 60 * 1000;\n\n/**\n * This class is a wrapper around fetch calls. It adds epoch to the request made so that the\n * server can match it with its epoch value in order to match the version.\n * It also validates the epoch value received in response of fetch calls. If the epoch does not match,\n * then it also clears all the cached entries for the given container.\n */\nexport class EpochTracker implements IPersistedFileCache {\n    private _fluidEpoch: string | undefined;\n\n    public readonly rateLimiter: RateLimiter;\n    private readonly driverId = uuid();\n    // This tracks the request number made by the driver instance.\n    private networkCallNumber = 1;\n    constructor(\n        protected readonly cache: IPersistedCache,\n        protected readonly fileEntry: IFileEntry,\n        protected readonly logger: ITelemetryLogger,\n    ) {\n        // Limits the max number of concurrent requests to 24.\n        this.rateLimiter = new RateLimiter(24);\n    }\n\n    // public for UT purposes only!\n    public setEpoch(epoch: string, fromCache: boolean, fetchType: FetchTypeInternal) {\n        assert(this._fluidEpoch === undefined, 0x1db /* \"epoch exists\" */);\n        this._fluidEpoch = epoch;\n\n        this.logger.sendTelemetryEvent(\n            {\n                eventName: \"EpochLearnedFirstTime\",\n                epoch,\n                fetchType,\n                fromCache,\n            },\n        );\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        try {\n            // Return undefined so that the ops/snapshots are grabbed from the server instead of the cache\n            const value: IVersionedValueWithEpoch = await this.cache.get(this.fileEntryFromEntry(entry));\n            // Version mismatch between what the runtime expects and what it recieved.\n            // The cached value should not be used\n            if (value === undefined || value.version !== persistedCacheValueVersion) {\n                return undefined;\n            }\n            assert(value.fluidEpoch !== undefined, 0x1dc /* \"all entries have to have epoch\" */);\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(value.fluidEpoch, true, \"cache\");\n            // Epoch mismatch, the cached value is considerably different from what the current state of\n            // the runtime and should not be used\n            } else if (this._fluidEpoch !== value.fluidEpoch) {\n                return undefined;\n            }\n            // Expire the cached snapshot if it's older than the defaultCacheExpiryTimeoutMs and immediately\n            // expire all old caches that do not have cacheEntryTime\n            if (entry.type === snapshotKey) {\n                const cacheTime = value.value?.cacheEntryTime;\n                const currentTime = Date.now();\n                if (cacheTime === undefined || currentTime - cacheTime >= defaultCacheExpiryTimeoutMs) {\n                    this.logger.sendTelemetryEvent(\n                        {\n                            eventName: \"odspVersionsCacheExpired\",\n                            duration: currentTime - cacheTime,\n                            maxCacheAgeMs: defaultCacheExpiryTimeoutMs,\n                        });\n                    await this.removeEntries();\n                    return undefined;\n                }\n            }\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return value.value;\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"cacheFetchError\", type: entry.type }, error);\n            return undefined;\n        }\n    }\n\n    public async put(entry: IEntry, value: any) {\n        assert(this._fluidEpoch !== undefined, 0x1dd /* \"no epoch\" */);\n        // For snapshots, the value should have the cacheEntryTime. This will be used to expire snapshots older\n        // than the defaultCacheExpiryTimeoutMs.\n        if (entry.type === snapshotKey) {\n            value.cacheEntryTime = value.cacheEntryTime ?? Date.now();\n        }\n        const data: IVersionedValueWithEpoch = {\n            value,\n            version: persistedCacheValueVersion,\n            fluidEpoch: this._fluidEpoch,\n        };\n        return this.cache.put(this.fileEntryFromEntry(entry), data)\n            .catch((error) => {\n                this.logger.sendErrorEvent({ eventName: \"cachePutError\", type: entry.type }, error);\n                throw error;\n            });\n    }\n\n    public async removeEntries(): Promise<void> {\n        try {\n            return await this.cache.removeEntries(this.fileEntry);\n        } catch (error) {\n            this.logger.sendErrorEvent({ eventName: \"removeCacheEntries\" }, error);\n        }\n    }\n\n    public get fluidEpoch() {\n        return this._fluidEpoch;\n    }\n\n    public async validateEpochFromPush(details: IConnected) {\n        const epoch = details.epoch;\n        assert(epoch !== undefined, 0x09d /* \"Connection details should contain epoch\" */);\n        try {\n            this.validateEpochFromResponse(epoch, \"push\");\n        } catch (error) {\n            await this.checkForEpochError(error, epoch, \"push\");\n            throw error;\n        }\n    }\n\n    /**\n     * Api to fetch the response for given request and parse it as json.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     * @param fetchReason - fetch reason to add to the request.\n     */\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: RequestInit,\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        return this.fetchCore<T>(url, fetchOptions, fetchAndParseAsJSONHelper, fetchType, addInBody, fetchReason);\n    }\n\n    /**\n     * Api to fetch the response for given request and parse it as json.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     * @param fetchReason - fetch reason to add to the request.\n     */\n    public async fetch(\n        url: string,\n        fetchOptions: RequestInit,\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ) {\n        return this.fetchCore<Response>(url, fetchOptions, fetchHelper, fetchType, addInBody, fetchReason);\n    }\n\n    private async fetchCore<T>(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetcher: (url: string, fetchOptions: {[index: string]: any}) => Promise<IOdspResponse<T>>,\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ) {\n        const clientCorrelationId = this.formatClientCorrelationId(fetchReason);\n        // Add epoch in fetch request.\n        this.addEpochInRequest(fetchOptions, addInBody, clientCorrelationId);\n        let epochFromResponse: string | undefined;\n        return this.rateLimiter.schedule(\n            async () => fetcher(url, fetchOptions),\n        ).then((response) => {\n            epochFromResponse = response.headers.get(\"x-fluid-epoch\");\n            this.validateEpochFromResponse(epochFromResponse, fetchType);\n            response.propsToLog.XRequestStatsHeader = clientCorrelationId;\n            return response;\n        }).catch(async (error) => {\n            // Get the server epoch from error in case we don't have it as if undefined we won't be able\n            // to mark it as epoch error.\n            if (epochFromResponse === undefined) {\n                epochFromResponse = (error as IOdspError).serverEpoch;\n            }\n            await this.checkForEpochError(error, epochFromResponse, fetchType);\n            throw error;\n        }).catch((error) => {\n            const fluidError = normalizeError(error, { props: { XRequestStatsHeader: clientCorrelationId }});\n            throw fluidError;\n        });\n    }\n\n    /**\n     * Api to fetch the response as it is for given request.\n     * @param url - url of the request\n     * @param fetchOptions - fetch options for request containing body, headers etc.\n     * @param fetchType - method for which fetch is called.\n     * @param addInBody - Pass True if caller wants to add epoch in post body.\n     * @param fetchReason - fetch reason to add to the request.\n     */\n    public async fetchArray(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ) {\n        return this.fetchCore<ArrayBuffer>(url, fetchOptions, fetchArray, fetchType, addInBody, fetchReason);\n    }\n\n    private addEpochInRequest(\n        fetchOptions: RequestInit,\n        addInBody: boolean,\n        clientCorrelationId: string,\n    ) {\n        const isClpCompliantApp = getOdspResolvedUrl(this.fileEntry.resolvedUrl).isClpCompliantApp;\n        if (addInBody) {\n            const headers: {[key: string]: string} = {};\n            headers[\"X-RequestStats\"] = clientCorrelationId;\n            if (this.fluidEpoch !== undefined) {\n                headers[\"x-fluid-epoch\"] = this.fluidEpoch;\n            }\n            if (isClpCompliantApp) {\n                headers[ClpCompliantAppHeader.isClpCompliantApp] = isClpCompliantApp.toString();\n            }\n            this.addParamInBody(fetchOptions, headers);\n        } else {\n            const addHeader = (key: string, val: string) => {\n                fetchOptions.headers = {\n                    ...fetchOptions.headers,\n                };\n                assert(fetchOptions.headers !== undefined, 0x282 /* \"Headers should be present now\" */);\n                fetchOptions.headers[key] = val;\n            };\n            addHeader(\"X-RequestStats\", clientCorrelationId);\n            if (this.fluidEpoch !== undefined) {\n                addHeader(\"x-fluid-epoch\", this.fluidEpoch);\n            }\n            if (isClpCompliantApp) {\n                addHeader(ClpCompliantAppHeader.isClpCompliantApp, isClpCompliantApp.toString());\n            }\n        }\n    }\n\n    private addParamInBody(fetchOptions: RequestInit, headers: {[key: string]: string}) {\n        // We use multi part form request for post body where we want to use this.\n        // So extract the form boundary to mark the end of form.\n        const body = fetchOptions.body;\n        assert(typeof body === \"string\", 0x21d /* \"body is not string\" */);\n        const splitBody = body.split(\"\\r\\n\");\n        const firstLine = splitBody.shift();\n        assert(firstLine !== undefined && firstLine.startsWith(\"--\"), 0x21e /* \"improper boundary format\" */);\n        const formParams = [firstLine];\n        Object.entries(headers).forEach(([key, value]) => {\n            formParams.push(`${key}: ${value}`);\n        });\n        splitBody.forEach((value: string) => {\n            formParams.push(value);\n        });\n        fetchOptions.body = formParams.join(\"\\r\\n\");\n    }\n\n    private formatClientCorrelationId(fetchReason?: string) {\n        const items: string[] = [`driverId=${this.driverId}`, `RequestNumber=${this.networkCallNumber++}`];\n        if (fetchReason !== undefined) {\n            items.push(`fetchReason=${fetchReason}`);\n        }\n        return items.join(\", \");\n    }\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        const error = this.checkForEpochErrorCore(epochFromResponse);\n        if (error !== undefined) {\n            throw error;\n        }\n        if (epochFromResponse !== undefined) {\n            if (this._fluidEpoch === undefined) {\n                this.setEpoch(epochFromResponse, fromCache, fetchType);\n            }\n        }\n    }\n\n    private async checkForEpochError(\n        error: unknown,\n        epochFromResponse: string | null | undefined,\n        fetchType: FetchTypeInternal,\n        fromCache: boolean = false,\n    ) {\n        if (isFluidError(error) && error.errorType === DriverErrorType.fileOverwrittenInStorage) {\n            const epochError = this.checkForEpochErrorCore(epochFromResponse);\n            if (epochError !== undefined) {\n                epochError.addTelemetryProperties({\n                    fromCache,\n                    clientEpoch: this.fluidEpoch,\n                    fetchType,\n                });\n                this.logger.sendErrorEvent({ eventName: \"fileOverwrittenInStorage\" }, epochError);\n                // If the epoch mismatches, then clear all entries for such file entry from cache.\n                await this.removeEntries();\n                throw epochError;\n            }\n            // If it was categorized as epoch error but the epoch returned in response matches with the client epoch\n            // then it was coherency 409, so rethrow it as throttling error so that it can retried. Default throttling\n            // time is 1s.\n            throw new ThrottlingError(\n                `Coherency 409: ${error.message}`,\n                1 /* retryAfterSeconds */,\n                { [Odsp409Error]: true, driverVersion });\n        }\n    }\n\n    private checkForEpochErrorCore(epochFromResponse: string | null | undefined) {\n        // If epoch is undefined, then don't compare it because initially for createNew or TreesLatest\n        // initializes this value. Sometimes response does not contain epoch as it is still in\n        // implementation phase at server side. In that case also, don't compare it with our epoch value.\n        if (this.fluidEpoch && epochFromResponse && (this.fluidEpoch !== epochFromResponse)) {\n            // This is similar in nature to how fluidEpochMismatchError (409) is handled.\n            // Difference - client detected mismatch, instead of server detecting it.\n            return new NonRetryableError(\n                \"Epoch mismatch\", DriverErrorType.fileOverwrittenInStorage, { driverVersion });\n        }\n    }\n\n    private fileEntryFromEntry(entry: IEntry): ICacheEntry {\n        return { ...entry, file: this.fileEntry };\n    }\n}\n\nexport class EpochTrackerWithRedemption extends EpochTracker {\n    private readonly treesLatestDeferral = new Deferred<void>();\n\n    protected validateEpochFromResponse(\n        epochFromResponse: string | undefined,\n        fetchType: FetchType,\n        fromCache: boolean = false,\n    ) {\n        super.validateEpochFromResponse(epochFromResponse, fetchType, fromCache);\n\n        // Any successful call means we have access to a file, i.e. any redemption that was required already happened.\n        // That covers cases of \"treesLatest\" as well as \"getVersions\" or \"createFile\" - all the ways we can start\n        // exploring a file.\n        this.treesLatestDeferral.resolve();\n    }\n\n    public async get(\n        entry: IEntry,\n    ): Promise<any> {\n        let result = super.get(entry);\n\n        // equivalence of what happens in fetchAndParseAsJSON()\n        if (entry.type === snapshotKey) {\n            result = result\n                .then((value) => {\n                    // If there is nothing in cache, we need to wait for network call to complete (and do redemption)\n                    // Otherwise file was redeemed in prior session, so if joinSession failed, we should not retry\n                    if (value !== undefined) {\n                        this.treesLatestDeferral.resolve();\n                    }\n                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n                    return value;\n                })\n                .catch((error) => {\n                    this.treesLatestDeferral.reject(error);\n                    throw error;\n                });\n        }\n        return result;\n    }\n\n    public async fetchAndParseAsJSON<T>(\n        url: string,\n        fetchOptions: {[index: string]: any},\n        fetchType: FetchType,\n        addInBody: boolean = false,\n        fetchReason?: string,\n    ): Promise<IOdspResponse<T>> {\n        // Optimize the flow if we know that treesLatestDeferral was already completed by the timer we started\n        // joinSession call. If we did - there is no reason to repeat the call as it will fail with same error.\n        const completed = this.treesLatestDeferral.isCompleted;\n\n        try {\n            return await super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody, fetchReason);\n        } catch (error) {\n            // Only handling here treesLatest. If createFile failed, we should never try to do joinSession.\n            // Similar, if getVersions failed, we should not do any further storage calls.\n            // So treesLatest is the only call that can have parallel joinSession request.\n            if (fetchType === \"treesLatest\") {\n                this.treesLatestDeferral.reject(error);\n            }\n            if (fetchType !== \"joinSession\" || error.statusCode < 401 || error.statusCode > 404 || completed) {\n                throw error;\n            }\n        }\n\n        // It is joinSession failing with 401..404 error\n        // Repeat after waiting for treeLatest succeeding (or fail if it failed).\n        // No special handling after first call - if file has been deleted, then it's game over.\n\n        // Ensure we have some safety here - we do not want to deadlock if we got logic somewhere wrong.\n        // If we waited too long, we will log error event and proceed with call.\n        // It may result in failure for user, but refreshing document would address it.\n        // Thus we use rather long timeout (not to get these failures as much as possible), but not large enough\n        // to unblock the process.\n        await PerformanceEvent.timedExecAsync(\n            this.logger,\n            { eventName: \"JoinSessionSyncWait\" },\n            async (event) => {\n                const timeoutRes = 51; // anything will work here\n                let timer: ReturnType<typeof setTimeout>;\n                const timeoutP = new Promise<number>((resolve) => {\n                    timer = setTimeout(() => { resolve(timeoutRes); }, 15000);\n                });\n                const res = await Promise.race([\n                    timeoutP,\n                    // cancel timeout to unblock UTs (otherwise Node process does not exit for 15 sec)\n                    this.treesLatestDeferral.promise.finally(() => clearTimeout(timer))]);\n                if (res === timeoutRes) {\n                    event.cancel();\n                }\n            },\n            { start: true, end: true, cancel: \"generic\" });\n        return super.fetchAndParseAsJSON<T>(url, fetchOptions, fetchType, addInBody);\n    }\n}\n\nexport interface ICacheAndTracker {\n    cache: IOdspCache;\n    epochTracker: EpochTracker;\n}\n\nexport function createOdspCacheAndTracker(\n    persistedCacheArg: IPersistedCache,\n    nonpersistentCache: INonPersistentCache,\n    fileEntry: IFileEntry,\n    logger: ITelemetryLogger): ICacheAndTracker\n{\n    const epochTracker = new EpochTrackerWithRedemption(persistedCacheArg, fileEntry, logger);\n    return {\n        cache: {\n            ...nonpersistentCache,\n            persistedCache: epochTracker,\n        },\n        epochTracker,\n    };\n}\n"]}

package/dist/fetchSnapshot.d.ts

@@ -29,6 +29,17 @@ interface ISnapshotRequestAndResponseOptions {
         [index: string]: any;
     };
 }
+/**
+ * This function fetches the snapshot and parse it according to what is mentioned in response headers.
+ * @param odspResolvedUrl - resolved odsp url.
+ * @param storageToken - token to do the auth for network request.
+ * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
+ * @param logger - logger
+ * @param fetchBinarySnapshotFormat - whether to fetch binary snapshot or not.
+ * @param controller - abort controller if caller needs to abort the network call.
+ * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
+ * @returns fetched snapshot.
+ */
 export declare function downloadSnapshot(odspResolvedUrl: IOdspResolvedUrl, storageToken: string, logger: ITelemetryLogger, snapshotOptions: ISnapshotOptions | undefined, fetchBinarySnapshotFormat?: boolean, controller?: AbortController, epochTracker?: EpochTracker): Promise<ISnapshotRequestAndResponseOptions>;
 export {};
 //# sourceMappingURL=fetchSnapshot.d.ts.map

package/dist/fetchSnapshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchSnapshot.d.ts","sourceRoot":"","sources":["../src/fetchSnapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EAEhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EAAuC,wBAAwB,EAA8B,MAAM,aAAa,CAAC;AAGxH,OAAO,EAKH,aAAa,EACb,iBAAiB,EACpB,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAC/B,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,OAAO,EAC1B,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE;IAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAC3G,OAAO,CAAC,iBAAiB,CAAC,CAwB5B;AAED,wBAAsB,uBAAuB,CACzC,eAAe,EAAE,gBAAgB,EACjC,mBAAmB,EAAE,+BAA+B,EACpD,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CACZ,oBAAoB,EAAE,gBAAgB,EACtC,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,UAAU,CAAC,EAAE,eAAe,KAC3B,OAAO,CAAC,kCAAkC,CAAC,EACpD,UAAU,EAAE,CAAC,cAAc,EAAE,wBAAwB,KAAK,OAAO,CAAC,IAAI,CAAC,EACvE,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAClC,oBAAoB,CAAC,EAAE,OAAO,GAC/B,OAAO,CAAC,iBAAiB,CAAC,CAqD5B;AAkND,UAAU,kCAAkC;IACxC,oBAAoB,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;CAC1C;AAiJD,wBAAsB,gBAAgB,CAClC,eAAe,EAAE,gBAAgB,EACjC,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,yBAAyB,CAAC,EAAE,OAAO,EACnC,UAAU,CAAC,EAAE,eAAe,EAC5B,YAAY,CAAC,EAAE,YAAY,GAC5B,OAAO,CAAC,kCAAkC,CAAC,CAc7C"}
+{"version":3,"file":"fetchSnapshot.d.ts","sourceRoot":"","sources":["../src/fetchSnapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EAEhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAuC,wBAAwB,EAA8B,MAAM,aAAa,CAAC;AAGxH,OAAO,EAKH,aAAa,EACb,iBAAiB,EACpB,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAC/B,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,OAAO,EAC1B,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE;IAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAC3G,OAAO,CAAC,iBAAiB,CAAC,CAwB5B;AAED,wBAAsB,uBAAuB,CACzC,eAAe,EAAE,gBAAgB,EACjC,mBAAmB,EAAE,+BAA+B,EACpD,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CACZ,oBAAoB,EAAE,gBAAgB,EACtC,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,UAAU,CAAC,EAAE,eAAe,KAC3B,OAAO,CAAC,kCAAkC,CAAC,EACpD,UAAU,EAAE,CAAC,cAAc,EAAE,wBAAwB,KAAK,OAAO,CAAC,IAAI,CAAC,EACvE,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAClC,oBAAoB,CAAC,EAAE,OAAO,GAC/B,OAAO,CAAC,iBAAiB,CAAC,CAqD5B;AAmND,UAAU,kCAAkC;IACxC,oBAAoB,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;CAC1C;AA8DD;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CAClC,eAAe,EAAE,gBAAgB,EACjC,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,yBAAyB,CAAC,EAAE,OAAO,EACnC,UAAU,CAAC,EAAE,eAAe,EAC5B,YAAY,CAAC,EAAE,YAAY,GAC5B,OAAO,CAAC,kCAAkC,CAAC,CAsD7C"}

package/dist/fetchSnapshot.js

@@ -14,6 +14,7 @@ const common_utils_1 = require("@fluidframework/common-utils");
 const driver_definitions_1 = require("@fluidframework/driver-definitions");
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const odsp_driver_definitions_1 = require("@fluidframework/odsp-driver-definitions");
+const protocol_base_1 = require("@fluidframework/protocol-base");
 const contracts_1 = require("./contracts");
 const getQueryString_1 = require("./getQueryString");
 const getUrlAndHeadersWithAuth_1 = require("./getUrlAndHeadersWithAuth");
@@ -123,7 +124,7 @@ async function fetchLatestSnapshotCore(odspResolvedUrl, storageTokenFetcher, sna
         }
         // This event measures only successful cases of getLatest call (no tokens, no retries).
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(logger, perfEvent, async (event) => {
-            var _a, _b, _c, _d, _e, _f, _g;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const response = await snapshotDownloader(odspResolvedUrl, storageToken, snapshotOptions, controller);
             const snapshot = response.odspSnapshotResponse.content;
             // From: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
@@ -202,7 +203,7 @@ async function fetchLatestSnapshotCore(odspResolvedUrl, storageTokenFetcher, sna
                 putInCache(valueWithEpoch);
             }
             event.end(Object.assign({ trees: numTrees, blobs: (_e = (_d = snapshot.blobs) === null || _d === void 0 ? void 0 : _d.size) !== null && _e !== void 0 ? _e : 0, leafNodes: numBlobs, encodedBlobsSize,
-                sequenceNumber, ops: (_g = (_f = snapshot.ops) === null || _f === void 0 ? void 0 : _f.length) !== null && _g !== void 0 ? _g : 0, headers: Object.keys(response.requestHeaders).length !== 0 ? true : undefined, 
+                sequenceNumber, ops: (_g = (_f = snapshot.ops) === null || _f === void 0 ? void 0 : _f.length) !== null && _g !== void 0 ? _g : 0, nonSysOps: (_j = (_h = snapshot.ops) === null || _h === void 0 ? void 0 : _h.filter((op) => !protocol_base_1.isSystemMessage(op)).length) !== null && _j !== void 0 ? _j : 0, headers: Object.keys(response.requestHeaders).length !== 0 ? true : undefined, 
                 // Interval between the first fetch until the last byte of the last redirect.
                 redirectTime,
                 // Interval between start and finish of the domain name lookup for the resource.
@@ -239,70 +240,6 @@ async function fetchLatestSnapshotCore(odspResolvedUrl, storageTokenFetcher, sna
         });
     });
 }
-/**
- * This function fetches the older snapshot format which is the json format(IOdspSnapshot).
- * @param odspResolvedUrl - resolved odsp url.
- * @param storageToken - token to do the auth for network request.
- * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
- * @param controller - abort controller if caller needs to abort the network call.
- * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
- * @returns fetched snapshot.
- */
-async function fetchSnapshotContentsCoreV1(odspResolvedUrl, storageToken, snapshotOptions, controller, epochTracker) {
-    var _a;
-    const snapshotUrl = odspResolvedUrl.endpoints.snapshotStorageUrl;
-    const url = `${snapshotUrl}/trees/latest?ump=1`;
-    // The location of file can move on Spo in which case server returns 308(Permanent Redirect) error.
-    // Adding below header will make VROOM API return 404 instead of 308 and browser can intercept it.
-    // This error thrown by server will contain the new redirect location. Look at the 404 error parsing
-    // for futher reference here: \packages\utils\odsp-doclib-utils\src\odspErrorUtils.ts
-    const header = { prefer: "manualredirect" };
-    const { body, headers } = getFormBodyAndHeaders(odspResolvedUrl, storageToken, snapshotOptions, header);
-    headers.accept = "application/json";
-    const fetchOptions = {
-        body,
-        headers,
-        signal: controller === null || controller === void 0 ? void 0 : controller.signal,
-        method: "POST",
-    };
-    const response = await ((_a = epochTracker === null || epochTracker === void 0 ? void 0 : epochTracker.fetchAndParseAsJSON(url, fetchOptions, "treesLatest", true)) !== null && _a !== void 0 ? _a : odspUtils_1.fetchAndParseAsJSONHelper(url, fetchOptions));
-    const snapshotContents = odspSnapshotParser_1.convertOdspSnapshotToSnapsohtTreeAndBlobs(response.content);
-    const finalSnapshotContents = Object.assign(Object.assign({}, response), { content: snapshotContents });
-    return {
-        odspSnapshotResponse: finalSnapshotContents,
-        requestHeaders: headers,
-        requestUrl: url,
-    };
-}
-/**
- * This function fetches the binary compact snapshot format. This is an experimental feature
- * and is behind a feature flag.
- * @param odspResolvedUrl - resolved odsp url.
- * @param storageToken - token to do the auth for network request.
- * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
- * @param controller - abort controller if caller needs to abort the network call.
- * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
- * @returns fetched snapshot.
- */
-async function fetchSnapshotContentsCoreV2(odspResolvedUrl, storageToken, snapshotOptions, controller, epochTracker) {
-    var _a;
-    const fullUrl = `${odspResolvedUrl.siteUrl}/_api/v2.1/drives/${odspResolvedUrl.driveId}/items/${odspResolvedUrl.itemId}/opStream/attachments/latest/content?ump=1`;
-    const { body, headers } = getFormBodyAndHeaders(odspResolvedUrl, storageToken, snapshotOptions);
-    const fetchOptions = {
-        body,
-        headers,
-        signal: controller === null || controller === void 0 ? void 0 : controller.signal,
-        method: "POST",
-    };
-    const response = await ((_a = epochTracker === null || epochTracker === void 0 ? void 0 : epochTracker.fetchArray(fullUrl, fetchOptions, "treesLatest", true)) !== null && _a !== void 0 ? _a : odspUtils_1.fetchArray(fullUrl, fetchOptions));
-    const snapshotContents = compactSnapshotParser_1.parseCompactSnapshotResponse(new ReadBufferUtils_1.ReadBuffer(new Uint8Array(response.content)));
-    const finalSnapshotContents = Object.assign(Object.assign({}, response), { content: snapshotContents });
-    return {
-        odspSnapshotResponse: finalSnapshotContents,
-        requestHeaders: headers,
-        requestUrl: fullUrl,
-    };
-}
 function getFormBodyAndHeaders(odspResolvedUrl, storageToken, snapshotOptions, headers) {
     var _a, _b;
     const formBoundary = uuid_1.v4();
@@ -354,20 +291,69 @@ function countTreesInSnapshotTree(snapshotTree) {
     }
     return numTrees;
 }
+/**
+ * This function fetches the snapshot and parse it according to what is mentioned in response headers.
+ * @param odspResolvedUrl - resolved odsp url.
+ * @param storageToken - token to do the auth for network request.
+ * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
+ * @param logger - logger
+ * @param fetchBinarySnapshotFormat - whether to fetch binary snapshot or not.
+ * @param controller - abort controller if caller needs to abort the network call.
+ * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
+ * @returns fetched snapshot.
+ */
 async function downloadSnapshot(odspResolvedUrl, storageToken, logger, snapshotOptions, fetchBinarySnapshotFormat, controller, epochTracker) {
+    var _a;
     // back-compat: This block to be removed with #8784 when we only consume/consider odsp resolvers that are >= 0.51
     const sharingLinkToRedeem = odspResolvedUrl.sharingLinkToRedeem;
     if (sharingLinkToRedeem) {
         odspResolvedUrl.shareLinkInfo = Object.assign(Object.assign({}, odspResolvedUrl.shareLinkInfo), { sharingLinkToRedeem });
     }
+    const snapshotUrl = odspResolvedUrl.endpoints.snapshotStorageUrl;
+    const url = `${snapshotUrl}/trees/latest?ump=1`;
+    // The location of file can move on Spo in which case server returns 308(Permanent Redirect) error.
+    // Adding below header will make VROOM API return 404 instead of 308 and browser can intercept it.
+    // This error thrown by server will contain the new redirect location. Look at the 404 error parsing
+    // for futher reference here: \packages\utils\odsp-doclib-utils\src\odspErrorUtils.ts
+    const header = { prefer: "manualredirect" };
+    const { body, headers } = getFormBodyAndHeaders(odspResolvedUrl, storageToken, snapshotOptions, header);
+    const fetchOptions = {
+        body,
+        headers,
+        signal: controller === null || controller === void 0 ? void 0 : controller.signal,
+        method: "POST",
+    };
+    // For now we are keeping both json and ms-fluid values in accept header while fetching as we want to let
+    // the server decide what format it wants to send to the client as we roll it out slowly.
     if (fetchBinarySnapshotFormat) {
-        // Logging an event here as it is not supposed to be used in production yet and only in experimental mode.
-        logger.sendTelemetryEvent({ eventName: "BinarySnapshotFetched" });
-        return fetchSnapshotContentsCoreV2(odspResolvedUrl, storageToken, snapshotOptions, controller, epochTracker);
+        headers.accept = `application/json, application/ms-fluid; v=${compactSnapshotParser_1.currentReadVersion}`;
+    }
+    else {
+        headers.accept = "application/json";
+    }
+    const response = await ((_a = epochTracker === null || epochTracker === void 0 ? void 0 : epochTracker.fetch(url, fetchOptions, "treesLatest", true)) !== null && _a !== void 0 ? _a : odspUtils_1.fetchHelper(url, fetchOptions));
+    let finalSnapshotContents;
+    const contentType = response.headers.get("content-type");
+    if (contentType === "application/json") {
+        const text = await response.content.text();
+        const content = JSON.parse(text);
+        response.propsToLog.bodySize = text.length;
+        const snapshotContents = odspSnapshotParser_1.convertOdspSnapshotToSnapsohtTreeAndBlobs(content);
+        finalSnapshotContents = Object.assign(Object.assign({}, response), { content: snapshotContents });
     }
     else {
-        return fetchSnapshotContentsCoreV1(odspResolvedUrl, storageToken, snapshotOptions, controller, epochTracker);
+        common_utils_1.assert(contentType === "application/ms-fluid", "Content type should be application/ms-fluid");
+        const content = await response.content.arrayBuffer();
+        response.propsToLog.bodySize = content.byteLength;
+        const snapshotContents = compactSnapshotParser_1.parseCompactSnapshotResponse(new ReadBufferUtils_1.ReadBuffer(new Uint8Array(content)));
+        finalSnapshotContents = Object.assign(Object.assign({}, response), { content: snapshotContents });
     }
+    response.propsToLog.contentType = contentType;
+    return {
+        odspSnapshotResponse: finalSnapshotContents,
+        requestHeaders: headers,
+        requestUrl: url,
+    };
 }
 exports.downloadSnapshot = downloadSnapshot;
 function isRedeemSharingLinkError(odspResolvedUrl, error) {