Refactor handling of non-managed resources

app/models/concerns/discovery_engine_nameable.rb

@@ -0,0 +1,31 @@
+# Enhances models with a `#name` method returning their fully qualified Google Cloud Platform
+# resource name (like a path).
+#
+# For example, for a `Control`, this would be:
+#   projects/{project}/locations/{location}/collections/{collection_id}/engines/
+#   {engine_id}/controls/{control_id}
+#
+# Requires the including class to implement `#discovery_engine_id`, and optionally `#parent` if the
+# parent resource is not the default collection.
+module DiscoveryEngineNameable
+  # The name (fully qualified path) of this Discovery Engine resource on GCP
+  def name
+    [parent_name, resource_path_fragment, discovery_engine_id].join("/")
+  end
+
+private
+
+  def resource_path_fragment
+    # For example: `DataStore` -> `dataStores`
+    self.class.name.downcase_first.pluralize
+  end
+
+  def parent_name
+    if respond_to?(:parent)
+      parent.name
+    else
+      # The default collection is the parent of all root-level resources
+      Rails.configuration.discovery_engine_default_collection_name
+    end
+  end
+end

app/models/control.rb

@@ -10,6 +10,7 @@
 # see
 # https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-Control
 class Control < ApplicationRecord
+  include DiscoveryEngineNameable
   include RemoteSynchronizable
   remote_synchronize with: DiscoveryEngine::ControlClient
 
@@ -30,11 +31,6 @@ def to_discovery_engine_control
     }
   end
 
-  # The fully qualified name of the control on Discovery Engine (like a path)
-  def name
-    [parent.name, "controls", discovery_engine_id].join("/")
-  end
-
   # The parent of the control on Discovery Engine (always the default engine)
   def parent
     Engine.default

app/models/data_store.rb

@@ -7,6 +7,8 @@
 #
 # see https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-DataStore
 class DataStore
+  include DiscoveryEngineNameable
+
   # The ID of the default datastore created through Terraform in `govuk_infrastructure`
   DEFAULT_DATA_STORE_ID = "govuk_content".freeze
 
@@ -20,15 +22,6 @@ def initialize(discovery_engine_id)
     @discovery_engine_id = discovery_engine_id
   end
 
-  # The fully qualified name of the data store on Discovery Engine (like a path)
-  def name
-    [
-      Rails.configuration.discovery_engine_default_collection_name,
-      "dataStores",
-      discovery_engine_id
-    ].join("/")
-  end
-
   def ==(other)
     discovery_engine_id == other.discovery_engine_id
   end

app/models/engine.rb

@@ -9,6 +9,8 @@
 #
 # see https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-Engine
 class Engine
+  include DiscoveryEngineNameable
+
   # The ID of the default engine created through Terraform in `govuk-infrastructure`
   DEFAULT_ENGINE_ID = "govuk".freeze
 
@@ -22,15 +24,6 @@ def initialize(discovery_engine_id)
     @discovery_engine_id = discovery_engine_id
   end
 
-  # The fully qualified name of the engine on Discovery Engine (like a path)
-  def name
-    [
-      Rails.configuration.discovery_engine_default_collection_name,
-      "engines",
-      discovery_engine_id
-    ].join("/")
-  end
-
   def ==(other)
     discovery_engine_id == other.discovery_engine_id
   end