Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Merge-Tree and SharedString ISegment Deprecations #23328

Open
anthony-murphy opened this issue Dec 13, 2024 · 1 comment
Open

Remove Merge-Tree and SharedString ISegment Deprecations #23328

anthony-murphy opened this issue Dec 13, 2024 · 1 comment
Assignees
Labels
api deprecation Changes to a deprecated API triage

Comments

@anthony-murphy
Copy link
Contributor

anthony-murphy commented Dec 13, 2024


"@fluidframework/merge-tree": minor
"@fluidframework/sequence": minor


"section": deprecation

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.

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 will be removed on ISegment and its implementations:

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

Additionally, the following types will be remove, and will become internal (i.e. users of the Fluid Framework will not have access to them):

  • IMergeNodeCommon
  • IMoveInfo
  • IRemovalInfo
  • LocalReferenceCollection
@anthony-murphy anthony-murphy added the api deprecation Changes to a deprecated API label Dec 13, 2024
@anthony-murphy anthony-murphy changed the title Merge-Tree and SharedString ISegment Deprecations Remove Merge-Tree and SharedString ISegment Deprecations Dec 13, 2024
@anthony-murphy
Copy link
Contributor Author

#23323

@anthony-murphy anthony-murphy self-assigned this Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api deprecation Changes to a deprecated API triage
Projects
None yet
Development

No branches or pull requests

1 participant