Add Event key to identify events #1440
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,5 +18,4 @@ go_test( | |
| size = "small", | ||
| srcs = ["store_test.go"], | ||
| embed = [":go_default_library"], | ||
| ) | ||
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,51 +13,3 @@ | |
| // limitations under the License. | ||
|
|
||
| package eventstore | ||
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| // Copyright 2021 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package model | ||
|
|
||
| import ( | ||
| "crypto/sha256" | ||
| "encoding/hex" | ||
| "fmt" | ||
| "sort" | ||
| "strings" | ||
| ) | ||
|
|
||
| var hashFunc = sha256.New | ||
|
|
||
| // MakeEventKey builds a fixed-length identifier based on the given name | ||
| // and labels. It returns the exact same string as long as both are the same. | ||
| func MakeEventKey(name string, labels map[string]string) string { | ||
| h := hashFunc() | ||
| if len(labels) == 0 { | ||
| h.Write([]byte(name)) | ||
| return hex.EncodeToString(h.Sum(nil)) | ||
| } | ||
|
|
||
| var b strings.Builder | ||
| b.WriteString(name) | ||
|
|
||
| // Guarantee uniqueness by sorting by keys. | ||
| keys := make([]string, 0, len(labels)) | ||
| for key := range labels { | ||
| keys = append(keys, key) | ||
| } | ||
| sort.Strings(keys) | ||
| for _, key := range keys { | ||
| b.WriteString(fmt.Sprintf("/%s:%s", key, labels[key])) | ||
| } | ||
|
|
||
| // Make a hash to be fixed length regardless of the length of the event key. | ||
| h.Write([]byte(b.String())) | ||
| return hex.EncodeToString(h.Sum(nil)) | ||
| } |
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| // Copyright 2021 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package model | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestMakeEventKey(t *testing.T) { | ||
| testcases := []struct { | ||
| testname string | ||
| name1 string | ||
| labels1 map[string]string | ||
| name2 string | ||
| labels2 map[string]string | ||
| wantSame bool | ||
| }{ | ||
| { | ||
| testname: "no name and labels given", | ||
| wantSame: true, | ||
| }, | ||
| { | ||
| testname: "no labels given", | ||
| name1: "name", | ||
| name2: "name", | ||
| wantSame: true, | ||
| }, | ||
| { | ||
| testname: "no name given", | ||
| labels1: map[string]string{ | ||
| "key1": "value1", | ||
| }, | ||
| labels2: map[string]string{ | ||
| "key1": "value1", | ||
| }, | ||
| wantSame: true, | ||
| }, | ||
| { | ||
| testname: "the exact same labels given", | ||
| name1: "name", | ||
| labels1: map[string]string{ | ||
| "key1": "value", | ||
| "key2": "value", | ||
| "key3": "value", | ||
| }, | ||
| name2: "name", | ||
| labels2: map[string]string{ | ||
| "key2": "value", | ||
| "key3": "value", | ||
| "key1": "value", | ||
| }, | ||
| wantSame: true, | ||
| }, | ||
| { | ||
| testname: "the sub match labels given", | ||
| name1: "name", | ||
| labels1: map[string]string{ | ||
| "key1": "value", | ||
| "key2": "value", | ||
| "key3": "value", | ||
| }, | ||
| name2: "name", | ||
| labels2: map[string]string{ | ||
| "key1": "value", | ||
| }, | ||
| wantSame: false, | ||
| }, | ||
| } | ||
| for _, tc := range testcases { | ||
| t.Run(tc.testname, func(t *testing.T) { | ||
| // Check if we can get the exact same string. | ||
| got1 := MakeEventKey(tc.name1, tc.labels1) | ||
| got2 := MakeEventKey(tc.name2, tc.labels2) | ||
| assert.NotEmpty(t, got1) | ||
| assert.NotEmpty(t, got2) | ||
| assert.Equal(t, tc.wantSame, got1 == got2) | ||
|
Member
There was a problem hiding this comment. Add the check of key length to ensure that they are not empty strings. |
||
| }) | ||
| } | ||
| } | ||
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.
nit: This should be done before locking.