Ensure that client plugin options doc are generated (#3223)

jterapin · web-flow · commit 74feea5ce5f6 · 2025-03-27T19:29:58.000-07:00
diff --git a/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/client_constructor.rb b/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/client_constructor.rb
@@ -5,11 +5,12 @@ class ClientConstructor
 
     # @option options [required, PluginList] :plugins
     # @option options [required, Array<CodegeneratedPlugin>] :codegenerated_plugins
-
+    # @option options [Array<PluginList::Plugin] :client_plugins
     def initialize(options)
-      plugin_options = documented_plugin_options(options.fetch(:plugins)) +
+      plugin_options =
+        documented_plugin_options(options.fetch(:plugins)) +
         documented_plugin_options(options.fetch(:codegenerated_plugins)) +
-        documented_plugin_options(options.fetch(:default_plugins, []))
+        documented_plugin_options(options.fetch(:client_plugins, []))
       documentation = {}
       plugin_options.each do |option|
         documentation[option.name] = YardOptionTag.new(
diff --git a/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/plugin_list.rb b/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/plugin_list.rb
@@ -8,8 +8,12 @@ class PluginList
     def initialize(options)
       @aws_sdk_core_lib_path = options.fetch(:aws_sdk_core_lib_path)
       @plugins = compute_plugins(options)
+      @client_plugins = compute_client_plugins(options)
     end
 
+    # @return [Array<Plugin>]
+    attr_reader :client_plugins
+
     # @return [Enumerable<Plugin>]
     def each(&block)
       @plugins.each(&block)
@@ -27,44 +31,74 @@ def compute_plugins(options)
         plugins.delete(plugin_name)
       end
       plugins.map do |class_name, path|
-        path = File.absolute_path(path)
-        Kernel.require(path)
+        compute_plugin(class_name, path)
+      end
+    end
 
-        Plugin.new(
-          class_name: class_name,
-          options: const_get(class_name).options,
-          path: path)
+    def compute_client_plugins(options)
+      plugins = options[:async_client] ? async_client_plugins : base_client_plugins
+      plugins.map do |class_name, path|
+        compute_plugin(class_name, path)
       end
     end
 
+    def compute_plugin(class_name, path)
+      path = File.absolute_path(path)
+      Kernel.require(path)
+
+      Plugin.new(
+        class_name: class_name,
+        options: const_get(class_name).options,
+        path: path
+      )
+    end
+
+    def async_client_plugins
+      {
+        'Seahorse::Client::Plugins::Endpoint' => "#{seahorse_plugins_path}/endpoint.rb",
+        'Seahorse::Client::Plugins::H2' => "#{seahorse_plugins_path}/h2.rb",
+        'Seahorse::Client::Plugins::ResponseTarget' => "#{seahorse_plugins_path}/response_target.rb",
+      }
+    end
+
+    def base_client_plugins
+      {
+        'Seahorse::Client::Plugins::Endpoint' => "#{seahorse_plugins_path}/endpoint.rb",
+        'Seahorse::Client::Plugins::NetHttp' => "#{seahorse_plugins_path}/h2.rb",
+        'Seahorse::Client::Plugins::RaiseResponseErrors' => "#{seahorse_plugins_path}/raise_response_errors.rb",
+        'Seahorse::Client::Plugins::ResponseTarget' => "#{seahorse_plugins_path}/response_target.rb",
+        'Seahorse::Client::Plugins::RequestCallback' => "#{seahorse_plugins_path}/request_callback.rb",
+      }
+    end
+
     def default_plugins
       {
-        'Seahorse::Client::Plugins::ContentLength' => "#{seahorse_plugins}/content_length.rb",
-        'Aws::Plugins::CredentialsConfiguration' => "#{core_plugins}/credentials_configuration.rb",
-        'Aws::Plugins::Logging' => "#{core_plugins}/logging.rb",
-        'Aws::Plugins::ParamConverter' => "#{core_plugins}/param_converter.rb",
-        'Aws::Plugins::ParamValidator' => "#{core_plugins}/param_validator.rb",
-        'Aws::Plugins::UserAgent' => "#{core_plugins}/user_agent.rb",
-        'Aws::Plugins::HelpfulSocketErrors' => "#{core_plugins}/helpful_socket_errors.rb",
-        'Aws::Plugins::RetryErrors' => "#{core_plugins}/retry_errors.rb",
-        'Aws::Plugins::GlobalConfiguration' => "#{core_plugins}/global_configuration.rb",
-        'Aws::Plugins::RegionalEndpoint' => "#{core_plugins}/regional_endpoint.rb",
-        'Aws::Plugins::EndpointDiscovery' => "#{core_plugins}/endpoint_discovery.rb",
-        'Aws::Plugins::EndpointPattern' => "#{core_plugins}/endpoint_pattern.rb",
-        'Aws::Plugins::ResponsePaging' => "#{core_plugins}/response_paging.rb",
-        'Aws::Plugins::StubResponses' => "#{core_plugins}/stub_responses.rb",
-        'Aws::Plugins::IdempotencyToken' => "#{core_plugins}/idempotency_token.rb",
-        'Aws::Plugins::InvocationId' => "#{core_plugins}/invocation_id.rb",
-        'Aws::Plugins::JsonvalueConverter' => "#{core_plugins}/jsonvalue_converter.rb",
-        'Aws::Plugins::ClientMetricsPlugin' => "#{core_plugins}/client_metrics_plugin.rb",
-        'Aws::Plugins::ClientMetricsSendPlugin' => "#{core_plugins}/client_metrics_send_plugin.rb",
-        'Aws::Plugins::TransferEncoding' => "#{core_plugins}/transfer_encoding.rb",
-        'Aws::Plugins::HttpChecksum' => "#{core_plugins}/http_checksum.rb",
-        'Aws::Plugins::ChecksumAlgorithm' => "#{core_plugins}/checksum_algorithm.rb",
-        'Aws::Plugins::RequestCompression' => "#{core_plugins}/request_compression.rb",
-        'Aws::Plugins::DefaultsMode' => "#{core_plugins}/defaults_mode.rb",
-        'Aws::Plugins::RecursionDetection' => "#{core_plugins}/recursion_detection.rb",
-        'Aws::Plugins::Telemetry' => "#{core_plugins}/telemetry.rb"
+        'Seahorse::Client::Plugins::ContentLength' => "#{seahorse_plugins_path}/content_length.rb",
+        'Aws::Plugins::CredentialsConfiguration' => "#{core_plugins_path}/credentials_configuration.rb",
+        'Aws::Plugins::Logging' => "#{core_plugins_path}/logging.rb",
+        'Aws::Plugins::ParamConverter' => "#{core_plugins_path}/param_converter.rb",
+        'Aws::Plugins::ParamValidator' => "#{core_plugins_path}/param_validator.rb",
+        'Aws::Plugins::UserAgent' => "#{core_plugins_path}/user_agent.rb",
+        'Aws::Plugins::HelpfulSocketErrors' => "#{core_plugins_path}/helpful_socket_errors.rb",
+        'Aws::Plugins::RetryErrors' => "#{core_plugins_path}/retry_errors.rb",
+        'Aws::Plugins::GlobalConfiguration' => "#{core_plugins_path}/global_configuration.rb",
+        'Aws::Plugins::RegionalEndpoint' => "#{core_plugins_path}/regional_endpoint.rb",
+        'Aws::Plugins::EndpointDiscovery' => "#{core_plugins_path}/endpoint_discovery.rb",
+        'Aws::Plugins::EndpointPattern' => "#{core_plugins_path}/endpoint_pattern.rb",
+        'Aws::Plugins::ResponsePaging' => "#{core_plugins_path}/response_paging.rb",
+        'Aws::Plugins::StubResponses' => "#{core_plugins_path}/stub_responses.rb",
+        'Aws::Plugins::IdempotencyToken' => "#{core_plugins_path}/idempotency_token.rb",
+        'Aws::Plugins::InvocationId' => "#{core_plugins_path}/invocation_id.rb",
+        'Aws::Plugins::JsonvalueConverter' => "#{core_plugins_path}/jsonvalue_converter.rb",
+        'Aws::Plugins::ClientMetricsPlugin' => "#{core_plugins_path}/client_metrics_plugin.rb",
+        'Aws::Plugins::ClientMetricsSendPlugin' => "#{core_plugins_path}/client_metrics_send_plugin.rb",
+        'Aws::Plugins::TransferEncoding' => "#{core_plugins_path}/transfer_encoding.rb",
+        'Aws::Plugins::HttpChecksum' => "#{core_plugins_path}/http_checksum.rb",
+        'Aws::Plugins::ChecksumAlgorithm' => "#{core_plugins_path}/checksum_algorithm.rb",
+        'Aws::Plugins::RequestCompression' => "#{core_plugins_path}/request_compression.rb",
+        'Aws::Plugins::DefaultsMode' => "#{core_plugins_path}/defaults_mode.rb",
+        'Aws::Plugins::RecursionDetection' => "#{core_plugins_path}/recursion_detection.rb",
+        'Aws::Plugins::Telemetry' => "#{core_plugins_path}/telemetry.rb"
       }
     end
 
@@ -82,18 +116,18 @@ def default_async_plugins
 
     def protocol_plugins(protocol)
       {
-        'json'      => { 'Aws::Plugins::Protocols::JsonRpc' => "#{core_plugins}/protocols/json_rpc.rb" },
-        'rest-json' => { 'Aws::Plugins::Protocols::RestJson' => "#{core_plugins}/protocols/rest_json.rb" },
-        'rest-xml'  => { 'Aws::Plugins::Protocols::RestXml' => "#{core_plugins}/protocols/rest_xml.rb" },
-        'query'     => { 'Aws::Plugins::Protocols::Query' => "#{core_plugins}/protocols/query.rb" },
-        'ec2'       => { 'Aws::Plugins::Protocols::EC2' => "#{core_plugins}/protocols/ec2.rb" },
-        'smithy-rpc-v2-cbor' => { 'Aws::Plugins::Protocols::RpcV2' => "#{core_plugins}/protocols/rpc_v2.rb" },
+        'json'      => { 'Aws::Plugins::Protocols::JsonRpc' => "#{core_plugins_path}/protocols/json_rpc.rb" },
+        'rest-json' => { 'Aws::Plugins::Protocols::RestJson' => "#{core_plugins_path}/protocols/rest_json.rb" },
+        'rest-xml'  => { 'Aws::Plugins::Protocols::RestXml' => "#{core_plugins_path}/protocols/rest_xml.rb" },
+        'query'     => { 'Aws::Plugins::Protocols::Query' => "#{core_plugins_path}/protocols/query.rb" },
+        'ec2'       => { 'Aws::Plugins::Protocols::EC2' => "#{core_plugins_path}/protocols/ec2.rb" },
+        'smithy-rpc-v2-cbor' => { 'Aws::Plugins::Protocols::RpcV2' => "#{core_plugins_path}/protocols/rpc_v2.rb" },
         'api-gateway' => {
-          'Aws::Plugins::Protocols::ApiGateway' => "#{core_plugins}/protocols/api_gateway.rb",
-          'Aws::Plugins::ApiKey' => "#{core_plugins}/api_key.rb",
-          'Aws::Plugins::APIGUserAgent' => "#{core_plugins}/apig_user_agent.rb",
-          'Aws::Plugins::APIGAuthorizerToken' => "#{core_plugins}/apig_authorizer_token.rb",
-          'Aws::Plugins::APIGCredentialsConfiguration' => "#{core_plugins}/apig_credentials_configuration.rb"
+          'Aws::Plugins::Protocols::ApiGateway' => "#{core_plugins_path}/protocols/api_gateway.rb",
+          'Aws::Plugins::ApiKey' => "#{core_plugins_path}/api_key.rb",
+          'Aws::Plugins::APIGUserAgent' => "#{core_plugins_path}/apig_user_agent.rb",
+          'Aws::Plugins::APIGAuthorizerToken' => "#{core_plugins_path}/apig_authorizer_token.rb",
+          'Aws::Plugins::APIGCredentialsConfiguration' => "#{core_plugins_path}/apig_credentials_configuration.rb"
         },
         nil         => {}
       }[protocol]
@@ -107,7 +141,7 @@ def protocol_plugins(protocol)
     def signature_plugins(options)
       if !options[:legacy_endpoints]
         {
-          'Aws::Plugins::Sign' => "#{core_plugins}/sign.rb"
+          'Aws::Plugins::Sign' => "#{core_plugins_path}/sign.rb"
         }
       else
         auth_types  = [options.fetch(:signature_version)]
@@ -116,36 +150,27 @@ def signature_plugins(options)
         auth_types.each do |auth_type|
           case auth_type
           when 'v4'
-            plugins['Aws::Plugins::SignatureV4'] = "#{core_plugins}/signature_v4.rb"
+            plugins['Aws::Plugins::SignatureV4'] = "#{core_plugins_path}/signature_v4.rb"
           when 'v2'
-            plugins['Aws::Plugins::SignatureV2'] = "#{core_plugins}/signature_v2.rb"
+            plugins['Aws::Plugins::SignatureV2'] = "#{core_plugins_path}/signature_v2.rb"
           when 'bearer'
-            plugins['Aws::Plugins::BearerAuthorization'] = "#{core_plugins}/bearer_authorization.rb"
+            plugins['Aws::Plugins::BearerAuthorization'] = "#{core_plugins_path}/bearer_authorization.rb"
           end
         end
         plugins
       end
     end
 
-    def core_plugins
+    def core_plugins_path
       File.join(@aws_sdk_core_lib_path, 'aws-sdk-core/plugins')
     end
 
-    def seahorse_plugins
+    def seahorse_plugins_path
       File.join(@aws_sdk_core_lib_path, 'seahorse/client/plugins')
     end
 
-    def core_lib
-      # TODO : may need to register the default plugins directory rather
-      #        than have the hard-coded here as a relative path
-      File.expand_path('../../../../../gems/aws-sdk-core/lib', __FILE__)
-    end
-
     def const_get(class_name)
-      const_names = class_name.split('::')
-      const_names.inject(Kernel) do |const, const_name|
-        const.const_get(const_name)
-      end
+      Object.const_get(class_name)
     end
 
     class Plugin
diff --git a/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/views/async_client_class.rb b/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/views/async_client_class.rb
@@ -24,14 +24,14 @@ def initialize(options)
         @gem_version = options.fetch(:gem_version)
         @plugins = PluginList.new(options)
         @codegenerated_plugins = options.fetch(:codegenerated_plugins, [])
-        @default_plugins = Seahorse::Client::AsyncBase.plugins.map do |plugin|
-          PluginList::Plugin.new(class_name: plugin.name, options: plugin.options, path: '')
-        end
+        @client_plugins = @plugins.client_plugins
         @client_constructor = ClientConstructor.new(
           options.merge(
             plugins: @plugins,
             codegenerated_plugins: @codegenerated_plugins,
-            default_plugins: @default_plugins))
+            client_plugins: @client_plugins
+          )
+        )
         @operations = ClientOperationList.new(options).to_a
       end
 
diff --git a/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/views/client_class.rb b/build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/views/client_class.rb
@@ -27,14 +27,14 @@ def initialize(options)
         @gem_version = options.fetch(:gem_version)
         @plugins = PluginList.new(options)
         @codegenerated_plugins = options.fetch(:codegenerated_plugins, [])
-        @default_plugins = Seahorse::Client::Base.plugins.map do |plugin|
-          PluginList::Plugin.new(class_name: plugin.name, options: plugin.options, path: '')
-        end
+        @client_plugins = @plugins.client_plugins
         @client_constructor = ClientConstructor.new(
           options.merge(
             plugins: @plugins,
             codegenerated_plugins: @codegenerated_plugins,
-            default_plugins: @default_plugins))
+            client_plugins: @client_plugins
+          )
+        )
         @operations = ClientOperationList.new(options).to_a
         @waiters = Waiter.build_list(options[:waiters])
         @custom = options.fetch(:custom)
@@ -96,7 +96,6 @@ def waiters_markdown_table
       def authorizer?
         @custom
       end
-
     end
   end
 end
diff --git a/build_tools/services.rb b/build_tools/services.rb
@@ -4,7 +4,6 @@
 
 module BuildTools
   class ServiceEnumerator
-
     include Enumerable
 
     MANIFEST_PATH = File.expand_path('../../services.json', __FILE__)
@@ -42,6 +41,10 @@ def each(&block)
       services.values.each(&block)
     end
 
+    def reset
+      @services = nil
+    end
+
     private
 
     def services
@@ -186,5 +189,4 @@ def eventstream?(api)
   end
 
   Services = ServiceEnumerator.new
-
 end
