Fluid Framework v3.5.0 (minor)

Contents

• 🌳 SharedTree DDS Changes
  • Export stored content and schema from alpha viewable trees (#28383)
  • SharedTree commit settlement events and no-change constraints are available in beta and legacy (#28254)
  • Preserve tagged diagnostics when reporting sandbox session errors (#28401)
  • Add a format validator for environments that disallow dynamic code generation (#28430)

🌳 SharedTree DDS Changes

Export stored content and schema from alpha viewable trees (#28383)

The new ViewableTreeAlpha interface provides exportVerbose and exportSimpleSchema methods. Use asAlpha(viewableTree) to inspect stored tree content and schema without first creating a schematized view.

Change details

Commit: 8150149

Affected packages:

• @fluidframework/tree
• fluid-framework

⬆️ Table of contents

SharedTree commit settlement events and no-change constraints are available in beta and legacy (#28254)

You can now observe whether a local SharedTree commit is applied or dropped after the sequencing service orders it without using alpha APIs. CommitOutcome and LocalCommitEvents are available from the /beta and /legacy entry points of @fluidframework/tree and fluid-framework. The changed event is available on TreeViewBeta and UntypedTreeView, with ChangeMetadataBeta and TreeBranchEventsBeta describing its beta API.

import { asBeta, CommitOutcome } from "fluid-framework/beta";

// ...
const betaView = asBeta(view);
const unsubscribe = betaView.events.on("changed", (metadata) => {
  if (metadata.isLocal) {
    metadata.events.on("settled", (outcome) => {
      if (outcome === CommitOutcome.FullyApplied) {
        console.log("Changes saved.");
      } else {
        console.log("Changes rejected.");
      }
    });
  }
});

Register the changed listener before making the edit or running the transaction. Do not edit the tree synchronously from a settlement callback; schedule any retry asynchronously.

You can also use NoChangeConstraint through the beta transaction APIs to require that the document has not changed before a transaction is applied. TransactionConstraintBeta includes this constraint, which you can supply in RunTransactionParamsBeta.preconditions. These APIs are available through both /beta and /legacy.

betaView.runTransaction(
  () => {
    // Make edits.
  },
  { preconditions: [{ type: "noChange" }] },
);

You can separately constrain a later revert by returning preconditionsOnRevert: [{ type: "noChange" }] from the transaction callback. This option is available on TransactionCallbackStatusBeta and requires that the document has not changed since the transaction before applying its revert.

Change details

Commit: f557bb4

Affected packages:

• @fluidframework/tree
• fluid-framework

⬆️ Table of contents

Preserve tagged diagnostics when reporting sandbox session errors (#28401)

Sandbox session errors retain their original cause and tagged telemetry properties. Failure notifications include a validated classification code and separate protocol-only and sensitive diagnostic fields. The Host tags protocol-only text received from the Guest as SandboxGuestData, and sensitive text as UserData. Applications that use the Guest as a security boundary must treat this tag as untrusted, potentially sensitive data. The Host does not send sensitive diagnostics to the Guest. Unknown error messages are not included in the telemetry-safe session error message. Blob-resolution errors are logged on the Host, while the Guest receives a fixed message that the service failed to resolve the handle.

Change details

Commit: bcd245b

Affected packages:

• @fluidframework/tree
• fluid-framework

⬆️ Table of contents

Add a format validator for environments that disallow dynamic code generation (#28430)

The new alpha FormatValidatorInterpreted validates persisted SharedTree data using TypeBox's JSON schema interpreter. Unlike FormatValidatorBasic, it does not generate JavaScript functions at runtime, so it works with Content Security Policies that omit unsafe-eval. Interpreted validation is slower than compiled validation, so applications without this restriction should continue to use FormatValidatorBasic. SharedTree sandbox protocol validation now uses the interpreted validator so it also works in these restricted environments.

import {
  FormatValidatorInterpreted,
  configuredSharedTreeAlpha,
} from "@fluidframework/tree/alpha";

const SharedTree = configuredSharedTreeAlpha({
  jsonValidator: FormatValidatorInterpreted,
});

Change details

Commit: e3c7f01

Affected packages:

• @fluidframework/tree
• fluid-framework

⬆️ Table of contents

🛠️ Start Building Today!

Please continue to engage with us on GitHub Discussion and Issue pages as you adopt Fluid Framework!