mirror of
https://github.com/kubernetes/client-go.git
synced 2026-07-15 15:29:18 +00:00
0ff074ca35
The main purpose is to replace context.TODO with a context provided by the caller. A secondary purpose is to enable contextual logging. Modifying the existing interfaces and APIs would have a big impact on the ecosystem. This is a no-go. Instead, the following approach was taken: - All interfaces get duplicated in a *WithContext variant where the methods also have a *WithContext suffix and the ctx parameter. All methods are treated this way except for obvious local get methods (like RESTClient) because it cannot be ruled out entirely that some implementation may need a context. - Implementations of these interfaces implement both method variants which is possible because the method names are different. The old methods are implemented as thin wrappers around the updated code which is now the body of the new methods or shared helpers. In some cases there is additional overhead (type checks, potentially additional allocations) when using the old methods. - To*WithContext helpers bridge from the old to the new interfaces. They try a type cast first. Because the in-tree implementations implement both, they can be used directly. For other implementations wrappers are used. - None of old APIs and interfaces are marked as deprecated. Instead doc comments inform consumers about the new and better alternatives. This approach avoids causing turmoil in the ecosystem when linters pick up on a formal deprecation and developers act on those linter warnings without properly thinking about the implications. "// Contextual logging: " is used as placeholder for "//logcheck:context". Once all relevant consumers have been updated to the new API, a search/replace can enable the logcheck linter to warn about usage of the old API. Implementations also get marked this way even if probably nothing ever calls them directly because it shows which code, at least theoretically, could get removed. - Existing unit tests do not get updated to the new APIs. This gives us unit test coverage of the old and new API because the old APIs call the new ones. - In-tree consumers will be updated in follow-up PRs. This is likely to be a longer process. Because of the deprecation comment, `hack/golangci-lint.sh -n` can be used to find code which needs to be updated. Kubernetes-commit: ab9f9f2a0e2f06d29464beb1f131190c91b6655e