fluid-framework 2.74.0 → 2.80.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # fluid-framework
 
+## 2.80.0
+
+### Minor Changes
+
+- TreeBranch operations throw when called during transactions ([#26097](https://github.com/microsoft/FluidFramework/pull/26097)) [33b1ec0827c](https://github.com/microsoft/FluidFramework/commit/33b1ec0827c433ce9afc126f26457a9245bd43eb)
+
+  This breaking change only affects the behavior of `TreeBranch` methods (currently released as beta).
+  - Invoking `TreeBranch.fork()` now throws an error if a transaction is ongoing on the branch.
+  - Invoking `TreeBranch.merge(sourceBranch)` now throws an error if a transaction is ongoing on the source branch.
+    As before, it also throws an error if a transaction is ongoing on the target (i.e., `this`) branch.
+  - Invoking `TreeBranch.rebaseOnto(targetBranch)` now throws an error if a transaction is ongoing on the target branch.
+    As before, it also throws an error if a transaction is ongoing on the source (i.e., `this`) branch.
+
+  These new restrictions insulate branches and their dependents from experiencing incomplete transaction changes.
+  This is important because incomplete transaction changes may not uphold application invariants.
+
+  In scenarios that experience the new errors, application authors should consider whether the ongoing transaction can safely be closed before invoking these methods.
+
 ## 2.74.0
 
 ### Minor Changes

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

@@ -159,9 +159,14 @@ export function cloneWithReplacements(root: unknown, rootKey: string, replacer:
     value: unknown;
 }): unknown;
 
+// @alpha
+export type CodecName = string;
+
 // @alpha @input
 export interface CodecWriteOptions extends ICodecOptions {
+    readonly allowPossiblyIncompatibleWriteVersionOverrides?: boolean;
     readonly minVersionForCollab: MinimumVersionForCollab;
+    readonly writeVersionOverrides?: ReadonlyMap<CodecName, FormatVersion>;
 }
 
 // @public
@@ -411,6 +416,7 @@ export const FluidClientVersion: {
     readonly v2_52: "2.52.0";
     readonly v2_73: "2.73.0";
     readonly v2_74: "2.74.0";
+    readonly v2_80: "2.80.0";
 };
 
 // @public
@@ -473,6 +479,9 @@ export const FormatValidatorBasic: FormatValidator_2;
 // @alpha
 export const FormatValidatorNoOp: FormatValidator;
 
+// @alpha
+export type FormatVersion = number | string | undefined;
+
 // @alpha
 export function generateSchemaFromSimpleSchema(simple: SimpleTreeSchema): TreeSchema;
 
@@ -1090,6 +1099,12 @@ export type Myself<M extends IMember = IMember> = M & {
     readonly currentConnection: string;
 };
 
+// @alpha
+export interface NoChangeConstraint {
+    // (undocumented)
+    readonly type: "noChange";
+}
+
 // @public @system
 type NodeBuilderData<T extends TreeNodeSchemaCore<string, NodeKind, boolean>> = T extends TreeNodeSchemaCore<string, NodeKind, boolean, unknown, infer TBuild> ? TBuild : never;
 
@@ -1288,7 +1303,7 @@ export interface RunTransaction {
 
 // @alpha @input
 export interface RunTransactionParams {
-    readonly preconditions?: readonly TransactionConstraint[];
+    readonly preconditions?: readonly TransactionConstraintAlpha[];
 }
 
 // @public @sealed
@@ -1770,12 +1785,15 @@ export type TransactionCallbackStatus<TSuccessValue, TFailureValue> = ({
     rollback: true;
     value: TFailureValue;
 }) & {
-    preconditionsOnRevert?: readonly TransactionConstraint[];
+    preconditionsOnRevert?: readonly TransactionConstraintAlpha[];
 };
 
 // @public
 export type TransactionConstraint = NodeInDocumentConstraint;
 
+// @alpha @sealed
+export type TransactionConstraintAlpha = TransactionConstraint | NoChangeConstraint;
+
 // @alpha
 export type TransactionResult = Omit<TransactionResultSuccess<unknown>, "value"> | Omit<TransactionResultFailed<unknown>, "value">;
 

package/dist/alpha.d.ts

@@ -196,6 +196,7 @@ export {
 	ArrayNodeSchema, 
 	BranchableTree, 
 	ChangeMetadata, 
+	CodecName, 
 	CodecWriteOptions, 
 	DirtyTreeMap, 
 	DirtyTreeStatus, 
@@ -208,6 +209,7 @@ export {
 	FormatValidator, 
 	FormatValidatorBasic, 
 	FormatValidatorNoOp, 
+	FormatVersion, 
 	HandleConverter, 
 	ICodecOptions, 
 	ITreeAlpha, 
@@ -238,6 +240,7 @@ export {
 	MapNodeCustomizableSchemaUnsafe, 
 	MapNodePojoEmulationSchema, 
 	MapNodeSchema, 
+	NoChangeConstraint, 
 	NodeSchemaOptionsAlpha, 
 	ObjectNodeSchema, 
 	ObjectSchemaOptionsAlpha, 
@@ -269,6 +272,7 @@ export {
 	System_TableSchema, 
 	TableSchema, 
 	TransactionCallbackStatus, 
+	TransactionConstraintAlpha, 
 	TransactionResult, 
 	TransactionResultExt, 
 	TransactionResultFailed, 

package/lib/alpha.d.ts

@@ -196,6 +196,7 @@ export {
 	ArrayNodeSchema, 
 	BranchableTree, 
 	ChangeMetadata, 
+	CodecName, 
 	CodecWriteOptions, 
 	DirtyTreeMap, 
 	DirtyTreeStatus, 
@@ -208,6 +209,7 @@ export {
 	FormatValidator, 
 	FormatValidatorBasic, 
 	FormatValidatorNoOp, 
+	FormatVersion, 
 	HandleConverter, 
 	ICodecOptions, 
 	ITreeAlpha, 
@@ -238,6 +240,7 @@ export {
 	MapNodeCustomizableSchemaUnsafe, 
 	MapNodePojoEmulationSchema, 
 	MapNodeSchema, 
+	NoChangeConstraint, 
 	NodeSchemaOptionsAlpha, 
 	ObjectNodeSchema, 
 	ObjectSchemaOptionsAlpha, 
@@ -269,6 +272,7 @@ export {
 	System_TableSchema, 
 	TableSchema, 
 	TransactionCallbackStatus, 
+	TransactionConstraintAlpha, 
 	TransactionResult, 
 	TransactionResultExt, 
 	TransactionResultFailed, 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "2.74.0",
+  "version": "2.80.0",
   "description": "The main entry point into Fluid Framework public packages",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,32 +57,32 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.74.0",
-    "@fluidframework/container-loader": "~2.74.0",
-    "@fluidframework/core-interfaces": "~2.74.0",
-    "@fluidframework/core-utils": "~2.74.0",
-    "@fluidframework/driver-definitions": "~2.74.0",
-    "@fluidframework/fluid-static": "~2.74.0",
-    "@fluidframework/map": "~2.74.0",
-    "@fluidframework/runtime-utils": "~2.74.0",
-    "@fluidframework/sequence": "~2.74.0",
-    "@fluidframework/shared-object-base": "~2.74.0",
-    "@fluidframework/tree": "~2.74.0"
+    "@fluidframework/container-definitions": "~2.80.0",
+    "@fluidframework/container-loader": "~2.80.0",
+    "@fluidframework/core-interfaces": "~2.80.0",
+    "@fluidframework/core-utils": "~2.80.0",
+    "@fluidframework/driver-definitions": "~2.80.0",
+    "@fluidframework/fluid-static": "~2.80.0",
+    "@fluidframework/map": "~2.80.0",
+    "@fluidframework/runtime-utils": "~2.80.0",
+    "@fluidframework/sequence": "~2.80.0",
+    "@fluidframework/shared-object-base": "~2.80.0",
+    "@fluidframework/tree": "~2.80.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.1",
+    "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-tools/build-cli": "^0.61.0",
+    "@fluid-tools/build-cli": "^0.62.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.61.0",
-    "@fluidframework/eslint-config-fluid": "~2.74.0",
+    "@fluidframework/build-tools": "^0.62.0",
+    "@fluidframework/eslint-config-fluid": "~2.80.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/node": "^18.19.0",
-    "concurrently": "^8.2.1",
+    "concurrently": "^9.2.1",
     "copyfiles": "^2.4.1",
-    "eslint": "~8.57.1",
+    "eslint": "~9.39.1",
     "jiti": "^2.6.1",
-    "rimraf": "^4.4.0",
+    "rimraf": "^6.1.2",
     "typescript": "~5.4.5"
   },
   "fluidBuild": {