chore(rpc_datasource): add warning for unexpected build option keys (#267)

Author: matthv

packages/forest_admin_datasource_rpc/lib/forest_admin_datasource_rpc.rb

@@ -12,7 +12,18 @@ def self.configure_polling_pool(max_threads:)
     Utils::SchemaPollingPool.instance.configure(max_threads: max_threads)
   end
 
+  KNOWN_BUILD_OPTIONS = %i[uri auth_secret introspection introspection_etag schema_polling_interval_sec].freeze
+
   def self.build(options)
+    unknown_keys = options.keys - KNOWN_BUILD_OPTIONS
+    if unknown_keys.any?
+      ForestAdminAgent::Facades::Container.logger.log(
+        'Warn',
+        "[RPCDatasource] Unknown option(s) passed to build: #{unknown_keys.join(", ")}. " \
+        "Known options are: #{KNOWN_BUILD_OPTIONS.join(", ")}"
+      )
+    end
+
     uri = options[:uri]
     auth_secret = options[:auth_secret] || ForestAdminAgent::Facades::Container.cache(:auth_secret)
     provided_introspection = options[:introspection]

packages/forest_admin_datasource_rpc/spec/forest_admin_datasource_rpc_spec.rb

@@ -16,6 +16,39 @@ module ForestAdminDatasourceRpc
 
       include_examples 'with introspection'
 
+      context 'with unknown options' do
+        let(:schema_polling_client) { instance_double(Utils::SchemaPollingClient, start?: true, stop: nil, current_schema: introspection) }
+        let(:logger) { ForestAdminAgent::Facades::Container.logger }
+
+        before do
+          allow(Utils::SchemaPollingClient).to receive(:new).and_return(schema_polling_client)
+        end
+
+        it 'logs a warning when unknown keys are passed' do
+          described_class.build({ uri: 'http://localhost', url: 'http://localhost', foo: 'bar' })
+
+          expect(logger).to have_received(:log).with(
+            'Warn',
+            a_string_matching(/Unknown option.*\burl\b.*\bfoo\b/)
+          )
+        end
+
+        it 'logs a warning when a key does not exist in known options' do
+          described_class.build({ uri: 'http://localhost', url: 'http://localhost' })
+
+          expect(logger).to have_received(:log).with(
+            'Warn',
+            a_string_matching(/Unknown option.*url.*Known options are/)
+          )
+        end
+
+        it 'does not log a warning when only known keys are passed' do
+          described_class.build({ uri: 'http://localhost', auth_secret: 'secret', schema_polling_interval_sec: 60 })
+
+          expect(logger).not_to have_received(:log).with('Warn', anything)
+        end
+      end
+
       context 'when server is running' do
         let(:schema_polling_client) { instance_double(Utils::SchemaPollingClient, start?: true, stop: nil, current_schema: introspection) }
         let(:response) { Utils::SchemaResponse.new(introspection, 'etag123') }