forest_admin_datasource_rpc 1.16.10 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c76facc94fe343ca29176a93b36f2a85b1d9e90f33c9d2e9a8300e0c1ff824c8
-  data.tar.gz: f47529d4767faf8ec9aaf7fe3c3863e26c092a526fc1c99fc6596fd8931ff235
+  metadata.gz: 3eddd5bbee08cd80c2df623bc125cfd1c93b5995c7cba4f64b0b4a53a93f7708
+  data.tar.gz: 8a57971769da080a8e5a3b030cb7da212665a47054d7fb558d60bf8d0d09b688
 SHA512:
-  metadata.gz: dd67fcda71f0307b651d1bb00c98ac03ac184ec9717f623394f3865680497220bc9558b10501aa9052ecf7ca7d94c0fac5f0486e5f1fc5c6f5e61ce0848a4351
-  data.tar.gz: 2a6d7cd793499fffb01ab99c75f5fbec550aef76b71aeeb82dd582cbd1f0274ef4f40ccb1080c364c58687d9451eea7170d453e8fa7c570bf32c0ff0a2cbf6ab
+  metadata.gz: b4b009428c7020b88a55b2673e4f2fc34d11712cb7c710868a3e745f7b1d527d2f2df61e9fbd7a4bf1b70873dc2d5a6358fc85e575f4013f69e9d97b4d3d5ea9
+  data.tar.gz: f5052e0d5d2e38572dc15730404ab4ef6d2bdfa75b8733aadffa77566e3c7585a3ec8e779d077be6aa106c78ab762b65dae2adb7d245cc7d5569b4c580f4c5a0

data/lib/forest_admin_datasource_rpc/Utils/rpc_client.rb

@@ -5,20 +5,17 @@ require 'time'
 
 module ForestAdminDatasourceRpc
   module Utils
+    # Response wrapper for schema requests that need ETag
+    class SchemaResponse
+      attr_reader :body, :etag
+
+      def initialize(body, etag = nil)
+        @body = body
+        @etag = etag
+      end
+    end
+
     class RpcClient
-      # RpcClient handles HTTP communication with the RPC Agent.
-      #
-      # Error Handling:
-      # When the RPC agent returns an error, this client automatically maps HTTP status codes
-      # to appropriate Forest Admin exception types. This ensures business errors from the
-      # RPC agent are properly propagated to the datasource_rpc.
-      #
-      # To add support for a new error type:
-      # 1. Add the status code and exception class to ERROR_STATUS_MAP
-      # 2. (Optional) Add a default message to generate_default_message method
-      # 3. Tests will automatically cover the new mapping
-
-      # Map HTTP status codes to Forest Admin exception classes
       ERROR_STATUS_MAP = {
         400 => ForestAdminAgent::Http::Exceptions::ValidationError,
         401 => ForestAdminAgent::Http::Exceptions::AuthenticationOpenIdClient,
@@ -28,12 +25,37 @@ module ForestAdminDatasourceRpc
         422 => ForestAdminAgent::Http::Exceptions::UnprocessableError
       }.freeze
 
+      DEFAULT_ERROR_MESSAGES = {
+        400 => 'Bad Request', 401 => 'Unauthorized', 403 => 'Forbidden',
+        404 => 'Not Found', 409 => 'Conflict', 422 => 'Unprocessable Entity'
+      }.freeze
+
+      HTTP_NOT_MODIFIED = 304
+      NotModified = Class.new
+
       def initialize(api_url, auth_secret)
         @api_url = api_url
         @auth_secret = auth_secret
       end
 
-      def call_rpc(endpoint, caller: nil, method: :get, payload: nil, symbolize_keys: false)
+      # rubocop:disable Metrics/ParameterLists
+      def call_rpc(endpoint, caller: nil, method: :get, payload: nil, symbolize_keys: false, if_none_match: nil)
+        response = make_request(endpoint, caller: caller, method: method, payload: payload,
+                                          symbolize_keys: symbolize_keys, if_none_match: if_none_match)
+        handle_response(response)
+      end
+
+      # rubocop:enable Metrics/ParameterLists
+
+      def fetch_schema(endpoint, if_none_match: nil)
+        response = make_request(endpoint, method: :get, symbolize_keys: true, if_none_match: if_none_match)
+        handle_response_with_etag(response)
+      end
+
+      private
+
+      # rubocop:disable Metrics/ParameterLists
+      def make_request(endpoint, caller: nil, method: :get, payload: nil, symbolize_keys: false, if_none_match: nil)
         client = Faraday.new(url: @api_url) do |faraday|
           faraday.request :json
           faraday.response :json, parser_options: { symbolize_names: symbolize_keys }
@@ -51,22 +73,33 @@ module ForestAdminDatasourceRpc
         }
 
         headers['forest_caller'] = caller.to_json if caller
+        headers['If-None-Match'] = %("#{if_none_match}") if if_none_match
 
-        response = client.send(method, endpoint, payload, headers)
-
-        handle_response(response)
+        client.send(method, endpoint, payload, headers)
       end
-
-      private
+      # rubocop:enable Metrics/ParameterLists
 
       def generate_signature(timestamp)
         OpenSSL::HMAC.hexdigest('SHA256', @auth_secret, timestamp)
       end
 
       def handle_response(response)
-        raise_appropriate_error(response) unless response.success?
+        return response.body if response.success?
+        return NotModified if response.status == HTTP_NOT_MODIFIED
+
+        raise_appropriate_error(response)
+      end
+
+      def handle_response_with_etag(response)
+        return SchemaResponse.new(response.body, extract_etag(response)) if response.success?
+        return NotModified if response.status == HTTP_NOT_MODIFIED
 
-        response.body
+        raise_appropriate_error(response)
+      end
+
+      def extract_etag(response)
+        etag = response.headers['ETag'] || response.headers['etag']
+        etag&.gsub(/\A"?|"?\z/, '')
       end
 
       def raise_appropriate_error(response)
@@ -89,37 +122,18 @@ module ForestAdminDatasourceRpc
       end
 
       def generate_default_message(status, url)
-        default_messages = {
-          400 => "Bad Request: #{url}",
-          401 => "Unauthorized: #{url}",
-          403 => "Forbidden: #{url}",
-          404 => "Not Found: #{url}",
-          409 => "Conflict: #{url}",
-          422 => "Unprocessable Entity: #{url}"
-        }
-
-        default_messages[status] || "Unknown error (#{url})"
+        prefix = DEFAULT_ERROR_MESSAGES[status] || 'Unknown error'
+        "#{prefix}: #{url}"
       end
 
       def parse_error_body(response)
         body = response.body
-
-        # If body is already a hash (Faraday parsed it as JSON)
         return symbolize_error_keys(body) if body.is_a?(Hash)
+        return { message: 'Unknown error' } unless body.is_a?(String) && !body.empty?
 
-        # Try to parse as JSON if it's a string
-        if body.is_a?(String) && !body.empty?
-          begin
-            parsed = JSON.parse(body)
-            return symbolize_error_keys(parsed)
-          rescue JSON::ParserError
-            # If parsing fails, return the body as the message
-            return { message: body }
-          end
-        end
-
-        # Fallback for empty or unexpected body types
-        { message: 'Unknown error' }
+        symbolize_error_keys(JSON.parse(body))
+      rescue JSON::ParserError
+        { message: body }
       end
 
       def symbolize_error_keys(hash)

data/lib/forest_admin_datasource_rpc/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminDatasourceRpc
-  VERSION = "1.16.10"
+  VERSION = "1.17.0"
 end

data/lib/forest_admin_datasource_rpc.rb

@@ -13,10 +13,15 @@ module ForestAdminDatasourceRpc
     auth_secret = options[:auth_secret] || ForestAdminAgent::Facades::Container.cache(:auth_secret)
     ForestAdminAgent::Facades::Container.logger.log('Info', "Getting schema from RPC agent on #{uri}.")
 
+    schema = nil
+    cached_etag = nil
+
     begin
       rpc_client = Utils::RpcClient.new(uri, auth_secret)
-      schema = rpc_client.call_rpc('/forest/rpc-schema', method: :get, symbolize_keys: true)
-      last_hash_schema = Digest::SHA1.hexdigest(schema.to_h.to_s)
+      response = rpc_client.fetch_schema('/forest/rpc-schema')
+      schema = response.body
+      # Use the ETag header for conditional requests
+      cached_etag = response.etag
     rescue Faraday::ConnectionFailed => e
       ForestAdminAgent::Facades::Container.logger.log(
         'Error',
@@ -45,11 +50,17 @@ module ForestAdminDatasourceRpc
     else
       sse = Utils::SseClient.new("#{uri}/forest/sse", auth_secret) do
         ForestAdminAgent::Facades::Container.logger.log('Info', 'RPC server stopped, checking schema...')
-        new_schema = rpc_client.call_rpc('/forest/rpc-schema', method: :get, symbolize_keys: true)
 
-        if last_hash_schema == Digest::SHA1.hexdigest(new_schema.to_h.to_s)
-          ForestAdminAgent::Facades::Container.logger.log('Debug', '[RPCDatasource] Schema has not changed')
+        # Send If-None-Match header to check if schema has changed (304 optimization)
+        result = rpc_client.fetch_schema('/forest/rpc-schema', if_none_match: cached_etag)
+
+        # If we get NotModified, schema hasn't changed
+        if result == Utils::RpcClient::NotModified
+          ForestAdminAgent::Facades::Container.logger.log('Debug', '[RPCDatasource] Schema has not changed (304)')
         else
+          # Schema has changed, update the cached ETag and schema, then reload
+          cached_etag = result.etag
+          ForestAdminAgent::Facades::Container.logger.log('Info', '[RPCDatasource] Schema changed, reloading agent...')
           ForestAdminAgent::Builder::AgentFactory.instance.reload!
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forest_admin_datasource_rpc
 version: !ruby/object:Gem::Version
-  version: 1.16.10
+  version: 1.17.0
 platform: ruby
 authors:
 - Matthieu
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-09 00:00:00.000000000 Z
+date: 2025-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64