Skip to content

Commit 4f10b24

Browse files
authored
Merge pull request kubernetes#126716 from stlaz/tlscachekey_comparable
ensure tlsCacheKey is strictly comparable to avoid runtime panics
2 parents 113b12c + 12ae218 commit 4f10b24

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

staging/src/k8s.io/client-go/transport/cache_go118.go

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,29 @@ limitations under the License.
1818

1919
package transport
2020

21+
// this is just to make the "unused" linter rule happy
22+
var _ = isCacheKeyComparable[tlsCacheKey]
23+
2124
// assert at compile time that tlsCacheKey is comparable in a way that will never panic at runtime.
22-
var _ = isComparable[tlsCacheKey]
25+
//
26+
// Golang 1.20 introduced an exception to type constraints that allows comparable, but not
27+
// necessarily strictly comparable type arguments to satisfy the `comparable` type constraint,
28+
// thus allowing interfaces to fulfil the `comparable` constraint.
29+
// However, by definition, "A comparison of two interface values with identical
30+
// dynamic types causes a run-time panic if that type is not comparable".
31+
//
32+
// We want to make sure that comparing two `tlsCacheKey` elements won't cause a
33+
// runtime panic. In order to do that, we'll force the `tlsCacheKey` to be strictly
34+
// comparable, thus making it impossible for it to contain interfaces.
35+
// To assert strict comparability, we'll use another definition: "Type
36+
// parameters are comparable if they are strictly comparable".
37+
// Below, we first construct a type parameter from the `tlsCacheKey` type so that
38+
// we can then push this type parameter to a comparable check, thus checking these
39+
// are strictly comparable.
40+
//
41+
// Original suggestion from https://github.com/golang/go/issues/56548#issuecomment-1317673963
42+
func isCacheKeyComparable[K tlsCacheKey]() {
43+
_ = isComparable[K]
44+
}
2345

2446
func isComparable[T comparable]() {}

0 commit comments

Comments
 (0)