Uh oh!
There was an error while loading. Please reload this page.
Add deterministic NewGuid() to OrchestrationContext - #124
Open
kaibocai (kaibocai) wants to merge 1 commit into
Open
Add deterministic NewGuid() to OrchestrationContext#124kaibocai (kaibocai) wants to merge 1 commit into
kaibocai (kaibocai) wants to merge 1 commit into
Conversation
Add a replay-safe, deterministic UUID generation method to
OrchestrationContext, aligned with the .NET Durable Task SDK.
Algorithm: UUID v5 (SHA-1, RFC 4122) using the same namespace
(9e952958-5e33-4daf-827f-2fa12937b875) and name format
(instanceId_timestamp_counter) as the .NET implementation.
Key details:
- Timestamp formatted with exactly 7 fractional digits to match
.NET DateTime.ToString("o")
- Nanoseconds truncated to 100ns (tick) precision for .NET parity
- Counter starts at 0 per context, incremented after each call
- Produces identical UUIDs to .NET SDK for same inputs
Tests: 9 unit tests + 1 integration test covering determinism,
uniqueness, .NET format alignment, golden value regression,
UUID v5 compliance, and replay safety.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>Contributor
There was a problem hiding this comment.
Pull request overview
Adds a replay-safe, deterministic GUID generator to the orchestration runtime to match Durable Task .NET’s TaskOrchestrationContext.NewGuid() behavior and prevent non-deterministic UUID usage during replay.
Changes:
- Add
OrchestrationContext.NewGuid()using UUID v5 with .NET-aligned namespace + timestamp formatting + per-context counter. - Add unit tests covering determinism, uniqueness, formatting, golden values, and UUID v5 properties.
- Add an integration test ensuring GUID determinism across replays when passing values through activities.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
task/orchestrator.go | Adds deterministic GUID namespace/format constants, a counter field, and NewGuid() implementation. |
task/orchestrator_test.go | Adds focused unit tests validating determinism, alignment, and regression (golden) outputs. |
tests/orchestrations_test.go | Adds end-to-end replay determinism coverage via activity round-trips. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+454
to
+461
| // This uses UUID v5 (SHA-1) per RFC 4122, matching the algorithm used by the .NET Durable Task SDK. | ||
| func (ctx *OrchestrationContext) NewGuid() uuid.UUID { | ||
| // Truncate to 100-nanosecond (tick) precision to match .NET DateTime behavior, | ||
| // then format with exactly 7 fractional digits to match .NET's ToString("o"). | ||
| truncatedTime := ctx.CurrentTimeUtc.Truncate(100 * time.Nanosecond) | ||
| name := fmt.Sprintf("%s_%s_%d", ctx.ID, truncatedTime.Format(dotnetDateTimeFormat), ctx.newGuidCounter) | ||
| ctx.newGuidCounter++ | ||
| return uuid.NewSHA1(deterministicGuidNamespace, []byte(name)) |
| pendingExternalEventTasks map[string]*list.List | ||
| saveBufferedExternalEvents bool | ||
| newGuidCounter int |
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
Sign up for freeto 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.
Summary
Adds a replay-safe, deterministic UUID generation method to
OrchestrationContext, closing the gap with the .NET Durable Task SDK.Algorithm
Uses UUID v5 (SHA-1, RFC 4122) with the same namespace (
9e952958-5e33-4daf-827f-2fa12937b875) and name format ({instanceId}_{timestamp}_{counter}) as the .NET implementation.Cross-SDK alignment details
DateTime.ToString("o")DateTimebehaviorUsage
Changes
task/orchestrator.gouuidimport, namespace constant, format constant,newGuidCounterfield,NewGuid()methodtask/orchestrator_test.gotests/orchestrations_test.goTest Coverage
DeterministicUniqueDifferentInstancesDifferentTimesNanosecondTruncationTimestampFormatGoldenValuesUUIDv5PropertiesCounterResetOnNewContextTest_NewGuidRelated
Closes gap identified in cross-SDK alignment analysis: .NET has
TaskOrchestrationContext.NewGuid()but Go had no equivalent, forcing users to use non-deterministicuuid.New()which breaks replay.