@fluidframework/container-loader 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

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 (168) hide show
  1. package/.eslintrc.js +18 -21
  2. package/.mocharc.js +2 -2
  3. package/README.md +65 -44
  4. package/api-extractor.json +2 -2
  5. package/closeAndGetPendingLocalState.md +51 -0
  6. package/dist/audience.d.ts +0 -1
  7. package/dist/audience.d.ts.map +1 -1
  8. package/dist/audience.js.map +1 -1
  9. package/dist/catchUpMonitor.d.ts.map +1 -1
  10. package/dist/catchUpMonitor.js.map +1 -1
  11. package/dist/collabWindowTracker.d.ts.map +1 -1
  12. package/dist/collabWindowTracker.js.map +1 -1
  13. package/dist/connectionManager.d.ts +5 -5
  14. package/dist/connectionManager.d.ts.map +1 -1
  15. package/dist/connectionManager.js +107 -44
  16. package/dist/connectionManager.js.map +1 -1
  17. package/dist/connectionState.d.ts.map +1 -1
  18. package/dist/connectionState.js.map +1 -1
  19. package/dist/connectionStateHandler.d.ts +7 -7
  20. package/dist/connectionStateHandler.d.ts.map +1 -1
  21. package/dist/connectionStateHandler.js +50 -21
  22. package/dist/connectionStateHandler.js.map +1 -1
  23. package/dist/container.d.ts +64 -5
  24. package/dist/container.d.ts.map +1 -1
  25. package/dist/container.js +329 -137
  26. package/dist/container.js.map +1 -1
  27. package/dist/containerContext.d.ts +19 -8
  28. package/dist/containerContext.d.ts.map +1 -1
  29. package/dist/containerContext.js +58 -14
  30. package/dist/containerContext.js.map +1 -1
  31. package/dist/containerStorageAdapter.d.ts +41 -2
  32. package/dist/containerStorageAdapter.d.ts.map +1 -1
  33. package/dist/containerStorageAdapter.js +88 -14
  34. package/dist/containerStorageAdapter.js.map +1 -1
  35. package/dist/contracts.d.ts +3 -3
  36. package/dist/contracts.d.ts.map +1 -1
  37. package/dist/contracts.js.map +1 -1
  38. package/dist/deltaManager.d.ts +21 -8
  39. package/dist/deltaManager.d.ts.map +1 -1
  40. package/dist/deltaManager.js +112 -37
  41. package/dist/deltaManager.js.map +1 -1
  42. package/dist/deltaManagerProxy.d.ts +10 -22
  43. package/dist/deltaManagerProxy.d.ts.map +1 -1
  44. package/dist/deltaManagerProxy.js +14 -50
  45. package/dist/deltaManagerProxy.js.map +1 -1
  46. package/dist/deltaQueue.d.ts.map +1 -1
  47. package/dist/deltaQueue.js +4 -2
  48. package/dist/deltaQueue.js.map +1 -1
  49. package/dist/index.d.ts +4 -3
  50. package/dist/index.d.ts.map +1 -1
  51. package/dist/index.js +1 -3
  52. package/dist/index.js.map +1 -1
  53. package/dist/loader.d.ts +13 -4
  54. package/dist/loader.d.ts.map +1 -1
  55. package/dist/loader.js +38 -24
  56. package/dist/loader.js.map +1 -1
  57. package/dist/packageVersion.d.ts +1 -1
  58. package/dist/packageVersion.js +1 -1
  59. package/dist/packageVersion.js.map +1 -1
  60. package/dist/protocol.d.ts.map +1 -1
  61. package/dist/protocol.js +2 -1
  62. package/dist/protocol.js.map +1 -1
  63. package/dist/protocolTreeDocumentStorageService.d.ts +6 -2
  64. package/dist/protocolTreeDocumentStorageService.d.ts.map +1 -1
  65. package/dist/protocolTreeDocumentStorageService.js +7 -4
  66. package/dist/protocolTreeDocumentStorageService.js.map +1 -1
  67. package/dist/quorum.d.ts.map +1 -1
  68. package/dist/quorum.js.map +1 -1
  69. package/dist/retriableDocumentStorageService.d.ts.map +1 -1
  70. package/dist/retriableDocumentStorageService.js +6 -2
  71. package/dist/retriableDocumentStorageService.js.map +1 -1
  72. package/dist/utils.d.ts.map +1 -1
  73. package/dist/utils.js +8 -5
  74. package/dist/utils.js.map +1 -1
  75. package/lib/audience.d.ts +0 -1
  76. package/lib/audience.d.ts.map +1 -1
  77. package/lib/audience.js.map +1 -1
  78. package/lib/catchUpMonitor.d.ts.map +1 -1
  79. package/lib/catchUpMonitor.js.map +1 -1
  80. package/lib/collabWindowTracker.d.ts.map +1 -1
  81. package/lib/collabWindowTracker.js.map +1 -1
  82. package/lib/connectionManager.d.ts +5 -5
  83. package/lib/connectionManager.d.ts.map +1 -1
  84. package/lib/connectionManager.js +110 -47
  85. package/lib/connectionManager.js.map +1 -1
  86. package/lib/connectionState.d.ts.map +1 -1
  87. package/lib/connectionState.js.map +1 -1
  88. package/lib/connectionStateHandler.d.ts +7 -7
  89. package/lib/connectionStateHandler.d.ts.map +1 -1
  90. package/lib/connectionStateHandler.js +50 -21
  91. package/lib/connectionStateHandler.js.map +1 -1
  92. package/lib/container.d.ts +64 -5
  93. package/lib/container.d.ts.map +1 -1
  94. package/lib/container.js +336 -144
  95. package/lib/container.js.map +1 -1
  96. package/lib/containerContext.d.ts +19 -8
  97. package/lib/containerContext.d.ts.map +1 -1
  98. package/lib/containerContext.js +59 -15
  99. package/lib/containerContext.js.map +1 -1
  100. package/lib/containerStorageAdapter.d.ts +41 -2
  101. package/lib/containerStorageAdapter.d.ts.map +1 -1
  102. package/lib/containerStorageAdapter.js +86 -14
  103. package/lib/containerStorageAdapter.js.map +1 -1
  104. package/lib/contracts.d.ts +3 -3
  105. package/lib/contracts.d.ts.map +1 -1
  106. package/lib/contracts.js.map +1 -1
  107. package/lib/deltaManager.d.ts +21 -8
  108. package/lib/deltaManager.d.ts.map +1 -1
  109. package/lib/deltaManager.js +114 -39
  110. package/lib/deltaManager.js.map +1 -1
  111. package/lib/deltaManagerProxy.d.ts +10 -22
  112. package/lib/deltaManagerProxy.d.ts.map +1 -1
  113. package/lib/deltaManagerProxy.js +14 -50
  114. package/lib/deltaManagerProxy.js.map +1 -1
  115. package/lib/deltaQueue.d.ts.map +1 -1
  116. package/lib/deltaQueue.js +4 -2
  117. package/lib/deltaQueue.js.map +1 -1
  118. package/lib/index.d.ts +4 -3
  119. package/lib/index.d.ts.map +1 -1
  120. package/lib/index.js +2 -2
  121. package/lib/index.js.map +1 -1
  122. package/lib/loader.d.ts +13 -4
  123. package/lib/loader.d.ts.map +1 -1
  124. package/lib/loader.js +37 -24
  125. package/lib/loader.js.map +1 -1
  126. package/lib/packageVersion.d.ts +1 -1
  127. package/lib/packageVersion.js +1 -1
  128. package/lib/packageVersion.js.map +1 -1
  129. package/lib/protocol.d.ts.map +1 -1
  130. package/lib/protocol.js +2 -1
  131. package/lib/protocol.js.map +1 -1
  132. package/lib/protocolTreeDocumentStorageService.d.ts +6 -2
  133. package/lib/protocolTreeDocumentStorageService.d.ts.map +1 -1
  134. package/lib/protocolTreeDocumentStorageService.js +7 -4
  135. package/lib/protocolTreeDocumentStorageService.js.map +1 -1
  136. package/lib/quorum.d.ts.map +1 -1
  137. package/lib/quorum.js.map +1 -1
  138. package/lib/retriableDocumentStorageService.d.ts.map +1 -1
  139. package/lib/retriableDocumentStorageService.js +6 -2
  140. package/lib/retriableDocumentStorageService.js.map +1 -1
  141. package/lib/utils.d.ts.map +1 -1
  142. package/lib/utils.js +8 -5
  143. package/lib/utils.js.map +1 -1
  144. package/package.json +67 -56
  145. package/prettier.config.cjs +1 -1
  146. package/src/audience.ts +51 -46
  147. package/src/catchUpMonitor.ts +39 -37
  148. package/src/collabWindowTracker.ts +75 -70
  149. package/src/connectionManager.ts +1040 -941
  150. package/src/connectionState.ts +19 -19
  151. package/src/connectionStateHandler.ts +557 -463
  152. package/src/container.ts +2147 -1784
  153. package/src/containerContext.ts +417 -345
  154. package/src/containerStorageAdapter.ts +268 -154
  155. package/src/contracts.ts +155 -153
  156. package/src/deltaManager.ts +1074 -945
  157. package/src/deltaManagerProxy.ts +88 -137
  158. package/src/deltaQueue.ts +155 -151
  159. package/src/index.ts +13 -17
  160. package/src/loader.ts +434 -427
  161. package/src/packageVersion.ts +1 -1
  162. package/src/protocol.ts +93 -87
  163. package/src/protocolTreeDocumentStorageService.ts +34 -34
  164. package/src/quorum.ts +34 -34
  165. package/src/retriableDocumentStorageService.ts +118 -102
  166. package/src/utils.ts +93 -83
  167. package/tsconfig.esnext.json +6 -6
  168. package/tsconfig.json +8 -12
package/src/loader.ts CHANGED
@@ -6,129 +6,109 @@
6
6
  import { v4 as uuid } from "uuid";
7
7
  import { ITelemetryBaseLogger, ITelemetryLogger } from "@fluidframework/common-definitions";
8
8
  import {
9
- FluidObject,
10
- IFluidRouter,
11
- IRequest,
12
- IRequestHeader,
13
- IResponse,
9
+ FluidObject,
10
+ IFluidRouter,
11
+ IRequest,
12
+ IRequestHeader,
13
+ IResponse,
14
14
  } from "@fluidframework/core-interfaces";
15
15
  import {
16
- IContainer,
17
- IFluidModule,
18
- IHostLoader,
19
- ILoader,
20
- ILoaderOptions as ILoaderOptions1,
21
- LoaderHeader,
22
- IProvideFluidCodeDetailsComparer,
23
- IFluidCodeDetails,
16
+ IContainer,
17
+ IFluidModule,
18
+ IHostLoader,
19
+ ILoader,
20
+ ILoaderOptions as ILoaderOptions1,
21
+ LoaderHeader,
22
+ IProvideFluidCodeDetailsComparer,
23
+ IFluidCodeDetails,
24
24
  } from "@fluidframework/container-definitions";
25
25
  import {
26
- ChildLogger,
27
- DebugLogger,
28
- IConfigProviderBase,
29
- loggerToMonitoringContext,
30
- mixinMonitoringContext,
31
- MonitoringContext,
32
- PerformanceEvent,
33
- sessionStorageConfigProvider,
26
+ ChildLogger,
27
+ DebugLogger,
28
+ IConfigProviderBase,
29
+ loggerToMonitoringContext,
30
+ mixinMonitoringContext,
31
+ MonitoringContext,
32
+ PerformanceEvent,
33
+ sessionStorageConfigProvider,
34
34
  } from "@fluidframework/telemetry-utils";
35
35
  import {
36
- IDocumentServiceFactory,
37
- IDocumentStorageService,
38
- IFluidResolvedUrl,
39
- IResolvedUrl,
40
- IUrlResolver,
36
+ IDocumentServiceFactory,
37
+ IDocumentStorageService,
38
+ IFluidResolvedUrl,
39
+ IUrlResolver,
41
40
  } from "@fluidframework/driver-definitions";
42
41
  import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
43
- import {
44
- ensureFluidResolvedUrl,
45
- MultiUrlResolver,
46
- MultiDocumentServiceFactory,
47
- } from "@fluidframework/driver-utils";
42
+ import { ensureFluidResolvedUrl } from "@fluidframework/driver-utils";
48
43
  import { Container, IPendingContainerState } from "./container";
49
44
  import { IParsedUrl, parseUrl } from "./utils";
50
45
  import { pkgVersion } from "./packageVersion";
51
46
  import { ProtocolHandlerBuilder } from "./protocol";
52
47
 
53
48
  function canUseCache(request: IRequest): boolean {
54
- if (request.headers === undefined) {
55
- return true;
56
- }
49
+ if (request.headers === undefined) {
50
+ return true;
51
+ }
57
52
 
58
- return request.headers[LoaderHeader.cache] !== false;
53
+ return request.headers[LoaderHeader.cache] !== false;
59
54
  }
60
55
 
56
+ /**
57
+ * @deprecated - In the next release RelativeLoader will no longer be exported. It is an internal class that should not be used directly.
58
+ */
61
59
  export class RelativeLoader implements ILoader {
62
- constructor(
63
- private readonly container: Container,
64
- private readonly loader: ILoader | undefined,
65
- ) {
66
- }
67
-
68
- public get IFluidRouter(): IFluidRouter { return this; }
69
-
70
- public async resolve(request: IRequest): Promise<IContainer> {
71
- if (request.url.startsWith("/")) {
72
- if (canUseCache(request)) {
73
- return this.container;
74
- } else {
75
- const resolvedUrl = this.container.resolvedUrl;
76
- ensureFluidResolvedUrl(resolvedUrl);
77
- const container = await Container.load(
78
- this.loader as Loader,
79
- {
80
- canReconnect: request.headers?.[LoaderHeader.reconnect],
81
- clientDetailsOverride: request.headers?.[LoaderHeader.clientDetails],
82
- resolvedUrl: { ...resolvedUrl },
83
- version: request.headers?.[LoaderHeader.version] ?? undefined,
84
- loadMode: request.headers?.[LoaderHeader.loadMode],
85
- },
86
- );
87
- return container;
88
- }
89
- }
90
-
91
- if (this.loader === undefined) {
92
- throw new Error("Cannot resolve external containers");
93
- }
94
- return this.loader.resolve(request);
95
- }
96
-
97
- public async request(request: IRequest): Promise<IResponse> {
98
- if (request.url.startsWith("/")) {
99
- const container = await this.resolve(request);
100
- return container.request(request);
101
- }
102
-
103
- if (this.loader === undefined) {
104
- return {
105
- status: 404,
106
- value: "Cannot request external containers",
107
- mimeType: "plain/text",
108
- };
109
- }
110
- return this.loader.request(request);
111
- }
112
- }
113
-
114
- function createCachedResolver(resolver: IUrlResolver) {
115
- const cacheResolver = Object.create(resolver) as IUrlResolver;
116
- const resolveCache = new Map<string, Promise<IResolvedUrl | undefined>>();
117
- cacheResolver.resolve = async (request: IRequest): Promise<IResolvedUrl | undefined> => {
118
- if (!canUseCache(request)) {
119
- return resolver.resolve(request);
120
- }
121
- if (!resolveCache.has(request.url)) {
122
- resolveCache.set(request.url, resolver.resolve(request));
123
- }
124
-
125
- return resolveCache.get(request.url);
126
- };
127
- return cacheResolver;
60
+ constructor(
61
+ private readonly container: Container,
62
+ private readonly loader: ILoader | undefined,
63
+ ) {}
64
+
65
+ public get IFluidRouter(): IFluidRouter {
66
+ return this;
67
+ }
68
+
69
+ public async resolve(request: IRequest): Promise<IContainer> {
70
+ if (request.url.startsWith("/")) {
71
+ if (canUseCache(request)) {
72
+ return this.container;
73
+ } else {
74
+ const resolvedUrl = this.container.resolvedUrl;
75
+ ensureFluidResolvedUrl(resolvedUrl);
76
+ const container = await Container.load(this.loader as Loader, {
77
+ canReconnect: request.headers?.[LoaderHeader.reconnect],
78
+ clientDetailsOverride: request.headers?.[LoaderHeader.clientDetails],
79
+ resolvedUrl: { ...resolvedUrl },
80
+ version: request.headers?.[LoaderHeader.version] ?? undefined,
81
+ loadMode: request.headers?.[LoaderHeader.loadMode],
82
+ });
83
+ return container;
84
+ }
85
+ }
86
+
87
+ if (this.loader === undefined) {
88
+ throw new Error("Cannot resolve external containers");
89
+ }
90
+ return this.loader.resolve(request);
91
+ }
92
+
93
+ public async request(request: IRequest): Promise<IResponse> {
94
+ if (request.url.startsWith("/")) {
95
+ const container = await this.resolve(request);
96
+ return container.request(request);
97
+ }
98
+
99
+ if (this.loader === undefined) {
100
+ return {
101
+ status: 404,
102
+ value: "Cannot request external containers",
103
+ mimeType: "plain/text",
104
+ };
105
+ }
106
+ return this.loader.request(request);
107
+ }
128
108
  }
129
109
 
130
110
  export interface ILoaderOptions extends ILoaderOptions1 {
131
- summarizeProtocolTree?: boolean;
111
+ summarizeProtocolTree?: boolean;
132
112
  }
133
113
 
134
114
  /**
@@ -138,14 +118,14 @@ export interface ILoaderOptions extends ILoaderOptions1 {
138
118
  * Encapsulates a module entry point with corresponding code details.
139
119
  */
140
120
  export interface IFluidModuleWithDetails {
141
- /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
142
- module: IFluidModule;
143
- /**
144
- * Code details associated with the module. Represents a document schema this module supports.
145
- * If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
146
- * it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
147
- */
148
- details: IFluidCodeDetails;
121
+ /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
122
+ module: IFluidModule;
123
+ /**
124
+ * Code details associated with the module. Represents a document schema this module supports.
125
+ * If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
126
+ * it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
127
+ */
128
+ details: IFluidCodeDetails;
149
129
  }
150
130
 
151
131
  /**
@@ -154,116 +134,115 @@ export interface IFluidModuleWithDetails {
154
134
  * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
155
135
  * a package name and package version range.
156
136
  */
157
- export interface ICodeDetailsLoader
158
- extends Partial<IProvideFluidCodeDetailsComparer> {
159
- /**
160
- * Load the code module (package) that is capable to interact with the document.
161
- *
162
- * @param source - Code proposal that articulates the current schema the document is written in.
163
- * @returns - Code module entry point along with the code details associated with it.
164
- */
165
- load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
137
+ export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
138
+ /**
139
+ * Load the code module (package) that is capable to interact with the document.
140
+ *
141
+ * @param source - Code proposal that articulates the current schema the document is written in.
142
+ * @returns - Code module entry point along with the code details associated with it.
143
+ */
144
+ load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
166
145
  }
167
146
 
168
147
  /**
169
148
  * Services and properties necessary for creating a loader
170
149
  */
171
150
  export interface ILoaderProps {
172
- /**
173
- * The url resolver used by the loader for resolving external urls
174
- * into Fluid urls such that the container specified by the
175
- * external url can be loaded.
176
- */
177
- readonly urlResolver: IUrlResolver;
178
- /**
179
- * The document service factory take the Fluid url provided
180
- * by the resolved url and constructs all the necessary services
181
- * for communication with the container's server.
182
- */
183
- readonly documentServiceFactory: IDocumentServiceFactory;
184
- /**
185
- * The code loader handles loading the necessary code
186
- * for running a container once it is loaded.
187
- */
188
- readonly codeLoader: ICodeDetailsLoader;
189
-
190
- /**
191
- * A property bag of options used by various layers
192
- * to control features
193
- */
194
- readonly options?: ILoaderOptions;
195
-
196
- /**
197
- * Scope is provided to all container and is a set of shared
198
- * services for container's to integrate with their host environment.
199
- */
200
- readonly scope?: FluidObject;
201
-
202
- /**
203
- * The logger that all telemetry should be pushed to.
204
- */
205
- readonly logger?: ITelemetryBaseLogger;
206
-
207
- /**
208
- * Blobs storage for detached containers.
209
- */
210
- readonly detachedBlobStorage?: IDetachedBlobStorage;
211
-
212
- /**
213
- * The configuration provider which may be used to control features.
214
- */
215
- readonly configProvider?: IConfigProviderBase;
216
-
217
- /**
218
- * Optional property for allowing the container to use a custom
219
- * protocol implementation for handling the quorum and/or the audience.
220
- */
221
- readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
151
+ /**
152
+ * The url resolver used by the loader for resolving external urls
153
+ * into Fluid urls such that the container specified by the
154
+ * external url can be loaded.
155
+ */
156
+ readonly urlResolver: IUrlResolver;
157
+ /**
158
+ * The document service factory take the Fluid url provided
159
+ * by the resolved url and constructs all the necessary services
160
+ * for communication with the container's server.
161
+ */
162
+ readonly documentServiceFactory: IDocumentServiceFactory;
163
+ /**
164
+ * The code loader handles loading the necessary code
165
+ * for running a container once it is loaded.
166
+ */
167
+ readonly codeLoader: ICodeDetailsLoader;
168
+
169
+ /**
170
+ * A property bag of options used by various layers
171
+ * to control features
172
+ */
173
+ readonly options?: ILoaderOptions;
174
+
175
+ /**
176
+ * Scope is provided to all container and is a set of shared
177
+ * services for container's to integrate with their host environment.
178
+ */
179
+ readonly scope?: FluidObject;
180
+
181
+ /**
182
+ * The logger that all telemetry should be pushed to.
183
+ */
184
+ readonly logger?: ITelemetryBaseLogger;
185
+
186
+ /**
187
+ * Blobs storage for detached containers.
188
+ */
189
+ readonly detachedBlobStorage?: IDetachedBlobStorage;
190
+
191
+ /**
192
+ * The configuration provider which may be used to control features.
193
+ */
194
+ readonly configProvider?: IConfigProviderBase;
195
+
196
+ /**
197
+ * Optional property for allowing the container to use a custom
198
+ * protocol implementation for handling the quorum and/or the audience.
199
+ */
200
+ readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
222
201
  }
223
202
 
224
203
  /**
225
204
  * Services and properties used by and exposed by the loader
226
205
  */
227
206
  export interface ILoaderServices {
228
- /**
229
- * The url resolver used by the loader for resolving external urls
230
- * into Fluid urls such that the container specified by the
231
- * external url can be loaded.
232
- */
233
- readonly urlResolver: IUrlResolver;
234
- /**
235
- * The document service factory take the Fluid url provided
236
- * by the resolved url and constructs all the necessary services
237
- * for communication with the container's server.
238
- */
239
- readonly documentServiceFactory: IDocumentServiceFactory;
240
- /**
241
- * The code loader handles loading the necessary code
242
- * for running a container once it is loaded.
243
- */
244
- readonly codeLoader: ICodeDetailsLoader;
245
-
246
- /**
247
- * A property bag of options used by various layers
248
- * to control features
249
- */
250
- readonly options: ILoaderOptions;
251
-
252
- /**
253
- * Scope is provided to all container and is a set of shared
254
- * services for container's to integrate with their host environment.
255
- */
256
- readonly scope: FluidObject;
257
-
258
- /**
259
- * The logger downstream consumers should construct their loggers from
260
- */
261
- readonly subLogger: ITelemetryLogger;
262
-
263
- /**
264
- * Blobs storage for detached containers.
265
- */
266
- readonly detachedBlobStorage?: IDetachedBlobStorage;
207
+ /**
208
+ * The url resolver used by the loader for resolving external urls
209
+ * into Fluid urls such that the container specified by the
210
+ * external url can be loaded.
211
+ */
212
+ readonly urlResolver: IUrlResolver;
213
+ /**
214
+ * The document service factory take the Fluid url provided
215
+ * by the resolved url and constructs all the necessary services
216
+ * for communication with the container's server.
217
+ */
218
+ readonly documentServiceFactory: IDocumentServiceFactory;
219
+ /**
220
+ * The code loader handles loading the necessary code
221
+ * for running a container once it is loaded.
222
+ */
223
+ readonly codeLoader: ICodeDetailsLoader;
224
+
225
+ /**
226
+ * A property bag of options used by various layers
227
+ * to control features
228
+ */
229
+ readonly options: ILoaderOptions;
230
+
231
+ /**
232
+ * Scope is provided to all container and is a set of shared
233
+ * services for container's to integrate with their host environment.
234
+ */
235
+ readonly scope: FluidObject;
236
+
237
+ /**
238
+ * The logger downstream consumers should construct their loggers from
239
+ */
240
+ readonly subLogger: ITelemetryLogger;
241
+
242
+ /**
243
+ * Blobs storage for detached containers.
244
+ */
245
+ readonly detachedBlobStorage?: IDetachedBlobStorage;
267
246
  }
268
247
 
269
248
  /**
@@ -271,228 +250,256 @@ export interface ILoaderServices {
271
250
  * blobs in detached containers.
272
251
  */
273
252
  export type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
274
- size: number;
275
- /**
276
- * Return an array of all blob IDs present in storage
277
- */
278
- getBlobIds(): string[];
279
- };
253
+ size: number;
254
+ /**
255
+ * Return an array of all blob IDs present in storage
256
+ */
257
+ getBlobIds(): string[];
258
+ };
259
+
260
+ /**
261
+ * With an already-resolved container, we can request a component directly, without loading the container again
262
+ * @param container - a resolved container
263
+ * @returns component on the container
264
+ */
265
+ export async function requestResolvedObjectFromContainer(
266
+ container: IContainer,
267
+ headers?: IRequestHeader,
268
+ ): Promise<IResponse> {
269
+ ensureFluidResolvedUrl(container.resolvedUrl);
270
+ const parsedUrl = parseUrl(container.resolvedUrl.url);
271
+
272
+ if (parsedUrl === undefined) {
273
+ throw new Error(`Invalid URL ${container.resolvedUrl.url}`);
274
+ }
275
+
276
+ return container.request({
277
+ url: `${parsedUrl.path}${parsedUrl.query}`,
278
+ headers,
279
+ });
280
+ }
280
281
 
281
282
  /**
282
283
  * Manages Fluid resource loading
283
284
  */
284
285
  export class Loader implements IHostLoader {
285
- private readonly containers = new Map<string, Promise<Container>>();
286
- public readonly services: ILoaderServices;
287
- private readonly mc: MonitoringContext;
288
- private readonly protocolHandlerBuilder: ProtocolHandlerBuilder | undefined;
289
-
290
- constructor(loaderProps: ILoaderProps) {
291
- const scope: FluidObject<ILoader> = { ...loaderProps.scope };
292
- if (loaderProps.options?.provideScopeLoader !== false) {
293
- scope.ILoader = this;
294
- }
295
- const telemetryProps = {
296
- loaderId: uuid(),
297
- loaderVersion: pkgVersion,
298
- };
299
-
300
- const subMc = mixinMonitoringContext(
301
- DebugLogger.mixinDebugLogger("fluid:telemetry", loaderProps.logger, { all: telemetryProps }),
302
- sessionStorageConfigProvider.value,
303
- loaderProps.configProvider,
304
- );
305
-
306
- this.services = {
307
- urlResolver: createCachedResolver(MultiUrlResolver.create(loaderProps.urlResolver)),
308
- documentServiceFactory: MultiDocumentServiceFactory.create(loaderProps.documentServiceFactory),
309
- codeLoader: loaderProps.codeLoader,
310
- options: loaderProps.options ?? {},
311
- scope,
312
- subLogger: subMc.logger,
313
- detachedBlobStorage: loaderProps.detachedBlobStorage,
314
- };
315
- this.mc = loggerToMonitoringContext(
316
- ChildLogger.create(this.services.subLogger, "Loader"));
317
- this.protocolHandlerBuilder = loaderProps.protocolHandlerBuilder;
318
- }
319
-
320
- public get IFluidRouter(): IFluidRouter { return this; }
321
-
322
- public async createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer> {
323
- const container = await Container.createDetached(
324
- this,
325
- codeDetails,
326
- this.protocolHandlerBuilder,
327
- );
328
-
329
- if (this.cachingEnabled) {
330
- container.once("attached", () => {
331
- ensureFluidResolvedUrl(container.resolvedUrl);
332
- const parsedUrl = parseUrl(container.resolvedUrl.url);
333
- if (parsedUrl !== undefined) {
334
- this.addToContainerCache(parsedUrl.id, Promise.resolve(container));
335
- }
336
- });
337
- }
338
-
339
- return container;
340
- }
341
-
342
- public async rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer> {
343
- return Container.rehydrateDetachedFromSnapshot(this, snapshot, this.protocolHandlerBuilder);
344
- }
345
-
346
- public async resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer> {
347
- const eventName = pendingLocalState === undefined ? "Resolve" : "ResolveWithPendingState";
348
- return PerformanceEvent.timedExecAsync(this.mc.logger, { eventName }, async () => {
349
- const resolved = await this.resolveCore(
350
- request,
351
- pendingLocalState !== undefined ? JSON.parse(pendingLocalState) : undefined,
352
- );
353
- return resolved.container;
354
- });
355
- }
356
-
357
- public async request(request: IRequest): Promise<IResponse> {
358
- return PerformanceEvent.timedExecAsync(this.mc.logger, { eventName: "Request" }, async () => {
359
- const resolved = await this.resolveCore(request);
360
- return resolved.container.request({
361
- ...request,
362
- url: `${resolved.parsed.path}${resolved.parsed.query}`,
363
- });
364
- });
365
- }
366
-
367
- private getKeyForContainerCache(request: IRequest, parsedUrl: IParsedUrl): string {
368
- const key = request.headers?.[LoaderHeader.version] !== undefined
369
- ? `${parsedUrl.id}@${request.headers[LoaderHeader.version]}`
370
- : parsedUrl.id;
371
- return key;
372
- }
373
-
374
- private addToContainerCache(key: string, containerP: Promise<Container>) {
375
- this.containers.set(key, containerP);
376
- containerP.then((container) => {
377
- // If the container is closed or becomes closed after we resolve it, remove it from the cache.
378
- if (container.closed) {
379
- this.containers.delete(key);
380
- } else {
381
- container.once("closed", () => {
382
- this.containers.delete(key);
383
- });
384
- }
385
- }).catch((error) => {});
386
- }
387
-
388
- private async resolveCore(
389
- request: IRequest,
390
- pendingLocalState?: IPendingContainerState,
391
- ): Promise<{ container: Container; parsed: IParsedUrl; }> {
392
- const resolvedAsFluid = await this.services.urlResolver.resolve(request);
393
- ensureFluidResolvedUrl(resolvedAsFluid);
394
-
395
- // Parse URL into data stores
396
- const parsed = parseUrl(resolvedAsFluid.url);
397
- if (parsed === undefined) {
398
- throw new Error(`Invalid URL ${resolvedAsFluid.url}`);
399
- }
400
-
401
- if (pendingLocalState !== undefined) {
402
- const parsedPendingUrl = parseUrl(pendingLocalState.url);
403
- if (parsedPendingUrl?.id !== parsed.id ||
404
- parsedPendingUrl?.path.replace(/\/$/, "") !== parsed.path.replace(/\/$/, "")) {
405
- const message = `URL ${resolvedAsFluid.url} does not match pending state URL ${pendingLocalState.url}`;
406
- throw new Error(message);
407
- }
408
- }
409
-
410
- const { canCache, fromSequenceNumber } = this.parseHeader(parsed, request);
411
- const shouldCache = pendingLocalState !== undefined ? false : canCache;
412
-
413
- let container: Container;
414
- if (shouldCache) {
415
- const key = this.getKeyForContainerCache(request, parsed);
416
- const maybeContainer = await this.containers.get(key);
417
- if (maybeContainer !== undefined) {
418
- container = maybeContainer;
419
- } else {
420
- const containerP =
421
- this.loadContainer(
422
- request,
423
- resolvedAsFluid);
424
- this.addToContainerCache(key, containerP);
425
- container = await containerP;
426
- }
427
- } else {
428
- container =
429
- await this.loadContainer(
430
- request,
431
- resolvedAsFluid,
432
- pendingLocalState);
433
- }
434
-
435
- if (container.deltaManager.lastSequenceNumber <= fromSequenceNumber) {
436
- await new Promise<void>((resolve, reject) => {
437
- function opHandler(message: ISequencedDocumentMessage) {
438
- if (message.sequenceNumber > fromSequenceNumber) {
439
- resolve();
440
- container.removeListener("op", opHandler);
441
- }
442
- }
443
-
444
- container.on("op", opHandler);
445
- });
446
- }
447
-
448
- return { container, parsed };
449
- }
450
-
451
- private get cachingEnabled() {
452
- return this.services.options.cache !== false;
453
- }
454
-
455
- private canCacheForRequest(headers: IRequestHeader): boolean {
456
- return this.cachingEnabled && headers[LoaderHeader.cache] !== false;
457
- }
458
-
459
- private parseHeader(parsed: IParsedUrl, request: IRequest) {
460
- let fromSequenceNumber = -1;
461
-
462
- request.headers = request.headers ?? {};
463
-
464
- const headerSeqNum = request.headers[LoaderHeader.sequenceNumber];
465
- if (headerSeqNum !== undefined) {
466
- fromSequenceNumber = headerSeqNum;
467
- }
468
-
469
- // If set in both query string and headers, use query string
470
- request.headers[LoaderHeader.version] = parsed.version ?? request.headers[LoaderHeader.version];
471
-
472
- const canCache = this.canCacheForRequest(request.headers);
473
-
474
- return {
475
- canCache,
476
- fromSequenceNumber,
477
- };
478
- }
479
-
480
- private async loadContainer(
481
- request: IRequest,
482
- resolved: IFluidResolvedUrl,
483
- pendingLocalState?: IPendingContainerState,
484
- ): Promise<Container> {
485
- return Container.load(
486
- this,
487
- {
488
- canReconnect: request.headers?.[LoaderHeader.reconnect],
489
- clientDetailsOverride: request.headers?.[LoaderHeader.clientDetails],
490
- resolvedUrl: resolved,
491
- version: request.headers?.[LoaderHeader.version] ?? undefined,
492
- loadMode: request.headers?.[LoaderHeader.loadMode],
493
- },
494
- pendingLocalState,
495
- this.protocolHandlerBuilder,
496
- );
497
- }
286
+ private readonly containers = new Map<string, Promise<Container>>();
287
+ public readonly services: ILoaderServices;
288
+ private readonly mc: MonitoringContext;
289
+ private readonly protocolHandlerBuilder: ProtocolHandlerBuilder | undefined;
290
+
291
+ constructor(loaderProps: ILoaderProps) {
292
+ const scope: FluidObject<ILoader> = { ...loaderProps.scope };
293
+ if (loaderProps.options?.provideScopeLoader !== false) {
294
+ scope.ILoader = this;
295
+ }
296
+ const telemetryProps = {
297
+ loaderId: uuid(),
298
+ loaderVersion: pkgVersion,
299
+ };
300
+
301
+ const subMc = mixinMonitoringContext(
302
+ DebugLogger.mixinDebugLogger("fluid:telemetry", loaderProps.logger, {
303
+ all: telemetryProps,
304
+ }),
305
+ sessionStorageConfigProvider.value,
306
+ loaderProps.configProvider,
307
+ );
308
+
309
+ this.services = {
310
+ urlResolver: loaderProps.urlResolver,
311
+ documentServiceFactory: loaderProps.documentServiceFactory,
312
+ codeLoader: loaderProps.codeLoader,
313
+ options: loaderProps.options ?? {},
314
+ scope,
315
+ subLogger: subMc.logger,
316
+ detachedBlobStorage: loaderProps.detachedBlobStorage,
317
+ };
318
+ this.mc = loggerToMonitoringContext(ChildLogger.create(this.services.subLogger, "Loader"));
319
+ this.protocolHandlerBuilder = loaderProps.protocolHandlerBuilder;
320
+ }
321
+
322
+ public get IFluidRouter(): IFluidRouter {
323
+ return this;
324
+ }
325
+
326
+ public async createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer> {
327
+ const container = await Container.createDetached(
328
+ this,
329
+ codeDetails,
330
+ this.protocolHandlerBuilder,
331
+ );
332
+
333
+ if (this.cachingEnabled) {
334
+ container.once("attached", () => {
335
+ ensureFluidResolvedUrl(container.resolvedUrl);
336
+ const parsedUrl = parseUrl(container.resolvedUrl.url);
337
+ if (parsedUrl !== undefined) {
338
+ this.addToContainerCache(parsedUrl.id, Promise.resolve(container));
339
+ }
340
+ });
341
+ }
342
+
343
+ return container;
344
+ }
345
+
346
+ public async rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer> {
347
+ return Container.rehydrateDetachedFromSnapshot(this, snapshot, this.protocolHandlerBuilder);
348
+ }
349
+
350
+ public async resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer> {
351
+ const eventName = pendingLocalState === undefined ? "Resolve" : "ResolveWithPendingState";
352
+ return PerformanceEvent.timedExecAsync(this.mc.logger, { eventName }, async () => {
353
+ const resolved = await this.resolveCore(
354
+ request,
355
+ pendingLocalState !== undefined ? JSON.parse(pendingLocalState) : undefined,
356
+ );
357
+ return resolved.container;
358
+ });
359
+ }
360
+
361
+ public async request(request: IRequest): Promise<IResponse> {
362
+ return PerformanceEvent.timedExecAsync(
363
+ this.mc.logger,
364
+ { eventName: "Request" },
365
+ async () => {
366
+ const resolved = await this.resolveCore(request);
367
+ return resolved.container.request({
368
+ ...request,
369
+ url: `${resolved.parsed.path}${resolved.parsed.query}`,
370
+ });
371
+ },
372
+ );
373
+ }
374
+
375
+ private getKeyForContainerCache(request: IRequest, parsedUrl: IParsedUrl): string {
376
+ const key =
377
+ request.headers?.[LoaderHeader.version] !== undefined
378
+ ? `${parsedUrl.id}@${request.headers[LoaderHeader.version]}`
379
+ : parsedUrl.id;
380
+ return key;
381
+ }
382
+
383
+ private addToContainerCache(key: string, containerP: Promise<Container>) {
384
+ this.containers.set(key, containerP);
385
+ containerP
386
+ .then((container) => {
387
+ // If the container is closed or becomes closed after we resolve it, remove it from the cache.
388
+ if (container.closed) {
389
+ this.containers.delete(key);
390
+ } else {
391
+ container.once("closed", () => {
392
+ this.containers.delete(key);
393
+ });
394
+ }
395
+ })
396
+ .catch((error) => {});
397
+ }
398
+
399
+ private async resolveCore(
400
+ request: IRequest,
401
+ pendingLocalState?: IPendingContainerState,
402
+ ): Promise<{ container: Container; parsed: IParsedUrl }> {
403
+ const resolvedAsFluid = await this.services.urlResolver.resolve(request);
404
+ ensureFluidResolvedUrl(resolvedAsFluid);
405
+
406
+ // Parse URL into data stores
407
+ const parsed = parseUrl(resolvedAsFluid.url);
408
+ if (parsed === undefined) {
409
+ throw new Error(`Invalid URL ${resolvedAsFluid.url}`);
410
+ }
411
+
412
+ if (pendingLocalState !== undefined) {
413
+ const parsedPendingUrl = parseUrl(pendingLocalState.url);
414
+ if (
415
+ parsedPendingUrl?.id !== parsed.id ||
416
+ parsedPendingUrl?.path.replace(/\/$/, "") !== parsed.path.replace(/\/$/, "")
417
+ ) {
418
+ const message = `URL ${resolvedAsFluid.url} does not match pending state URL ${pendingLocalState.url}`;
419
+ throw new Error(message);
420
+ }
421
+ }
422
+
423
+ const { canCache, fromSequenceNumber } = this.parseHeader(parsed, request);
424
+ const shouldCache = pendingLocalState !== undefined ? false : canCache;
425
+
426
+ let container: Container;
427
+ if (shouldCache) {
428
+ const key = this.getKeyForContainerCache(request, parsed);
429
+ const maybeContainer = await this.containers.get(key);
430
+ if (maybeContainer !== undefined) {
431
+ container = maybeContainer;
432
+ } else {
433
+ const containerP = this.loadContainer(request, resolvedAsFluid);
434
+ this.addToContainerCache(key, containerP);
435
+ container = await containerP;
436
+ }
437
+ } else {
438
+ container = await this.loadContainer(request, resolvedAsFluid, pendingLocalState);
439
+ }
440
+
441
+ if (container.deltaManager.lastSequenceNumber <= fromSequenceNumber) {
442
+ await new Promise<void>((resolve, reject) => {
443
+ function opHandler(message: ISequencedDocumentMessage) {
444
+ if (message.sequenceNumber > fromSequenceNumber) {
445
+ resolve();
446
+ container.removeListener("op", opHandler);
447
+ }
448
+ }
449
+
450
+ container.on("op", opHandler);
451
+ });
452
+ }
453
+
454
+ return { container, parsed };
455
+ }
456
+
457
+ private get cachingEnabled() {
458
+ return this.services.options.cache !== false;
459
+ }
460
+
461
+ private canCacheForRequest(headers: IRequestHeader): boolean {
462
+ return this.cachingEnabled && headers[LoaderHeader.cache] !== false;
463
+ }
464
+
465
+ private parseHeader(parsed: IParsedUrl, request: IRequest) {
466
+ let fromSequenceNumber = -1;
467
+
468
+ request.headers = request.headers ?? {};
469
+
470
+ const headerSeqNum = request.headers[LoaderHeader.sequenceNumber];
471
+ if (headerSeqNum !== undefined) {
472
+ fromSequenceNumber = headerSeqNum;
473
+ }
474
+
475
+ // If set in both query string and headers, use query string
476
+ request.headers[LoaderHeader.version] =
477
+ parsed.version ?? request.headers[LoaderHeader.version];
478
+
479
+ const canCache = this.canCacheForRequest(request.headers);
480
+
481
+ return {
482
+ canCache,
483
+ fromSequenceNumber,
484
+ };
485
+ }
486
+
487
+ private async loadContainer(
488
+ request: IRequest,
489
+ resolved: IFluidResolvedUrl,
490
+ pendingLocalState?: IPendingContainerState,
491
+ ): Promise<Container> {
492
+ return Container.load(
493
+ this,
494
+ {
495
+ canReconnect: request.headers?.[LoaderHeader.reconnect],
496
+ clientDetailsOverride: request.headers?.[LoaderHeader.clientDetails],
497
+ resolvedUrl: resolved,
498
+ version: request.headers?.[LoaderHeader.version] ?? undefined,
499
+ loadMode: request.headers?.[LoaderHeader.loadMode],
500
+ },
501
+ pendingLocalState,
502
+ this.protocolHandlerBuilder,
503
+ );
504
+ }
498
505
  }