Implement transparent client pattern and middleware error handling (#147)

Co-authored-by: Evan Sosenko <[email protected]>
Co-authored-by: Seam Bot <[email protected]>

Author: 3 people

lib/seam/base_client.rb

@@ -9,6 +9,10 @@ def initialize(data)
       create_accessor_methods
     end
 
+    def [](key)
+      instance_variable_get(:"@#{key}")
+    end
+
     private
 
     def create_accessor_methods

lib/seam/deep_hash_accessor.rb

@@ -4,13 +4,11 @@ module Seam
   module Helpers
     module ActionAttempt
       def self.decide_and_wait(action_attempt, client, wait_for_action_attempt)
-        wait_decision = wait_for_action_attempt.nil? ? client.defaults.wait_for_action_attempt : wait_for_action_attempt
-
-        if wait_decision == true
+        if wait_for_action_attempt == true
           return wait_until_finished(action_attempt, client)
-        elsif wait_decision.is_a?(Hash)
-          return wait_until_finished(action_attempt, client, timeout: wait_decision[:timeout],
-            polling_interval: wait_decision[:polling_interval])
+        elsif wait_for_action_attempt.is_a?(Hash)
+          return wait_until_finished(action_attempt, client, timeout: wait_for_action_attempt[:timeout],
+            polling_interval: wait_for_action_attempt[:polling_interval])
         end
 
         action_attempt
@@ -37,13 +35,7 @@ def self.wait_until_finished(action_attempt, client, timeout: nil, polling_inter
       end
 
       def self.update_action_attempt(action_attempt, client)
-        response = client.request_seam(
-          :post,
-          "/action_attempts/get",
-          body: {
-            action_attempt_id: action_attempt.action_attempt_id
-          }
-        )
+        response = client.get("/action_attempts/get", {action_attempt_id: action_attempt.action_attempt_id})
 
         action_attempt.update_from_response(response.body["action_attempt"])
         action_attempt

lib/seam/helpers/action_attempt.rb

@@ -29,7 +29,7 @@ def lts_version
       end
 
       def workspaces
-        @workspaces ||= WorkspacesProxy.new(Seam::Clients::Workspaces.new(self))
+        @workspaces ||= WorkspacesProxy.new(Seam::Clients::Workspaces.new(client: @client, defaults: @defaults))
       end
 
       def self.from_personal_access_token(personal_access_token, endpoint: nil, wait_for_action_attempt: true, faraday_options: {}, faraday_retry_options: {})
@@ -41,16 +41,6 @@ def self.from_personal_access_token(personal_access_token, endpoint: nil, wait_f
           faraday_retry_options: faraday_retry_options
         )
       end
-
-      def request_seam_object(method, path, klass, inner_object, config = {})
-        response = Seam::Http::Request.request_seam(@client, @endpoint, method, path, config)
-        data = response.body[inner_object]
-        klass.load_from_response(data, self)
-      end
-
-      def request_seam(method, path, config = {})
-        Seam::Http::Request.request_seam(@client, @endpoint, method, path, config)
-      end
     end
 
     class WorkspacesProxy

lib/seam/http_multi_workspace.rb

@@ -18,9 +18,10 @@ def initialize(client: nil, api_key: nil, personal_access_token: nil, workspace_
         @endpoint = options[:endpoint]
         @auth_headers = options[:auth_headers]
         @defaults = Seam::DeepHashAccessor.new({"wait_for_action_attempt" => wait_for_action_attempt})
-
         @client = client || Seam::Http::Request.create_faraday_client(@endpoint, @auth_headers, faraday_options,
           faraday_retry_options)
+
+        initialize_routes(client: @client, defaults: @defaults)
       end
 
       def lts_version
@@ -36,16 +37,6 @@ def self.from_personal_access_token(personal_access_token, workspace_id, endpoin
         new(personal_access_token: personal_access_token, workspace_id: workspace_id, endpoint: endpoint,
           wait_for_action_attempt: wait_for_action_attempt, faraday_options: faraday_options, faraday_retry_options: faraday_retry_options)
       end
-
-      def request_seam_object(method, path, klass, inner_object, config = {})
-        response = Seam::Http::Request.request_seam(@client, @endpoint, method, path, config)
-        data = response.body[inner_object]
-        klass.load_from_response(data, self)
-      end
-
-      def request_seam(method, path, config = {})
-        Seam::Http::Request.request_seam(@client, @endpoint, method, path, config)
-      end
     end
   end
 end

lib/seam/http_single_workspace.rb

@@ -23,42 +23,9 @@ def self.create_faraday_client(endpoint, auth_headers, faraday_options = {}, far
 
         Faraday.new(options) do |builder|
           builder.request :json
-          builder.request :retry, faraday_retry_options
           builder.response :json
-        end
-      end
-
-      def self.handle_error_response(response, _method, _path)
-        status_code = response.status
-        request_id = response.headers["seam-request-id"]
-
-        raise Http::UnauthorizedError.new(request_id) if status_code == 401
-
-        error = response.body.is_a?(Hash) ? response.body["error"] || {} : {}
-        error_type = error["type"] || "unknown_error"
-        error_message = error["message"] || "Unknown error"
-        error_details = {
-          type: error_type,
-          message: error_message,
-          data: error["data"]
-        }
-
-        if error_type == "invalid_input"
-          error_details["validation_errors"] = error["validation_errors"]
-          raise Http::InvalidInputError.new(error_details, status_code, request_id)
-        end
-
-        raise Http::ApiError.new(error_details, status_code, request_id)
-      end
-
-      def self.request_seam(client, endpoint, method, path, config = {})
-        url = "#{endpoint}#{path}"
-        response = client.run_request(method, url, config[:body], config[:headers])
-
-        if response.success?
-          response
-        else
-          handle_error_response(response, method, path)
+          builder.use ResponseMiddleware
+          builder.request :retry, faraday_retry_options
         end
       end
 
@@ -72,6 +39,53 @@ def self.default_headers
         }
       end
 
+      class ResponseMiddleware < Faraday::Response::RaiseError
+        def on_complete(env)
+          return if env.success?
+
+          status_code = env.status
+          request_id = env.response_headers["seam-request-id"]
+
+          raise Http::UnauthorizedError.new(request_id) if status_code == 401
+
+          if seam_api_error_response?(env)
+            body = JSON.parse(env.body)
+            error = body["error"]
+            error_details = {
+              type: error["type"] || "unknown_error",
+              message: error["message"] || "Unknown error",
+              data: error["data"]
+            }
+
+            if error["type"] == "invalid_input"
+              error_details["validation_errors"] = error["validation_errors"]
+              raise Http::InvalidInputError.new(error_details, status_code, request_id)
+            end
+
+            raise Http::ApiError.new(error_details, status_code, request_id)
+          end
+
+          super
+        end
+
+        def seam_api_error_response?(env)
+          return false unless env.response_headers
+
+          content_type = env.response_headers["Content-Type"]
+          return false unless content_type&.start_with?("application/json")
+
+          begin
+            body = JSON.parse(env.body)
+            return false unless body.is_a?(Hash) && body["error"].is_a?(Hash)
+
+            error = body["error"]
+            error["type"].is_a?(String) && error["message"].is_a?(String)
+          rescue JSON::ParserError
+            false
+          end
+        end
+      end
+
       def self.deep_merge(hash1, hash2)
         result = hash1.dup
         hash2.each do |key, value|