@fluid-experimental/dds-interceptions 2.0.0-dev-rc.2.0.0.245554

package/lib/test/sharedDirectoryWithInterception.spec.js

@@ -0,0 +1,282 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MockFluidDataStoreRuntime } from "@fluidframework/test-runtime-utils";
+import { SharedDirectory, DirectoryFactory } from "@fluidframework/map";
+import { createDirectoryWithInterception } from "../map/index.js";
+describe("Shared Directory with Interception", () => {
+    describe("Simple User Attribution", () => {
+        const userAttributes = { userId: "Fake User" };
+        const documentId = "fakeId";
+        const attributionDirectoryName = "attribution";
+        const attributionKey = (key) => `${key}.attribution`;
+        let sharedDirectory;
+        let dataStoreContext;
+        // This function gets / creates the attribution directory for the given subdirectory path.
+        function getAttributionDirectory(root, path) {
+            if (!root.hasSubDirectory(attributionDirectoryName)) {
+                root.createSubDirectory(attributionDirectoryName);
+            }
+            let currentSubDir = root.getSubDirectory(attributionDirectoryName);
+            assert(currentSubDir);
+            if (path === "/") {
+                return currentSubDir;
+            }
+            let prevSubDir = currentSubDir;
+            const subdirs = path.substr(1).split("/");
+            for (const subdir of subdirs) {
+                currentSubDir = currentSubDir.getSubDirectory(subdir);
+                if (currentSubDir === undefined) {
+                    currentSubDir = prevSubDir.createSubDirectory(subdir);
+                    break;
+                }
+                prevSubDir = currentSubDir;
+            }
+            return currentSubDir;
+        }
+        /**
+         * This callback creates / gets an attribution directory that mirrors the actual directory. It sets the
+         * user attribute in the attribution directory against the same key used in the original set.
+         * For example - For directory /foo, it sets the attribute in /attribution/foo.
+         */
+        function mirrorDirectoryInterceptionCb(baseDirectory, subDirectory, key, value) {
+            const attributionDirectory = getAttributionDirectory(baseDirectory, subDirectory.absolutePath);
+            attributionDirectory.set(key, userAttributes);
+        }
+        /**
+         * This callback creates / gets an attribution directory that is a subdirectory of the given directory. It sets
+         * the user attribute in the attribution directory against the same key used in the original set.
+         * For example - For directory /foo, it sets the attribute in /foo/attribute
+         */
+        function subDirectoryinterceptionCb(baseDirectory, subDirectory, key, value) {
+            if (!subDirectory.hasSubDirectory(attributionDirectoryName)) {
+                subDirectory.createSubDirectory(attributionDirectoryName);
+            }
+            const attributionDirectory = subDirectory.getSubDirectory(attributionDirectoryName);
+            assert(attributionDirectory);
+            attributionDirectory.set(key, userAttributes);
+        }
+        // This callback sets the user attribution in the subdirectory against a key derived from the original key.
+        function setInterceptionCb(baseDirectory, subDirectory, key, value) {
+            subDirectory.set(attributionKey(key), userAttributes);
+        }
+        function orderSequentially(callback) {
+            callback();
+        }
+        beforeEach(() => {
+            const dataStoreRuntime = new MockFluidDataStoreRuntime();
+            sharedDirectory = new SharedDirectory(documentId, dataStoreRuntime, DirectoryFactory.Attributes);
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            dataStoreContext = {
+                containerRuntime: { orderSequentially },
+            };
+        });
+        // Verifies that the props are stored correctly in the attribution sub directory - a sub directory
+        // of the given directory with name `attributionDirectoryName`.
+        function verifySubDirectoryAttribution(directory, key, value, props) {
+            assert.equal(directory.get(key), value, "The retrieved value should match the value that was set");
+            const attributionDir = directory.getSubDirectory(attributionDirectoryName);
+            assert(attributionDir);
+            if (props === undefined) {
+                assert.equal(attributionDir, undefined, "The attribution directory should not exist because there was no interception");
+            }
+            else {
+                assert.deepEqual(attributionDir.get(key), props, "The user attributes set via the interception callback should exist.");
+            }
+        }
+        // Verifies that the props are stored correctly in the given directory under a key derived from the
+        // given key - under attributionKey(key).
+        function verifyDirectoryAttribution(directory, key, value, props) {
+            assert.equal(directory.get(key), value, "The retrieved value should match the value that was set");
+            if (props === undefined) {
+                assert.equal(directory.get(attributionKey(key)), undefined, "The user attributes should not exist because there was no interception");
+            }
+            else {
+                assert.deepEqual(directory.get(attributionKey(key)), props, "The user attributes set via the interception callback should exist.");
+            }
+        }
+        /**
+         * This test create two levels of directories as shown below:
+         * /
+         * /foo
+         * /foo/bar
+         *
+         * It mirrors this directory structure for storing attributes as shown below. It uses the baseDirectory
+         * in the interception callback to create this.
+         * /attribution
+         * /attribution/foo
+         * /attribution/foo/bar
+         *
+         * It tests that the wrapper returns the correct baseDirectory (root in this case). It also tests that the
+         * subdirectory created via the wrapper calls is wrapped and calls the interception callback.
+         */
+        it("should be able to create an attribution directory tree mirroring the actual directory tree", async () => {
+            const root = createDirectoryWithInterception(sharedDirectory, dataStoreContext, mirrorDirectoryInterceptionCb);
+            const key = "level";
+            let value = "root";
+            root.set(key, value);
+            assert.equal(root.get(key), value, "The retrieved value should match the value that was set");
+            // Verify that attribution directory `/attribution` was created for root and the user attribute
+            // set on it.
+            const rootAttribution = root.getSubDirectory(attributionDirectoryName);
+            assert(rootAttribution);
+            assert.equal(rootAttribution.get(key), userAttributes, "The user attrributes set via callback should exist");
+            // Create the level 1 directory `/foo`.
+            const foo = root.createSubDirectory("foo");
+            value = "level1";
+            foo.set(key, value);
+            assert.equal(foo.get(key), value, "The retrieved value should match the value that was set");
+            // Verify that attribution directory `/attribution/foo` was created for /foo and the user attribute
+            // set on it.
+            const fooAttribution = rootAttribution.getSubDirectory("foo");
+            assert(fooAttribution);
+            assert.equal(fooAttribution.get(key), userAttributes, "The user attributes set via callback should exist");
+            // Create the level 2 directory `/foo/bar`.
+            const bar = foo.createSubDirectory("bar");
+            value = "level2";
+            bar.set(key, value);
+            assert.equal(bar.get(key), value, "The retrieved value should match the value that was set");
+            // Verify that attribution directory `/attribution/foo/bar` was created for /foo/bar and the user
+            // attribute set on it.
+            const barAttribution = fooAttribution.getSubDirectory("bar");
+            assert(barAttribution);
+            assert.equal(barAttribution.get(key), userAttributes, "The user attributes set via callback should exist");
+        });
+        /**
+         * This test create two levels of directories as shown below:
+         * /
+         * /foo
+         * /foo/bar
+         *
+         * It creates an attribution subdirectory for each of the subdirectories as shown below:
+         * /attribution
+         * /foo/attribution
+         * /foo/bar/attribution
+         *
+         * It tests that the wrapper returns the correct subDirectory.
+         */
+        it("should be able to create an attribution directory for each subdirectory", async () => {
+            const root = createDirectoryWithInterception(sharedDirectory, dataStoreContext, subDirectoryinterceptionCb);
+            const key = "level";
+            let value = "root";
+            root.set(key, value);
+            verifySubDirectoryAttribution(root, key, value, userAttributes);
+            // Create the level 1 directory `/foo`.
+            const foo = root.createSubDirectory("foo");
+            value = "level1";
+            foo.set(key, value);
+            verifySubDirectoryAttribution(foo, key, value, userAttributes);
+            // Create the level 2 directory `/foo/bar`.
+            const bar = foo.createSubDirectory("bar");
+            value = "level2";
+            bar.set(key, value);
+            verifySubDirectoryAttribution(bar, key, value, userAttributes);
+        });
+        it("should be able to get a wrapped subDirectory via getSubDirectory/getWorkingDirectory", async () => {
+            const root = createDirectoryWithInterception(sharedDirectory, dataStoreContext, subDirectoryinterceptionCb);
+            // Create a sub directory and get it via getSubDirectory.
+            root.createSubDirectory("foo");
+            const foo = root.getSubDirectory("foo");
+            assert(foo);
+            // Set a key and verify that user attribute is set via the interception callback.
+            let key = "color";
+            let value = "green";
+            foo.set(key, value);
+            verifySubDirectoryAttribution(foo, key, value, userAttributes);
+            // Create a sub directory via the unwrapped object and get its working directory via the wrapper.
+            sharedDirectory.createSubDirectory("bar");
+            const bar = root.getWorkingDirectory("bar");
+            assert(bar);
+            // Set a key and verify that user attribute is set via the interception callback.
+            key = "permission";
+            value = "read";
+            bar.set(key, value);
+            verifySubDirectoryAttribution(bar, key, value, userAttributes);
+        });
+        it("should get undefined for non-existent subDirectory via getSubDirectory/getWorkingDirectory", async () => {
+            const root = createDirectoryWithInterception(sharedDirectory, dataStoreContext, subDirectoryinterceptionCb);
+            const foo = root.getSubDirectory("foo");
+            assert.strictEqual(foo, undefined);
+            const bar = root.getWorkingDirectory("bar");
+            assert.strictEqual(bar, undefined);
+        });
+        /**
+         * This test creates a wrapped shared directory. It then creates a subdirectory and creates another wrapper
+         * from the subdirectory. It verifies that the callback for both the root directory and subdirectory is
+         * called on a set on the wrapped subdirectory.
+         */
+        it("should be able to wrap a subDirectory in another interception wrapper", async () => {
+            const root = createDirectoryWithInterception(sharedDirectory, dataStoreContext, setInterceptionCb);
+            // Create a sub directory via the wrapper and wrap it in another interception wrapper.
+            const foo = root.createSubDirectory("foo");
+            const userEmail = "test@microsoft.com";
+            // Interception callback for wrapping the subdirectory that adds user email to the attribution.
+            function interceptionCb(baseDirectory, subDirectory, key, value) {
+                const attributes = subDirectory.get(attributionKey(key));
+                subDirectory.set(attributionKey(key), { ...attributes, userEmail });
+            }
+            const fooWithAttribution = createDirectoryWithInterception(foo, dataStoreContext, interceptionCb);
+            // Set a key and verify that user id and user email are set via the interception callbacks.
+            const permKey = "permission";
+            const permValue = "write";
+            fooWithAttribution.set(permKey, permValue);
+            verifyDirectoryAttribution(fooWithAttribution, permKey, permValue, {
+                ...userAttributes,
+                userEmail,
+            });
+        });
+        it("should be able to see changes made by the wrapper from the underlying shared directory", async () => {
+            const sharedDirectoryWithInterception = createDirectoryWithInterception(sharedDirectory, dataStoreContext, setInterceptionCb);
+            const key = "style";
+            const value = "bold";
+            sharedDirectoryWithInterception.set(key, value);
+            verifyDirectoryAttribution(sharedDirectory, key, value, userAttributes);
+        });
+        it("should be able to see changes made by the underlying shared directory from the wrapper", async () => {
+            const sharedDirectoryWithInterception = createDirectoryWithInterception(sharedDirectory, dataStoreContext, setInterceptionCb);
+            const key = "font";
+            const value = "Arial";
+            sharedDirectory.set(key, value);
+            verifyDirectoryAttribution(sharedDirectoryWithInterception, key, value);
+        });
+        /**
+         * This test calls set on the wrapper from the interception callback which will cause an infinite
+         * recursion. Verify that the wrapper detects this and asserts.
+         * Also, verify that the object is not unusable after the assert.
+         */
+        it("should assert if set is called on the wrapper from the callback causing infinite recursion", async () => {
+            // eslint-disable-next-line prefer-const
+            let sharedDirectoryWithInterception;
+            let useWrapper = true;
+            // If useWrapper above is true, this interception callback that calls a set on the wrapped object
+            // causing an infinite recursion.
+            // If useWrapper is false, it uses the passed subDirectory which does not cause recursion.
+            function recursiveInterceptionCb(baseDirectory, subDirectory, key, value) {
+                const directory = useWrapper ? sharedDirectoryWithInterception : subDirectory;
+                directory.set(attributionKey(key), userAttributes);
+            }
+            // Create the interception wrapper with the above callback. The set method should throw an assertion as this
+            // will cause infinite recursion.
+            sharedDirectoryWithInterception = createDirectoryWithInterception(sharedDirectory, dataStoreContext, recursiveInterceptionCb);
+            let asserted = false;
+            try {
+                sharedDirectoryWithInterception.set("color", "green");
+            }
+            catch (error) {
+                assert.strictEqual(error.message, "0x0bf", "We should have caught an assert in replaceText because it detects an infinite recursion");
+                asserted = true;
+            }
+            assert.equal(asserted, true, "The set call should have asserted because it detects inifinite recursion");
+            // Set useWrapper to false and call set on the wrapper again. Verify that the object is still usable and
+            // we do not get an assert anymore.
+            useWrapper = false;
+            const colorKey = "color";
+            const colorValue = "red";
+            sharedDirectoryWithInterception.set(colorKey, colorValue);
+            verifyDirectoryAttribution(sharedDirectoryWithInterception, colorKey, colorValue, userAttributes);
+        });
+    });
+});
+//# sourceMappingURL=sharedDirectoryWithInterception.spec.js.map

package/lib/test/sharedDirectoryWithInterception.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedDirectoryWithInterception.spec.js","sourceRoot":"","sources":["../../src/test/sharedDirectoryWithInterception.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAc,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEpF,OAAO,EAAE,+BAA+B,EAAE,MAAM,iBAAiB,CAAC;AAElE,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;IACnD,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACxC,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,QAAQ,CAAC;QAC5B,MAAM,wBAAwB,GAAG,aAAa,CAAC;QAC/C,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,GAAG,cAAc,CAAC;QAC7D,IAAI,eAAgC,CAAC;QACrC,IAAI,gBAAwC,CAAC;QAE7C,0FAA0F;QAC1F,SAAS,uBAAuB,CAAC,IAAgB,EAAE,IAAY;YAC9D,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,wBAAwB,CAAC,EAAE;gBACpD,IAAI,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;aAClD;YAED,IAAI,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC;YACnE,MAAM,CAAC,aAAa,CAAC,CAAC;YACtB,IAAI,IAAI,KAAK,GAAG,EAAE;gBACjB,OAAO,aAAa,CAAC;aACrB;YAED,IAAI,UAAU,GAAG,aAAa,CAAC;YAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC7B,aAAa,GAAG,aAAa,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBACtD,IAAI,aAAa,KAAK,SAAS,EAAE;oBAChC,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;oBACtD,MAAM;iBACN;gBACD,UAAU,GAAG,aAAa,CAAC;aAC3B;YACD,OAAO,aAAa,CAAC;QACtB,CAAC;QAED;;;;WAIG;QACH,SAAS,6BAA6B,CACrC,aAAyB,EACzB,YAAwB,EACxB,GAAW,EACX,KAAU;YAEV,MAAM,oBAAoB,GAAe,uBAAuB,CAC/D,aAAa,EACb,YAAY,CAAC,YAAY,CACzB,CAAC;YACF,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC/C,CAAC;QAED;;;;WAIG;QACH,SAAS,0BAA0B,CAClC,aAAyB,EACzB,YAAwB,EACxB,GAAW,EACX,KAAU;YAEV,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,wBAAwB,CAAC,EAAE;gBAC5D,YAAY,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;aAC1D;YACD,MAAM,oBAAoB,GAAG,YAAY,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC;YACpF,MAAM,CAAC,oBAAoB,CAAC,CAAC;YAC7B,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC/C,CAAC;QAED,2GAA2G;QAC3G,SAAS,iBAAiB,CACzB,aAAyB,EACzB,YAAwB,EACxB,GAAW,EACX,KAAU;YAEV,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC;QACvD,CAAC;QAED,SAAS,iBAAiB,CAAC,QAAoB;YAC9C,QAAQ,EAAE,CAAC;QACZ,CAAC;QAED,UAAU,CAAC,GAAG,EAAE;YACf,MAAM,gBAAgB,GAAG,IAAI,yBAAyB,EAAE,CAAC;YACzD,eAAe,GAAG,IAAI,eAAe,CACpC,UAAU,EACV,gBAAgB,EAChB,gBAAgB,CAAC,UAAU,CAC3B,CAAC;YAEF,yEAAyE;YACzE,gBAAgB,GAAG;gBAClB,gBAAgB,EAAE,EAAE,iBAAiB,EAAE;aACb,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,kGAAkG;QAClG,+DAA+D;QAC/D,SAAS,6BAA6B,CACrC,SAAqB,EACrB,GAAW,EACX,KAAa,EACb,KAAW;YAEX,MAAM,CAAC,KAAK,CACX,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAClB,KAAK,EACL,yDAAyD,CACzD,CAAC;YAEF,MAAM,cAAc,GAAG,SAAS,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC;YAC3E,MAAM,CAAC,cAAc,CAAC,CAAC;YACvB,IAAI,KAAK,KAAK,SAAS,EAAE;gBACxB,MAAM,CAAC,KAAK,CACX,cAAc,EACd,SAAS,EACT,8EAA8E,CAC9E,CAAC;aACF;iBAAM;gBACN,MAAM,CAAC,SAAS,CACf,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EACvB,KAAK,EACL,qEAAqE,CACrE,CAAC;aACF;QACF,CAAC;QAED,mGAAmG;QACnG,yCAAyC;QACzC,SAAS,0BAA0B,CAClC,SAAqB,EACrB,GAAW,EACX,KAAa,EACb,KAAW;YAEX,MAAM,CAAC,KAAK,CACX,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAClB,KAAK,EACL,yDAAyD,CACzD,CAAC;YAEF,IAAI,KAAK,KAAK,SAAS,EAAE;gBACxB,MAAM,CAAC,KAAK,CACX,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAClC,SAAS,EACT,wEAAwE,CACxE,CAAC;aACF;iBAAM;gBACN,MAAM,CAAC,SAAS,CACf,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAClC,KAAK,EACL,qEAAqE,CACrE,CAAC;aACF;QACF,CAAC;QAED;;;;;;;;;;;;;;WAcG;QACH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;YAC3G,MAAM,IAAI,GAAG,+BAA+B,CAC3C,eAAe,EACf,gBAAgB,EAChB,6BAA6B,CAC7B,CAAC;YAEF,MAAM,GAAG,GAAW,OAAO,CAAC;YAC5B,IAAI,KAAK,GAAW,MAAM,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACrB,MAAM,CAAC,KAAK,CACX,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EACb,KAAK,EACL,yDAAyD,CACzD,CAAC;YAEF,+FAA+F;YAC/F,aAAa;YACb,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC;YACvE,MAAM,CAAC,eAAe,CAAC,CAAC;YACxB,MAAM,CAAC,KAAK,CACX,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EACxB,cAAc,EACd,oDAAoD,CACpD,CAAC;YAEF,uCAAuC;YACvC,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,KAAK,GAAG,QAAQ,CAAC;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpB,MAAM,CAAC,KAAK,CACX,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EACZ,KAAK,EACL,yDAAyD,CACzD,CAAC;YAEF,mGAAmG;YACnG,aAAa;YACb,MAAM,cAAc,GAAG,eAAe,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAC9D,MAAM,CAAC,cAAc,CAAC,CAAC;YACvB,MAAM,CAAC,KAAK,CACX,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EACvB,cAAc,EACd,mDAAmD,CACnD,CAAC;YAEF,2CAA2C;YAC3C,MAAM,GAAG,GAAG,GAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,KAAK,GAAG,QAAQ,CAAC;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpB,MAAM,CAAC,KAAK,CACX,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EACZ,KAAK,EACL,yDAAyD,CACzD,CAAC;YAEF,iGAAiG;YACjG,uBAAuB;YACvB,MAAM,cAAc,GAAG,cAAc,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAC7D,MAAM,CAAC,cAAc,CAAC,CAAC;YACvB,MAAM,CAAC,KAAK,CACX,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EACvB,cAAc,EACd,mDAAmD,CACnD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH;;;;;;;;;;;;WAYG;QACH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,IAAI,GAAG,+BAA+B,CAC3C,eAAe,EACf,gBAAgB,EAChB,0BAA0B,CAC1B,CAAC;YACF,MAAM,GAAG,GAAW,OAAO,CAAC;YAC5B,IAAI,KAAK,GAAW,MAAM,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACrB,6BAA6B,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YAEhE,uCAAuC;YACvC,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,KAAK,GAAG,QAAQ,CAAC;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpB,6BAA6B,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YAE/D,2CAA2C;YAC3C,MAAM,GAAG,GAAG,GAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,KAAK,GAAG,QAAQ,CAAC;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpB,6BAA6B,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;YACrG,MAAM,IAAI,GAAG,+BAA+B,CAC3C,eAAe,EACf,gBAAgB,EAChB,0BAA0B,CAC1B,CAAC;YAEF,yDAAyD;YACzD,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACxC,MAAM,CAAC,GAAG,CAAC,CAAC;YAEZ,iFAAiF;YACjF,IAAI,GAAG,GAAW,OAAO,CAAC;YAC1B,IAAI,KAAK,GAAW,OAAO,CAAC;YAC5B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpB,6BAA6B,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YAE/D,iGAAiG;YACjG,eAAe,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,CAAC,GAAG,CAAC,CAAC;YAEZ,iFAAiF;YACjF,GAAG,GAAG,YAAY,CAAC;YACnB,KAAK,GAAG,MAAM,CAAC;YACf,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpB,6BAA6B,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;YAC3G,MAAM,IAAI,GAAG,+BAA+B,CAC3C,eAAe,EACf,gBAAgB,EAChB,0BAA0B,CAC1B,CAAC;YAEF,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACxC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAEnC,MAAM,GAAG,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH;;;;WAIG;QACH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;YACtF,MAAM,IAAI,GAAG,+BAA+B,CAC3C,eAAe,EACf,gBAAgB,EAChB,iBAAiB,CACjB,CAAC;YAEF,sFAAsF;YACtF,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,MAAM,SAAS,GAAG,oBAAoB,CAAC;YAEvC,+FAA+F;YAC/F,SAAS,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK;gBAC9D,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;gBACzD,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,kBAAkB,GAAG,+BAA+B,CACzD,GAAG,EACH,gBAAgB,EAChB,cAAc,CACd,CAAC;YAEF,2FAA2F;YAC3F,MAAM,OAAO,GAAW,YAAY,CAAC;YACrC,MAAM,SAAS,GAAW,OAAO,CAAC;YAClC,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC3C,0BAA0B,CAAC,kBAAkB,EAAE,OAAO,EAAE,SAAS,EAAE;gBAClE,GAAG,cAAc;gBACjB,SAAS;aACT,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wFAAwF,EAAE,KAAK,IAAI,EAAE;YACvG,MAAM,+BAA+B,GAAG,+BAA+B,CACtE,eAAe,EACf,gBAAgB,EAChB,iBAAiB,CACjB,CAAC;YACF,MAAM,GAAG,GAAW,OAAO,CAAC;YAC5B,MAAM,KAAK,GAAW,MAAM,CAAC;YAC7B,+BAA+B,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAChD,0BAA0B,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wFAAwF,EAAE,KAAK,IAAI,EAAE;YACvG,MAAM,+BAA+B,GAAG,+BAA+B,CACtE,eAAe,EACf,gBAAgB,EAChB,iBAAiB,CACjB,CAAC;YACF,MAAM,GAAG,GAAW,MAAM,CAAC;YAC3B,MAAM,KAAK,GAAW,OAAO,CAAC;YAC9B,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAChC,0BAA0B,CAAC,+BAA+B,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH;;;;WAIG;QACH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;YAC3G,wCAAwC;YACxC,IAAI,+BAAgD,CAAC;YAErD,IAAI,UAAU,GAAY,IAAI,CAAC;YAC/B,iGAAiG;YACjG,iCAAiC;YACjC,0FAA0F;YAC1F,SAAS,uBAAuB,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK;gBACvE,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,YAAY,CAAC;gBAC9E,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC;YACpD,CAAC;YAED,4GAA4G;YAC5G,iCAAiC;YACjC,+BAA+B,GAAG,+BAA+B,CAChE,eAAe,EACf,gBAAgB,EAChB,uBAAuB,CACvB,CAAC;YAEF,IAAI,QAAQ,GAAY,KAAK,CAAC;YAC9B,IAAI;gBACH,+BAA+B,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;aACtD;YAAC,OAAO,KAAU,EAAE;gBACpB,MAAM,CAAC,WAAW,CACjB,KAAK,CAAC,OAAO,EACb,OAAO,EACP,yFAAyF,CACzF,CAAC;gBACF,QAAQ,GAAG,IAAI,CAAC;aAChB;YACD,MAAM,CAAC,KAAK,CACX,QAAQ,EACR,IAAI,EACJ,0EAA0E,CAC1E,CAAC;YAEF,wGAAwG;YACxG,mCAAmC;YACnC,UAAU,GAAG,KAAK,CAAC;YACnB,MAAM,QAAQ,GAAW,OAAO,CAAC;YACjC,MAAM,UAAU,GAAW,KAAK,CAAC;YACjC,+BAA+B,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YAC1D,0BAA0B,CACzB,+BAA+B,EAC/B,QAAQ,EACR,UAAU,EACV,cAAc,CACd,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { MockFluidDataStoreRuntime } from \"@fluidframework/test-runtime-utils\";\nimport { IDirectory, SharedDirectory, DirectoryFactory } from \"@fluidframework/map\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { createDirectoryWithInterception } from \"../map/index.js\";\n\ndescribe(\"Shared Directory with Interception\", () => {\n\tdescribe(\"Simple User Attribution\", () => {\n\t\tconst userAttributes = { userId: \"Fake User\" };\n\t\tconst documentId = \"fakeId\";\n\t\tconst attributionDirectoryName = \"attribution\";\n\t\tconst attributionKey = (key: string) => `${key}.attribution`;\n\t\tlet sharedDirectory: SharedDirectory;\n\t\tlet dataStoreContext: IFluidDataStoreContext;\n\n\t\t// This function gets / creates the attribution directory for the given subdirectory path.\n\t\tfunction getAttributionDirectory(root: IDirectory, path: string) {\n\t\t\tif (!root.hasSubDirectory(attributionDirectoryName)) {\n\t\t\t\troot.createSubDirectory(attributionDirectoryName);\n\t\t\t}\n\n\t\t\tlet currentSubDir = root.getSubDirectory(attributionDirectoryName);\n\t\t\tassert(currentSubDir);\n\t\t\tif (path === \"/\") {\n\t\t\t\treturn currentSubDir;\n\t\t\t}\n\n\t\t\tlet prevSubDir = currentSubDir;\n\t\t\tconst subdirs = path.substr(1).split(\"/\");\n\t\t\tfor (const subdir of subdirs) {\n\t\t\t\tcurrentSubDir = currentSubDir.getSubDirectory(subdir);\n\t\t\t\tif (currentSubDir === undefined) {\n\t\t\t\t\tcurrentSubDir = prevSubDir.createSubDirectory(subdir);\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tprevSubDir = currentSubDir;\n\t\t\t}\n\t\t\treturn currentSubDir;\n\t\t}\n\n\t\t/**\n\t\t * This callback creates / gets an attribution directory that mirrors the actual directory. It sets the\n\t\t * user attribute in the attribution directory against the same key used in the original set.\n\t\t * For example - For directory /foo, it sets the attribute in /attribution/foo.\n\t\t */\n\t\tfunction mirrorDirectoryInterceptionCb(\n\t\t\tbaseDirectory: IDirectory,\n\t\t\tsubDirectory: IDirectory,\n\t\t\tkey: string,\n\t\t\tvalue: any,\n\t\t): void {\n\t\t\tconst attributionDirectory: IDirectory = getAttributionDirectory(\n\t\t\t\tbaseDirectory,\n\t\t\t\tsubDirectory.absolutePath,\n\t\t\t);\n\t\t\tattributionDirectory.set(key, userAttributes);\n\t\t}\n\n\t\t/**\n\t\t * This callback creates / gets an attribution directory that is a subdirectory of the given directory. It sets\n\t\t * the user attribute in the attribution directory against the same key used in the original set.\n\t\t * For example - For directory /foo, it sets the attribute in /foo/attribute\n\t\t */\n\t\tfunction subDirectoryinterceptionCb(\n\t\t\tbaseDirectory: IDirectory,\n\t\t\tsubDirectory: IDirectory,\n\t\t\tkey: string,\n\t\t\tvalue: any,\n\t\t): void {\n\t\t\tif (!subDirectory.hasSubDirectory(attributionDirectoryName)) {\n\t\t\t\tsubDirectory.createSubDirectory(attributionDirectoryName);\n\t\t\t}\n\t\t\tconst attributionDirectory = subDirectory.getSubDirectory(attributionDirectoryName);\n\t\t\tassert(attributionDirectory);\n\t\t\tattributionDirectory.set(key, userAttributes);\n\t\t}\n\n\t\t// This callback sets the user attribution in the subdirectory against a key derived from the original key.\n\t\tfunction setInterceptionCb(\n\t\t\tbaseDirectory: IDirectory,\n\t\t\tsubDirectory: IDirectory,\n\t\t\tkey: string,\n\t\t\tvalue: any,\n\t\t): void {\n\t\t\tsubDirectory.set(attributionKey(key), userAttributes);\n\t\t}\n\n\t\tfunction orderSequentially(callback: () => void): void {\n\t\t\tcallback();\n\t\t}\n\n\t\tbeforeEach(() => {\n\t\t\tconst dataStoreRuntime = new MockFluidDataStoreRuntime();\n\t\t\tsharedDirectory = new SharedDirectory(\n\t\t\t\tdocumentId,\n\t\t\t\tdataStoreRuntime,\n\t\t\t\tDirectoryFactory.Attributes,\n\t\t\t);\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n\t\t\tdataStoreContext = {\n\t\t\t\tcontainerRuntime: { orderSequentially },\n\t\t\t} as IFluidDataStoreContext;\n\t\t});\n\n\t\t// Verifies that the props are stored correctly in the attribution sub directory - a sub directory\n\t\t// of the given directory with name `attributionDirectoryName`.\n\t\tfunction verifySubDirectoryAttribution(\n\t\t\tdirectory: IDirectory,\n\t\t\tkey: string,\n\t\t\tvalue: string,\n\t\t\tprops?: any,\n\t\t) {\n\t\t\tassert.equal(\n\t\t\t\tdirectory.get(key),\n\t\t\t\tvalue,\n\t\t\t\t\"The retrieved value should match the value that was set\",\n\t\t\t);\n\n\t\t\tconst attributionDir = directory.getSubDirectory(attributionDirectoryName);\n\t\t\tassert(attributionDir);\n\t\t\tif (props === undefined) {\n\t\t\t\tassert.equal(\n\t\t\t\t\tattributionDir,\n\t\t\t\t\tundefined,\n\t\t\t\t\t\"The attribution directory should not exist because there was no interception\",\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tassert.deepEqual(\n\t\t\t\t\tattributionDir.get(key),\n\t\t\t\t\tprops,\n\t\t\t\t\t\"The user attributes set via the interception callback should exist.\",\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\t// Verifies that the props are stored correctly in the given directory under a key derived from the\n\t\t// given key - under attributionKey(key).\n\t\tfunction verifyDirectoryAttribution(\n\t\t\tdirectory: IDirectory,\n\t\t\tkey: string,\n\t\t\tvalue: string,\n\t\t\tprops?: any,\n\t\t) {\n\t\t\tassert.equal(\n\t\t\t\tdirectory.get(key),\n\t\t\t\tvalue,\n\t\t\t\t\"The retrieved value should match the value that was set\",\n\t\t\t);\n\n\t\t\tif (props === undefined) {\n\t\t\t\tassert.equal(\n\t\t\t\t\tdirectory.get(attributionKey(key)),\n\t\t\t\t\tundefined,\n\t\t\t\t\t\"The user attributes should not exist because there was no interception\",\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tassert.deepEqual(\n\t\t\t\t\tdirectory.get(attributionKey(key)),\n\t\t\t\t\tprops,\n\t\t\t\t\t\"The user attributes set via the interception callback should exist.\",\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\t/**\n\t\t * This test create two levels of directories as shown below:\n\t\t * /\n\t\t * /foo\n\t\t * /foo/bar\n\t\t *\n\t\t * It mirrors this directory structure for storing attributes as shown below. It uses the baseDirectory\n\t\t * in the interception callback to create this.\n\t\t * /attribution\n\t\t * /attribution/foo\n\t\t * /attribution/foo/bar\n\t\t *\n\t\t * It tests that the wrapper returns the correct baseDirectory (root in this case). It also tests that the\n\t\t * subdirectory created via the wrapper calls is wrapped and calls the interception callback.\n\t\t */\n\t\tit(\"should be able to create an attribution directory tree mirroring the actual directory tree\", async () => {\n\t\t\tconst root = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\tmirrorDirectoryInterceptionCb,\n\t\t\t);\n\n\t\t\tconst key: string = \"level\";\n\t\t\tlet value: string = \"root\";\n\t\t\troot.set(key, value);\n\t\t\tassert.equal(\n\t\t\t\troot.get(key),\n\t\t\t\tvalue,\n\t\t\t\t\"The retrieved value should match the value that was set\",\n\t\t\t);\n\n\t\t\t// Verify that attribution directory `/attribution` was created for root and the user attribute\n\t\t\t// set on it.\n\t\t\tconst rootAttribution = root.getSubDirectory(attributionDirectoryName);\n\t\t\tassert(rootAttribution);\n\t\t\tassert.equal(\n\t\t\t\trootAttribution.get(key),\n\t\t\t\tuserAttributes,\n\t\t\t\t\"The user attrributes set via callback should exist\",\n\t\t\t);\n\n\t\t\t// Create the level 1 directory `/foo`.\n\t\t\tconst foo = root.createSubDirectory(\"foo\");\n\t\t\tvalue = \"level1\";\n\t\t\tfoo.set(key, value);\n\t\t\tassert.equal(\n\t\t\t\tfoo.get(key),\n\t\t\t\tvalue,\n\t\t\t\t\"The retrieved value should match the value that was set\",\n\t\t\t);\n\n\t\t\t// Verify that attribution directory `/attribution/foo` was created for /foo and the user attribute\n\t\t\t// set on it.\n\t\t\tconst fooAttribution = rootAttribution.getSubDirectory(\"foo\");\n\t\t\tassert(fooAttribution);\n\t\t\tassert.equal(\n\t\t\t\tfooAttribution.get(key),\n\t\t\t\tuserAttributes,\n\t\t\t\t\"The user attributes set via callback should exist\",\n\t\t\t);\n\n\t\t\t// Create the level 2 directory `/foo/bar`.\n\t\t\tconst bar = foo.createSubDirectory(\"bar\");\n\t\t\tvalue = \"level2\";\n\t\t\tbar.set(key, value);\n\t\t\tassert.equal(\n\t\t\t\tbar.get(key),\n\t\t\t\tvalue,\n\t\t\t\t\"The retrieved value should match the value that was set\",\n\t\t\t);\n\n\t\t\t// Verify that attribution directory `/attribution/foo/bar` was created for /foo/bar and the user\n\t\t\t// attribute set on it.\n\t\t\tconst barAttribution = fooAttribution.getSubDirectory(\"bar\");\n\t\t\tassert(barAttribution);\n\t\t\tassert.equal(\n\t\t\t\tbarAttribution.get(key),\n\t\t\t\tuserAttributes,\n\t\t\t\t\"The user attributes set via callback should exist\",\n\t\t\t);\n\t\t});\n\n\t\t/**\n\t\t * This test create two levels of directories as shown below:\n\t\t * /\n\t\t * /foo\n\t\t * /foo/bar\n\t\t *\n\t\t * It creates an attribution subdirectory for each of the subdirectories as shown below:\n\t\t * /attribution\n\t\t * /foo/attribution\n\t\t * /foo/bar/attribution\n\t\t *\n\t\t * It tests that the wrapper returns the correct subDirectory.\n\t\t */\n\t\tit(\"should be able to create an attribution directory for each subdirectory\", async () => {\n\t\t\tconst root = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\tsubDirectoryinterceptionCb,\n\t\t\t);\n\t\t\tconst key: string = \"level\";\n\t\t\tlet value: string = \"root\";\n\t\t\troot.set(key, value);\n\t\t\tverifySubDirectoryAttribution(root, key, value, userAttributes);\n\n\t\t\t// Create the level 1 directory `/foo`.\n\t\t\tconst foo = root.createSubDirectory(\"foo\");\n\t\t\tvalue = \"level1\";\n\t\t\tfoo.set(key, value);\n\t\t\tverifySubDirectoryAttribution(foo, key, value, userAttributes);\n\n\t\t\t// Create the level 2 directory `/foo/bar`.\n\t\t\tconst bar = foo.createSubDirectory(\"bar\");\n\t\t\tvalue = \"level2\";\n\t\t\tbar.set(key, value);\n\t\t\tverifySubDirectoryAttribution(bar, key, value, userAttributes);\n\t\t});\n\n\t\tit(\"should be able to get a wrapped subDirectory via getSubDirectory/getWorkingDirectory\", async () => {\n\t\t\tconst root = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\tsubDirectoryinterceptionCb,\n\t\t\t);\n\n\t\t\t// Create a sub directory and get it via getSubDirectory.\n\t\t\troot.createSubDirectory(\"foo\");\n\t\t\tconst foo = root.getSubDirectory(\"foo\");\n\t\t\tassert(foo);\n\n\t\t\t// Set a key and verify that user attribute is set via the interception callback.\n\t\t\tlet key: string = \"color\";\n\t\t\tlet value: string = \"green\";\n\t\t\tfoo.set(key, value);\n\t\t\tverifySubDirectoryAttribution(foo, key, value, userAttributes);\n\n\t\t\t// Create a sub directory via the unwrapped object and get its working directory via the wrapper.\n\t\t\tsharedDirectory.createSubDirectory(\"bar\");\n\t\t\tconst bar = root.getWorkingDirectory(\"bar\");\n\t\t\tassert(bar);\n\n\t\t\t// Set a key and verify that user attribute is set via the interception callback.\n\t\t\tkey = \"permission\";\n\t\t\tvalue = \"read\";\n\t\t\tbar.set(key, value);\n\t\t\tverifySubDirectoryAttribution(bar, key, value, userAttributes);\n\t\t});\n\n\t\tit(\"should get undefined for non-existent subDirectory via getSubDirectory/getWorkingDirectory\", async () => {\n\t\t\tconst root = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\tsubDirectoryinterceptionCb,\n\t\t\t);\n\n\t\t\tconst foo = root.getSubDirectory(\"foo\");\n\t\t\tassert.strictEqual(foo, undefined);\n\n\t\t\tconst bar = root.getWorkingDirectory(\"bar\");\n\t\t\tassert.strictEqual(bar, undefined);\n\t\t});\n\n\t\t/**\n\t\t * This test creates a wrapped shared directory. It then creates a subdirectory and creates another wrapper\n\t\t * from the subdirectory. It verifies that the callback for both the root directory and subdirectory is\n\t\t * called on a set on the wrapped subdirectory.\n\t\t */\n\t\tit(\"should be able to wrap a subDirectory in another interception wrapper\", async () => {\n\t\t\tconst root = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\tsetInterceptionCb,\n\t\t\t);\n\n\t\t\t// Create a sub directory via the wrapper and wrap it in another interception wrapper.\n\t\t\tconst foo = root.createSubDirectory(\"foo\");\n\t\t\tconst userEmail = \"test@microsoft.com\";\n\n\t\t\t// Interception callback for wrapping the subdirectory that adds user email to the attribution.\n\t\t\tfunction interceptionCb(baseDirectory, subDirectory, key, value) {\n\t\t\t\tconst attributes = subDirectory.get(attributionKey(key));\n\t\t\t\tsubDirectory.set(attributionKey(key), { ...attributes, userEmail });\n\t\t\t}\n\t\t\tconst fooWithAttribution = createDirectoryWithInterception(\n\t\t\t\tfoo,\n\t\t\t\tdataStoreContext,\n\t\t\t\tinterceptionCb,\n\t\t\t);\n\n\t\t\t// Set a key and verify that user id and user email are set via the interception callbacks.\n\t\t\tconst permKey: string = \"permission\";\n\t\t\tconst permValue: string = \"write\";\n\t\t\tfooWithAttribution.set(permKey, permValue);\n\t\t\tverifyDirectoryAttribution(fooWithAttribution, permKey, permValue, {\n\t\t\t\t...userAttributes,\n\t\t\t\tuserEmail,\n\t\t\t});\n\t\t});\n\n\t\tit(\"should be able to see changes made by the wrapper from the underlying shared directory\", async () => {\n\t\t\tconst sharedDirectoryWithInterception = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\tsetInterceptionCb,\n\t\t\t);\n\t\t\tconst key: string = \"style\";\n\t\t\tconst value: string = \"bold\";\n\t\t\tsharedDirectoryWithInterception.set(key, value);\n\t\t\tverifyDirectoryAttribution(sharedDirectory, key, value, userAttributes);\n\t\t});\n\n\t\tit(\"should be able to see changes made by the underlying shared directory from the wrapper\", async () => {\n\t\t\tconst sharedDirectoryWithInterception = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\tsetInterceptionCb,\n\t\t\t);\n\t\t\tconst key: string = \"font\";\n\t\t\tconst value: string = \"Arial\";\n\t\t\tsharedDirectory.set(key, value);\n\t\t\tverifyDirectoryAttribution(sharedDirectoryWithInterception, key, value);\n\t\t});\n\n\t\t/**\n\t\t * This test calls set on the wrapper from the interception callback which will cause an infinite\n\t\t * recursion. Verify that the wrapper detects this and asserts.\n\t\t * Also, verify that the object is not unusable after the assert.\n\t\t */\n\t\tit(\"should assert if set is called on the wrapper from the callback causing infinite recursion\", async () => {\n\t\t\t// eslint-disable-next-line prefer-const\n\t\t\tlet sharedDirectoryWithInterception: SharedDirectory;\n\n\t\t\tlet useWrapper: boolean = true;\n\t\t\t// If useWrapper above is true, this interception callback that calls a set on the wrapped object\n\t\t\t// causing an infinite recursion.\n\t\t\t// If useWrapper is false, it uses the passed subDirectory which does not cause recursion.\n\t\t\tfunction recursiveInterceptionCb(baseDirectory, subDirectory, key, value) {\n\t\t\t\tconst directory = useWrapper ? sharedDirectoryWithInterception : subDirectory;\n\t\t\t\tdirectory.set(attributionKey(key), userAttributes);\n\t\t\t}\n\n\t\t\t// Create the interception wrapper with the above callback. The set method should throw an assertion as this\n\t\t\t// will cause infinite recursion.\n\t\t\tsharedDirectoryWithInterception = createDirectoryWithInterception(\n\t\t\t\tsharedDirectory,\n\t\t\t\tdataStoreContext,\n\t\t\t\trecursiveInterceptionCb,\n\t\t\t);\n\n\t\t\tlet asserted: boolean = false;\n\t\t\ttry {\n\t\t\t\tsharedDirectoryWithInterception.set(\"color\", \"green\");\n\t\t\t} catch (error: any) {\n\t\t\t\tassert.strictEqual(\n\t\t\t\t\terror.message,\n\t\t\t\t\t\"0x0bf\",\n\t\t\t\t\t\"We should have caught an assert in replaceText because it detects an infinite recursion\",\n\t\t\t\t);\n\t\t\t\tasserted = true;\n\t\t\t}\n\t\t\tassert.equal(\n\t\t\t\tasserted,\n\t\t\t\ttrue,\n\t\t\t\t\"The set call should have asserted because it detects inifinite recursion\",\n\t\t\t);\n\n\t\t\t// Set useWrapper to false and call set on the wrapper again. Verify that the object is still usable and\n\t\t\t// we do not get an assert anymore.\n\t\t\tuseWrapper = false;\n\t\t\tconst colorKey: string = \"color\";\n\t\t\tconst colorValue: string = \"red\";\n\t\t\tsharedDirectoryWithInterception.set(colorKey, colorValue);\n\t\t\tverifyDirectoryAttribution(\n\t\t\t\tsharedDirectoryWithInterception,\n\t\t\t\tcolorKey,\n\t\t\t\tcolorValue,\n\t\t\t\tuserAttributes,\n\t\t\t);\n\t\t});\n\t});\n});\n"]}

package/lib/test/sharedMapWithInterception.spec.js

@@ -0,0 +1,105 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MockFluidDataStoreRuntime } from "@fluidframework/test-runtime-utils";
+import { SharedMap } from "@fluidframework/map";
+import { createSharedMapWithInterception } from "../map/index.js";
+describe("Shared Map with Interception", () => {
+    describe("Simple User Attribution", () => {
+        /**
+         * The following tests test simple user attribution in SharedMap with interception.
+         * In the callback function of the SharedMap with inteception, it sets the user
+         * attribution information in the underlying SharedMap against <key>.attribution.
+         */
+        const userAttributes = { userId: "Fake User" };
+        const documentId = "fakeId";
+        const attributionKey = (key) => `${key}.attribution`;
+        let sharedMap;
+        let dataStoreContext;
+        function orderSequentially(callback) {
+            callback();
+        }
+        function interceptionCb(map, key, value) {
+            map.set(attributionKey(key), userAttributes);
+        }
+        beforeEach(() => {
+            const dataStoreRuntime = new MockFluidDataStoreRuntime();
+            sharedMap = SharedMap.getFactory().create(dataStoreRuntime, documentId);
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            dataStoreContext = {
+                containerRuntime: { orderSequentially },
+            };
+        });
+        // Verifies that the props are stored correctly in the given map under a key derived from the
+        // given key - under attributionKey(key).
+        function verifyMapAttribution(map, key, value, props) {
+            assert.equal(map.get(key), value, "The retrieved value should match the value that was set");
+            if (props === undefined) {
+                assert.equal(map.get(attributionKey(key)), undefined, "The user attributes should not exist because there was no interception");
+            }
+            else {
+                assert.deepEqual(map.get(attributionKey(key)), props, "The user attributes set via the interception callback should exist.");
+            }
+        }
+        it("should be able to intercept SharedMap set method in the wrapper", async () => {
+            const sharedMapWithInterception = createSharedMapWithInterception(sharedMap, dataStoreContext, interceptionCb);
+            const key = "color";
+            const value = "green";
+            sharedMapWithInterception.set(key, value);
+            verifyMapAttribution(sharedMapWithInterception, key, value, userAttributes);
+        });
+        it("should be able to see changes made by the wrapper from the underlying shared map", async () => {
+            const sharedMapWithInterception = createSharedMapWithInterception(sharedMap, dataStoreContext, interceptionCb);
+            const key = "style";
+            const value = "bold";
+            sharedMapWithInterception.set(key, value);
+            verifyMapAttribution(sharedMap, key, value, userAttributes);
+        });
+        it("should be able to see changes made by the underlying shared map from the wrapper", async () => {
+            const sharedMapWithInterception = createSharedMapWithInterception(sharedMap, dataStoreContext, interceptionCb);
+            const key = "font";
+            const value = "Arial";
+            sharedMap.set(key, value);
+            verifyMapAttribution(sharedMapWithInterception, key, value);
+        });
+        /**
+         * This test calls set on the wrapper from the interception callback which will cause an infinite
+         * recursion. Verify that the wrapper detects this and asserts.
+         * Also, verify that the object is not unusable after the assert.
+         */
+        it("should assert if set is called on the wrapper from the callback causing infinite recursion", async () => {
+            // eslint-disable-next-line prefer-const
+            let sharedMapWithInterception;
+            let useWrapper = true;
+            // If useWrapper above is true, this interception callback that calls a set on the wrapped object
+            // causing an infinite recursion.
+            // If useWrapper is false, it uses the passed sharedMap which does not cause recursion.
+            function recursiveInterceptionCb(map, key, value) {
+                const localMap = useWrapper ? sharedMapWithInterception : sharedMap;
+                localMap.set(attributionKey(key), userAttributes);
+            }
+            // Create the interception wrapper with a callback that calls set on the wrapper. The set method should
+            // throw an assertion as this will cause infinite recursion.
+            sharedMapWithInterception = createSharedMapWithInterception(sharedMap, dataStoreContext, recursiveInterceptionCb);
+            let asserted = false;
+            try {
+                sharedMapWithInterception.set("color", "green");
+            }
+            catch (error) {
+                assert.strictEqual(error.message, "0x0c0", "We should have caught an assert in replaceText because it detects an infinite recursion");
+                asserted = true;
+            }
+            assert.equal(asserted, true, "The set call should have asserted because it detects inifinite recursion");
+            // Set useWrapper to false and call set on the wrapper again. Verify that the object is still usable and
+            // we do not get an assert anymore.
+            useWrapper = false;
+            const colorKey = "color";
+            const colorValue = "red";
+            sharedMapWithInterception.set(colorKey, colorValue);
+            verifyMapAttribution(sharedMapWithInterception, colorKey, colorValue, userAttributes);
+        });
+    });
+});
+//# sourceMappingURL=sharedMapWithInterception.spec.js.map

package/lib/test/sharedMapWithInterception.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedMapWithInterception.spec.js","sourceRoot":"","sources":["../../src/test/sharedMapWithInterception.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAE5D,OAAO,EAAE,+BAA+B,EAAE,MAAM,iBAAiB,CAAC;AAElE,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACxC;;;;WAIG;QACH,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,QAAQ,CAAC;QAC5B,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,GAAG,cAAc,CAAC;QAC7D,IAAI,SAAqB,CAAC;QAC1B,IAAI,gBAAwC,CAAC;QAE7C,SAAS,iBAAiB,CAAC,QAAoB;YAC9C,QAAQ,EAAE,CAAC;QACZ,CAAC;QAED,SAAS,cAAc,CAAC,GAAe,EAAE,GAAW,EAAE,KAAU;YAC/D,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC;QAC9C,CAAC;QAED,UAAU,CAAC,GAAG,EAAE;YACf,MAAM,gBAAgB,GAAG,IAAI,yBAAyB,EAAE,CAAC;YACzD,SAAS,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YAExE,yEAAyE;YACzE,gBAAgB,GAAG;gBAClB,gBAAgB,EAAE,EAAE,iBAAiB,EAAE;aACb,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,6FAA6F;QAC7F,yCAAyC;QACzC,SAAS,oBAAoB,CAAC,GAAe,EAAE,GAAW,EAAE,KAAa,EAAE,KAAW;YACrF,MAAM,CAAC,KAAK,CACX,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EACZ,KAAK,EACL,yDAAyD,CACzD,CAAC;YAEF,IAAI,KAAK,KAAK,SAAS,EAAE;gBACxB,MAAM,CAAC,KAAK,CACX,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAC5B,SAAS,EACT,wEAAwE,CACxE,CAAC;aACF;iBAAM;gBACN,MAAM,CAAC,SAAS,CACf,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAC5B,KAAK,EACL,qEAAqE,CACrE,CAAC;aACF;QACF,CAAC;QAED,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;YAChF,MAAM,yBAAyB,GAAG,+BAA+B,CAChE,SAAS,EACT,gBAAgB,EAChB,cAAc,CACd,CAAC;YACF,MAAM,GAAG,GAAW,OAAO,CAAC;YAC5B,MAAM,KAAK,GAAW,OAAO,CAAC;YAC9B,yBAAyB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1C,oBAAoB,CAAC,yBAAyB,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;YACjG,MAAM,yBAAyB,GAAG,+BAA+B,CAChE,SAAS,EACT,gBAAgB,EAChB,cAAc,CACd,CAAC;YACF,MAAM,GAAG,GAAW,OAAO,CAAC;YAC5B,MAAM,KAAK,GAAW,MAAM,CAAC;YAC7B,yBAAyB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1C,oBAAoB,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;YACjG,MAAM,yBAAyB,GAAG,+BAA+B,CAChE,SAAS,EACT,gBAAgB,EAChB,cAAc,CACd,CAAC;YACF,MAAM,GAAG,GAAW,MAAM,CAAC;YAC3B,MAAM,KAAK,GAAW,OAAO,CAAC;YAC9B,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1B,oBAAoB,CAAC,yBAAyB,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH;;;;WAIG;QACH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;YAC3G,wCAAwC;YACxC,IAAI,yBAAqC,CAAC;YAE1C,IAAI,UAAU,GAAY,IAAI,CAAC;YAC/B,iGAAiG;YACjG,iCAAiC;YACjC,uFAAuF;YACvF,SAAS,uBAAuB,CAAC,GAAe,EAAE,GAAW,EAAE,KAAU;gBACxE,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC;gBACpE,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC;YACnD,CAAC;YACD,uGAAuG;YACvG,4DAA4D;YAC5D,yBAAyB,GAAG,+BAA+B,CAC1D,SAAS,EACT,gBAAgB,EAChB,uBAAuB,CACvB,CAAC;YAEF,IAAI,QAAQ,GAAY,KAAK,CAAC;YAC9B,IAAI;gBACH,yBAAyB,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;aAChD;YAAC,OAAO,KAAU,EAAE;gBACpB,MAAM,CAAC,WAAW,CACjB,KAAK,CAAC,OAAO,EACb,OAAO,EACP,yFAAyF,CACzF,CAAC;gBACF,QAAQ,GAAG,IAAI,CAAC;aAChB;YACD,MAAM,CAAC,KAAK,CACX,QAAQ,EACR,IAAI,EACJ,0EAA0E,CAC1E,CAAC;YAEF,wGAAwG;YACxG,mCAAmC;YACnC,UAAU,GAAG,KAAK,CAAC;YACnB,MAAM,QAAQ,GAAW,OAAO,CAAC;YACjC,MAAM,UAAU,GAAW,KAAK,CAAC;YACjC,yBAAyB,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpD,oBAAoB,CAAC,yBAAyB,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { MockFluidDataStoreRuntime } from \"@fluidframework/test-runtime-utils\";\nimport { ISharedMap, SharedMap } from \"@fluidframework/map\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { createSharedMapWithInterception } from \"../map/index.js\";\n\ndescribe(\"Shared Map with Interception\", () => {\n\tdescribe(\"Simple User Attribution\", () => {\n\t\t/**\n\t\t * The following tests test simple user attribution in SharedMap with interception.\n\t\t * In the callback function of the SharedMap with inteception, it sets the user\n\t\t * attribution information in the underlying SharedMap against <key>.attribution.\n\t\t */\n\t\tconst userAttributes = { userId: \"Fake User\" };\n\t\tconst documentId = \"fakeId\";\n\t\tconst attributionKey = (key: string) => `${key}.attribution`;\n\t\tlet sharedMap: ISharedMap;\n\t\tlet dataStoreContext: IFluidDataStoreContext;\n\n\t\tfunction orderSequentially(callback: () => void): void {\n\t\t\tcallback();\n\t\t}\n\n\t\tfunction interceptionCb(map: ISharedMap, key: string, value: any): void {\n\t\t\tmap.set(attributionKey(key), userAttributes);\n\t\t}\n\n\t\tbeforeEach(() => {\n\t\t\tconst dataStoreRuntime = new MockFluidDataStoreRuntime();\n\t\t\tsharedMap = SharedMap.getFactory().create(dataStoreRuntime, documentId);\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n\t\t\tdataStoreContext = {\n\t\t\t\tcontainerRuntime: { orderSequentially },\n\t\t\t} as IFluidDataStoreContext;\n\t\t});\n\n\t\t// Verifies that the props are stored correctly in the given map under a key derived from the\n\t\t// given key - under attributionKey(key).\n\t\tfunction verifyMapAttribution(map: ISharedMap, key: string, value: string, props?: any) {\n\t\t\tassert.equal(\n\t\t\t\tmap.get(key),\n\t\t\t\tvalue,\n\t\t\t\t\"The retrieved value should match the value that was set\",\n\t\t\t);\n\n\t\t\tif (props === undefined) {\n\t\t\t\tassert.equal(\n\t\t\t\t\tmap.get(attributionKey(key)),\n\t\t\t\t\tundefined,\n\t\t\t\t\t\"The user attributes should not exist because there was no interception\",\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tassert.deepEqual(\n\t\t\t\t\tmap.get(attributionKey(key)),\n\t\t\t\t\tprops,\n\t\t\t\t\t\"The user attributes set via the interception callback should exist.\",\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\tit(\"should be able to intercept SharedMap set method in the wrapper\", async () => {\n\t\t\tconst sharedMapWithInterception = createSharedMapWithInterception(\n\t\t\t\tsharedMap,\n\t\t\t\tdataStoreContext,\n\t\t\t\tinterceptionCb,\n\t\t\t);\n\t\t\tconst key: string = \"color\";\n\t\t\tconst value: string = \"green\";\n\t\t\tsharedMapWithInterception.set(key, value);\n\t\t\tverifyMapAttribution(sharedMapWithInterception, key, value, userAttributes);\n\t\t});\n\n\t\tit(\"should be able to see changes made by the wrapper from the underlying shared map\", async () => {\n\t\t\tconst sharedMapWithInterception = createSharedMapWithInterception(\n\t\t\t\tsharedMap,\n\t\t\t\tdataStoreContext,\n\t\t\t\tinterceptionCb,\n\t\t\t);\n\t\t\tconst key: string = \"style\";\n\t\t\tconst value: string = \"bold\";\n\t\t\tsharedMapWithInterception.set(key, value);\n\t\t\tverifyMapAttribution(sharedMap, key, value, userAttributes);\n\t\t});\n\n\t\tit(\"should be able to see changes made by the underlying shared map from the wrapper\", async () => {\n\t\t\tconst sharedMapWithInterception = createSharedMapWithInterception(\n\t\t\t\tsharedMap,\n\t\t\t\tdataStoreContext,\n\t\t\t\tinterceptionCb,\n\t\t\t);\n\t\t\tconst key: string = \"font\";\n\t\t\tconst value: string = \"Arial\";\n\t\t\tsharedMap.set(key, value);\n\t\t\tverifyMapAttribution(sharedMapWithInterception, key, value);\n\t\t});\n\n\t\t/**\n\t\t * This test calls set on the wrapper from the interception callback which will cause an infinite\n\t\t * recursion. Verify that the wrapper detects this and asserts.\n\t\t * Also, verify that the object is not unusable after the assert.\n\t\t */\n\t\tit(\"should assert if set is called on the wrapper from the callback causing infinite recursion\", async () => {\n\t\t\t// eslint-disable-next-line prefer-const\n\t\t\tlet sharedMapWithInterception: ISharedMap;\n\n\t\t\tlet useWrapper: boolean = true;\n\t\t\t// If useWrapper above is true, this interception callback that calls a set on the wrapped object\n\t\t\t// causing an infinite recursion.\n\t\t\t// If useWrapper is false, it uses the passed sharedMap which does not cause recursion.\n\t\t\tfunction recursiveInterceptionCb(map: ISharedMap, key: string, value: any) {\n\t\t\t\tconst localMap = useWrapper ? sharedMapWithInterception : sharedMap;\n\t\t\t\tlocalMap.set(attributionKey(key), userAttributes);\n\t\t\t}\n\t\t\t// Create the interception wrapper with a callback that calls set on the wrapper. The set method should\n\t\t\t// throw an assertion as this will cause infinite recursion.\n\t\t\tsharedMapWithInterception = createSharedMapWithInterception(\n\t\t\t\tsharedMap,\n\t\t\t\tdataStoreContext,\n\t\t\t\trecursiveInterceptionCb,\n\t\t\t);\n\n\t\t\tlet asserted: boolean = false;\n\t\t\ttry {\n\t\t\t\tsharedMapWithInterception.set(\"color\", \"green\");\n\t\t\t} catch (error: any) {\n\t\t\t\tassert.strictEqual(\n\t\t\t\t\terror.message,\n\t\t\t\t\t\"0x0c0\",\n\t\t\t\t\t\"We should have caught an assert in replaceText because it detects an infinite recursion\",\n\t\t\t\t);\n\t\t\t\tasserted = true;\n\t\t\t}\n\t\t\tassert.equal(\n\t\t\t\tasserted,\n\t\t\t\ttrue,\n\t\t\t\t\"The set call should have asserted because it detects inifinite recursion\",\n\t\t\t);\n\n\t\t\t// Set useWrapper to false and call set on the wrapper again. Verify that the object is still usable and\n\t\t\t// we do not get an assert anymore.\n\t\t\tuseWrapper = false;\n\t\t\tconst colorKey: string = \"color\";\n\t\t\tconst colorValue: string = \"red\";\n\t\t\tsharedMapWithInterception.set(colorKey, colorValue);\n\t\t\tverifyMapAttribution(sharedMapWithInterception, colorKey, colorValue, userAttributes);\n\t\t});\n\t});\n});\n"]}

package/lib/test/sharedStringWithInterception.spec.js

@@ -0,0 +1,147 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MockFluidDataStoreRuntime } from "@fluidframework/test-runtime-utils";
+import { SharedString, SharedStringFactory } from "@fluidframework/sequence";
+import { createSharedStringWithInterception } from "../sequence/index.js";
+describe("Shared String with Interception", () => {
+    /**
+     * The following tests test simple user attribution in SharedString with interception.
+     * In the callback function of the SharedString with interception, it adds the user
+     * information to the passed properties and returns it.
+     */
+    describe("Simple User Attribution", () => {
+        const userAttributes = { userId: "Fake User" };
+        const documentId = "fakeId";
+        let sharedString;
+        let dataStoreContext;
+        function orderSequentially(callback) {
+            callback();
+        }
+        // Interception function that adds userProps to the passed props and returns.
+        function propertyInterceptionCb(props) {
+            const newProps = { ...props, ...userAttributes };
+            return newProps;
+        }
+        // Function that verifies that the given shared string has correct value and the right properties at
+        // the given position.
+        function verifyString(ss, text, props, position) {
+            assert.equal(ss.getText(), text, "The retrieved text should match the inserted text");
+            assert.deepEqual({ ...ss.getPropertiesAtPosition(position) }, { ...props }, "The properties set via the interception callback should exist");
+        }
+        beforeEach(() => {
+            const dataStoreRuntime = new MockFluidDataStoreRuntime();
+            sharedString = new SharedString(dataStoreRuntime, documentId, SharedStringFactory.Attributes);
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            dataStoreContext = {
+                containerRuntime: { orderSequentially },
+            };
+        });
+        it("should be able to intercept SharedString methods by the wrapper", async () => {
+            const sharedStringWithInterception = createSharedStringWithInterception(sharedString, dataStoreContext, propertyInterceptionCb);
+            // Insert text into shared string.
+            let text = "123";
+            let syleProps = { style: "bold" };
+            sharedStringWithInterception.insertText(0, text, syleProps);
+            verifyString(sharedStringWithInterception, text, { ...syleProps, ...userAttributes }, 2);
+            // Replace text in the shared string.
+            text = "aaa";
+            syleProps = { style: "italics " };
+            sharedStringWithInterception.replaceText(2, 3, "aaa", syleProps);
+            verifyString(sharedStringWithInterception, "12aaa", { ...syleProps, ...userAttributes }, 2);
+            // Annotate the shared string.
+            const colorProps = { color: "green" };
+            sharedStringWithInterception.annotateRange(0, 5, colorProps);
+            verifyString(sharedStringWithInterception, "12aaa", { ...syleProps, ...colorProps, ...userAttributes }, 2);
+        });
+        it("should be able to see changes made by the wrapper from the underlying shared string", async () => {
+            const sharedStringWithInterception = createSharedStringWithInterception(sharedString, dataStoreContext, propertyInterceptionCb);
+            // Insert text via the shared string with interception wrapper.
+            let text = "123";
+            let syleProps = { style: "bold" };
+            sharedStringWithInterception.insertText(0, text, syleProps);
+            // Verify the text and properties via the underlying shared string.
+            verifyString(sharedString, text, { ...syleProps, ...userAttributes }, 2);
+            // Replace text via the shared string with interception wrapper.
+            text = "aaa";
+            syleProps = { style: "italics " };
+            sharedStringWithInterception.replaceText(2, 3, "aaa", syleProps);
+            // Verify the text and properties via the underlying shared string.
+            verifyString(sharedString, "12aaa", { ...syleProps, ...userAttributes }, 2);
+            // Annotate the shared string.
+            const colorProps = { color: "green" };
+            sharedStringWithInterception.annotateRange(0, 5, colorProps);
+            // Verify the text and properties via the underlying shared string.
+            verifyString(sharedString, "12aaa", { ...syleProps, ...colorProps, ...userAttributes }, 2);
+        });
+        it("should be able to see changes made by the underlying shared string from the wrapper", async () => {
+            const sharedStringWithInterception = createSharedStringWithInterception(sharedString, dataStoreContext, propertyInterceptionCb);
+            // Insert text via the underlying shared string.
+            let text = "123";
+            let syleProps = { style: "bold" };
+            sharedString.insertText(0, text, syleProps);
+            // Verify the text and properties via the interception wrapper. It should not have the user attributes.
+            verifyString(sharedStringWithInterception, text, syleProps, 2);
+            // Replace text via the underlying shared string.
+            text = "aaa";
+            syleProps = { style: "italics " };
+            sharedString.replaceText(2, 3, "aaa", syleProps);
+            // Verify the text and properties via the interception wrapper. It should not have the user attributes.
+            verifyString(sharedStringWithInterception, "12aaa", syleProps, 2);
+            // Annotate the shared string via the underlying shared string.
+            const colorProps = { color: "green" };
+            sharedString.annotateRange(0, 5, colorProps);
+            // Verify the text and properties via the interception wrapper. It should not have the user attributes.
+            verifyString(sharedStringWithInterception, "12aaa", { ...syleProps, ...colorProps }, 2);
+        });
+        /**
+         * This test calls a method on the wrapper from the interception callback which will cause an infinite
+         * recursion. Verify that the wrapper detects this and asserts.
+         * Also, verify that the object is not unusable after the assert.
+         */
+        it("should assert if a wrapper method is called from the callback causing infinite recursion", async () => {
+            // eslint-disable-next-line prefer-const
+            let sharedStringWithInterception;
+            const propsInRecursiveCb = { fromRecursiveCb: "true" };
+            let useWrapper = true;
+            // If useWrapper above is true, this interception callback calls a method on the wrapped object
+            // causing an infinite recursion.
+            // If useWrapper is false, it uses the passed shared string which does not cause recursion.
+            function recursiveInterceptionCb(properties) {
+                const ss = useWrapper ? sharedStringWithInterception : sharedString;
+                ss.annotateRange(0, 1, propsInRecursiveCb);
+                return { ...properties, ...userAttributes };
+            }
+            // Create the interception wrapper with the above callback. The set method should throw an assertion as this
+            // will cause infinite recursion.
+            sharedStringWithInterception = createSharedStringWithInterception(sharedString, dataStoreContext, recursiveInterceptionCb);
+            let text = "123";
+            const props = { style: "bold" };
+            // First, insert text via the unwrapped shared string so that we have something to annotate in the
+            // recursiveInterceptionCb.
+            sharedString.insertText(0, text, props);
+            let asserted = false;
+            try {
+                text = "abc";
+                // Try to replace text.
+                sharedStringWithInterception.replaceText(1, 2, text);
+            }
+            catch (error) {
+                assert.strictEqual(error.message, "0x0c8", "We should have caught an assert in replaceText because it detects an infinite recursion");
+                asserted = true;
+            }
+            assert.equal(asserted, true, "replaceText should have asserted because it detects inifinite recursion");
+            // Verify that the object is still usable:
+            // Set useWrapper to false and call replacetext on the wrapper again. Verify that we do not get an assert.
+            useWrapper = false;
+            text = "test";
+            sharedStringWithInterception.replaceText(2, 3, text, props);
+            verifyString(sharedStringWithInterception, "12test", { ...props, ...userAttributes }, 2);
+            // Verify that the annotate on position 0 in the recursiveInterceptionCb annotated the attributes.
+            verifyString(sharedStringWithInterception, "12test", { ...props, ...propsInRecursiveCb }, 0);
+        });
+    });
+});
+//# sourceMappingURL=sharedStringWithInterception.spec.js.map