@fluid-experimental/tree 0.58.2002 → 0.58.3000-61081

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

@@ -2,15 +2,34 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { EditStatus, GenericTransaction } from '../../generic';
-import { Snapshot } from '../../Snapshot';
+import { Result } from '../../Common';
+import { ChangeInternal, EditStatus } from '../../persisted-types';
+import { RevisionView } from '../../RevisionView';
+import { ChangeResult, GenericTransaction, GenericTransactionPolicy } from '../../TransactionInternal';
 /**
- * A mock implementation of `GenericTransaction` for use in tests.
  * @internal
  */
-export declare class MockTransaction<TChange> extends GenericTransaction<TChange> {
-    static factory<TChange>(snapshot: Snapshot): MockTransaction<TChange>;
-    protected validateOnClose(): EditStatus;
-    protected dispatchChange(change: TChange): EditStatus;
+export declare namespace MockTransaction {
+    interface Options {
+        statusOnClose: EditStatus;
+    }
+    const defaultOptions: Options;
+    /**
+     * Makes a new {@link GenericTransaction} that follows the {@link MockTransaction.Policy} policy.
+     *
+     * @internal
+     */
+    function factory(view: RevisionView, options?: Options): GenericTransaction;
+    /**
+     * A mock implementation of `GenericTransaction` for use in tests.
+     * @internal
+     */
+    class Policy implements GenericTransactionPolicy {
+        options: Options;
+        constructor(options: Options);
+        tryResolveChange(_state: any, change: ChangeInternal): Result.Ok<ChangeInternal>;
+        validateOnClose(state: any): ChangeResult;
+        dispatchChange(state: any): ChangeResult;
+    }
 }
 //# sourceMappingURL=MockTransaction.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"MockTransaction.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/MockTransaction.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C;;;GAGG;AACH,qBAAa,eAAe,CAAC,OAAO,CAAE,SAAQ,kBAAkB,CAAC,OAAO,CAAC;WAC1D,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC;IAI5E,SAAS,CAAC,eAAe,IAAI,UAAU;IAIvC,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU;CAGrD"}
+{"version":3,"file":"MockTransaction.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/MockTransaction.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EACN,YAAY,EACZ,kBAAkB,EAClB,wBAAwB,EAExB,MAAM,2BAA2B,CAAC;AAEnC;;GAEG;AACH,yBAAiB,eAAe,CAAC;IAChC,UAAiB,OAAO;QACvB,aAAa,EAAE,UAAU,CAAC;KAC1B;IAEM,MAAM,cAAc,EAAE,OAE5B,CAAC;IAEF;;;;OAIG;IACH,SAAgB,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,GAAE,OAAwB,GAAG,kBAAkB,CAEjG;IAED;;;OAGG;IACH,MAAa,MAAO,YAAW,wBAAwB;QAC/C,OAAO,EAAE,OAAO,CAAC;oBAEL,OAAO,EAAE,OAAO;QAI5B,gBAAgB,CAAC,MAAM,KAAA,EAAE,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC,EAAE,CAAC,cAAc,CAAC;QAI3E,eAAe,CAAC,KAAK,KAAA,GAAG,YAAY;QASpC,cAAc,CAAC,KAAK,KAAA,GAAG,YAAY;KAG1C;CACD"}

package/lib/test/utilities/MockTransaction.js

@@ -2,20 +2,49 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { EditStatus, GenericTransaction } from '../../generic';
+import { Result } from '../../Common';
+import { EditStatus } from '../../persisted-types';
+import { GenericTransaction, } from '../../TransactionInternal';
 /**
- * A mock implementation of `GenericTransaction` for use in tests.
  * @internal
  */
-export class MockTransaction extends GenericTransaction {
-    static factory(snapshot) {
-        return new MockTransaction(snapshot);
+export var MockTransaction;
+(function (MockTransaction) {
+    MockTransaction.defaultOptions = {
+        statusOnClose: EditStatus.Applied,
+    };
+    /**
+     * Makes a new {@link GenericTransaction} that follows the {@link MockTransaction.Policy} policy.
+     *
+     * @internal
+     */
+    function factory(view, options = MockTransaction.defaultOptions) {
+        return new GenericTransaction(view, new Policy(options));
     }
-    validateOnClose() {
-        return EditStatus.Applied;
+    MockTransaction.factory = factory;
+    /**
+     * A mock implementation of `GenericTransaction` for use in tests.
+     * @internal
+     */
+    class Policy {
+        constructor(options) {
+            this.options = options;
+        }
+        tryResolveChange(_state, change) {
+            return Result.ok(change);
+        }
+        validateOnClose(state) {
+            return this.options.statusOnClose === EditStatus.Applied
+                ? Result.ok(state.view)
+                : Result.error({
+                    status: this.options.statusOnClose,
+                    failure: undefined,
+                });
+        }
+        dispatchChange(state) {
+            return Result.ok(state.view);
+        }
     }
-    dispatchChange(change) {
-        return EditStatus.Applied;
-    }
-}
+    MockTransaction.Policy = Policy;
+})(MockTransaction || (MockTransaction = {}));
 //# sourceMappingURL=MockTransaction.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"MockTransaction.js","sourceRoot":"","sources":["../../../src/test/utilities/MockTransaction.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAG/D;;;GAGG;AACH,MAAM,OAAO,eAAyB,SAAQ,kBAA2B;IACjE,MAAM,CAAC,OAAO,CAAU,QAAkB;QAChD,OAAO,IAAI,eAAe,CAAU,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAES,eAAe;QACxB,OAAO,UAAU,CAAC,OAAO,CAAC;IAC3B,CAAC;IAES,cAAc,CAAC,MAAe;QACvC,OAAO,UAAU,CAAC,OAAO,CAAC;IAC3B,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EditStatus, GenericTransaction } from '../../generic';\nimport { Snapshot } from '../../Snapshot';\n\n/**\n * A mock implementation of `GenericTransaction` for use in tests.\n * @internal\n */\nexport class MockTransaction<TChange> extends GenericTransaction<TChange> {\n\tpublic static factory<TChange>(snapshot: Snapshot): MockTransaction<TChange> {\n\t\treturn new MockTransaction<TChange>(snapshot);\n\t}\n\n\tprotected validateOnClose(): EditStatus {\n\t\treturn EditStatus.Applied;\n\t}\n\n\tprotected dispatchChange(change: TChange): EditStatus {\n\t\treturn EditStatus.Applied;\n\t}\n}\n"]}
+{"version":3,"file":"MockTransaction.js","sourceRoot":"","sources":["../../../src/test/utilities/MockTransaction.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAkB,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAEN,kBAAkB,GAGlB,MAAM,2BAA2B,CAAC;AAEnC;;GAEG;AACH,MAAM,KAAW,eAAe,CA8C/B;AA9CD,WAAiB,eAAe;IAKlB,8BAAc,GAAY;QACtC,aAAa,EAAE,UAAU,CAAC,OAAO;KACjC,CAAC;IAEF;;;;OAIG;IACH,SAAgB,OAAO,CAAC,IAAkB,EAAE,UAAmB,gBAAA,cAAc;QAC5E,OAAO,IAAI,kBAAkB,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1D,CAAC;IAFe,uBAAO,UAEtB,CAAA;IAED;;;OAGG;IACH,MAAa,MAAM;QAGlB,YAAmB,OAAgB;YAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACxB,CAAC;QAEM,gBAAgB,CAAC,MAAM,EAAE,MAAsB;YACrD,OAAO,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;QAEM,eAAe,CAAC,KAAK;YAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,UAAU,CAAC,OAAO;gBACvD,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;gBACvB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;oBACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa;oBAClC,OAAO,EAAE,SAAmD;iBAC3D,CAAC,CAAC;QACP,CAAC;QAEM,cAAc,CAAC,KAAK;YAC1B,OAAO,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;KACD;IAvBY,sBAAM,SAuBlB,CAAA;AACF,CAAC,EA9CgB,eAAe,KAAf,eAAe,QA8C/B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Result } from '../../Common';\nimport { ChangeInternal, EditStatus } from '../../persisted-types';\nimport { RevisionView } from '../../RevisionView';\nimport {\n\tChangeResult,\n\tGenericTransaction,\n\tGenericTransactionPolicy,\n\tTransactionInternal,\n} from '../../TransactionInternal';\n\n/**\n * @internal\n */\nexport namespace MockTransaction {\n\texport interface Options {\n\t\tstatusOnClose: EditStatus;\n\t}\n\n\texport const defaultOptions: Options = {\n\t\tstatusOnClose: EditStatus.Applied,\n\t};\n\n\t/**\n\t * Makes a new {@link GenericTransaction} that follows the {@link MockTransaction.Policy} policy.\n\t *\n\t * @internal\n\t */\n\texport function factory(view: RevisionView, options: Options = defaultOptions): GenericTransaction {\n\t\treturn new GenericTransaction(view, new Policy(options));\n\t}\n\n\t/**\n\t * A mock implementation of `GenericTransaction` for use in tests.\n\t * @internal\n\t */\n\texport class Policy implements GenericTransactionPolicy {\n\t\tpublic options: Options;\n\n\t\tpublic constructor(options: Options) {\n\t\t\tthis.options = options;\n\t\t}\n\n\t\tpublic tryResolveChange(_state, change: ChangeInternal): Result.Ok<ChangeInternal> {\n\t\t\treturn Result.ok(change);\n\t\t}\n\n\t\tpublic validateOnClose(state): ChangeResult {\n\t\t\treturn this.options.statusOnClose === EditStatus.Applied\n\t\t\t\t? Result.ok(state.view)\n\t\t\t\t: Result.error({\n\t\t\t\t\t\tstatus: this.options.statusOnClose,\n\t\t\t\t\t\tfailure: undefined as unknown as TransactionInternal.Failure,\n\t\t\t\t  });\n\t\t}\n\n\t\tpublic dispatchChange(state): ChangeResult {\n\t\t\treturn Result.ok(state.view);\n\t\t}\n\t}\n}\n"]}

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

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { LocalServerSharedTreeTestingComponents, LocalServerSharedTreeTestingOptions } from './TestUtilities';
+/**
+ * Runs a test suite for SharedTree's ability to apply pending local state stashed by the host.
+ * See documentation on `applyStashedOp`.
+ * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.
+ */
+export declare function runPendingLocalStateTests(title: string, setUpLocalServerTestSharedTree: (options: LocalServerSharedTreeTestingOptions) => Promise<LocalServerSharedTreeTestingComponents>): void;
+//# sourceMappingURL=PendingLocalStateTests.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PendingLocalStateTests.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/PendingLocalStateTests.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,OAAO,EACN,sCAAsC,EACtC,mCAAmC,EAGnC,MAAM,iBAAiB,CAAC;AAezB;;;;GAIG;AACH,wBAAgB,yBAAyB,CACxC,KAAK,EAAE,MAAM,EACb,8BAA8B,EAAE,CAC/B,OAAO,EAAE,mCAAmC,KACxC,OAAO,CAAC,sCAAsC,CAAC,QAqHpD"}

package/lib/test/utilities/PendingLocalStateTests.js

@@ -0,0 +1,105 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { expect } from 'chai';
+import { requestFluidObject } from '@fluidframework/runtime-utils';
+import { fail } from '../../Common';
+import { WriteFormat } from '../../persisted-types';
+import { Change, StablePlace } from '../../ChangeTypes';
+import { setUpTestTree, stabilizeEdit, } from './TestUtilities';
+async function withContainerOffline(provider, container, action) {
+    await provider.ensureSynchronized();
+    await provider.opProcessingController.pauseProcessing(container);
+    const actionReturn = action();
+    const pendingLocalState = container.closeAndGetPendingLocalState();
+    provider.opProcessingController.resumeProcessing(container);
+    return { actionReturn, pendingLocalState };
+}
+/**
+ * Runs a test suite for SharedTree's ability to apply pending local state stashed by the host.
+ * See documentation on `applyStashedOp`.
+ * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.
+ */
+export function runPendingLocalStateTests(title, setUpLocalServerTestSharedTree) {
+    describe(title, () => {
+        const documentId = 'documentId';
+        [WriteFormat.v0_0_2 /* TODO: Enable when stashed ops are supported: WriteFormat.v0_1_1 */].forEach((writeFormat) => {
+            it(`is applied to all connected containers (v${writeFormat})`, async () => {
+                var _a, _b, _c;
+                const { container, tree, testObjectProvider } = await setUpLocalServerTestSharedTree({
+                    id: documentId,
+                    writeFormat,
+                });
+                const testTree = setUpTestTree(tree);
+                const { tree: tree2 } = await setUpLocalServerTestSharedTree({
+                    id: documentId,
+                    testObjectProvider,
+                    writeFormat,
+                });
+                const url = (_a = (await container.getAbsoluteUrl('/'))) !== null && _a !== void 0 ? _a : fail('Container unable to resolve "/".');
+                await testObjectProvider.ensureSynchronized();
+                const initialEditLogLength = tree.edits.length;
+                const { pendingLocalState, actionReturn: edit } = await withContainerOffline(testObjectProvider, container, () => tree.applyEdit(...Change.insertTree(testTree.buildLeaf(), StablePlace.after(testTree.left))));
+                await testObjectProvider.ensureSynchronized();
+                const leftTraitAfterOfflineClose = tree2.currentView.getTrait(testTree.left.traitLocation.translate(tree2));
+                const loader = testObjectProvider.makeTestLoader();
+                // Simulate reconnect of user 1; a new container will be created which passes the stashed local state in its
+                // load request.
+                const container3 = await loader.resolve({ url }, pendingLocalState);
+                const dataObject3 = await requestFluidObject(container3, '/');
+                const tree3 = await dataObject3.getSharedObject(documentId);
+                expect(tree3.editsInternal.isLocalEdit(edit.id)).to.be.true; // Kludge
+                await testObjectProvider.ensureSynchronized();
+                expect(leftTraitAfterOfflineClose.length).to.equal(1, 'Second tree should not receive edits made by first tree after it went offline.');
+                expect(tree3.currentView.getTrait(testTree.left.traitLocation.translate(tree3)).length).to.equal(2, 'Tree which loaded with stashed pending edits should apply them.');
+                expect(tree2.currentView.getTrait(testTree.left.traitLocation.translate(tree2)).length).to.equal(2, 'Tree collaborating with a client that applies stashed pending edits should see them.');
+                const stableEdit = stabilizeEdit(tree, edit);
+                expect(stabilizeEdit(tree2, (_b = (await tree2.editsInternal.tryGetEdit(edit.id))) !== null && _b !== void 0 ? _b : fail())).to.deep.equal(stableEdit);
+                expect(stabilizeEdit(tree3, (_c = (await tree3.editsInternal.tryGetEdit(edit.id))) !== null && _c !== void 0 ? _c : fail())).to.deep.equal(stableEdit);
+                expect(tree2.edits.length).to.equal(initialEditLogLength + 1);
+                expect(tree3.edits.length).to.equal(initialEditLogLength + 1);
+            });
+        });
+        it('Deals with stashed handle ops gracefully', async () => {
+            var _a;
+            // Setup
+            const { container, tree, testObjectProvider } = await setUpLocalServerTestSharedTree({
+                id: documentId,
+                writeFormat: WriteFormat.v0_1_1,
+            });
+            const testTree = setUpTestTree(tree);
+            await setUpLocalServerTestSharedTree({
+                id: documentId,
+                testObjectProvider,
+                writeFormat: WriteFormat.v0_1_1,
+            });
+            const url = (_a = (await container.getAbsoluteUrl('/'))) !== null && _a !== void 0 ? _a : fail('Container unable to resolve "/".');
+            await testObjectProvider.ensureSynchronized();
+            await testObjectProvider.opProcessingController.pauseProcessing();
+            // Generate enough edits to cause a chunk upload.
+            for (let i = 0; i < tree.edits.editsPerChunk; i++) {
+                tree.applyEdit(...Change.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.left.traitLocation)));
+            }
+            // Process all of those messages, sequencing them but without informing the container that they have been sequenced.
+            await testObjectProvider.opProcessingController.processOutgoing(container);
+            // Inform the container that all of the edits it generated above have been sequenced, thereby filling an edit chunk
+            // whose responsibility to upload is on the container.
+            await testObjectProvider.opProcessingController.processIncoming(container);
+            // Process outgoing/incoming once more to handle the blob attach op.
+            await testObjectProvider.opProcessingController.processOutgoing(container);
+            await testObjectProvider.opProcessingController.processIncoming(container);
+            const pendingLocalState = container.closeAndGetPendingLocalState();
+            const loader = testObjectProvider.makeTestLoader();
+            const container2 = await loader.resolve({ url }, pendingLocalState);
+            const dataObject2 = await requestFluidObject(container2, '/');
+            const tree2 = await dataObject2.getSharedObject(documentId);
+            await testObjectProvider.ensureSynchronized();
+            const editLog = tree2.edits;
+            const unuploadedEditChunks = Array.from(editLog.getEditChunksReadyForUpload());
+            expect(unuploadedEditChunks.length).to.equal(0);
+            expect(editLog.getEditLogSummary().editChunks.length).to.equal(2);
+        });
+    });
+}
+//# sourceMappingURL=PendingLocalStateTests.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PendingLocalStateTests.js","sourceRoot":"","sources":["../../../src/test/utilities/PendingLocalStateTests.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAwB,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAG1E,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAGN,aAAa,EACb,aAAa,GACb,MAAM,iBAAiB,CAAC;AAEzB,KAAK,UAAU,oBAAoB,CAClC,QAA6B,EAC7B,SAAqB,EACrB,MAAqB;IAErB,MAAM,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IACpC,MAAM,QAAQ,CAAC,sBAAsB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,MAAM,EAAE,CAAC;IAC9B,MAAM,iBAAiB,GAAG,SAAS,CAAC,4BAA4B,EAAE,CAAC;IACnE,QAAQ,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5D,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACxC,KAAa,EACb,8BAEoD;IAEpD,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;QACpB,MAAM,UAAU,GAAG,YAAY,CAAC;QAEhC,CAAC,WAAW,CAAC,MAAM,CAAC,qEAAqE,CAAC,CAAC,OAAO,CACjG,CAAC,WAAW,EAAE,EAAE;YACf,EAAE,CAAC,4CAA4C,WAAW,GAAG,EAAE,KAAK,IAAI,EAAE;;gBACzE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,MAAM,8BAA8B,CAAC;oBACpF,EAAE,EAAE,UAAU;oBACd,WAAW;iBACX,CAAC,CAAC;gBACH,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;gBACrC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,8BAA8B,CAAC;oBAC5D,EAAE,EAAE,UAAU;oBACd,kBAAkB;oBAClB,WAAW;iBACX,CAAC,CAAC;gBACH,MAAM,GAAG,SAAG,CAAC,MAAM,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,mCAAI,IAAI,CAAC,kCAAkC,CAAC,CAAC;gBAC9F,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;gBAC9C,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;gBAE/C,MAAM,EAAE,iBAAiB,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,MAAM,oBAAoB,CAC3E,kBAAkB,EAClB,SAAS,EACT,GAAG,EAAE,CACJ,IAAI,CAAC,SAAS,CACb,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CACpD,CAC1B,CAAC;gBACF,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;gBAC9C,MAAM,0BAA0B,GAAG,KAAK,CAAC,WAAW,CAAC,QAAQ,CAC5D,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,CAC5C,CAAC;gBACF,MAAM,MAAM,GAAG,kBAAkB,CAAC,cAAc,EAAE,CAAC;gBAEnD,4GAA4G;gBAC5G,gBAAgB;gBAChB,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC;gBACpE,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAmB,UAAU,EAAE,GAAG,CAAC,CAAC;gBAChF,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,eAAe,CAAa,UAAU,CAAC,CAAC;gBACxE,MAAM,CAAE,KAAK,CAAC,aAAyC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS;gBAEnG,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;gBAE9C,MAAM,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACjD,CAAC,EACD,gFAAgF,CAChF,CAAC;gBACF,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAC/F,CAAC,EACD,iEAAiE,CACjE,CAAC;gBACF,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAC/F,CAAC,EACD,sFAAsF,CACtF,CAAC;gBAEF,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC7C,MAAM,CACL,aAAa,CAAC,KAAK,QAAE,CAAC,MAAM,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,mCAAI,IAAI,EAAE,CAAC,CAC/E,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC5B,MAAM,CACL,aAAa,CAAC,KAAK,QAAE,CAAC,MAAM,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,mCAAI,IAAI,EAAE,CAAC,CAC/E,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC5B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAC;gBAC9D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;QACJ,CAAC,CACD,CAAC;QAEF,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;;YACzD,QAAQ;YACR,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,MAAM,8BAA8B,CAAC;gBACpF,EAAE,EAAE,UAAU;gBACd,WAAW,EAAE,WAAW,CAAC,MAAM;aAC/B,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,8BAA8B,CAAC;gBACpC,EAAE,EAAE,UAAU;gBACd,kBAAkB;gBAClB,WAAW,EAAE,WAAW,CAAC,MAAM;aAC/B,CAAC,CAAC;YAEH,MAAM,GAAG,SAAG,CAAC,MAAM,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,mCAAI,IAAI,CAAC,kCAAkC,CAAC,CAAC;YAE9F,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;YAC9C,MAAM,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,EAAE,CAAC;YAClE,iDAAiD;YACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAI,IAAI,CAAC,KAAiB,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE;gBAC/D,IAAI,CAAC,SAAS,CACb,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAC5F,CAAC;aACF;YACD,oHAAoH;YACpH,MAAM,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC3E,mHAAmH;YACnH,sDAAsD;YACtD,MAAM,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC3E,oEAAoE;YACpE,MAAM,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC3E,MAAM,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAE3E,MAAM,iBAAiB,GAAG,SAAS,CAAC,4BAA4B,EAAE,CAAC;YACnE,MAAM,MAAM,GAAG,kBAAkB,CAAC,cAAc,EAAE,CAAC;YAEnD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAmB,UAAU,EAAE,GAAG,CAAC,CAAC;YAChF,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,eAAe,CAAa,UAAU,CAAC,CAAC;YACxE,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;YAE9C,MAAM,OAAO,GAAG,KAAK,CAAC,KAAgB,CAAC;YACvC,MAAM,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAC;YAC/E,MAAM,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnE,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 { expect } from 'chai';\nimport { IContainer } from '@fluidframework/container-definitions';\nimport { requestFluidObject } from '@fluidframework/runtime-utils';\nimport { ITestFluidObject, ITestObjectProvider } from '@fluidframework/test-utils';\nimport { fail } from '../../Common';\nimport { ChangeInternal, Edit, WriteFormat } from '../../persisted-types';\nimport type { EditLog } from '../../EditLog';\nimport { SharedTree } from '../../SharedTree';\nimport { Change, StablePlace } from '../../ChangeTypes';\nimport {\n\tLocalServerSharedTreeTestingComponents,\n\tLocalServerSharedTreeTestingOptions,\n\tsetUpTestTree,\n\tstabilizeEdit,\n} from './TestUtilities';\n\nasync function withContainerOffline<TReturn>(\n\tprovider: ITestObjectProvider,\n\tcontainer: IContainer,\n\taction: () => TReturn\n): Promise<{ actionReturn: TReturn; pendingLocalState: string }> {\n\tawait provider.ensureSynchronized();\n\tawait provider.opProcessingController.pauseProcessing(container);\n\tconst actionReturn = action();\n\tconst pendingLocalState = container.closeAndGetPendingLocalState();\n\tprovider.opProcessingController.resumeProcessing(container);\n\treturn { actionReturn, pendingLocalState };\n}\n\n/**\n * Runs a test suite for SharedTree's ability to apply pending local state stashed by the host.\n * See documentation on `applyStashedOp`.\n * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.\n */\nexport function runPendingLocalStateTests(\n\ttitle: string,\n\tsetUpLocalServerTestSharedTree: (\n\t\toptions: LocalServerSharedTreeTestingOptions\n\t) => Promise<LocalServerSharedTreeTestingComponents>\n) {\n\tdescribe(title, () => {\n\t\tconst documentId = 'documentId';\n\n\t\t[WriteFormat.v0_0_2 /* TODO: Enable when stashed ops are supported: WriteFormat.v0_1_1 */].forEach(\n\t\t\t(writeFormat) => {\n\t\t\t\tit(`is applied to all connected containers (v${writeFormat})`, async () => {\n\t\t\t\t\tconst { container, tree, testObjectProvider } = await setUpLocalServerTestSharedTree({\n\t\t\t\t\t\tid: documentId,\n\t\t\t\t\t\twriteFormat,\n\t\t\t\t\t});\n\t\t\t\t\tconst testTree = setUpTestTree(tree);\n\t\t\t\t\tconst { tree: tree2 } = await setUpLocalServerTestSharedTree({\n\t\t\t\t\t\tid: documentId,\n\t\t\t\t\t\ttestObjectProvider,\n\t\t\t\t\t\twriteFormat,\n\t\t\t\t\t});\n\t\t\t\t\tconst url = (await container.getAbsoluteUrl('/')) ?? fail('Container unable to resolve \"/\".');\n\t\t\t\t\tawait testObjectProvider.ensureSynchronized();\n\t\t\t\t\tconst initialEditLogLength = tree.edits.length;\n\n\t\t\t\t\tconst { pendingLocalState, actionReturn: edit } = await withContainerOffline(\n\t\t\t\t\t\ttestObjectProvider,\n\t\t\t\t\t\tcontainer,\n\t\t\t\t\t\t() =>\n\t\t\t\t\t\t\ttree.applyEdit(\n\t\t\t\t\t\t\t\t...Change.insertTree(testTree.buildLeaf(), StablePlace.after(testTree.left))\n\t\t\t\t\t\t\t) as Edit<ChangeInternal>\n\t\t\t\t\t);\n\t\t\t\t\tawait testObjectProvider.ensureSynchronized();\n\t\t\t\t\tconst leftTraitAfterOfflineClose = tree2.currentView.getTrait(\n\t\t\t\t\t\ttestTree.left.traitLocation.translate(tree2)\n\t\t\t\t\t);\n\t\t\t\t\tconst loader = testObjectProvider.makeTestLoader();\n\n\t\t\t\t\t// Simulate reconnect of user 1; a new container will be created which passes the stashed local state in its\n\t\t\t\t\t// load request.\n\t\t\t\t\tconst container3 = await loader.resolve({ url }, pendingLocalState);\n\t\t\t\t\tconst dataObject3 = await requestFluidObject<ITestFluidObject>(container3, '/');\n\t\t\t\t\tconst tree3 = await dataObject3.getSharedObject<SharedTree>(documentId);\n\t\t\t\t\texpect((tree3.editsInternal as EditLog<ChangeInternal>).isLocalEdit(edit.id)).to.be.true; // Kludge\n\n\t\t\t\t\tawait testObjectProvider.ensureSynchronized();\n\n\t\t\t\t\texpect(leftTraitAfterOfflineClose.length).to.equal(\n\t\t\t\t\t\t1,\n\t\t\t\t\t\t'Second tree should not receive edits made by first tree after it went offline.'\n\t\t\t\t\t);\n\t\t\t\t\texpect(tree3.currentView.getTrait(testTree.left.traitLocation.translate(tree3)).length).to.equal(\n\t\t\t\t\t\t2,\n\t\t\t\t\t\t'Tree which loaded with stashed pending edits should apply them.'\n\t\t\t\t\t);\n\t\t\t\t\texpect(tree2.currentView.getTrait(testTree.left.traitLocation.translate(tree2)).length).to.equal(\n\t\t\t\t\t\t2,\n\t\t\t\t\t\t'Tree collaborating with a client that applies stashed pending edits should see them.'\n\t\t\t\t\t);\n\n\t\t\t\t\tconst stableEdit = stabilizeEdit(tree, edit);\n\t\t\t\t\texpect(\n\t\t\t\t\t\tstabilizeEdit(tree2, (await tree2.editsInternal.tryGetEdit(edit.id)) ?? fail())\n\t\t\t\t\t).to.deep.equal(stableEdit);\n\t\t\t\t\texpect(\n\t\t\t\t\t\tstabilizeEdit(tree3, (await tree3.editsInternal.tryGetEdit(edit.id)) ?? fail())\n\t\t\t\t\t).to.deep.equal(stableEdit);\n\t\t\t\t\texpect(tree2.edits.length).to.equal(initialEditLogLength + 1);\n\t\t\t\t\texpect(tree3.edits.length).to.equal(initialEditLogLength + 1);\n\t\t\t\t});\n\t\t\t}\n\t\t);\n\n\t\tit('Deals with stashed handle ops gracefully', async () => {\n\t\t\t// Setup\n\t\t\tconst { container, tree, testObjectProvider } = await setUpLocalServerTestSharedTree({\n\t\t\t\tid: documentId,\n\t\t\t\twriteFormat: WriteFormat.v0_1_1,\n\t\t\t});\n\t\t\tconst testTree = setUpTestTree(tree);\n\t\t\tawait setUpLocalServerTestSharedTree({\n\t\t\t\tid: documentId,\n\t\t\t\ttestObjectProvider,\n\t\t\t\twriteFormat: WriteFormat.v0_1_1,\n\t\t\t});\n\n\t\t\tconst url = (await container.getAbsoluteUrl('/')) ?? fail('Container unable to resolve \"/\".');\n\n\t\t\tawait testObjectProvider.ensureSynchronized();\n\t\t\tawait testObjectProvider.opProcessingController.pauseProcessing();\n\t\t\t// Generate enough edits to cause a chunk upload.\n\t\t\tfor (let i = 0; i < (tree.edits as EditLog).editsPerChunk; i++) {\n\t\t\t\ttree.applyEdit(\n\t\t\t\t\t...Change.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.left.traitLocation))\n\t\t\t\t);\n\t\t\t}\n\t\t\t// Process all of those messages, sequencing them but without informing the container that they have been sequenced.\n\t\t\tawait testObjectProvider.opProcessingController.processOutgoing(container);\n\t\t\t// Inform the container that all of the edits it generated above have been sequenced, thereby filling an edit chunk\n\t\t\t// whose responsibility to upload is on the container.\n\t\t\tawait testObjectProvider.opProcessingController.processIncoming(container);\n\t\t\t// Process outgoing/incoming once more to handle the blob attach op.\n\t\t\tawait testObjectProvider.opProcessingController.processOutgoing(container);\n\t\t\tawait testObjectProvider.opProcessingController.processIncoming(container);\n\n\t\t\tconst pendingLocalState = container.closeAndGetPendingLocalState();\n\t\t\tconst loader = testObjectProvider.makeTestLoader();\n\n\t\t\tconst container2 = await loader.resolve({ url }, pendingLocalState);\n\t\t\tconst dataObject2 = await requestFluidObject<ITestFluidObject>(container2, '/');\n\t\t\tconst tree2 = await dataObject2.getSharedObject<SharedTree>(documentId);\n\t\t\tawait testObjectProvider.ensureSynchronized();\n\n\t\t\tconst editLog = tree2.edits as EditLog;\n\t\t\tconst unuploadedEditChunks = Array.from(editLog.getEditChunksReadyForUpload());\n\t\t\texpect(unuploadedEditChunks.length).to.equal(0);\n\t\t\texpect(editLog.getEditLogSummary().editChunks.length).to.equal(2);\n\t\t});\n\t});\n}\n"]}

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

@@ -2,12 +2,11 @@
  * 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 { WriteFormat } from '../../persisted-types';
 import { SharedTreeTestingComponents, SharedTreeTestingOptions } from './TestUtilities';
 /**
- * Runs a test suite for operations on `SharedTree`.
+ * Runs a test suite for operations on `SharedTree` writing ops at `writeFormat`.
  * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.
  */
-export declare function runSharedTreeOperationsTests<TSharedTree extends SharedTree | SharedTreeWithAnchors>(title: string, setUpTestSharedTree: (options?: SharedTreeTestingOptions) => SharedTreeTestingComponents<TSharedTree>): void;
+export declare function runSharedTreeOperationsTests(title: string, writeFormat: WriteFormat, setUpTestSharedTreeWithDefaultVersion: (options?: SharedTreeTestingOptions) => SharedTreeTestingComponents): void;
 //# sourceMappingURL=SharedTreeTests.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SharedTreeTests.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/SharedTreeTests.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmBH,OAAO,EAAgE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAO/G,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAcN,2BAA2B,EAC3B,wBAAwB,EACxB,MAAM,iBAAiB,CAAC;AAmBzB;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,SAAS,UAAU,GAAG,qBAAqB,EAClG,KAAK,EAAE,MAAM,EACb,mBAAmB,EAAE,CAAC,OAAO,CAAC,EAAE,wBAAwB,KAAK,2BAA2B,CAAC,WAAW,CAAC,QAg3BrG"}
+{"version":3,"file":"SharedTreeTests.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/SharedTreeTests.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuBH,OAAO,EAeN,WAAW,EACX,MAAM,uBAAuB,CAAC;AAY/B,OAAO,EAGN,2BAA2B,EAC3B,wBAAwB,EAaxB,MAAM,iBAAiB,CAAC;AAazB;;;GAGG;AACH,wBAAgB,4BAA4B,CAC3C,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,WAAW,EACxB,qCAAqC,EAAE,CAAC,OAAO,CAAC,EAAE,wBAAwB,KAAK,2BAA2B,QAk2C1G"}