mirror of
https://github.com/kubernetes/client-go.git
synced 2026-02-22 08:03:18 +00:00
8101e94f49
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. - All old APIs and interfaces are marked as deprecated. There is no intent to ever remove them, but consumers should be made aware that there are now better alternatives. Implementations also get marked this way even if 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: 025b844bcabe0212c4dd56395ee18481602d7c65
123 lines
3.6 KiB
Go
123 lines
3.6 KiB
Go
/*
|
|
Copyright 2017 The Kubernetes 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 openapi
|
|
|
|
import (
|
|
"context"
|
|
"net/url"
|
|
|
|
"k8s.io/kube-openapi/pkg/handler3"
|
|
)
|
|
|
|
const ContentTypeOpenAPIV3PB = "application/com.github.proto-openapi.spec.v3@v1.0+protobuf"
|
|
|
|
// Deprecated: use GroupVersionWithContext instead.
|
|
type GroupVersion interface {
|
|
Schema(contentType string) ([]byte, error)
|
|
|
|
// ServerRelativeURL. Returns the path and parameters used to fetch the schema.
|
|
// You should use the Schema method to fetch it, but this value can be used
|
|
// to key the current version of the schema in a cache since it contains a
|
|
// hash string which changes upon schema update.
|
|
ServerRelativeURL() string
|
|
}
|
|
|
|
type GroupVersionWithContext interface {
|
|
SchemaWithContext(ctx context.Context, contentType string) ([]byte, error)
|
|
|
|
// ServerRelativeURL. Returns the path and parameters used to fetch the schema.
|
|
// You should use the Schema method to fetch it, but this value can be used
|
|
// to key the current version of the schema in a cache since it contains a
|
|
// hash string which changes upon schema update.
|
|
ServerRelativeURL() string
|
|
}
|
|
|
|
func ToGroupVersionWithContext(gv GroupVersion) GroupVersionWithContext {
|
|
if gv == nil {
|
|
return nil
|
|
}
|
|
if gv, ok := gv.(GroupVersionWithContext); ok {
|
|
return gv
|
|
}
|
|
return &groupVersionWrapper{
|
|
GroupVersion: gv,
|
|
}
|
|
}
|
|
|
|
type groupVersionWrapper struct {
|
|
GroupVersion
|
|
}
|
|
|
|
func (gv *groupVersionWrapper) SchemaWithContext(ctx context.Context, contentType string) ([]byte, error) {
|
|
return gv.Schema(contentType)
|
|
}
|
|
|
|
type groupversion struct {
|
|
client *client
|
|
item handler3.OpenAPIV3DiscoveryGroupVersion
|
|
useClientPrefix bool
|
|
}
|
|
|
|
var (
|
|
_ GroupVersion = &groupversion{}
|
|
_ GroupVersionWithContext = &groupversion{}
|
|
)
|
|
|
|
func newGroupVersion(client *client, item handler3.OpenAPIV3DiscoveryGroupVersion, useClientPrefix bool) *groupversion {
|
|
return &groupversion{client: client, item: item, useClientPrefix: useClientPrefix}
|
|
}
|
|
|
|
func (g *groupversion) Schema(contentType string) ([]byte, error) {
|
|
return g.SchemaWithContext(context.Background(), contentType)
|
|
}
|
|
|
|
func (g *groupversion) SchemaWithContext(ctx context.Context, contentType string) ([]byte, error) {
|
|
if !g.useClientPrefix {
|
|
return g.client.restClient.Get().
|
|
RequestURI(g.item.ServerRelativeURL).
|
|
SetHeader("Accept", contentType).
|
|
Do(ctx).
|
|
Raw()
|
|
}
|
|
|
|
locator, err := url.Parse(g.item.ServerRelativeURL)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
path := g.client.restClient.Get().
|
|
AbsPath(locator.Path).
|
|
SetHeader("Accept", contentType)
|
|
|
|
// Other than root endpoints(openapiv3/apis), resources have hash query parameter to support etags.
|
|
// However, absPath does not support handling query parameters internally,
|
|
// so that hash query parameter is added manually
|
|
for k, value := range locator.Query() {
|
|
for _, v := range value {
|
|
path.Param(k, v)
|
|
}
|
|
}
|
|
|
|
return path.Do(ctx).Raw()
|
|
}
|
|
|
|
// URL used for fetching the schema. The URL includes a hash and can be used
|
|
// to key the current version of the schema in a cache.
|
|
func (g *groupversion) ServerRelativeURL() string {
|
|
return g.item.ServerRelativeURL
|
|
}
|