@fluid-experimental/attributor 2.1.0 → 2.3.0-288113

package/dist/runtimeAttributorDataStoreChannel.d.ts

@@ -0,0 +1,92 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { AttachState, IDeltaManager } from "@fluidframework/container-definitions/internal";
+import { FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
+import type { IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
+import { IFluidDataStoreRuntimeEvents } from "@fluidframework/datastore-definitions/internal";
+import { IDocumentMessage, type ISnapshotTree, ISequencedDocumentMessage, IQuorumClients } from "@fluidframework/driver-definitions/internal";
+import { IGarbageCollectionData, IFluidDataStoreChannel, IFluidDataStoreContext, IInboundSignalMessage, VisibilityState, type ISummaryTreeWithStats, type ITelemetryContext } from "@fluidframework/runtime-definitions/internal";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+/**
+ * Data store channel for the runtime attributor. This channel is responsible for storing and managing the
+ */
+export declare class RuntimeAttributorDataStoreChannel extends TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements IFluidDataStoreChannel {
+    readonly dataStoreContext: IFluidDataStoreContext;
+    constructor(dataStoreContext: IFluidDataStoreContext, existing: boolean);
+    get IFluidDataStoreChannel(): IFluidDataStoreChannel;
+    private _disposed;
+    get disposed(): boolean;
+    dispose(): void;
+    private readonly runtimeAttributor;
+    isEnabled: boolean;
+    attachState: AttachState;
+    visibilityState: VisibilityState;
+    private readonly deferredAttached;
+    private readonly mc;
+    get logger(): ITelemetryLoggerExt;
+    initialize(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, quorum: IQuorumClients, baseSnapshotForAttributorTree: ISnapshotTree | undefined, readBlob: (id: string) => Promise<ArrayBufferLike>): Promise<void>;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.makeVisibleAndAttachGraph}
+     */
+    makeVisibleAndAttachGraph(): void;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.getAttachSummary}
+     */
+    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.getAttachGCData}
+     */
+    getAttachGCData(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.process}
+     */
+    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.processSignal}
+     */
+    processSignal(message: IInboundSignalMessage, local: boolean): void;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.summarize}
+     */
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.getGCData}
+     */
+    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.updateUsedRoutes}
+     */
+    updateUsedRoutes(usedRoutes: string[]): void;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.setConnectionState}
+     */
+    setConnectionState(connected: boolean, clientId?: string): void;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.reSubmit}
+     */
+    reSubmit(type: string, content: unknown, localOpMetadata: unknown): void;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.applyStashedOp}
+     */
+    applyStashedOp(content: unknown): Promise<unknown>;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.rollback}
+     */
+    rollback?(type: string, content: unknown, localOpMetadata: unknown): void;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.entryPoint}
+     */
+    readonly entryPoint: IFluidHandleInternal<FluidObject>;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.request}
+     */
+    request(request: IRequest): Promise<IResponse>;
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.setAttachState}
+     */
+    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
+}
+//# sourceMappingURL=runtimeAttributorDataStoreChannel.d.ts.map

package/dist/runtimeAttributorDataStoreChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributorDataStoreChannel.d.ts","sourceRoot":"","sources":["../src/runtimeAttributorDataStoreChannel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AAC5F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACnF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAGrF,OAAO,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AAC9F,OAAO,EACN,gBAAgB,EAChB,KAAK,aAAa,EAClB,yBAAyB,EACzB,cAAc,EACd,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACN,mBAAmB,EAInB,MAAM,0CAA0C,CAAC;AAIlD;;GAEG;AACH,qBAAa,iCACZ,SAAQ,iBAAiB,CAAC,4BAA4B,CACtD,YAAW,sBAAsB;aAGhB,gBAAgB,EAAE,sBAAsB;gBAAxC,gBAAgB,EAAE,sBAAsB,EACxD,QAAQ,EAAE,OAAO;IA4BlB,IAAW,sBAAsB,IAAI,sBAAsB,CAE1D;IAED,OAAO,CAAC,SAAS,CAAS;IAC1B,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAEM,OAAO,IAAI,IAAI;IAItB,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IAC/C,SAAS,UAAQ;IACjB,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAwB;IACzD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IACvC,IAAW,MAAM,IAAI,mBAAmB,CAEvC;IAEY,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;IAShB;;OAEG;IACI,yBAAyB,IAAI,IAAI;IASxC;;OAEG;IACI,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,qBAAqB;IAIpF;;OAEG;IACI,eAAe,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,sBAAsB;IAIpF;;OAEG;IACI,OAAO,CACb,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO,GACtB,IAAI;IAIP;;OAEG;IACI,aAAa,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAI1E;;OAEG;IACU,SAAS,CACrB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;OAEG;IACU,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAMzE;;OAEG;IACI,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAInD;;OAEG;IACI,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAItE;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAK/E;;OAEG;IACU,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/D;;OAEG;IACI,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAKhF;;OAEG;IACH,SAAgB,UAAU,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAE9D;;OAEG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAK3D;;OAEG;IACI,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,GAAG,IAAI;CAgCtF"}

package/dist/runtimeAttributorDataStoreChannel.js

@@ -0,0 +1,177 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeAttributorDataStoreChannel = void 0;
+const client_utils_1 = require("@fluid-internal/client-utils");
+const internal_1 = require("@fluidframework/container-definitions/internal");
+const internal_2 = require("@fluidframework/core-utils/internal");
+const internal_3 = require("@fluidframework/datastore/internal");
+const internal_4 = require("@fluidframework/runtime-definitions/internal");
+const internal_5 = require("@fluidframework/telemetry-utils/internal");
+const runtimeAttributor_js_1 = require("./runtimeAttributor.js");
+/**
+ * Data store channel for the runtime attributor. This channel is responsible for storing and managing the
+ */
+class RuntimeAttributorDataStoreChannel extends client_utils_1.TypedEventEmitter {
+    constructor(dataStoreContext, existing) {
+        super();
+        this.dataStoreContext = dataStoreContext;
+        this._disposed = false;
+        this.isEnabled = true;
+        this.deferredAttached = new internal_2.Deferred();
+        this.runtimeAttributor = new runtimeAttributor_js_1.RuntimeAttributor();
+        this.mc = (0, internal_5.createChildMonitoringContext)({
+            logger: dataStoreContext.baseLogger,
+            namespace: "Attributor",
+        });
+        this.attachState = dataStoreContext.attachState;
+        if (existing) {
+            this.visibilityState =
+                dataStoreContext.attachState === internal_1.AttachState.Detached
+                    ? internal_4.VisibilityState.LocallyVisible
+                    : internal_4.VisibilityState.GloballyVisible;
+        }
+        else {
+            this.visibilityState = internal_4.VisibilityState.NotVisible;
+        }
+        // If it's existing we know it has been attached.
+        if (existing) {
+            this.deferredAttached.resolve();
+        }
+        this.entryPoint = new internal_3.FluidObjectHandle(this.runtimeAttributor, "", dataStoreContext.IFluidHandleContext);
+    }
+    get IFluidDataStoreChannel() {
+        return this;
+    }
+    get disposed() {
+        return this._disposed;
+    }
+    dispose() {
+        this._disposed = true;
+    }
+    get logger() {
+        return this.mc.logger;
+    }
+    async initialize(deltaManager, quorum, baseSnapshotForAttributorTree, readBlob) {
+        await this.runtimeAttributor.initialize(deltaManager, quorum, baseSnapshotForAttributorTree, readBlob);
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.makeVisibleAndAttachGraph}
+     */
+    makeVisibleAndAttachGraph() {
+        if (this.visibilityState !== internal_4.VisibilityState.NotVisible) {
+            return;
+        }
+        this.visibilityState = internal_4.VisibilityState.LocallyVisible;
+        this.dataStoreContext.makeLocallyVisible();
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.getAttachSummary}
+     */
+    getAttachSummary(telemetryContext) {
+        return this.runtimeAttributor.summarizeOpAttributor();
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.getAttachGCData}
+     */
+    getAttachGCData(telemetryContext) {
+        return { gcNodes: {} };
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.process}
+     */
+    process(message, local, localOpMetadata) {
+        throw new Error("Attributor should not receive messages yet");
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.processSignal}
+     */
+    processSignal(message, local) {
+        throw new Error("Attributor should not receive signals");
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.summarize}
+     */
+    async summarize(fullTree, trackState, telemetryContext) {
+        return this.runtimeAttributor.summarizeOpAttributor();
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.getGCData}
+     */
+    async getGCData(fullGC) {
+        // Nothing to be GCed from the attributor.
+        const garbageCollectionData = { gcNodes: {} };
+        return garbageCollectionData;
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.updateUsedRoutes}
+     */
+    updateUsedRoutes(usedRoutes) {
+        return;
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.setConnectionState}
+     */
+    setConnectionState(connected, clientId) {
+        (0, internal_5.raiseConnectedEvent)(this.logger, this, connected, clientId);
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.reSubmit}
+     */
+    reSubmit(type, content, localOpMetadata) {
+        // Should not resubmit anything from the attributor as the attributor does not send ops yet.
+        throw new Error("Should not resubmit anything from the attributor");
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.applyStashedOp}
+     */
+    async applyStashedOp(content) {
+        // Should not apply stashed ops to the attributor as the attributor does not send ops yet.
+        throw new Error("Should not apply stashed ops to the attributor");
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.rollback}
+     */
+    rollback(type, content, localOpMetadata) {
+        // Should not rollback anything from the attributor as it does not send ops yet.
+        throw new Error("Should not rollback anything from the attributor");
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.request}
+     */
+    async request(request) {
+        // Should not request anything from the attributor as the attributor does not have any channels further.
+        throw new Error("Should not request anything from the attributor");
+    }
+    /**
+     * {@inheritdoc IFluidDataStoreChannel.setAttachState}
+     */
+    setAttachState(attachState) {
+        switch (attachState) {
+            case internal_1.AttachState.Attaching: {
+                this.attachState = internal_1.AttachState.Attaching;
+                (0, internal_2.assert)(this.visibilityState === internal_4.VisibilityState.LocallyVisible, 0xa1e /* Data store should be locally visible before it can become globally visible. */);
+                // Mark the data store globally visible and make its child channels visible as well.
+                this.visibilityState = internal_4.VisibilityState.GloballyVisible;
+                // This promise resolution will be moved to attached event once we fix the scheduler.
+                this.deferredAttached.resolve();
+                this.emit("attaching");
+                break;
+            }
+            case internal_1.AttachState.Attached: {
+                (0, internal_2.assert)(this.visibilityState === internal_4.VisibilityState.GloballyVisible, 0xa1f /* Data store should be globally visible when its attached. */);
+                this.attachState = internal_1.AttachState.Attached;
+                this.emit("attached");
+                break;
+            }
+            default: {
+                (0, internal_2.unreachableCase)(attachState, "unreached");
+            }
+        }
+    }
+}
+exports.RuntimeAttributorDataStoreChannel = RuntimeAttributorDataStoreChannel;
+//# sourceMappingURL=runtimeAttributorDataStoreChannel.js.map

package/dist/runtimeAttributorDataStoreChannel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributorDataStoreChannel.js","sourceRoot":"","sources":["../src/runtimeAttributorDataStoreChannel.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AACjE,6EAA4F;AAG5F,kEAAwF;AACxF,iEAAuE;AAQvE,2EAQsD;AACtD,uEAKkD;AAElD,iEAA2D;AAE3D;;GAEG;AACH,MAAa,iCACZ,SAAQ,gCAA+C;IAGvD,YACiB,gBAAwC,EACxD,QAAiB;QAEjB,KAAK,EAAE,CAAC;QAHQ,qBAAgB,GAAhB,gBAAgB,CAAwB;QAiCjD,cAAS,GAAG,KAAK,CAAC;QAUnB,cAAS,GAAG,IAAI,CAAC;QAGP,qBAAgB,GAAG,IAAI,mBAAQ,EAAQ,CAAC;QA1CxD,IAAI,CAAC,iBAAiB,GAAG,IAAI,wCAAiB,EAAE,CAAC;QACjD,IAAI,CAAC,EAAE,GAAG,IAAA,uCAA4B,EAAC;YACtC,MAAM,EAAE,gBAAgB,CAAC,UAAU;YACnC,SAAS,EAAE,YAAY;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,gBAAgB,CAAC,WAAW,CAAC;QAChD,IAAI,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,eAAe;gBACnB,gBAAgB,CAAC,WAAW,KAAK,sBAAW,CAAC,QAAQ;oBACpD,CAAC,CAAC,0BAAe,CAAC,cAAc;oBAChC,CAAC,CAAC,0BAAe,CAAC,eAAe,CAAC;QACrC,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,eAAe,GAAG,0BAAe,CAAC,UAAU,CAAC;QACnD,CAAC;QACD,iDAAiD;QACjD,IAAI,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,4BAAiB,CACtC,IAAI,CAAC,iBAAiB,EACtB,EAAE,EACF,gBAAgB,CAAC,mBAAmB,CACpC,CAAC;IACH,CAAC;IAED,IAAW,sBAAsB;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAGD,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAEM,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACvB,CAAC;IAQD,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,UAAU,CACtB,YAAwE,EACxE,MAAsB,EACtB,6BAAwD,EACxD,QAAkD;QAElD,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CACtC,YAAY,EACZ,MAAM,EACN,6BAA6B,EAC7B,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;OAEG;IACI,yBAAyB;QAC/B,IAAI,IAAI,CAAC,eAAe,KAAK,0BAAe,CAAC,UAAU,EAAE,CAAC;YACzD,OAAO;QACR,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,0BAAe,CAAC,cAAc,CAAC;QAEtD,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,gBAAoC;QAC3D,OAAO,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,EAAE,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,gBAAoC;QAC1D,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,OAAO,CACb,OAAkC,EAClC,KAAc,EACd,eAAwB;QAExB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,OAA8B,EAAE,KAAc;QAClE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CACrB,QAAkB,EAClB,UAAoB,EACpB,gBAAoC;QAEpC,OAAO,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,EAAE,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,MAAgB;QACtC,0CAA0C;QAC1C,MAAM,qBAAqB,GAA2B,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QACtE,OAAO,qBAAqB,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,UAAoB;QAC3C,OAAO;IACR,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,SAAkB,EAAE,QAAiB;QAC9D,IAAA,8BAAmB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAY,EAAE,OAAgB,EAAE,eAAwB;QACvE,4FAA4F;QAC5F,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,OAAgB;QAC3C,0FAA0F;QAC1F,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACI,QAAQ,CAAE,IAAY,EAAE,OAAgB,EAAE,eAAwB;QACxE,gFAAgF;QAChF,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACrE,CAAC;IAOD;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;QACrC,wGAAwG;QACxG,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,WAAyD;QAC9E,QAAQ,WAAW,EAAE,CAAC;YACrB,KAAK,sBAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC5B,IAAI,CAAC,WAAW,GAAG,sBAAW,CAAC,SAAS,CAAC;gBAEzC,IAAA,iBAAM,EACL,IAAI,CAAC,eAAe,KAAK,0BAAe,CAAC,cAAc,EACvD,KAAK,CAAC,iFAAiF,CACvF,CAAC;gBAEF,oFAAoF;gBACpF,IAAI,CAAC,eAAe,GAAG,0BAAe,CAAC,eAAe,CAAC;gBAEvD,qFAAqF;gBACrF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACvB,MAAM;YACP,CAAC;YACD,KAAK,sBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC3B,IAAA,iBAAM,EACL,IAAI,CAAC,eAAe,KAAK,0BAAe,CAAC,eAAe,EACxD,KAAK,CAAC,8DAA8D,CACpE,CAAC;gBACF,IAAI,CAAC,WAAW,GAAG,sBAAW,CAAC,QAAQ,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACtB,MAAM;YACP,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACT,IAAA,0BAAe,EAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC3C,CAAC;QACF,CAAC;IACF,CAAC;CACD;AA7ND,8EA6NC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport { AttachState, IDeltaManager } from \"@fluidframework/container-definitions/internal\";\nimport { FluidObject, IRequest, IResponse } from \"@fluidframework/core-interfaces\";\nimport type { IFluidHandleInternal } from \"@fluidframework/core-interfaces/internal\";\nimport { assert, Deferred, unreachableCase } from \"@fluidframework/core-utils/internal\";\nimport { FluidObjectHandle } from \"@fluidframework/datastore/internal\";\nimport { IFluidDataStoreRuntimeEvents } from \"@fluidframework/datastore-definitions/internal\";\nimport {\n\tIDocumentMessage,\n\ttype ISnapshotTree,\n\tISequencedDocumentMessage,\n\tIQuorumClients,\n} from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tIGarbageCollectionData,\n\tIFluidDataStoreChannel,\n\tIFluidDataStoreContext,\n\tIInboundSignalMessage,\n\tVisibilityState,\n\ttype ISummaryTreeWithStats,\n\ttype ITelemetryContext,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\tITelemetryLoggerExt,\n\tMonitoringContext,\n\traiseConnectedEvent,\n\tcreateChildMonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport { RuntimeAttributor } from \"./runtimeAttributor.js\";\n\n/**\n * Data store channel for the runtime attributor. This channel is responsible for storing and managing the\n */\nexport class RuntimeAttributorDataStoreChannel\n\textends TypedEventEmitter<IFluidDataStoreRuntimeEvents>\n\timplements IFluidDataStoreChannel\n{\n\tpublic constructor(\n\t\tpublic readonly dataStoreContext: IFluidDataStoreContext,\n\t\texisting: boolean,\n\t) {\n\t\tsuper();\n\t\tthis.runtimeAttributor = new RuntimeAttributor();\n\t\tthis.mc = createChildMonitoringContext({\n\t\t\tlogger: dataStoreContext.baseLogger,\n\t\t\tnamespace: \"Attributor\",\n\t\t});\n\t\tthis.attachState = dataStoreContext.attachState;\n\t\tif (existing) {\n\t\t\tthis.visibilityState =\n\t\t\t\tdataStoreContext.attachState === AttachState.Detached\n\t\t\t\t\t? VisibilityState.LocallyVisible\n\t\t\t\t\t: VisibilityState.GloballyVisible;\n\t\t} else {\n\t\t\tthis.visibilityState = VisibilityState.NotVisible;\n\t\t}\n\t\t// If it's existing we know it has been attached.\n\t\tif (existing) {\n\t\t\tthis.deferredAttached.resolve();\n\t\t}\n\t\tthis.entryPoint = new FluidObjectHandle<FluidObject>(\n\t\t\tthis.runtimeAttributor,\n\t\t\t\"\",\n\t\t\tdataStoreContext.IFluidHandleContext,\n\t\t);\n\t}\n\n\tpublic get IFluidDataStoreChannel(): IFluidDataStoreChannel {\n\t\treturn this;\n\t}\n\n\tprivate _disposed = false;\n\tpublic get disposed(): boolean {\n\t\treturn this._disposed;\n\t}\n\n\tpublic dispose(): void {\n\t\tthis._disposed = true;\n\t}\n\n\tprivate readonly runtimeAttributor: RuntimeAttributor;\n\tpublic isEnabled = true;\n\tpublic attachState: AttachState;\n\tpublic visibilityState: VisibilityState;\n\tprivate readonly deferredAttached = new Deferred<void>();\n\tprivate readonly mc: MonitoringContext;\n\tpublic get logger(): ITelemetryLoggerExt {\n\t\treturn this.mc.logger;\n\t}\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\tawait this.runtimeAttributor.initialize(\n\t\t\tdeltaManager,\n\t\t\tquorum,\n\t\t\tbaseSnapshotForAttributorTree,\n\t\t\treadBlob,\n\t\t);\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.makeVisibleAndAttachGraph}\n\t */\n\tpublic makeVisibleAndAttachGraph(): void {\n\t\tif (this.visibilityState !== VisibilityState.NotVisible) {\n\t\t\treturn;\n\t\t}\n\t\tthis.visibilityState = VisibilityState.LocallyVisible;\n\n\t\tthis.dataStoreContext.makeLocallyVisible();\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.getAttachSummary}\n\t */\n\tpublic getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats {\n\t\treturn this.runtimeAttributor.summarizeOpAttributor();\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.getAttachGCData}\n\t */\n\tpublic getAttachGCData(telemetryContext?: ITelemetryContext): IGarbageCollectionData {\n\t\treturn { gcNodes: {} };\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.process}\n\t */\n\tpublic process(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t): void {\n\t\tthrow new Error(\"Attributor should not receive messages yet\");\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.processSignal}\n\t */\n\tpublic processSignal(message: IInboundSignalMessage, local: boolean): void {\n\t\tthrow new Error(\"Attributor should not receive signals\");\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.summarize}\n\t */\n\tpublic async summarize(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats> {\n\t\treturn this.runtimeAttributor.summarizeOpAttributor();\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.getGCData}\n\t */\n\tpublic async getGCData(fullGC?: boolean): Promise<IGarbageCollectionData> {\n\t\t// Nothing to be GCed from the attributor.\n\t\tconst garbageCollectionData: IGarbageCollectionData = { gcNodes: {} };\n\t\treturn garbageCollectionData;\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.updateUsedRoutes}\n\t */\n\tpublic updateUsedRoutes(usedRoutes: string[]): void {\n\t\treturn;\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.setConnectionState}\n\t */\n\tpublic setConnectionState(connected: boolean, clientId?: string): void {\n\t\traiseConnectedEvent(this.logger, this, connected, clientId);\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.reSubmit}\n\t */\n\tpublic reSubmit(type: string, content: unknown, localOpMetadata: unknown): void {\n\t\t// Should not resubmit anything from the attributor as the attributor does not send ops yet.\n\t\tthrow new Error(\"Should not resubmit anything from the attributor\");\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.applyStashedOp}\n\t */\n\tpublic async applyStashedOp(content: unknown): Promise<unknown> {\n\t\t// Should not apply stashed ops to the attributor as the attributor does not send ops yet.\n\t\tthrow new Error(\"Should not apply stashed ops to the attributor\");\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.rollback}\n\t */\n\tpublic rollback?(type: string, content: unknown, localOpMetadata: unknown): void {\n\t\t// Should not rollback anything from the attributor as it does not send ops yet.\n\t\tthrow new Error(\"Should not rollback anything from the attributor\");\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.entryPoint}\n\t */\n\tpublic readonly entryPoint: IFluidHandleInternal<FluidObject>;\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.request}\n\t */\n\tpublic async request(request: IRequest): Promise<IResponse> {\n\t\t// Should not request anything from the attributor as the attributor does not have any channels further.\n\t\tthrow new Error(\"Should not request anything from the attributor\");\n\t}\n\n\t/**\n\t * {@inheritdoc IFluidDataStoreChannel.setAttachState}\n\t */\n\tpublic setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void {\n\t\tswitch (attachState) {\n\t\t\tcase AttachState.Attaching: {\n\t\t\t\tthis.attachState = AttachState.Attaching;\n\n\t\t\t\tassert(\n\t\t\t\t\tthis.visibilityState === VisibilityState.LocallyVisible,\n\t\t\t\t\t0xa1e /* Data store should be locally visible before it can become globally visible. */,\n\t\t\t\t);\n\n\t\t\t\t// Mark the data store globally visible and make its child channels visible as well.\n\t\t\t\tthis.visibilityState = VisibilityState.GloballyVisible;\n\n\t\t\t\t// This promise resolution will be moved to attached event once we fix the scheduler.\n\t\t\t\tthis.deferredAttached.resolve();\n\t\t\t\tthis.emit(\"attaching\");\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase AttachState.Attached: {\n\t\t\t\tassert(\n\t\t\t\t\tthis.visibilityState === VisibilityState.GloballyVisible,\n\t\t\t\t\t0xa1f /* Data store should be globally visible when its attached. */,\n\t\t\t\t);\n\t\t\t\tthis.attachState = AttachState.Attached;\n\t\t\t\tthis.emit(\"attached\");\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tunreachableCase(attachState, \"unreached\");\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/runtimeAttributorDataStoreFactory.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IFluidDataStoreFactory, IFluidDataStoreChannel, IFluidDataStoreContext } from "@fluidframework/runtime-definitions/internal";
+/**
+ * Factory for the runtime attributor data store channel.
+ */
+export declare class RuntimeAttributorFactory implements IFluidDataStoreFactory {
+    static readonly type = "@fluid-experimental/attributor";
+    get type(): string;
+    get IFluidDataStoreFactory(): IFluidDataStoreFactory;
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
+}
+//# sourceMappingURL=runtimeAttributorDataStoreFactory.d.ts.map

package/dist/runtimeAttributorDataStoreFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributorDataStoreFactory.d.ts","sourceRoot":"","sources":["../src/runtimeAttributorDataStoreFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,8CAA8C,CAAC;AAKtD;;GAEG;AACH,qBAAa,wBAAyB,YAAW,sBAAsB;IACtE,gBAAuB,IAAI,oCAAoC;IAE/D,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,sBAAsB,IAAI,sBAAsB,CAE1D;IAEY,oBAAoB,CAChC,OAAO,EAAE,sBAAsB,EAC/B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,sBAAsB,CAAC;CA2BlC"}

package/dist/runtimeAttributorDataStoreFactory.js

@@ -0,0 +1,39 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeAttributorFactory = void 0;
+const internal_1 = require("@fluidframework/telemetry-utils/internal");
+const runtimeAttributorDataStoreChannel_js_1 = require("./runtimeAttributorDataStoreChannel.js");
+/**
+ * Factory for the runtime attributor data store channel.
+ */
+class RuntimeAttributorFactory {
+    get type() {
+        return RuntimeAttributorFactory.type;
+    }
+    get IFluidDataStoreFactory() {
+        return this;
+    }
+    async instantiateDataStore(context, existing) {
+        const runtime = new runtimeAttributorDataStoreChannel_js_1.RuntimeAttributorDataStoreChannel(context, existing);
+        const logger = (0, internal_1.createChildLogger)({
+            logger: context.baseLogger,
+            namespace: "Attributor",
+        });
+        await internal_1.PerformanceEvent.timedExecAsync(logger, {
+            eventName: "initialize",
+        }, async (event) => {
+            await runtime.initialize(context.deltaManager, context.getQuorum(), context.baseSnapshot, async (id) => context.storage.readBlob(id));
+            event.end({
+                attributionEnabledInDoc: true, // If we are instantiating the attributor, it is enabled
+            });
+        });
+        return runtime;
+    }
+}
+exports.RuntimeAttributorFactory = RuntimeAttributorFactory;
+RuntimeAttributorFactory.type = "@fluid-experimental/attributor";
+//# sourceMappingURL=runtimeAttributorDataStoreFactory.js.map

package/dist/runtimeAttributorDataStoreFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributorDataStoreFactory.js","sourceRoot":"","sources":["../src/runtimeAttributorDataStoreFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,uEAA+F;AAE/F,iGAA2F;AAE3F;;GAEG;AACH,MAAa,wBAAwB;IAGpC,IAAW,IAAI;QACd,OAAO,wBAAwB,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,IAAW,sBAAsB;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAChC,OAA+B,EAC/B,QAAiB;QAEjB,MAAM,OAAO,GAAG,IAAI,wEAAiC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEzE,MAAM,MAAM,GAAG,IAAA,4BAAiB,EAAC;YAChC,MAAM,EAAE,OAAO,CAAC,UAAU;YAC1B,SAAS,EAAE,YAAY;SACvB,CAAC,CAAC;QAEH,MAAM,2BAAgB,CAAC,cAAc,CACpC,MAAM,EACN;YACC,SAAS,EAAE,YAAY;SACvB,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACf,MAAM,OAAO,CAAC,UAAU,CACvB,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,SAAS,EAAE,EACnB,OAAO,CAAC,YAAY,EACpB,KAAK,EAAE,EAAU,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAClD,CAAC;YACF,KAAK,CAAC,GAAG,CAAC;gBACT,uBAAuB,EAAE,IAAI,EAAE,wDAAwD;aACvF,CAAC,CAAC;QACJ,CAAC,CACD,CAAC;QACF,OAAO,OAAO,CAAC;IAChB,CAAC;;AAxCF,4DAyCC;AAxCuB,6BAAI,GAAG,gCAAgC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIFluidDataStoreFactory,\n\tIFluidDataStoreChannel,\n\tIFluidDataStoreContext,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport { PerformanceEvent, createChildLogger } from \"@fluidframework/telemetry-utils/internal\";\n\nimport { RuntimeAttributorDataStoreChannel } from \"./runtimeAttributorDataStoreChannel.js\";\n\n/**\n * Factory for the runtime attributor data store channel.\n */\nexport class RuntimeAttributorFactory implements IFluidDataStoreFactory {\n\tpublic static readonly type = \"@fluid-experimental/attributor\";\n\n\tpublic get type(): string {\n\t\treturn RuntimeAttributorFactory.type;\n\t}\n\n\tpublic get IFluidDataStoreFactory(): IFluidDataStoreFactory {\n\t\treturn this;\n\t}\n\n\tpublic async instantiateDataStore(\n\t\tcontext: IFluidDataStoreContext,\n\t\texisting: boolean,\n\t): Promise<IFluidDataStoreChannel> {\n\t\tconst runtime = new RuntimeAttributorDataStoreChannel(context, existing);\n\n\t\tconst logger = createChildLogger({\n\t\t\tlogger: context.baseLogger,\n\t\t\tnamespace: \"Attributor\",\n\t\t});\n\n\t\tawait PerformanceEvent.timedExecAsync(\n\t\t\tlogger,\n\t\t\t{\n\t\t\t\teventName: \"initialize\",\n\t\t\t},\n\t\t\tasync (event) => {\n\t\t\t\tawait runtime.initialize(\n\t\t\t\t\tcontext.deltaManager,\n\t\t\t\t\tcontext.getQuorum(),\n\t\t\t\t\tcontext.baseSnapshot,\n\t\t\t\t\tasync (id: string) => context.storage.readBlob(id),\n\t\t\t\t);\n\t\t\t\tevent.end({\n\t\t\t\t\tattributionEnabledInDoc: true, // If we are instantiating the attributor, it is enabled\n\t\t\t\t});\n\t\t\t},\n\t\t);\n\t\treturn runtime;\n\t}\n}\n"]}

package/lib/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/lib/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/lib/attributorContracts.js

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+// Summary tree keys
+export const opBlobName = "opAttributor";
+/**
+ * @internal
+ */
+export const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+/**
+ * @internal
+ */
+export const IRuntimeAttributor = "IRuntimeAttributor";
+/**
+ * @internal
+ */
+export const attributorDataStoreAlias = "attributor-cf9b6fe4-4c50-4a5d-9045-eb73b886f740";
+//# sourceMappingURL=attributorContracts.js.map

package/lib/attributorContracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributorContracts.js","sourceRoot":"","sources":["../src/attributorContracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,oBAAoB;AACpB,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,CAAC;AAEzC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,mCAAmC,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAoC,oBAAoB,CAAC;AASxF;;GAEG;AACH,MAAM,CAAC,MAAM,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/lib/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/lib/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/lib/index.js

@@ -2,5 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { createRuntimeAttributor, enableOnNewFileKey, IRuntimeAttributor, mixinAttributor, } from "./mixinAttributor.js";
+export { mixinAttributor, getRuntimeAttributor } from "./mixinAttributor.js";
+export { attributorDataStoreAlias, enableOnNewFileKey, IRuntimeAttributor, } from "./attributorContracts.js";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,uBAAuB,EACvB,kBAAkB,EAElB,kBAAkB,EAClB,eAAe,GACf,MAAM,sBAAsB,CAAC","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,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EACN,wBAAwB,EACxB,kBAAkB,EAElB,kBAAkB,GAClB,MAAM,0BAA0B,CAAC","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/lib/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/lib/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"}