sqewer 6.5.1 → 8.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1c2d6717fda50ce8a72721d00ffcfd2fae867f40f40a07a0cf48cbe94fe17b
-  data.tar.gz: fb1622a03a4f540aaa96d24dc3d5d39c5d400b658f371c88dc682844ac784ea5
+  metadata.gz: c3bde02330a40856f767370e8098ec7e11216c1434977b8072cdd78af410d132
+  data.tar.gz: 79a8fae95732af97fee2faa101abe058015e542fafe00c6f193298a8d2a9db29
 SHA512:
-  metadata.gz: fd4e73838959531d646d0ed69fd8316e85075d3abe96b5362c58ff5de9af27b26cec142273bce674aaadf571275f1f91cf055c305be4b9797edd75eb89b74222
-  data.tar.gz: 9f4b9006f504bd4a0a85abea9d3c82bf2c70ccdfecf59095df58a1e6b1b8b3ed0b6ba819778f828c48e5dd1865c1f312c5feda78485e9ceab95565e9559cc870
+  metadata.gz: d0ee92f90995e1ad4fc439da92550fb6e9a9a294941b444a41b761e5589d82fb4cc4e5d7252359bc5b22f5675d6dcfb7f4dfb1fcf81e7376e3939f6a7e6cccd2
+  data.tar.gz: f95b7659f1fa00b51a0f4882515b5f0c6d655148849de83b9da4bf104814ccfe0a192cf617c1a56a2c154c8f79331ee5e6acb6979f7d795fc68ee4fc3401f831

data/.travis.yml

@@ -1,11 +1,7 @@
 gemfile:
-  - gemfiles/Gemfile.rails-4.2.x
   - gemfiles/Gemfile.rails-5.0.x
   - gemfiles/Gemfile.rails-5.1.x
 rvm:
-  - 2.3.7
-  - 2.4.5
-  - 2.5.1
   - 2.6.5
   - 2.7.0
 cache: bundler
@@ -13,15 +9,3 @@ sudo: false
 env:
   global:
   - AWS_REGION=eu-central-1
-matrix:
-  exclude:
-  - rvm: 2.3.7
-    gemfile: gemfiles/Gemfile.rails-5.0.x
-  - rvm: 2.3.7
-    gemfile: gemfiles/Gemfile.rails-5.1.x
-  - rvm: 2.5.1
-    gemfile: gemfiles/Gemfile.rails-4.2.x
-  - rvm: 2.6.5
-    gemfile: gemfiles/Gemfile.rails-4.2.x
-  - rvm: 2.7.0
-    gemfile: gemfiles/Gemfile.rails-4.2.x

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+### 8.0.2
+- Add `Aws::SQS::Errors::AccessDenied` to the list of errors that Sqewer must release the singleton SQS client
+
+### 8.0.1
+- Release the singleton SQS client when AWS raises credentials error to be able to use a new credential next time
+
+### 8.0.0
+- Remove method `Sqewer.client=`
+- Change `Sqewer::Connection` to use a singleton SQS client by default
+
+### 7.0.0
+- Remove support of Ruby 2.3, 2.4 and 2.5
+- Remove support of Rails 4
+- Change `Sqewer::Connection` to preferentially use a singleton instance of `Aws::SQS::Client`, which can be set using `Sqewer.client=`. This avoids many HTTP requests to the AWS metadata endpoint when getting credentials.
+
 ### 6.5.1
 - Also retry on `Aws::SQS::Errors::InternalError` exception when receiving/sending messages. This will make
   the receiving thread more resilient to sudden SQS failures. By the time SQS recovers the receiving thread

data/README.md

@@ -48,7 +48,7 @@ The messages will only be deleted from SQS once the job execution completes with
 
 ## Requirements
 
-Ruby 2.1+, version 2 of the AWS SDK. You can also run Sqewer backed by a SQLite database file, which can be handy for development situations.
+Ruby 2.6+, version 2 of the AWS SDK. You can also run Sqewer backed by a SQLite database file, which can be handy for development situations.
 
 ## Job storage
 
@@ -288,7 +288,7 @@ and traceable (make good use of logging).
 
 # Usage with Rails via ActiveJob
 
-This gem includes a queue adapter for usage with ActiveJob in Rails 4.2+. The functionality
+This gem includes a queue adapter for usage with ActiveJob in Rails 5+. The functionality
 is well-tested and should function for any well-conforming ActiveJob subclasses.
 
 To run the default `sqewer` worker setup against your Rails application, first set it as the

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sqewer"
+
+require "irb"
+IRB.start(__FILE__)

data/lib/sqewer.rb

@@ -11,6 +11,11 @@ module Sqewer
     end
   end
 
+  # Returns a singleton of Aws::SQS::Client
+  def self.client
+    Sqewer::Connection.client
+  end
+
   # Loads a particular Sqewer extension that is not loaded
   # automatically during the gem require.
   #

data/lib/sqewer/connection.rb

@@ -13,6 +13,11 @@ class Sqewer::Connection
 
   NotOurFaultAwsError = Class.new(Sqewer::Error)
 
+  SQS_ERRORS_TO_RELEASE_CLIENT = [
+    Aws::Errors::MissingCredentialsError,
+    Aws::SQS::Errors::AccessDenied,
+  ]
+
   # A wrapper for most important properties of the received message
   class Message < Struct.new(:receipt_handle, :body, :attributes)
     def inspect
@@ -39,12 +44,25 @@ class Sqewer::Connection
     raise "SQS_QUEUE_URL not set in the environment. This is the queue URL Sqewer uses by default."
   end
 
+  # Returns a singleton of Aws::SQS::Client
+  def self.client
+    # It's better using a singleton client to prevent making a lot of HTTP
+    # requests to the AWS metadata endpoint when getting credentials.
+    @client ||= begin
+      require 'aws-sdk-sqs'
+      ::Aws::SQS::Client.new(
+        instance_profile_credentials_timeout: 1,
+        instance_profile_credentials_retries: 5,
+      )
+    end
+  end
+
   # Initializes a new adapter, with access to the SQS queue at the given URL.
   #
   # @param queue_url[String] the SQS queue URL (the URL can be copied from your AWS console)
-  def initialize(queue_url)
-    require 'aws-sdk-sqs'
+  def initialize(queue_url, client: self.class.client)
     @queue_url = queue_url
+    @client = client
   end
 
   # Receive at most 10 messages from the queue, and return the array of Message objects. Retries for at
@@ -55,7 +73,7 @@ class Sqewer::Connection
   # @return [Array<Message>] an array of Message objects
   def receive_messages
     Retriable.retriable on: network_and_aws_sdk_errors, tries: MAX_RANDOM_RECEIVE_FAILURES do
-      response = client.receive_message(
+      response = @client.receive_message(
         queue_url: @queue_url,
         attribute_names: ['All'],
         wait_time_seconds: DEFAULT_TIMEOUT_SECONDS,
@@ -63,6 +81,14 @@ class Sqewer::Connection
       )
       response.messages.map {|message| Message.new(message.receipt_handle, message.body, message.attributes) }
     end
+  rescue *SQS_ERRORS_TO_RELEASE_CLIENT
+    # We noticed cases where errors related to AWS credentials started to happen suddenly.
+    # We don't know the root cause yet, but what we can do is release the
+    # singleton @client instance because it contains a cache of credentials that in most
+    # cases is no longer valid.
+    self.class.release_client
+
+    raise
   end
 
   # Send a message to the backing queue
@@ -189,6 +215,12 @@ class Sqewer::Connection
     buffer.each_batch {|batch| handle_batch_with_retries(:delete_message_batch, batch) }
   end
 
+  protected
+
+  def self.release_client
+    @client = nil
+  end
+
   private
 
   def network_and_aws_sdk_errors
@@ -197,7 +229,7 @@ class Sqewer::Connection
 
   def handle_batch_with_retries(method, batch)
     Retriable.retriable on: network_and_aws_sdk_errors, tries: MAX_RANDOM_FAILURES_PER_CALL do
-      resp = client.send(method, queue_url: @queue_url, entries: batch)
+      resp = @client.send(method, queue_url: @queue_url, entries: batch)
       wrong_messages, aws_failures = resp.failed.partition {|m| m.sender_fault }
       if wrong_messages.any?
         err = wrong_messages.inspect + ', ' + resp.inspect
@@ -208,12 +240,13 @@ class Sqewer::Connection
         raise NotOurFaultAwsError
       end
     end
-  end
-
-  def client
-    @client ||= Aws::SQS::Client.new(
-      instance_profile_credentials_timeout: 1, # defaults to 1 second
-      instance_profile_credentials_retries: 5, # defaults to 0 retries
-    )
+  rescue *SQS_ERRORS_TO_RELEASE_CLIENT
+    # We noticed cases where errors related to AWS credentials started to happen suddenly.
+    # We don't know the root cause yet, but what we can do is release the
+    # singleton @client instance because it contains a cache of credentials that in most
+    # cases is no longer valid.
+    self.class.release_client
+
+    raise
   end
 end

data/lib/sqewer/version.rb

@@ -1,3 +1,3 @@
 module Sqewer
-  VERSION = '6.5.1'
+  VERSION = '8.0.2'
 end

data/sqewer.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Process jobs from SQS}
   spec.description   = %q{A full-featured library for all them SQS worker needs}
   spec.homepage      = "https://github.com/WeTransfer/sqewer"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -49,4 +50,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "appsignal", '~> 2'
+  spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqewer
 version: !ruby/object:Gem::Version
-  version: 6.5.1
+  version: 8.0.2
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -221,11 +221,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A full-featured library for all them SQS worker needs
 email:
 - me@julik.nl
 - linkyndy@gmail.com
 executables:
+- console
 - sqewer
 - sqewer_rails
 extensions: []
@@ -239,10 +254,10 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/console
 - bin/sqewer
 - bin/sqewer_rails
 - example.env
-- gemfiles/Gemfile.rails-4.2.x
 - gemfiles/Gemfile.rails-5.0.x
 - gemfiles/Gemfile.rails-5.1.x
 - lib/sqewer.rb
@@ -278,14 +293,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Process jobs from SQS

data/gemfiles/Gemfile.rails-4.2.x

@@ -1,8 +0,0 @@
-source "http://rubygems.org"
-
-# Gemspec as base dependency set
-gemspec path: __dir__ + '/..'
-
-gem 'sqlite3', '~> 1.3.6'
-gem 'activejob', "~> 4.2.0"
-gem 'activerecord', "~> 4.2.0"