github/client-go
1
0
Fork 0
mirror of https://github.com/kubernetes/client-go.git synced 2025-09-12 21:32:10 +00:00
Code Issues Projects Releases Wiki Activity

Address PR feedback around gvk parser generation ergonomics

Browse Source 
Kubernetes-commit: c9e97de46bb76cf868fcb172f286127b9894fbe9
This commit is contained in:
Kevin Delgado
2021-07-20 21:29:02 +00:00
committed by Kubernetes Publisher
parent 1b1afde6e1
commit 305b0bc3db
3 changed files with 53 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
applyconfigurations/meta/v1/unstructured.go
View File

@@ -13,11 +13,15 @@ import (
"sigs.k8s.io/structured-merge-diff/v4/typed"
)
// openAPISchemaTTL is how frequently we need to check
// whether the open API schema has changed or not.
const openAPISchemaTTL = time.Minute
// UnstructuredExtractor enables extracting the applied configuration state from object for fieldManager into an
// unstructured object type.
type UnstructuredExtractor interface {
ExtractUnstructured(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error)
ExtractUnstructuredStatus(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error)
Extract(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error)
ExtractStatus(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error)
}
// gvkParserCache caches the GVKParser in order to prevent from having to repeatedly
@@ -37,45 +41,42 @@ type gvkParserCache struct {
}
// regenerateGVKParser builds the parser from the raw OpenAPI schema.
func (c *gvkParserCache) regenerateGVKParser() error {
doc, err := c.discoveryClient.OpenAPISchema()
func regenerateGVKParser(dc discovery.DiscoveryInterface) (*fieldmanager.GvkParser, error) {
doc, err := dc.OpenAPISchema()
if err != nil {
return err
return nil, err
}
c.lastChecked = time.Now()
//c.lastChecked = time.Now()
models, err := proto.NewOpenAPIData(doc)
if err != nil {
return err
return nil, err
}
gvkParser, err := fieldmanager.NewGVKParser(models, false)
if err != nil {
return err
}
return fieldmanager.NewGVKParser(models, false)
//gvkParser, err := fieldmanager.NewGVKParser(models, false)
//if err != nil {
// return nil, err
//}
c.gvkParser = gvkParser
return nil
//return gvkParser, nil
//return nil
}
// objectTypeForGVK retrieves the typed.ParseableType for a given gvk from the cache
func (c *gvkParserCache) objectTypeForGVK(gvk schema.GroupVersionKind) (*typed.ParseableType, error) {
c.mu.Lock()
defer c.mu.Unlock()
if c.gvkParser != nil {
// if the ttl on the parser cache has expired,
// recheck the discovery client to see if the Open API schema has changed
if time.Now().After(c.lastChecked.Add(c.ttl)) {
c.lastChecked = time.Now()
if c.discoveryClient.HasOpenAPISchemaChanged() {
// the schema has changed, regenerate the parser
if err := c.regenerateGVKParser(); err != nil {
return nil, err
}
// if the ttl on the openAPISchema has expired,
// recheck the discovery client to see if the Open API schema has changed
if time.Now().After(c.lastChecked.Add(openAPISchemaTTL)) {
c.lastChecked = time.Now()
if c.discoveryClient.HasOpenAPISchemaChanged() {
// the schema has changed, regenerate the parser
parser, err := regenerateGVKParser(c.discoveryClient)
if err != nil {
return nil, err
}
}
} else {
if err := c.regenerateGVKParser(); err != nil {
return nil, err
c.gvkParser = parser
}
}
return c.gvkParser.Type(gvk), nil
@@ -87,27 +88,31 @@ type extractor struct {
// NewUnstructuredExtractor creates the extractor with which you can extract the applied configuration
// for a given manager from an unstructured object.
func NewUnstructuredExtractor(dc discovery.DiscoveryInterface) UnstructuredExtractor {
func NewUnstructuredExtractor(dc discovery.DiscoveryInterface) (UnstructuredExtractor, error) {
// TODO: expose ttl as an argument if we want to.
defaultTTL := time.Minute
parser, err := regenerateGVKParser(dc)
if err != nil {
return nil, err
}
return &extractor{
cache: &gvkParserCache{
gvkParser: parser,
discoveryClient: dc,
ttl: defaultTTL,
},
}
}, nil
}
// ExtractUnstructured extracts the applied configuration owned by fiieldManager from an unstructured object.
// Extract extracts the applied configuration owned by fiieldManager from an unstructured object.
// Note that the apply configuration itself is also an unstructured object.
func (e *extractor) ExtractUnstructured(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error) {
func (e *extractor) Extract(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error) {
return e.extractUnstructured(object, fieldManager, "")
}
// ExtractUnstructuredStatus is the same as ExtractUnstructured except
// ExtractStatus is the same as ExtractUnstructured except
// that it extracts the status subresource applied configuration.
// Experimental!
func (e *extractor) ExtractUnstructuredStatus(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error) {
func (e *extractor) ExtractStatus(object *unstructured.Unstructured, fieldManager string) (*unstructured.Unstructured, error) {
return e.extractUnstructured(object, fieldManager, "status")
}