[fix] Default journal_retention to zero when reading old invoker effects #3451
Conversation
This file contains hidden or 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
This fixes a bug where restate v1.4.0 would fail to deserialize old invoker effects from bifrost. Example error: ``` 2025-06-24T10:51:30.432763Z ERROR run: restate_types::storage::decode: Flexbuffers error at field command.InvokerEffect.kind.JournalEntryV2.entry.inner.Command.command_specific_metadata.CallOrSend err=command.InvokerEffect.kind.JournalEntryV2.entry.inner.Command.command_specific_metadata.CallOrSend: Serde Error: missing field `journal_retention_duration` partition_id=5 2025-06-24T10:51:30.432772Z ERROR run: restate_wal_protocol::envelope: FlexbuffersSerde decode failure (decoding Envelope) err=decoding failed: Serde Error: missing field `journal_retention_duration` partition_id=5 2025-06-24T10:51:30.432788Z WARN run: restate_worker::partition: Shutting partition processor down because of error: decoding failed: Serde Error: missing field `journal_retention_duration` partition_id=5 ```
pcholakov
approved these changes
Jun 24, 2025
tillrohrmann
approved these changes
Jun 24, 2025
There was a problem hiding this comment.
Thanks a lot for fixing this problem @AhmedSoliman. Defaulting to a 0 duration should be correct. LGTM. +1 for merging.
| @@ -175,6 +175,9 @@ pub struct CallOrSendMetadata { | |||
| pub invocation_target: InvocationTarget, | |||
| pub span_context: ServiceInvocationSpanContext, | |||
| pub completion_retention_duration: Duration, | |||
| // Since v1.4.0. Messages older than v1.4.0 will have zero retention as that | |||
| // matches the default behaviour of <= 1.3.x. | |||
| #[serde(default)] | |||
There was a problem hiding this comment.
I guess this also needs skip_serializing_if zero?
There was a problem hiding this comment.
Flexbuffer serialization should skip unknown fields if I am not mistaken so for this specific encoding format it might not be needed.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This fixes a bug where restate v1.4.0 would fail to deserialize old invoker effects from bifrost.
Example error: