@fluid-experimental/attributor 2.0.0-internal.3.3.0

package/lib/lz4Encoder.js

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { compress, decompress } from "lz4js";
+import { bufferToString, stringToBuffer } from "@fluidframework/common-utils";
+/**
+ * @alpha
+ */
+export function makeLZ4Encoder() {
+    return {
+        encode: (decoded) => {
+            const uncompressed = new TextEncoder().encode(JSON.stringify(decoded));
+            const compressed = compress(uncompressed);
+            return bufferToString(compressed, "base64");
+        },
+        decode: (serializedSummary) => {
+            const compressed = new Uint8Array(stringToBuffer(serializedSummary, "base64"));
+            const uncompressed = decompress(compressed);
+            const decoded = JSON.parse(new TextDecoder().decode(uncompressed));
+            return decoded;
+        },
+    };
+}
+//# sourceMappingURL=lz4Encoder.js.map

package/lib/lz4Encoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lz4Encoder.js","sourceRoot":"","sources":["../src/lz4Encoder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAI9E;;GAEG;AACH,MAAM,UAAU,cAAc;IAC7B,OAAO;QACN,MAAM,EAAE,CAAC,OAAoB,EAAE,EAAE;YAChC,MAAM,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACvE,MAAM,UAAU,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;YAC1C,OAAO,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,EAAE,CAAC,iBAAyB,EAAe,EAAE;YAClD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC/E,MAAM,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAgB,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAChF,OAAO,OAAO,CAAC;QAChB,CAAC;KACD,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { compress, decompress } from \"lz4js\";\nimport { bufferToString, stringToBuffer } from \"@fluidframework/common-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { Encoder } from \"./encoders\";\n\n/**\n * @alpha\n */\nexport function makeLZ4Encoder<T>(): Encoder<Jsonable<T>, string> {\n\treturn {\n\t\tencode: (decoded: Jsonable<T>) => {\n\t\t\tconst uncompressed = new TextEncoder().encode(JSON.stringify(decoded));\n\t\t\tconst compressed = compress(uncompressed);\n\t\t\treturn bufferToString(compressed, \"base64\");\n\t\t},\n\t\tdecode: (serializedSummary: string): Jsonable<T> => {\n\t\t\tconst compressed = new Uint8Array(stringToBuffer(serializedSummary, \"base64\"));\n\t\t\tconst uncompressed = decompress(compressed);\n\t\t\tconst decoded: Jsonable<T> = JSON.parse(new TextDecoder().decode(uncompressed));\n\t\t\treturn decoded;\n\t\t},\n\t};\n}\n"]}

package/lib/mixinAttributor.d.ts

@@ -0,0 +1,60 @@
+import { ContainerRuntime } from "@fluidframework/container-runtime";
+import { AttributionInfo, AttributionKey } from "@fluidframework/runtime-definitions";
+/**
+ * @alpha
+ * Feature Gate Key -
+ * Whether or not a container runtime instantiated using `mixinAttributor`'s load should generate an attributor on
+ * new files. See package README for more notes on integration.
+ */
+export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+/**
+ * @alpha
+ */
+export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
+/**
+ * @alpha
+ */
+export interface IProvideRuntimeAttributor {
+    readonly IRuntimeAttributor: IRuntimeAttributor;
+}
+/**
+ * Provides access to attribution information stored on the container runtime.
+ *
+ * Attributors are only populated after the container runtime they are injected into has initialized.
+ * @sealed
+ * @alpha
+ */
+export interface IRuntimeAttributor extends IProvideRuntimeAttributor {
+    /**
+     * @throws - If no AttributionInfo exists for this key.
+     */
+    get(key: AttributionKey): AttributionInfo;
+    /**
+     * @returns - Whether any AttributionInfo exists for the provided key.
+     */
+    has(key: AttributionKey): boolean;
+    /**
+     * @returns - Whether the runtime is currently tracking attribution information for the loaded container.
+     * See {@link mixinAttributor} for more details on when this happens.
+     */
+    readonly isEnabled: boolean;
+}
+/**
+ * @returns an IRuntimeAttributor for usage with `mixinAttributor`. The attributor will only be populated with data
+ * once it's passed via scope to a container runtime load flow. See {@link mixinAttributor}.
+ * @alpha
+ */
+export declare function createRuntimeAttributor(): IRuntimeAttributor;
+/**
+ * Mixes in logic to load and store runtime-based attribution functionality.
+ *
+ * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.
+ *
+ * Existing documents without stored attributors will not start storing attribution information: if an
+ * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,
+ * that attributor's `has` method will always return `false`.
+ * @param Base - base class, inherits from FluidAttributorRuntime
+ * @alpha
+ */
+export declare const mixinAttributor: (Base?: typeof ContainerRuntime) => typeof ContainerRuntime;
+//# sourceMappingURL=mixinAttributor.d.ts.map

package/lib/mixinAttributor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixinAttributor.d.ts","sourceRoot":"","sources":["../src/mixinAttributor.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE,OAAO,EACN,eAAe,EACf,cAAc,EAId,MAAM,qCAAqC,CAAC;AAe7C;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,sCAAsC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,yBAAgD,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;CAChD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAmB,SAAQ,yBAAyB;IACpE;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,cAAc,GAAG,eAAe,CAAC;IAE1C;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,kBAAkB,CAE5D;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,UAAU,uBAAuB,4BA+ErB,CAAC"}

package/lib/mixinAttributor.js

@@ -0,0 +1,148 @@
+import { ContainerRuntime } from "@fluidframework/container-runtime";
+import { addSummarizeResultToSummary, SummaryTreeBuilder } from "@fluidframework/runtime-utils";
+import { assert, bufferToString, unreachableCase } from "@fluidframework/common-utils";
+import { UsageError } from "@fluidframework/container-utils";
+import { loggerToMonitoringContext } from "@fluidframework/telemetry-utils";
+import { Attributor, OpStreamAttributor } from "./attributor";
+import { AttributorSerializer, chain, deltaEncoder } from "./encoders";
+import { makeLZ4Encoder } from "./lz4Encoder";
+// Summary tree keys
+const attributorTreeName = ".attributor";
+const opBlobName = "op";
+/**
+ * @alpha
+ * Feature Gate Key -
+ * Whether or not a container runtime instantiated using `mixinAttributor`'s load should generate an attributor on
+ * new files. See package README for more notes on integration.
+ */
+export const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+/**
+ * @alpha
+ */
+export const IRuntimeAttributor = "IRuntimeAttributor";
+/**
+ * @returns an IRuntimeAttributor for usage with `mixinAttributor`. The attributor will only be populated with data
+ * once it's passed via scope to a container runtime load flow. See {@link mixinAttributor}.
+ * @alpha
+ */
+export function createRuntimeAttributor() {
+    return new RuntimeAttributor();
+}
+/**
+ * Mixes in logic to load and store runtime-based attribution functionality.
+ *
+ * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.
+ *
+ * Existing documents without stored attributors will not start storing attribution information: if an
+ * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,
+ * that attributor's `has` method will always return `false`.
+ * @param Base - base class, inherits from FluidAttributorRuntime
+ * @alpha
+ */
+export const mixinAttributor = (Base = ContainerRuntime) => class ContainerRuntimeWithAttributor extends Base {
+    static async load(context, registryEntries, requestHandler, runtimeOptions = {}, containerScope = context.scope, existing, ctor = ContainerRuntimeWithAttributor) {
+        var _a, _b, _c, _d;
+        var _e;
+        const runtimeAttributor = (_a = containerScope) === null || _a === void 0 ? void 0 : _a.IRuntimeAttributor;
+        if (!runtimeAttributor) {
+            throw new UsageError("ContainerRuntimeWithAttributor must be passed a scope implementing IProvideRuntimeAttributor");
+        }
+        const pendingRuntimeState = context.pendingLocalState;
+        const baseSnapshot = (_b = pendingRuntimeState === null || pendingRuntimeState === void 0 ? void 0 : pendingRuntimeState.baseSnapshot) !== null && _b !== void 0 ? _b : context.baseSnapshot;
+        const { audience, deltaManager } = context;
+        assert(audience !== undefined, 0x508 /* Audience must exist when instantiating attribution-providing runtime */);
+        const mc = loggerToMonitoringContext(context.taggedLogger);
+        const shouldTrackAttribution = (_c = mc.config.getBoolean(enableOnNewFileKey)) !== null && _c !== void 0 ? _c : false;
+        if (shouldTrackAttribution) {
+            ((_d = (_e = context.options).attribution) !== null && _d !== void 0 ? _d : (_e.attribution = {})).track = true;
+        }
+        const runtime = (await Base.load(context, registryEntries, requestHandler, runtimeOptions, containerScope, existing, ctor));
+        runtime.runtimeAttributor = runtimeAttributor;
+        // Note: this fetches attribution blobs relatively eagerly in the load flow; we may want to optimize
+        // this to avoid blocking on such information until application actually requests some op-based attribution
+        // info or we need to summarize. All that really needs to happen immediately is to start recording
+        // op seq# -> attributionInfo for new ops.
+        await runtime.runtimeAttributor.initialize(deltaManager, audience, baseSnapshot, async (id) => runtime.storage.readBlob(id), shouldTrackAttribution);
+        return runtime;
+    }
+    addContainerStateToSummary(summaryTree, fullTree, trackState, telemetryContext) {
+        var _a;
+        super.addContainerStateToSummary(summaryTree, fullTree, trackState, telemetryContext);
+        const attributorSummary = (_a = this.runtimeAttributor) === null || _a === void 0 ? void 0 : _a.summarize();
+        if (attributorSummary) {
+            addSummarizeResultToSummary(summaryTree, attributorTreeName, attributorSummary);
+        }
+    }
+};
+class RuntimeAttributor {
+    constructor() {
+        this.encoder = {
+            encode: unreachableCase,
+            decode: unreachableCase,
+        };
+        this.isEnabled = false;
+    }
+    get IRuntimeAttributor() {
+        return this;
+    }
+    get(key) {
+        assert(this.opAttributor !== undefined, 0x509 /* RuntimeAttributor must be initialized before getAttributionInfo can be called */);
+        if (key.type === "detached") {
+            throw new Error("Attribution of detached keys is not yet supported.");
+        }
+        if (key.type === "local") {
+            // Note: we can *almost* orchestrate this correctly with internal-only changes by looking up the current
+            // client id in the audience. However, for read->write client transition, the container might have not yet
+            // received a client id. This is left as a TODO as it might be more easily solved once the detached case
+            // is settled (e.g. if it's reasonable for the host to know the current user information at container
+            // creation time, we could just use that here as well).
+            throw new Error("Attribution of local keys is not yet supported.");
+        }
+        return this.opAttributor.getAttributionInfo(key.seq);
+    }
+    has(key) {
+        var _a;
+        if (key.type === "detached") {
+            return false;
+        }
+        if (key.type === "local") {
+            return false;
+        }
+        return ((_a = this.opAttributor) === null || _a === void 0 ? void 0 : _a.tryGetAttributionInfo(key.seq)) !== undefined;
+    }
+    async initialize(deltaManager, audience, baseSnapshot, readBlob, shouldAddAttributorOnNewFile) {
+        const attributorTree = baseSnapshot === null || baseSnapshot === void 0 ? void 0 : baseSnapshot.trees[attributorTreeName];
+        // Existing documents that don't already have a snapshot containing runtime attribution info shouldn't
+        // inject any for now--this causes some back-compat integration problems that aren't fully worked out.
+        const shouldExcludeAttributor = (baseSnapshot !== undefined && attributorTree === undefined) ||
+            (baseSnapshot === undefined && !shouldAddAttributorOnNewFile);
+        if (shouldExcludeAttributor) {
+            // This gives a consistent error for calls to `get` on keys that don't exist.
+            this.opAttributor = new Attributor();
+            return;
+        }
+        this.isEnabled = true;
+        this.encoder = chain(new AttributorSerializer((entries) => new OpStreamAttributor(deltaManager, audience, entries), deltaEncoder), makeLZ4Encoder());
+        if (attributorTree !== undefined) {
+            const id = attributorTree.blobs[opBlobName];
+            assert(id !== undefined, 0x50a /* Attributor tree should have op attributor summary blob. */);
+            const blobContents = await readBlob(id);
+            const attributorSnapshot = bufferToString(blobContents, "utf8");
+            this.opAttributor = this.encoder.decode(attributorSnapshot);
+        }
+        else {
+            this.opAttributor = new OpStreamAttributor(deltaManager, audience);
+        }
+    }
+    summarize() {
+        if (!this.isEnabled) {
+            // Loaded existing document without attributor data: avoid injecting any data.
+            return undefined;
+        }
+        assert(this.opAttributor !== undefined, 0x50b /* RuntimeAttributor should be initialized before summarization */);
+        const builder = new SummaryTreeBuilder();
+        builder.addBlob(opBlobName, this.encoder.encode(this.opAttributor));
+        return builder.getSummaryTree();
+    }
+}
+//# sourceMappingURL=mixinAttributor.js.map

package/lib/mixinAttributor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixinAttributor.js","sourceRoot":"","sources":["../src/mixinAttributor.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AASrE,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAGhG,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAe,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,YAAY,EAAW,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,oBAAoB;AACpB,MAAM,kBAAkB,GAAG,aAAa,CAAC;AACzC,MAAM,UAAU,GAAG,IAAI,CAAC;AAExB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,mCAAmC,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAoC,oBAAoB,CAAC;AAkCxF;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACtC,OAAO,IAAI,iBAAiB,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAgC,gBAAgB,EAAE,EAAE,CACnF,MAAM,8BAA+B,SAAQ,IAAI;IACzC,MAAM,CAAC,KAAK,CAAC,IAAI,CACvB,OAA0B,EAC1B,eAAmD,EACnD,cAEY,EACZ,iBAAuD,EAAE,EACzD,iBAA0C,OAAO,CAAC,KAAK,EACvD,QAA8B,EAC9B,OAAgC,8BAAoE;;;QAEpG,MAAM,iBAAiB,GAAG,MACzB,cACA,0CAAE,kBAAkB,CAAC;QACtB,IAAI,CAAC,iBAAiB,EAAE;YACvB,MAAM,IAAI,UAAU,CACnB,8FAA8F,CAC9F,CAAC;SACF;QAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,iBAEnC,CAAC;QACF,MAAM,YAAY,GACjB,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,YAAY,mCAAI,OAAO,CAAC,YAAY,CAAC;QAE3D,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QAC3C,MAAM,CACL,QAAQ,KAAK,SAAS,EACtB,KAAK,CAAC,0EAA0E,CAChF,CAAC;QAEF,MAAM,EAAE,GAAG,yBAAyB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC3D,MAAM,sBAAsB,GAAG,MAAA,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,mCAAI,KAAK,CAAC;QACjF,IAAI,sBAAsB,EAAE;YAC3B,aAAC,OAAO,CAAC,OAAO,EAAC,WAAW,uCAAX,WAAW,GAAK,EAAE,EAAC,CAAC,KAAK,GAAG,IAAI,CAAC;SAClD;QAED,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAC/B,OAAO,EACP,eAAe,EACf,cAAc,EACd,cAAc,EACd,cAAc,EACd,QAAQ,EACR,IAAI,CACJ,CAAmC,CAAC;QACrC,OAAO,CAAC,iBAAiB,GAAG,iBAAsC,CAAC;QAEnE,oGAAoG;QACpG,2GAA2G;QAC3G,kGAAkG;QAClG,0CAA0C;QAC1C,MAAM,OAAO,CAAC,iBAAiB,CAAC,UAAU,CACzC,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC1C,sBAAsB,CACtB,CAAC;QACF,OAAO,OAAO,CAAC;IAChB,CAAC;IAIS,0BAA0B,CACnC,WAAkC,EAClC,QAAiB,EACjB,UAAmB,EACnB,gBAAoC;;QAEpC,KAAK,CAAC,0BAA0B,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACtF,MAAM,iBAAiB,GAAG,MAAA,IAAI,CAAC,iBAAiB,0CAAE,SAAS,EAAE,CAAC;QAC9D,IAAI,iBAAiB,EAAE;YACtB,2BAA2B,CAAC,WAAW,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;SAChF;IACF,CAAC;CACqC,CAAC;AAEzC,MAAM,iBAAiB;IAAvB;QAuCS,YAAO,GAAiC;YAC/C,MAAM,EAAE,eAAe;YACvB,MAAM,EAAE,eAAe;SACvB,CAAC;QAGK,cAAS,GAAG,KAAK,CAAC;IA0D1B,CAAC;IAtGA,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,GAAG,CAAC,GAAmB;QAC7B,MAAM,CACL,IAAI,CAAC,YAAY,KAAK,SAAS,EAC/B,KAAK,CAAC,mFAAmF,CACzF,CAAC;QAEF,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;SACtE;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE;YACzB,wGAAwG;YACxG,0GAA0G;YAC1G,wGAAwG;YACxG,qGAAqG;YACrG,uDAAuD;YACvD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACnE;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACtD,CAAC;IAEM,GAAG,CAAC,GAAmB;;QAC7B,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;YAC5B,OAAO,KAAK,CAAC;SACb;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE;YACzB,OAAO,KAAK,CAAC;SACb;QAED,OAAO,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAE,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,MAAK,SAAS,CAAC;IACxE,CAAC;IAUM,KAAK,CAAC,UAAU,CACtB,YAAwE,EACxE,QAAmB,EACnB,YAAuC,EACvC,QAAkD,EAClD,4BAAqC;QAErC,MAAM,cAAc,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAC/D,sGAAsG;QACtG,sGAAsG;QACtG,MAAM,uBAAuB,GAC5B,CAAC,YAAY,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS,CAAC;YAC5D,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC/D,IAAI,uBAAuB,EAAE;YAC5B,6EAA6E;YAC7E,IAAI,CAAC,YAAY,GAAG,IAAI,UAAU,EAAE,CAAC;YACrC,OAAO;SACP;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CACnB,IAAI,oBAAoB,CACvB,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,EACpE,YAAY,CACZ,EACD,cAAc,EAAE,CAChB,CAAC;QAEF,IAAI,cAAc,KAAK,SAAS,EAAE;YACjC,MAAM,EAAE,GAAG,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CACL,EAAE,KAAK,SAAS,EAChB,KAAK,CAAC,6DAA6D,CACnE,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxC,MAAM,kBAAkB,GAAG,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAChE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;SAC5D;aAAM;YACN,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAkB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;SACnE;IACF,CAAC;IAEM,SAAS;QACf,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACpB,8EAA8E;YAC9E,OAAO,SAAS,CAAC;SACjB;QAED,MAAM,CACL,IAAI,CAAC,YAAY,KAAK,SAAS,EAC/B,KAAK,CAAC,kEAAkE,CACxE,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACpE,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport {\n\tIDocumentMessage,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n} from \"@fluidframework/protocol-definitions\";\nimport { IAudience, IContainerContext, IDeltaManager } from \"@fluidframework/container-definitions\";\nimport { ContainerRuntime } from \"@fluidframework/container-runtime\";\nimport type { IContainerRuntimeOptions } from \"@fluidframework/container-runtime\";\nimport {\n\tAttributionInfo,\n\tAttributionKey,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tNamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions\";\nimport { addSummarizeResultToSummary, SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { IRequest, IResponse, FluidObject } from \"@fluidframework/core-interfaces\";\nimport { assert, bufferToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { UsageError } from \"@fluidframework/container-utils\";\nimport { loggerToMonitoringContext } from \"@fluidframework/telemetry-utils\";\nimport { Attributor, IAttributor, OpStreamAttributor } from \"./attributor\";\nimport { AttributorSerializer, chain, deltaEncoder, Encoder } from \"./encoders\";\nimport { makeLZ4Encoder } from \"./lz4Encoder\";\n\n// Summary tree keys\nconst attributorTreeName = \".attributor\";\nconst opBlobName = \"op\";\n\n/**\n * @alpha\n * Feature Gate Key -\n * Whether or not a container runtime instantiated using `mixinAttributor`'s load should generate an attributor on\n * new files. See package README for more notes on integration.\n */\nexport const enableOnNewFileKey = \"Fluid.Attribution.EnableOnNewFile\";\n\n/**\n * @alpha\n */\nexport const IRuntimeAttributor: keyof IProvideRuntimeAttributor = \"IRuntimeAttributor\";\n\n/**\n * @alpha\n */\nexport interface IProvideRuntimeAttributor {\n\treadonly IRuntimeAttributor: IRuntimeAttributor;\n}\n\n/**\n * Provides access to attribution information stored on the container runtime.\n *\n * Attributors are only populated after the container runtime they are injected into has initialized.\n * @sealed\n * @alpha\n */\nexport interface IRuntimeAttributor extends IProvideRuntimeAttributor {\n\t/**\n\t * @throws - If no AttributionInfo exists for this key.\n\t */\n\tget(key: AttributionKey): AttributionInfo;\n\n\t/**\n\t * @returns - Whether any AttributionInfo exists for the provided key.\n\t */\n\thas(key: AttributionKey): boolean;\n\n\t/**\n\t * @returns - Whether the runtime is currently tracking attribution information for the loaded container.\n\t * See {@link mixinAttributor} for more details on when this happens.\n\t */\n\treadonly isEnabled: boolean;\n}\n\n/**\n * @returns an IRuntimeAttributor for usage with `mixinAttributor`. The attributor will only be populated with data\n * once it's passed via scope to a container runtime load flow. See {@link mixinAttributor}.\n * @alpha\n */\nexport function createRuntimeAttributor(): IRuntimeAttributor {\n\treturn new RuntimeAttributor();\n}\n\n/**\n * Mixes in logic to load and store runtime-based attribution functionality.\n *\n * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.\n *\n * Existing documents without stored attributors will not start storing attribution information: if an\n * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,\n * that attributor's `has` method will always return `false`.\n * @param Base - base class, inherits from FluidAttributorRuntime\n * @alpha\n */\nexport const mixinAttributor = (Base: typeof ContainerRuntime = ContainerRuntime) =>\n\tclass ContainerRuntimeWithAttributor extends Base {\n\t\tpublic static async load(\n\t\t\tcontext: IContainerContext,\n\t\t\tregistryEntries: NamedFluidDataStoreRegistryEntries,\n\t\t\trequestHandler?:\n\t\t\t\t| ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>)\n\t\t\t\t| undefined,\n\t\t\truntimeOptions: IContainerRuntimeOptions | undefined = {},\n\t\t\tcontainerScope: FluidObject | undefined = context.scope,\n\t\t\texisting?: boolean | undefined,\n\t\t\tctor: typeof ContainerRuntime = ContainerRuntimeWithAttributor as unknown as typeof ContainerRuntime,\n\t\t): Promise<ContainerRuntime> {\n\t\t\tconst runtimeAttributor = (\n\t\t\t\tcontainerScope as FluidObject<IProvideRuntimeAttributor> | undefined\n\t\t\t)?.IRuntimeAttributor;\n\t\t\tif (!runtimeAttributor) {\n\t\t\t\tthrow new UsageError(\n\t\t\t\t\t\"ContainerRuntimeWithAttributor must be passed a scope implementing IProvideRuntimeAttributor\",\n\t\t\t\t);\n\t\t\t}\n\n\t\t\tconst pendingRuntimeState = context.pendingLocalState as {\n\t\t\t\tbaseSnapshot?: ISnapshotTree;\n\t\t\t};\n\t\t\tconst baseSnapshot: ISnapshotTree | undefined =\n\t\t\t\tpendingRuntimeState?.baseSnapshot ?? context.baseSnapshot;\n\n\t\t\tconst { audience, deltaManager } = context;\n\t\t\tassert(\n\t\t\t\taudience !== undefined,\n\t\t\t\t0x508 /* Audience must exist when instantiating attribution-providing runtime */,\n\t\t\t);\n\n\t\t\tconst mc = loggerToMonitoringContext(context.taggedLogger);\n\t\t\tconst shouldTrackAttribution = mc.config.getBoolean(enableOnNewFileKey) ?? false;\n\t\t\tif (shouldTrackAttribution) {\n\t\t\t\t(context.options.attribution ??= {}).track = true;\n\t\t\t}\n\n\t\t\tconst runtime = (await Base.load(\n\t\t\t\tcontext,\n\t\t\t\tregistryEntries,\n\t\t\t\trequestHandler,\n\t\t\t\truntimeOptions,\n\t\t\t\tcontainerScope,\n\t\t\t\texisting,\n\t\t\t\tctor,\n\t\t\t)) as ContainerRuntimeWithAttributor;\n\t\t\truntime.runtimeAttributor = runtimeAttributor as RuntimeAttributor;\n\n\t\t\t// Note: this fetches attribution blobs relatively eagerly in the load flow; we may want to optimize\n\t\t\t// this to avoid blocking on such information until application actually requests some op-based attribution\n\t\t\t// info or we need to summarize. All that really needs to happen immediately is to start recording\n\t\t\t// op seq# -> attributionInfo for new ops.\n\t\t\tawait runtime.runtimeAttributor.initialize(\n\t\t\t\tdeltaManager,\n\t\t\t\taudience,\n\t\t\t\tbaseSnapshot,\n\t\t\t\tasync (id) => runtime.storage.readBlob(id),\n\t\t\t\tshouldTrackAttribution,\n\t\t\t);\n\t\t\treturn runtime;\n\t\t}\n\n\t\tprivate runtimeAttributor: RuntimeAttributor | undefined;\n\n\t\tprotected addContainerStateToSummary(\n\t\t\tsummaryTree: ISummaryTreeWithStats,\n\t\t\tfullTree: boolean,\n\t\t\ttrackState: boolean,\n\t\t\ttelemetryContext?: ITelemetryContext,\n\t\t) {\n\t\t\tsuper.addContainerStateToSummary(summaryTree, fullTree, trackState, telemetryContext);\n\t\t\tconst attributorSummary = this.runtimeAttributor?.summarize();\n\t\t\tif (attributorSummary) {\n\t\t\t\taddSummarizeResultToSummary(summaryTree, attributorTreeName, attributorSummary);\n\t\t\t}\n\t\t}\n\t} as unknown as typeof ContainerRuntime;\n\nclass RuntimeAttributor implements IRuntimeAttributor {\n\tpublic get IRuntimeAttributor(): IRuntimeAttributor {\n\t\treturn this;\n\t}\n\n\tpublic get(key: AttributionKey): AttributionInfo {\n\t\tassert(\n\t\t\tthis.opAttributor !== undefined,\n\t\t\t0x509 /* RuntimeAttributor must be initialized before getAttributionInfo can be called */,\n\t\t);\n\n\t\tif (key.type === \"detached\") {\n\t\t\tthrow new Error(\"Attribution of detached keys is not yet supported.\");\n\t\t}\n\n\t\tif (key.type === \"local\") {\n\t\t\t// Note: we can *almost* orchestrate this correctly with internal-only changes by looking up the current\n\t\t\t// client id in the audience. However, for read->write client transition, the container might have not yet\n\t\t\t// received a client id. This is left as a TODO as it might be more easily solved once the detached case\n\t\t\t// is settled (e.g. if it's reasonable for the host to know the current user information at container\n\t\t\t// creation time, we could just use that here as well).\n\t\t\tthrow new Error(\"Attribution of local keys is not yet supported.\");\n\t\t}\n\n\t\treturn this.opAttributor.getAttributionInfo(key.seq);\n\t}\n\n\tpublic has(key: AttributionKey): boolean {\n\t\tif (key.type === \"detached\") {\n\t\t\treturn false;\n\t\t}\n\n\t\tif (key.type === \"local\") {\n\t\t\treturn false;\n\t\t}\n\n\t\treturn this.opAttributor?.tryGetAttributionInfo(key.seq) !== undefined;\n\t}\n\n\tprivate encoder: Encoder<IAttributor, string> = {\n\t\tencode: unreachableCase,\n\t\tdecode: unreachableCase,\n\t};\n\n\tprivate opAttributor: IAttributor | undefined;\n\tpublic isEnabled = false;\n\n\tpublic async initialize(\n\t\tdeltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n\t\taudience: IAudience,\n\t\tbaseSnapshot: ISnapshotTree | undefined,\n\t\treadBlob: (id: string) => Promise<ArrayBufferLike>,\n\t\tshouldAddAttributorOnNewFile: boolean,\n\t): Promise<void> {\n\t\tconst attributorTree = baseSnapshot?.trees[attributorTreeName];\n\t\t// Existing documents that don't already have a snapshot containing runtime attribution info shouldn't\n\t\t// inject any for now--this causes some back-compat integration problems that aren't fully worked out.\n\t\tconst shouldExcludeAttributor =\n\t\t\t(baseSnapshot !== undefined && attributorTree === undefined) ||\n\t\t\t(baseSnapshot === undefined && !shouldAddAttributorOnNewFile);\n\t\tif (shouldExcludeAttributor) {\n\t\t\t// This gives a consistent error for calls to `get` on keys that don't exist.\n\t\t\tthis.opAttributor = new Attributor();\n\t\t\treturn;\n\t\t}\n\n\t\tthis.isEnabled = true;\n\t\tthis.encoder = chain(\n\t\t\tnew AttributorSerializer(\n\t\t\t\t(entries) => new OpStreamAttributor(deltaManager, audience, entries),\n\t\t\t\tdeltaEncoder,\n\t\t\t),\n\t\t\tmakeLZ4Encoder(),\n\t\t);\n\n\t\tif (attributorTree !== undefined) {\n\t\t\tconst id = attributorTree.blobs[opBlobName];\n\t\t\tassert(\n\t\t\t\tid !== undefined,\n\t\t\t\t0x50a /* Attributor tree should have op attributor summary blob. */,\n\t\t\t);\n\t\t\tconst blobContents = await readBlob(id);\n\t\t\tconst attributorSnapshot = bufferToString(blobContents, \"utf8\");\n\t\t\tthis.opAttributor = this.encoder.decode(attributorSnapshot);\n\t\t} else {\n\t\t\tthis.opAttributor = new OpStreamAttributor(deltaManager, audience);\n\t\t}\n\t}\n\n\tpublic summarize(): ISummaryTreeWithStats | undefined {\n\t\tif (!this.isEnabled) {\n\t\t\t// Loaded existing document without attributor data: avoid injecting any data.\n\t\t\treturn undefined;\n\t\t}\n\n\t\tassert(\n\t\t\tthis.opAttributor !== undefined,\n\t\t\t0x50b /* RuntimeAttributor should be initialized before summarization */,\n\t\t);\n\t\tconst builder = new SummaryTreeBuilder();\n\t\tbuilder.addBlob(opBlobName, this.encoder.encode(this.opAttributor));\n\t\treturn builder.getSummaryTree();\n\t}\n}\n"]}

package/lib/stringInterner.d.ts

@@ -0,0 +1,55 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * The ID of the string that has been interned, which can be used by a {@link StringInterner} to retrieve the
+ * original string.
+ * @public
+ */
+export declare type InternedStringId = number & {
+    readonly InternedStringId: "e221abc9-9d17-4493-8db0-70c871a1c27c";
+};
+/**
+ * Interns strings as integers.
+ */
+export interface StringInterner {
+    getInternedId(input: string): InternedStringId | undefined;
+    getString(internedId: number): string;
+    getSerializable(): readonly string[];
+}
+/**
+ * Interns strings as integers.
+ * Given a string, this class will produce a unique integer associated with that string that can then be used to
+ * retrieve the string.
+ */
+export declare class MutableStringInterner implements StringInterner {
+    private readonly stringToInternedIdMap;
+    private readonly internedStrings;
+    /**
+     * @param inputStrings - A list of strings to intern in the order given. Can be used to rehydrate from a previous
+     * `StringInterner`'s {@link StringInterner.getSerializable} return value.
+     */
+    constructor(inputStrings?: readonly string[]);
+    /**
+     * @param input - The string to get the associated intern ID for
+     * @returns an intern ID that is uniquely associated with the input string
+     */
+    getOrCreateInternedId(input: string): InternedStringId;
+    getInternedId(input: string): InternedStringId | undefined;
+    /**
+     *
+     * @param internId - The intern ID to get the associated string for. Can only retrieve strings that have been
+     * used as inputs to calls of `getInternId`.
+     * @returns a string that is uniquely associated with the given intern ID
+     */
+    getString(internId: number): string;
+    /**
+     * @returns The list of strings interned where the indices map to the associated {@link InternedStringId} of
+     * each string.
+     */
+    getSerializable(): readonly string[];
+    /** Create a new interned id. Assumes without validation that the input doesn't already have an interned id. */
+    private createNewId;
+}
+//# sourceMappingURL=stringInterner.d.ts.map

package/lib/stringInterner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringInterner.d.ts","sourceRoot":"","sources":["../src/stringInterner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;GAIG;AACH,oBAAY,gBAAgB,GAAG,MAAM,GAAG;IACvC,QAAQ,CAAC,gBAAgB,EAAE,sCAAsC,CAAC;CAClE,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC3D,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC,eAAe,IAAI,SAAS,MAAM,EAAE,CAAC;CACrC;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,YAAW,cAAc;IAC3D,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAuC;IAC7E,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAgB;IAEhD;;;OAGG;gBACS,YAAY,GAAE,SAAS,MAAM,EAAO;IAMhD;;;OAGG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB;IAItD,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAIjE;;;;;OAKG;IACI,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAQ1C;;;OAGG;IACI,eAAe,IAAI,SAAS,MAAM,EAAE;IAI3C,+GAA+G;IAC/G,OAAO,CAAC,WAAW;CAMnB"}

package/lib/stringInterner.js

@@ -0,0 +1,62 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { UsageError } from "@fluidframework/container-utils";
+/**
+ * Interns strings as integers.
+ * Given a string, this class will produce a unique integer associated with that string that can then be used to
+ * retrieve the string.
+ */
+export class MutableStringInterner {
+    /**
+     * @param inputStrings - A list of strings to intern in the order given. Can be used to rehydrate from a previous
+     * `StringInterner`'s {@link StringInterner.getSerializable} return value.
+     */
+    constructor(inputStrings = []) {
+        this.stringToInternedIdMap = new Map();
+        this.internedStrings = [];
+        for (const value of inputStrings) {
+            this.getOrCreateInternedId(value);
+        }
+    }
+    /**
+     * @param input - The string to get the associated intern ID for
+     * @returns an intern ID that is uniquely associated with the input string
+     */
+    getOrCreateInternedId(input) {
+        var _a;
+        return (_a = this.getInternedId(input)) !== null && _a !== void 0 ? _a : this.createNewId(input);
+    }
+    getInternedId(input) {
+        return this.stringToInternedIdMap.get(input);
+    }
+    /**
+     *
+     * @param internId - The intern ID to get the associated string for. Can only retrieve strings that have been
+     * used as inputs to calls of `getInternId`.
+     * @returns a string that is uniquely associated with the given intern ID
+     */
+    getString(internId) {
+        const result = this.internedStrings[internId];
+        if (!result) {
+            throw new UsageError(`No string associated with ${internId}.`);
+        }
+        return result;
+    }
+    /**
+     * @returns The list of strings interned where the indices map to the associated {@link InternedStringId} of
+     * each string.
+     */
+    getSerializable() {
+        return this.internedStrings;
+    }
+    /** Create a new interned id. Assumes without validation that the input doesn't already have an interned id. */
+    createNewId(input) {
+        const internedId = this.stringToInternedIdMap.size;
+        this.stringToInternedIdMap.set(input, internedId);
+        this.internedStrings.push(input);
+        return internedId;
+    }
+}
+//# sourceMappingURL=stringInterner.js.map

package/lib/stringInterner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringInterner.js","sourceRoot":"","sources":["../src/stringInterner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAoB7D;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAIjC;;;OAGG;IACH,YAAY,eAAkC,EAAE;QAP/B,0BAAqB,GAAG,IAAI,GAAG,EAA4B,CAAC;QAC5D,oBAAe,GAAa,EAAE,CAAC;QAO/C,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;YACjC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;SAClC;IACF,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,KAAa;;QACzC,OAAO,MAAA,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,mCAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IAEM,aAAa,CAAC,KAAa;QACjC,OAAO,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,QAAgB;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,EAAE;YACZ,MAAM,IAAI,UAAU,CAAC,6BAA6B,QAAQ,GAAG,CAAC,CAAC;SAC/D;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,eAAe;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;IAED,+GAA+G;IACvG,WAAW,CAAC,KAAa;QAChC,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAwB,CAAC;QACvE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAClD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,UAAU,CAAC;IACnB,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { UsageError } from \"@fluidframework/container-utils\";\n\n/**\n * The ID of the string that has been interned, which can be used by a {@link StringInterner} to retrieve the\n * original string.\n * @public\n */\nexport type InternedStringId = number & {\n\treadonly InternedStringId: \"e221abc9-9d17-4493-8db0-70c871a1c27c\";\n};\n\n/**\n * Interns strings as integers.\n */\nexport interface StringInterner {\n\tgetInternedId(input: string): InternedStringId | undefined;\n\tgetString(internedId: number): string;\n\tgetSerializable(): readonly string[];\n}\n\n/**\n * Interns strings as integers.\n * Given a string, this class will produce a unique integer associated with that string that can then be used to\n * retrieve the string.\n */\nexport class MutableStringInterner implements StringInterner {\n\tprivate readonly stringToInternedIdMap = new Map<string, InternedStringId>();\n\tprivate readonly internedStrings: string[] = [];\n\n\t/**\n\t * @param inputStrings - A list of strings to intern in the order given. Can be used to rehydrate from a previous\n\t * `StringInterner`'s {@link StringInterner.getSerializable} return value.\n\t */\n\tconstructor(inputStrings: readonly string[] = []) {\n\t\tfor (const value of inputStrings) {\n\t\t\tthis.getOrCreateInternedId(value);\n\t\t}\n\t}\n\n\t/**\n\t * @param input - The string to get the associated intern ID for\n\t * @returns an intern ID that is uniquely associated with the input string\n\t */\n\tpublic getOrCreateInternedId(input: string): InternedStringId {\n\t\treturn this.getInternedId(input) ?? this.createNewId(input);\n\t}\n\n\tpublic getInternedId(input: string): InternedStringId | undefined {\n\t\treturn this.stringToInternedIdMap.get(input);\n\t}\n\n\t/**\n\t *\n\t * @param internId - The intern ID to get the associated string for. Can only retrieve strings that have been\n\t * used as inputs to calls of `getInternId`.\n\t * @returns a string that is uniquely associated with the given intern ID\n\t */\n\tpublic getString(internId: number): string {\n\t\tconst result = this.internedStrings[internId];\n\t\tif (!result) {\n\t\t\tthrow new UsageError(`No string associated with ${internId}.`);\n\t\t}\n\t\treturn result;\n\t}\n\n\t/**\n\t * @returns The list of strings interned where the indices map to the associated {@link InternedStringId} of\n\t * each string.\n\t */\n\tpublic getSerializable(): readonly string[] {\n\t\treturn this.internedStrings;\n\t}\n\n\t/** Create a new interned id. Assumes without validation that the input doesn't already have an interned id. */\n\tprivate createNewId(input: string): InternedStringId {\n\t\tconst internedId = this.stringToInternedIdMap.size as InternedStringId;\n\t\tthis.stringToInternedIdMap.set(input, internedId);\n\t\tthis.internedStrings.push(input);\n\t\treturn internedId;\n\t}\n}\n"]}

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@fluid-experimental/attributor",
+  "version": "2.0.0-internal.3.3.0",
+  "description": "Operation attributor",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/framework/attributor"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "lib/index.js",
+  "types": "dist/index.d.ts",
+  "nyc": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.ts",
+      "dist/test/**/*.js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.ts",
+      "dist/**/*.js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
+  "dependencies": {
+    "@fluidframework/common-utils": "^1.1.1",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/container-runtime": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/container-utils": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/protocol-definitions": "^1.1.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "lz4js": "^0.2.0"
+  },
+  "devDependencies": {
+    "@fluid-internal/stochastic-test-utils": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluid-tools/build-cli": "^0.12.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.12.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@fluidframework/merge-tree": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/sequence": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.3.3.0 <2.0.0-internal.4.0.0",
+    "@microsoft/api-extractor": "^7.22.2",
+    "@rushstack/eslint-config": "^2.5.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^14.18.36",
+    "concurrently": "^6.2.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.2",
+    "eslint": "~8.6.0",
+    "mocha": "^10.0.0",
+    "nyc": "^15.0.0",
+    "prettier": "~2.6.2",
+    "rimraf": "^2.6.2",
+    "typescript": "~4.5.5"
+  },
+  "typeValidation": {
+    "disabled": true,
+    "broken": {}
+  },
+  "scripts": {
+    "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
+    "test:mocha": "mocha --ignore 'dist/test/memory/**/*' --recursive 'dist/test/**/*.spec.js' -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+  }
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/attributor.ts

@@ -0,0 +1,105 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/common-utils";
+import { IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { AttributionInfo } from "@fluidframework/runtime-definitions";
+import { UsageError } from "@fluidframework/container-utils";
+import { IAudience, IDeltaManager } from "@fluidframework/container-definitions";
+
+/**
+ * Provides lookup between attribution keys and their associated attribution information.
+ * @alpha
+ */
+export interface IAttributor {
+	/**
+	 * Retrieves attribution information associated with a particular key.
+	 * @param key - Attribution key to look up.
+	 * @throws If no attribution information is recorded for that key.
+	 */
+	getAttributionInfo(key: number): AttributionInfo;
+
+	/**
+	 * @param key - Attribution key to look up.
+	 * @returns the attribution information associated with the provided key, or undefined if no information exists.
+	 */
+	tryGetAttributionInfo(key: number): AttributionInfo | undefined;
+
+	/**
+	 * @returns an iterable of (attribution key, attribution info) pairs for each stored key.
+	 */
+	entries(): IterableIterator<[number, AttributionInfo]>;
+
+	// TODO:
+	// - GC
+}
+
+/**
+ * {@inheritdoc IAttributor}
+ * @alpha
+ */
+export class Attributor implements IAttributor {
+	protected readonly keyToInfo: Map<number, AttributionInfo>;
+
+	/**
+	 * @param initialEntries - Any entries which should be populated on instantiation.
+	 */
+	constructor(initialEntries?: Iterable<[number, AttributionInfo]>) {
+		this.keyToInfo = new Map(initialEntries ?? []);
+	}
+
+	/**
+	 * {@inheritdoc IAttributor.getAttributionInfo}
+	 */
+	public getAttributionInfo(key: number): AttributionInfo {
+		const result = this.tryGetAttributionInfo(key);
+		if (!result) {
+			throw new UsageError(`Requested attribution information for unstored key: ${key}.`);
+		}
+		return result;
+	}
+
+	/**
+	 * {@inheritdoc IAttributor.tryGetAttributionInfo}
+	 */
+	public tryGetAttributionInfo(key: number): AttributionInfo | undefined {
+		return this.keyToInfo.get(key);
+	}
+
+	/**
+	 * {@inheritdoc IAttributor.entries}
+	 */
+	public entries(): IterableIterator<[number, AttributionInfo]> {
+		return this.keyToInfo.entries();
+	}
+}
+
+/**
+ * Attributor which listens to an op stream and records entries for each op.
+ * Sequence numbers are used as attribution keys.
+ * @alpha
+ */
+export class OpStreamAttributor extends Attributor implements IAttributor {
+	constructor(
+		deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
+		audience: IAudience,
+		initialEntries?: Iterable<[number, AttributionInfo]>,
+	) {
+		super(initialEntries);
+		deltaManager.on("op", (message: ISequencedDocumentMessage) => {
+			const client = audience.getMember(message.clientId);
+			if (message.type === "op") {
+				// TODO: This case may be legitimate, and if so we need to figure out how to handle it.
+				assert(
+					client !== undefined,
+					0x4af /* Received message from user not in the audience */,
+				);
+				this.keyToInfo.set(message.sequenceNumber, {
+					user: client.user,
+					timestamp: message.timestamp,
+				});
+			}
+		});
+	}
+}