Upcoming Release: FluidFramework v2.21.0

[tylerbutler]

This issue is automatically updated with a preview of the release notes for the upcoming Fluid Framework release.

To generate release notes locally to commit to the RELEASE_NOTES folder in the repo, run the following command:

pnpm flub generate releaseNotes -g client -t minor --outFile RELEASE_NOTES/2.21.0.md

To generate the release notes to paste into the GitHub Release, run the following command:

pnpm flub generate releaseNotes -g client -t minor --headingLinks --excludeH1 --outFile temporary-file.md

This should happen automatically as part of the release process, but if you need to generate the release notes manually, you can use the above command.

---

Fluid Framework v2.21.0

Contents

• 🐛 Bug Fixes
  • SharedMap, SharedIntervalCollection and AttributableMap now error on unrecognized Ops (#23659)
• ⚠️ Deprecations
  • Deprecate unnecessary exports of container-runtime package (#23607)
  • supportedFeatures is deprecated in IContainerContext (#22877)

🐛 Bug Fixes

SharedMap, SharedIntervalCollection and AttributableMap now error on unrecognized Ops (#23659)

To avoid future versions of DDSes with new Op types causing silent data corruption and de-sync between clients, DDSes should error when unable to apply an Op. This prevents data loss and corruption scenarios like a summary client using old code discarding all ops from newer clients.

If updating applications using SharedMap, SharedIntervalCollection and AttributableMap use a newer version which adds Ops types in the future, old clients which are old enough to be from before this fix will ignore the new ops instead of erroring. Therefore it may be useful to ensure this update is deployed as widely as possible before migrating any to newer versions which add new op formats to these DDSes.

Change details

Commit: 3dd4208

Affected packages:

• @fluid-experimental/attributable-map
• @fluidframework/map
• @fluidframework/sequence

⬆️ Table of contents

⚠️ Deprecations

Deprecate unnecessary exports of container-runtime package (#23607)

The following types in the @fluidframework/container-runtime are deprecated. These types are unnecessary for external users of this package.

• currentDocumentVersionSchema
• DeletedResponseHeaderKey
• DocumentSchemaValueType
• DocumentsSchemaController
• GCFeatureMatrix
• GCNodeType
• GCVersion
• IBlobManagerLoadInfo
• ICancellableSummarizerController
• ICancellationToken
• IConnectableRuntime
• IContainerRuntimeMetadata
• ICreateContainerMetadata
• IDocumentSchema
• IDocumentSchemaChangeMessage
• IDocumentSchemaCurrent
• IDocumentSchemaFeatures
• IGCMetadata
• IGCStats
• IMarkPhaseStats
• IRefreshSummaryAckOptions
• ISerializedElection
• ISubmitSummaryOptions
• ISummarizerInternalsProvider
• ISummarizerRuntime
• ISummaryCancellationToken
• ISummaryMetadataMessage
• ISweepPhaseStats
• Summarizer

Change details

Commit: 3da5b42

Affected packages:

• @fluidframework/container-runtime

⬆️ Table of contents

supportedFeatures is deprecated in IContainerContext (#22877)

This was an optional property that was used internally to communicate features supported by the Loader layer to Runtime. This has been replaced with an internal-only functionality.

Change details

Commit: 4c06412

Affected packages:

• @fluidframework/container-definitions

⬆️ Table of contents

🛠️ Start Building Today!

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