Merge pull request #126716 from stlaz/tlscachekey_comparable

ensure tlsCacheKey is strictly comparable to avoid runtime panics

Kubernetes-commit: 4f10b245031193c1c1679573201810ffac9191a4
This commit is contained in:
Kubernetes Publisher 2024-08-19 18:14:08 -07:00
commit 46965213e4

View File

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