fluid-framework 2.100.0 → 2.101.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # fluid-framework
 
+## 2.101.0
+
+### Minor Changes
+
+- Add SharedTreeOptionsBeta.healUnresolvableIdentifiersOnDecode to recover documents with corrupted identifiers ([#27281](https://github.com/microsoft/FluidFramework/pull/27281)) [d9205ddcd6a](https://github.com/microsoft/FluidFramework/commit/d9205ddcd6a9f0ec11d5422b38e30a6a91a9258c)
+
+  A SharedTree bug can result in corrupted documents due to their attach summary compressing identifier-field values in a way that cannot be uncompressed.
+  This bug manifested as remote clients processing the op throwing an error with the message "Unknown op space ID.".
+
+  This change adds an option (`healUnresolvableIdentifiersOnDecode`) to `configuredSharedTreeBetaLegacy` which will allow documents affected by this bug to load again when enabled.
+  Enabling this option carries some risk, see documentation on the interface itself for more details.
+
+  #### Who is affected
+
+  Only SharedTrees attached to a container that was already attached can be impacted.
+  Furthermore, this bug only occurs when the attached tree contains [`identifier`](https://fluidframework.com/docs/api/tree/schemafactory-class#identifier-property) fields which contain implicitly generated default values.
+
+- Fix a SharedTree document corruption bug ([#27292](https://github.com/microsoft/FluidFramework/pull/27292)) [6f4cdcb7a0a](https://github.com/microsoft/FluidFramework/commit/6f4cdcb7a0a76ba215a361c7b3a12943750fe286)
+
+  A SharedTree bug which could corrupt documents when attaching them to containers has been fixed.
+  See `healUnresolvableIdentifiersOnDecode` on `configuredSharedTreeBetaLegacy` for a potential mitigation path for documents that were already corrupted by this bug.
+
+  #### Who is affected
+
+  Only SharedTrees attached to a container that was already attached can be impacted.
+  Furthermore, this bug only occurs when the attached tree contains [`identifier`](https://fluidframework.com/docs/api/tree/schemafactory-class#identifier-property) fields which contain implicitly generated default values.
+
 ## 2.100.0
 
 ### Minor Changes

package/api-report/fluid-framework.alpha.api.md

@@ -1667,7 +1667,9 @@ export interface SharedTreeOptions extends SharedTreeOptionsBeta, Partial<CodecW
 }
 
 // @beta @input
-export type SharedTreeOptionsBeta = ForestOptions & Partial<CodecWriteOptionsBeta>;
+export interface SharedTreeOptionsBeta extends ForestOptions, Partial<CodecWriteOptionsBeta> {
+    readonly healUnresolvableIdentifiersOnDecode?: boolean;
+}
 
 // @alpha @sealed
 export interface SimpleAllowedTypeAttributes<out Type extends SchemaType = SchemaType> {

package/api-report/fluid-framework.beta.api.md

@@ -1008,7 +1008,9 @@ export interface SharedObjectKind<out TSharedObject = unknown> extends ErasedTyp
 export const SharedTree: SharedObjectKind<ITree>;
 
 // @beta @input
-export type SharedTreeOptionsBeta = ForestOptions & Partial<CodecWriteOptionsBeta>;
+export interface SharedTreeOptionsBeta extends ForestOptions, Partial<CodecWriteOptionsBeta> {
+    readonly healUnresolvableIdentifiersOnDecode?: boolean;
+}
 
 // @public @sealed @system
 export interface SimpleNodeSchemaBase<out TNodeKind extends NodeKind, out TCustomMetadata = unknown> {

package/api-report/fluid-framework.legacy.beta.api.md

@@ -1372,7 +1372,9 @@ export type SharedStringSegment = TextSegment | Marker;
 export const SharedTree: SharedObjectKind<ITree>;
 
 // @beta @input
-export type SharedTreeOptionsBeta = ForestOptions & Partial<CodecWriteOptionsBeta>;
+export interface SharedTreeOptionsBeta extends ForestOptions, Partial<CodecWriteOptionsBeta> {
+    readonly healUnresolvableIdentifiersOnDecode?: boolean;
+}
 
 export { Side }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "2.100.0",
+  "version": "2.101.0",
   "description": "The main entry point into Fluid Framework public packages",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,17 +57,17 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.100.0",
-    "@fluidframework/container-loader": "~2.100.0",
-    "@fluidframework/core-interfaces": "~2.100.0",
-    "@fluidframework/core-utils": "~2.100.0",
-    "@fluidframework/driver-definitions": "~2.100.0",
-    "@fluidframework/fluid-static": "~2.100.0",
-    "@fluidframework/map": "~2.100.0",
-    "@fluidframework/runtime-utils": "~2.100.0",
-    "@fluidframework/sequence": "~2.100.0",
-    "@fluidframework/shared-object-base": "~2.100.0",
-    "@fluidframework/tree": "~2.100.0"
+    "@fluidframework/container-definitions": "~2.101.0",
+    "@fluidframework/container-loader": "~2.101.0",
+    "@fluidframework/core-interfaces": "~2.101.0",
+    "@fluidframework/core-utils": "~2.101.0",
+    "@fluidframework/driver-definitions": "~2.101.0",
+    "@fluidframework/fluid-static": "~2.101.0",
+    "@fluidframework/map": "~2.101.0",
+    "@fluidframework/runtime-utils": "~2.101.0",
+    "@fluidframework/sequence": "~2.101.0",
+    "@fluidframework/shared-object-base": "~2.101.0",
+    "@fluidframework/tree": "~2.101.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",