aws-sdk-rails 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e58942a12378042b0c5bdfe304b6b90f79dbc2d69c6dcdd00f0750a1faac0e2d
-  data.tar.gz: 0fbb662869d4f5bb6c4fe1c9481fcdb842b6cfe8f7099568e9770364bed046d1
+  metadata.gz: b7354b35727ee37128ccb8b13f94a4d0564518e02e1acaf87086a3664fbea719
+  data.tar.gz: 8c9aae1eb8fed5ee9c4dca9d74fadd95619a0d05c455c9164dca9310002199db
 SHA512:
-  metadata.gz: 187ff26d189951811d49dad748c7722baf91cf1160e62cdfbb219ebb7684cd61b814cc024d85cd7694f0dffac48c85fd5e4ac1c87ce811b2d4bb1aa2dfb102b4
-  data.tar.gz: 9c3c281bc54ee18b98bde43c0f2832c08a131715af13e0f747544e2d78791e1579a00bb23486d72c74c7ad44784604fd9cf63befc9788c3cfe60c5637cb75e97
+  metadata.gz: e3c645120b3787a041900edd7365dec40d766807bc6c11fe81cd6788909d3f180c549fbd0e9071acfeefcd8608cc2e7d3d99f8f53d4ebf611742a33683eeddf0
+  data.tar.gz: 49743ff5d71ed4dfe915e6aa80cb6d1f1fdb6ba18d783330faae0e320435af92bb32ed78a042b3cb3be486e4a5cdf3826c723d36272a89a599c7f00c85ec0eca

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+5.0.0 (2024-11-21)
+------------------
+
+* Feature - [Major Version] Remove dependencies on modular feature gems: `aws-actiondispatch-dynamodb`, `aws-actionmailer-ses`, `aws-actionmailbox-ses`, `aws-activejob-sqs`, and `aws-record-rails`.
+
+* Issue - Remove `Aws::Rails.add_action_mailer_delivery_method` in favor of `ActionMailer::Base.add_delivery_method` or the Railtie and configuration in `aws-actionmailer-ses ~> 1`.
+
+* Issue - Remove require of `aws/rails/action_mailbox/rspec` in favor of `aws/action_mailbox/ses/rspec`.
+
+* Issue - Remove symlinked namespaces from previous major versions.
+
+* Feature - `ActiveSupport::Notifications` are enabled by default and removes `Aws::Rails.instrument_sdk_operations`.
+
+* Feature - Moved railtie initializations to their appropriate spots.
+
+* Issue - Do not execute `ActiveJob` from EB cron without the root path.
+
 4.2.0 (2024-11-20)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-4.2.0
+5.0.0

data/lib/aws/rails/middleware/elastic_beanstalk_sqsd.rb

@@ -31,37 +31,42 @@ module Aws
         private
 
         def execute_job(request)
-          # Jobs queued from the Active Job SQS adapter contain the JSON message in the request body.
-          job = Aws::Json.load(request.body.string)
+          # Jobs queued from the SQS adapter contain the JSON message in the request body.
+          job = ::ActiveSupport::JSON.decode(request.body.string)
           job_name = job['job_class']
           @logger.debug("Executing job: #{job_name}")
-
-          begin
-            ::ActiveJob::Base.execute(job)
-          rescue NameError => e
-            @logger.error("Job #{job_name} could not resolve to a class that inherits from Active Job.")
-            @logger.error("Error: #{e}")
-            return internal_error_response
-          end
-
+          _execute_job(job, job_name)
           [200, { 'Content-Type' => 'text/plain' }, ["Successfully ran job #{job_name}."]]
+        rescue NameError
+          internal_error_response
+        end
+
+        def _execute_job(job, job_name)
+          ::ActiveJob::Base.execute(job)
+        rescue NameError => e
+          @logger.error("Job #{job_name} could not resolve to a class that inherits from Active Job.")
+          @logger.error("Error: #{e}")
+          raise e
         end
 
         def execute_periodic_task(request)
           # The beanstalk worker SQS Daemon will add the 'X-Aws-Sqsd-Taskname' for periodic tasks set in cron.yaml.
           job_name = request.headers['X-Aws-Sqsd-Taskname']
           @logger.debug("Creating and executing periodic task: #{job_name}")
-
-          begin
-            job = job_name.constantize.new
-            job.perform_now
-          rescue NameError => e
-            @logger.error("Periodic task #{job_name} could not resolve to an Active Job class - check the spelling in cron.yaml.")
-            @logger.error("Error: #{e}.")
-            return internal_error_response
-          end
-
+          _execute_periodic_task(job_name)
           [200, { 'Content-Type' => 'text/plain' }, ["Successfully ran periodic task #{job_name}."]]
+        rescue NameError
+          internal_error_response
+        end
+
+        def _execute_periodic_task(job_name)
+          job = job_name.constantize.new
+          job.perform_now
+        rescue NameError => e
+          @logger.error("Periodic task #{job_name} could not resolve to an Active Job class " \
+                        '- check the cron name spelling and set the path as / in cron.yaml.')
+          @logger.error("Error: #{e}.")
+          raise e
         end
 
         def internal_error_response
@@ -84,7 +89,7 @@ module Aws
         # The beanstalk worker SQS Daemon will add the custom 'X-Aws-Sqsd-Taskname' header
         # for periodic tasks set in cron.yaml.
         def periodic_task?(request)
-          !request.headers['X-Aws-Sqsd-Taskname'].nil? && request.headers['X-Aws-Sqsd-Taskname'].present?
+          request.headers['X-Aws-Sqsd-Taskname'].present? && request.fullpath == '/'
         end
 
         def sent_from_docker_host?(request)
@@ -112,6 +117,7 @@ module Aws
           @default_docker_ips ||= build_default_docker_ips
         end
 
+        # rubocop:disable Metrics/AbcSize
         def build_default_docker_ips
           default_gw_ips = ['172.17.0.1']
 
@@ -128,6 +134,7 @@ module Aws
 
           default_gw_ips
         end
+        # rubocop:enable Metrics/AbcSize
       end
     end
   end

data/lib/aws/rails/notifications.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'aws-sdk-core'
 require 'active_support/notifications'
 
+require 'aws-sdk-core'
+
 module Aws
   module Rails
     # @api private

data/lib/aws/rails/railtie.rb

@@ -3,34 +3,24 @@
 module Aws
   # Use the Rails namespace.
   module Rails
+    # See https://guides.rubyonrails.org/configuring.html#initializers
     # @api private
     class Railtie < ::Rails::Railtie
-      initializer 'aws-sdk-rails.initialize',
-                  before: :load_config_initializers do
-        # Initialization Actions
-        Aws::Rails.log_to_rails_logger
-        Aws::Rails.use_rails_encrypted_credentials
-        Aws::Rails.add_action_mailer_delivery_method
-        Aws::Rails.add_action_mailer_delivery_method(:sesv2)
-
-        if %i[ses sesv2].include?(::Rails.application.config.action_mailer.delivery_method)
-          ::Rails.logger.warn(<<~MSG)
-            ** Aws::Rails.add_action_mailer_delivery_method will be removed in aws-sdk-rails ~> 5.
-            In `aws-actionmailer-ses ~> 1`, configuration will be set using config settings:
-
-              config.action_mailer.delivery_method = :ses_v2
-              config.action_mailer.ses_v2_settings = { region: 'us-west-2' }
-
-            Existing Mailer classes have moved namespaces but will continue to work in this major version. **
-          MSG
-        end
+      # Set the logger for the AWS SDK to Rails.logger.
+      initializer 'aws-sdk-rails.log-to-rails-logger', after: :initialize_logger do
+        Aws.config[:logger] = ::Rails.logger
       end
 
-      initializer 'aws-sdk-rails.insert_middleware' do |app|
-        Aws::Rails.add_sqsd_middleware(app)
+      # Configures the AWS SDK with credentials from Rails encrypted credentials.
+      initializer 'aws-sdk-rails.use-rails-encrypted-credentials', after: :load_environment_config do
+        # limit the config keys we merge to credentials only
+        aws_credential_keys = %i[access_key_id secret_access_key session_token account_id]
+        creds = ::Rails.application.credentials[:aws].to_h.slice(*aws_credential_keys)
+        Aws.config.merge!(creds)
       end
 
-      initializer 'aws-sdk-rails.eager_load' do
+      # Eager load the AWS SDK Clients.
+      initializer 'aws-sdk-rails.eager-load-sdk', before: :eager_load! do
         Aws.define_singleton_method(:eager_load!) do
           Aws.constants.each do |c|
             m = Aws.const_get(c)
@@ -46,65 +36,37 @@ module Aws
           config.eager_load_namespaces << Aws
         end
       end
-    end
-
-    # Configures the AWS SDK for Ruby's logger to use the Rails logger.
-    def self.log_to_rails_logger
-      Aws.config[:logger] = ::Rails.logger
-      nil
-    end
 
-    # Configures the AWS SDK with credentials from Rails encrypted credentials.
-    def self.use_rails_encrypted_credentials
-      # limit the config keys we merge to credentials only
-      aws_credential_keys = %i[access_key_id secret_access_key session_token account_id]
-      creds = ::Rails.application.credentials[:aws].to_h.slice(*aws_credential_keys)
-      Aws.config.merge!(creds)
-    end
-
-    # This is called automatically from the SDK's Railtie, but can be manually
-    # called if you want to specify options for building the Aws::SES::Client or
-    # Aws::SESV2::Client.
-    #
-    # @param [Symbol] name The name of the ActionMailer delivery method to
-    #   register, either :ses or :sesv2.
-    # @param [Hash] client_options The options you wish to pass on to the
-    #   Aws::SES[V2]::Client initialization method.
-    def self.add_action_mailer_delivery_method(name = :ses, client_options = {})
-      # TODO: remove this method in aws-sdk-rails ~> 5
-      ActiveSupport.on_load(:action_mailer) do
-        if name == :sesv2
-          add_delivery_method(name, Aws::Rails::Sesv2Mailer, client_options)
-        else
-          add_delivery_method(name, Aws::Rails::SesMailer, client_options)
+      # Add ActiveSupport Notifications instrumentation to AWS SDK client operations.
+      # Each operation will produce an event with a name `<operation>.<service>.aws`.
+      # For example, S3's put_object has an event name of: put_object.S3.aws
+      initializer 'aws-sdk-rails.instrument-sdk-operations', after: :load_active_support do
+        Aws.constants.each do |c|
+          m = Aws.const_get(c)
+          if m.is_a?(Module) && m.const_defined?(:Client) &&
+             (client = m.const_get(:Client)) && client.superclass == Seahorse::Client::Base
+            m.const_get(:Client).add_plugin(Aws::Rails::Notifications)
+          end
         end
       end
-    end
 
-    # Add ActiveSupport Notifications instrumentation to AWS SDK client operations.
-    # Each operation will produce an event with a name `<operation>.<service>.aws`.
-    # For example, S3's put_object has an event name of: put_object.S3.aws
-    def self.instrument_sdk_operations
-      Aws.constants.each do |c|
-        m = Aws.const_get(c)
-        if m.is_a?(Module) && m.const_defined?(:Client) &&
-           (client = m.const_get(:Client)) && client.superclass == Seahorse::Client::Base
-          m.const_get(:Client).add_plugin(Aws::Rails::Notifications)
-        end
+      # Register a middleware that will handle requests from the Elastic Beanstalk worker SQS Daemon.
+      initializer 'aws-sdk-rails.add-sqsd-middleware', before: :build_middleware_stack do |app|
+        Aws::Rails.add_sqsd_middleware(app)
       end
     end
 
-    # Register a middleware that will handle requests from the Elastic Beanstalk worker SQS Daemon.
-    # This will only be added in the presence of the AWS_PROCESS_BEANSTALK_WORKER_REQUESTS environment variable.
-    # The expectation is this variable should only be set on EB worker environments.
-    def self.add_sqsd_middleware(app)
-      return unless ENV['AWS_PROCESS_BEANSTALK_WORKER_REQUESTS']
+    class << self
+      # @api private
+      def add_sqsd_middleware(app)
+        return unless ENV['AWS_PROCESS_BEANSTALK_WORKER_REQUESTS']
 
-      if app.config.force_ssl
-        # SQS Daemon sends requests over HTTP - allow and process them before enforcing SSL.
-        app.config.middleware.insert_before(::ActionDispatch::SSL, Aws::Rails::Middleware::ElasticBeanstalkSQSD)
-      else
-        app.config.middleware.use(Aws::Rails::Middleware::ElasticBeanstalkSQSD)
+        if app.config.force_ssl
+          # SQS Daemon sends requests over HTTP - allow and process them before enforcing SSL.
+          app.config.middleware.insert_before(::ActionDispatch::SSL, Aws::Rails::Middleware::ElasticBeanstalkSQSD)
+        else
+          app.config.middleware.use(Aws::Rails::Middleware::ElasticBeanstalkSQSD)
+        end
       end
     end
   end

data/lib/aws-sdk-rails.rb

@@ -4,24 +4,8 @@ require_relative 'aws/rails/middleware/elastic_beanstalk_sqsd'
 require_relative 'aws/rails/railtie'
 require_relative 'aws/rails/notifications'
 
-# remove these in aws-sdk-rails 5
-require 'aws-actiondispatch-dynamodb'
-require 'aws-actionmailbox-ses' if defined?(ActionMailbox::Engine)
-require 'aws-actionmailer-ses'
-require 'aws-activejob-sqs'
-require 'aws-record-rails'
-
 module Aws
   module Rails
     VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
   end
 end
-
-# remove these in aws-sdk-rails 5
-Aws::Rails::SqsActiveJob = Aws::ActiveJob::SQS
-Aws::Rails::EbsSqsActiveJobMiddleware = Aws::Rails::Middleware::ElasticBeanstalkSQSD
-Aws::Rails::SesMailer = Aws::ActionMailer::SES::Mailer
-Aws::Rails::Sesv2Mailer = Aws::ActionMailer::SESV2::Mailer
-# This is for backwards compatibility after introducing support for SESv2.
-# The old mailer is now replaced with the new SES (v1) mailer.
-Aws::Rails::Mailer = Aws::Rails::SesMailer

metadata

@@ -1,85 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rails
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-actiondispatch-dynamodb
+  name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aws-actionmailbox-ses
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aws-actionmailer-ses
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aws-activejob-sqs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aws-record-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +49,6 @@ files:
 - LICENSE.txt
 - VERSION
 - lib/aws-sdk-rails.rb
-- lib/aws/rails/action_mailbox/rspec.rb
 - lib/aws/rails/middleware/elastic_beanstalk_sqsd.rb
 - lib/aws/rails/notifications.rb
 - lib/aws/rails/railtie.rb

data/lib/aws/rails/action_mailbox/rspec.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-# This can be deleted in aws-sdk-rails ~> 5
-
-require 'aws/action_mailbox/ses/rspec'
-Aws::Rails::ActionMailbox::RSpec = Aws::ActionMailbox::SES::RSpec
-
-Kernel.warn('Aws::Rails::ActionMailbox::RSpec is deprecated in aws-sdk-rails ~> 5. ' \
-            'Use Aws::ActionMailbox::SES::RSpec instead.')
-Kernel.warn('Please require "aws/action_mailbox/ses/rspec" instead of "aws/rails/action_mailbox/rspec"')