Versioning data merge algo and hybrid logical clock utils #4205
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2020 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Copyright (c) 2020 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package hybrid_logical_clock | ||
|
|
||
| import ( | ||
| "errors" | ||
|
|
||
| clockpb "go.temporal.io/server/api/clock/v1" | ||
| commonclock "go.temporal.io/server/common/clock" | ||
| ) | ||
|
|
||
| var ErrClocksEqual = errors.New("HybridLogicalClocks are equal") | ||
|
|
||
|
|
||
| type Clock = clockpb.HybridLogicalClock | ||
|
|
||
| // Next generates the next clock timestamp given the current clock. | ||
| // HybridLogicalClock requires the previous clock to ensure that time doesn't move backwards and the next clock is | ||
| // monotonically increasing. | ||
| func Next(clock Clock, source commonclock.TimeSource) Clock { | ||
| wallclock := source.Now().UnixMilli() | ||
| // Ensure time does not move backwards | ||
| if wallclock < clock.GetWallClock() { | ||
| wallclock = clock.GetWallClock() | ||
| } | ||
| // Ensure timestamp is monotonically increasing | ||
| if wallclock == clock.GetWallClock() { | ||
| clock.Version = clock.GetVersion() + 1 | ||
| } else { | ||
| clock.Version = 0 | ||
| clock.WallClock = wallclock | ||
| } | ||
|
|
||
| return Clock{WallClock: wallclock, Version: clock.Version, ClusterId: clock.ClusterId} | ||
| } | ||
|
|
||
| // Zero generates a zeroed logical clock for the cluster ID. | ||
| func Zero(clusterID int64) Clock { | ||
| return Clock{WallClock: 0, Version: 0, ClusterId: clusterID} | ||
| } | ||
|
|
||
| func sign[T int64 | int32](x T) int { | ||
| if x > 0 { | ||
| return 1 | ||
| } | ||
| if x < 0 { | ||
| return -1 | ||
| } | ||
| return 0 | ||
| } | ||
|
|
||
| // Compare 2 clocks, returns 0 if a == b, -1 if a > b, 1 if a < b | ||
| func Compare(a Clock, b Clock) int { | ||
| if a.WallClock == b.WallClock { | ||
| if a.Version == b.Version { | ||
| return sign(b.ClusterId - a.ClusterId) | ||
| } | ||
| return sign(b.Version - a.Version) | ||
| } | ||
| return sign(b.WallClock - a.WallClock) | ||
| } | ||
|
|
||
| // Greater returns true if a is greater than b | ||
| func Greater(a Clock, b Clock) bool { | ||
| return Compare(b, a) > 0 | ||
| } | ||
|
|
||
| // Greater returns true if a is greater than b | ||
| func Less(a Clock, b Clock) bool { | ||
| return Compare(a, b) > 0 | ||
| } | ||
|
|
||
| // Max returns the maximum of two clocks | ||
| func Max(a Clock, b Clock) Clock { | ||
| if Compare(a, b) > 0 { | ||
| return b | ||
| } | ||
| return a | ||
| } | ||
|
|
||
| // Equal returns whether two clocks are equal | ||
| func Equal(a Clock, b Clock) bool { | ||
| return Compare(a, b) == 0 | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2020 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Copyright (c) 2020 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package hybrid_logical_clock | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| commonclock "go.temporal.io/server/common/clock" | ||
| ) | ||
|
|
||
| func Test_Next_ReturnsGreaterClock(t *testing.T) { | ||
| t0 := Zero(1) | ||
| timesource := commonclock.NewEventTimeSource() | ||
|
|
||
| // Same wallclock | ||
| timesource.Update(time.Unix(0, 0).UTC()) | ||
| t1 := Next(t0, timesource) | ||
| assert.Equal(t, Compare(t0, t1), 1) | ||
| // Greater wallclock | ||
| timesource.Update(time.Unix(0, 1).UTC()) | ||
| t2 := Next(t1, timesource) | ||
| assert.Equal(t, Compare(t1, t2), 1) | ||
| } | ||
|
|
||
| func Test_Compare(t *testing.T) { | ||
| var t0 Clock | ||
| var t1 Clock | ||
|
|
||
| t0 = Clock{WallClock: 1, Version: 1, ClusterId: 1} | ||
| t1 = Clock{WallClock: 1, Version: 1, ClusterId: 1} | ||
| assert.Equal(t, Compare(t0, t1), 0) | ||
| assert.True(t, Equal(t0, t1)) | ||
|
|
||
| t0 = Clock{WallClock: 1, Version: 1, ClusterId: 1} | ||
| t1 = Clock{WallClock: 1, Version: 1, ClusterId: 2} | ||
| assert.Equal(t, Compare(t0, t1), 1) | ||
| // Let's get a -1 in there for sanity | ||
| assert.Equal(t, Compare(t1, t0), -1) | ||
|
|
||
| t0 = Clock{WallClock: 1, Version: 1, ClusterId: 1} | ||
| t1 = Clock{WallClock: 1, Version: 2, ClusterId: 1} | ||
| assert.Equal(t, Compare(t0, t1), 1) | ||
|
|
||
| t0 = Clock{WallClock: 1, Version: 1, ClusterId: 1} | ||
| t1 = Clock{WallClock: 2, Version: 1, ClusterId: 1} | ||
| assert.Equal(t, Compare(t0, t1), 1) | ||
|
|
||
| assert.True(t, Greater(t1, t0)) | ||
| assert.True(t, Less(t0, t1)) | ||
| } | ||
|
|
||
| func Test_Max_ReturnsMaximum(t *testing.T) { | ||
| t0 := Zero(1) | ||
| t1 := Zero(2) | ||
|
|
||
| max := Max(t0, t1) | ||
| assert.Equal(t, max, t1) | ||
| // Just in case it doesn't work in reverse order... | ||
| max = Max(t1, t0) | ||
| assert.Equal(t, max, t1) | ||
| } |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this really deserve a new package? just put it in
common/clock.. they're used together anyway so anyone importing this needs to import that too