@fluid-experimental/attributor 2.1.0 → 2.3.0-288113

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluid-experimental/attributor
 
+## 2.2.0
+
+Dependency updates only.
+
 ## 2.1.0
 
 Dependency updates only.

package/README.md

@@ -2,7 +2,7 @@
 
 This package contains definitions and implementations for framework-provided attribution functionality.
 
-<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER) -->
 
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -139,7 +139,7 @@ The behavior of `"Fluid.Attribution.WriteOnNewFile"` supports the standard strat
 "reading the new format" corresponds to using a container runtime initialized with `mixinAttributor`, and "writing the new format" to enabling `"Fluid.Attribution.WriteOnNewFile"` in configuration.
 During the "waiting to saturate" period, developers are free to experiment with turning the feature flag on locally and testing various compatability scenarios.
 
-<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
+<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
 
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->

package/dist/attributorContracts.d.ts

@@ -0,0 +1,49 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type AttributionInfo, type AttributionKey } from "@fluidframework/runtime-definitions/internal";
+export declare const opBlobName = "opAttributor";
+/**
+ * @internal
+ */
+export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+/**
+ * @internal
+ */
+export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
+/**
+ * @internal
+ */
+export interface IProvideRuntimeAttributor {
+    readonly IRuntimeAttributor: IRuntimeAttributor;
+}
+/**
+ * @internal
+ */
+export declare const attributorDataStoreAlias = "attributor-cf9b6fe4-4c50-4a5d-9045-eb73b886f740";
+/**
+ * Provides access to attribution information stored on the container runtime.
+ *
+ * @remarks Attributors are only populated after the container runtime into which they are being injected has initialized.
+ *
+ * @sealed
+ * @internal
+ */
+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.
+     * If enabled, the runtime attributor can be asked for the attribution info for different keys.
+     * See {@link mixinAttributor} for more details on when this happens.
+     */
+    readonly isEnabled: boolean;
+}
+//# sourceMappingURL=attributorContracts.d.ts.map

package/dist/attributorContracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributorContracts.d.ts","sourceRoot":"","sources":["../src/attributorContracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,MAAM,8CAA8C,CAAC;AAGtD,eAAO,MAAM,UAAU,iBAAiB,CAAC;AAEzC;;GAEG;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;;GAEG;AACH,eAAO,MAAM,wBAAwB,oDAAoD,CAAC;AAE1F;;;;;;;GAOG;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;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC5B"}

package/dist/attributorContracts.js

@@ -0,0 +1,22 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attributorDataStoreAlias = exports.IRuntimeAttributor = exports.enableOnNewFileKey = exports.opBlobName = void 0;
+// Summary tree keys
+exports.opBlobName = "opAttributor";
+/**
+ * @internal
+ */
+exports.enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+/**
+ * @internal
+ */
+exports.IRuntimeAttributor = "IRuntimeAttributor";
+/**
+ * @internal
+ */
+exports.attributorDataStoreAlias = "attributor-cf9b6fe4-4c50-4a5d-9045-eb73b886f740";
+//# sourceMappingURL=attributorContracts.js.map

package/dist/attributorContracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributorContracts.js","sourceRoot":"","sources":["../src/attributorContracts.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,oBAAoB;AACP,QAAA,UAAU,GAAG,cAAc,CAAC;AAEzC;;GAEG;AACU,QAAA,kBAAkB,GAAG,mCAAmC,CAAC;AAEtE;;GAEG;AACU,QAAA,kBAAkB,GAAoC,oBAAoB,CAAC;AASxF;;GAEG;AACU,QAAA,wBAAwB,GAAG,iDAAiD,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\ttype AttributionInfo,\n\ttype AttributionKey,\n} from \"@fluidframework/runtime-definitions/internal\";\n\n// Summary tree keys\nexport const opBlobName = \"opAttributor\";\n\n/**\n * @internal\n */\nexport const enableOnNewFileKey = \"Fluid.Attribution.EnableOnNewFile\";\n\n/**\n * @internal\n */\nexport const IRuntimeAttributor: keyof IProvideRuntimeAttributor = \"IRuntimeAttributor\";\n\n/**\n * @internal\n */\nexport interface IProvideRuntimeAttributor {\n\treadonly IRuntimeAttributor: IRuntimeAttributor;\n}\n\n/**\n * @internal\n */\nexport const attributorDataStoreAlias = \"attributor-cf9b6fe4-4c50-4a5d-9045-eb73b886f740\";\n\n/**\n * Provides access to attribution information stored on the container runtime.\n *\n * @remarks Attributors are only populated after the container runtime into which they are being injected has initialized.\n *\n * @sealed\n * @internal\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 * If enabled, the runtime attributor can be asked for the attribution info for different keys.\n\t * See {@link mixinAttributor} for more details on when this happens.\n\t */\n\treadonly isEnabled: boolean;\n}\n"]}

package/dist/index.d.ts

@@ -3,5 +3,6 @@
  * Licensed under the MIT License.
  */
 export { type IAttributor } from "./attributor.js";
-export { createRuntimeAttributor, enableOnNewFileKey, type IProvideRuntimeAttributor, IRuntimeAttributor, mixinAttributor, } from "./mixinAttributor.js";
+export { mixinAttributor, getRuntimeAttributor } from "./mixinAttributor.js";
+export { attributorDataStoreAlias, enableOnNewFileKey, type IProvideRuntimeAttributor, IRuntimeAttributor, } from "./attributorContracts.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EACN,uBAAuB,EACvB,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,kBAAkB,EAClB,eAAe,GACf,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EACN,wBAAwB,EACxB,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,kBAAkB,GAClB,MAAM,0BAA0B,CAAC"}

package/dist/index.js

@@ -4,10 +4,12 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mixinAttributor = exports.IRuntimeAttributor = exports.enableOnNewFileKey = exports.createRuntimeAttributor = void 0;
+exports.IRuntimeAttributor = exports.enableOnNewFileKey = exports.attributorDataStoreAlias = exports.getRuntimeAttributor = exports.mixinAttributor = void 0;
 var mixinAttributor_js_1 = require("./mixinAttributor.js");
-Object.defineProperty(exports, "createRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.createRuntimeAttributor; } });
-Object.defineProperty(exports, "enableOnNewFileKey", { enumerable: true, get: function () { return mixinAttributor_js_1.enableOnNewFileKey; } });
-Object.defineProperty(exports, "IRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.IRuntimeAttributor; } });
 Object.defineProperty(exports, "mixinAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.mixinAttributor; } });
+Object.defineProperty(exports, "getRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.getRuntimeAttributor; } });
+var attributorContracts_js_1 = require("./attributorContracts.js");
+Object.defineProperty(exports, "attributorDataStoreAlias", { enumerable: true, get: function () { return attributorContracts_js_1.attributorDataStoreAlias; } });
+Object.defineProperty(exports, "enableOnNewFileKey", { enumerable: true, get: function () { return attributorContracts_js_1.enableOnNewFileKey; } });
+Object.defineProperty(exports, "IRuntimeAttributor", { enumerable: true, get: function () { return attributorContracts_js_1.IRuntimeAttributor; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2DAM8B;AAL7B,6HAAA,uBAAuB,OAAA;AACvB,wHAAA,kBAAkB,OAAA;AAElB,wHAAA,kBAAkB,OAAA;AAClB,qHAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { type IAttributor } from \"./attributor.js\";\nexport {\n\tcreateRuntimeAttributor,\n\tenableOnNewFileKey,\n\ttype IProvideRuntimeAttributor,\n\tIRuntimeAttributor,\n\tmixinAttributor,\n} from \"./mixinAttributor.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2DAA6E;AAApE,qHAAA,eAAe,OAAA;AAAE,0HAAA,oBAAoB,OAAA;AAC9C,mEAKkC;AAJjC,kIAAA,wBAAwB,OAAA;AACxB,4HAAA,kBAAkB,OAAA;AAElB,4HAAA,kBAAkB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { type IAttributor } from \"./attributor.js\";\nexport { mixinAttributor, getRuntimeAttributor } from \"./mixinAttributor.js\";\nexport {\n\tattributorDataStoreAlias,\n\tenableOnNewFileKey,\n\ttype IProvideRuntimeAttributor,\n\tIRuntimeAttributor,\n} from \"./attributorContracts.js\";\n"]}

package/dist/mixinAttributor.d.ts

@@ -3,61 +3,20 @@
  * Licensed under the MIT License.
  */
 import { ContainerRuntime } from "@fluidframework/container-runtime/internal";
-import { type AttributionInfo, type AttributionKey } from "@fluidframework/runtime-definitions/internal";
+import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
+import { type IRuntimeAttributor } from "./attributorContracts.js";
 /**
+ * Utility function to get the runtime attributor from the container runtime.
+ * @param runtime - container runtime from which attributor is to be fetched.
+ * @returns IRuntimeAttributor if it exists, otherwise undefined.
  * @internal
  */
-export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
-/**
- * @internal
- */
-export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
-/**
- * @internal
- */
-export interface IProvideRuntimeAttributor {
-    readonly IRuntimeAttributor: IRuntimeAttributor;
-}
-/**
- * Provides access to attribution information stored on the container runtime.
- *
- * @remarks Attributors are only populated after the container runtime into which they are being injected has initialized.
- *
- * @sealed
- * @internal
- */
-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.
-     * If enabled, the runtime attributor can be asked for the attribution info for different keys.
-     * See {@link mixinAttributor} for more details on when this happens.
-     */
-    readonly isEnabled: boolean;
-}
-/**
- * Creates an `IRuntimeAttributor` for usage with {@link mixinAttributor}.
- *
- * @remarks The attributor will only be populated with data once it's passed via scope to a container runtime load flow.
- *
- * @internal
- */
-export declare function createRuntimeAttributor(): IRuntimeAttributor;
+export declare function getRuntimeAttributor(runtime: IContainerRuntime): Promise<IRuntimeAttributor | undefined>;
 /**
  * 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`.
+ * Existing documents without stored attributor will not start storing attribution information. We only create the attributor
+ * if its tracking is enabled and we are creating a new document.
  * @param Base - base class, inherits from FluidAttributorRuntime
  * @internal
  */

package/dist/mixinAttributor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mixinAttributor.d.ts","sourceRoot":"","sources":["../src/mixinAttributor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAe9E,OAAO,EAGN,KAAK,eAAe,EACpB,KAAK,cAAc,EAEnB,MAAM,8CAA8C,CAAC;AAoBtD;;GAEG;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;;;;;;;GAOG;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;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,IAAI,kBAAkB,CAE5D;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,UACrB,uBAAuB,KAC3B,uBAwHqC,CAAC"}
+{"version":3,"file":"mixinAttributor.d.ts","sourceRoot":"","sources":["../src/mixinAttributor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAE9E,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wDAAwD,CAAC;AAUhG,OAAO,EAIN,KAAK,kBAAkB,EACvB,MAAM,0BAA0B,CAAC;AAGlC;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACzC,OAAO,EAAE,iBAAiB,GACxB,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAMzC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,UACrB,uBAAuB,KAC3B,uBAsEqC,CAAC"}

package/dist/mixinAttributor.js

@@ -4,61 +4,42 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mixinAttributor = exports.createRuntimeAttributor = exports.IRuntimeAttributor = exports.enableOnNewFileKey = void 0;
-const client_utils_1 = require("@fluid-internal/client-utils");
+exports.mixinAttributor = exports.getRuntimeAttributor = void 0;
 const internal_1 = require("@fluidframework/container-runtime/internal");
 const internal_2 = require("@fluidframework/core-utils/internal");
-const internal_3 = require("@fluidframework/runtime-utils/internal");
-const internal_4 = require("@fluidframework/telemetry-utils/internal");
-const attributor_js_1 = require("./attributor.js");
-const encoders_js_1 = require("./encoders.js");
-const lz4Encoder_js_1 = require("./lz4Encoder.js");
-// Summary tree keys
-const attributorTreeName = ".attributor";
-const opBlobName = "op";
+const internal_3 = require("@fluidframework/telemetry-utils/internal");
+const attributorContracts_js_1 = require("./attributorContracts.js");
+const runtimeAttributorDataStoreFactory_js_1 = require("./runtimeAttributorDataStoreFactory.js");
 /**
+ * Utility function to get the runtime attributor from the container runtime.
+ * @param runtime - container runtime from which attributor is to be fetched.
+ * @returns IRuntimeAttributor if it exists, otherwise undefined.
  * @internal
  */
-exports.enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
-/**
- * @internal
- */
-exports.IRuntimeAttributor = "IRuntimeAttributor";
-/**
- * Creates an `IRuntimeAttributor` for usage with {@link mixinAttributor}.
- *
- * @remarks The attributor will only be populated with data once it's passed via scope to a container runtime load flow.
- *
- * @internal
- */
-function createRuntimeAttributor() {
-    return new RuntimeAttributor();
+async function getRuntimeAttributor(runtime) {
+    const entryPoint = await runtime.getAliasedDataStoreEntryPoint(attributorContracts_js_1.attributorDataStoreAlias);
+    const runtimeAttributor = (await entryPoint?.get());
+    return runtimeAttributor?.IRuntimeAttributor;
 }
-exports.createRuntimeAttributor = createRuntimeAttributor;
+exports.getRuntimeAttributor = getRuntimeAttributor;
 /**
  * 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`.
+ * Existing documents without stored attributor will not start storing attribution information. We only create the attributor
+ * if its tracking is enabled and we are creating a new document.
  * @param Base - base class, inherits from FluidAttributorRuntime
  * @internal
  */
 const mixinAttributor = (Base = internal_1.ContainerRuntime) => class ContainerRuntimeWithAttributor extends Base {
     static async loadRuntime(params) {
         const { context, registryEntries, existing, requestHandler, provideEntryPoint, runtimeOptions, containerScope, containerRuntimeCtor = ContainerRuntimeWithAttributor, } = params;
-        const runtimeAttributor = containerScope?.IRuntimeAttributor;
-        if (!runtimeAttributor) {
-            throw new internal_4.UsageError("ContainerRuntimeWithAttributor must be passed a scope implementing IProvideRuntimeAttributor");
-        }
-        const pendingRuntimeState = context.pendingLocalState;
-        const baseSnapshot = pendingRuntimeState?.baseSnapshot ?? context.baseSnapshot;
-        const { quorum, deltaManager, taggedLogger } = context;
-        (0, internal_2.assert)(quorum !== undefined, 0x968 /* quorum must exist when instantiating attribution-providing runtime */);
-        const mc = (0, internal_4.loggerToMonitoringContext)(taggedLogger);
-        const shouldTrackAttribution = mc.config.getBoolean(exports.enableOnNewFileKey) ?? false;
+        const mc = (0, internal_3.loggerToMonitoringContext)(context.taggedLogger);
+        const factory = new runtimeAttributorDataStoreFactory_js_1.RuntimeAttributorFactory();
+        const registryEntriesCopy = [
+            ...registryEntries,
+            [runtimeAttributorDataStoreFactory_js_1.RuntimeAttributorFactory.type, Promise.resolve(factory)],
+        ];
+        const shouldTrackAttribution = mc.config.getBoolean(attributorContracts_js_1.enableOnNewFileKey) ?? false;
         if (shouldTrackAttribution) {
             const { options } = context;
             // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
@@ -67,116 +48,30 @@ const mixinAttributor = (Base = internal_1.ContainerRuntime) => class ContainerR
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         const runtime = (await Base.loadRuntime({
             context,
-            registryEntries,
+            registryEntries: registryEntriesCopy,
             requestHandler,
             provideEntryPoint,
-            // ! This prop is needed for back-compat. Can be removed in 2.0.0-internal.8.0.0
-            initializeEntryPoint: provideEntryPoint,
             runtimeOptions,
             containerScope,
             existing,
             containerRuntimeCtor,
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }));
-        runtime.runtimeAttributor = runtimeAttributor;
-        const logger = (0, internal_4.createChildLogger)({
-            logger: runtime.baseLogger,
-            namespace: "Attributor",
-        });
-        // 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 internal_4.PerformanceEvent.timedExecAsync(logger, {
-            eventName: "initialize",
-        }, async (event) => {
-            await runtime.runtimeAttributor?.initialize(deltaManager, quorum, baseSnapshot, async (id) => runtime.storage.readBlob(id), shouldTrackAttribution);
-            event.end({
-                attributionEnabledInConfig: shouldTrackAttribution,
-                attributionEnabledInDoc: runtime.runtimeAttributor
-                    ? runtime.runtimeAttributor.isEnabled
-                    : false,
-            });
-        });
-        return runtime;
-    }
-    addContainerStateToSummary(summaryTree, fullTree, trackState, telemetryContext) {
-        super.addContainerStateToSummary(summaryTree, fullTree, trackState, telemetryContext);
-        const attributorSummary = this.runtimeAttributor?.summarize();
-        if (attributorSummary) {
-            (0, internal_3.addSummarizeResultToSummary)(summaryTree, attributorTreeName, attributorSummary);
+        let runtimeAttributor;
+        if (shouldTrackAttribution) {
+            if (existing) {
+                runtimeAttributor = await getRuntimeAttributor(runtime);
+            }
+            else {
+                const datastore = await runtime.createDataStore(runtimeAttributorDataStoreFactory_js_1.RuntimeAttributorFactory.type);
+                const result = await datastore.trySetAlias(attributorContracts_js_1.attributorDataStoreAlias);
+                (0, internal_2.assert)(result === "Success", 0xa1b /* Failed to set alias for attributor data store */);
+                runtimeAttributor = (await datastore.entryPoint.get());
+                (0, internal_2.assert)(runtimeAttributor !== undefined, 0xa1c /* Attributor should be defined */);
+            }
         }
+        return runtime;
     }
 };
 exports.mixinAttributor = mixinAttributor;
-class RuntimeAttributor {
-    constructor() {
-        this.encoder = {
-            encode: internal_2.unreachableCase,
-            decode: internal_2.unreachableCase,
-        };
-        this.isEnabled = false;
-    }
-    get IRuntimeAttributor() {
-        return this;
-    }
-    get(key) {
-        (0, internal_2.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) {
-        if (key.type === "detached") {
-            return false;
-        }
-        if (key.type === "local") {
-            return false;
-        }
-        return this.opAttributor?.tryGetAttributionInfo(key.seq) !== undefined;
-    }
-    async initialize(deltaManager, quorum, baseSnapshot, readBlob, shouldAddAttributorOnNewFile) {
-        const attributorTree = 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_js_1.Attributor();
-            return;
-        }
-        this.isEnabled = true;
-        this.encoder = (0, encoders_js_1.chain)(new encoders_js_1.AttributorSerializer((entries) => new attributor_js_1.OpStreamAttributor(deltaManager, quorum, entries), encoders_js_1.deltaEncoder), (0, lz4Encoder_js_1.makeLZ4Encoder)());
-        if (attributorTree === undefined) {
-            this.opAttributor = new attributor_js_1.OpStreamAttributor(deltaManager, quorum);
-        }
-        else {
-            const id = attributorTree.blobs[opBlobName];
-            (0, internal_2.assert)(id !== undefined, 0x50a /* Attributor tree should have op attributor summary blob. */);
-            const blobContents = await readBlob(id);
-            const attributorSnapshot = (0, client_utils_1.bufferToString)(blobContents, "utf8");
-            this.opAttributor = this.encoder.decode(attributorSnapshot);
-        }
-    }
-    summarize() {
-        if (!this.isEnabled) {
-            // Loaded existing document without attributor data: avoid injecting any data.
-            return undefined;
-        }
-        (0, internal_2.assert)(this.opAttributor !== undefined, 0x50b /* RuntimeAttributor should be initialized before summarization */);
-        const builder = new internal_3.SummaryTreeBuilder();
-        builder.addBlob(opBlobName, this.encoder.encode(this.opAttributor));
-        return builder.getSummaryTree();
-    }
-}
 //# sourceMappingURL=mixinAttributor.js.map

package/dist/mixinAttributor.js.map

@@ -1 +1 @@
-{"version":3,"file":"mixinAttributor.js","sourceRoot":"","sources":["../src/mixinAttributor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA8D;AAK9D,yEAA8E;AAQ9E,kEAA8E;AAc9E,qEAGgD;AAChD,uEAKkD;AAElD,mDAAmF;AACnF,+CAAwF;AACxF,mDAAiD;AAEjD,oBAAoB;AACpB,MAAM,kBAAkB,GAAG,aAAa,CAAC;AACzC,MAAM,UAAU,GAAG,IAAI,CAAC;AAExB;;GAEG;AACU,QAAA,kBAAkB,GAAG,mCAAmC,CAAC;AAEtE;;GAEG;AACU,QAAA,kBAAkB,GAAoC,oBAAoB,CAAC;AAoCxF;;;;;;GAMG;AACH,SAAgB,uBAAuB;IACtC,OAAO,IAAI,iBAAiB,EAAE,CAAC;AAChC,CAAC;AAFD,0DAEC;AAED;;;;;;;;;;GAUG;AACI,MAAM,eAAe,GAAG,CAC9B,OAAgC,2BAAgB,EACtB,EAAE,CAC5B,MAAM,8BAA+B,SAAQ,IAAI;IACzC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAY/B;QACA,MAAM,EACL,OAAO,EACP,eAAe,EACf,QAAQ,EACR,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,oBAAoB,GAAG,8BAAoE,GAC3F,GAAG,MAAM,CAAC;QAEX,MAAM,iBAAiB,GACtB,cACA,EAAE,kBAAkB,CAAC;QACtB,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACxB,MAAM,IAAI,qBAAU,CACnB,8FAA8F,CAC9F,CAAC;QACH,CAAC;QAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,iBAEnC,CAAC;QACF,MAAM,YAAY,GACjB,mBAAmB,EAAE,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC;QAE3D,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QACvD,IAAA,iBAAM,EACL,MAAM,KAAK,SAAS,EACpB,KAAK,CAAC,wEAAwE,CAC9E,CAAC;QAEF,MAAM,EAAE,GAAG,IAAA,oCAAyB,EAAC,YAAY,CAAC,CAAC;QAEnD,MAAM,sBAAsB,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,0BAAkB,CAAC,IAAI,KAAK,CAAC;QACjF,IAAI,sBAAsB,EAAE,CAAC;YAC5B,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;YAC5B,sEAAsE;YACtE,CAAC,OAAO,CAAC,WAAW,KAAnB,OAAO,CAAC,WAAW,GAAK,EAAE,EAAC,CAAC,KAAK,GAAG,IAAI,CAAC;QAC3C,CAAC;QAED,iEAAiE;QACjE,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC;YACvC,OAAO;YACP,eAAe;YACf,cAAc;YACd,iBAAiB;YACjB,gFAAgF;YAChF,oBAAoB,EAAE,iBAAiB;YACvC,cAAc;YACd,cAAc;YACd,QAAQ;YACR,oBAAoB;YACpB,8DAA8D;SACvD,CAAC,CAAmC,CAAC;QAC7C,OAAO,CAAC,iBAAiB,GAAG,iBAAsC,CAAC;QAEnE,MAAM,MAAM,GAAG,IAAA,4BAAiB,EAAC;YAChC,MAAM,EAAE,OAAO,CAAC,UAAU;YAC1B,SAAS,EAAE,YAAY;SACvB,CAAC,CAAC;QAEH,oGAAoG;QACpG,2GAA2G;QAC3G,kGAAkG;QAClG,0CAA0C;QAC1C,MAAM,2BAAgB,CAAC,cAAc,CACpC,MAAM,EACN;YACC,SAAS,EAAE,YAAY;SACvB,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACf,MAAM,OAAO,CAAC,iBAAiB,EAAE,UAAU,CAC1C,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC1C,sBAAsB,CACtB,CAAC;YACF,KAAK,CAAC,GAAG,CAAC;gBACT,0BAA0B,EAAE,sBAAsB;gBAClD,uBAAuB,EAAE,OAAO,CAAC,iBAAiB;oBACjD,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,SAAS;oBACrC,CAAC,CAAC,KAAK;aACR,CAAC,CAAC;QACJ,CAAC,CACD,CAAC;QAEF,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,IAAI,CAAC,iBAAiB,EAAE,SAAS,EAAE,CAAC;QAC9D,IAAI,iBAAiB,EAAE,CAAC;YACvB,IAAA,sCAA2B,EAAC,WAAW,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;QACjF,CAAC;IACF,CAAC;CACqC,CAAC;AA1H5B,QAAA,eAAe,mBA0Ha;AAEzC,MAAM,iBAAiB;IAAvB;QAuCS,YAAO,GAAiC;YAC/C,MAAM,EAAE,0BAAe;YACvB,MAAM,EAAE,0BAAe;SACvB,CAAC;QAGK,cAAS,GAAG,KAAK,CAAC;IA0D1B,CAAC;IAtGA,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,GAAG,CAAC,GAAmB;QAC7B,IAAA,iBAAM,EACL,IAAI,CAAC,YAAY,KAAK,SAAS,EAC/B,KAAK,CAAC,mFAAmF,CACzF,CAAC;QAEF,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,wGAAwG;YACxG,0GAA0G;YAC1G,wGAAwG;YACxG,qGAAqG;YACrG,uDAAuD;YACvD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACpE,CAAC;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,CAAC;YAC7B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;IACxE,CAAC;IAUM,KAAK,CAAC,UAAU,CACtB,YAAwE,EACxE,MAAsB,EACtB,YAAuC,EACvC,QAAkD,EAClD,4BAAqC;QAErC,MAAM,cAAc,GAAG,YAAY,EAAE,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,CAAC;YAC7B,6EAA6E;YAC7E,IAAI,CAAC,YAAY,GAAG,IAAI,0BAAU,EAAE,CAAC;YACrC,OAAO;QACR,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAA,mBAAK,EACnB,IAAI,kCAAoB,CACvB,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,kCAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAClE,0BAAY,CACZ,EACD,IAAA,8BAAc,GAAE,CAChB,CAAC;QAEF,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,YAAY,GAAG,IAAI,kCAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACP,MAAM,EAAE,GAAG,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAA,iBAAM,EACL,EAAE,KAAK,SAAS,EAChB,KAAK,CAAC,6DAA6D,CACnE,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxC,MAAM,kBAAkB,GAAG,IAAA,6BAAc,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAChE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC7D,CAAC;IACF,CAAC;IAEM,SAAS;QACf,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACrB,8EAA8E;YAC9E,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,IAAA,iBAAM,EACL,IAAI,CAAC,YAAY,KAAK,SAAS,EAC/B,KAAK,CAAC,kEAAkE,CACxE,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,6BAAkB,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 */\n\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport {\n\ttype IDeltaManager,\n\ttype IContainerContext,\n} from \"@fluidframework/container-definitions/internal\";\nimport { ContainerRuntime } from \"@fluidframework/container-runtime/internal\";\nimport type { IContainerRuntimeOptions } from \"@fluidframework/container-runtime/internal\";\nimport { type IContainerRuntime } from \"@fluidframework/container-runtime-definitions/internal\";\nimport {\n\ttype FluidObject,\n\ttype IRequest,\n\ttype IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { assert, unreachableCase } from \"@fluidframework/core-utils/internal\";\nimport { type IQuorumClients } from \"@fluidframework/driver-definitions\";\nimport {\n\ttype IDocumentMessage,\n\ttype ISnapshotTree,\n\ttype ISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport {\n\ttype ISummaryTreeWithStats,\n\ttype ITelemetryContext,\n\ttype AttributionInfo,\n\ttype AttributionKey,\n\ttype NamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\tSummaryTreeBuilder,\n\taddSummarizeResultToSummary,\n} from \"@fluidframework/runtime-utils/internal\";\nimport {\n\tPerformanceEvent,\n\tUsageError,\n\tcreateChildLogger,\n\tloggerToMonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport { Attributor, type IAttributor, OpStreamAttributor } from \"./attributor.js\";\nimport { AttributorSerializer, type Encoder, chain, deltaEncoder } from \"./encoders.js\";\nimport { makeLZ4Encoder } from \"./lz4Encoder.js\";\n\n// Summary tree keys\nconst attributorTreeName = \".attributor\";\nconst opBlobName = \"op\";\n\n/**\n * @internal\n */\nexport const enableOnNewFileKey = \"Fluid.Attribution.EnableOnNewFile\";\n\n/**\n * @internal\n */\nexport const IRuntimeAttributor: keyof IProvideRuntimeAttributor = \"IRuntimeAttributor\";\n\n/**\n * @internal\n */\nexport interface IProvideRuntimeAttributor {\n\treadonly IRuntimeAttributor: IRuntimeAttributor;\n}\n\n/**\n * Provides access to attribution information stored on the container runtime.\n *\n * @remarks Attributors are only populated after the container runtime into which they are being injected has initialized.\n *\n * @sealed\n * @internal\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 * If enabled, the runtime attributor can be asked for the attribution info for different keys.\n\t * See {@link mixinAttributor} for more details on when this happens.\n\t */\n\treadonly isEnabled: boolean;\n}\n\n/**\n * Creates an `IRuntimeAttributor` for usage with {@link mixinAttributor}.\n *\n * @remarks The attributor will only be populated with data once it's passed via scope to a container runtime load flow.\n *\n * @internal\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 * @internal\n */\nexport const mixinAttributor = (\n\tBase: typeof ContainerRuntime = ContainerRuntime,\n): typeof ContainerRuntime =>\n\tclass ContainerRuntimeWithAttributor extends Base {\n\t\tpublic static async loadRuntime(params: {\n\t\t\tcontext: IContainerContext;\n\t\t\tregistryEntries: NamedFluidDataStoreRegistryEntries;\n\t\t\texisting: boolean;\n\t\t\truntimeOptions?: IContainerRuntimeOptions;\n\t\t\tcontainerScope?: FluidObject;\n\t\t\tcontainerRuntimeCtor?: typeof ContainerRuntime;\n\t\t\t/**\n\t\t\t * @deprecated Will be removed once Loader LTS version is \"2.0.0-internal.7.0.0\". Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n\t\t\t */\n\t\t\trequestHandler?: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>;\n\t\t\tprovideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;\n\t\t}): Promise<ContainerRuntime> {\n\t\t\tconst {\n\t\t\t\tcontext,\n\t\t\t\tregistryEntries,\n\t\t\t\texisting,\n\t\t\t\trequestHandler,\n\t\t\t\tprovideEntryPoint,\n\t\t\t\truntimeOptions,\n\t\t\t\tcontainerScope,\n\t\t\t\tcontainerRuntimeCtor = ContainerRuntimeWithAttributor as unknown as typeof ContainerRuntime,\n\t\t\t} = params;\n\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 { quorum, deltaManager, taggedLogger } = context;\n\t\t\tassert(\n\t\t\t\tquorum !== undefined,\n\t\t\t\t0x968 /* quorum must exist when instantiating attribution-providing runtime */,\n\t\t\t);\n\n\t\t\tconst mc = loggerToMonitoringContext(taggedLogger);\n\n\t\t\tconst shouldTrackAttribution = mc.config.getBoolean(enableOnNewFileKey) ?? false;\n\t\t\tif (shouldTrackAttribution) {\n\t\t\t\tconst { options } = context;\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\t\t(options.attribution ??= {}).track = true;\n\t\t\t}\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\tconst runtime = (await Base.loadRuntime({\n\t\t\t\tcontext,\n\t\t\t\tregistryEntries,\n\t\t\t\trequestHandler,\n\t\t\t\tprovideEntryPoint,\n\t\t\t\t// ! This prop is needed for back-compat. Can be removed in 2.0.0-internal.8.0.0\n\t\t\t\tinitializeEntryPoint: provideEntryPoint,\n\t\t\t\truntimeOptions,\n\t\t\t\tcontainerScope,\n\t\t\t\texisting,\n\t\t\t\tcontainerRuntimeCtor,\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t} as any)) as ContainerRuntimeWithAttributor;\n\t\t\truntime.runtimeAttributor = runtimeAttributor as RuntimeAttributor;\n\n\t\t\tconst logger = createChildLogger({\n\t\t\t\tlogger: runtime.baseLogger,\n\t\t\t\tnamespace: \"Attributor\",\n\t\t\t});\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 PerformanceEvent.timedExecAsync(\n\t\t\t\tlogger,\n\t\t\t\t{\n\t\t\t\t\teventName: \"initialize\",\n\t\t\t\t},\n\t\t\t\tasync (event) => {\n\t\t\t\t\tawait runtime.runtimeAttributor?.initialize(\n\t\t\t\t\t\tdeltaManager,\n\t\t\t\t\t\tquorum,\n\t\t\t\t\t\tbaseSnapshot,\n\t\t\t\t\t\tasync (id) => runtime.storage.readBlob(id),\n\t\t\t\t\t\tshouldTrackAttribution,\n\t\t\t\t\t);\n\t\t\t\t\tevent.end({\n\t\t\t\t\t\tattributionEnabledInConfig: shouldTrackAttribution,\n\t\t\t\t\t\tattributionEnabledInDoc: runtime.runtimeAttributor\n\t\t\t\t\t\t\t? runtime.runtimeAttributor.isEnabled\n\t\t\t\t\t\t\t: false,\n\t\t\t\t\t});\n\t\t\t\t},\n\t\t\t);\n\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): void {\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\tquorum: IQuorumClients,\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, quorum, 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\tthis.opAttributor = new OpStreamAttributor(deltaManager, quorum);\n\t\t} else {\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}\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"]}
+{"version":3,"file":"mixinAttributor.js","sourceRoot":"","sources":["../src/mixinAttributor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yEAA8E;AAQ9E,kEAA6D;AAE7D,uEAAqF;AAErF,qEAKkC;AAClC,iGAAkF;AAElF;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB,CACzC,OAA0B;IAE1B,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,6BAA6B,CAAC,iDAAwB,CAAC,CAAC;IACzF,MAAM,iBAAiB,GAAG,CAAC,MAAM,UAAU,EAAE,GAAG,EAAE,CAEtC,CAAC;IACb,OAAO,iBAAiB,EAAE,kBAAkB,CAAC;AAC9C,CAAC;AARD,oDAQC;AAED;;;;;;;GAOG;AACI,MAAM,eAAe,GAAG,CAC9B,OAAgC,2BAAgB,EACtB,EAAE,CAC5B,MAAM,8BAA+B,SAAQ,IAAI;IACzC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAY/B;QACA,MAAM,EACL,OAAO,EACP,eAAe,EACf,QAAQ,EACR,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,oBAAoB,GAAG,8BAAoE,GAC3F,GAAG,MAAM,CAAC;QAEX,MAAM,EAAE,GAAG,IAAA,oCAAyB,EAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAG,IAAI,+DAAwB,EAAE,CAAC;QAC/C,MAAM,mBAAmB,GAAuC;YAC/D,GAAG,eAAe;YAClB,CAAC,+DAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACzD,CAAC;QACF,MAAM,sBAAsB,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,2CAAkB,CAAC,IAAI,KAAK,CAAC;QACjF,IAAI,sBAAsB,EAAE,CAAC;YAC5B,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;YAC5B,sEAAsE;YACtE,CAAC,OAAO,CAAC,WAAW,KAAnB,OAAO,CAAC,WAAW,GAAK,EAAE,EAAC,CAAC,KAAK,GAAG,IAAI,CAAC;QAC3C,CAAC;QAED,iEAAiE;QACjE,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC;YACvC,OAAO;YACP,eAAe,EAAE,mBAAmB;YACpC,cAAc;YACd,iBAAiB;YACjB,cAAc;YACd,cAAc;YACd,QAAQ;YACR,oBAAoB;YACpB,8DAA8D;SACvD,CAAC,CAAmC,CAAC;QAE7C,IAAI,iBAAiD,CAAC;QACtD,IAAI,sBAAsB,EAAE,CAAC;YAC5B,IAAI,QAAQ,EAAE,CAAC;gBACd,iBAAiB,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACP,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,+DAAwB,CAAC,IAAI,CAAC,CAAC;gBAC/E,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,iDAAwB,CAAC,CAAC;gBACrE,IAAA,iBAAM,EACL,MAAM,KAAK,SAAS,EACpB,KAAK,CAAC,mDAAmD,CACzD,CAAC;gBACF,iBAAiB,GAAG,CAAC,MAAM,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,CAAuB,CAAC;gBAC7E,IAAA,iBAAM,EAAC,iBAAiB,KAAK,SAAS,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;YACnF,CAAC;QACF,CAAC;QAED,OAAO,OAAO,CAAC;IAChB,CAAC;CACqC,CAAC;AAxE5B,QAAA,eAAe,mBAwEa","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type IContainerContext } from \"@fluidframework/container-definitions/internal\";\nimport { ContainerRuntime } from \"@fluidframework/container-runtime/internal\";\nimport type { IContainerRuntimeOptions } from \"@fluidframework/container-runtime/internal\";\nimport { type IContainerRuntime } from \"@fluidframework/container-runtime-definitions/internal\";\nimport {\n\ttype FluidObject,\n\ttype IRequest,\n\ttype IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { type NamedFluidDataStoreRegistryEntries } from \"@fluidframework/runtime-definitions/internal\";\nimport { loggerToMonitoringContext } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\tattributorDataStoreAlias,\n\tenableOnNewFileKey,\n\ttype IProvideRuntimeAttributor,\n\ttype IRuntimeAttributor,\n} from \"./attributorContracts.js\";\nimport { RuntimeAttributorFactory } from \"./runtimeAttributorDataStoreFactory.js\";\n\n/**\n * Utility function to get the runtime attributor from the container runtime.\n * @param runtime - container runtime from which attributor is to be fetched.\n * @returns IRuntimeAttributor if it exists, otherwise undefined.\n * @internal\n */\nexport async function getRuntimeAttributor(\n\truntime: IContainerRuntime,\n): Promise<IRuntimeAttributor | undefined> {\n\tconst entryPoint = await runtime.getAliasedDataStoreEntryPoint(attributorDataStoreAlias);\n\tconst runtimeAttributor = (await entryPoint?.get()) as\n\t\t| FluidObject<IProvideRuntimeAttributor>\n\t\t| undefined;\n\treturn runtimeAttributor?.IRuntimeAttributor;\n}\n\n/**\n * Mixes in logic to load and store runtime-based attribution functionality.\n *\n * Existing documents without stored attributor will not start storing attribution information. We only create the attributor\n * if its tracking is enabled and we are creating a new document.\n * @param Base - base class, inherits from FluidAttributorRuntime\n * @internal\n */\nexport const mixinAttributor = (\n\tBase: typeof ContainerRuntime = ContainerRuntime,\n): typeof ContainerRuntime =>\n\tclass ContainerRuntimeWithAttributor extends Base {\n\t\tpublic static async loadRuntime(params: {\n\t\t\tcontext: IContainerContext;\n\t\t\tregistryEntries: NamedFluidDataStoreRegistryEntries;\n\t\t\texisting: boolean;\n\t\t\truntimeOptions?: IContainerRuntimeOptions;\n\t\t\tcontainerScope?: FluidObject;\n\t\t\tcontainerRuntimeCtor?: typeof ContainerRuntime;\n\t\t\t/**\n\t\t\t * @deprecated Will be removed once Loader LTS version is \"2.0.0-internal.7.0.0\". Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n\t\t\t */\n\t\t\trequestHandler?: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>;\n\t\t\tprovideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;\n\t\t}): Promise<ContainerRuntime> {\n\t\t\tconst {\n\t\t\t\tcontext,\n\t\t\t\tregistryEntries,\n\t\t\t\texisting,\n\t\t\t\trequestHandler,\n\t\t\t\tprovideEntryPoint,\n\t\t\t\truntimeOptions,\n\t\t\t\tcontainerScope,\n\t\t\t\tcontainerRuntimeCtor = ContainerRuntimeWithAttributor as unknown as typeof ContainerRuntime,\n\t\t\t} = params;\n\n\t\t\tconst mc = loggerToMonitoringContext(context.taggedLogger);\n\t\t\tconst factory = new RuntimeAttributorFactory();\n\t\t\tconst registryEntriesCopy: NamedFluidDataStoreRegistryEntries = [\n\t\t\t\t...registryEntries,\n\t\t\t\t[RuntimeAttributorFactory.type, Promise.resolve(factory)],\n\t\t\t];\n\t\t\tconst shouldTrackAttribution = mc.config.getBoolean(enableOnNewFileKey) ?? false;\n\t\t\tif (shouldTrackAttribution) {\n\t\t\t\tconst { options } = context;\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\t\t(options.attribution ??= {}).track = true;\n\t\t\t}\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\tconst runtime = (await Base.loadRuntime({\n\t\t\t\tcontext,\n\t\t\t\tregistryEntries: registryEntriesCopy,\n\t\t\t\trequestHandler,\n\t\t\t\tprovideEntryPoint,\n\t\t\t\truntimeOptions,\n\t\t\t\tcontainerScope,\n\t\t\t\texisting,\n\t\t\t\tcontainerRuntimeCtor,\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t} as any)) as ContainerRuntimeWithAttributor;\n\n\t\t\tlet runtimeAttributor: IRuntimeAttributor | undefined;\n\t\t\tif (shouldTrackAttribution) {\n\t\t\t\tif (existing) {\n\t\t\t\t\truntimeAttributor = await getRuntimeAttributor(runtime);\n\t\t\t\t} else {\n\t\t\t\t\tconst datastore = await runtime.createDataStore(RuntimeAttributorFactory.type);\n\t\t\t\t\tconst result = await datastore.trySetAlias(attributorDataStoreAlias);\n\t\t\t\t\tassert(\n\t\t\t\t\t\tresult === \"Success\",\n\t\t\t\t\t\t0xa1b /* Failed to set alias for attributor data store */,\n\t\t\t\t\t);\n\t\t\t\t\truntimeAttributor = (await datastore.entryPoint.get()) as IRuntimeAttributor;\n\t\t\t\t\tassert(runtimeAttributor !== undefined, 0xa1c /* Attributor should be defined */);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn runtime;\n\t\t}\n\t} as unknown as typeof ContainerRuntime;\n"]}

package/dist/runtimeAttributor.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDeltaManager } from "@fluidframework/container-definitions/internal";
+import { IDocumentMessage, type ISnapshotTree, ISequencedDocumentMessage, IQuorumClients } from "@fluidframework/driver-definitions/internal";
+import { type AttributionInfo, type AttributionKey, type ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
+import { type IRuntimeAttributor } from "./attributorContracts.js";
+export declare class RuntimeAttributor implements IRuntimeAttributor {
+    get IRuntimeAttributor(): IRuntimeAttributor;
+    get(key: AttributionKey): AttributionInfo;
+    has(key: AttributionKey): boolean;
+    private encoder;
+    private opAttributor;
+    isEnabled: boolean;
+    initialize(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, quorum: IQuorumClients, baseSnapshotForAttributorTree: ISnapshotTree | undefined, readBlob: (id: string) => Promise<ArrayBufferLike>): Promise<void>;
+    summarizeOpAttributor(): ISummaryTreeWithStats;
+}
+//# sourceMappingURL=runtimeAttributor.d.ts.map

package/dist/runtimeAttributor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributor.d.ts","sourceRoot":"","sources":["../src/runtimeAttributor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AAE/E,OAAO,EACN,gBAAgB,EAChB,KAAK,aAAa,EAClB,yBAAyB,EACzB,cAAc,EACd,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,MAAM,8CAA8C,CAAC;AAItD,OAAO,EAAc,KAAK,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAI/E,qBAAa,iBAAkB,YAAW,kBAAkB;IAC3D,IAAW,kBAAkB,IAAI,kBAAkB,CAElD;IAEM,GAAG,CAAC,GAAG,EAAE,cAAc,GAAG,eAAe;IAsBzC,GAAG,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO;IAYxC,OAAO,CAAC,OAAO,CAGb;IAEF,OAAO,CAAC,YAAY,CAA0B;IACvC,SAAS,UAAQ;IAEX,UAAU,CACtB,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,MAAM,EAAE,cAAc,EACtB,6BAA6B,EAAE,aAAa,GAAG,SAAS,EACxD,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,GAChD,OAAO,CAAC,IAAI,CAAC;IAuBT,qBAAqB,IAAI,qBAAqB;CASrD"}

package/dist/runtimeAttributor.js

@@ -0,0 +1,71 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeAttributor = void 0;
+const client_utils_1 = require("@fluid-internal/client-utils");
+const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/runtime-utils/internal");
+const attributor_js_1 = require("./attributor.js");
+const attributorContracts_js_1 = require("./attributorContracts.js");
+const encoders_js_1 = require("./encoders.js");
+const lz4Encoder_js_1 = require("./lz4Encoder.js");
+class RuntimeAttributor {
+    constructor() {
+        this.encoder = {
+            encode: internal_1.unreachableCase,
+            decode: internal_1.unreachableCase,
+        };
+        this.isEnabled = true;
+    }
+    get IRuntimeAttributor() {
+        return this;
+    }
+    get(key) {
+        (0, internal_1.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) {
+        if (key.type === "detached") {
+            return false;
+        }
+        if (key.type === "local") {
+            return false;
+        }
+        return this.opAttributor?.tryGetAttributionInfo(key.seq) !== undefined;
+    }
+    async initialize(deltaManager, quorum, baseSnapshotForAttributorTree, readBlob) {
+        this.encoder = (0, encoders_js_1.chain)(new encoders_js_1.AttributorSerializer((entries) => new attributor_js_1.OpStreamAttributor(deltaManager, quorum, entries), encoders_js_1.deltaEncoder), (0, lz4Encoder_js_1.makeLZ4Encoder)());
+        if (baseSnapshotForAttributorTree === undefined) {
+            this.opAttributor = new attributor_js_1.OpStreamAttributor(deltaManager, quorum);
+        }
+        else {
+            const id = baseSnapshotForAttributorTree.blobs[attributorContracts_js_1.opBlobName];
+            (0, internal_1.assert)(id !== undefined, 0x50a /* Attributor tree should have op attributor summary blob. */);
+            const blobContents = await readBlob(id);
+            const attributorSnapshot = (0, client_utils_1.bufferToString)(blobContents, "utf8");
+            this.opAttributor = this.encoder.decode(attributorSnapshot);
+        }
+    }
+    summarizeOpAttributor() {
+        (0, internal_1.assert)(this.opAttributor !== undefined, 0xa1d /* RuntimeAttributor should be initialized before summarization */);
+        const builder = new internal_2.SummaryTreeBuilder();
+        builder.addBlob(attributorContracts_js_1.opBlobName, this.encoder.encode(this.opAttributor));
+        return builder.getSummaryTree();
+    }
+}
+exports.RuntimeAttributor = RuntimeAttributor;
+//# sourceMappingURL=runtimeAttributor.js.map

package/dist/runtimeAttributor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributor.js","sourceRoot":"","sources":["../src/runtimeAttributor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA8D;AAE9D,kEAA8E;AAY9E,qEAA4E;AAE5E,mDAAuE;AACvE,qEAA+E;AAC/E,+CAAwF;AACxF,mDAAiD;AAEjD,MAAa,iBAAiB;IAA9B;QAuCS,YAAO,GAAiC;YAC/C,MAAM,EAAE,0BAAe;YACvB,MAAM,EAAE,0BAAe;SACvB,CAAC;QAGK,cAAS,GAAG,IAAI,CAAC;IAuCzB,CAAC;IAnFA,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,GAAG,CAAC,GAAmB;QAC7B,IAAA,iBAAM,EACL,IAAI,CAAC,YAAY,KAAK,SAAS,EAC/B,KAAK,CAAC,mFAAmF,CACzF,CAAC;QAEF,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,wGAAwG;YACxG,0GAA0G;YAC1G,wGAAwG;YACxG,qGAAqG;YACrG,uDAAuD;YACvD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACpE,CAAC;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,CAAC;YAC7B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;IACxE,CAAC;IAUM,KAAK,CAAC,UAAU,CACtB,YAAwE,EACxE,MAAsB,EACtB,6BAAwD,EACxD,QAAkD;QAElD,IAAI,CAAC,OAAO,GAAG,IAAA,mBAAK,EACnB,IAAI,kCAAoB,CACvB,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,kCAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAClE,0BAAY,CACZ,EACD,IAAA,8BAAc,GAAE,CAChB,CAAC;QAEF,IAAI,6BAA6B,KAAK,SAAS,EAAE,CAAC;YACjD,IAAI,CAAC,YAAY,GAAG,IAAI,kCAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACP,MAAM,EAAE,GAAG,6BAA6B,CAAC,KAAK,CAAC,mCAAU,CAAC,CAAC;YAC3D,IAAA,iBAAM,EACL,EAAE,KAAK,SAAS,EAChB,KAAK,CAAC,6DAA6D,CACnE,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxC,MAAM,kBAAkB,GAAG,IAAA,6BAAc,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAChE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC7D,CAAC;IACF,CAAC;IAEM,qBAAqB;QAC3B,IAAA,iBAAM,EACL,IAAI,CAAC,YAAY,KAAK,SAAS,EAC/B,KAAK,CAAC,kEAAkE,CACxE,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,6BAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,mCAAU,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACpE,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;CACD;AApFD,8CAoFC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions/internal\";\nimport { assert, unreachableCase } from \"@fluidframework/core-utils/internal\";\nimport {\n\tIDocumentMessage,\n\ttype ISnapshotTree,\n\tISequencedDocumentMessage,\n\tIQuorumClients,\n} from \"@fluidframework/driver-definitions/internal\";\nimport {\n\ttype AttributionInfo,\n\ttype AttributionKey,\n\ttype ISummaryTreeWithStats,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport { OpStreamAttributor, type IAttributor } from \"./attributor.js\";\nimport { opBlobName, type IRuntimeAttributor } from \"./attributorContracts.js\";\nimport { AttributorSerializer, chain, deltaEncoder, type Encoder } from \"./encoders.js\";\nimport { makeLZ4Encoder } from \"./lz4Encoder.js\";\n\nexport class 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 = true;\n\n\tpublic async initialize(\n\t\tdeltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n\t\tquorum: IQuorumClients,\n\t\tbaseSnapshotForAttributorTree: ISnapshotTree | undefined,\n\t\treadBlob: (id: string) => Promise<ArrayBufferLike>,\n\t): Promise<void> {\n\t\tthis.encoder = chain(\n\t\t\tnew AttributorSerializer(\n\t\t\t\t(entries) => new OpStreamAttributor(deltaManager, quorum, entries),\n\t\t\t\tdeltaEncoder,\n\t\t\t),\n\t\t\tmakeLZ4Encoder(),\n\t\t);\n\n\t\tif (baseSnapshotForAttributorTree === undefined) {\n\t\t\tthis.opAttributor = new OpStreamAttributor(deltaManager, quorum);\n\t\t} else {\n\t\t\tconst id = baseSnapshotForAttributorTree.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}\n\t}\n\n\tpublic summarizeOpAttributor(): ISummaryTreeWithStats {\n\t\tassert(\n\t\t\tthis.opAttributor !== undefined,\n\t\t\t0xa1d /* 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"]}