Make handle parsing/decoding functions idempotent #21102
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
markfields
requested review from
DLehenbauer,
anthony-murphy,
Abe27342 and
scottn12
github-actions
bot
added
area: dds
⯆ @fluid-example/bundle-size-tests: -139 Bytes
Baseline commit: 1018e0f |
alexvy86
reviewed
May 16, 2024
tyler-cai-microsoft
approved these changes
May 16, 2024
Co-authored-by: Alex Villarreal <[email protected]>
|
FYI--'reviewer guidance' section needs update. Mark and I looked into these failures just now and verified that the same failure JSON (i.e. sequence of steps) doesn't reproduce the assert today. Since the original PR, there have been a few fixes to SharedString/merge-tree which are plausibly what fixed the issue. Notably, we fixed an issue where objects in SharedString ops would be reference-equal to property bags in the string. It would make sense removing the round-trip in that PR would cause bad behavior given the existence of this bug at the time. |
Abe27342
approved these changes
May 20, 2024
markfields
added a commit
to markfields/FluidFramework
that referenced
this pull request
May 20, 2024
Fixes microsoft#8016. We need to port this back to RC3 and RC4 once merged to main. For anyone implementing their own DDS, when they pick up an FF release with microsoft#19242 in it, they will likely be in a position where handles are going through `parseHandles` or `serializer.decode` twice. We assumed this was idempotent but found that it is not, with two different codepaths needing to be fixed. Note that `parseHandles` may return the same object unmodified now, wherease before it would always clone (via `JSON.stringify` roundtrip) --------- Co-authored-by: Alex Villarreal <[email protected]>
markfields
added a commit
to markfields/FluidFramework
that referenced
this pull request
May 20, 2024
Fixes microsoft#8016. We need to port this back to RC3 and RC4 once merged to main. For anyone implementing their own DDS, when they pick up an FF release with microsoft#19242 in it, they will likely be in a position where handles are going through `parseHandles` or `serializer.decode` twice. We assumed this was idempotent but found that it is not, with two different codepaths needing to be fixed. Note that `parseHandles` may return the same object unmodified now, wherease before it would always clone (via `JSON.stringify` roundtrip) --------- Co-authored-by: Alex Villarreal <[email protected]>
This was referenced May 20, 2024
markfields
added a commit
that referenced
this pull request
May 20, 2024
#21169) Port #21102 to `release/client/2.0.0-rc.4.0` For anyone implementing their own DDS, when upgrading from `2.0.0-rc.2.0` to `2.0.0-rc.3.0` or later, they will likely be in a position where handles are going through `parseHandles` or `serializer.decode` twice. Without this fix, those functions are not idempotent and will hit a fatal error being called twice. Note that `parseHandles` may return the same object unmodified now, whereas before it would always clone (via `JSON.stringify` roundtrip) Co-authored-by: Alex Villarreal <[email protected]>
markfields
added a commit
that referenced
this pull request
May 21, 2024
#21170) Port #21102 to `release/client/2.0.0-rc.3.0` For anyone implementing their own DDS, when upgrading from `2.0.0-rc.2.0` to `2.0.0-rc.3.0` or later, they will likely be in a position where handles are going through `parseHandles` or `serializer.decode` twice. Without this fix, those functions are not idempotent and will hit a fatal error being called twice. Note that `parseHandles` may return the same object unmodified now, whereas before it would always clone (via `JSON.stringify` roundtrip) Co-authored-by: Alex Villarreal <[email protected]>
kekachmar
pushed a commit
to kekachmar/FluidFramework
that referenced
this pull request
May 21, 2024
Fixes microsoft#8016. We need to port this back to RC3 and RC4 once merged to main. For anyone implementing their own DDS, when they pick up an FF release with microsoft#19242 in it, they will likely be in a position where handles are going through `parseHandles` or `serializer.decode` twice. We assumed this was idempotent but found that it is not, with two different codepaths needing to be fixed. Note that `parseHandles` may return the same object unmodified now, wherease before it would always clone (via `JSON.stringify` roundtrip) --------- Co-authored-by: Alex Villarreal <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes AB#8016. We need to port this back to RC3 and RC4 once merged to main.
For anyone implementing their own DDS, when they pick up an FF release with #19242 in it, they will likely be in a position where handles are going through
parseHandlesorserializer.decodetwice.We assumed this was idempotent but found that it is not, with two different codepaths needing to be fixed.
Reviewer Guidance
This is a superset of #19716. In that discussion you'll see reference made to some DDS Fuzz test failures for particular seeds. Abram and I took the JSON from those failures and tested those scripts against main and they were fine, so proceeding.