Skip to content

Commit

Permalink
Add HasOpenAPISchemaChanged to DiscoveryInterface
Browse files Browse the repository at this point in the history
Kubernetes-commit: 235a57a29e5d232f411a23148643533140e646d1
  • Loading branch information
kevindelgado authored and k8s-publishing-bot committed Jul 16, 2021
1 parent 5d4570c commit 4389b4f
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 32 deletions.
41 changes: 10 additions & 31 deletions applyconfigurations/meta/v1/unstructured.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
package v1

import (
"crypto/sha512"
"encoding/json"
"fmt"

"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
Expand Down Expand Up @@ -32,40 +30,25 @@ type objectTypeCache interface {
type nonCachingObjectTypeCache struct {
// TODO: lock this?
discoveryClient discovery.DiscoveryInterface
docHash [sha512.Size]uint8
gvkParser *fieldmanager.GvkParser
typeForGVK map[schema.GroupVersionKind]*typed.ParseableType
}

// objectTypeForGVK retrieves the typed.ParseableType for a given gvk from the cache
func (c *nonCachingObjectTypeCache) objectTypeForGVK(gvk schema.GroupVersionKind) (*typed.ParseableType, error) {
doc, err := c.discoveryClient.OpenAPISchema()
if err != nil {
return nil, err
}

docBytes, err := json.Marshal(doc)
if err != nil {
return nil, err
}
docHash := sha512.Sum512(docBytes)

// cache hit
if c.docHash == docHash {
if !c.discoveryClient.HasOpenAPISchemaChanged() && c.gvkParser != nil {
// cache hit
fmt.Println("cache hit")
fmt.Printf("docHash = %+v\n", docHash)
objType, ok := c.typeForGVK[gvk]
if ok {
fmt.Println("gvk recognized")
fmt.Printf("gvk = %+v\n", gvk)
return objType, nil
}
objType = c.gvkParser.Type(gvk)
c.typeForGVK[gvk] = objType
return objType, nil
fmt.Printf("gvk = %+v\n", gvk)
return c.gvkParser.Type(gvk), nil
} else {
fmt.Println("cache miss")
// cache miss
fmt.Println("cache miss")
fmt.Printf("gvk = %+v\n", gvk)
doc, err := c.discoveryClient.OpenAPISchema()
if err != nil {
return nil, err
}
models, err := proto.NewOpenAPIData(doc)
if err != nil {
return nil, err
Expand All @@ -77,11 +60,7 @@ func (c *nonCachingObjectTypeCache) objectTypeForGVK(gvk schema.GroupVersionKind
}

objType := gvkParser.Type(gvk)
c.docHash = docHash
c.gvkParser = gvkParser
c.typeForGVK = map[schema.GroupVersionKind]*typed.ParseableType{
gvk: objType,
}

return objType, nil
}
Expand Down
4 changes: 4 additions & 0 deletions discovery/cached/disk/cached_discovery.go
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,10 @@ func (d *CachedDiscoveryClient) OpenAPISchema() (*openapi_v2.Document, error) {
return d.delegate.OpenAPISchema()
}

func (d *CachedDiscoveryClient) HasOpenAPISchemaChanged() bool {
return d.delegate.HasOpenAPISchemaChanged()
}

// Fresh is supposed to tell the caller whether or not to retry if the cache
// fails to find something (false = retry, true = no need to retry).
func (d *CachedDiscoveryClient) Fresh() bool {
Expand Down
18 changes: 17 additions & 1 deletion discovery/discovery_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/url"
"sort"
"strings"
Expand Down Expand Up @@ -125,6 +126,8 @@ type ServerVersionInterface interface {
type OpenAPISchemaInterface interface {
// OpenAPISchema retrieves and parses the swagger API schema the server supports.
OpenAPISchema() (*openapi_v2.Document, error)

HasOpenAPISchemaChanged() bool
}

// DiscoveryClient implements the functions that discover server-supported API groups,
Expand All @@ -133,6 +136,7 @@ type DiscoveryClient struct {
restClient restclient.Interface

LegacyPrefix string
etag string
}

// Convert metav1.APIVersions to metav1.APIGroup. APIVersions is used by legacy v1, so
Expand Down Expand Up @@ -419,9 +423,21 @@ func (d *DiscoveryClient) ServerVersion() (*version.Info, error) {
return &info, nil
}

func (d *DiscoveryClient) HasOpenAPISchemaChanged() bool {
result := d.restClient.Verb("HEAD").AbsPath("/openapi/v2").SetHeader("If-None-Match", d.etag).SetHeader("Accept", mimePb).Do(context.TODO())
var status int
result.StatusCode(&status)
if status == http.StatusNotModified {
return false
}
return true
}

// OpenAPISchema fetches the open api schema using a rest client and parses the proto.
func (d *DiscoveryClient) OpenAPISchema() (*openapi_v2.Document, error) {
data, err := d.restClient.Get().AbsPath("/openapi/v2").SetHeader("Accept", mimePb).Do(context.TODO()).Raw()
result := d.restClient.Get().AbsPath("/openapi/v2").SetHeader("Accept", mimePb).Do(context.TODO())
d.etag = result.Etag()
data, err := result.Raw()
if err != nil {
if errors.IsForbidden(err) || errors.IsNotFound(err) || errors.IsNotAcceptable(err) {
// single endpoint not found/registered in old server, try to fetch old endpoint
Expand Down
12 changes: 12 additions & 0 deletions rest/request.go
Original file line number Diff line number Diff line change
Expand Up @@ -1062,6 +1062,12 @@ func (r *Request) DoRaw(ctx context.Context) ([]byte, error) {

// transformResponse converts an API response into a structured API object
func (r *Request) transformResponse(resp *http.Response, req *http.Request) Result {
var etag string
etagHeader, ok := resp.Header["Etag"]
if ok && len(etagHeader) == 1 {
etag = etagHeader[0]
}

var body []byte
if resp.Body != nil {
data, err := ioutil.ReadAll(resp.Body)
Expand Down Expand Up @@ -1146,6 +1152,7 @@ func (r *Request) transformResponse(resp *http.Response, req *http.Request) Resu
statusCode: resp.StatusCode,
decoder: decoder,
warnings: handleWarnings(resp.Header, r.warningHandler),
etag: etag,
}
}

Expand Down Expand Up @@ -1272,6 +1279,7 @@ type Result struct {
contentType string
err error
statusCode int
etag string

decoder runtime.Decoder
}
Expand Down Expand Up @@ -1308,6 +1316,10 @@ func (r Result) Get() (runtime.Object, error) {
return out, nil
}

func (r Result) Etag() string {
return r.etag
}

// StatusCode returns the HTTP status code of the request. (Only valid if no
// error was returned.)
func (r Result) StatusCode(statusCode *int) Result {
Expand Down

0 comments on commit 4389b4f

Please sign in to comment.