Add HSM Deletion Tombstone Tracking #7014
Draft
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
justinp-tt
changed the title
justinp-tt
changed the title
bergundy
reviewed
Dec 19, 2024
Comment on lines
5934
to
5964
| case "Activity": | ||
| tombstone = &persistencespb.StateMachineTombstone{ | ||
| StateMachineKey: &persistencespb.StateMachineTombstone_ActivityScheduledEventId{ | ||
| ActivityScheduledEventId: ms.parseID(key.ID), | ||
| }, | ||
| } | ||
| case "Timer": | ||
| tombstone = &persistencespb.StateMachineTombstone{ | ||
| StateMachineKey: &persistencespb.StateMachineTombstone_TimerId{ | ||
| TimerId: key.ID, | ||
| }, | ||
| } | ||
| case "ChildExecution": | ||
| tombstone = &persistencespb.StateMachineTombstone{ | ||
| StateMachineKey: &persistencespb.StateMachineTombstone_ChildExecutionInitiatedEventId{ | ||
| ChildExecutionInitiatedEventId: ms.parseID(key.ID), | ||
| }, | ||
| } | ||
| case "RequestCancel": | ||
| tombstone = &persistencespb.StateMachineTombstone{ | ||
| StateMachineKey: &persistencespb.StateMachineTombstone_RequestCancelInitiatedEventId{ | ||
| RequestCancelInitiatedEventId: ms.parseID(key.ID), | ||
| }, | ||
| } | ||
| case "Signal": | ||
| tombstone = &persistencespb.StateMachineTombstone{ | ||
| StateMachineKey: &persistencespb.StateMachineTombstone_SignalExternalInitiatedEventId{ | ||
| SignalExternalInitiatedEventId: ms.parseID(key.ID), | ||
| }, | ||
| } | ||
| } |
There was a problem hiding this comment.
This is not necessary, you only need to track StateMachinePath changes here. Activities and other state machines pre-date the HSM framework and won't be reflected in the oplog.
bergundy
reviewed
Dec 19, 2024
| if ms.stateMachineNode != nil { | ||
| opLog, err := ms.stateMachineNode.Outputs() | ||
| if err != nil { | ||
| panic(fmt.Sprintf("Failed to get HSM operation log: %v", err)) |
There was a problem hiding this comment.
Don't panic here, return an error instead and handle it in the caller.
There was a problem hiding this comment.
I'd be okay panicking if the only reason this would happen only unexpectedly. Consider making the Outputs() function panic instead of returning an error.
bergundy
reviewed
Dec 19, 2024
| @@ -5907,6 +5907,39 @@ func (ms *MutableStateImpl) closeTransactionTrackTombstones( | |||
| } | |||
|
|
|||
| var tombstones []*persistencespb.StateMachineTombstone | |||
| if ms.stateMachineNode != nil { | |||
| opLog, err := ms.stateMachineNode.Outputs() | |||
There was a problem hiding this comment.
We can rename Outputs to OpLog.
yycptt
approved these changes
Dec 19, 2024
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.
What changed?
StateMachinePathtombstone type for HSM deletions alongside existing activity/timer/etc. tombstonesWhy?
Without this:
How did you test it?
Draft PR. Tests not developed yet
Potential risks
Risk Mitigation:
Documentation
No changes required - this extends an internal implementation detail of how deletions are tracked.
Is hotfix candidate?
No - this should follow normal deployment process.