aws-sdk-rails 3.1.0 → 3.6.0

data/lib/aws/rails/sqs_active_job/executor.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+
+module Aws
+  module Rails
+    module SqsActiveJob
+      # CLI runner for polling for SQS ActiveJobs
+      class Executor
+
+        DEFAULTS = {
+           min_threads:     0,
+           max_threads:     Concurrent.processor_count,
+           auto_terminate:  true,
+           idletime:        60, # 1 minute
+           fallback_policy: :caller_runs # slow down the producer thread
+        }.freeze
+
+        def initialize(options = {})
+          @executor = Concurrent::ThreadPoolExecutor.new(DEFAULTS.merge(options))
+          @logger = options[:logger] || ActiveSupport::Logger.new(STDOUT)
+        end
+
+        # TODO: Consider catching the exception and sleeping instead of using :caller_runs
+        def execute(message)
+          @executor.post(message) do |message|
+            begin
+              job = JobRunner.new(message)
+              @logger.info("Running job: #{job.id}[#{job.class_name}]")
+              job.run
+              message.delete
+            rescue Aws::Json::ParseError => e
+              @logger.error "Unable to parse message body: #{message.data.body}. Error: #{e}."
+            rescue StandardError => e
+              # message will not be deleted and will be retried
+              job_msg = job ? "#{job.id}[#{job.class_name}]" : 'unknown job'
+              @logger.info "Error processing job #{job_msg}: #{e}"
+              @logger.debug e.backtrace.join("\n")
+            end
+          end
+        end
+
+        def shutdown(timeout=nil)
+          @executor.shutdown
+          clean_shutdown = @executor.wait_for_termination(timeout)
+          if clean_shutdown
+            @logger.info 'Clean shutdown complete.  All executing jobs finished.'
+          else
+            @logger.info "Timeout (#{timeout}) exceeded.  Some jobs may not have"\
+              " finished cleanly.  Unfinished jobs will not be removed from"\
+              " the queue and can be ru-run once their visibility timeout"\
+              " passes."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/rails/sqs_active_job/job_runner.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Aws
+  module Rails
+    module SqsActiveJob
+
+      class JobRunner
+        attr_reader :id, :class_name
+
+        def initialize(message)
+          @job_data = Aws::Json.load(message.data.body)
+          @class_name = @job_data['job_class'].constantize
+          @id = @job_data['job_id']
+        end
+
+        def run
+          ActiveJob::Base.execute @job_data
+        end
+      end
+    end
+  end
+end

data/lib/aws/rails/sqs_active_job/lambda_handler.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+
+module Aws
+  module Rails
+    module SqsActiveJob
+
+      # A lambda event handler to run jobs from an SQS queue trigger
+      # Trigger the lambda from your SQS queue
+      # Configure the entrypoint to: +config/environment.Aws::Rails::SqsActiveJob.lambda_job_handler+
+      # This will load your Rails environment, and then use this method as the handler.
+      def self.lambda_job_handler(event:, context:)
+        return 'no records to process' unless event['Records']
+
+        event['Records'].each do |record|
+          sqs_msg = to_sqs_msg(record)
+          job = Aws::Rails::SqsActiveJob::JobRunner.new(sqs_msg)
+          puts("Running job: #{job.id}[#{job.class_name}]")
+          job.run
+          sqs_msg.delete
+        end
+        "Processed #{event['Records'].length} jobs."
+      end
+
+      private
+
+      def self.to_sqs_msg(record)
+        msg = Aws::SQS::Types::Message.new(
+          body: record['body'],
+          md5_of_body: record['md5OfBody'],
+          message_attributes: self.to_message_attributes(record),
+          message_id: record['messageId'],
+          receipt_handle: record['receiptHandle']
+        )
+        Aws::SQS::Message.new(
+          queue_url: to_queue_url(record),
+          receipt_handle: msg.receipt_handle,
+          data: msg,
+          client: Aws::Rails::SqsActiveJob.config.client
+        )
+      end
+
+      def self.to_message_attributes(record)
+        record['messageAttributes'].each_with_object({}) do |(key, value), acc|
+          acc[key] = {
+            string_value: value['stringValue'],
+            binary_value: value['binaryValue'],
+            string_list_values: ['stringListValues'],
+            binary_list_values: value['binaryListValues'],
+            data_type: value['dataType']
+          }
+        end
+      end
+
+      def self.to_queue_url(record)
+        source_arn = record['eventSourceARN']
+        raise ArgumentError, "Invalid queue arn: #{source_arn}" unless Aws::ARNParser.arn?(source_arn)
+
+        arn = Aws::ARNParser.parse(source_arn)
+        sfx = Aws::Partitions::EndpointProvider.dns_suffix_for(arn.region)
+        "https://sqs.#{arn.region}.#{sfx}/#{arn.account_id}/#{arn.resource}"
+      end
+    end
+  end
+end

data/lib/aws/rails/sqs_active_job/poller.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+require 'optparse'
+require 'concurrent'
+
+module Aws
+  module Rails
+    module SqsActiveJob
+
+      class Interrupt < Exception; end
+
+      # CLI runner for polling for SQS ActiveJobs
+      # Use `aws_sqs_active_job --help` for detailed usage
+      class Poller
+
+        DEFAULT_OPTS = {
+          threads: 2*Concurrent.processor_count,
+          max_messages: 10,
+          visibility_timeout: 60,
+          shutdown_timeout: 15,
+          backpressure: 10
+        }
+
+        def initialize(args = ARGV)
+          @options = parse_args(args)
+          # Set_environment must be run before we boot_rails
+          set_environment
+        end
+
+        def set_environment
+          @environment = @options[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+        end
+
+        def run
+          # exit 0
+          boot_rails
+
+          # cannot load config (from file or initializers) until after
+          # rails has been booted.
+          @options = DEFAULT_OPTS
+                     .merge(Aws::Rails::SqsActiveJob.config.to_h)
+                     .merge(@options.to_h)
+          validate_config
+          # ensure we have a logger configured
+          @logger = @options[:logger] || ActiveSupport::Logger.new(STDOUT)
+          @logger.info("Starting Poller with options=#{@options}")
+
+
+          Signal.trap('INT') { raise Interrupt }
+          Signal.trap('TERM') { raise Interrupt }
+          @executor = Executor.new(max_threads: @options[:threads], logger: @logger, max_queue: @options[:backpressure])
+
+          poll
+        rescue Interrupt
+          @logger.info 'Process Interrupted or killed - attempting to shutdown cleanly.'
+          shutdown
+          exit
+        end
+
+        private
+
+        def shutdown
+          @executor.shutdown(@options[:shutdown_timeout])
+        end
+
+        def poll
+          queue_url = Aws::Rails::SqsActiveJob.config.queue_url_for(@options[:queue])
+          @logger.info "Polling on: #{@options[:queue]} => #{queue_url}"
+          client = Aws::Rails::SqsActiveJob.config.client
+          @poller = Aws::SQS::QueuePoller.new(queue_url, client: client)
+          poller_options = {
+            skip_delete: true,
+            max_number_of_messages: @options[:max_messages],
+            visibility_timeout: @options[:visibility_timeout]
+          }
+          # Limit max_number_of_messages for FIFO queues to 1
+          # this ensures jobs with the same message_group_id are processed
+          # in order
+          # Jobs with different message_group_id will be processed in
+          # parallel and may be out of order.
+          if Aws::Rails::SqsActiveJob.fifo?(queue_url)
+            poller_options[:max_number_of_messages] = 1
+          end
+
+          single_message = poller_options[:max_number_of_messages] == 1
+
+          @poller.poll(poller_options) do |msgs|
+            msgs = [msgs] if single_message
+            @logger.info "Processing batch of #{msgs.length} messages"
+            msgs.each do |msg|
+              @executor.execute(Aws::SQS::Message.new(
+                queue_url: queue_url,
+                receipt_handle: msg.receipt_handle,
+                data: msg,
+                client: client
+              ))
+            end
+          end
+        end
+
+        def boot_rails
+          ENV['RACK_ENV'] = ENV['RAILS_ENV'] = @environment
+          require "rails"
+          require File.expand_path("config/environment.rb")
+        end
+
+        def parse_args(argv)
+          out = {}
+          parser = ::OptionParser.new { |opts|
+            opts.on("-q", "--queue STRING", "[Required] Queue to poll") { |a| out[:queue] = a }
+            opts.on("-e", "--environment STRING", "Rails environment (defaults to development). You can also use the APP_ENV or RAILS_ENV environment variables to specify the environment.") { |a| out[:environment] = a }
+            opts.on("-t", "--threads INTEGER", Integer, "The maximum number of worker threads to create.  Defaults to 2x the number of processors available on this system.") { |a| out[:threads] = a }
+            opts.on("-b", "--backpressure INTEGER", Integer, "The maximum number of messages to have waiting in the Executor queue. This should be a low, but non zero number.  Messages in the Executor queue cannot be picked up by other processes and will slow down shutdown.") { |a| out[:backpressure] = a }
+            opts.on("-m", "--max_messages INTEGER", Integer, "Max number of messages to receive in a batch from SQS.") { |a| out[:max_messages] = a }
+            opts.on("-v", "--visibility_timeout INTEGER", Integer, "The visibility timeout is the number of seconds that a message will not be processable by any other consumers. You should set this value to be longer than your expected job runtime to prevent other processes from picking up an running job.  See the SQS Visibility Timeout Documentation at https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html.") { |a| out[:visibility_timeout] = a }
+            opts.on("-s", "--shutdown_timeout INTEGER", Integer, "The amount of time to wait for a clean shutdown.  Jobs that are unable to complete in this time will not be deleted from the SQS queue and will be retryable after the visibility timeout.") { |a| out[:shutdown_timeout] = a }
+          }
+
+          parser.banner = "aws_sqs_active_job [options]"
+          parser.on_tail "-h", "--help", "Show help" do
+            puts parser
+            exit 1
+          end
+
+          parser.parse(argv)
+          out
+        end
+
+        def validate_config
+          raise ArgumentError, 'You must specify the name of the queue to process jobs from' unless @options[:queue]
+        end
+      end
+    end
+  end
+end

data/lib/generators/aws_record/base.rb

@@ -0,0 +1,217 @@
+require 'rails/generators'
+require_relative 'generated_attribute'
+require_relative 'secondary_index'
+
+module AwsRecord
+    module Generators
+      class Base < Rails::Generators::NamedBase
+        argument :attributes, type: :array, default: [], banner: "field[:type][:opts]...", desc: "Describes the fields in the model"
+        check_class_collision
+
+        class_option :disable_mutation_tracking, type: :boolean, desc: "Disables dirty tracking"
+        class_option :timestamps, type: :boolean, desc: "Adds created, updated timestamps to the model"
+        class_option :table_config, type: :hash, default: {}, banner: "primary:R-W [SecondaryIndex1:R-W]...", desc: "Declares the r/w units for the model as well as any secondary indexes", :required => true
+        class_option :gsi, type: :array, default: [], banner: "name:hkey{field_name}[,rkey{field_name},proj_type{ALL|KEYS_ONLY|INCLUDE}]...", desc: "Allows for the declaration of secondary indexes"
+        class_option :table_name, type: :string, banner: "model_table_name"
+        class_option :password_digest, type: :boolean, desc: "Whether to add a password_digest field to the model"
+
+        class_option :required, type: :string, banner: "field1...", desc: "A list of attributes that are required for an instance of the model"
+        class_option :length_validations, type: :hash, default: {}, banner: "field1:MIN-MAX...", desc: "Validations on the length of attributes in a model"
+
+        attr_accessor :primary_read_units, :primary_write_units, :gsi_rw_units, :gsis, :required_attrs, :length_validations
+
+        private
+
+        def initialize(args, *options)
+          options[0] << "--skip-table-config" if options[1][:behavior] == :revoke
+          @parse_errors = []
+
+          super
+          ensure_unique_fields
+          ensure_hkey
+          parse_gsis!
+          parse_table_config!
+          parse_validations!
+
+          if !@parse_errors.empty?
+            STDERR.puts "The following errors were encountered while trying to parse the given attributes"
+            STDERR.puts
+            STDERR.puts @parse_errors
+            STDERR.puts
+
+            abort("Please fix the errors before proceeding.")
+          end
+        end
+
+        def parse_attributes!
+
+          self.attributes = (attributes || []).map do |attr|
+            begin
+              GeneratedAttribute.parse(attr)
+            rescue ArgumentError => e
+              @parse_errors << e
+              next
+            end
+          end
+          self.attributes = self.attributes.compact
+
+          if options['password_digest']
+            self.attributes << GeneratedAttribute.new("password_digest", :string_attr, :digest => true)
+          end
+
+          if options['timestamps']
+            self.attributes << GeneratedAttribute.parse("created:datetime:default_value{Time.now}")
+            self.attributes << GeneratedAttribute.parse("updated:datetime:default_value{Time.now}")
+          end
+        end
+
+        def ensure_unique_fields
+          used_names = Set.new
+          duplicate_fields = []
+
+          self.attributes.each do |attr|
+
+            if used_names.include? attr.name
+              duplicate_fields << [:attribute, attr.name]
+            end
+            used_names.add attr.name
+
+            if attr.options.key? :database_attribute_name
+              raw_db_attr_name = attr.options[:database_attribute_name].delete('"') # db attribute names are wrapped with " to make template generation easier
+
+              if used_names.include? raw_db_attr_name
+                duplicate_fields << [:database_attribute_name, raw_db_attr_name]
+              end
+
+              used_names.add raw_db_attr_name
+            end
+          end
+
+          if !duplicate_fields.empty?
+            duplicate_fields.each do |invalid_attr|
+              @parse_errors << ArgumentError.new("Found duplicated field name: #{invalid_attr[1]}, in attribute#{invalid_attr[0]}")
+            end
+          end
+        end
+
+        def ensure_hkey
+          uuid_member = nil
+          hkey_member = nil
+          rkey_member = nil
+
+          self.attributes.each do |attr|
+            if attr.options.key? :hash_key
+              if hkey_member
+                @parse_errors << ArgumentError.new("Redefinition of hash_key attr: #{attr.name}, original declaration of hash_key on: #{hkey_member.name}")
+                next
+              end
+
+              hkey_member = attr
+            elsif attr.options.key? :range_key
+              if rkey_member
+                @parse_errors << ArgumentError.new("Redefinition of range_key attr: #{attr.name}, original declaration of range_key on: #{hkey_member.name}")
+                next
+              end
+
+              rkey_member = attr
+            end
+
+            if attr.name.include? "uuid"
+              uuid_member = attr
+            end
+          end
+
+          if !hkey_member
+            if uuid_member
+              uuid_member.options[:hash_key] = true
+            else
+              self.attributes.unshift GeneratedAttribute.parse("uuid:hkey")
+            end
+          end
+        end
+
+        def mutation_tracking_disabled?
+          options['disable_mutation_tracking']
+        end
+
+        def has_validations?
+          !@required_attrs.empty? || !@length_validations.empty?
+        end
+
+        def parse_table_config!
+          return unless options['table_config']
+
+          @primary_read_units, @primary_write_units = parse_rw_units("primary")
+
+          @gsi_rw_units = @gsis.map { |idx|
+            [idx.name, parse_rw_units(idx.name)]
+          }.to_h
+
+          options['table_config'].each do |config, rw_units|
+            if config == "primary"
+              next
+            else
+              gsi = @gsis.select { |idx| idx.name == config}
+
+              if gsi.empty?
+                @parse_errors << ArgumentError.new("Could not find a gsi declaration for #{config}")
+              end
+            end
+          end
+        end
+
+        def parse_rw_units(name)
+          if !options['table_config'].key? name
+            @parse_errors << ArgumentError.new("Please provide a table_config definition for #{name}")
+          else
+            rw_units = options['table_config'][name]
+            return rw_units.gsub(/[,.-]/, ':').split(':').reject { |s| s.empty? }
+          end
+        end
+
+        def parse_gsis!
+          @gsis = (options['gsi'] || []).map do |raw_idx|
+            begin
+              idx = SecondaryIndex.parse(raw_idx)
+
+              attributes = self.attributes.select { |attr| attr.name == idx.hash_key}
+              if attributes.empty?
+                @parse_errors << ArgumentError.new("Could not find attribute #{idx.hash_key} for gsi #{idx.name} hkey")
+                next
+              end
+
+              if idx.range_key
+                attributes = self.attributes.select { |attr| attr.name == idx.range_key}
+                if attributes.empty?
+                  @parse_errors << ArgumentError.new("Could not find attribute #{idx.range_key} for gsi #{idx.name} rkey")
+                  next
+                end
+              end
+
+              idx
+            rescue ArgumentError => e
+              @parse_errors << e
+              next
+            end
+          end
+
+          @gsis = @gsis.compact
+        end
+
+        def parse_validations!
+          @required_attrs = options['required'] ? options['required'].split(',') : []
+          @required_attrs.each do |val_attr|
+            @parse_errors << ArgumentError.new("No such field #{val_attr} in required validations") if !self.attributes.any? { |attr| attr.name == val_attr }
+          end
+
+          @length_validations = options['length_validations'].map do |val_attr, bounds|
+            @parse_errors << ArgumentError.new("No such field #{val_attr} in required validations") if !self.attributes.any? { |attr| attr.name == val_attr }
+
+            bounds = bounds.gsub(/[,.-]/, ':').split(':').reject { |s| s.empty? }
+            [val_attr, "#{bounds[0]}..#{bounds[1]}"]
+          end
+          @length_validations = @length_validations.to_h
+        end
+      end
+    end
+  end