Implement protocol plugin and rpcv2 protocol

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

@@ -49,6 +49,10 @@
 require_relative 'smithy-client/cbor'
 require_relative 'smithy-client/codecs/cbor'
 
+# protocols
+require_relative 'smithy-client/protocols'
+require_relative 'smithy-client/protocols/rpcv2'
+
 module Smithy
   # Base module for a generated Smithy gem.
   module Client

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

@@ -30,7 +30,8 @@ def serialize(data, shape)
         # @param [Struct] type
         # @return [Object, Hash]
         def deserialize(bytes, shape, type = nil)
-          return {} if bytes.empty?
+          return {} # for development purposes since default response body is StringIO
+          # return {} if bytes.empty?
 
           parse_data(Client::CBOR.decode(bytes), shape, type)
         end

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

@@ -11,6 +11,7 @@ class HandlerContext
       # @option options [Configuration] :config (nil)
       # @option options [Request] :request (HTTP::Request.new)
       # @option options [Response] :response (HTTP::Response.new)
+      # @option options [Protocol] :protocol (nil)
       # @options options [Hash] :metadata ({})
       def initialize(options = {})
         @operation_name = options[:operation_name]
@@ -20,6 +21,7 @@ def initialize(options = {})
         @config = options[:config]
         @request = options[:request] || HTTP::Request.new
         @response = options[:response] || HTTP::Response.new
+        @protocol = options[:protocol]
         @metadata = {}
       end
 
@@ -44,6 +46,9 @@ def initialize(options = {})
       # @return [Response]
       attr_accessor :response
 
+      # @return [Protocol]
+      attr_accessor :protocol
+
       # @return [Hash]
       attr_reader :metadata
 

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Client
+    module Protocols
+      # Base protocol class that all protocols derived from
+      class ProtocolBase
+        def initialize(id)
+          @id = id
+          @service_id = nil
+        end
+
+        attr_reader :id
+
+        attr_accessor :service_id
+
+        def build_request(context)
+          raise NotImplementedError
+        end
+
+        def parse_response(context)
+          raise NotImplementedError
+        end
+
+        def parse_error
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Client
+    module Protocols
+      # RPCV2 protocol
+      class RPCV2 < ProtocolBase
+        def initialize
+          super('smithy.protocols#rpcv2Cbor')
+        end
+
+        def build_request(context)
+          puts 'BUILDING REQUEST FROM RPCV2 PROTOCOL'
+          input_shape = context.operation.input
+          context.request.http_method = 'POST'
+          codec = Client::Codecs::CBOR.new(codec_setting(input_shape))
+          context.request.body = codec.serialize(context.params, input_shape)
+          apply_headers(context.request)
+        end
+
+        def parse_response(context)
+          puts 'PARSING RESPONSE FROM RPCV2 PROTOCOL'
+          # TODO: Need to refactor to handle eventstreams
+          output_shape = context.operation.output
+          codec = Client::Codecs::CBOR.new(codec_setting(output_shape))
+          codec.deserialize(context.response.body, output_shape, output_shape.type)
+        end
+
+        # TODO: Implement ContentType Handler specific to RPCV2
+        def apply_content_type(context)
+          context.request.headers['Content-Type'] = 'application/cbor'
+        end
+
+        private
+
+        def apply_headers(request)
+          # TODO: Add X-Amz-Query-Mode header if aws.protocols#awsQueryCompatible is true
+          request.headers['Smithy-Protocol'] = 'rpc-v2-cbor'
+          # TODO: Remove after implementing ContentLength Plugin/Handler
+          request.headers['Content-Length'] = request.body.size
+        end
+
+        def codec_setting(_shape)
+          # TODO: Filter codec traits, depending on context
+          {}
+        end
+      end
+    end
+  end
+end

gems/smithy/lib/smithy/generators/client.rb

@@ -81,6 +81,11 @@ def code_generated_plugins
             require_path: "lib/#{@gem_name}/plugins/endpoint.rb",
             source: Views::Client::EndpointPlugin.new(@plan).render
           )
+          e.yield Views::Client::Plugin.new(
+            class_name: "#{@plan.module_name}::Plugins::Protocol",
+            require_path: "lib/#{@gem_name}/plugins/protocol.rb",
+            source: Views::Client::ProtocolPlugin.new(@plan).render
+          )
         end
       end
 

gems/smithy/lib/smithy/templates/client/client.erb

@@ -37,12 +37,15 @@ module <%= module_name %>
 
     def build_input(operation_name, params)
       handlers = @handlers.for(operation_name)
+      operation = config.schema.operation(operation_name)
+      config.protocol.service_id = '<%= service_id %>'
       context = Smithy::Client::HandlerContext.new(
         operation_name: operation_name,
-        operation: config.schema.operation(operation_name),
+        operation: operation,
         client: self,
         params: params,
         config: config,
+        protocol: config.protocol
       )
       context[:gem_name] = '<%= gem_name %>'
       context[:gem_version] = '<%= gem_version %>'

gems/smithy/lib/smithy/templates/client/protocol_plugin.erb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+module <%= module_name %>
+  module Plugins
+     # Protocol plugin
+     class Protocol < Smithy::Client::Plugin
+       option(
+         :protocol,
+         doc_default: 'Smithy::Client::Protocols::<%= protocol_name %>',
+         doc_type: 'Smithy::Client::Protocols::ProtocolBase',
+         docstring: 'TODO'
+         ) do |_cfg|
+           Smithy::Client::Protocols::<%= protocol_name %>.new
+         end
+
+       # @api private
+       class Build < Smithy::Client::Handler
+         def call(context)
+           puts '**Calling from BuildHandler**'
+           context.protocol.build_request(context)
+           @handler.call(context)
+         end
+       end
+
+       # @api private
+       class Parse < Smithy::Client::Handler
+         def call(context)
+           puts '**Calling from ParseHandler**'
+           resp = @handler.call(context)
+           context.protocol.parse_response(context)
+           resp
+         end
+       end
+
+       def add_handlers(handlers, config)
+         handlers.add(Build)
+         handlers.add(Parse)
+       end
+     end
+  end
+end

gems/smithy/lib/smithy/views/client.rb

@@ -28,6 +28,7 @@ module Client; end
 require_relative 'client/gemspec'
 require_relative 'client/module'
 require_relative 'client/module_rbs'
+require_relative 'client/protocol_plugin'
 require_relative 'client/rubocop_yml'
 require_relative 'client/shapes'
 require_relative 'client/shapes_rbs'

gems/smithy/lib/smithy/views/client/client.rb

@@ -16,6 +16,10 @@ def module_name
           @plan.module_name
         end
 
+        def service_id
+          @plan.service.keys.first
+        end
+
         def gem_name
           @plan.gem_name
         end

gems/smithy/lib/smithy/views/client/module.rb

@@ -34,7 +34,17 @@ def requires
           return %i[customizations types shapes] if @plan.type == :schema
 
           # Order matters here - plugins must come before client, types must come before shapes
-          %w[plugins/endpoint types shapes client customizations errors endpoint_parameters endpoint_provider]
+          %w[
+            plugins/endpoint
+            plugins/protocol
+            types
+            shapes
+            client
+            customizations
+            errors
+            endpoint_parameters
+            endpoint_provider
+          ]
         end
       end
     end

gems/smithy/lib/smithy/views/client/protocol_plugin.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    module Client
+      # @api private
+      class ProtocolPlugin < View
+        def initialize(plan)
+          @plan = plan
+          @model = plan.model
+          super()
+        end
+
+        attr_reader :plan
+
+        def module_name
+          @plan.module_name
+        end
+
+        def protocol_name
+          raise ArgumentError, 'Invalid protocol' if (protocol = resolve_protocol).nil?
+
+          protocol
+        end
+
+        private
+
+        SUPPORTED_PROTOCOLS = {
+          'smithy.protocols#rpcv2Cbor' => 'RPCV2'
+        }.freeze
+
+        # smithy.protocols#rpcv2Cbor
+        def resolve_protocol
+          protocol = @plan
+                     .service
+                     .values
+                     .first['traits']
+                     .find { |k, _v| k.start_with?('smithy.protocols') }
+                     &.first
+          SUPPORTED_PROTOCOLS[protocol]
+        end
+      end
+    end
+  end
+end

model/weather.smithy

@@ -2,7 +2,10 @@ $version: "2"
 
 namespace example.weather
 
+use smithy.protocols#rpcv2Cbor
+
 /// Provides weather forecasts.
+@rpcv2Cbor
 @paginated(inputToken: "nextToken", outputToken: "nextToken", pageSize: "pageSize")
 service Weather {
     version: "2006-03-01"

projections/weather/lib/weather.rb

@@ -9,6 +9,7 @@ module Weather
 end
 
 require_relative 'weather/plugins/endpoint'
+require_relative 'weather/plugins/protocol'
 require_relative 'weather/types'
 require_relative 'weather/shapes'
 require_relative 'weather/client'

projections/weather/lib/weather/client.rb

@@ -12,6 +12,7 @@ class Client < Smithy::Client::Base
 
     add_plugin(Smithy::Client::Plugins::NetHTTP)
     add_plugin(Weather::Plugins::Endpoint)
+    add_plugin(Weather::Plugins::Protocol)
 
     # @param [Hash] options
     # @option options [Logger] :logger
@@ -83,6 +84,8 @@ class Client < Smithy::Client::Base
     #  `#resolve_endpoint(parameters)`.
     # @option options [String] :endpoint
     #  Custom Endpoint
+    # @option options [Smithy::Client::Protocols::ProtocolBase] :protocol (Smithy::Client::Protocols::RPCV2)
+    #  TODO
     def initialize(*args)
       super
     end
@@ -164,12 +167,15 @@ def list_cities(params = {}, options = {})
 
     def build_input(operation_name, params)
       handlers = @handlers.for(operation_name)
+      operation = config.schema.operation(operation_name)
+      config.protocol.service_id = 'example.weather#Weather'
       context = Smithy::Client::HandlerContext.new(
         operation_name: operation_name,
-        operation: config.schema.operation(operation_name),
+        operation: operation,
         client: self,
         params: params,
-        config: config
+        config: config,
+        protocol: config.protocol
       )
       context[:gem_name] = 'weather'
       context[:gem_version] = '1.0.0'

projections/weather/lib/weather/plugins/protocol.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+module Weather
+  module Plugins
+    # Protocol plugin
+    class Protocol < Smithy::Client::Plugin
+      option(
+        :protocol,
+        doc_default: 'Smithy::Client::Protocols::RPCV2',
+        doc_type: 'Smithy::Client::Protocols::ProtocolBase',
+        docstring: 'TODO'
+      ) do |_cfg|
+        Smithy::Client::Protocols::RPCV2.new
+      end
+
+      # @api private
+      class Build < Smithy::Client::Handler
+        def call(context)
+          puts '**Calling from BuildHandler**'
+          context.protocol.build_request(context)
+          @handler.call(context)
+        end
+      end
+
+      # @api private
+      class Parse < Smithy::Client::Handler
+        def call(context)
+          puts '**Calling from ParseHandler**'
+          resp = @handler.call(context)
+          context.protocol.parse_response(context)
+          resp
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Build)
+        handlers.add(Parse)
+      end
+    end
+  end
+end

projections/weather/lib/weather/shapes.rb

@@ -61,7 +61,7 @@ module Shapes
       schema.service = ServiceShape.new(
         id: 'example.weather#Weather',
         version: '2006-03-01',
-        traits: { 'smithy.api#paginated' => { 'inputToken' => 'nextToken', 'outputToken' => 'nextToken', 'pageSize' => 'pageSize' } }
+        traits: { 'smithy.api#paginated' => { 'inputToken' => 'nextToken', 'outputToken' => 'nextToken', 'pageSize' => 'pageSize' }, 'smithy.protocols#rpcv2Cbor' => {} }
       )
       schema.add_operation(:get_city, OperationShape.new do |operation|
         operation.id = 'example.weather#GetCity'