[Bugfix] Enable LazyLoader for CRD & CRD Schemas (#1582)

Author: ajanikow

CHANGELOG.md

@@ -9,6 +9,7 @@
 - (Documentation) Use relative links for generated docs
 - (Improvement) Change default logging level to info. Add --log.sampling (default true). Adjust log levels.
 - (Maintenance) Bump Go to 1.21.6
+- (Bugfix) Enable LazyLoader for CRD & CRD Schemas
 
 ## [1.2.36](https://github.com/arangodb/kube-arangodb/tree/1.2.36) (2024-01-08)
 - (Documentation) Improvements and fixes for rendered documentation (GH pages)

pkg/crd/crds/apps-job.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	AppsJobVersion = driver.Version("1.0.1")
 )
 
-func init() {
-	mustLoadCRD(appsJobs, appsJobsSchemaRaw, &appsJobsCRD, &appsJobsCRDSchemas)
-}
-
 // Deprecated: use AppsJobWithOptions instead
 func AppsJob() *apiextensions.CustomResourceDefinition {
 	return AppsJobWithOptions()
@@ -57,8 +55,8 @@ func AppsJobDefinitionWithOptions(opts ...func(*CRDOptions)) Definition {
 	}
 }
 
-var appsJobsCRD apiextensions.CustomResourceDefinition
-var appsJobsCRDSchemas crdSchemas
+var appsJobsCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](appsJobs)
+var appsJobsCRDSchemas = util.NewYamlLoader[crdSchemas](appsJobsSchemaRaw)
 
 //go:embed apps-job.yaml
 var appsJobs []byte

pkg/crd/crds/backups-backup.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	BackupsBackupVersion = driver.Version("1.0.1")
 )
 
-func init() {
-	mustLoadCRD(backupsBackup, backupsBackupSchemaRaw, &backupsBackupCRD, &backupsBackupCRDSchemas)
-}
-
 // Deprecated: use BackupsBackupWithOptions instead
 func BackupsBackup() *apiextensions.CustomResourceDefinition {
 	return BackupsBackupWithOptions()
@@ -57,8 +55,8 @@ func BackupsBackupDefinitionWithOptions(opts ...func(*CRDOptions)) Definition {
 	}
 }
 
-var backupsBackupCRD apiextensions.CustomResourceDefinition
-var backupsBackupCRDSchemas crdSchemas
+var backupsBackupCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](backupsBackup)
+var backupsBackupCRDSchemas = util.NewYamlLoader[crdSchemas](backupsBackupSchemaRaw)
 
 //go:embed backups-backup.yaml
 var backupsBackup []byte

pkg/crd/crds/backups-backuppolicy.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	BackupsBackupPolicyPolicyVersion = driver.Version("1.0.1")
 )
 
-func init() {
-	mustLoadCRD(backupsBackupPolicy, backupsBackupPolicySchemaRaw, &backupsBackupPolicyCRD, &backupsBackupPolicyCRDSchemas)
-}
-
 // Deprecated: use BackupsBackupPolicyPolicyWithOptions instead
 func BackupsBackupPolicyPolicy() *apiextensions.CustomResourceDefinition {
 	return BackupsBackupPolicyPolicyWithOptions()
@@ -57,8 +55,8 @@ func BackupsBackupPolicyDefinitionWithOptions(opts ...func(*CRDOptions)) Definit
 	}
 }
 
-var backupsBackupPolicyCRD apiextensions.CustomResourceDefinition
-var backupsBackupPolicyCRDSchemas crdSchemas
+var backupsBackupPolicyCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](backupsBackupPolicy)
+var backupsBackupPolicyCRDSchemas = util.NewYamlLoader[crdSchemas](backupsBackupPolicySchemaRaw)
 
 //go:embed backups-backuppolicy.yaml
 var backupsBackupPolicy []byte

pkg/crd/crds/crds.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -24,9 +24,10 @@ import (
 	"fmt"
 
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
-	"k8s.io/apimachinery/pkg/util/yaml"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 type Definition struct {
@@ -65,16 +66,6 @@ func AllDefinitions() []Definition {
 	}
 }
 
-func mustLoadCRD(crdRaw, crdSchemasRaw []byte, crd *apiextensions.CustomResourceDefinition, schemas *crdSchemas) {
-	if err := yaml.Unmarshal(crdRaw, crd); err != nil {
-		panic(err)
-	}
-
-	if err := yaml.Unmarshal(crdSchemasRaw, schemas); err != nil {
-		panic(err)
-	}
-}
-
 type crdSchemas map[string]apiextensions.CustomResourceValidation
 
 type CRDOptions struct {
@@ -97,13 +88,19 @@ func WithSchema() func(*CRDOptions) {
 	}
 }
 
-func getCRD(crd apiextensions.CustomResourceDefinition, schemas crdSchemas, opts ...func(*CRDOptions)) *apiextensions.CustomResourceDefinition {
+func getCRD(crdLoader util.Loader[apiextensions.CustomResourceDefinition], schemasLoader util.Loader[crdSchemas], opts ...func(*CRDOptions)) *apiextensions.CustomResourceDefinition {
 	o := &CRDOptions{}
 	for _, fn := range opts {
 		fn(o)
 	}
+
+	crd := crdLoader.MustGet()
+
 	if o.WithSchema {
 		crdWithSchema := crd.DeepCopy()
+
+		schemas := schemasLoader.MustGet()
+
 		for i, v := range crdWithSchema.Spec.Versions {
 			schema, ok := schemas[v.Name]
 			if !ok {

pkg/crd/crds/database-clustersynchronization.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	DatabaseClusterSynchronizationVersion = driver.Version("1.0.1")
 )
 
-func init() {
-	mustLoadCRD(databaseClusterSynchronization, databaseClusterSynchronizationSchemaRaw, &databaseClusterSynchronizationCRD, &databaseClusterSynchronizationCRDSchemas)
-}
-
 // Deprecated: use DatabaseClusterSynchronizationWithOptions instead
 func DatabaseClusterSynchronization() *apiextensions.CustomResourceDefinition {
 	return DatabaseClusterSynchronizationWithOptions()
@@ -57,8 +55,8 @@ func DatabaseClusterSynchronizationDefinitionWithOptions(opts ...func(*CRDOption
 	}
 }
 
-var databaseClusterSynchronizationCRD apiextensions.CustomResourceDefinition
-var databaseClusterSynchronizationCRDSchemas crdSchemas
+var databaseClusterSynchronizationCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](databaseClusterSynchronization)
+var databaseClusterSynchronizationCRDSchemas = util.NewYamlLoader[crdSchemas](databaseClusterSynchronizationSchemaRaw)
 
 //go:embed database-clustersynchronization.yaml
 var databaseClusterSynchronization []byte

pkg/crd/crds/database-deployment.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	DatabaseDeploymentVersion = driver.Version("1.0.1")
 )
 
-func init() {
-	mustLoadCRD(databaseDeployment, databaseDeploymentSchemaRaw, &databaseDeploymentCRD, &databaseDeploymentCRDSchemas)
-}
-
 // Deprecated: use DatabaseDeploymentWithOptions instead
 func DatabaseDeployment() *apiextensions.CustomResourceDefinition {
 	return DatabaseDeploymentWithOptions()
@@ -57,8 +55,8 @@ func DatabaseDeploymentDefinitionWithOptions(opts ...func(*CRDOptions)) Definiti
 	}
 }
 
-var databaseDeploymentCRD apiextensions.CustomResourceDefinition
-var databaseDeploymentCRDSchemas crdSchemas
+var databaseDeploymentCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](databaseDeployment)
+var databaseDeploymentCRDSchemas = util.NewYamlLoader[crdSchemas](databaseDeploymentSchemaRaw)
 
 //go:embed database-deployment.yaml
 var databaseDeployment []byte

pkg/crd/crds/database-member.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	DatabaseMemberVersion = driver.Version("1.0.1")
 )
 
-func init() {
-	mustLoadCRD(databaseMember, databaseMemberSchemaRaw, &databaseMemberCRD, &databaseMemberCRDSchemas)
-}
-
 // Deprecated: use DatabaseMemberWithOptions instead
 func DatabaseMember() *apiextensions.CustomResourceDefinition {
 	return DatabaseMemberWithOptions()
@@ -57,8 +55,8 @@ func DatabaseMemberDefinitionWithOptions(opts ...func(*CRDOptions)) Definition {
 	}
 }
 
-var databaseMemberCRD apiextensions.CustomResourceDefinition
-var databaseMemberCRDSchemas crdSchemas
+var databaseMemberCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](databaseMember)
+var databaseMemberCRDSchemas = util.NewYamlLoader[crdSchemas](databaseMemberSchemaRaw)
 
 //go:embed database-member.yaml
 var databaseMember []byte

pkg/crd/crds/database-task.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	DatabaseTaskVersion = driver.Version("1.0.1")
 )
 
-func init() {
-	mustLoadCRD(databaseTask, databaseTaskSchemaRaw, &databaseTaskCRD, &databaseTaskCRDSchemas)
-}
-
 // Deprecated: use DatabaseTaskWithOptions instead
 func DatabaseTask() *apiextensions.CustomResourceDefinition {
 	return DatabaseTaskWithOptions()
@@ -57,8 +55,8 @@ func DatabaseTaskDefinitionWithOptions(opts ...func(*CRDOptions)) Definition {
 	}
 }
 
-var databaseTaskCRD apiextensions.CustomResourceDefinition
-var databaseTaskCRDSchemas crdSchemas
+var databaseTaskCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](databaseTask)
+var databaseTaskCRDSchemas = util.NewYamlLoader[crdSchemas](databaseTaskSchemaRaw)
 
 //go:embed database-task.yaml
 var databaseTask []byte

pkg/crd/crds/ml-extension.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,16 +26,14 @@ import (
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	"github.com/arangodb/go-driver"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
 )
 
 const (
 	MLExtensionVersion = driver.Version("1.0.0")
 )
 
-func init() {
-	mustLoadCRD(mlExtension, mlExtensionSchemaRaw, &mlExtensionCRD, &mlExtensionCRDSchemas)
-}
-
 func MLExtensionWithOptions(opts ...func(*CRDOptions)) *apiextensions.CustomResourceDefinition {
 	return getCRD(mlExtensionCRD, mlExtensionCRDSchemas, opts...)
 }
@@ -47,8 +45,8 @@ func MLExtensionDefinitionWithOptions(opts ...func(*CRDOptions)) Definition {
 	}
 }
 
-var mlExtensionCRD apiextensions.CustomResourceDefinition
-var mlExtensionCRDSchemas crdSchemas
+var mlExtensionCRD = util.NewYamlLoader[apiextensions.CustomResourceDefinition](mlExtension)
+var mlExtensionCRDSchemas = util.NewYamlLoader[crdSchemas](mlExtensionSchemaRaw)
 
 //go:embed ml-extension.yaml
 var mlExtension []byte