feat(persisted-ops): Clean up code

ldebruijn · Aug 10, 2024 · 41ecbc3 · 41ecbc3
1 parent b6561d4
commit 41ecbc3
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 20 deletions.
diff --git a/cmd/main_test.go b/cmd/main_test.go
@@ -112,7 +112,7 @@ type Product {
 `,
 				cfgOverrides: func(cfg *config.Config) *config.Config {
 					cfg.PersistedOperations.Enabled = true
-					cfg.PersistedOperations.Loader.Type = "disk"
+					cfg.PersistedOperations.Loader.Type = "local"
 					cfg.PersistedOperations.Loader.Location = "./"
 					return cfg
 				},
@@ -170,7 +170,7 @@ type Product {
 				cfgOverrides: func(cfg *config.Config) *config.Config {
 					cfg.ObfuscateUpstreamErrors = false
 					cfg.PersistedOperations.Enabled = true
-					cfg.PersistedOperations.Loader.Type = "disk"
+					cfg.PersistedOperations.Loader.Type = "local"
 					cfg.PersistedOperations.Loader.Location = "./"
 					cfg.PersistedOperations.RejectOnFailure = false
 					return cfg
@@ -371,7 +371,7 @@ type Product {
 `,
 				cfgOverrides: func(cfg *config.Config) *config.Config {
 					cfg.PersistedOperations.Enabled = true
-					cfg.PersistedOperations.Loader.Type = "disk"
+					cfg.PersistedOperations.Loader.Type = "local"
 					cfg.PersistedOperations.Loader.Location = "./"
 					cfg.PersistedOperations.RejectOnFailure = false
 					cfg.ObfuscateUpstreamErrors = false
@@ -437,7 +437,7 @@ type Product {
 `,
 				cfgOverrides: func(cfg *config.Config) *config.Config {
 					cfg.PersistedOperations.Enabled = true
-					cfg.PersistedOperations.Loader.Type = "disk"
+					cfg.PersistedOperations.Loader.Type = "local"
 					cfg.PersistedOperations.Loader.Location = "./"
 					cfg.PersistedOperations.RejectOnFailure = false
 					return cfg

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -49,22 +49,23 @@ obfuscate_upstream_errors: true
 
 
 persisted_operations:
-  # Enable or disable the feature, enabled by default
+  # Enable or disable the feature, disabled by default
   enabled: false
   # Fail unknown operations, disable this feature to allow unknown operations to reach your GraphQL API
   reject_on_failure: true
-  # Store is the location on local disk where graphql-protect can find the persisted operations, it loads any `*.json` files on disk
-  store: "./store"
-  reload:
-    enabled: true
-    # The interval in which the local store dir is read and refreshes the internal state
-    interval: 5m
-    # The timeout for the remote operation
-    timeout: 10s
-  remote:
-    # Load persisted operations from a GCP Cloud Storage bucket.
-    # Will look at all the objects in the bucket and try to load any object with a `.json` extension
-    gcp_bucket: ""
+  # Loader decides how persisted operations are loaded, see loader chapter for more details
+  loader:
+    # Type of loader to use
+    type: local
+    # Location to load persisted operations from
+    location: ./store
+    # Whether to reload persisted operations periodically
+    reload:
+      enabled: true
+      # The interval in which the persisted operations are refreshed
+      interval: 5m0s
+      # The timeout for the refreshing operation
+      timeout: 10s
 
 block_field_suggestions:
   enabled: true

diff --git a/docs/protections/persisted_operations.md b/docs/protections/persisted_operations.md
@@ -23,7 +23,7 @@ persisted_operations:
   # Loader decides how persisted operations are loaded, see loader chapter for more details
   loader:
     # Type of loader to use
-    type: disk
+    type: local
     # Location to load persisted operations from
     location: ./store
     # Whether to reload persisted operations periodically

diff --git a/internal/app/config/config_test.go b/internal/app/config/config_test.go
@@ -73,7 +73,7 @@ func TestNewConfig(t *testing.T) {
 				PersistedOperations: persistedoperations.Config{
 					Enabled: false,
 					Loader: persistedoperations.LoaderConfig{
-						Type:     "disk",
+						Type:     "local",
 						Location: "./store",
 						Reload: struct {
 							Enabled  bool          `conf:"default:true" yaml:"enabled"`

diff --git a/internal/business/persistedoperations/persisted_operations.go b/internal/business/persistedoperations/persisted_operations.go
@@ -61,7 +61,7 @@ type Config struct {
 }
 
 type LoaderConfig struct {
-	Type     string `conf:"default:disk" yaml:"type"`
+	Type     string `conf:"default:local" yaml:"type"`
 	Location string `conf:"default:./store" yaml:"location"`
 	// Configuration for auto-reloading persisted operations
 	Reload struct {