fluid-framework 2.74.0 → 2.81.0-374083

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

@@ -142,26 +142,28 @@ export interface BranchableTree extends ViewableTree {
 }
 
 // @alpha @sealed
-export type ChangeMetadata = CommitMetadata & ({
-    readonly isLocal: true;
-    getChange(): JsonCompatibleReadOnly;
-} | {
-    readonly isLocal: false;
-    readonly getChange?: undefined;
-});
+export type ChangeMetadata = LocalChangeMetadata | RemoteChangeMetadata;
 
 // @alpha
 export function checkCompatibility(viewWhichCreatedStoredSchema: TreeViewConfiguration, view: TreeViewConfiguration): Omit<SchemaCompatibilityStatus, "canInitialize">;
 
+// @alpha
+export function checkSchemaCompatibilitySnapshots(options: SchemaCompatibilitySnapshotsOptions): void;
+
 // @alpha
 export function cloneWithReplacements(root: unknown, rootKey: string, replacer: (key: string, value: unknown) => {
     clone: boolean;
     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 +413,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 +476,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;
 
@@ -1048,6 +1054,13 @@ export type Listeners<T extends object> = {
     [P in (string | symbol) & keyof T as IsListener<T[P]> extends true ? P : never]: T[P];
 };
 
+// @alpha @sealed
+export interface LocalChangeMetadata extends CommitMetadata {
+    getChange(): JsonCompatibleReadOnly;
+    getRevertible(onDisposed?: (revertible: RevertibleAlpha) => void): RevertibleAlpha | undefined;
+    readonly isLocal: true;
+}
+
 // @public @sealed
 export interface MakeNominal {
 }
@@ -1090,6 +1103,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;
 
@@ -1215,6 +1234,13 @@ export const RecordNodeSchema: {
     readonly [Symbol.hasInstance]: (value: TreeNodeSchema) => value is RecordNodeSchema<string, ImplicitAllowedTypes, true, unknown>;
 };
 
+// @alpha @sealed
+export interface RemoteChangeMetadata extends CommitMetadata {
+    readonly getChange?: undefined;
+    readonly getRevertible?: undefined;
+    readonly isLocal: false;
+}
+
 // @alpha
 export function replaceConciseTreeHandles<T>(tree: ConciseTree, replacer: HandleConverter<T>): ConciseTree<T>;
 
@@ -1288,7 +1314,18 @@ export interface RunTransaction {
 
 // @alpha @input
 export interface RunTransactionParams {
-    readonly preconditions?: readonly TransactionConstraint[];
+    readonly preconditions?: readonly TransactionConstraintAlpha[];
+}
+
+// @alpha @input
+export interface SchemaCompatibilitySnapshotsOptions {
+    readonly fileSystem: SnapshotFileSystem;
+    readonly minVersionForCollaboration: string;
+    readonly mode: "test" | "update";
+    readonly schema: TreeViewConfiguration;
+    readonly snapshotDirectory: string;
+    readonly snapshotUnchangedVersions?: true;
+    readonly version: string;
 }
 
 // @public @sealed
@@ -1435,6 +1472,7 @@ export interface SharedTreeFormatOptions {
 
 // @alpha @input
 export interface SharedTreeOptions extends SharedTreeOptionsBeta, Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions> {
+    readonly enableDetachedRootEditing?: boolean;
     readonly enableSharedBranches?: boolean;
     shouldEncodeIncrementally?: IncrementalEncodingPolicy;
 }
@@ -1522,6 +1560,19 @@ export function singletonSchema<TScope extends string, TName extends string | nu
     readonly value: TName;
 }, Record<string, never>, true, Record<string, never>, undefined>;
 
+// @alpha @input
+export interface SnapshotFileSystem {
+    join(parentPath: string, childPath: string): string;
+    mkdirSync(dir: string, options: {
+        recursive: true;
+    }): void;
+    readdirSync(dir: string): readonly string[];
+    readFileSync(file: string, encoding: "utf8"): string;
+    writeFileSync(file: string, data: string, options: {
+        encoding: "utf8";
+    }): void;
+}
+
 // @alpha @system
 export namespace System_TableSchema {
     // @sealed @system
@@ -1770,12 +1821,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/api-report/fluid-framework.legacy.beta.api.md

@@ -800,7 +800,9 @@ export interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents &
 // @beta @sealed @legacy
 export interface ISharedDirectoryEvents extends ISharedObjectEvents {
     (event: "valueChanged", listener: (changed: IDirectoryValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    // @deprecated
     (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
+    (event: "cleared", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
     (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
     (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
 }

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, 
@@ -234,10 +236,12 @@ export {
 	JsonSchemaType, 
 	JsonStringKeyPatternProperties, 
 	JsonTreeSchema, 
+	LocalChangeMetadata, 
 	MapNodeCustomizableSchema, 
 	MapNodeCustomizableSchemaUnsafe, 
 	MapNodePojoEmulationSchema, 
 	MapNodeSchema, 
+	NoChangeConstraint, 
 	NodeSchemaOptionsAlpha, 
 	ObjectNodeSchema, 
 	ObjectSchemaOptionsAlpha, 
@@ -247,9 +251,11 @@ export {
 	RecordNodeCustomizableSchema, 
 	RecordNodePojoEmulationSchema, 
 	RecordNodeSchema, 
+	RemoteChangeMetadata, 
 	RevertibleAlpha, 
 	RevertibleAlphaFactory, 
 	RunTransactionParams, 
+	SchemaCompatibilitySnapshotsOptions, 
 	SchemaFactoryAlpha, 
 	SchemaType, 
 	SharedTreeFormatOptions, 
@@ -266,9 +272,11 @@ export {
 	SimpleRecordNodeSchema, 
 	SimpleTreeIndex, 
 	SimpleTreeSchema, 
+	SnapshotFileSystem, 
 	System_TableSchema, 
 	TableSchema, 
 	TransactionCallbackStatus, 
+	TransactionConstraintAlpha, 
 	TransactionResult, 
 	TransactionResultExt, 
 	TransactionResultFailed, 
@@ -297,6 +305,7 @@ export {
 	asAlpha, 
 	asTreeViewAlpha, 
 	checkCompatibility, 
+	checkSchemaCompatibilitySnapshots, 
 	cloneWithReplacements, 
 	comparePersistedSchema, 
 	configuredSharedTree, 

package/eslint.config.mts

@@ -1,8 +1,8 @@
-/* eslint-disable */
-/**
- * GENERATED FILE - DO NOT EDIT DIRECTLY.
- * To regenerate: pnpm tsx scripts/generate-flat-eslint-configs.ts --typescript
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
  */
+
 import type { Linter } from "eslint";
 import { strict } from "../../../common/build/eslint-config-fluid/flat.mts";
 

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, 
@@ -234,10 +236,12 @@ export {
 	JsonSchemaType, 
 	JsonStringKeyPatternProperties, 
 	JsonTreeSchema, 
+	LocalChangeMetadata, 
 	MapNodeCustomizableSchema, 
 	MapNodeCustomizableSchemaUnsafe, 
 	MapNodePojoEmulationSchema, 
 	MapNodeSchema, 
+	NoChangeConstraint, 
 	NodeSchemaOptionsAlpha, 
 	ObjectNodeSchema, 
 	ObjectSchemaOptionsAlpha, 
@@ -247,9 +251,11 @@ export {
 	RecordNodeCustomizableSchema, 
 	RecordNodePojoEmulationSchema, 
 	RecordNodeSchema, 
+	RemoteChangeMetadata, 
 	RevertibleAlpha, 
 	RevertibleAlphaFactory, 
 	RunTransactionParams, 
+	SchemaCompatibilitySnapshotsOptions, 
 	SchemaFactoryAlpha, 
 	SchemaType, 
 	SharedTreeFormatOptions, 
@@ -266,9 +272,11 @@ export {
 	SimpleRecordNodeSchema, 
 	SimpleTreeIndex, 
 	SimpleTreeSchema, 
+	SnapshotFileSystem, 
 	System_TableSchema, 
 	TableSchema, 
 	TransactionCallbackStatus, 
+	TransactionConstraintAlpha, 
 	TransactionResult, 
 	TransactionResultExt, 
 	TransactionResultFailed, 
@@ -297,6 +305,7 @@ export {
 	asAlpha, 
 	asTreeViewAlpha, 
 	checkCompatibility, 
+	checkSchemaCompatibilitySnapshots, 
 	cloneWithReplacements, 
 	comparePersistedSchema, 
 	configuredSharedTree, 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "2.74.0",
+  "version": "2.81.0-374083",
   "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.81.0-374083",
+    "@fluidframework/container-loader": "2.81.0-374083",
+    "@fluidframework/core-interfaces": "2.81.0-374083",
+    "@fluidframework/core-utils": "2.81.0-374083",
+    "@fluidframework/driver-definitions": "2.81.0-374083",
+    "@fluidframework/fluid-static": "2.81.0-374083",
+    "@fluidframework/map": "2.81.0-374083",
+    "@fluidframework/runtime-utils": "2.81.0-374083",
+    "@fluidframework/sequence": "2.81.0-374083",
+    "@fluidframework/shared-object-base": "2.81.0-374083",
+    "@fluidframework/tree": "2.81.0-374083"
   },
   "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.63.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.61.0",
-    "@fluidframework/eslint-config-fluid": "~2.74.0",
+    "@fluidframework/build-tools": "^0.63.0",
+    "@fluidframework/eslint-config-fluid": "2.81.0-374083",
     "@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": {

package/.eslintrc.cjs

@@ -1,12 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	extends: ["@fluidframework/eslint-config-fluid/strict", "prettier"],
-	parserOptions: {
-		project: ["./tsconfig.json"],
-	},
-	rules: {},
-};