@fluid-experimental/tree 0.58.2001 → 0.59.2000-61729

package/lib/test/undoRedoStackManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"undoRedoStackManager.js","sourceRoot":"","sources":["../../src/test/undoRedoStackManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,0FAA0F;AAC1F,wFAAwF;AACxF,kBAAkB;AAElB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,IAAK,YAIJ;AAJD,WAAK,YAAY;IAChB,+CAAI,CAAA;IACJ,+CAAI,CAAA;IACJ,+CAAI,CAAA;AACL,CAAC,EAJI,YAAY,KAAZ,YAAY,QAIhB;AAED;;GAEG;AACH,MAAM,KAAK;IAGV,YAAY,GAAG,KAAU;QADR,UAAK,GAAQ,EAAE,CAAC;QAEhC,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SACzC;IACF,CAAC;IAEM,KAAK;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;IAChC,CAAC;IACM,GAAG;QACT,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE;YAClB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACrB;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IACM,GAAG;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAEM,IAAI,CAAC,IAAO;QAClB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzB,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAC1C,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC1B;IACF,CAAC;CACD;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,KAAqC;IACzD,IAAI,CAAC,IAAoC;QAC/C,IAAI,IAAI,KAAK,SAAS,EAAE;YACvB,IAAI,CAAC,kBAAkB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC5D;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAEM,iCAAiC;QACvC,IAAI,IAAI,CAAC,GAAG,EAAE,KAAK,SAAS,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACrB;aAAM;YACN,IAAI,CAAC,sBAAsB,EAAE,CAAC;SAC9B;IACF,CAAC;IAEO,sBAAsB;QAC7B,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAC1C,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC1B;IACF,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAoB;IAqChC;QALiB,cAAS,GAAG,IAAI,aAAa,EAAE,CAAC;QAChC,cAAS,GAAG,IAAI,aAAa,EAAE,CAAC;QACzC,SAAI,GAAiB,YAAY,CAAC,IAAI,CAAC;QAC9B,iBAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QAGlD,IAAI,CAAC,SAAS,CAAC,kBAAkB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjF,IAAI,CAAC,SAAS,CAAC,kBAAkB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAClF,CAAC;IAvCO,MAAM,CAAC,MAAM,CAAC,WAA0B,EAAE,SAAwB;QACzE,gDAAgD;QAChD,oDAAoD;QACpD,8BAA8B;QAC9B,SAAS,CAAC,iCAAiC,EAAE,CAAC;QAE9C,gEAAgE;QAChE,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,WAAW,CAAC,GAAG,EAAE,KAAK,SAAS,EAAE;YAC/D,WAAW,CAAC,GAAG,EAAE,CAAC;SAClB;QAED,mDAAmD;QACnD,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YACzC,IAAI,cAAc,KAAK,SAAS,EAAE;gBACjC,OAAO,CAAC,cAAc,CAAC,KAAK,EAAE,EAAE;oBAC/B,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,CAAC;oBACvC,IAAI,SAAS,KAAK,SAAS,EAAE;wBAC5B,SAAS,CAAC,MAAM,EAAE,CAAC;qBACnB;iBACD;aACD;SACD;QAED,iDAAiD;QACjD,sDAAsD;QACtD,EAAE;QACF,WAAW,CAAC,iCAAiC,EAAE,CAAC;QAChD,SAAS,CAAC,iCAAiC,EAAE,CAAC;IAC/C,CAAC;IAYM,qBAAqB;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,EAAE;YACpC,IAAI,CAAC,SAAS,CAAC,iCAAiC,EAAE,CAAC;SACnD;IACF,CAAC;IAEM,EAAE,CAAC,KAAqB,EAAE,QAAoB;QACpD,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IACM,cAAc,CAAC,KAAqB,EAAE,QAAoB;QAChE,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,aAAa;QACnB,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE;YAC3B,OAAO,KAAK,CAAC;SACb;QACD,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC9B,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,aAAa;QACnB,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE;YAC3B,OAAO,KAAK,CAAC;SACb;QACD,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC9B,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,sBAAsB,CAAC,UAAuB;QACpD,IAAI,YAA2B,CAAC;QAEhC,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,YAAY,CAAC,IAAI;gBACrB,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC9B,IAAI,CAAC,cAAc,EAAE,CAAC;gBACtB,MAAM;YAEP,KAAK,YAAY,CAAC,IAAI;gBACrB,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC9B,MAAM;YAEP,KAAK,YAAY,CAAC,IAAI;gBACrB,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC9B,MAAM;YAEP;gBACC,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;SACjC;QACD,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,EAAE,CAAC;QAC1C,IAAI,cAAc,KAAK,SAAS,EAAE;YACjC,YAAY,CAAC,IAAI,CAAC,IAAI,KAAK,CAAc,UAAU,CAAC,CAAC,CAAC;SACtD;aAAM;YACN,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAChC;IACF,CAAC;IAEO,cAAc;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE;YAC/B,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;YAC/C,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACpC,OAAO,CAAC,iBAAiB,CAAC,KAAK,EAAE,EAAE;oBAClC,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,EAAE,CAAC;oBAC9C,IAAI,aAAa,KAAK,SAAS,EAAE;wBAChC,aAAa,CAAC,OAAO,EAAE,CAAC;qBACxB;iBACD;aACD;SACD;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// TODO: This is a temporary copy of the 'UndoRedoStackManager' from 'framework/undo-redo'\n//       to unblock testing of SharedMatrix undo while we decide on the correct layering\n//       for undo.\n\nimport { EventEmitter } from 'events';\nimport { IRevertible } from '../default-edits/UndoRedoHandler';\n\nenum UndoRedoMode {\n\tNone,\n\tRedo,\n\tUndo,\n}\n\n/**\n * Helper class for createing a stack over an array\n */\nclass Stack<T> {\n\tpublic itemPushedCallback: (() => void) | undefined;\n\tprivate readonly items: T[] = [];\n\tconstructor(...items: T[]) {\n\t\tif (items !== undefined) {\n\t\t\titems.forEach((item) => this.push(item));\n\t\t}\n\t}\n\n\tpublic empty(): boolean {\n\t\treturn this.items.length === 0;\n\t}\n\tpublic top(): T | undefined {\n\t\tif (!this.empty()) {\n\t\t\treturn this.items[0];\n\t\t}\n\t\treturn undefined;\n\t}\n\tpublic pop(): T | undefined {\n\t\treturn this.items.shift();\n\t}\n\n\tpublic push(item: T) {\n\t\tthis.items.unshift(item);\n\t\tif (this.itemPushedCallback !== undefined) {\n\t\t\tthis.itemPushedCallback();\n\t\t}\n\t}\n}\n\n/**\n * Helper class for creating the Undo and Redo stacks\n */\nclass UndoRedoStack extends Stack<Stack<IRevertible> | undefined> {\n\tpublic push(item: Stack<IRevertible> | undefined) {\n\t\tif (item !== undefined) {\n\t\t\titem.itemPushedCallback = () => this.callItemPushedCallback;\n\t\t}\n\t\tsuper.push(item);\n\t}\n\n\tpublic closeCurrentOperationIfInProgress() {\n\t\tif (this.top() !== undefined) {\n\t\t\tthis.push(undefined);\n\t\t} else {\n\t\t\tthis.callItemPushedCallback();\n\t\t}\n\t}\n\n\tprivate callItemPushedCallback() {\n\t\tif (this.itemPushedCallback !== undefined) {\n\t\t\tthis.itemPushedCallback();\n\t\t}\n\t}\n}\n\n/**\n * Manages the Undo and Redo stacks, and operations withing those stacks.\n * Allows adding items to the current operation on the stack, closing the current operation,\n * and issuing and undo or a redo.\n */\nexport class UndoRedoStackManager {\n\tprivate static revert(revertStack: UndoRedoStack, pushStack: UndoRedoStack) {\n\t\t// Close the pushStack, as it could get  new ops\n\t\t// from the revert, and we don't want those combined\n\t\t// with any existing operation\n\t\tpushStack.closeCurrentOperationIfInProgress();\n\n\t\t// Search the revert stack for the first defined operation stack\n\t\twhile (!revertStack.empty() && revertStack.top() === undefined) {\n\t\t\trevertStack.pop();\n\t\t}\n\n\t\t// If there is a defined operation stack, revert it\n\t\tif (!revertStack.empty()) {\n\t\t\tconst operationStack = revertStack.pop();\n\t\t\tif (operationStack !== undefined) {\n\t\t\t\twhile (!operationStack.empty()) {\n\t\t\t\t\tconst operation = operationStack.pop();\n\t\t\t\t\tif (operation !== undefined) {\n\t\t\t\t\t\toperation.revert();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Make sure both stacks have any open operations\n\t\t// closed, since we won't want anything added to those\n\t\t//\n\t\trevertStack.closeCurrentOperationIfInProgress();\n\t\tpushStack.closeCurrentOperationIfInProgress();\n\t}\n\n\tprivate readonly undoStack = new UndoRedoStack();\n\tprivate readonly redoStack = new UndoRedoStack();\n\tprivate mode: UndoRedoMode = UndoRedoMode.None;\n\tprivate readonly eventEmitter = new EventEmitter();\n\n\tconstructor() {\n\t\tthis.undoStack.itemPushedCallback = () => this.eventEmitter.emit('changePushed');\n\t\tthis.redoStack.itemPushedCallback = () => this.eventEmitter.emit('changePushed');\n\t}\n\n\tpublic closeCurrentOperation() {\n\t\tif (this.mode === UndoRedoMode.None) {\n\t\t\tthis.undoStack.closeCurrentOperationIfInProgress();\n\t\t}\n\t}\n\n\tpublic on(event: 'changePushed', listener: () => void) {\n\t\tthis.eventEmitter.on(event, listener);\n\t}\n\tpublic removeListener(event: 'changePushed', listener: () => void) {\n\t\tthis.eventEmitter.removeListener(event, listener);\n\t}\n\n\tpublic undoOperation(): boolean {\n\t\tif (this.undoStack.empty()) {\n\t\t\treturn false;\n\t\t}\n\t\tthis.mode = UndoRedoMode.Undo;\n\t\tUndoRedoStackManager.revert(this.undoStack, this.redoStack);\n\t\tthis.mode = UndoRedoMode.None;\n\t\treturn true;\n\t}\n\n\tpublic redoOperation(): boolean {\n\t\tif (this.redoStack.empty()) {\n\t\t\treturn false;\n\t\t}\n\t\tthis.mode = UndoRedoMode.Redo;\n\t\tUndoRedoStackManager.revert(this.redoStack, this.undoStack);\n\t\tthis.mode = UndoRedoMode.None;\n\t\treturn true;\n\t}\n\n\tpublic pushToCurrentOperation(revertible: IRevertible) {\n\t\tlet currentStack: UndoRedoStack;\n\n\t\tswitch (this.mode) {\n\t\t\tcase UndoRedoMode.None:\n\t\t\t\tcurrentStack = this.undoStack;\n\t\t\t\tthis.clearRedoStack();\n\t\t\t\tbreak;\n\n\t\t\tcase UndoRedoMode.Redo:\n\t\t\t\tcurrentStack = this.undoStack;\n\t\t\t\tbreak;\n\n\t\t\tcase UndoRedoMode.Undo:\n\t\t\t\tcurrentStack = this.redoStack;\n\t\t\t\tbreak;\n\n\t\t\tdefault:\n\t\t\t\tthrow new Error('unknown mode');\n\t\t}\n\t\tconst operationStack = currentStack.top();\n\t\tif (operationStack === undefined) {\n\t\t\tcurrentStack.push(new Stack<IRevertible>(revertible));\n\t\t} else {\n\t\t\toperationStack.push(revertible);\n\t\t}\n\t}\n\n\tprivate clearRedoStack() {\n\t\twhile (!this.redoStack.empty()) {\n\t\t\tconst redoOpertionStack = this.redoStack.pop();\n\t\t\tif (redoOpertionStack !== undefined) {\n\t\t\t\twhile (!redoOpertionStack.empty()) {\n\t\t\t\t\tconst redoOperation = redoOpertionStack.pop();\n\t\t\t\t\tif (redoOperation !== undefined) {\n\t\t\t\t\t\tredoOperation.discard();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/lib/test/utilities/SummaryFormatCompatibilityTests.d.ts

@@ -1,13 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { SharedTree } from '../../default-edits';
-import { SharedTreeWithAnchors } from '../../anchored-edits';
-import { LocalServerSharedTreeTestingComponents, LocalServerSharedTreeTestingOptions, SharedTreeTestingComponents, SharedTreeTestingOptions } from './TestUtilities';
-/**
- * Runs a test suite for summaries on `SharedTree`.
- * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.
- */
-export declare function runSummaryTests<TSharedTree extends SharedTree | SharedTreeWithAnchors>(title: string, setUpTestSharedTree: (options?: SharedTreeTestingOptions) => SharedTreeTestingComponents<TSharedTree>, setUpLocalServerTestSharedTree: (options: LocalServerSharedTreeTestingOptions) => Promise<LocalServerSharedTreeTestingComponents<TSharedTree>>): void;
-//# sourceMappingURL=SummaryFormatCompatibilityTests.d.ts.map

package/lib/test/utilities/SummaryFormatCompatibilityTests.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SummaryFormatCompatibilityTests.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/SummaryFormatCompatibilityTests.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AASjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAEN,sCAAsC,EACtC,mCAAmC,EACnC,2BAA2B,EAC3B,wBAAwB,EACxB,MAAM,iBAAiB,CAAC;AAoBzB;;;GAGG;AACH,wBAAgB,eAAe,CAAC,WAAW,SAAS,UAAU,GAAG,qBAAqB,EACrF,KAAK,EAAE,MAAM,EACb,mBAAmB,EAAE,CAAC,OAAO,CAAC,EAAE,wBAAwB,KAAK,2BAA2B,CAAC,WAAW,CAAC,EACrG,8BAA8B,EAAE,CAC/B,OAAO,EAAE,mCAAmC,KACxC,OAAO,CAAC,sCAAsC,CAAC,WAAW,CAAC,CAAC,QA8JjE"}

package/lib/test/utilities/SummaryFormatCompatibilityTests.js

@@ -1,154 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import * as fs from 'fs';
-import { resolve, join } from 'path';
-import { assert, expect } from 'chai';
-import { fail } from '../../Common';
-import { deserialize } from '../../SummaryBackCompatibility';
-import { fullHistorySummarizer, fullHistorySummarizer_0_1_0, } from '../../generic';
-import { createStableEdits, } from './TestUtilities';
-import { TestFluidSerializer } from './TestSerializer';
-// This accounts for this file being executed after compilation. If many tests want to leverage resources, we should unify
-// resource path logic to a single place.
-const pathBase = resolve(__dirname, '../../../src/test/summary-files/');
-function summaryFilePath(summaryName) {
-    return join(pathBase, `${summaryName}.json`);
-}
-/**
- * A version/summarizer pair must be specified for a write test to be generated.
- * Versions that can no longer be written should be removed from this list.
- */
-const supportedSummarizers = [
-    { version: '0.0.2', summarizer: fullHistorySummarizer },
-    { version: '0.1.0', summarizer: fullHistorySummarizer_0_1_0 },
-];
-/**
- * Runs a test suite for summaries on `SharedTree`.
- * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.
- */
-export function runSummaryTests(title, setUpTestSharedTree, setUpLocalServerTestSharedTree) {
-    describe(title, () => {
-        var _a;
-        const setupEditId = '9406d301-7449-48a5-b2ea-9be637b0c6e4';
-        const testSerializer = new TestFluidSerializer();
-        let expectedTree;
-        let testObjectProvider;
-        const testSummaryFiles = fs.readdirSync(pathBase);
-        // Create and populate a map of the file names associated with their summary type
-        const summaryTypes = new Map();
-        for (let fileName of testSummaryFiles) {
-            // Summary files should be named in the following format: `${summaryType}-${version}.json`
-            const fileNameRegularExpression = /(?<summaryType>[\w+-]*\w+)-(?<version>\d+\.\d\.\d).json/;
-            const match = fileNameRegularExpression.exec(fileName);
-            const matchGroups = (_a = match === null || match === void 0 ? void 0 : match.groups) !== null && _a !== void 0 ? _a : fail(`invalid filename ${fileName}`);
-            const summaryType = matchGroups.summaryType;
-            fileName = `${matchGroups.summaryType}-${matchGroups.version}`;
-            let collection = summaryTypes.get(summaryType);
-            if (collection === undefined) {
-                collection = [];
-                summaryTypes.set(summaryType, collection);
-            }
-            collection.push(fileName);
-        }
-        // Resets the tree before each test
-        beforeEach(async () => {
-            const testingComponents = await setUpLocalServerTestSharedTree({
-                setupEditId,
-            });
-            expectedTree = testingComponents.tree;
-            testObjectProvider = testingComponents.testObjectProvider;
-        });
-        afterEach(async () => {
-            testObjectProvider.reset();
-        });
-        const validateSummaryRead = (fileName) => {
-            const serializedSummary = fs.readFileSync(summaryFilePath(fileName), 'utf8');
-            const summary = deserialize(serializedSummary, testSerializer);
-            const { tree } = setUpTestSharedTree();
-            assert.typeOf(summary, 'object');
-            tree.loadSummary(summary);
-            expect(tree.equals(expectedTree)).to.be.true;
-        };
-        const validateSummaryWrite = (summarizer) => {
-            // Save a new summary with the expected tree and use it to load a new SharedTree
-            const newSummary = summarizer(expectedTree.edits, expectedTree.currentView);
-            const { tree: tree2 } = setUpTestSharedTree();
-            tree2.loadSummary(newSummary);
-            // The expected tree, tree loaded with the existing summary, and the tree loaded
-            // with the new summary should all be equal.
-            expect(tree2.equals(expectedTree)).to.be.true;
-        };
-        for (const [summaryType, files] of summaryTypes.entries()) {
-            it(`files of type '${summaryType}' with different format versions produce identical trees`, () => {
-                // Load the first summary file
-                const serializedSummary = fs.readFileSync(summaryFilePath(files[0]), 'utf8');
-                const summary = deserialize(serializedSummary, testSerializer);
-                assert.typeOf(summary, 'object');
-                expectedTree.loadSummary(summary);
-                // Check every other summary file results in the same loaded tree
-                for (let i = 1; i < files.length; i++) {
-                    const { tree } = setUpTestSharedTree();
-                    const serializedSummary = fs.readFileSync(summaryFilePath(files[i]), 'utf8');
-                    const summary = deserialize(serializedSummary, testSerializer);
-                    assert.typeOf(summary, 'object');
-                    tree.loadSummary(summary);
-                    expect(tree.equals(expectedTree)).to.be.true;
-                }
-            });
-            for (const { version, summarizer } of supportedSummarizers) {
-                it(`format version ${version} can be written for ${summaryType} summary type`, async () => {
-                    // Load the first summary file (the one with the oldest version)
-                    const serializedSummary = fs.readFileSync(summaryFilePath(files.sort()[0]), 'utf8');
-                    const summary = deserialize(serializedSummary, testSerializer);
-                    assert.typeOf(summary, 'object');
-                    // Wait for the ops to to be submitted and processed across the containers.
-                    await testObjectProvider.ensureSynchronized();
-                    expectedTree.loadSummary(summary);
-                    await testObjectProvider.ensureSynchronized();
-                    // Write a new summary with the specified version
-                    const newSummary = expectedTree.saveSerializedSummary({ summarizer });
-                    // Check the newly written summary is equivalent to its corresponding test summary file
-                    const fileName = `${summaryType}-${version}`;
-                    // Re-stringify the the JSON file to remove escaped characters
-                    const expectedSummary = JSON.stringify(JSON.parse(fs.readFileSync(summaryFilePath(fileName), 'utf8')));
-                    expect(newSummary).to.equal(expectedSummary);
-                });
-            }
-        }
-        describe('version 0.0.2', () => {
-            it('can be read and written with no history', async () => {
-                validateSummaryRead('no-history-0.0.2');
-                validateSummaryWrite(fullHistorySummarizer);
-            });
-            it('can be read and written with small history', async () => {
-                createStableEdits(11).forEach((edit) => {
-                    expectedTree.processLocalEdit(edit);
-                });
-                // Wait for the ops to to be submitted and processed across the containers.
-                await testObjectProvider.ensureSynchronized();
-                validateSummaryRead('small-history-0.0.2');
-                validateSummaryWrite(fullHistorySummarizer);
-            });
-        });
-        describe('version 0.1.0', () => {
-            it('can be read and written with no history', async () => {
-                validateSummaryRead('no-history-0.1.0');
-                validateSummaryWrite(fullHistorySummarizer_0_1_0);
-            });
-            it('can be read and written with large history', async () => {
-                testObjectProvider.logger.registerExpectedEvent({ eventName: 'fluid:telemetry:Batching:LengthTooBig' }, { eventName: 'fluid:telemetry:Batching:LengthTooBig' });
-                // Process an arbitrarily large number of stable edits
-                createStableEdits(251).forEach((edit) => {
-                    expectedTree.processLocalEdit(edit);
-                });
-                // Wait for the ops to to be submitted and processed across the containers.
-                await testObjectProvider.ensureSynchronized();
-                validateSummaryRead('large-history-0.1.0');
-                validateSummaryWrite(fullHistorySummarizer_0_1_0);
-            });
-        });
-    });
-}
-//# sourceMappingURL=SummaryFormatCompatibilityTests.js.map

package/lib/test/utilities/SummaryFormatCompatibilityTests.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SummaryFormatCompatibilityTests.js","sourceRoot":"","sources":["../../../src/test/utilities/SummaryFormatCompatibilityTests.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAEtC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAGpC,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EACN,qBAAqB,EACrB,2BAA2B,GAG3B,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,iBAAiB,GAKjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,0HAA0H;AAC1H,yCAAyC;AACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAC;AAExE,SAAS,eAAe,CAAC,WAAmB;IAC3C,OAAO,IAAI,CAAC,QAAQ,EAAE,GAAG,WAAW,OAAO,CAAC,CAAC;AAC9C,CAAC;AAED;;;GAGG;AACH,MAAM,oBAAoB,GAAqE;IAC9F,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,qBAAqB,EAAE;IACvD,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,2BAA2B,EAAE;CAC7D,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC9B,KAAa,EACb,mBAAqG,EACrG,8BAEiE;IAEjE,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;;QACpB,MAAM,WAAW,GAAG,sCAAgD,CAAC;QAErE,MAAM,cAAc,GAAG,IAAI,mBAAmB,EAAE,CAAC;QAEjD,IAAI,YAAyB,CAAC;QAC9B,IAAI,kBAAsC,CAAC;QAE3C,MAAM,gBAAgB,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAElD,iFAAiF;QACjF,MAAM,YAAY,GAAG,IAAI,GAAG,EAAoB,CAAC;QACjD,KAAK,IAAI,QAAQ,IAAI,gBAAgB,EAAE;YACtC,0FAA0F;YAC1F,MAAM,yBAAyB,GAAG,yDAAyD,CAAC;YAC5F,MAAM,KAAK,GAAG,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEvD,MAAM,WAAW,SAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,mCAAI,IAAI,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;YAC1E,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC;YAC5C,QAAQ,GAAG,GAAG,WAAW,CAAC,WAAW,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YAE/D,IAAI,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC/C,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC7B,UAAU,GAAG,EAAE,CAAC;gBAChB,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;aAC1C;YACD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC1B;QAED,mCAAmC;QACnC,UAAU,CAAC,KAAK,IAAI,EAAE;YACrB,MAAM,iBAAiB,GAAG,MAAM,8BAA8B,CAAC;gBAC9D,WAAW;aACX,CAAC,CAAC;YACH,YAAY,GAAG,iBAAiB,CAAC,IAAI,CAAC;YACtC,kBAAkB,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACpB,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAQ,EAAE;YACtD,MAAM,iBAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;YAC7E,MAAM,OAAO,GAAG,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAE/D,MAAM,EAAE,IAAI,EAAE,GAAG,mBAAmB,EAAE,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACjC,IAAI,CAAC,WAAW,CAAC,OAAgC,CAAC,CAAC;YAEnD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC9C,CAAC,CAAC;QAEF,MAAM,oBAAoB,GAAG,CAAC,UAAyC,EAAQ,EAAE;YAChF,gFAAgF;YAChF,MAAM,UAAU,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;YAC5E,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,mBAAmB,EAAE,CAAC;YAC9C,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAE9B,gFAAgF;YAChF,4CAA4C;YAC5C,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC/C,CAAC,CAAC;QAEF,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE;YAC1D,EAAE,CAAC,kBAAkB,WAAW,0DAA0D,EAAE,GAAG,EAAE;gBAChG,8BAA8B;gBAC9B,MAAM,iBAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;gBAC7E,MAAM,OAAO,GAAG,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;gBAC/D,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACjC,YAAY,CAAC,WAAW,CAAC,OAAgC,CAAC,CAAC;gBAE3D,iEAAiE;gBACjE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACtC,MAAM,EAAE,IAAI,EAAE,GAAG,mBAAmB,EAAE,CAAC;oBAEvC,MAAM,iBAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;oBAC7E,MAAM,OAAO,GAAG,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;oBAC/D,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBACjC,IAAI,CAAC,WAAW,CAAC,OAAgC,CAAC,CAAC;oBAEnD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;iBAC7C;YACF,CAAC,CAAC,CAAC;YAEH,KAAK,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,oBAAoB,EAAE;gBAC3D,EAAE,CAAC,kBAAkB,OAAO,uBAAuB,WAAW,eAAe,EAAE,KAAK,IAAI,EAAE;oBACzF,gEAAgE;oBAChE,MAAM,iBAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;oBACpF,MAAM,OAAO,GAAG,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;oBAC/D,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAEjC,2EAA2E;oBAC3E,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;oBAC9C,YAAY,CAAC,WAAW,CAAC,OAAgC,CAAC,CAAC;oBAE3D,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;oBAE9C,iDAAiD;oBACjD,MAAM,UAAU,GAAG,YAAY,CAAC,qBAAqB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;oBAEtE,uFAAuF;oBACvF,MAAM,QAAQ,GAAG,GAAG,WAAW,IAAI,OAAO,EAAE,CAAC;oBAC7C,8DAA8D;oBAC9D,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CACrC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,CAC9D,CAAC;oBAEF,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACH;SACD;QAED,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;YAC9B,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACxD,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;gBACxC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC3D,iBAAiB,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBACtC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACrC,CAAC,CAAC,CAAC;gBAEH,2EAA2E;gBAC3E,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;gBAE9C,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;gBAC3C,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;YAC9B,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACxD,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;gBACxC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC3D,kBAAkB,CAAC,MAAM,CAAC,qBAAqB,CAC9C,EAAE,SAAS,EAAE,uCAAuC,EAAE,EACtD,EAAE,SAAS,EAAE,uCAAuC,EAAE,CACtD,CAAC;gBACF,sDAAsD;gBACtD,iBAAiB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBACvC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACrC,CAAC,CAAC,CAAC;gBAEH,2EAA2E;gBAC3E,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;gBAE9C,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;gBAC3C,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from 'fs';\nimport { resolve, join } from 'path';\nimport { assert, expect } from 'chai';\nimport { TestObjectProvider } from '@fluidframework/test-utils';\nimport { fail } from '../../Common';\nimport { SharedTree } from '../../default-edits';\nimport { EditId } from '../../Identifiers';\nimport { deserialize } from '../../SummaryBackCompatibility';\nimport {\n\tfullHistorySummarizer,\n\tfullHistorySummarizer_0_1_0,\n\tSharedTreeSummarizer,\n\tSharedTreeSummaryBase,\n} from '../../generic';\nimport { SharedTreeWithAnchors } from '../../anchored-edits';\nimport {\n\tcreateStableEdits,\n\tLocalServerSharedTreeTestingComponents,\n\tLocalServerSharedTreeTestingOptions,\n\tSharedTreeTestingComponents,\n\tSharedTreeTestingOptions,\n} from './TestUtilities';\nimport { TestFluidSerializer } from './TestSerializer';\n\n// This accounts for this file being executed after compilation. If many tests want to leverage resources, we should unify\n// resource path logic to a single place.\nconst pathBase = resolve(__dirname, '../../../src/test/summary-files/');\n\nfunction summaryFilePath(summaryName: string): string {\n\treturn join(pathBase, `${summaryName}.json`);\n}\n\n/**\n * A version/summarizer pair must be specified for a write test to be generated.\n * Versions that can no longer be written should be removed from this list.\n */\nconst supportedSummarizers: { version: string; summarizer: SharedTreeSummarizer<unknown> }[] = [\n\t{ version: '0.0.2', summarizer: fullHistorySummarizer },\n\t{ version: '0.1.0', summarizer: fullHistorySummarizer_0_1_0 },\n];\n\n/**\n * Runs a test suite for summaries on `SharedTree`.\n * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.\n */\nexport function runSummaryTests<TSharedTree extends SharedTree | SharedTreeWithAnchors>(\n\ttitle: string,\n\tsetUpTestSharedTree: (options?: SharedTreeTestingOptions) => SharedTreeTestingComponents<TSharedTree>,\n\tsetUpLocalServerTestSharedTree: (\n\t\toptions: LocalServerSharedTreeTestingOptions\n\t) => Promise<LocalServerSharedTreeTestingComponents<TSharedTree>>\n) {\n\tdescribe(title, () => {\n\t\tconst setupEditId = '9406d301-7449-48a5-b2ea-9be637b0c6e4' as EditId;\n\n\t\tconst testSerializer = new TestFluidSerializer();\n\n\t\tlet expectedTree: TSharedTree;\n\t\tlet testObjectProvider: TestObjectProvider;\n\n\t\tconst testSummaryFiles = fs.readdirSync(pathBase);\n\n\t\t// Create and populate a map of the file names associated with their summary type\n\t\tconst summaryTypes = new Map<string, string[]>();\n\t\tfor (let fileName of testSummaryFiles) {\n\t\t\t// Summary files should be named in the following format: `${summaryType}-${version}.json`\n\t\t\tconst fileNameRegularExpression = /(?<summaryType>[\\w+-]*\\w+)-(?<version>\\d+\\.\\d\\.\\d).json/;\n\t\t\tconst match = fileNameRegularExpression.exec(fileName);\n\n\t\t\tconst matchGroups = match?.groups ?? fail(`invalid filename ${fileName}`);\n\t\t\tconst summaryType = matchGroups.summaryType;\n\t\t\tfileName = `${matchGroups.summaryType}-${matchGroups.version}`;\n\n\t\t\tlet collection = summaryTypes.get(summaryType);\n\t\t\tif (collection === undefined) {\n\t\t\t\tcollection = [];\n\t\t\t\tsummaryTypes.set(summaryType, collection);\n\t\t\t}\n\t\t\tcollection.push(fileName);\n\t\t}\n\n\t\t// Resets the tree before each test\n\t\tbeforeEach(async () => {\n\t\t\tconst testingComponents = await setUpLocalServerTestSharedTree({\n\t\t\t\tsetupEditId,\n\t\t\t});\n\t\t\texpectedTree = testingComponents.tree;\n\t\t\ttestObjectProvider = testingComponents.testObjectProvider;\n\t\t});\n\n\t\tafterEach(async () => {\n\t\t\ttestObjectProvider.reset();\n\t\t});\n\n\t\tconst validateSummaryRead = (fileName: string): void => {\n\t\t\tconst serializedSummary = fs.readFileSync(summaryFilePath(fileName), 'utf8');\n\t\t\tconst summary = deserialize(serializedSummary, testSerializer);\n\n\t\t\tconst { tree } = setUpTestSharedTree();\n\t\t\tassert.typeOf(summary, 'object');\n\t\t\ttree.loadSummary(summary as SharedTreeSummaryBase);\n\n\t\t\texpect(tree.equals(expectedTree)).to.be.true;\n\t\t};\n\n\t\tconst validateSummaryWrite = (summarizer: SharedTreeSummarizer<unknown>): void => {\n\t\t\t// Save a new summary with the expected tree and use it to load a new SharedTree\n\t\t\tconst newSummary = summarizer(expectedTree.edits, expectedTree.currentView);\n\t\t\tconst { tree: tree2 } = setUpTestSharedTree();\n\t\t\ttree2.loadSummary(newSummary);\n\n\t\t\t// The expected tree, tree loaded with the existing summary, and the tree loaded\n\t\t\t// with the new summary should all be equal.\n\t\t\texpect(tree2.equals(expectedTree)).to.be.true;\n\t\t};\n\n\t\tfor (const [summaryType, files] of summaryTypes.entries()) {\n\t\t\tit(`files of type '${summaryType}' with different format versions produce identical trees`, () => {\n\t\t\t\t// Load the first summary file\n\t\t\t\tconst serializedSummary = fs.readFileSync(summaryFilePath(files[0]), 'utf8');\n\t\t\t\tconst summary = deserialize(serializedSummary, testSerializer);\n\t\t\t\tassert.typeOf(summary, 'object');\n\t\t\t\texpectedTree.loadSummary(summary as SharedTreeSummaryBase);\n\n\t\t\t\t// Check every other summary file results in the same loaded tree\n\t\t\t\tfor (let i = 1; i < files.length; i++) {\n\t\t\t\t\tconst { tree } = setUpTestSharedTree();\n\n\t\t\t\t\tconst serializedSummary = fs.readFileSync(summaryFilePath(files[i]), 'utf8');\n\t\t\t\t\tconst summary = deserialize(serializedSummary, testSerializer);\n\t\t\t\t\tassert.typeOf(summary, 'object');\n\t\t\t\t\ttree.loadSummary(summary as SharedTreeSummaryBase);\n\n\t\t\t\t\texpect(tree.equals(expectedTree)).to.be.true;\n\t\t\t\t}\n\t\t\t});\n\n\t\t\tfor (const { version, summarizer } of supportedSummarizers) {\n\t\t\t\tit(`format version ${version} can be written for ${summaryType} summary type`, async () => {\n\t\t\t\t\t// Load the first summary file (the one with the oldest version)\n\t\t\t\t\tconst serializedSummary = fs.readFileSync(summaryFilePath(files.sort()[0]), 'utf8');\n\t\t\t\t\tconst summary = deserialize(serializedSummary, testSerializer);\n\t\t\t\t\tassert.typeOf(summary, 'object');\n\n\t\t\t\t\t// Wait for the ops to to be submitted and processed across the containers.\n\t\t\t\t\tawait testObjectProvider.ensureSynchronized();\n\t\t\t\t\texpectedTree.loadSummary(summary as SharedTreeSummaryBase);\n\n\t\t\t\t\tawait testObjectProvider.ensureSynchronized();\n\n\t\t\t\t\t// Write a new summary with the specified version\n\t\t\t\t\tconst newSummary = expectedTree.saveSerializedSummary({ summarizer });\n\n\t\t\t\t\t// Check the newly written summary is equivalent to its corresponding test summary file\n\t\t\t\t\tconst fileName = `${summaryType}-${version}`;\n\t\t\t\t\t// Re-stringify the the JSON file to remove escaped characters\n\t\t\t\t\tconst expectedSummary = JSON.stringify(\n\t\t\t\t\t\tJSON.parse(fs.readFileSync(summaryFilePath(fileName), 'utf8'))\n\t\t\t\t\t);\n\n\t\t\t\t\texpect(newSummary).to.equal(expectedSummary);\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\tdescribe('version 0.0.2', () => {\n\t\t\tit('can be read and written with no history', async () => {\n\t\t\t\tvalidateSummaryRead('no-history-0.0.2');\n\t\t\t\tvalidateSummaryWrite(fullHistorySummarizer);\n\t\t\t});\n\n\t\t\tit('can be read and written with small history', async () => {\n\t\t\t\tcreateStableEdits(11).forEach((edit) => {\n\t\t\t\t\texpectedTree.processLocalEdit(edit);\n\t\t\t\t});\n\n\t\t\t\t// Wait for the ops to to be submitted and processed across the containers.\n\t\t\t\tawait testObjectProvider.ensureSynchronized();\n\n\t\t\t\tvalidateSummaryRead('small-history-0.0.2');\n\t\t\t\tvalidateSummaryWrite(fullHistorySummarizer);\n\t\t\t});\n\t\t});\n\n\t\tdescribe('version 0.1.0', () => {\n\t\t\tit('can be read and written with no history', async () => {\n\t\t\t\tvalidateSummaryRead('no-history-0.1.0');\n\t\t\t\tvalidateSummaryWrite(fullHistorySummarizer_0_1_0);\n\t\t\t});\n\n\t\t\tit('can be read and written with large history', async () => {\n\t\t\t\ttestObjectProvider.logger.registerExpectedEvent(\n\t\t\t\t\t{ eventName: 'fluid:telemetry:Batching:LengthTooBig' },\n\t\t\t\t\t{ eventName: 'fluid:telemetry:Batching:LengthTooBig' }\n\t\t\t\t);\n\t\t\t\t// Process an arbitrarily large number of stable edits\n\t\t\t\tcreateStableEdits(251).forEach((edit) => {\n\t\t\t\t\texpectedTree.processLocalEdit(edit);\n\t\t\t\t});\n\n\t\t\t\t// Wait for the ops to to be submitted and processed across the containers.\n\t\t\t\tawait testObjectProvider.ensureSynchronized();\n\n\t\t\t\tvalidateSummaryRead('large-history-0.1.0');\n\t\t\t\tvalidateSummaryWrite(fullHistorySummarizer_0_1_0);\n\t\t\t});\n\t\t});\n\t});\n}\n"]}

package/src/BasicCheckout.ts

@@ -1,34 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { Snapshot } from './Snapshot';
-import { Checkout } from './Checkout';
-import { EditCommittedEventArguments, GenericSharedTree } from './generic';
-
-/**
- * Basic Session that stays up to date with the SharedTree.
- *
- * waitForPendingUpdates is always a no-op since BasicCheckout is always up to date.
- * @public
- * @sealed
- */
-export class BasicCheckout<TChange> extends Checkout<TChange> {
-	/**
-	 * @param tree - the tree
-	 */
-	public constructor(tree: GenericSharedTree<TChange>) {
-		super(tree, tree.currentView, (args: EditCommittedEventArguments<GenericSharedTree<TChange>>) => {
-			this.emitChange();
-		});
-	}
-
-	protected get latestCommittedView(): Snapshot {
-		return this.tree.currentView;
-	}
-
-	public async waitForPendingUpdates(): Promise<void> {
-		return Promise.resolve();
-	}
-}

package/src/Snapshot.ts

@@ -1,363 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { assert, copyPropertyIfDefined, fail } from './Common';
-import { NodeId, TraitLabel } from './Identifiers';
-import { getChangeNodeFromSnapshot } from './SnapshotUtilities';
-import { Delta, Forest } from './Forest';
-import { ChangeNode, NodeData, Payload, TraitLocation } from './generic';
-
-/**
- * An immutable view of a distributed tree node.
- * @public
- */
-export interface SnapshotNode extends NodeData {
-	readonly traits: ReadonlyMap<TraitLabel, readonly NodeId[]>;
-}
-
-/**
- * Index of a place within a trait.
- * 0 = before all nodes,
- * 1 = after first node,
- * etc.
- * @public
- */
-export type PlaceIndex = number & { readonly PlaceIndex: unique symbol };
-
-/**
- * Index of a node within a trait.
- * 0 = first node,
- * 1 = second node,
- * etc.
- * @public
- */
-export type TraitNodeIndex = number & { readonly TraitNodeIndex: unique symbol };
-
-/**
- * A place within a particular `Snapshot` that is anchored relative to a specific node in the tree, or relative to the outside of the trait.
- * Valid iff 'trait' is valid and, if provided, sibling is in the Location specified by 'trait'.
- * @public
- */
-export interface SnapshotPlace {
-	readonly sibling?: NodeId;
-	readonly side: Side;
-	readonly trait: TraitLocation;
-}
-
-/**
- * Defines a place relative to sibling.
- * The "outside" of a trait is the `undefined` sibling,
- * so After `undefined` is the beginning of the trait, and before `undefined` is the end.
- *
- * For this purpose, traits look like:
- *
- * `{undefined} - {Node 0} - {Node 1} - ... - {Node N} - {undefined}`
- *
- * Each `{value}` in the diagram is a possible sibling, which is either a Node or undefined.
- * Each `-` in the above diagram is a `Place`, and can be describe as being `After` a particular `{sibling}` or `Before` it.
- * This means that `After` `{undefined}` means the same `Place` as before the first node
- * and `Before` `{undefined}` means the `Place` after the last Node.
- *
- * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):
- * the choice of which way to anchor a place only matters when the kept across an edit, and thus evaluated in multiple contexts where the
- * two place description may no longer evaluate to the same place.
- * @public
- */
-export enum Side {
-	Before = 0,
-	After = 1,
-}
-
-/**
- * Specifies the range of nodes from `start` to `end` within a trait within a particular `Snapshot`.
- * Valid iff start and end are valid and are withing the same trait.
- * @public
- */
-export interface SnapshotRange {
-	readonly start: SnapshotPlace;
-	readonly end: SnapshotPlace;
-}
-
-/**
- * An immutable view of a distributed tree.
- * @public
- */
-export class Snapshot {
-	public readonly root: NodeId;
-	private readonly forest: Forest;
-
-	/**
-	 * A cache of node's index within their parent trait.
-	 * Used to avoid redundant linear scans of traits.
-	 * Not shared across snapshots; initialized to empty each time a Snapshot is created.
-	 */
-	private traitIndicesCache?: Map<NodeId, TraitNodeIndex>;
-
-	/**
-	 * Constructs a Snapshot using the supplied tree.
-	 * @param root - the root of the tree to use as the contents of the `Snapshot`
-	 */
-	public static fromTree(root: ChangeNode, expensiveValidation = false): Snapshot {
-		function insertNodeRecursive(node: ChangeNode, newSnapshotNodes: Map<NodeId, SnapshotNode>): NodeId {
-			const { identifier, definition } = node;
-			const traits: Map<TraitLabel, readonly NodeId[]> = new Map();
-
-			// eslint-disable-next-line no-restricted-syntax
-			for (const key in node.traits) {
-				if (Object.prototype.hasOwnProperty.call(node.traits, key)) {
-					const element = node.traits[key];
-					if (element.length > 0) {
-						traits.set(
-							key as TraitLabel,
-							element.map((n) => insertNodeRecursive(n, newSnapshotNodes))
-						);
-					}
-				}
-			}
-			const snapshotNode: SnapshotNode = { identifier, definition, traits };
-			copyPropertyIfDefined(node, snapshotNode, 'payload');
-			assert(
-				!newSnapshotNodes.has(identifier),
-				`duplicate node in tree for snapshot: { identifier: ${identifier}, definition: ${definition}`
-			);
-			newSnapshotNodes.set(snapshotNode.identifier, snapshotNode);
-			return snapshotNode.identifier;
-		}
-
-		const map = new Map<NodeId, SnapshotNode>();
-		return new Snapshot(insertNodeRecursive(root, map), Forest.create(expensiveValidation).add(map.values()));
-	}
-
-	private constructor(root: NodeId, forest: Forest) {
-		this.root = root;
-		this.forest = forest;
-	}
-
-	/** Return a tree of JSON-compatible `ChangeNode`s representing the current state of this `Snapshot` */
-	public getChangeNodeTree(): ChangeNode {
-		return getChangeNodeFromSnapshot(this, this.root);
-	}
-
-	/**
-	 * Returns the number of nodes in this `Snapshot`
-	 */
-	public get size(): number {
-		return this.forest.size;
-	}
-
-	/**
-	 * @returns true iff the nodeId exists.
-	 */
-	public hasNode(id: NodeId): boolean {
-		return this.forest.tryGet(id) !== undefined;
-	}
-
-	/**
-	 * @returns a `ChangeNode` derived from the `SnapshotNode` in this snapshot with the given `NodeId`.
-	 */
-	public getChangeNode(id: NodeId): ChangeNode {
-		return getChangeNodeFromSnapshot(this, id);
-	}
-
-	/**
-	 * @returns the `ChangeNode`s derived from the `SnapshotNode`s in this snapshot with the given `NodeId`s.
-	 */
-	public getChangeNodes(nodeIds: readonly NodeId[]): ChangeNode[] {
-		return nodeIds.map((id) => this.getChangeNode(id));
-	}
-
-	/**
-	 * Asserts the forest is in a consistent state.
-	 */
-	public assertConsistent(): void {
-		this.forest.assertConsistent();
-	}
-
-	/**
-	 * Inserts all nodes in a NodeSequence into the forest.
-	 */
-	public addNodes(sequence: Iterable<SnapshotNode>): Snapshot {
-		return new Snapshot(this.root, this.forest.add(sequence));
-	}
-
-	/**
-	 * Remove all nodes with the given ids from the forest
-	 */
-	public deleteNodes(nodes: Iterable<NodeId>): Snapshot {
-		return new Snapshot(this.root, this.forest.delete(nodes, true));
-	}
-
-	/**
-	 * Parents a set of detached nodes at a specified place.
-	 * @param nodesToAttach - the nodes to parent in the specified place. The nodes must already be present in the Snapshot.
-	 * @param place - the location to insert the nodes.
-	 */
-	public attachRange(nodesToAttach: readonly NodeId[], place: SnapshotPlace): Snapshot {
-		const { parent, label } = place.trait;
-		const index = this.findIndexWithinTrait(place);
-		return new Snapshot(this.root, this.forest.attachRangeOfChildren(parent, label, index, nodesToAttach));
-	}
-
-	/**
-	 * Detaches a range of nodes from their parent. The detached nodes remain in the Snapshot.
-	 * @param rangeToDetach - the range of nodes to detach
-	 */
-	public detachRange(rangeToDetach: SnapshotRange): { snapshot: Snapshot; detached: readonly NodeId[] } {
-		const { start, end } = rangeToDetach;
-		const { trait: traitLocation } = start;
-		const { parent, label } = traitLocation;
-		const startIndex = this.findIndexWithinTrait(start);
-		const endIndex = this.findIndexWithinTrait(end);
-		const { forest, detached } = this.forest.detachRangeOfChildren(parent, label, startIndex, endIndex);
-		return { snapshot: new Snapshot(this.root, forest), detached };
-	}
-
-	/**
-	 * Sets a node's value. The node must exist in this `Snapshot`.
-	 * @param nodeId - the id of the node
-	 * @param value - the new value
-	 */
-	public setNodeValue(nodeId: NodeId, value: Payload): Snapshot {
-		return new Snapshot(this.root, this.forest.setValue(nodeId, value));
-	}
-
-	/**
-	 * @returns the index just after place (which specifies a location between items).
-	 * Performance note: this is O(siblings in trait).
-	 */
-	public findIndexWithinTrait(place: SnapshotPlace): PlaceIndex {
-		if (place.sibling === undefined) {
-			return this.getIndexOfSide(place.side, place.trait);
-		}
-		return getIndex(place.side, this.getIndexInTrait(place.sibling));
-	}
-
-	/**
-	 * Returns the node associated with `id` in this `Snapshot`.
-	 */
-	public getSnapshotNode(id: NodeId): SnapshotNode {
-		return this.forest.get(id);
-	}
-
-	/**
-	 * Returns the label of the trait that a node is under. Returns undefined if the node is not present or if it is the root node.
-	 */
-	public getTraitLabel(id: NodeId): TraitLabel | undefined {
-		return this.forest.tryGetParent(id)?.traitParent;
-	}
-
-	/**
-	 * Returns the parent of a node. Returns undefined if the node does not exist in the snapshot or if it does not have a parent.
-	 */
-	public getParentSnapshotNode(id: NodeId): SnapshotNode | undefined {
-		const parentInfo = this.forest.tryGetParent(id);
-		if (parentInfo === undefined) {
-			return undefined;
-		}
-		return this.getSnapshotNode(parentInfo.parentId);
-	}
-
-	/**
-	 * @param node - must have a parent.
-	 */
-	public getTraitLocation(node: NodeId): TraitLocation {
-		const parentData = this.forest.getParent(node);
-		assert(parentData !== undefined, 'node must have parent');
-		return {
-			parent: parentData.parentId,
-			label: parentData.traitParent,
-		};
-	}
-
-	/**
-	 * @param node - must have a parent.
-	 * Performance note: this is O(siblings in trait).
-	 */
-	public getIndexInTrait(node: NodeId): TraitNodeIndex {
-		if (this.traitIndicesCache === undefined) {
-			this.traitIndicesCache = new Map();
-		} else {
-			const cached = this.traitIndicesCache.get(node);
-			if (cached !== undefined) {
-				return cached;
-			}
-		}
-		const parentData = this.forest.getParent(node);
-		const parent = this.forest.get(parentData.parentId);
-		const traitParent =
-			parent.traits.get(parentData.traitParent) ?? fail('invalid parentData: trait parent not found.');
-		let foundIndex = -1 as TraitNodeIndex;
-		for (let i = 0; i < traitParent.length; i++) {
-			const nodeInTrait = traitParent[i];
-			const index = i as TraitNodeIndex;
-			this.traitIndicesCache.set(nodeInTrait, index);
-			if (nodeInTrait === node) {
-				foundIndex = index;
-			}
-		}
-		return foundIndex !== -1 ? foundIndex : fail('invalidParentData: node not found in specified trait');
-	}
-
-	/**
-	 * Return a trait given its location
-	 * @param traitLocation - the location of the trait
-	 */
-	public getTrait(traitLocation: TraitLocation): readonly NodeId[] {
-		return this.getSnapshotNode(traitLocation.parent).traits.get(traitLocation.label) ?? [];
-	}
-
-	private getIndexOfSide(side: Side, traitLocation: TraitLocation): PlaceIndex {
-		return side === Side.After ? (0 as PlaceIndex) : (this.getTrait(traitLocation).length as PlaceIndex);
-	}
-
-	/** Compares this snapshot to another for equality. */
-	public equals(snapshot: Snapshot): boolean {
-		if (this.root !== snapshot.root) {
-			return false;
-		}
-
-		// TODO:#49100:Perf: make this faster and/or remove use by PrefetchingCheckout.
-		return this.forest.equals(snapshot.forest);
-	}
-
-	private *iterateNodeDescendants(nodeId: NodeId): IterableIterator<SnapshotNode> {
-		const node = this.getSnapshotNode(nodeId);
-		yield node;
-		for (const trait of node.traits.values()) {
-			for (const childId of trait) {
-				yield* this.iterateNodeDescendants(childId);
-			}
-		}
-	}
-
-	/**
-	 * Calculate the difference between two `Snapshot`s
-	 * @param snapshot - the other snapshot to compare to this one
-	 * @returns A {@link Delta} which nodes must be changed, added, and removed to get from `this` to `snapshot`.
-	 * The snapshots must share a root.
-	 */
-	public delta(snapshot: Snapshot): Delta<NodeId> {
-		assert(this.root === snapshot.root, 'Delta can only be calculated between snapshots that share a root');
-		return this.forest.delta(snapshot.forest);
-	}
-
-	public [Symbol.iterator](): IterableIterator<SnapshotNode> {
-		return this.iterateNodeDescendants(this.root);
-	}
-}
-
-function getIndex(side: Side, index: TraitNodeIndex): PlaceIndex {
-	// eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-	return (side + index) as PlaceIndex;
-}
-
-/**
- * Contains some redundant information. Use only in computations between edits. Do not store.
- * @public
- */
-export interface NodeInTrait {
-	readonly trait: TraitLocation;
-	readonly index: TraitNodeIndex;
-}