@fluid-experimental/attributor 2.1.0 → 2.3.0-288113

package/lib/runtimeAttributorDataStoreChannel.js

@@ -0,0 +1,173 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { AttachState } from "@fluidframework/container-definitions/internal";
+import { assert, Deferred, unreachableCase } from "@fluidframework/core-utils/internal";
+import { FluidObjectHandle } from "@fluidframework/datastore/internal";
+import { VisibilityState, } from "@fluidframework/runtime-definitions/internal";
+import { raiseConnectedEvent, createChildMonitoringContext, } from "@fluidframework/telemetry-utils/internal";
+import { RuntimeAttributor } from "./runtimeAttributor.js";
+/**
+ * Data store channel for the runtime attributor. This channel is responsible for storing and managing the
+ */
+export class RuntimeAttributorDataStoreChannel extends TypedEventEmitter {
+    constructor(dataStoreContext, existing) {
+        super();
+        this.dataStoreContext = dataStoreContext;
+        this._disposed = false;
+        this.isEnabled = true;
+        this.deferredAttached = new Deferred();
+        this.runtimeAttributor = new RuntimeAttributor();
+        this.mc = createChildMonitoringContext({
+            logger: dataStoreContext.baseLogger,
+            namespace: "Attributor",
+        });
+        this.attachState = dataStoreContext.attachState;
+        if (existing) {
+            this.visibilityState =
+                dataStoreContext.attachState === AttachState.Detached
+                    ? VisibilityState.LocallyVisible
+                    : VisibilityState.GloballyVisible;
+        }
+        else {
+            this.visibilityState = VisibilityState.NotVisible;
+        }
+        // If it's existing we know it has been attached.
+        if (existing) {
+            this.deferredAttached.resolve();
+        }
+        this.entryPoint = new 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 !== VisibilityState.NotVisible) {
+            return;
+        }
+        this.visibilityState = 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) {
+        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 AttachState.Attaching: {
+                this.attachState = AttachState.Attaching;
+                assert(this.visibilityState === 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 = VisibilityState.GloballyVisible;
+                // This promise resolution will be moved to attached event once we fix the scheduler.
+                this.deferredAttached.resolve();
+                this.emit("attaching");
+                break;
+            }
+            case AttachState.Attached: {
+                assert(this.visibilityState === VisibilityState.GloballyVisible, 0xa1f /* Data store should be globally visible when its attached. */);
+                this.attachState = AttachState.Attached;
+                this.emit("attached");
+                break;
+            }
+            default: {
+                unreachableCase(attachState, "unreached");
+            }
+        }
+    }
+}
+//# sourceMappingURL=runtimeAttributorDataStoreChannel.js.map

package/lib/runtimeAttributorDataStoreChannel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributorDataStoreChannel.js","sourceRoot":"","sources":["../src/runtimeAttributorDataStoreChannel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,WAAW,EAAiB,MAAM,gDAAgD,CAAC;AAG5F,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAQvE,OAAO,EAKN,eAAe,GAGf,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAGN,mBAAmB,EACnB,4BAA4B,GAC5B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D;;GAEG;AACH,MAAM,OAAO,iCACZ,SAAQ,iBAA+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,QAAQ,EAAQ,CAAC;QA1CxD,IAAI,CAAC,iBAAiB,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACjD,IAAI,CAAC,EAAE,GAAG,4BAA4B,CAAC;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,WAAW,CAAC,QAAQ;oBACpD,CAAC,CAAC,eAAe,CAAC,cAAc;oBAChC,CAAC,CAAC,eAAe,CAAC,eAAe,CAAC;QACrC,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,eAAe,GAAG,eAAe,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,iBAAiB,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,eAAe,CAAC,UAAU,EAAE,CAAC;YACzD,OAAO;QACR,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,eAAe,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,mBAAmB,CAAC,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,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC5B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC;gBAEzC,MAAM,CACL,IAAI,CAAC,eAAe,KAAK,eAAe,CAAC,cAAc,EACvD,KAAK,CAAC,iFAAiF,CACvF,CAAC;gBAEF,oFAAoF;gBACpF,IAAI,CAAC,eAAe,GAAG,eAAe,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,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC3B,MAAM,CACL,IAAI,CAAC,eAAe,KAAK,eAAe,CAAC,eAAe,EACxD,KAAK,CAAC,8DAA8D,CACpE,CAAC;gBACF,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACtB,MAAM;YACP,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACT,eAAe,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC3C,CAAC;QACF,CAAC;IACF,CAAC;CACD","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/lib/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/lib/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/lib/runtimeAttributorDataStoreFactory.js

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { PerformanceEvent, createChildLogger } from "@fluidframework/telemetry-utils/internal";
+import { RuntimeAttributorDataStoreChannel } from "./runtimeAttributorDataStoreChannel.js";
+/**
+ * Factory for the runtime attributor data store channel.
+ */
+export class RuntimeAttributorFactory {
+    get type() {
+        return RuntimeAttributorFactory.type;
+    }
+    get IFluidDataStoreFactory() {
+        return this;
+    }
+    async instantiateDataStore(context, existing) {
+        const runtime = new RuntimeAttributorDataStoreChannel(context, existing);
+        const logger = createChildLogger({
+            logger: context.baseLogger,
+            namespace: "Attributor",
+        });
+        await 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;
+    }
+}
+RuntimeAttributorFactory.type = "@fluid-experimental/attributor";
+//# sourceMappingURL=runtimeAttributorDataStoreFactory.js.map

package/lib/runtimeAttributorDataStoreFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeAttributorDataStoreFactory.js","sourceRoot":"","sources":["../src/runtimeAttributorDataStoreFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAE/F,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAE3F;;GAEG;AACH,MAAM,OAAO,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,iCAAiC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEzE,MAAM,MAAM,GAAG,iBAAiB,CAAC;YAChC,MAAM,EAAE,OAAO,CAAC,UAAU;YAC1B,SAAS,EAAE,YAAY;SACvB,CAAC,CAAC;QAEH,MAAM,gBAAgB,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;;AAvCsB,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/attributor",
-  "version": "2.1.0",
+  "version": "2.3.0-288113",
   "description": "Operation attributor",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -47,31 +47,32 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.1.0",
-    "@fluidframework/container-definitions": "~2.1.0",
-    "@fluidframework/container-runtime": "~2.1.0",
-    "@fluidframework/container-runtime-definitions": "~2.1.0",
-    "@fluidframework/core-interfaces": "~2.1.0",
-    "@fluidframework/core-utils": "~2.1.0",
-    "@fluidframework/datastore-definitions": "~2.1.0",
-    "@fluidframework/driver-definitions": "~2.1.0",
-    "@fluidframework/runtime-definitions": "~2.1.0",
-    "@fluidframework/runtime-utils": "~2.1.0",
-    "@fluidframework/telemetry-utils": "~2.1.0",
+    "@fluid-internal/client-utils": "2.3.0-288113",
+    "@fluidframework/container-definitions": "2.3.0-288113",
+    "@fluidframework/container-runtime": "2.3.0-288113",
+    "@fluidframework/container-runtime-definitions": "2.3.0-288113",
+    "@fluidframework/core-interfaces": "2.3.0-288113",
+    "@fluidframework/core-utils": "2.3.0-288113",
+    "@fluidframework/datastore": "2.3.0-288113",
+    "@fluidframework/datastore-definitions": "2.3.0-288113",
+    "@fluidframework/driver-definitions": "2.3.0-288113",
+    "@fluidframework/runtime-definitions": "2.3.0-288113",
+    "@fluidframework/runtime-utils": "2.3.0-288113",
+    "@fluidframework/telemetry-utils": "2.3.0-288113",
     "lz4js": "^0.2.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "~1.8.3",
-    "@fluid-internal/mocha-test-setup": "~2.1.0",
-    "@fluid-private/stochastic-test-utils": "~2.1.0",
-    "@fluid-tools/build-cli": "^0.41.0",
+    "@fluid-internal/mocha-test-setup": "2.3.0-288113",
+    "@fluid-private/stochastic-test-utils": "2.3.0-288113",
+    "@fluid-tools/build-cli": "^0.43.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.41.0",
+    "@fluidframework/build-tools": "^0.43.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/merge-tree": "~2.1.0",
-    "@fluidframework/sequence": "~2.1.0",
-    "@fluidframework/test-runtime-utils": "~2.1.0",
+    "@fluidframework/merge-tree": "2.3.0-288113",
+    "@fluidframework/sequence": "2.3.0-288113",
+    "@fluidframework/test-runtime-utils": "2.3.0-288113",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",

package/src/attributorContracts.ts

@@ -0,0 +1,61 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {
+	type AttributionInfo,
+	type AttributionKey,
+} from "@fluidframework/runtime-definitions/internal";
+
+// Summary tree keys
+export const opBlobName = "opAttributor";
+
+/**
+ * @internal
+ */
+export const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+
+/**
+ * @internal
+ */
+export const IRuntimeAttributor: keyof IProvideRuntimeAttributor = "IRuntimeAttributor";
+
+/**
+ * @internal
+ */
+export interface IProvideRuntimeAttributor {
+	readonly IRuntimeAttributor: IRuntimeAttributor;
+}
+
+/**
+ * @internal
+ */
+export 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;
+}

package/src/index.ts

@@ -4,10 +4,10 @@
  */
 
 export { type IAttributor } from "./attributor.js";
+export { mixinAttributor, getRuntimeAttributor } from "./mixinAttributor.js";
 export {
-	createRuntimeAttributor,
+	attributorDataStoreAlias,
 	enableOnNewFileKey,
 	type IProvideRuntimeAttributor,
 	IRuntimeAttributor,
-	mixinAttributor,
-} from "./mixinAttributor.js";
+} from "./attributorContracts.js";