Convert attributor to IFluidDataStoreChannel

examples/apps/attributable-map/src/modelContainerRuntimeFactoryWithAttribution.ts

@@ -4,7 +4,7 @@
  */
 
 import { IModelContainerRuntimeEntryPoint } from "@fluid-example/example-utils";
-import { createRuntimeAttributor, mixinAttributor } from "@fluid-experimental/attributor";
+import { mixinAttributor } from "@fluid-experimental/attributor";
 import {
 	IContainer,
 	IContainerContext,
@@ -54,7 +54,6 @@ export abstract class ModelContainerRuntimeFactoryWithAttribution<ModelType>
 					this.createModel(containerRuntime, container),
 			}),
 			runtimeOptions: this.runtimeOptions,
-			containerScope: { IRuntimeAttributor: createRuntimeAttributor() },
 			existing,
 		});
 

packages/framework/attributor/package.json

@@ -89,6 +89,7 @@
 		"@fluidframework/container-runtime-definitions": "workspace:~",
 		"@fluidframework/core-interfaces": "workspace:~",
 		"@fluidframework/core-utils": "workspace:~",
+		"@fluidframework/datastore": "workspace:~",
 		"@fluidframework/datastore-definitions": "workspace:~",
 		"@fluidframework/driver-definitions": "workspace:~",
 		"@fluidframework/runtime-definitions": "workspace:~",

packages/framework/attributor/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;
+}

packages/framework/attributor/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";