forest_admin_agent 1.37.0 → 1.37.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc6e61b3689e5c138ee42e22593c8c63b831c0ecdb1bd83c98eaf7906474b05e
-  data.tar.gz: fa9601ceb32774b5238c78ad6afe7264e6814ea4b8a90bbc87fff720d8b58c79
+  metadata.gz: 5f51fef26a1f52081d72076f28f72f437b54a83098e102a42a6296762c9132b7
+  data.tar.gz: 21687f62160a1c9cec54ecd22ec825916b01b8e7dba199effa38155bf562d1f7
 SHA512:
-  metadata.gz: 842fb4291fe4d103bdb227012e1eefcc2aee41ddf57d3524cf40c78d3497d0697f76007f418e06cc4b8c051f7bf337bbe634583f95affd00f928d556be3e1486
-  data.tar.gz: 846cc2161f6e731dd6141279d99f3927953929881ae4a1b3770746d3bc94070a44507d4fddbb7d98c3b9a2810eb095dbfb51c64546ffbc6e5754c9a23a0aecea
+  metadata.gz: 2cfb0856639abffe732513e6cc01d94f91f7f26e251e211f56405b6b695410a77a66b767315ec5a775ce2f534629121bc44e9315389e5764e338c4da49e911eb
+  data.tar.gz: ca3e278582b7166879c261efffbd47e85ae991e1b18867b10ec4d8f05c0eed3505420a455cc3b393730eb8d0a9f16d1b61c422d50e9f198d4d4d75316ed913ce

data/lib/forest_admin_agent/builder/agent_factory.rb

@@ -13,6 +13,8 @@ module ForestAdminAgent
       attr_reader :customizer, :container, :has_env_secret
       attr_accessor :schema_only_mode
 
+      ENV_SECRET_FORMAT = /\A[0-9a-f]{64}\z/
+
       def initialize
         super
         @reloading = false
@@ -20,7 +22,7 @@ module ForestAdminAgent
 
       def setup(options)
         @options = options
-        @has_env_secret = options.to_h.key?(:env_secret)
+        @has_env_secret = !options.to_h[:env_secret].nil?
         @customizer = ForestAdminDatasourceCustomizer::DatasourceCustomizer.new
         build_container
         build_cache
@@ -115,6 +117,7 @@ module ForestAdminAgent
         end
 
         return unless @has_env_secret
+        return unless secrets_format_valid?
 
         schema = generate_schema_file
 
@@ -127,7 +130,19 @@ module ForestAdminAgent
           end
         end
 
-        post_schema(schema, force)
+        begin
+          post_schema(schema, force)
+        rescue StandardError => e
+          # A well-formed secret can still be rejected by the server (wrong project, revoked
+          # secret, network down, ...). Same rule as an invalid format: block boot in
+          # production, but never in dev - warn and move on instead. Scoped to this call
+          # only, so a local bug (a broken customization, an unwritable schema_path, ...)
+          # still surfaces immediately instead of being logged as a generic warning.
+          raise e if Facades::Container.cache(:is_production)
+
+          @logger.log('Warn', "[ForestAdmin] #{e.message}")
+          @logger.log('Warn', '[ForestAdmin] Schema sync failed, continuing without it.')
+        end
       end
 
       # Generates or loads the schema and writes it to file (in development mode).
@@ -175,6 +190,40 @@ module ForestAdminAgent
 
       private
 
+      # Checked from send_schema rather than setup, so that schema-only mode (which never
+      # syncs to the server) never fails on a secret it doesn't actually need.
+      def secrets_format_valid?
+        errors = secret_format_errors
+        return true if errors.empty?
+
+        if Facades::Container.cache(:is_production)
+          raise ForestAdminAgent::Http::Exceptions::ValidationError, errors.join(' ')
+        end
+
+        # Don't block boot on a config mistake in dev: warn loudly and skip the schema
+        # sync instead, so the developer can still work on the rest of the app.
+        errors.each { |error| @logger.log('Warn', "[ForestAdmin] #{error}") }
+        @logger.log('Warn', '[ForestAdmin] Skipping schema sync until this is fixed.')
+        false
+      end
+
+      def secret_format_errors
+        errors = []
+        env_secret = @options.to_h[:env_secret]
+
+        unless env_secret.is_a?(String) && env_secret.match?(ENV_SECRET_FORMAT)
+          errors << 'config.env_secret is invalid: it must be the 64-character hexadecimal secret from your ' \
+                    'Forest Admin project settings.'
+        end
+
+        auth_secret = @options.to_h[:auth_secret]
+        unless auth_secret.is_a?(String)
+          errors << 'config.auth_secret is invalid: it must be a string. Any long random value works.'
+        end
+
+        errors
+      end
+
       def container_replace(key, value)
         @container._container.delete(key.to_s)
         @container.register(key, value)
@@ -211,6 +260,7 @@ module ForestAdminAgent
 
         begin
           response = client.post('/forest/apimaps/hashcheck', { schemaFileHash: hash }.to_json)
+          client.raise_for_response!(response)
           body = JSON.parse(response.body)
           body['sendSchema']
         rescue JSON::ParserError => e
@@ -281,7 +331,8 @@ module ForestAdminAgent
       def send_schema_to_server(api_map)
         ForestAdminAgent::Facades::Container.logger.log('Info', 'schema was updated, sending new version')
         client = ForestAdminAgent::Http::ForestAdminApiRequester.new
-        client.post('/forest/apimaps', api_map.to_json)
+        response = client.post('/forest/apimaps', api_map.to_json)
+        client.raise_for_response!(response)
       rescue Faraday::Error => e
         status = e.response[:status] if e.response
         if status

data/lib/forest_admin_agent/http/forest_admin_api_requester.rb

@@ -41,33 +41,48 @@ module ForestAdminAgent
           )
         end
 
-        if error.response[:status].zero? || error.response[:status] == 502
+        raise_for_status(error.response[:status], cause: error)
+      end
+
+      # Faraday does not raise on HTTP error statuses here (no raise_error middleware
+      # configured), so a response has to be checked explicitly to turn e.g. an
+      # invalid envSecret (404) into the same typed errors as handle_response_error.
+      def raise_for_response!(response)
+        return if response.success?
+
+        raise_for_status(response.status, message: response.reason_phrase)
+      end
+
+      private
+
+      def raise_for_status(status, cause: nil, message: cause&.message)
+        if status.zero? || status == 502
           raise BadGatewayError.new(
             'Failed to reach ForestAdmin server. Are you online?',
-            details: { status: error.response[:status] },
-            cause: error
+            details: { status: status },
+            cause: cause
           )
         end
 
-        if error.response[:status] == 404
+        if status == 404
           raise NotFoundError.new(
             'ForestAdmin server failed to find the project related to the envSecret you configured. Can you check that you copied it properly in the Forest initialization?',
-            details: { status: error.response[:status] }
+            details: { status: status }
           )
         end
 
-        if error.response[:status] == 503
+        if status == 503
           raise ServiceUnavailableError.new(
             'Forest is in maintenance for a few minutes. We are upgrading your experience in the forest. We just need a few more minutes to get it right.',
-            details: { status: error.response[:status] },
-            cause: error
+            details: { status: status },
+            cause: cause
           )
         end
 
         raise InternalServerError.new(
           'An unexpected error occurred while contacting the ForestAdmin server. Please contact support@forestadmin.com for further investigations.',
-          details: { status: error.response[:status], message: error.message },
-          cause: error
+          details: { status: status, message: message },
+          cause: cause
         )
       end
     end

data/lib/forest_admin_agent/utils/schema/schema_emitter.rb

@@ -6,7 +6,7 @@ module ForestAdminAgent
     module Schema
       class SchemaEmitter
         LIANA_NAME = "agent-ruby"
-        LIANA_VERSION = "1.37.0"
+        LIANA_VERSION = "1.37.1"
 
         def self.generate(datasource)
           datasource.collections

data/lib/forest_admin_agent/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminAgent
-  VERSION = "1.37.0"
+  VERSION = "1.37.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forest_admin_agent
 version: !ruby/object:Gem::Version
-  version: 1.37.0
+  version: 1.37.1
 platform: ruby
 authors:
 - Matthieu