aws-sdk-core 2.4.0 → 3.53.0

data/lib/aws-sdk-core/ecs_credentials.rb

@@ -60,7 +60,7 @@ module Aws
       super
     end
 
-    # @return [Integer] The number of times to retry failed atttempts to
+    # @return [Integer] The number of times to retry failed attempts to
     #   fetch credentials from the instance metadata service. Defaults to 0.
     attr_reader :retries
 
@@ -85,7 +85,7 @@ module Aws
           c['SecretAccessKey'],
           c['Token']
         )
-        @expiration = c['Expiration'] ? Time.parse(c['Expiration']) : nil
+        @expiration = c['Expiration'] ? Time.iso8601(c['Expiration']) : nil
       end
     end
 
@@ -126,7 +126,7 @@ module Aws
       retries = 0
       begin
         yield
-      rescue *error_classes => error
+      rescue *error_classes => _error
         if retries < max_retries
           @backoff.call(retries)
           retries += 1

data/lib/aws-sdk-core/endpoint_cache.rb

@@ -0,0 +1,188 @@
+module Aws
+  # @api private
+  # a LRU cache caching endpoints data
+  class EndpointCache
+
+    # default cache entries limit
+    MAX_ENTRIES = 1000
+
+    # default max threads pool size
+    MAX_THREADS = 10
+
+    def initialize(options = {})
+      @max_entries = options[:max_entries] || MAX_ENTRIES
+      @entries = {} # store endpoints
+      @max_threads = options[:max_threads] || MAX_THREADS
+      @pool = {} # store polling threads
+      @mutex = Mutex.new
+      @require_identifier = nil # whether endpoint operation support identifier
+    end
+
+    # @return [Integer] Max size limit of cache
+    attr_reader :max_entries
+
+    # @return [Integer] Max count of polling threads
+    attr_reader :max_threads
+
+    # return [Hash] Polling threads pool
+    attr_reader :pool
+
+    # @param [String] key
+    # @return [Endpoint]
+    def [](key)
+      @mutex.synchronize do
+        # fetching an existing endpoint delete it and then append it
+        endpoint = @entries[key]
+        if endpoint
+          @entries.delete(key)
+          @entries[key] = endpoint
+        end
+        endpoint
+      end
+    end
+
+    # @param [String] key
+    # @param [Hash] value
+    def []=(key, value)
+      @mutex.synchronize do
+        # delete the least recent used endpoint when cache is full
+        unless @entries.size < @max_entries
+          old_key, _ = @entries.shift
+          self.delete_polling_thread(old_key)
+        end
+        # delete old value if exists
+        @entries.delete(key)
+        @entries[key] = Endpoint.new(value.to_hash)
+      end
+    end
+
+    # checking whether an unexpired endpoint key exists in cache
+    # @param [String] key
+    # @return [Boolean]
+    def key?(key)
+      if @entries.key?(key) && (@entries[key].nil? || @entries[key].expired?)
+        self.delete(key)
+      end
+      @entries.key?(key)
+    end
+
+    # checking whether an polling thread exist for the key
+    # @param [String] key
+    # @return [Boolean]
+    def threads_key?(key)
+      @pool.key?(key)
+    end
+
+    # remove entry only
+    # @param [String] key
+    def delete(key)
+      @mutex.synchronize do
+        @entries.delete(key)
+      end
+    end
+
+    # kill the old polling thread and remove it from pool
+    # @param [String] key
+    def delete_polling_thread(key)
+      Thread.kill(@pool[key]) if self.threads_key?(key)
+      @pool.delete(key)
+    end
+
+    # update cache with requests (using service endpoint operation)
+    # to fetch endpoint list (with identifiers when available)
+    # @param [String] key
+    # @param [RequestContext] ctx
+    def update(key, ctx)
+      resp = _request_endpoint(ctx)
+      if resp && resp.endpoints
+        resp.endpoints.each { |e| self[key] = e }
+      end
+    end
+
+    # extract the key to be used in the cache from request context
+    # @param [RequestContext] ctx
+    # @return [String]
+    def extract_key(ctx)
+      parts = []
+      # fetching from cred provider directly gives warnings
+      parts << ctx.config.credentials.credentials.access_key_id
+      if _endpoint_operation_identifier(ctx)
+        parts << ctx.operation_name
+        ctx.operation.input.shape.members.inject(parts) do |p, (name, ref)|
+          p << ctx.params[name] if ref["endpointdiscoveryid"]
+          p
+        end
+      end
+      parts.join('_')
+    end
+
+    # update polling threads pool
+    # param [String] key
+    # param [Thread] thread
+    def update_polling_pool(key, thread)
+      unless @pool.size < @max_threads
+        _, thread = @pool.shift
+        Thread.kill(thread)
+      end
+      @pool[key] = thread
+    end
+
+    # kill all polling threads
+    def stop_polling!
+      @pool.each { |_, t| Thread.kill(t) }
+      @pool = {}
+    end
+
+    private
+
+    def _request_endpoint(ctx)
+      params = {}
+      if _endpoint_operation_identifier(ctx)
+        # build identifier params when available
+        params[:operation] = ctx.operation.name
+        ctx.operation.input.shape.members.inject(params) do |p, (name, ref)|
+          if ref["endpointdiscoveryid"]
+            p[:identifiers] ||= {}
+            p[:identifiers][ref.location_name] = ctx.params[name]
+          end
+          p
+        end
+      end
+
+      begin
+        endpoint_operation_name = ctx.config.api.endpoint_operation
+        ctx.client.send(endpoint_operation_name, params)
+      rescue Aws::Errors::ServiceError
+        nil 
+      end
+    end
+
+    def _endpoint_operation_identifier(ctx)
+      return @require_identifier unless @require_identifier.nil?
+      operation_name = ctx.config.api.endpoint_operation
+      operation = ctx.config.api.operation(operation_name)
+      @require_identifier = operation.input.shape.members.any?
+    end
+
+    class Endpoint
+    
+      # default endpoint cache time, 1 minute
+      CACHE_PERIOD = 1
+
+      def initialize(options)
+        @address = options.fetch(:address)
+        @cache_period = options[:cache_period_in_minutes] || CACHE_PERIOD
+        @created_time = Time.now
+      end
+
+      # [String] valid URI address (with path) 
+      attr_reader :address
+
+      def expired?
+        Time.now - @created_time > @cache_period * 60
+      end
+
+    end
+
+  end
+end

data/lib/aws-sdk-core/errors.rb

@@ -1,10 +1,10 @@
 require 'thread'
 
 module Aws
-
-  # Each Service module has its own Errors module, e.g. {S3::Errors}.
   module Errors
 
+    class NonSupportedRubyVersionError < RuntimeError; end
+
     # The base class for all errors returned by an Amazon Web Service.
     # All ~400 level client errors and ~500 level server errors are raised
     # as service errors.  This indicates it was an error returned from the
@@ -13,9 +13,12 @@ module Aws
 
       # @param [Seahorse::Client::RequestContext] context
       # @param [String] message
-      def initialize(context, message)
+      # @param [Aws::Structure] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
         @code = self.class.code
+        @message = message if message && !message.empty?
         @context = context
+        @data = data
         super(message)
       end
 
@@ -26,6 +29,9 @@ module Aws
       #   that triggered the remote service to return this error.
       attr_reader :context
 
+      # @return [Aws::Structure]
+      attr_reader :data
+
       class << self
 
         # @return [String]
@@ -34,24 +40,178 @@ module Aws
       end
     end
 
+    # Raised when a `streaming` operation has `requiresLength` trait
+    # enabled but request payload size/length cannot be calculated
+    class MissingContentLength < RuntimeError
+      def initialize(*args)
+        msg = 'Required `Content-Length` value missing for the request.'
+        super(msg)
+      end
+    end
+
+    # Rasied when endpoint discovery failed for operations
+    # that requires endpoints from endpoint discovery
+    class EndpointDiscoveryError < RuntimeError
+      def initialize(*args)
+        msg = 'Endpoint discovery failed for the operation or discovered endpoint is not working, '\
+          'request will keep failing until endpoint discovery succeeds or :endpoint option is provided.'
+        super(msg)
+      end
+    end
+
+    # raised when hostLabel member is not provided
+    # at operation input when endpoint trait is available
+    # with 'hostPrefix' requirement
+    class MissingEndpointHostLabelValue < RuntimeError
+
+      def initialize(name)
+        msg = "Missing required parameter #{name} to construct"\
+          " endpoint host prefix. You can disable host prefix by"\
+          " setting :disable_host_prefix_injection to `true`."
+        super(msg)
+      end
+
+    end
+
+    # Raised when attempting to #signal an event before
+    # making an async request
+    class SignalEventError < RuntimeError; end
+
+    # Raised when EventStream Parser failed to parse
+    # a raw event message
+    class EventStreamParserError < RuntimeError; end
+
+    # Raise when EventStream Builder failed to build
+    # an event message with parameters provided
+    class EventStreamBuilderError < RuntimeError; end
+
+    # Error event in an event stream which has event_type :error
+    # error code and error message can be retrieved when available.
+    #
+    # example usage:
+    #
+    #   client.stream_foo(name: 'bar') do |event|
+    #     stream.on_error_event do |event|
+    #       puts "Error #{event.error_code}: #{event.error_message}"
+    #       raise event
+    #     end
+    #   end
+    #
+    class EventError < RuntimeError
+
+      def initialize(event_type, code, message)
+        @event_type = event_type
+        @error_code = code
+        @error_message = message
+      end
+
+      # @return [Symbol]
+      attr_reader :event_type
+
+      # @return [String]
+      attr_reader :error_code
+
+      # @return [String]
+      attr_reader :error_message
+
+    end
+
     # Various plugins perform client-side checksums of responses.
     # This error indicates a checksum failed.
     class ChecksumError < RuntimeError; end
 
-    # Raised when a {Service} is constructed and the specified shared
+    # Raised when a client is constructed and the specified shared
     # credentials profile does not exist.
     class NoSuchProfileError < RuntimeError; end
 
-    # Raised when a {Service} is constructed, where Assume Role credentials are
+    # Raised when a client is constructed, where Assume Role credentials are
     # expected, and there is no source profile specified.
     class NoSourceProfileError < RuntimeError; end
 
-    # Raised when a {Service} is constructed and credentials are not
+    # Raised when a client is constructed with Assume Role credentials using
+    # a credential_source, and that source type is unsupported.
+    class InvalidCredentialSourceError < RuntimeError; end
+
+    # Raised when a client is constructed with Assume Role credentials, but
+    # the profile has both source_profile and credential_source.
+    class CredentialSourceConflictError < RuntimeError; end
+
+    # Raised when a client is constructed with Assume Role credentials using
+    # a credential_source, and that source doesn't provide credentials.
+    class NoSourceCredentialsError < RuntimeError; end
+
+    # Raised when a client is constructed and credentials are not
     # set, or the set credentials are empty.
-    class MissingCredentialsError < RuntimeError; end
+    class MissingCredentialsError < RuntimeError
+      def initialize(*args)
+        msg = 'unable to sign request without credentials set'
+        super(msg)
+      end
+    end
+
+    # Raised when a credentials provider process returns a JSON
+    # payload with either invalid version number or malformed contents
+    class InvalidProcessCredentialsPayload < RuntimeError; end
+
+    # Raised when a client is constructed and region is not specified.
+    class MissingRegionError < ArgumentError
+      def initialize(*args)
+        msg = "missing region; use :region option or "
+        msg << "export region name to ENV['AWS_REGION']"
+        super(msg)
+      end
+    end
+
+    # Raised when attempting to connect to an endpoint and a `SocketError`
+    # is received from the HTTP client. This error is typically the result
+    # of configuring an invalid `:region`.
+    class NoSuchEndpointError < RuntimeError
+
+      def initialize(options = {})
+        @context = options[:context]
+        @endpoint = @context.http_request.endpoint
+        @original_error = options[:original_error]
+        super(<<-MSG)
+Encountered a `SocketError` while attempting to connect to:
+
+  #{endpoint.to_s}
+
+This is typically the result of an invalid `:region` option or a
+poorly formatted `:endpoint` option.
+
+* Avoid configuring the `:endpoint` option directly. Endpoints are constructed
+  from the `:region`. The `:endpoint` option is reserved for connecting to
+  non-standard test endpoints.
+
+* Not every service is available in every region.
 
-    # Raised when a {Service} is constructed and region is not specified.
-    class MissingRegionError < ArgumentError; end
+* Never suffix region names with availability zones.
+  Use "us-east-1", not "us-east-1a"
+
+Known AWS regions include (not specific to this service):
+
+#{possible_regions}
+        MSG
+      end
+
+      attr_reader :context
+
+      attr_reader :endpoint
+
+      attr_reader :original_error
+
+      private
+
+      def possible_regions
+        Aws.partitions.inject([]) do |region_names, partition|
+          partition.regions.each do |region|
+            region_names << region.name
+          end
+          region_names
+        end.join("\n")
+      end
+
+    end
 
     # This module is mixed into another module, providing dynamic
     # error classes.  Error classes all inherit from {ServiceError}.
@@ -86,7 +246,11 @@ module Aws
       def error_class(error_code)
         constant = error_class_constant(error_code)
         if error_const_set?(constant)
-          const_get(constant)
+          # modeled error class exist
+          # set code attribute
+          err_class = const_get(constant)
+          err_class.code = constant.to_s
+          err_class
         else
           set_error_constant(constant)
         end

data/lib/aws-sdk-core/event_emitter.rb

@@ -0,0 +1,62 @@
+module Aws
+  class EventEmitter
+
+    def initialize
+      @listeners = {}
+      @validate_event = true
+      @status = :sleep
+      @signal_queue = Queue.new
+    end
+
+    attr_accessor :stream
+
+    attr_accessor :encoder
+
+    attr_accessor :validate_event
+
+    attr_accessor :signal_queue
+
+    def on(type, callback)
+      (@listeners[type] ||= []) << callback
+    end
+
+    def signal(type, event)
+      return unless @listeners[type]
+      @listeners[type].each do |listener|
+        listener.call(event) if event.event_type == type
+      end
+    end
+
+    def emit(type, params)
+      unless @stream
+        raise Aws::Errors::SignalEventError.new(
+          "Singaling events before making async request"\
+          " is not allowed."
+        )
+      end
+      if @validate_event && type != :end_stream
+        Aws::ParamValidator.validate!(
+          @encoder.rules.shape.member(type), params)
+      end
+      _ready_for_events?
+      @stream.data(
+        @encoder.encode(type, params),
+        end_stream: type == :end_stream
+      )
+    end
+
+    private
+
+    def _ready_for_events?
+      return true if @status == :ready
+
+      # blocked until once initial 200 response is received
+      # signal will be available in @signal_queue
+      # and this check will no longer be blocked
+      @signal_queue.pop
+      @status = :ready
+      true
+    end
+
+  end
+end