Use plugins per protocol approach

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: necko-actions/setup-smithy@v1
         with:
-          version: '1.56.0'
+          version: '1.60.3'
       - run: smithy --version
 
       - name: Setup Ruby

gems/smithy-client/lib/smithy-client.rb

@@ -52,10 +52,6 @@
 require_relative 'smithy-client/identity'
 require_relative 'smithy-client/refreshing_identity_provider'
 
-# protocols
-
-require_relative 'smithy-client/rpc_v2_cbor/protocol'
-
 # stubbing
 
 require_relative 'smithy-client/stubs'

gems/smithy-client/lib/smithy-client/handler_list_entry.rb

@@ -10,11 +10,10 @@ module Client
     class HandlerListEntry
       # @api private
       STEPS = {
-        initialize: 600,
-        validate: 500,
-        build: 400,
-        retry: 300,
-        parse: 200,
+        initialize: 500,
+        validate: 400,
+        build: 300,
+        retry: 200,
         sign: 100,
         send: 0
       }.freeze
@@ -79,8 +78,7 @@ def step=(step)
         if STEPS.key?(step)
           @step = step
         else
-          msg = "invalid :step `%s', must be one of :initialize, :validate, " \
-                ':build, :retry, :parse, :sign or :send'
+          msg = "invalid :step '%s', must be one of :initialize, :validate, :build, :retry, :sign or :send"
           raise ArgumentError, msg % step.inspect
         end
       end
@@ -89,7 +87,7 @@ def priority=(priority)
         if (0..99).include?(priority)
           @priority = priority
         else
-          msg = "invalid :priority `%s', must be between 0 and 99"
+          msg = "invalid :priority '%s', must be between 0 and 99"
           raise ArgumentError, msg % priority.inspect
         end
       end

gems/smithy-client/lib/smithy-client/plugins/param_converter.rb

@@ -22,8 +22,7 @@ class Handler < Client::Handler
           def call(context)
             converter = Client::ParamConverter.new(context.operation.input)
             context.params = converter.convert(context.params)
-            context.http_response.on_done { converter.close_opened_files }
-            @handler.call(context)
+            @handler.call(context).on_done { converter.close_opened_files }
           end
         end
       end

gems/smithy-client/lib/smithy-client/plugins/rpc_v2_cbor.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../rpc_v2_cbor/error_handler'
+require_relative '../rpc_v2_cbor/handler'
+require_relative '../stubbing/rpc_v2_cbor'
+
+module Smithy
+  module Client
+    module Plugins
+      # @api private
+      class RpcV2Cbor < Plugin
+        # @api private
+        option(:codec) { CBOR::Codec.new }
+        # @api private
+        option(:stubber) { Stubbing::RpcV2Cbor.new }
+
+        handler(Client::RpcV2Cbor::Handler)
+        handler(Client::RpcV2Cbor::ErrorHandler, step: :sign)
+      end
+    end
+  end
+end

gems/smithy-client/lib/smithy-client/plugins/stub_responses.rb

@@ -23,6 +23,8 @@ class StubResponses < Plugin
         option(:api_requests) { [] }
         # @api private
         option(:api_requests_mutex) { Mutex.new }
+        # @api private
+        option(:stubber) { Stubbing::NullProtocol.new }
 
         def add_handlers(handlers, config)
           return unless config.stub_responses

gems/smithy-client/lib/smithy-client/response.rb

@@ -13,7 +13,9 @@ def initialize(options = {})
         @context = options[:context] || HandlerContext.new
         @data = options[:data]
         @error = options[:error]
-        @context.http_response.on_error { |error| @error = error }
+        @http_request = @context.http_request
+        @http_response = @context.http_response
+        @http_response.on_error { |error| @error = error }
         super(@error || @data)
       end
 
@@ -28,6 +30,24 @@ def initialize(options = {})
       #  operation.  This will be `nil` if the operation was successful.
       attr_accessor :error
 
+      # @overload on_done(status_code, &block)
+      #   @param [Integer] status_code The block will be
+      #     triggered only for responses with the given status code.
+      #
+      # @overload on_done(status_code_range, &block)
+      #   @param [Range<Integer>] status_code_range The block will be
+      #     triggered only for responses with a status code that falls
+      #     within the given range.
+      #
+      # @return [self]
+      def on_done(range = nil, &)
+        response = self
+        @http_response.on_done(range) do
+          yield response
+        end
+        self
+      end
+
       # Necessary to define as a subclass of Delegator
       # @api private
       def __getobj__(&)

gems/smithy-client/lib/smithy-client/rpc_v2_cbor/response_parser.rb → gems/smithy-client/lib/smithy-client/rpc_v2_cbor/error_handler.rb

@@ -2,34 +2,35 @@
 
 module Smithy
   module Client
-    module RPCv2CBOR
+    module RpcV2Cbor
       # @api private
-      class ResponseParser
-        def initialize(options = {})
-          @codec = CBOR::Codec.new(options)
-        end
-
-        def parse_error(context)
-          if !valid_response?(context)
-            code, message, data = http_status_error(context)
-            build_error(context, code, message, data)
-          elsif (300..599).cover?(context.http_response.status_code)
-            error(context)
+      class ErrorHandler < Client::Handler
+        def call(context)
+          # Malformed responses should throw an http based error, so we check
+          # 200 range for error handling only for this case.
+          @handler.call(context).on_done(200..599) do |response|
+            if !valid_response?(context)
+              code, message, data = http_status_error(context)
+              response.error = build_error(context, code, message, data)
+            elsif (300..599).cover?(context.http_response.status_code)
+              response.error = error(context)
+            end
           end
         end
 
-        def parse_data(context)
-          @codec.deserialize(context.operation.output, context.http_response.body.read)
-        end
-
         private
 
         def valid_response?(context)
           req_header = context.http_request.headers['smithy-protocol']
-          resp_header = context.http_request.headers['smithy-protocol']
+          resp_header = context.http_response.headers['smithy-protocol']
           req_header == resp_header
         end
 
+        # TODO: Fix this
+        # This is not correct per protocol tests. Some headers will determine the error code.
+        # If the body is empty, there is still potentially an error code from the header, but
+        # we are making a generic http status error instead. In a new major version, we should
+        # always try to extract header, and during extraction, check headers and body.
         def error(context)
           body = context.http_response.body.read
           if body.empty?
@@ -56,7 +57,7 @@ def parse_error_data(context, body, code)
           context.operation.errors.each do |ref|
             next unless ref.shape.id == code
 
-            data = @codec.deserialize(ref, body, ref.shape.type.new)
+            data = context.config.codec.deserialize(ref, body, ref.shape.type.new)
           end
           data
         end

gems/smithy-client/lib/smithy-client/rpc_v2_cbor/request_builder.rb → gems/smithy-client/lib/smithy-client/rpc_v2_cbor/handler.rb

@@ -2,26 +2,27 @@
 
 module Smithy
   module Client
-    module RPCv2CBOR
+    module RpcV2Cbor
       # @api private
-      class RequestBuilder
-        include Schema::Shapes
-
-        def initialize(options = {})
-          @codec = CBOR::Codec.new(options)
+      class Handler < Client::Handler
+        def call(context)
+          build_request(context)
+          response = @handler.call(context)
+          response.on_done(200..299) { |resp| resp.data = parse_body(context) }
+          response
         end
 
-        def build(context)
-          apply_http_method(context)
+        private
+
+        def build_request(context)
+          context.http_request.http_method = 'POST'
           apply_headers(context)
           apply_body(context)
           apply_url_path(context)
         end
 
-        private
-
-        def apply_http_method(context)
-          context.http_request.http_method = 'POST'
+        def parse_body(context)
+          context.config.codec.deserialize(context.operation.output, context.http_response.body.read)
         end
 
         def apply_headers(context)
@@ -35,7 +36,7 @@ def apply_content_type_header(context)
           content_type =
             if event_stream?(input)
               'application/vnd.amazon.eventstream'
-            elsif input.shape != Prelude::Unit
+            elsif input.shape != Schema::Shapes::Prelude::Unit
               'application/cbor'
             end
 
@@ -54,7 +55,7 @@ def apply_accept_header(context)
         end
 
         def apply_body(context)
-          context.http_request.body = @codec.serialize(context.operation.input, context.params)
+          context.http_request.body = context.config.codec.serialize(context.operation.input, context.params)
         end
 
         def apply_url_path(context)
@@ -66,7 +67,7 @@ def apply_url_path(context)
         def event_stream?(ref)
           ref.shape.members.each_value do |member_ref|
             shape = member_ref.shape
-            return true if shape.traits.key?('smithy.api#streaming') && shape.is_a?(UnionShape)
+            return true if shape.traits.key?('smithy.api#streaming') && shape.is_a?(Schema::Shapes::UnionShape)
           end
           false
         end

gems/smithy-client/lib/smithy-client/stubbing.rb

@@ -3,7 +3,7 @@
 require_relative 'stubbing/data_applicator'
 require_relative 'stubbing/empty_stub'
 require_relative 'stubbing/endpoint_provider'
-require_relative 'stubbing/protocol'
+require_relative 'stubbing/null_protocol'
 require_relative 'stubbing/stub_data'
 
 module Smithy

gems/smithy-client/lib/smithy-client/stubbing/null_protocol.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Client
+    module Stubbing
+      # @api private
+      class NullProtocol
+        def stub_data(_config, _operation, _data)
+          HTTP::Response.new
+        end
+
+        def stub_error(_config, _error_code)
+          HTTP::Response.new
+        end
+      end
+    end
+  end
+end