Upcoming Release: FluidFramework v2.14.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.14.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.14.0

Contents

• Legacy API Changes
  • MockLogger has been removed from the alpha+legacy API surface (#23473)
  • Remove deprecated Merge-Tree and SharedString ISegment members (#23448)

Legacy API Changes

MockLogger has been removed from the alpha+legacy API surface (#23473)

The MockLogger class previously exposed in the alpha+legacy API surface of @fluidframework/telemetry-utils has been removed. No replacement is provided, as this class was only intended for use in testing scenarios, and should be trivial to re-implement in any codebase that still uses it.

Change details

Commit: 237f042

Affected packages:

• @fluidframework/telemetry-utils

⬆️ Table of contents

Remove deprecated Merge-Tree and SharedString ISegment members (#23448)

The current ISegment interface over-exposes a number of properties which do not have an external use case, and any external usage could result in damage to the underlying merge-tree including data corruption. In Fluid Framework release 2.12.0 these properties and associated types were deprecated.

The only use case that will continue to be supported is determining if a segment is removed. For this purpose we've added the free function segmentIsRemoved(segment: ISegment): boolean.

For example, checking if a segment is not removed would change as follows:

- if(segment.removedSeq === undefined){
+ if(!segmentIsRemoved(segment)){

The following properties are removed from ISegment and its implementations:

• clientId
• index
• localMovedSeq
• localRefs
• localRemovedSeq
• localSeq
• movedClientsIds
• movedSeq
• movedSeqs
• ordinal
• removedClientIds
• removedSeq
• seq
• wasMovedOnInsert

Additionally, the following types are also removed:

• IMergeNodeCommon
• IMoveInfo
• IRemovalInfo
• LocalReferenceCollection

Change details

Commit: e98574f

Affected packages:

• @fluidframework/merge-tree
• @fluidframework/sequence

⬆️ Table of contents

🛠️ Start Building Today!

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