Skip to content

Commit

Permalink
Add changeset for removing the inbound and outbound queues on IDeltaM…
Browse files Browse the repository at this point in the history
…anager (microsoft#23024)

## Description

Add chngeset for removing the inbound and outbound queues on
iDeltamanager. Refer to this PR for extra details:
microsoft#22282

---------

Co-authored-by: Jatin Garg <[email protected]>
Co-authored-by: Tyler Butler <[email protected]>
  • Loading branch information
3 people authored Nov 7, 2024
1 parent 99d6b8c commit 509d6a1
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions .changeset/nice-flies-brake.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@

The inbound and outbound properties have been removed from IDeltaManager

The inbound and outbound properties were deprecated in a previous release and have been removed from IDeltaManager. Please check pull request [#19636](https://github.com/microsoft/FluidFramework/pull/19636) for alternative APIs.
The inbound and outbound properties were [deprecated in version 2.0.0-rc.2.0.0](https://github.com/microsoft/FluidFramework/blob/main/RELEASE_NOTES/2.0.0-rc.2.0.0.md#container-definitions-deprecate-ideltamanagerinbound-and-ideltamanageroutbound) and have been removed from `IDeltaManager`.

This is the link to the [Release Notes](https://github.com/microsoft/FluidFramework/blob/main/RELEASE_NOTES/2.0.0-rc.2.0.0.md#container-definitions-deprecate-ideltamanagerinbound-and-ideltamanageroutbound)
which contains more instructions on the alternatives.
`IDeltaManager.inbound` contained functionality that could break core runtime features such as summarization and processing batches if used improperly. Data loss or corruption could occur when `IDeltaManger.inbound.pause()` or `IDeltaManager.inbound.resume()` were called.

Similarly, `IDeltaManager.outbound` contained functionality that could break core runtime features such as generation of batches and chunking. Data loss or corruption could occur when `IDeltaManger.inbound.pause()` or `IDeltaManager.inbound.resume()` were called.

#### Alternatives

- Alternatives to `IDeltaManager.inbound.on("op", ...)` are `IDeltaManager.on("op", ...)`
- Alternatives to calling `IDeltaManager.inbound.pause`, `IDeltaManager.outbound.pause` for `IContainer` disconnect use `IContainer.disconnect`.
- Alternatives to calling `IDeltaManager.inbound.resume`, `IDeltaManager.outbound.resume` for `IContainer` reconnect use `IContainer.connect`.

0 comments on commit 509d6a1

Please sign in to comment.