@fluid-experimental/attributor 2.1.0-281041 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +89 -2
  3. package/dist/attributorContracts.d.ts +49 -0
  4. package/dist/attributorContracts.d.ts.map +1 -0
  5. package/dist/attributorContracts.js +22 -0
  6. package/dist/attributorContracts.js.map +1 -0
  7. package/dist/index.d.ts +2 -1
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +6 -4
  10. package/dist/index.js.map +1 -1
  11. package/dist/mixinAttributor.d.ts +8 -49
  12. package/dist/mixinAttributor.d.ts.map +1 -1
  13. package/dist/mixinAttributor.js +35 -140
  14. package/dist/mixinAttributor.js.map +1 -1
  15. package/dist/runtimeAttributor.d.ts +19 -0
  16. package/dist/runtimeAttributor.d.ts.map +1 -0
  17. package/dist/runtimeAttributor.js +71 -0
  18. package/dist/runtimeAttributor.js.map +1 -0
  19. package/dist/runtimeAttributorDataStoreChannel.d.ts +92 -0
  20. package/dist/runtimeAttributorDataStoreChannel.d.ts.map +1 -0
  21. package/dist/runtimeAttributorDataStoreChannel.js +177 -0
  22. package/dist/runtimeAttributorDataStoreChannel.js.map +1 -0
  23. package/dist/runtimeAttributorDataStoreFactory.d.ts +15 -0
  24. package/dist/runtimeAttributorDataStoreFactory.d.ts.map +1 -0
  25. package/dist/runtimeAttributorDataStoreFactory.js +39 -0
  26. package/dist/runtimeAttributorDataStoreFactory.js.map +1 -0
  27. package/lib/attributorContracts.d.ts +49 -0
  28. package/lib/attributorContracts.d.ts.map +1 -0
  29. package/lib/attributorContracts.js +19 -0
  30. package/lib/attributorContracts.js.map +1 -0
  31. package/lib/index.d.ts +2 -1
  32. package/lib/index.d.ts.map +1 -1
  33. package/lib/index.js +2 -1
  34. package/lib/index.js.map +1 -1
  35. package/lib/mixinAttributor.d.ts +8 -49
  36. package/lib/mixinAttributor.d.ts.map +1 -1
  37. package/lib/mixinAttributor.js +33 -138
  38. package/lib/mixinAttributor.js.map +1 -1
  39. package/lib/runtimeAttributor.d.ts +19 -0
  40. package/lib/runtimeAttributor.d.ts.map +1 -0
  41. package/lib/runtimeAttributor.js +67 -0
  42. package/lib/runtimeAttributor.js.map +1 -0
  43. package/lib/runtimeAttributorDataStoreChannel.d.ts +92 -0
  44. package/lib/runtimeAttributorDataStoreChannel.d.ts.map +1 -0
  45. package/lib/runtimeAttributorDataStoreChannel.js +173 -0
  46. package/lib/runtimeAttributorDataStoreChannel.js.map +1 -0
  47. package/lib/runtimeAttributorDataStoreFactory.d.ts +15 -0
  48. package/lib/runtimeAttributorDataStoreFactory.d.ts.map +1 -0
  49. package/lib/runtimeAttributorDataStoreFactory.js +35 -0
  50. package/lib/runtimeAttributorDataStoreFactory.js.map +1 -0
  51. package/package.json +20 -19
  52. package/src/attributorContracts.ts +61 -0
  53. package/src/index.ts +3 -3
  54. package/src/mixinAttributor.ts +45 -267
  55. package/src/runtimeAttributor.ts +111 -0
  56. package/src/runtimeAttributorDataStoreChannel.ts +261 -0
  57. package/src/runtimeAttributorDataStoreFactory.ts +59 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @fluid-experimental/attributor
2
2
 
3
+ ## 2.2.0
4
+
5
+ Dependency updates only.
6
+
7
+ ## 2.1.0
8
+
9
+ Dependency updates only.
10
+
3
11
  ## 2.0.0-rc.5.0.0
4
12
 
5
13
  ### Minor Changes
package/README.md CHANGED
@@ -2,11 +2,16 @@
2
2
 
3
3
  This package contains definitions and implementations for framework-provided attribution functionality.
4
4
 
5
- <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
5
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER) -->
6
6
 
7
7
  <!-- prettier-ignore-start -->
8
8
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
9
9
 
10
+ **IMPORTANT: This package is experimental.**
11
+ **Its APIs may change without notice.**
12
+
13
+ **Do not use in production scenarios.**
14
+
10
15
  ## Using Fluid Framework libraries
11
16
 
12
17
  When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
@@ -15,6 +20,18 @@ library consumers should always prefer `^`.
15
20
 
16
21
  If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
17
22
 
23
+ ## Installation
24
+
25
+ To get started, install the package by running the following command:
26
+
27
+ ```bash
28
+ npm i @fluid-experimental/attributor
29
+ ```
30
+
31
+ ## API Documentation
32
+
33
+ API documentation for **@fluid-experimental/attributor** is available at <https://fluidframework.com/docs/apis/attributor>.
34
+
18
35
  <!-- prettier-ignore-end -->
19
36
 
20
37
  <!-- AUTO-GENERATED-CONTENT:END -->
@@ -122,11 +139,81 @@ The behavior of `"Fluid.Attribution.WriteOnNewFile"` supports the standard strat
122
139
  "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.
123
140
  During the "waiting to saturate" period, developers are free to experiment with turning the feature flag on locally and testing various compatability scenarios.
124
141
 
125
- <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
142
+ <!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
126
143
 
127
144
  <!-- prettier-ignore-start -->
128
145
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
129
146
 
147
+ ## Minimum Client Requirements
148
+
149
+ These are the platform requirements for the current version of Fluid Framework Client Packages.
150
+ These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter.
151
+ For Long Term Support (LTS) versions this can require supporting these platforms for several years.
152
+
153
+ It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug.
154
+ If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request.
155
+ When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working.
156
+
157
+ ### Supported Runtimes
158
+
159
+ - NodeJs ^20.10.0 except that we will drop support for it [when NodeJs 20 loses its upstream support on 2026-04-30](https://github.com/nodejs/release#release-schedule), and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30).
160
+ - Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards).
161
+
162
+ ### Supported Tools
163
+
164
+ - TypeScript 5.4:
165
+ - All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported.
166
+ - [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required.
167
+ - [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported.
168
+ - `exactOptionalPropertyTypes` is currently not fully supported.
169
+ If used, narrowing members of Fluid Framework types types using `in`, `Reflect.has`, `Object.hasOwn` or `Object.prototype.hasOwnProperty` should be avoided as they may incorrectly exclude `undefined` from the possible values in some cases.
170
+ - [webpack](https://webpack.js.org/) 5
171
+ - We are not intending to be prescriptive about what bundler to use.
172
+ Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.
173
+
174
+ ### Module Resolution
175
+
176
+ [`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) resolution should be used with TypeScript compilerOptions to follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
177
+ Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.
178
+
179
+ ### Module Formats
180
+
181
+ - ES Modules:
182
+ ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported.
183
+ - CommonJs:
184
+ Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below.
185
+ This is done to accommodate some workflows without good ES Module support.
186
+ If you have a workflow you would like included in this list, file an issue.
187
+ Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.
188
+
189
+ - Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648))
190
+
191
+ ## Contribution Guidelines
192
+
193
+ There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
194
+
195
+ - Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
196
+ - [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
197
+ - Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
198
+ - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
199
+
200
+ Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
201
+
202
+ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
203
+ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
204
+
205
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
206
+ Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
207
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
208
+
209
+ ## Help
210
+
211
+ Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
212
+
213
+ Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
214
+
215
+ Thank you!
216
+
130
217
  ## Trademark
131
218
 
132
219
  This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
@@ -0,0 +1,49 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+ import { type AttributionInfo, type AttributionKey } from "@fluidframework/runtime-definitions/internal";
6
+ export declare const opBlobName = "opAttributor";
7
+ /**
8
+ * @internal
9
+ */
10
+ export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
11
+ /**
12
+ * @internal
13
+ */
14
+ export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
15
+ /**
16
+ * @internal
17
+ */
18
+ export interface IProvideRuntimeAttributor {
19
+ readonly IRuntimeAttributor: IRuntimeAttributor;
20
+ }
21
+ /**
22
+ * @internal
23
+ */
24
+ export declare const attributorDataStoreAlias = "attributor-cf9b6fe4-4c50-4a5d-9045-eb73b886f740";
25
+ /**
26
+ * Provides access to attribution information stored on the container runtime.
27
+ *
28
+ * @remarks Attributors are only populated after the container runtime into which they are being injected has initialized.
29
+ *
30
+ * @sealed
31
+ * @internal
32
+ */
33
+ export interface IRuntimeAttributor extends IProvideRuntimeAttributor {
34
+ /**
35
+ * @throws - If no AttributionInfo exists for this key.
36
+ */
37
+ get(key: AttributionKey): AttributionInfo;
38
+ /**
39
+ * @returns Whether any AttributionInfo exists for the provided key.
40
+ */
41
+ has(key: AttributionKey): boolean;
42
+ /**
43
+ * @returns Whether the runtime is currently tracking attribution information for the loaded container.
44
+ * If enabled, the runtime attributor can be asked for the attribution info for different keys.
45
+ * See {@link mixinAttributor} for more details on when this happens.
46
+ */
47
+ readonly isEnabled: boolean;
48
+ }
49
+ //# sourceMappingURL=attributorContracts.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ /*!
3
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
+ * Licensed under the MIT License.
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.attributorDataStoreAlias = exports.IRuntimeAttributor = exports.enableOnNewFileKey = exports.opBlobName = void 0;
8
+ // Summary tree keys
9
+ exports.opBlobName = "opAttributor";
10
+ /**
11
+ * @internal
12
+ */
13
+ exports.enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
14
+ /**
15
+ * @internal
16
+ */
17
+ exports.IRuntimeAttributor = "IRuntimeAttributor";
18
+ /**
19
+ * @internal
20
+ */
21
+ exports.attributorDataStoreAlias = "attributor-cf9b6fe4-4c50-4a5d-9045-eb73b886f740";
22
+ //# sourceMappingURL=attributorContracts.js.map
@@ -0,0 +1 @@
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 CHANGED
@@ -3,5 +3,6 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  export { type IAttributor } from "./attributor.js";
6
- export { createRuntimeAttributor, enableOnNewFileKey, type IProvideRuntimeAttributor, IRuntimeAttributor, mixinAttributor, } from "./mixinAttributor.js";
6
+ export { mixinAttributor, getRuntimeAttributor } from "./mixinAttributor.js";
7
+ export { attributorDataStoreAlias, enableOnNewFileKey, type IProvideRuntimeAttributor, IRuntimeAttributor, } from "./attributorContracts.js";
7
8
  //# sourceMappingURL=index.d.ts.map
@@ -1 +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"}
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,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 CHANGED
@@ -4,10 +4,12 @@
4
4
  * Licensed under the MIT License.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.mixinAttributor = exports.IRuntimeAttributor = exports.enableOnNewFileKey = exports.createRuntimeAttributor = void 0;
7
+ exports.IRuntimeAttributor = exports.enableOnNewFileKey = exports.attributorDataStoreAlias = exports.getRuntimeAttributor = exports.mixinAttributor = void 0;
8
8
  var mixinAttributor_js_1 = require("./mixinAttributor.js");
9
- Object.defineProperty(exports, "createRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.createRuntimeAttributor; } });
10
- Object.defineProperty(exports, "enableOnNewFileKey", { enumerable: true, get: function () { return mixinAttributor_js_1.enableOnNewFileKey; } });
11
- Object.defineProperty(exports, "IRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.IRuntimeAttributor; } });
12
9
  Object.defineProperty(exports, "mixinAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.mixinAttributor; } });
10
+ Object.defineProperty(exports, "getRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_js_1.getRuntimeAttributor; } });
11
+ var attributorContracts_js_1 = require("./attributorContracts.js");
12
+ Object.defineProperty(exports, "attributorDataStoreAlias", { enumerable: true, get: function () { return attributorContracts_js_1.attributorDataStoreAlias; } });
13
+ Object.defineProperty(exports, "enableOnNewFileKey", { enumerable: true, get: function () { return attributorContracts_js_1.enableOnNewFileKey; } });
14
+ Object.defineProperty(exports, "IRuntimeAttributor", { enumerable: true, get: function () { return attributorContracts_js_1.IRuntimeAttributor; } });
13
15
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +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"]}
1
+ {"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"]}
@@ -3,61 +3,20 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  import { ContainerRuntime } from "@fluidframework/container-runtime/internal";
6
- import { type AttributionInfo, type AttributionKey } from "@fluidframework/runtime-definitions/internal";
6
+ import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
7
+ import { type IRuntimeAttributor } from "./attributorContracts.js";
7
8
  /**
9
+ * Utility function to get the runtime attributor from the container runtime.
10
+ * @param runtime - container runtime from which attributor is to be fetched.
11
+ * @returns IRuntimeAttributor if it exists, otherwise undefined.
8
12
  * @internal
9
13
  */
10
- export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
11
- /**
12
- * @internal
13
- */
14
- export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
15
- /**
16
- * @internal
17
- */
18
- export interface IProvideRuntimeAttributor {
19
- readonly IRuntimeAttributor: IRuntimeAttributor;
20
- }
21
- /**
22
- * Provides access to attribution information stored on the container runtime.
23
- *
24
- * @remarks Attributors are only populated after the container runtime into which they are being injected has initialized.
25
- *
26
- * @sealed
27
- * @internal
28
- */
29
- export interface IRuntimeAttributor extends IProvideRuntimeAttributor {
30
- /**
31
- * @throws - If no AttributionInfo exists for this key.
32
- */
33
- get(key: AttributionKey): AttributionInfo;
34
- /**
35
- * @returns Whether any AttributionInfo exists for the provided key.
36
- */
37
- has(key: AttributionKey): boolean;
38
- /**
39
- * @returns Whether the runtime is currently tracking attribution information for the loaded container.
40
- * If enabled, the runtime attributor can be asked for the attribution info for different keys.
41
- * See {@link mixinAttributor} for more details on when this happens.
42
- */
43
- readonly isEnabled: boolean;
44
- }
45
- /**
46
- * Creates an `IRuntimeAttributor` for usage with {@link mixinAttributor}.
47
- *
48
- * @remarks The attributor will only be populated with data once it's passed via scope to a container runtime load flow.
49
- *
50
- * @internal
51
- */
52
- export declare function createRuntimeAttributor(): IRuntimeAttributor;
14
+ export declare function getRuntimeAttributor(runtime: IContainerRuntime): Promise<IRuntimeAttributor | undefined>;
53
15
  /**
54
16
  * Mixes in logic to load and store runtime-based attribution functionality.
55
17
  *
56
- * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.
57
- *
58
- * Existing documents without stored attributors will not start storing attribution information: if an
59
- * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,
60
- * that attributor's `has` method will always return `false`.
18
+ * Existing documents without stored attributor will not start storing attribution information. We only create the attributor
19
+ * if its tracking is enabled and we are creating a new document.
61
20
  * @param Base - base class, inherits from FluidAttributorRuntime
62
21
  * @internal
63
22
  */
@@ -1 +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"}
1
+ {"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"}
@@ -4,61 +4,42 @@
4
4
  * Licensed under the MIT License.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.mixinAttributor = exports.createRuntimeAttributor = exports.IRuntimeAttributor = exports.enableOnNewFileKey = void 0;
8
- const client_utils_1 = require("@fluid-internal/client-utils");
7
+ exports.mixinAttributor = exports.getRuntimeAttributor = void 0;
9
8
  const internal_1 = require("@fluidframework/container-runtime/internal");
10
9
  const internal_2 = require("@fluidframework/core-utils/internal");
11
- const internal_3 = require("@fluidframework/runtime-utils/internal");
12
- const internal_4 = require("@fluidframework/telemetry-utils/internal");
13
- const attributor_js_1 = require("./attributor.js");
14
- const encoders_js_1 = require("./encoders.js");
15
- const lz4Encoder_js_1 = require("./lz4Encoder.js");
16
- // Summary tree keys
17
- const attributorTreeName = ".attributor";
18
- const opBlobName = "op";
10
+ const internal_3 = require("@fluidframework/telemetry-utils/internal");
11
+ const attributorContracts_js_1 = require("./attributorContracts.js");
12
+ const runtimeAttributorDataStoreFactory_js_1 = require("./runtimeAttributorDataStoreFactory.js");
19
13
  /**
14
+ * Utility function to get the runtime attributor from the container runtime.
15
+ * @param runtime - container runtime from which attributor is to be fetched.
16
+ * @returns IRuntimeAttributor if it exists, otherwise undefined.
20
17
  * @internal
21
18
  */
22
- exports.enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
23
- /**
24
- * @internal
25
- */
26
- exports.IRuntimeAttributor = "IRuntimeAttributor";
27
- /**
28
- * Creates an `IRuntimeAttributor` for usage with {@link mixinAttributor}.
29
- *
30
- * @remarks The attributor will only be populated with data once it's passed via scope to a container runtime load flow.
31
- *
32
- * @internal
33
- */
34
- function createRuntimeAttributor() {
35
- return new RuntimeAttributor();
19
+ async function getRuntimeAttributor(runtime) {
20
+ const entryPoint = await runtime.getAliasedDataStoreEntryPoint(attributorContracts_js_1.attributorDataStoreAlias);
21
+ const runtimeAttributor = (await entryPoint?.get());
22
+ return runtimeAttributor?.IRuntimeAttributor;
36
23
  }
37
- exports.createRuntimeAttributor = createRuntimeAttributor;
24
+ exports.getRuntimeAttributor = getRuntimeAttributor;
38
25
  /**
39
26
  * Mixes in logic to load and store runtime-based attribution functionality.
40
27
  *
41
- * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.
42
- *
43
- * Existing documents without stored attributors will not start storing attribution information: if an
44
- * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,
45
- * that attributor's `has` method will always return `false`.
28
+ * Existing documents without stored attributor will not start storing attribution information. We only create the attributor
29
+ * if its tracking is enabled and we are creating a new document.
46
30
  * @param Base - base class, inherits from FluidAttributorRuntime
47
31
  * @internal
48
32
  */
49
33
  const mixinAttributor = (Base = internal_1.ContainerRuntime) => class ContainerRuntimeWithAttributor extends Base {
50
34
  static async loadRuntime(params) {
51
35
  const { context, registryEntries, existing, requestHandler, provideEntryPoint, runtimeOptions, containerScope, containerRuntimeCtor = ContainerRuntimeWithAttributor, } = params;
52
- const runtimeAttributor = containerScope?.IRuntimeAttributor;
53
- if (!runtimeAttributor) {
54
- throw new internal_4.UsageError("ContainerRuntimeWithAttributor must be passed a scope implementing IProvideRuntimeAttributor");
55
- }
56
- const pendingRuntimeState = context.pendingLocalState;
57
- const baseSnapshot = pendingRuntimeState?.baseSnapshot ?? context.baseSnapshot;
58
- const { quorum, deltaManager, taggedLogger } = context;
59
- (0, internal_2.assert)(quorum !== undefined, 0x968 /* quorum must exist when instantiating attribution-providing runtime */);
60
- const mc = (0, internal_4.loggerToMonitoringContext)(taggedLogger);
61
- const shouldTrackAttribution = mc.config.getBoolean(exports.enableOnNewFileKey) ?? false;
36
+ const mc = (0, internal_3.loggerToMonitoringContext)(context.taggedLogger);
37
+ const factory = new runtimeAttributorDataStoreFactory_js_1.RuntimeAttributorFactory();
38
+ const registryEntriesCopy = [
39
+ ...registryEntries,
40
+ [runtimeAttributorDataStoreFactory_js_1.RuntimeAttributorFactory.type, Promise.resolve(factory)],
41
+ ];
42
+ const shouldTrackAttribution = mc.config.getBoolean(attributorContracts_js_1.enableOnNewFileKey) ?? false;
62
43
  if (shouldTrackAttribution) {
63
44
  const { options } = context;
64
45
  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
@@ -67,116 +48,30 @@ const mixinAttributor = (Base = internal_1.ContainerRuntime) => class ContainerR
67
48
  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
68
49
  const runtime = (await Base.loadRuntime({
69
50
  context,
70
- registryEntries,
51
+ registryEntries: registryEntriesCopy,
71
52
  requestHandler,
72
53
  provideEntryPoint,
73
- // ! This prop is needed for back-compat. Can be removed in 2.0.0-internal.8.0.0
74
- initializeEntryPoint: provideEntryPoint,
75
54
  runtimeOptions,
76
55
  containerScope,
77
56
  existing,
78
57
  containerRuntimeCtor,
79
58
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
80
59
  }));
81
- runtime.runtimeAttributor = runtimeAttributor;
82
- const logger = (0, internal_4.createChildLogger)({
83
- logger: runtime.baseLogger,
84
- namespace: "Attributor",
85
- });
86
- // Note: this fetches attribution blobs relatively eagerly in the load flow; we may want to optimize
87
- // this to avoid blocking on such information until application actually requests some op-based attribution
88
- // info or we need to summarize. All that really needs to happen immediately is to start recording
89
- // op seq# -> attributionInfo for new ops.
90
- await internal_4.PerformanceEvent.timedExecAsync(logger, {
91
- eventName: "initialize",
92
- }, async (event) => {
93
- await runtime.runtimeAttributor?.initialize(deltaManager, quorum, baseSnapshot, async (id) => runtime.storage.readBlob(id), shouldTrackAttribution);
94
- event.end({
95
- attributionEnabledInConfig: shouldTrackAttribution,
96
- attributionEnabledInDoc: runtime.runtimeAttributor
97
- ? runtime.runtimeAttributor.isEnabled
98
- : false,
99
- });
100
- });
101
- return runtime;
102
- }
103
- addContainerStateToSummary(summaryTree, fullTree, trackState, telemetryContext) {
104
- super.addContainerStateToSummary(summaryTree, fullTree, trackState, telemetryContext);
105
- const attributorSummary = this.runtimeAttributor?.summarize();
106
- if (attributorSummary) {
107
- (0, internal_3.addSummarizeResultToSummary)(summaryTree, attributorTreeName, attributorSummary);
60
+ let runtimeAttributor;
61
+ if (shouldTrackAttribution) {
62
+ if (existing) {
63
+ runtimeAttributor = await getRuntimeAttributor(runtime);
64
+ }
65
+ else {
66
+ const datastore = await runtime.createDataStore(runtimeAttributorDataStoreFactory_js_1.RuntimeAttributorFactory.type);
67
+ const result = await datastore.trySetAlias(attributorContracts_js_1.attributorDataStoreAlias);
68
+ (0, internal_2.assert)(result === "Success", 0xa1b /* Failed to set alias for attributor data store */);
69
+ runtimeAttributor = (await datastore.entryPoint.get());
70
+ (0, internal_2.assert)(runtimeAttributor !== undefined, 0xa1c /* Attributor should be defined */);
71
+ }
108
72
  }
73
+ return runtime;
109
74
  }
110
75
  };
111
76
  exports.mixinAttributor = mixinAttributor;
112
- class RuntimeAttributor {
113
- constructor() {
114
- this.encoder = {
115
- encode: internal_2.unreachableCase,
116
- decode: internal_2.unreachableCase,
117
- };
118
- this.isEnabled = false;
119
- }
120
- get IRuntimeAttributor() {
121
- return this;
122
- }
123
- get(key) {
124
- (0, internal_2.assert)(this.opAttributor !== undefined, 0x509 /* RuntimeAttributor must be initialized before getAttributionInfo can be called */);
125
- if (key.type === "detached") {
126
- throw new Error("Attribution of detached keys is not yet supported.");
127
- }
128
- if (key.type === "local") {
129
- // Note: we can *almost* orchestrate this correctly with internal-only changes by looking up the current
130
- // client id in the audience. However, for read->write client transition, the container might have not yet
131
- // received a client id. This is left as a TODO as it might be more easily solved once the detached case
132
- // is settled (e.g. if it's reasonable for the host to know the current user information at container
133
- // creation time, we could just use that here as well).
134
- throw new Error("Attribution of local keys is not yet supported.");
135
- }
136
- return this.opAttributor.getAttributionInfo(key.seq);
137
- }
138
- has(key) {
139
- if (key.type === "detached") {
140
- return false;
141
- }
142
- if (key.type === "local") {
143
- return false;
144
- }
145
- return this.opAttributor?.tryGetAttributionInfo(key.seq) !== undefined;
146
- }
147
- async initialize(deltaManager, quorum, baseSnapshot, readBlob, shouldAddAttributorOnNewFile) {
148
- const attributorTree = baseSnapshot?.trees[attributorTreeName];
149
- // Existing documents that don't already have a snapshot containing runtime attribution info shouldn't
150
- // inject any for now--this causes some back-compat integration problems that aren't fully worked out.
151
- const shouldExcludeAttributor = (baseSnapshot !== undefined && attributorTree === undefined) ||
152
- (baseSnapshot === undefined && !shouldAddAttributorOnNewFile);
153
- if (shouldExcludeAttributor) {
154
- // This gives a consistent error for calls to `get` on keys that don't exist.
155
- this.opAttributor = new attributor_js_1.Attributor();
156
- return;
157
- }
158
- this.isEnabled = true;
159
- 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)());
160
- if (attributorTree === undefined) {
161
- this.opAttributor = new attributor_js_1.OpStreamAttributor(deltaManager, quorum);
162
- }
163
- else {
164
- const id = attributorTree.blobs[opBlobName];
165
- (0, internal_2.assert)(id !== undefined, 0x50a /* Attributor tree should have op attributor summary blob. */);
166
- const blobContents = await readBlob(id);
167
- const attributorSnapshot = (0, client_utils_1.bufferToString)(blobContents, "utf8");
168
- this.opAttributor = this.encoder.decode(attributorSnapshot);
169
- }
170
- }
171
- summarize() {
172
- if (!this.isEnabled) {
173
- // Loaded existing document without attributor data: avoid injecting any data.
174
- return undefined;
175
- }
176
- (0, internal_2.assert)(this.opAttributor !== undefined, 0x50b /* RuntimeAttributor should be initialized before summarization */);
177
- const builder = new internal_3.SummaryTreeBuilder();
178
- builder.addBlob(opBlobName, this.encoder.encode(this.opAttributor));
179
- return builder.getSummaryTree();
180
- }
181
- }
182
77
  //# sourceMappingURL=mixinAttributor.js.map
@@ -1 +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"]}
1
+ {"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"]}
@@ -0,0 +1,19 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+ import { IDeltaManager } from "@fluidframework/container-definitions/internal";
6
+ import { IDocumentMessage, type ISnapshotTree, ISequencedDocumentMessage, IQuorumClients } from "@fluidframework/driver-definitions/internal";
7
+ import { type AttributionInfo, type AttributionKey, type ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
8
+ import { type IRuntimeAttributor } from "./attributorContracts.js";
9
+ export declare class RuntimeAttributor implements IRuntimeAttributor {
10
+ get IRuntimeAttributor(): IRuntimeAttributor;
11
+ get(key: AttributionKey): AttributionInfo;
12
+ has(key: AttributionKey): boolean;
13
+ private encoder;
14
+ private opAttributor;
15
+ isEnabled: boolean;
16
+ initialize(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, quorum: IQuorumClients, baseSnapshotForAttributorTree: ISnapshotTree | undefined, readBlob: (id: string) => Promise<ArrayBufferLike>): Promise<void>;
17
+ summarizeOpAttributor(): ISummaryTreeWithStats;
18
+ }
19
+ //# sourceMappingURL=runtimeAttributor.d.ts.map