mirror of
https://github.com/kubernetes/client-go.git
synced 2026-07-16 17:14:36 +00:00
07eaa8b369
The rationale for explicit cancellation checks is that these functions have side effects that can be avoided when checking upfront. These side effects can still occur when cancellation happens while the functions are executing, but "already canceled" is common enough that it deserves special handling. Kubernetes-commit: c3f63fc258b73e487da7ca84c40be43fc4c5f4dd
92 lines
2.5 KiB
Go
92 lines
2.5 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 cached
|
|
|
|
import (
|
|
"context"
|
|
"sync"
|
|
|
|
"k8s.io/client-go/openapi"
|
|
)
|
|
|
|
type Client struct {
|
|
delegate openapi.ClientWithContext
|
|
|
|
once sync.Once
|
|
result map[string]openapi.GroupVersionWithContext
|
|
err error
|
|
}
|
|
|
|
var (
|
|
//nolint:staticcheck // Intentionally using the old interface here.
|
|
_ openapi.Client = &Client{}
|
|
_ openapi.ClientWithContext = &Client{}
|
|
)
|
|
|
|
// NewClientWithContext is a better alternative because it supports contextual logging and cancellation.
|
|
//
|
|
// Contextual logging: Use NewClientWithContext instead.
|
|
func NewClient(other openapi.Client) openapi.Client {
|
|
return newClient(openapi.ToClientWithContext(other))
|
|
}
|
|
|
|
func NewClientWithContext(other openapi.ClientWithContext) *Client {
|
|
return newClient(other)
|
|
}
|
|
|
|
func newClient(other openapi.ClientWithContext) *Client {
|
|
return &Client{
|
|
delegate: other,
|
|
}
|
|
}
|
|
|
|
// PathsWithContext is a better alternative because it supports contextual logging and cancellation.
|
|
//
|
|
// Contextual logging: Use PathsWithContext instead.
|
|
func (c *Client) Paths() (map[string]openapi.GroupVersion, error) {
|
|
// For efficiency reasons in the *WithContext case this is a map to
|
|
// openapi.GroupVersionWithContext. But we know that all entries
|
|
// also implement openapi.GroupVersion.
|
|
resultWithContext, err := c.PathsWithContext(context.Background())
|
|
result := make(map[string]openapi.GroupVersion, len(resultWithContext))
|
|
for key, entry := range resultWithContext {
|
|
result[key] = entry.(openapi.GroupVersion)
|
|
}
|
|
return result, err
|
|
}
|
|
|
|
func (c *Client) PathsWithContext(ctx context.Context) (map[string]openapi.GroupVersionWithContext, error) {
|
|
if err := ctx.Err(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
c.once.Do(func() {
|
|
uncached, err := c.delegate.PathsWithContext(ctx)
|
|
if err != nil {
|
|
c.err = err
|
|
return
|
|
}
|
|
|
|
result := make(map[string]openapi.GroupVersionWithContext, len(uncached))
|
|
for k, v := range uncached {
|
|
result[k] = newGroupVersion(v)
|
|
}
|
|
c.result = result
|
|
})
|
|
return c.result, c.err
|
|
}
|