@fluidframework/container-definitions 2.23.0 → 2.31.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.
- package/CHANGELOG.md +407 -389
- package/api-report/container-definitions.legacy.alpha.api.md +1 -0
- package/dist/loader.d.ts +3 -0
- package/dist/loader.d.ts.map +1 -1
- package/dist/loader.js.map +1 -1
- package/lib/loader.d.ts +3 -0
- package/lib/loader.d.ts.map +1 -1
- package/lib/loader.js.map +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +5 -8
- package/src/loader.ts +3 -0
- package/prettier.config.cjs +0 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# @fluidframework/container-definitions
|
|
2
2
|
|
|
3
|
+
## 2.31.0
|
|
4
|
+
|
|
5
|
+
Dependency updates only.
|
|
6
|
+
|
|
7
|
+
## 2.30.0
|
|
8
|
+
|
|
9
|
+
### Minor Changes
|
|
10
|
+
|
|
11
|
+
- IContainer.getContainerPackageInfo() is now deprecated ([#23840](https://github.com/microsoft/FluidFramework/pull/23840)) [521be72619](https://github.com/microsoft/FluidFramework/commit/521be726198a1f88f4f8f06c0f273528a49d2957)
|
|
12
|
+
|
|
13
|
+
The `IContainer.getContainerPackageInfo()` function is now deprecated. This API will be removed in version 2.40.0.
|
|
14
|
+
Use `IFluidCodeDetails.package` returned by `IContainer.getLoadedCodeDetails()` instead.
|
|
15
|
+
|
|
16
|
+
See [issue #23898](https://github.com/microsoft/FluidFramework/issues/23898) for details.
|
|
17
|
+
|
|
3
18
|
## 2.23.0
|
|
4
19
|
|
|
5
20
|
Dependency updates only.
|
|
@@ -12,10 +27,10 @@ Dependency updates only.
|
|
|
12
27
|
|
|
13
28
|
### Minor Changes
|
|
14
29
|
|
|
15
|
-
-
|
|
30
|
+
- The IContainerContext.supportedFeatures property is now deprecated ([#22877](https://github.com/microsoft/FluidFramework/pull/22877)) [4c06412bb3](https://github.com/microsoft/FluidFramework/commit/4c06412bb365d680430f83b87c456d132d9da1be)
|
|
16
31
|
|
|
17
|
-
|
|
18
|
-
|
|
32
|
+
The `IContainerContext.supportedFeatures` optional property was used internally to communicate features supported by the
|
|
33
|
+
Loader layer to the Runtime layer. This has since been replaced with functionality that is not exposed externally.
|
|
19
34
|
|
|
20
35
|
## 2.20.0
|
|
21
36
|
|
|
@@ -37,19 +52,19 @@ Dependency updates only.
|
|
|
37
52
|
|
|
38
53
|
### Minor Changes
|
|
39
54
|
|
|
40
|
-
-
|
|
55
|
+
- The inbound and outbound properties have been removed from IDeltaManager ([#22282](https://github.com/microsoft/FluidFramework/pull/22282)) [45a57693f2](https://github.com/microsoft/FluidFramework/commit/45a57693f291e0dc5e91af7f29a9b9c8f82dfad5)
|
|
41
56
|
|
|
42
|
-
|
|
57
|
+
The inbound and outbound properties were [deprecated in version 2.0.0-rc.2.0.0](https://github.com/microsoft/FluidFramework/blob/main/RELEASE_NOTES/2.0.0-rc.2.0.0.md#container-definitions-deprecate-ideltamanagerinbound-and-ideltamanageroutbound) and have been removed from `IDeltaManager`.
|
|
43
58
|
|
|
44
|
-
|
|
59
|
+
`IDeltaManager.inbound` contained functionality that could break core runtime features such as summarization and processing batches if used improperly. Data loss or corruption could occur when `IDeltaManger.inbound.pause()` or `IDeltaManager.inbound.resume()` were called.
|
|
45
60
|
|
|
46
|
-
|
|
61
|
+
Similarly, `IDeltaManager.outbound` contained functionality that could break core runtime features such as generation of batches and chunking. Data loss or corruption could occur when `IDeltaManger.inbound.pause()` or `IDeltaManager.inbound.resume()` were called.
|
|
47
62
|
|
|
48
|
-
|
|
63
|
+
#### Alternatives
|
|
49
64
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
65
|
+
- Alternatives to `IDeltaManager.inbound.on("op", ...)` are `IDeltaManager.on("op", ...)`
|
|
66
|
+
- Alternatives to calling `IDeltaManager.inbound.pause`, `IDeltaManager.outbound.pause` for `IContainer` disconnect use `IContainer.disconnect`.
|
|
67
|
+
- Alternatives to calling `IDeltaManager.inbound.resume`, `IDeltaManager.outbound.resume` for `IContainer` reconnect use `IContainer.connect`.
|
|
53
68
|
|
|
54
69
|
## 2.5.0
|
|
55
70
|
|
|
@@ -75,241 +90,241 @@ Dependency updates only.
|
|
|
75
90
|
|
|
76
91
|
### Minor Changes
|
|
77
92
|
|
|
78
|
-
-
|
|
93
|
+
- Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
|
|
79
94
|
|
|
80
|
-
|
|
95
|
+
Update package implementations to use TypeScript 5.4.5.
|
|
81
96
|
|
|
82
97
|
## 2.0.0-rc.4.0.0
|
|
83
98
|
|
|
84
99
|
### Major Changes
|
|
85
100
|
|
|
86
|
-
-
|
|
101
|
+
- Audience & connection sequencing improvements [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
|
|
87
102
|
|
|
88
|
-
|
|
103
|
+
Here are breaking changes in Audience behavior:
|
|
89
104
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
105
|
+
1. IAudience no longer implements EventEmmiter. If you used addListener() or removeListener(), please replace with on() & off() respectively.
|
|
106
|
+
2. IAudience interface implements getSelf() method and "selfChanged" event.
|
|
107
|
+
3. IContainerContext.audience is no longer optional
|
|
108
|
+
4. "connected" events are now raised (various API surfaces - IContainer, IContainerRuntime, IFluidDataStoreRuntime, etc.) a bit later in reconnection sequence for "read" connections - only after client receives its own "join" signal and caught up on ops, which makes it symmetrical with "write" connections.
|
|
94
109
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
110
|
+
- If this change in behavior breaks some scenario, please let us know immediately, but you can revert that behavior using the following feature gates:
|
|
111
|
+
- "Fluid.Container.DisableCatchUpBeforeDeclaringConnected"
|
|
112
|
+
- "Fluid.Container.DisableJoinSignalWait"
|
|
98
113
|
|
|
99
114
|
### Minor Changes
|
|
100
115
|
|
|
101
|
-
-
|
|
116
|
+
- Type Erase IFluidDataStoreRuntime.deltaManager [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
|
|
102
117
|
|
|
103
|
-
|
|
104
|
-
|
|
118
|
+
Make IFluidDataStoreRuntime.deltaManager have an opaque type.
|
|
119
|
+
Marks the following types which were reachable from it as alpha:
|
|
105
120
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
121
|
+
- IConnectionDetails
|
|
122
|
+
- IDeltaSender
|
|
123
|
+
- IDeltaManagerEvents
|
|
124
|
+
- IDeltaManager
|
|
125
|
+
- IDeltaQueueEvents
|
|
126
|
+
- IDeltaQueue
|
|
127
|
+
- ReadOnlyInfo
|
|
113
128
|
|
|
114
|
-
|
|
129
|
+
As a temporary workaround, users needing access to the full delta manager API can use the `@alpha` `toDeltaManagerInternal` API to retrieve its members, but should migrate away from requiring access to those APIs.
|
|
115
130
|
|
|
116
|
-
|
|
131
|
+
Implementing a custom `IFluidDataStoreRuntime` is not supported: this is now indicated by it being marked with `@sealed`.
|
|
117
132
|
|
|
118
133
|
## 2.0.0-rc.3.0.0
|
|
119
134
|
|
|
120
135
|
### Major Changes
|
|
121
136
|
|
|
122
|
-
-
|
|
137
|
+
- container-definitions: IContainerContext.getSpecifiedCodeDetails() removed [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
123
138
|
|
|
124
|
-
|
|
139
|
+
IContainerContext.getSpecifiedCodeDetails() was deprecated in 0.42 and has now been removed.
|
|
125
140
|
|
|
126
|
-
-
|
|
141
|
+
- Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
127
142
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
143
|
+
Fluid Framework packages have been updated to use the [package.json "exports"
|
|
144
|
+
field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
|
|
145
|
+
TypeScript types and implementation code.
|
|
131
146
|
|
|
132
|
-
|
|
147
|
+
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
133
148
|
|
|
134
|
-
|
|
135
|
-
|
|
149
|
+
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
150
|
+
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
136
151
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
152
|
+
We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
|
|
153
|
+
for use with modern versions of Node.js _and_ Bundlers.
|
|
154
|
+
[See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
|
|
155
|
+
regarding the module and moduleResolution options.
|
|
141
156
|
|
|
142
|
-
|
|
143
|
-
|
|
157
|
+
**Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
|
|
158
|
+
to distinguish stable APIs from those that are in development.**
|
|
144
159
|
|
|
145
160
|
## 2.0.0-rc.2.0.0
|
|
146
161
|
|
|
147
162
|
### Minor Changes
|
|
148
163
|
|
|
149
|
-
-
|
|
164
|
+
- container-definitions: Deprecate IDeltaManager.inbound and IDeltaManager.outbound ([#19636](https://github.com/microsoft/FluidFramework/issues/19636)) [305c0f4346](https://github.com/microsoft/FluidFramework/commits/305c0f4346d08cba3d345d9698e35c0a1517b31a)
|
|
150
165
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
166
|
+
`IDeltaManager.inbound` was deprecated because it was not very useful to the customer and there are pieces of
|
|
167
|
+
functionality that can break the core runtime if used improperly. For example, summarization and processing batches. Do
|
|
168
|
+
not use the apis on this if possible. Data loss/corruption may occur in these scenarios in which
|
|
169
|
+
`IDeltaManger.inbound.pause()` or `IDeltaManager.inbound.resume()` get called.
|
|
155
170
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
171
|
+
Deprecated `IDeltaManager.outbound` as it was not very useful to the customer and there are pieces of functionality
|
|
172
|
+
that can break the core runtime if used improperly. For example, generation of batches and chunking. Op batching and
|
|
173
|
+
chunking can be broken. Data loss/corruption may occur in these scenarios in which `IDeltaManger.inbound.pause()` or
|
|
174
|
+
`IDeltaManager.inbound.resume()` get called.
|
|
160
175
|
|
|
161
|
-
|
|
176
|
+
### Alternatives
|
|
162
177
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
178
|
+
- Alternatives to `IDeltaManager.inbound.on("op", ...)` are `IDeltaManager.on("op", ...)`
|
|
179
|
+
- Alternatives to calling `IDeltaManager.inbound.pause`, `IDeltaManager.outbound.pause` for `IContainer` disconnect
|
|
180
|
+
use `IContainer.disconnect`.
|
|
181
|
+
- Alternatives to calling `IDeltaManager.inbound.resume`, `IDeltaManager.outbound.resume` for `IContainer` reconnect
|
|
182
|
+
use `IContainer.connect`.
|
|
168
183
|
|
|
169
|
-
-
|
|
184
|
+
- container-loader: Behavior change: IContainer.attach will be made retriable in the next release ([#19246](https://github.com/microsoft/FluidFramework/issues/19246)) [3d5dfb28d4](https://github.com/microsoft/FluidFramework/commits/3d5dfb28d47b55943c6a92ec50530e6fa86b0568)
|
|
170
185
|
|
|
171
|
-
|
|
186
|
+
The `attach` function on IContainer has been modified such that the container stay open on non-fatal errors. On failure of attach the developer should inspect IContainer.closed to see if the container has been closed. If not closed, the developer can retry calling attach.
|
|
172
187
|
|
|
173
|
-
|
|
188
|
+
The functionality is currently behind a configuration `Fluid.Container.RetryOnAttachFailure` which can be set to `true` to enable the new functionality.
|
|
174
189
|
|
|
175
|
-
|
|
190
|
+
In the next release we will default to the new behavior, and it will be possible to disable this behavior by setting `Fluid.Container.RetryOnAttachFailure` to `false`
|
|
176
191
|
|
|
177
|
-
-
|
|
192
|
+
- driver-definitions: Deprecate `ISnapshotContents` ([#19314](https://github.com/microsoft/FluidFramework/issues/19314)) [fc731b69de](https://github.com/microsoft/FluidFramework/commits/fc731b69deed4a2987e9b97d8918492d689bafbc)
|
|
178
193
|
|
|
179
|
-
|
|
194
|
+
`ISnapshotContents` is deprecated. It has been replaced with `ISnapshot`.
|
|
180
195
|
|
|
181
|
-
-
|
|
196
|
+
- driver-definitions: repositoryUrl removed from IDocumentStorageService ([#19522](https://github.com/microsoft/FluidFramework/issues/19522)) [90eb3c9d33](https://github.com/microsoft/FluidFramework/commits/90eb3c9d33d80e24caa1393a50f414c5602f6aa3)
|
|
182
197
|
|
|
183
|
-
|
|
198
|
+
The `repositoryUrl` member of `IDocumentStorageService` was unused and always equal to the empty string. It has been removed.
|
|
184
199
|
|
|
185
|
-
-
|
|
200
|
+
- Deprecated error-related enums have been removed ([#19067](https://github.com/microsoft/FluidFramework/issues/19067)) [59793302e5](https://github.com/microsoft/FluidFramework/commits/59793302e56784cfb6ace0e6469345f3565b3312)
|
|
186
201
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
202
|
+
Error-related enums `ContainerErrorType`, `DriverErrorType`, `OdspErrorType` and `RouterliciousErrorType` were previously
|
|
203
|
+
deprecated and are now removed. There are replacement object-based enumerations of `ContainerErrorTypes`,
|
|
204
|
+
`DriverErrorTypes`, `OdspErrorTypes` and `RouterliciousErrorTypes`. Refer to the release notes of [Fluid Framework version
|
|
205
|
+
2.0.0-internal.7.0.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.7.0.0) for details
|
|
206
|
+
on the replacements.
|
|
192
207
|
|
|
193
|
-
-
|
|
208
|
+
- container-definitions: ILoaderOptions no longer accepts arbitrary key/value pairs ([#19306](https://github.com/microsoft/FluidFramework/issues/19306)) [741926e225](https://github.com/microsoft/FluidFramework/commits/741926e2253a161504ecc6a6451d8f15d7ac4ed6)
|
|
194
209
|
|
|
195
|
-
|
|
210
|
+
ILoaderOptions has been narrowed to the specific set of supported loader options, and may no longer be used to pass arbitrary key/value pairs through to the runtime.
|
|
196
211
|
|
|
197
|
-
-
|
|
212
|
+
- container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
|
|
198
213
|
|
|
199
|
-
|
|
214
|
+
Added `containerMetadata` prop on IContainer interface.
|
|
200
215
|
|
|
201
|
-
-
|
|
216
|
+
- runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
|
|
202
217
|
|
|
203
|
-
|
|
218
|
+
The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
|
|
204
219
|
|
|
205
|
-
-
|
|
220
|
+
- Updated @fluidframework/protocol-definitions [c2791deb24](https://github.com/microsoft/FluidFramework/commits/c2791deb249e8bd03cfe2b735785bba19e7bf838)
|
|
206
221
|
|
|
207
|
-
|
|
222
|
+
The @fluidframework/protocol-definitions dependency has been upgraded to v3.2.0.
|
|
208
223
|
|
|
209
|
-
|
|
224
|
+
[See the full changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#320)
|
|
210
225
|
|
|
211
|
-
-
|
|
226
|
+
- Updated server dependencies [c2791deb24](https://github.com/microsoft/FluidFramework/commits/c2791deb249e8bd03cfe2b735785bba19e7bf838)
|
|
212
227
|
|
|
213
|
-
|
|
214
|
-
|
|
228
|
+
The following Fluid server dependencies have been updated to the latest version, 4.0.0.
|
|
229
|
+
[See the full changelog.](https://github.com/microsoft/FluidFramework/blob/main/server/routerlicious/RELEASE_NOTES/3.0.0.md)
|
|
215
230
|
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
231
|
+
- @fluidframework/gitresources
|
|
232
|
+
- @fluidframework/server-kafka-orderer
|
|
233
|
+
- @fluidframework/server-lambdas
|
|
234
|
+
- @fluidframework/server-lambdas-driver
|
|
235
|
+
- @fluidframework/server-local-server
|
|
236
|
+
- @fluidframework/server-memory-orderer
|
|
237
|
+
- @fluidframework/protocol-base
|
|
238
|
+
- @fluidframework/server-routerlicious
|
|
239
|
+
- @fluidframework/server-routerlicious-base
|
|
240
|
+
- @fluidframework/server-services
|
|
241
|
+
- @fluidframework/server-services-client
|
|
242
|
+
- @fluidframework/server-services-core
|
|
243
|
+
- @fluidframework/server-services-ordering-kafkanode
|
|
244
|
+
- @fluidframework/server-services-ordering-rdkafka
|
|
245
|
+
- @fluidframework/server-services-ordering-zookeeper
|
|
246
|
+
- @fluidframework/server-services-shared
|
|
247
|
+
- @fluidframework/server-services-telemetry
|
|
248
|
+
- @fluidframework/server-services-utils
|
|
249
|
+
- @fluidframework/server-test-utils
|
|
250
|
+
- tinylicious
|
|
236
251
|
|
|
237
252
|
## 2.0.0-rc.1.0.0
|
|
238
253
|
|
|
239
254
|
### Minor Changes
|
|
240
255
|
|
|
241
|
-
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
256
|
+
- Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
257
|
+
|
|
258
|
+
The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
|
|
259
|
+
|
|
260
|
+
- @fluidframework/gitresources
|
|
261
|
+
- @fluidframework/server-kafka-orderer
|
|
262
|
+
- @fluidframework/server-lambdas
|
|
263
|
+
- @fluidframework/server-lambdas-driver
|
|
264
|
+
- @fluidframework/server-local-server
|
|
265
|
+
- @fluidframework/server-memory-orderer
|
|
266
|
+
- @fluidframework/protocol-base
|
|
267
|
+
- @fluidframework/server-routerlicious
|
|
268
|
+
- @fluidframework/server-routerlicious-base
|
|
269
|
+
- @fluidframework/server-services
|
|
270
|
+
- @fluidframework/server-services-client
|
|
271
|
+
- @fluidframework/server-services-core
|
|
272
|
+
- @fluidframework/server-services-ordering-kafkanode
|
|
273
|
+
- @fluidframework/server-services-ordering-rdkafka
|
|
274
|
+
- @fluidframework/server-services-ordering-zookeeper
|
|
275
|
+
- @fluidframework/server-services-shared
|
|
276
|
+
- @fluidframework/server-services-telemetry
|
|
277
|
+
- @fluidframework/server-services-utils
|
|
278
|
+
- @fluidframework/server-test-utils
|
|
279
|
+
- tinylicious
|
|
280
|
+
|
|
281
|
+
- Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
282
|
+
|
|
283
|
+
The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
|
|
284
|
+
changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
|
|
270
285
|
|
|
271
286
|
## 2.0.0-internal.8.0.0
|
|
272
287
|
|
|
273
288
|
### Major Changes
|
|
274
289
|
|
|
275
|
-
-
|
|
290
|
+
- container-definitions: Removed request(...) and IFluidRouter from IContainer [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
276
291
|
|
|
277
|
-
|
|
278
|
-
|
|
292
|
+
The `request(...)` method and `IFluidRouter` property have been removed from `IContainer`. Please use the
|
|
293
|
+
`IContainer.getEntryPoint()` method to get the container's entry point.
|
|
279
294
|
|
|
280
|
-
|
|
295
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
|
|
281
296
|
|
|
282
|
-
-
|
|
297
|
+
- container-loader: Removed request(...) and IFluidRouter from ILoader and Loader [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
283
298
|
|
|
284
|
-
|
|
285
|
-
|
|
299
|
+
The `request(...)` method and `IFluidRouter` property have been removed from `ILoader` and `Loader`. Instead, after
|
|
300
|
+
calling `ILoader.resolve(...)`, call the `getEntryPoint()` method on the returned `IContainer`.
|
|
286
301
|
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
302
|
+
See
|
|
303
|
+
[Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
304
|
+
for more details.
|
|
290
305
|
|
|
291
|
-
-
|
|
306
|
+
- container-runtime: Removed IPendingLocalState and IRuntime.notifyAttaching [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
292
307
|
|
|
293
|
-
|
|
294
|
-
|
|
308
|
+
The deprecated `IPendingLocalState` and `IRuntime.notifyAttaching` APIs are removed. There is no replacement as they are
|
|
309
|
+
not longer used.
|
|
295
310
|
|
|
296
|
-
-
|
|
311
|
+
- container-runtime: Removed request pattern from ContainerRuntime, IRuntime, and IContainerRuntimeBase [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
297
312
|
|
|
298
|
-
|
|
313
|
+
The `request(...)` method and `IFluidRouter` property have been removed from the following places:
|
|
299
314
|
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
315
|
+
- `ContainerRuntime`
|
|
316
|
+
- `IRuntime`
|
|
317
|
+
- `IContainerRuntimeBase`
|
|
303
318
|
|
|
304
|
-
|
|
319
|
+
Please use the `IRuntime.getEntryPoint()` method to get the runtime's entry point.
|
|
305
320
|
|
|
306
|
-
|
|
321
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
|
|
307
322
|
|
|
308
|
-
-
|
|
323
|
+
- container-definitions: Fix ISnapshotTreeWithBlobContents and mark internal [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
309
324
|
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
325
|
+
`ISnapshotTreeWithBlobContents` is an internal type that should not be used externally. Additionally, the type didn't
|
|
326
|
+
match the usage, specifically in runtime-utils where an `any` cast was used to work around undefined blobContents. The
|
|
327
|
+
type has been updated to reflect that blobContents can be undefined.
|
|
313
328
|
|
|
314
329
|
## 2.0.0-internal.7.4.0
|
|
315
330
|
|
|
@@ -331,85 +346,88 @@ Dependency updates only.
|
|
|
331
346
|
|
|
332
347
|
### Major Changes
|
|
333
348
|
|
|
334
|
-
-
|
|
349
|
+
- odsp-driver: Load container in readonly mode when driver throws DriverErrorType.outOfStorage [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
335
350
|
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
351
|
+
Handle DriverErrorType.outOfStorage error from driver and load the container in readonly mode. Currently there is no
|
|
352
|
+
handling and when the join session throws this error, the container will get closed. With this we use NoDeltaStream
|
|
353
|
+
object as connection and load the container in read mode, so that it loads properly. We also notify the that the
|
|
354
|
+
container is "readonly" through the event on delta manager so that apps can listen to this and show any UX etc. The app
|
|
355
|
+
can listen to the event like this:
|
|
341
356
|
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
357
|
+
```ts
|
|
358
|
+
container.deltaManager.on(
|
|
359
|
+
"readonly",
|
|
360
|
+
(
|
|
361
|
+
readonly?: boolean,
|
|
362
|
+
readonlyConnectionReason?: { text: string; error?: IErrorBase },
|
|
363
|
+
) => {
|
|
364
|
+
// error?.errorType will be equal to DriverErrorType.outOfStorage in this case
|
|
365
|
+
// App logic
|
|
366
|
+
},
|
|
367
|
+
);
|
|
368
|
+
```
|
|
351
369
|
|
|
352
|
-
-
|
|
370
|
+
- Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
353
371
|
|
|
354
|
-
|
|
372
|
+
This included the following changes from the protocol-definitions release:
|
|
355
373
|
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
374
|
+
- Updating signal interfaces for some planned improvements. The intention is split the interface between signals
|
|
375
|
+
submitted by clients to the server and the resulting signals sent from the server to clients.
|
|
376
|
+
- A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
|
|
377
|
+
been added, which will be the typing for signals sent from the client to the server. Both extend a new
|
|
378
|
+
ISignalMessageBase interface that contains common members.
|
|
379
|
+
- The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
|
|
362
380
|
|
|
363
|
-
-
|
|
381
|
+
- container-definitions: IContainer's and IDataStore's IFluidRouter capabilities are deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
364
382
|
|
|
365
|
-
|
|
383
|
+
`IFluidRouter` and `request({ url: "/" })` on `IContainer` and `IDataStore` are deprecated and will be removed in a future major release. Please migrate all usage to the appropriate `getEntryPoint()` or `entryPoint` APIs.
|
|
366
384
|
|
|
367
|
-
|
|
385
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
|
|
368
386
|
|
|
369
|
-
-
|
|
387
|
+
- Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
370
388
|
|
|
371
|
-
|
|
389
|
+
Dependencies on the following Fluid server package have been updated to version 2.0.1:
|
|
372
390
|
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
391
|
+
- @fluidframework/gitresources: 2.0.1
|
|
392
|
+
- @fluidframework/server-kafka-orderer: 2.0.1
|
|
393
|
+
- @fluidframework/server-lambdas: 2.0.1
|
|
394
|
+
- @fluidframework/server-lambdas-driver: 2.0.1
|
|
395
|
+
- @fluidframework/server-local-server: 2.0.1
|
|
396
|
+
- @fluidframework/server-memory-orderer: 2.0.1
|
|
397
|
+
- @fluidframework/protocol-base: 2.0.1
|
|
398
|
+
- @fluidframework/server-routerlicious: 2.0.1
|
|
399
|
+
- @fluidframework/server-routerlicious-base: 2.0.1
|
|
400
|
+
- @fluidframework/server-services: 2.0.1
|
|
401
|
+
- @fluidframework/server-services-client: 2.0.1
|
|
402
|
+
- @fluidframework/server-services-core: 2.0.1
|
|
403
|
+
- @fluidframework/server-services-ordering-kafkanode: 2.0.1
|
|
404
|
+
- @fluidframework/server-services-ordering-rdkafka: 2.0.1
|
|
405
|
+
- @fluidframework/server-services-ordering-zookeeper: 2.0.1
|
|
406
|
+
- @fluidframework/server-services-shared: 2.0.1
|
|
407
|
+
- @fluidframework/server-services-telemetry: 2.0.1
|
|
408
|
+
- @fluidframework/server-services-utils: 2.0.1
|
|
409
|
+
- @fluidframework/server-test-utils: 2.0.1
|
|
410
|
+
- tinylicious: 2.0.1
|
|
393
411
|
|
|
394
|
-
-
|
|
412
|
+
- test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
395
413
|
|
|
396
|
-
|
|
414
|
+
The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
|
|
397
415
|
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
416
|
+
- `BaseContainerRuntimeFactory`
|
|
417
|
+
- `RuntimeFactory`
|
|
418
|
+
- `ContainerRuntime` (constructor and `loadRuntime`)
|
|
419
|
+
- `FluidDataStoreRuntime`
|
|
402
420
|
|
|
403
|
-
|
|
404
|
-
|
|
421
|
+
See [testContainerRuntimeFactoryWithDefaultDataStore.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/test/test-utils/src/testContainerRuntimeFactoryWithDefaultDataStore.ts) for an example implemtation of `provideEntryPoint` for ContainerRuntime.
|
|
422
|
+
See [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L83) for an example implementation of `provideEntryPoint` for DataStoreRuntime.
|
|
405
423
|
|
|
406
|
-
|
|
424
|
+
Subsequently, various `entryPoint` and `getEntryPoint()` endpoints have become required. Please see [containerRuntime.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/containerRuntime.ts) for example implementations of these APIs.
|
|
407
425
|
|
|
408
|
-
|
|
426
|
+
For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
409
427
|
|
|
410
|
-
-
|
|
428
|
+
- Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
411
429
|
|
|
412
|
-
|
|
430
|
+
The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
|
|
413
431
|
|
|
414
432
|
## 2.0.0-internal.6.4.0
|
|
415
433
|
|
|
@@ -423,39 +441,39 @@ Dependency updates only.
|
|
|
423
441
|
|
|
424
442
|
### Minor Changes
|
|
425
443
|
|
|
426
|
-
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
444
|
+
- Temporarily restore id property on IContainerContext ([#16846](https://github.com/microsoft/FluidFramework/issues/16846)) [9825a692dd](https://github.com/microsoft/FluidFramework/commits/9825a692dd27eded214e3978a7fd6028b05e6fab)
|
|
445
|
+
|
|
446
|
+
The `id` property on `IContainerContext` has been temporarily restored to ease the transition to `2.0.0-internal.6.x`.
|
|
447
|
+
It will be removed again in `2.0.0-internal.7.0.0`.
|
|
448
|
+
|
|
449
|
+
The original deprecation announcement can be found [here](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.5.2.0).
|
|
450
|
+
|
|
451
|
+
- Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
|
|
452
|
+
|
|
453
|
+
The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
|
|
454
|
+
imported from the **@fluidframework/core-interfaces** package:
|
|
455
|
+
|
|
456
|
+
- interface IDisposable
|
|
457
|
+
- interface IErrorEvent
|
|
458
|
+
- interface IErrorEvent
|
|
459
|
+
- interface IEvent
|
|
460
|
+
- interface IEventProvider
|
|
461
|
+
- interface ILoggingError
|
|
462
|
+
- interface ITaggedTelemetryPropertyType
|
|
463
|
+
- interface ITelemetryBaseEvent
|
|
464
|
+
- interface ITelemetryBaseLogger
|
|
465
|
+
- interface ITelemetryErrorEvent
|
|
466
|
+
- interface ITelemetryGenericEvent
|
|
467
|
+
- interface ITelemetryLogger
|
|
468
|
+
- interface ITelemetryPerformanceEvent
|
|
469
|
+
- interface ITelemetryProperties
|
|
470
|
+
- type ExtendEventProvider
|
|
471
|
+
- type IEventThisPlaceHolder
|
|
472
|
+
- type IEventTransformer
|
|
473
|
+
- type ReplaceIEventThisPlaceHolder
|
|
474
|
+
- type ReplaceIEventThisPlaceHolder
|
|
475
|
+
- type TelemetryEventCategory
|
|
476
|
+
- type TelemetryEventPropertyType
|
|
459
477
|
|
|
460
478
|
## 2.0.0-internal.6.1.0
|
|
461
479
|
|
|
@@ -465,217 +483,217 @@ Dependency updates only.
|
|
|
465
483
|
|
|
466
484
|
### Major Changes
|
|
467
485
|
|
|
468
|
-
-
|
|
486
|
+
- Removed IContainerContext.existing [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
469
487
|
|
|
470
|
-
|
|
488
|
+
The recommended means of checking for existing changed to the instantiateRuntime param in 2021, and the IContainerContext.existing member was formally deprecated in 2.0.0-internal.2.0.0. This member is now removed.
|
|
471
489
|
|
|
472
|
-
-
|
|
490
|
+
- Remove closeAndGetPendingLocalState from IContainer [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
473
491
|
|
|
474
|
-
|
|
475
|
-
|
|
492
|
+
This change removes the deprecated and experimental method closeAndGetPendingLocalState from IContainer. It continues to
|
|
493
|
+
exist on IContainerExperimental.
|
|
476
494
|
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
495
|
+
IContainerExperimental is an interface that is easily casted to, which enables partners to access experimental features for testing and evaluation.
|
|
496
|
+
Moving the experimental method off IContainer will reduce exposure and churn on that production interface as we iterate
|
|
497
|
+
on and finalize our experimental features.
|
|
480
498
|
|
|
481
|
-
|
|
499
|
+
Experimental features should not be used in production environments.
|
|
482
500
|
|
|
483
|
-
-
|
|
501
|
+
- allSentOpsAckd and processTime events removed from IDeltaManagerEvents [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
484
502
|
|
|
485
|
-
|
|
503
|
+
The "allSentOpsAckd" and "processTime" events on the IDeltaManagerEvents interface were deprecated in 2.0.0-internal.2.2.0 and have now been removed.
|
|
486
504
|
|
|
487
|
-
-
|
|
505
|
+
- IConnectionDetailsInternal and IDeltaHandlerStrategy removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
488
506
|
|
|
489
|
-
|
|
507
|
+
IConnectionDetailsInternal and IDeltaHandlerStrategy from the @fluidframework/container-definitions package were deprecated in 2.0.0-internal.5.2.0 and have now been removed.
|
|
490
508
|
|
|
491
|
-
-
|
|
509
|
+
- Request APIs deprecated from many places [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
492
510
|
|
|
493
|
-
|
|
511
|
+
The `request` API (associated with the `IFluidRouter` interface) has been deprecated on a number of classes and interfaces. The following are impacted:
|
|
494
512
|
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
513
|
+
- `IRuntime` and `ContainerRuntime`
|
|
514
|
+
- `IFluidDataStoreRuntime` and `FluidDataStoreRuntime`
|
|
515
|
+
- `IFluidDataStoreChannel`
|
|
516
|
+
- `MockFluidDataStoreRuntime`
|
|
517
|
+
- `TestFluidObject`
|
|
500
518
|
|
|
501
|
-
|
|
519
|
+
Please migrate usage to the corresponding `entryPoint` or `getEntryPoint()` of the object. The value for these "entryPoint" related APIs is determined from factories (for `IRuntime` and `IFluidDataStoreRuntime`) via the `initializeEntryPoint` method. If no method is passed to the factory, the corresponding `entryPoint` and `getEntryPoint()` will be undefined.
|
|
502
520
|
|
|
503
|
-
|
|
521
|
+
For an example implementation of `initializeEntryPoint`, see [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/blob/next/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L84).
|
|
504
522
|
|
|
505
|
-
|
|
523
|
+
More information of the migration off the request pattern, and current status of its removal, is documented in [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md).
|
|
506
524
|
|
|
507
|
-
-
|
|
525
|
+
- IContainer's and IDataStore's IFluidRouter capabilities are deprecated. [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
508
526
|
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
527
|
+
- The `request` function taking an arbitrary URL and headers is deprecated
|
|
528
|
+
- However, an overload taking only `{ url: "/" }` is not, for back-compat purposes during the migration
|
|
529
|
+
from the request pattern to using entryPoint.
|
|
512
530
|
|
|
513
|
-
|
|
531
|
+
### About requesting "/" and using entryPoint
|
|
514
532
|
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
533
|
+
Requesting "/" is an idiom some consumers of Fluid Framework have used in their own `requestHandler`s
|
|
534
|
+
(passed to `ContainerRuntime.loadRuntime` and `FluidDataStoreRuntime`'s constructor).
|
|
535
|
+
The ability to access the "root" or "entry point" of a Container / DataStore will presently be provided by
|
|
536
|
+
`IContainer.getEntryPoint` and `IDataStore.entryPoint`. However these are still optional, so a temporary workaround is needed.
|
|
519
537
|
|
|
520
|
-
|
|
521
|
-
|
|
538
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
539
|
+
for more info on this transition from request to entryPoint.
|
|
522
540
|
|
|
523
|
-
|
|
541
|
+
### Present Replacement for requesting an arbitrary URL
|
|
524
542
|
|
|
525
|
-
|
|
543
|
+
Suppose you have these variables:
|
|
526
544
|
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
545
|
+
```ts
|
|
546
|
+
const container: IContainer = ...;
|
|
547
|
+
const dataStore: IDataStore = ...;
|
|
548
|
+
```
|
|
531
549
|
|
|
532
|
-
|
|
550
|
+
Before:
|
|
533
551
|
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
552
|
+
```ts
|
|
553
|
+
container.request({ url, headers });
|
|
554
|
+
dataStore.request({ url, headers });
|
|
555
|
+
```
|
|
538
556
|
|
|
539
|
-
|
|
557
|
+
After:
|
|
540
558
|
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
559
|
+
```ts
|
|
560
|
+
// Assume there is an interface like this in the app's Container implementation
|
|
561
|
+
interface CustomUrlRouter {
|
|
562
|
+
doRequestRouting(request: { url: string; headers: Record<string, any>; }): any;
|
|
563
|
+
}
|
|
546
564
|
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
565
|
+
// Prerequisite: Pass a requestHandler to ContainerRuntime.loadRuntime that routes "/"
|
|
566
|
+
// to some root object implementing CustomUrlRouter
|
|
567
|
+
const containerRouter: CustomUrlRouter = await container.request({ "/" });
|
|
568
|
+
containerRouter.doRequestRouting({ url, headers });
|
|
551
569
|
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
570
|
+
// Prerequisite: Pass a requestHandler to FluidDataStoreRuntime's constructor that routes "/"
|
|
571
|
+
// to some root object implementing CustomUrlRouter
|
|
572
|
+
const dataStoreRouter: CustomUrlRouter = await dataStore.request({ "/" });
|
|
573
|
+
dataStoreRouter.doRequestRouting({ url, headers });
|
|
574
|
+
```
|
|
557
575
|
|
|
558
|
-
|
|
576
|
+
### Looking ahead to using entryPoint
|
|
559
577
|
|
|
560
|
-
|
|
561
|
-
|
|
578
|
+
In the next major release, `getEntryPoint` and `entryPoint` should be mandatory and available for use.
|
|
579
|
+
Then you may replace each call `request({ url: "/" })` with a call to get the entryPoint using these functions/properties.
|
|
562
580
|
|
|
563
|
-
-
|
|
581
|
+
- Loader container caching off by default [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
564
582
|
|
|
565
|
-
|
|
583
|
+
Loader container caching will now be off by default and the ability to control it is deprecated. Loader caching is deprecated and will be removed in a future release, as well as all caching functionality of containers. Please try not to rely on caching and inform us if you cannot do so.
|
|
566
584
|
|
|
567
|
-
|
|
585
|
+
If you run into trouble with this behavior, please report it ASAP to the FluidFramework team and use the following options (available in this release only) to unblock you:
|
|
568
586
|
|
|
569
|
-
|
|
570
|
-
|
|
587
|
+
- set `ILoaderProps.options.cache` to `true` when constructing a `Loader` object (see the `ILoaderOptions` interface)
|
|
588
|
+
- set `[LoaderHeader.cache]` header to `true` when requesting a container
|
|
571
589
|
|
|
572
|
-
-
|
|
590
|
+
- contextChanged event on IContainerEvents removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
573
591
|
|
|
574
|
-
|
|
592
|
+
The contextChanged event on IContainerEvents was deprecated in 2.0.0-internal.2.2.0 and has now been removed.
|
|
575
593
|
|
|
576
|
-
-
|
|
594
|
+
- ICodeAllowList interface removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
577
595
|
|
|
578
|
-
|
|
596
|
+
The ICodeAllowList interface was deprecated in 2.0.0-internal.3.2.0 and has now been removed.
|
|
579
597
|
|
|
580
|
-
-
|
|
598
|
+
- getPendingLocalState and closeAndGetPendingLocalState are now async [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
581
599
|
|
|
582
|
-
|
|
600
|
+
getPendingLocalState and closeAndGetPendingLocalState are now async to allow uploading blobs to attach to a DDS (in closing scenario). There is a new parameter in those methods at the container/runtime layer "notifyImminentClosure" which is true only when closing and ensures uploading blobs fast resolve and get attached. Once we apply stashed ops to new container, blob will try to reupload and we will know where to place its references.
|
|
583
601
|
|
|
584
|
-
-
|
|
602
|
+
- Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
585
603
|
|
|
586
|
-
|
|
604
|
+
Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
|
|
587
605
|
|
|
588
|
-
-
|
|
606
|
+
- `Loader.resolve()` throws if `LoaderHeader.sequenceNumber` and `IContainerLoadMode.opsBeforeReturn` do not match [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
589
607
|
|
|
590
|
-
|
|
608
|
+
Calling `Loader.resolve()` will now throw an error if `LoaderHeader.sequenceNumber` is defined but `IContainerLoadMode.opsBeforeReturn` is not set to "sequenceNumber". Vice versa, `Loader.resolve()` will also throw an error if `IContainerLoadMode.opsBeforeReturn` is set to "sequenceNumber" but `LoaderHeader.sequenceNumber` is not defined.
|
|
591
609
|
|
|
592
|
-
-
|
|
610
|
+
- IDeltaManager members disposed and dispose() removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
593
611
|
|
|
594
|
-
|
|
612
|
+
IDeltaManager members disposed and dispose() were deprecated in 2.0.0-internal.5.3.0 and have now been removed.
|
|
595
613
|
|
|
596
|
-
-
|
|
614
|
+
- Request APIs deprecated on ILoader [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
597
615
|
|
|
598
|
-
|
|
599
|
-
|
|
616
|
+
The `request` API (associated with the `IFluidRouter` interface) has been deprecated on `ILoader` and `Loader`.
|
|
617
|
+
Please migrate all usage to using the `IContainer.request(...)` method if using a dynamic request URL, or to the `IContainer.getEntryPoint()` method if trying to obtain the application-specified root object.
|
|
600
618
|
|
|
601
|
-
|
|
619
|
+
**Note:** The `IContainer.request(...)` method will be deprecated in an upcoming release, so do not rely on this method for a long-term solution (the APIs around `entryPoint` and `getEntryPoint()` will become required and available for usage in its place).
|
|
602
620
|
|
|
603
|
-
|
|
604
|
-
|
|
621
|
+
After calling `ILoader.resolve(...)`, call the `request(...)` method on the returned `IContainer` with a corresponding request URL. For converting a request URL from `Loader` to `Container`, use the `IUrlResolver` passed into the `Loader`'s constructor.
|
|
622
|
+
The following is an example of what this change may look like:
|
|
605
623
|
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
624
|
+
```
|
|
625
|
+
// OLD
|
|
626
|
+
const request: IRequest;
|
|
627
|
+
const urlResolver = new YourUrlResolver();
|
|
628
|
+
const loader = new Loader({ urlResolver, ... });
|
|
611
629
|
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
630
|
+
await loader.resolve(request);
|
|
631
|
+
const response = loader.request(request);
|
|
632
|
+
```
|
|
615
633
|
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
634
|
+
```
|
|
635
|
+
// NEW
|
|
636
|
+
const request: IRequest;
|
|
637
|
+
const urlResolver = new YourUrlResolver();
|
|
638
|
+
const loader = new Loader({ urlResolver, ... });
|
|
621
639
|
|
|
622
|
-
|
|
623
|
-
|
|
640
|
+
const container = await loader.resolve(request);
|
|
641
|
+
const resolvedUrl: IRequest = urlResolver.resolve(request);
|
|
624
642
|
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
643
|
+
// Parse the `resolvedUrl.url` property as necessary before passing to `container.request(...)`
|
|
644
|
+
// For an example, see the `Loader.resolveCore(...)` method
|
|
645
|
+
const parsedResolvedUrl = // implement parse logic here
|
|
646
|
+
const response = container.request(parsedResolvedUrl);
|
|
647
|
+
```
|
|
630
648
|
|
|
631
|
-
|
|
649
|
+
Status on removal of the request pattern is tracked in [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
632
650
|
|
|
633
|
-
-
|
|
651
|
+
- IContainerContext members removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
634
652
|
|
|
635
|
-
|
|
653
|
+
IContainerContext members disposed, dispose(), serviceConfiguration, and id were deprecated in 2.0.0-internal.5.2.0 and have now been removed.
|
|
636
654
|
|
|
637
655
|
## 2.0.0-internal.5.4.0
|
|
638
656
|
|
|
639
657
|
### Minor Changes
|
|
640
658
|
|
|
641
|
-
-
|
|
659
|
+
- `ILoaderOptions.cache` has been deprecated ([#16383](https://github.com/microsoft/FluidFramework/issues/16383)) [ef9b00f1bf](https://github.com/microsoft/FluidFramework/commits/ef9b00f1bf538861ecc616c7c9e1d73707ab89fb)
|
|
642
660
|
|
|
643
|
-
|
|
661
|
+
`ILoaderOptions.cache` has been deprecated and will be removed in a future release, as well as all caching functionality of containers. Cache support will be removed soon, please try not to rely on caching, and inform us if you cannot do so.
|
|
644
662
|
|
|
645
663
|
## 2.0.0-internal.5.3.0
|
|
646
664
|
|
|
647
665
|
### Minor Changes
|
|
648
666
|
|
|
649
|
-
-
|
|
667
|
+
- Move closeAndGetPendingLocalState to IContainerExperimental ([#16302](https://github.com/microsoft/FluidFramework/issues/16302)) [93151af787](https://github.com/microsoft/FluidFramework/commits/93151af787b76e547cf3460df47f81832131db8c)
|
|
650
668
|
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
669
|
+
This change deprecates the experimental method closeAndGetPendingLocalState on IContainer and moves it to IContainerExperimental.
|
|
670
|
+
IContainerExperimental is an interface that is easily casted to, which enables partners to access experimental features for testing and evaluation.
|
|
671
|
+
Moving the experimental method off IContainer will reduce exposure and churn on that production interface as we iterate on and finalize our experimental features.
|
|
672
|
+
Experimental features should not be used in production environments.
|
|
655
673
|
|
|
656
|
-
-
|
|
674
|
+
- IDeltaManager members disposed and dispose() deprecated ([#16224](https://github.com/microsoft/FluidFramework/issues/16224)) [85b30b686a](https://github.com/microsoft/FluidFramework/commits/85b30b686a47563baf00ded97986610f1f3e77ed)
|
|
657
675
|
|
|
658
|
-
|
|
676
|
+
Directly calling dispose() on the IDeltaManager puts the system in an inconsistent state, and inspecting the disposed state of the IDeltaManager is not recommended (instead, prefer to inspect either the IContainer.disposed, IContainerRuntime.disposed, or IFluidDataStoreRuntime.disposed depending on your scenario). These members have been deprecated from the interface and will be removed in an upcoming release.
|
|
659
677
|
|
|
660
678
|
## 2.0.0-internal.5.2.0
|
|
661
679
|
|
|
662
680
|
### Minor Changes
|
|
663
681
|
|
|
664
|
-
-
|
|
682
|
+
- IContainerContext members deprecated ([#16180](https://github.com/microsoft/FluidFramework/issues/16180)) [bf6a26cfe6](https://github.com/microsoft/FluidFramework/commits/bf6a26cfe6ac58386f2c9af260603a15b03ba84f)
|
|
665
683
|
|
|
666
|
-
|
|
684
|
+
IContainerContext members disposed, dispose(), serviceConfiguration, and id have been deprecated and will be removed in an upcoming release.
|
|
667
685
|
|
|
668
|
-
|
|
686
|
+
disposed - The disposed state on the IContainerContext is not meaningful to the runtime.
|
|
669
687
|
|
|
670
|
-
|
|
688
|
+
dispose() - The runtime is not permitted to dispose the IContainerContext, this results in an inconsistent system state.
|
|
671
689
|
|
|
672
|
-
|
|
690
|
+
serviceConfiguration - This property is redundant, and is unused by the runtime. The same information can be found via `deltaManager.serviceConfiguration` on this object if it is necessary.
|
|
673
691
|
|
|
674
|
-
|
|
692
|
+
id - The docId is already logged by the IContainerContext.taggedLogger for telemetry purposes, so this is generally unnecessary for telemetry. If the id is needed for other purposes it should be passed to the consumer explicitly.
|
|
675
693
|
|
|
676
|
-
-
|
|
694
|
+
- IConnectionDetailsInternal and IDeltaHandlerStrategy deprecated ([#16081](https://github.com/microsoft/FluidFramework/issues/16081)) [279dcd5563](https://github.com/microsoft/FluidFramework/commits/279dcd55635b650494cf2347f21cf0e2b979413a)
|
|
677
695
|
|
|
678
|
-
|
|
696
|
+
The IConnectionDetailsInternal and IDeltaHandlerStrategy interfaces from the @fluidframework/container-definitions package have been deprecated and will be removed in a future release. These are internal-only interfaces and should not be used.
|
|
679
697
|
|
|
680
698
|
## 2.0.0-internal.5.1.0
|
|
681
699
|
|
|
@@ -685,16 +703,16 @@ Dependency updates only.
|
|
|
685
703
|
|
|
686
704
|
### Major Changes
|
|
687
705
|
|
|
688
|
-
-
|
|
706
|
+
- Calling `IContainer.close(...)` will no longer dispose the container runtime, document service, or document storage service. [8b242fdc79](https://github.com/microsoft/FluidFramework/commits/8b242fdc796714cf1da9ad3f90d02efb122af0c2)
|
|
689
707
|
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
708
|
+
If the container is not expected to be used after the `close(...)` call, replace it instead with a
|
|
709
|
+
`IContainer.dispose(...)` call (this should be the most common case). Using `IContainer.dispose(...)` will no longer
|
|
710
|
+
switch the container to "readonly" mode and relevant code should instead listen to the Container's "disposed" event.
|
|
693
711
|
|
|
694
|
-
|
|
695
|
-
|
|
712
|
+
If you intend to pass your own critical error to the container, use `IContainer.close(...)`. Once you are done using the
|
|
713
|
+
container, call `IContainer.dispose(...)`.
|
|
696
714
|
|
|
697
|
-
|
|
715
|
+
See the [Closure](packages/loader/container-loader/README.md#Closure) section of Loader README.md for more details.
|
|
698
716
|
|
|
699
717
|
## 2.0.0-internal.4.4.0
|
|
700
718
|
|