@fluidframework/datastore 2.30.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 +276 -262
- package/api-report/datastore.legacy.alpha.api.md +1 -0
- package/dist/dataStoreLayerCompatState.d.ts +35 -0
- package/dist/dataStoreLayerCompatState.d.ts.map +1 -0
- package/dist/dataStoreLayerCompatState.js +74 -0
- package/dist/dataStoreLayerCompatState.js.map +1 -0
- package/dist/dataStoreRuntime.d.ts +8 -0
- package/dist/dataStoreRuntime.d.ts.map +1 -1
- package/dist/dataStoreRuntime.js +13 -1
- package/dist/dataStoreRuntime.js.map +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/lib/dataStoreLayerCompatState.d.ts +35 -0
- package/lib/dataStoreLayerCompatState.d.ts.map +1 -0
- package/lib/dataStoreLayerCompatState.js +70 -0
- package/lib/dataStoreLayerCompatState.js.map +1 -0
- package/lib/dataStoreRuntime.d.ts +8 -0
- package/lib/dataStoreRuntime.d.ts.map +1 -1
- package/lib/dataStoreRuntime.js +15 -1
- package/lib/dataStoreRuntime.js.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +19 -27
- package/src/dataStoreLayerCompatState.ts +85 -0
- package/src/dataStoreRuntime.ts +23 -2
- package/src/packageVersion.ts +1 -1
- package/prettier.config.cjs +0 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,32 +1,46 @@
|
|
|
1
1
|
# @fluidframework/datastore
|
|
2
2
|
|
|
3
|
+
## 2.31.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- New ILayerCompatDetails property on FluidDataStoreRuntime, MockFluidDataStoreContext and MockFluidDataStoreRuntime ([#24166](https://github.com/microsoft/FluidFramework/pull/24166)) [fac75c8258](https://github.com/microsoft/FluidFramework/commit/fac75c8258c979a6b15a70b9cf84df09f62b3e93)
|
|
8
|
+
|
|
9
|
+
A new optional property, `ILayerCompatDetails`, has been added to `FluidDataStoreRuntime`. This property is used by
|
|
10
|
+
`FluidDataStoreContext` in the Runtime layer to validate that the Runtime and DataStore layers are compatible.
|
|
11
|
+
|
|
12
|
+
`ILayerCompatDetails` has also been added to `MockFluidDataStoreRuntime` and `MockFluidDataStoreContext` which are used for
|
|
13
|
+
testing.
|
|
14
|
+
|
|
15
|
+
Important: this property is intended for use by Fluid Framework code only. No code outside the Fluid Framework should use or depend on this property in any way.
|
|
16
|
+
|
|
3
17
|
## 2.30.0
|
|
4
18
|
|
|
5
19
|
### Minor Changes
|
|
6
20
|
|
|
7
|
-
-
|
|
21
|
+
- The process and processDocumentSchemaOp functions have been removed ([#24018](https://github.com/microsoft/FluidFramework/pull/24018)) [bc35d543d5](https://github.com/microsoft/FluidFramework/commit/bc35d543d58c7e4bf28944b09d645cc26bf28a29)
|
|
8
22
|
|
|
9
|
-
|
|
23
|
+
`process` has been replaced by `processMessages` from the following:
|
|
10
24
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
25
|
+
- `FluidDataStoreRuntime`
|
|
26
|
+
- `IDeltaHandler`
|
|
27
|
+
- `IFluidDataStoreChannel`
|
|
28
|
+
- `MockFluidDataStoreRuntime`
|
|
29
|
+
- `MockDeltaConnection`
|
|
16
30
|
|
|
17
|
-
|
|
31
|
+
`processDocumentSchemaOp` has been replaced by `processDocumentSchemaMessages` from `DocumentsSchemaController`.
|
|
18
32
|
|
|
19
|
-
|
|
33
|
+
See the [deprecation release note](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.5.0#user-content-the-process-function-on-ifluiddatastorechannel-ideltahandler-mockfluiddatastoreruntime-and-mockdeltaconnection-is-now-deprecated-22840) for more details.
|
|
20
34
|
|
|
21
35
|
## 2.23.0
|
|
22
36
|
|
|
23
37
|
### Minor Changes
|
|
24
38
|
|
|
25
|
-
-
|
|
39
|
+
- The FluidDataStoreRuntime.process function is now deprecated ([#23866](https://github.com/microsoft/FluidFramework/pull/23866)) [3f44d43e985](https://github.com/microsoft/FluidFramework/commit/3f44d43e985fea02ea349d024d3ae5d85f7eddd6)
|
|
26
40
|
|
|
27
|
-
|
|
41
|
+
A new function `processMessages` has been added in place of `process`. The new function will be called to process multiple messages instead of a single one on the data store runtime. This is part of a feature called "op bunching" where contiguous ops of a given type and to a given data store / DDS are bunched and sent together for processing.
|
|
28
42
|
|
|
29
|
-
|
|
43
|
+
Note that `process` may still be called in scenarios where this data store runtime (Datastore layer) is running with an older version of data store context (Runtime layer) in the same client. This is to support Fluid layer compatibility.
|
|
30
44
|
|
|
31
45
|
## 2.22.0
|
|
32
46
|
|
|
@@ -40,18 +54,18 @@ Dependency updates only.
|
|
|
40
54
|
|
|
41
55
|
### Minor Changes
|
|
42
56
|
|
|
43
|
-
-
|
|
57
|
+
- The createDataStoreWithProps APIs on ContainerRuntime and IContainerRuntimeBase have been removed ([#22996](https://github.com/microsoft/FluidFramework/pull/22996)) [bd243fb292](https://github.com/microsoft/FluidFramework/commit/bd243fb2927915d87c42486e21ee0c990962a9a7)
|
|
44
58
|
|
|
45
|
-
|
|
46
|
-
|
|
59
|
+
`ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps`
|
|
60
|
+
were [deprecated in version 0.25.0](https://github.com/microsoft/FluidFramework/blob/main/BREAKING.md#icontainerruntimebase_createdatastorewithprops-is-removed) and have been removed.
|
|
47
61
|
|
|
48
|
-
|
|
49
|
-
|
|
62
|
+
Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState`
|
|
63
|
+
parameter.
|
|
50
64
|
|
|
51
|
-
|
|
65
|
+
These changes were originally announced in version 0.25.0. See the following issues for more details:
|
|
52
66
|
|
|
53
|
-
|
|
54
|
-
|
|
67
|
+
- [#1537](https://github.com/microsoft/FluidFramework/issues/1537)
|
|
68
|
+
- [#2931](https://github.com/microsoft/FluidFramework/pull/2931)
|
|
55
69
|
|
|
56
70
|
## 2.13.0
|
|
57
71
|
|
|
@@ -69,19 +83,19 @@ Dependency updates only.
|
|
|
69
83
|
|
|
70
84
|
### Minor Changes
|
|
71
85
|
|
|
72
|
-
-
|
|
86
|
+
- 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)
|
|
73
87
|
|
|
74
|
-
|
|
88
|
+
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`.
|
|
75
89
|
|
|
76
|
-
|
|
90
|
+
`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.
|
|
77
91
|
|
|
78
|
-
|
|
92
|
+
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.
|
|
79
93
|
|
|
80
|
-
|
|
94
|
+
#### Alternatives
|
|
81
95
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
96
|
+
- Alternatives to `IDeltaManager.inbound.on("op", ...)` are `IDeltaManager.on("op", ...)`
|
|
97
|
+
- Alternatives to calling `IDeltaManager.inbound.pause`, `IDeltaManager.outbound.pause` for `IContainer` disconnect use `IContainer.disconnect`.
|
|
98
|
+
- Alternatives to calling `IDeltaManager.inbound.resume`, `IDeltaManager.outbound.resume` for `IContainer` reconnect use `IContainer.connect`.
|
|
85
99
|
|
|
86
100
|
## 2.5.0
|
|
87
101
|
|
|
@@ -107,153 +121,153 @@ Dependency updates only.
|
|
|
107
121
|
|
|
108
122
|
### Minor Changes
|
|
109
123
|
|
|
110
|
-
-
|
|
124
|
+
- Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
|
|
111
125
|
|
|
112
|
-
|
|
126
|
+
Update package implementations to use TypeScript 5.4.5.
|
|
113
127
|
|
|
114
128
|
## 2.0.0-rc.4.0.0
|
|
115
129
|
|
|
116
130
|
### Minor Changes
|
|
117
131
|
|
|
118
|
-
-
|
|
132
|
+
- Type Erase IFluidDataStoreRuntime.deltaManager [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
|
|
119
133
|
|
|
120
|
-
|
|
121
|
-
|
|
134
|
+
Make IFluidDataStoreRuntime.deltaManager have an opaque type.
|
|
135
|
+
Marks the following types which were reachable from it as alpha:
|
|
122
136
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
137
|
+
- IConnectionDetails
|
|
138
|
+
- IDeltaSender
|
|
139
|
+
- IDeltaManagerEvents
|
|
140
|
+
- IDeltaManager
|
|
141
|
+
- IDeltaQueueEvents
|
|
142
|
+
- IDeltaQueue
|
|
143
|
+
- ReadOnlyInfo
|
|
130
144
|
|
|
131
|
-
|
|
145
|
+
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.
|
|
132
146
|
|
|
133
|
-
|
|
147
|
+
Implementing a custom `IFluidDataStoreRuntime` is not supported: this is now indicated by it being marked with `@sealed`.
|
|
134
148
|
|
|
135
149
|
## 2.0.0-rc.3.0.0
|
|
136
150
|
|
|
137
151
|
### Major Changes
|
|
138
152
|
|
|
139
|
-
-
|
|
153
|
+
- Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
140
154
|
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
155
|
+
Fluid Framework packages have been updated to use the [package.json "exports"
|
|
156
|
+
field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
|
|
157
|
+
TypeScript types and implementation code.
|
|
144
158
|
|
|
145
|
-
|
|
159
|
+
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
146
160
|
|
|
147
|
-
|
|
148
|
-
|
|
161
|
+
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
162
|
+
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
149
163
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
164
|
+
We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
|
|
165
|
+
for use with modern versions of Node.js _and_ Bundlers.
|
|
166
|
+
[See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
|
|
167
|
+
regarding the module and moduleResolution options.
|
|
154
168
|
|
|
155
|
-
|
|
156
|
-
|
|
169
|
+
**Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
|
|
170
|
+
to distinguish stable APIs from those that are in development.**
|
|
157
171
|
|
|
158
172
|
## 2.0.0-rc.2.0.0
|
|
159
173
|
|
|
160
174
|
### Minor Changes
|
|
161
175
|
|
|
162
|
-
-
|
|
176
|
+
- container-runtime: New feature: ID compression for DataStores & DDSs ([#19859](https://github.com/microsoft/FluidFramework/issues/19859)) [51f0d3db73](https://github.com/microsoft/FluidFramework/commits/51f0d3db737800e1c30ea5e3952d38ff30ffc7da)
|
|
163
177
|
|
|
164
|
-
|
|
178
|
+
### Key changes
|
|
165
179
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
180
|
+
1. A new API IContainerRuntimeBase.generateDocumentUniqueId() is exposed. This API will opportunistically generate IDs in short format (non-negative numbers). If it can't achieve that, it will return UUID strings. UUIDs generated will have low entropy in groups and will compress well. It can be leveraged anywhere in container where container unique IDs are required. I.e. any place that uses uuid() and stores data in container is likely candidate to start leveraging this API.
|
|
181
|
+
2. Data store internal IDs (IDs that are auto generated by FF system) will opportunistically be generated in shorter form. Data stores created in detached container will always have short IDs, data stores created in attached container will opportunistically be short (by using newly added IContainerRuntimeBase.generateDocumentUniqueId() capability)
|
|
182
|
+
3. Similar DDS names will be opportunistically short (same considerations for detached DDS vs. attached DDS)
|
|
169
183
|
|
|
170
|
-
|
|
184
|
+
### Implementation details
|
|
171
185
|
|
|
172
|
-
|
|
186
|
+
1. Container level ID Compressor can now be enabled with delay. With such setting, only new IContainerRuntimeBase.generateDocumentUniqueId() is exposed (ID Compressor is not exposed in such case, as leveraging any of its other capabilities requires future container sessions to load ID Compressor on container load, for correctness reasons). Once Container establishes connection and any changes are made in container, newly added API will start generating more compact IDs (in most cases).
|
|
173
187
|
|
|
174
|
-
|
|
188
|
+
### Breaking changes
|
|
175
189
|
|
|
176
|
-
|
|
190
|
+
1. DDS names can no longer start with "\_" symbol - this is reserved for FF needs. I've validated that's not an issue for AzureClient (it only creates root object by name, everything else is referred by handle). Our main internal partners almost never use named DDSs (I can find only 4 instances in Loop).
|
|
177
191
|
|
|
178
|
-
|
|
192
|
+
### Backward compatibility considerations
|
|
179
193
|
|
|
180
|
-
|
|
181
|
-
|
|
194
|
+
1. Data store internal IDs could collide with earlier used names data stores. Earlier versions of FF framework (before DataStore aliasing feature was added) allowed customers to supply IDs for data stores. And thus, files created with earlier versions of framework could have data store IDs that will be similar to names FF will use for newly created data stores ("A", ... "Z", "a"..."z", "AA", etc.). While such collision is possible, it's very unlikely (almost impossible) if user-provided names were at least 4-5 characters long.
|
|
195
|
+
2. If application runs to these problems, or wants to reduce risks, consider disabling ID compressor via IContainerRuntimeOptions.enableRuntimeIdCompressor = "off".
|
|
182
196
|
|
|
183
|
-
|
|
197
|
+
### Minor changes
|
|
184
198
|
|
|
185
|
-
|
|
186
|
-
|
|
199
|
+
1. IContainerRuntime.createDetachedRootDataStore() is removed. Please use IContainerRuntime.createDetachedDataStore and IDataStore.trySetAlias() instead
|
|
200
|
+
2. IContainerRuntimeOptions.enableRuntimeIdCompressor has been changes from boolean to tri-state.
|
|
187
201
|
|
|
188
|
-
-
|
|
202
|
+
- Deprecated error-related enums have been removed ([#19067](https://github.com/microsoft/FluidFramework/issues/19067)) [59793302e5](https://github.com/microsoft/FluidFramework/commits/59793302e56784cfb6ace0e6469345f3565b3312)
|
|
189
203
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
204
|
+
Error-related enums `ContainerErrorType`, `DriverErrorType`, `OdspErrorType` and `RouterliciousErrorType` were previously
|
|
205
|
+
deprecated and are now removed. There are replacement object-based enumerations of `ContainerErrorTypes`,
|
|
206
|
+
`DriverErrorTypes`, `OdspErrorTypes` and `RouterliciousErrorTypes`. Refer to the release notes of [Fluid Framework version
|
|
207
|
+
2.0.0-internal.7.0.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.7.0.0) for details
|
|
208
|
+
on the replacements.
|
|
195
209
|
|
|
196
|
-
-
|
|
210
|
+
- 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)
|
|
197
211
|
|
|
198
|
-
|
|
212
|
+
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.
|
|
199
213
|
|
|
200
214
|
## 2.0.0-rc.1.0.0
|
|
201
215
|
|
|
202
216
|
### Minor Changes
|
|
203
217
|
|
|
204
|
-
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
218
|
+
- Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
219
|
+
|
|
220
|
+
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)
|
|
221
|
+
|
|
222
|
+
- @fluidframework/gitresources
|
|
223
|
+
- @fluidframework/server-kafka-orderer
|
|
224
|
+
- @fluidframework/server-lambdas
|
|
225
|
+
- @fluidframework/server-lambdas-driver
|
|
226
|
+
- @fluidframework/server-local-server
|
|
227
|
+
- @fluidframework/server-memory-orderer
|
|
228
|
+
- @fluidframework/protocol-base
|
|
229
|
+
- @fluidframework/server-routerlicious
|
|
230
|
+
- @fluidframework/server-routerlicious-base
|
|
231
|
+
- @fluidframework/server-services
|
|
232
|
+
- @fluidframework/server-services-client
|
|
233
|
+
- @fluidframework/server-services-core
|
|
234
|
+
- @fluidframework/server-services-ordering-kafkanode
|
|
235
|
+
- @fluidframework/server-services-ordering-rdkafka
|
|
236
|
+
- @fluidframework/server-services-ordering-zookeeper
|
|
237
|
+
- @fluidframework/server-services-shared
|
|
238
|
+
- @fluidframework/server-services-telemetry
|
|
239
|
+
- @fluidframework/server-services-utils
|
|
240
|
+
- @fluidframework/server-test-utils
|
|
241
|
+
- tinylicious
|
|
242
|
+
|
|
243
|
+
- Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
244
|
+
|
|
245
|
+
The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
|
|
246
|
+
changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
|
|
233
247
|
|
|
234
248
|
## 2.0.0-internal.8.0.0
|
|
235
249
|
|
|
236
250
|
### Major Changes
|
|
237
251
|
|
|
238
|
-
-
|
|
252
|
+
- datastore: Removed `FluidDataStoreRuntime.load(...)` [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
239
253
|
|
|
240
|
-
|
|
241
|
-
|
|
254
|
+
The static method `FluidDataStoreRuntime.load(...)` has been removed. Please migrate all usage of this method to
|
|
255
|
+
`FluidDataStoreRuntime` constructor.
|
|
242
256
|
|
|
243
|
-
-
|
|
257
|
+
- container-definitions: Fix ISnapshotTreeWithBlobContents and mark internal [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
244
258
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
259
|
+
`ISnapshotTreeWithBlobContents` is an internal type that should not be used externally. Additionally, the type didn't
|
|
260
|
+
match the usage, specifically in runtime-utils where an `any` cast was used to work around undefined blobContents. The
|
|
261
|
+
type has been updated to reflect that blobContents can be undefined.
|
|
248
262
|
|
|
249
|
-
-
|
|
263
|
+
- runtime-definitions: Removed IFluidRouter from IFluidDataStoreChannel and FluidDataStoreRuntime [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
250
264
|
|
|
251
|
-
|
|
252
|
-
|
|
265
|
+
The `IFluidRouter` property has been removed from `IFluidDataStoreChannel` and `FluidDataStoreRuntime`. Please migrate
|
|
266
|
+
all usage to the `IFluidDataStoreChannel.entryPoint` API.
|
|
253
267
|
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
268
|
+
See
|
|
269
|
+
[Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
270
|
+
for more details.
|
|
257
271
|
|
|
258
272
|
## 2.0.0-internal.7.4.0
|
|
259
273
|
|
|
@@ -275,74 +289,74 @@ Dependency updates only.
|
|
|
275
289
|
|
|
276
290
|
### Major Changes
|
|
277
291
|
|
|
278
|
-
-
|
|
292
|
+
- Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
279
293
|
|
|
280
|
-
|
|
294
|
+
This included the following changes from the protocol-definitions release:
|
|
281
295
|
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
296
|
+
- Updating signal interfaces for some planned improvements. The intention is split the interface between signals
|
|
297
|
+
submitted by clients to the server and the resulting signals sent from the server to clients.
|
|
298
|
+
- A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
|
|
299
|
+
been added, which will be the typing for signals sent from the client to the server. Both extend a new
|
|
300
|
+
ISignalMessageBase interface that contains common members.
|
|
301
|
+
- The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
|
|
288
302
|
|
|
289
|
-
-
|
|
303
|
+
- runtime-definitions: `bindToContext` API removed [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
290
304
|
|
|
291
|
-
|
|
292
|
-
|
|
305
|
+
`bindToContext` has been removed from `FluidDataStoreRuntime`, `IFluidDataStoreContext` and
|
|
306
|
+
`MockFluidDataStoreContext`. This has been deprecated for several releases and cannot be used anymore.
|
|
293
307
|
|
|
294
|
-
-
|
|
308
|
+
- Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
295
309
|
|
|
296
|
-
|
|
310
|
+
Dependencies on the following Fluid server package have been updated to version 2.0.1:
|
|
297
311
|
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
312
|
+
- @fluidframework/gitresources: 2.0.1
|
|
313
|
+
- @fluidframework/server-kafka-orderer: 2.0.1
|
|
314
|
+
- @fluidframework/server-lambdas: 2.0.1
|
|
315
|
+
- @fluidframework/server-lambdas-driver: 2.0.1
|
|
316
|
+
- @fluidframework/server-local-server: 2.0.1
|
|
317
|
+
- @fluidframework/server-memory-orderer: 2.0.1
|
|
318
|
+
- @fluidframework/protocol-base: 2.0.1
|
|
319
|
+
- @fluidframework/server-routerlicious: 2.0.1
|
|
320
|
+
- @fluidframework/server-routerlicious-base: 2.0.1
|
|
321
|
+
- @fluidframework/server-services: 2.0.1
|
|
322
|
+
- @fluidframework/server-services-client: 2.0.1
|
|
323
|
+
- @fluidframework/server-services-core: 2.0.1
|
|
324
|
+
- @fluidframework/server-services-ordering-kafkanode: 2.0.1
|
|
325
|
+
- @fluidframework/server-services-ordering-rdkafka: 2.0.1
|
|
326
|
+
- @fluidframework/server-services-ordering-zookeeper: 2.0.1
|
|
327
|
+
- @fluidframework/server-services-shared: 2.0.1
|
|
328
|
+
- @fluidframework/server-services-telemetry: 2.0.1
|
|
329
|
+
- @fluidframework/server-services-utils: 2.0.1
|
|
330
|
+
- @fluidframework/server-test-utils: 2.0.1
|
|
331
|
+
- tinylicious: 2.0.1
|
|
318
332
|
|
|
319
|
-
-
|
|
333
|
+
- test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
320
334
|
|
|
321
|
-
|
|
335
|
+
The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
|
|
322
336
|
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
337
|
+
- `BaseContainerRuntimeFactory`
|
|
338
|
+
- `RuntimeFactory`
|
|
339
|
+
- `ContainerRuntime` (constructor and `loadRuntime`)
|
|
340
|
+
- `FluidDataStoreRuntime`
|
|
327
341
|
|
|
328
|
-
|
|
329
|
-
|
|
342
|
+
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.
|
|
343
|
+
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.
|
|
330
344
|
|
|
331
|
-
|
|
345
|
+
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.
|
|
332
346
|
|
|
333
|
-
|
|
347
|
+
For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
334
348
|
|
|
335
|
-
-
|
|
349
|
+
- Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
336
350
|
|
|
337
|
-
|
|
351
|
+
The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
|
|
338
352
|
|
|
339
353
|
## 2.0.0-internal.6.4.0
|
|
340
354
|
|
|
341
355
|
### Minor Changes
|
|
342
356
|
|
|
343
|
-
-
|
|
357
|
+
- Some stack traces are improved ([#17380](https://github.com/microsoft/FluidFramework/issues/17380)) [34f2808ee9](https://github.com/microsoft/FluidFramework/commits/34f2808ee9764aef21b990f8b48860d9e3ce27a5)
|
|
344
358
|
|
|
345
|
-
|
|
359
|
+
Some stack traces have been improved and might now include frames for async functions that weren't previously included.
|
|
346
360
|
|
|
347
361
|
## 2.0.0-internal.6.3.0
|
|
348
362
|
|
|
@@ -352,32 +366,32 @@ Dependency updates only.
|
|
|
352
366
|
|
|
353
367
|
### Minor Changes
|
|
354
368
|
|
|
355
|
-
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
369
|
+
- Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
|
|
370
|
+
|
|
371
|
+
The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
|
|
372
|
+
imported from the **@fluidframework/core-interfaces** package:
|
|
373
|
+
|
|
374
|
+
- interface IDisposable
|
|
375
|
+
- interface IErrorEvent
|
|
376
|
+
- interface IErrorEvent
|
|
377
|
+
- interface IEvent
|
|
378
|
+
- interface IEventProvider
|
|
379
|
+
- interface ILoggingError
|
|
380
|
+
- interface ITaggedTelemetryPropertyType
|
|
381
|
+
- interface ITelemetryBaseEvent
|
|
382
|
+
- interface ITelemetryBaseLogger
|
|
383
|
+
- interface ITelemetryErrorEvent
|
|
384
|
+
- interface ITelemetryGenericEvent
|
|
385
|
+
- interface ITelemetryLogger
|
|
386
|
+
- interface ITelemetryPerformanceEvent
|
|
387
|
+
- interface ITelemetryProperties
|
|
388
|
+
- type ExtendEventProvider
|
|
389
|
+
- type IEventThisPlaceHolder
|
|
390
|
+
- type IEventTransformer
|
|
391
|
+
- type ReplaceIEventThisPlaceHolder
|
|
392
|
+
- type ReplaceIEventThisPlaceHolder
|
|
393
|
+
- type TelemetryEventCategory
|
|
394
|
+
- type TelemetryEventPropertyType
|
|
381
395
|
|
|
382
396
|
## 2.0.0-internal.6.1.0
|
|
383
397
|
|
|
@@ -387,47 +401,47 @@ Dependency updates only.
|
|
|
387
401
|
|
|
388
402
|
### Major Changes
|
|
389
403
|
|
|
390
|
-
-
|
|
404
|
+
- Request APIs deprecated from many places [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
391
405
|
|
|
392
|
-
|
|
406
|
+
The `request` API (associated with the `IFluidRouter` interface) has been deprecated on a number of classes and interfaces. The following are impacted:
|
|
393
407
|
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
408
|
+
- `IRuntime` and `ContainerRuntime`
|
|
409
|
+
- `IFluidDataStoreRuntime` and `FluidDataStoreRuntime`
|
|
410
|
+
- `IFluidDataStoreChannel`
|
|
411
|
+
- `MockFluidDataStoreRuntime`
|
|
412
|
+
- `TestFluidObject`
|
|
399
413
|
|
|
400
|
-
|
|
414
|
+
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.
|
|
401
415
|
|
|
402
|
-
|
|
416
|
+
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).
|
|
403
417
|
|
|
404
|
-
|
|
418
|
+
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).
|
|
405
419
|
|
|
406
|
-
-
|
|
420
|
+
- `initializeEntryPoint` will become required [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
407
421
|
|
|
408
|
-
|
|
422
|
+
The optional `initializeEntryPoint` method has been added to a number of constructors. **This method argument will become required in an upcoming release** and a value will need to be provided to the following classes:
|
|
409
423
|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
424
|
+
- `BaseContainerRuntimeFactory`
|
|
425
|
+
- `ContainerRuntimeFactoryWithDefaultDataStore`
|
|
426
|
+
- `RuntimeFactory`
|
|
427
|
+
- `ContainerRuntime` (constructor and `loadRuntime`)
|
|
428
|
+
- `FluidDataStoreRuntime`
|
|
415
429
|
|
|
416
|
-
|
|
430
|
+
For an example implementation of `initializeEntryPoint`, see [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/blob/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L84).
|
|
417
431
|
|
|
418
|
-
|
|
432
|
+
This work will replace the request pattern. See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more info on this effort.
|
|
419
433
|
|
|
420
|
-
-
|
|
434
|
+
- FluidDataStoreRuntime.getChannel throws for channels that do not exist [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
421
435
|
|
|
422
|
-
|
|
436
|
+
Previously, calling `FluidDataStoreRuntime.getChannel(id)` for a channel that does not exist would wait for the channel to be created (possibly waiting indefinitely if never created). However, there is no safe means to dynamically create a channel in this manner without risking data corruption. The call will instead now throw for non-existent channels.
|
|
423
437
|
|
|
424
|
-
-
|
|
438
|
+
- Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
425
439
|
|
|
426
|
-
|
|
440
|
+
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.
|
|
427
441
|
|
|
428
|
-
-
|
|
442
|
+
- IDeltaManager members disposed and dispose() removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
429
443
|
|
|
430
|
-
|
|
444
|
+
IDeltaManager members disposed and dispose() were deprecated in 2.0.0-internal.5.3.0 and have now been removed.
|
|
431
445
|
|
|
432
446
|
## 2.0.0-internal.5.4.0
|
|
433
447
|
|
|
@@ -449,22 +463,22 @@ Dependency updates only.
|
|
|
449
463
|
|
|
450
464
|
### Major Changes
|
|
451
465
|
|
|
452
|
-
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
466
|
+
- The `@fluidframework/garbage-collector` package was deprecated in version 2.0.0-internal.4.1.0. [8b242fdc79](https://github.com/microsoft/FluidFramework/commits/8b242fdc796714cf1da9ad3f90d02efb122af0c2)
|
|
467
|
+
It has now been removed with the following functions, interfaces, and types in it.
|
|
468
|
+
|
|
469
|
+
- `cloneGCData`
|
|
470
|
+
- `concatGarbageCollectionData`
|
|
471
|
+
- `concatGarbageCollectionStates`
|
|
472
|
+
- `GCDataBuilder`
|
|
473
|
+
- `getGCDataFromSnapshot`
|
|
474
|
+
- `IGCResult`
|
|
475
|
+
- `removeRouteFromAllNodes`
|
|
476
|
+
- `runGarbageCollection`
|
|
477
|
+
- `trimLeadingAndTrailingSlashes`
|
|
478
|
+
- `trimLeadingSlashes`
|
|
479
|
+
- `trimTrailingSlashes`
|
|
480
|
+
- `unpackChildNodesGCDetails`
|
|
481
|
+
- `unpackChildNodesUsedRoutes`
|
|
468
482
|
|
|
469
483
|
## 2.0.0-internal.4.4.0
|
|
470
484
|
|
|
@@ -474,31 +488,31 @@ Dependency updates only.
|
|
|
474
488
|
|
|
475
489
|
### Minor Changes
|
|
476
490
|
|
|
477
|
-
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
491
|
+
- GC interfaces removed from runtime-definitions ([#14750](https://github.com/microsoft/FluidFramework/pull-requests/14750)) [60274eacab](https://github.com/microsoft/FluidFramework/commits/60274eacabf14d42f52f6ad1c2f64356e64ba1a2)
|
|
492
|
+
|
|
493
|
+
The following interfaces available in `@fluidframework/runtime-definitions` are internal implementation details and have been deprecated for public use. They will be removed in an upcoming release.
|
|
494
|
+
|
|
495
|
+
- `IGarbageCollectionNodeData`
|
|
496
|
+
- `IGarbageCollectionState`
|
|
497
|
+
- `IGarbageCollectionSnapshotData`
|
|
498
|
+
- `IGarbageCollectionSummaryDetailsLegacy`
|
|
499
|
+
|
|
500
|
+
- @fluidframework/garbage-collector deprecated ([#14750](https://github.com/microsoft/FluidFramework/pull-requests/14750)) [60274eacab](https://github.com/microsoft/FluidFramework/commits/60274eacabf14d42f52f6ad1c2f64356e64ba1a2)
|
|
501
|
+
|
|
502
|
+
The `@fluidframework/garbage-collector` package is deprecated with the following functions, interfaces, and types in it.
|
|
503
|
+
These are internal implementation details and have been deprecated for public use. They will be removed in an upcoming
|
|
504
|
+
release.
|
|
505
|
+
|
|
506
|
+
- `cloneGCData`
|
|
507
|
+
- `concatGarbageCollectionData`
|
|
508
|
+
- `concatGarbageCollectionStates`
|
|
509
|
+
- `GCDataBuilder`
|
|
510
|
+
- `getGCDataFromSnapshot`
|
|
511
|
+
- `IGCResult`
|
|
512
|
+
- `removeRouteFromAllNodes`
|
|
513
|
+
- `runGarbageCollection`
|
|
514
|
+
- `trimLeadingAndTrailingSlashes`
|
|
515
|
+
- `trimLeadingSlashes`
|
|
516
|
+
- `trimTrailingSlashes`
|
|
517
|
+
- `unpackChildNodesGCDetails`
|
|
518
|
+
- `unpackChildNodesUsedRoutes`
|