sqewer 7.0.0 → 8.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acb88799499e49e2390422fd05b7c7a160bfec1f441347947941a8f15f62e3f1
-  data.tar.gz: d009682a2cf36c0a27daf683b6110a1a0ce6b3f1b35ba111ad391d57281aa4d1
+  metadata.gz: 04eca66282554d24d485eb24c83cfbbe6c920eeafe2cc87f2f4638fb1c35ef82
+  data.tar.gz: 8eadd3fdbc63b6f0f26a65d5338a587fd6819889d94a83020914f4af65e527ff
 SHA512:
-  metadata.gz: 262f94efde1b86cbce03be08ce9a9c4cdd11de0bb95354c1f7a0adc29bdd4dc08c5d3d82d3377c5d9825dde7bbe1a7323214ed6d89c82d4ed97a56ffd27e0f98
-  data.tar.gz: 5375e768f53ad132fd5a6460dbe5bbf6b1457eaa514c54a1d445fb0f9b7ac30a4c852157877894766ae69da82c2e4efb76c42c4a0689f759ee9b83d909869752
+  metadata.gz: 27504ff6d9db93063d766ced7efc1b76de5f4e7977490a2046316438eade94389705a75470e49d9d8e8a5a05862b2551df7d6d673398938b12c166842e6380bf
+  data.tar.gz: 1b1a9ef385a4ed693cc6d0999eb8d526b36fda101cfc6ab19e11d856ddf0327a4237affe854e7e03891c16cb9f8e7f4fe4c7140b26218eef64bd23909d4817c2

data/.gitignore

@@ -54,3 +54,5 @@ Gemfile.lock
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+
+workdb.sqlite3*

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 8.0.3
+- Fix `Sqewer::Connection` to properly get the list of AWS errors
+
+### 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

data/lib/sqewer.rb

@@ -11,23 +11,9 @@ module Sqewer
     end
   end
 
-  # Sets an instance of Aws::SQS::Client to be used as a singleton.
-  # We recommend setting the options instance_profile_credentials_timeout and
-  # instance_profile_credentials_retries, for example:
-  #
-  #   sqs_client = Aws::SQS::Client.new(
-  #     instance_profile_credentials_timeout: 1,
-  #     instance_profile_credentials_retries: 5,
-  #   )
-  #   Storm.client = sqs_client
-  #
-  # @param client[Aws::SQS::Client] an instance of Aws::SQS::Client
-  def self.client=(client)
-    @client = client
-  end
-
+  # Returns a singleton of Aws::SQS::Client
   def self.client
-    @client
+    Sqewer::Connection.client
   end
 
   # Loads a particular Sqewer extension that is not loaded

data/lib/sqewer/connection.rb

@@ -39,12 +39,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 +68,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 +76,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 +210,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 +224,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,17 +235,20 @@ class Sqewer::Connection
         raise NotOurFaultAwsError
       end
     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
 
-  def client
-    # It's better using a singleton client to prevent making a lot of HTTP
-    # requests to the AWS metadata endpoint when getting credentials.
-    # Maybe in the future, we can remove @client and use Storm.client only.
-    return Sqewer.client if Sqewer.client
-
-    @client ||= Aws::SQS::Client.new(
-      instance_profile_credentials_timeout: 1, # defaults to 1 second
-      instance_profile_credentials_retries: 5, # defaults to 0 retries
-    )
+  def sqs_errors_to_release_client
+    [
+      Aws::Errors::MissingCredentialsError,
+      Aws::SQS::Errors::AccessDenied,
+    ]
   end
 end

data/lib/sqewer/version.rb

@@ -1,3 +1,3 @@
 module Sqewer
-  VERSION = '7.0.0'
+  VERSION = '8.0.3'
 end

data/sqewer.gemspec

@@ -50,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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sqewer
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.3
 platform: ruby
 authors:
 - Julik Tarkhanov
 - Andrei Horak
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -221,6 +221,20 @@ 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
@@ -271,7 +285,7 @@ homepage: https://github.com/WeTransfer/sqewer
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -286,8 +300,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Process jobs from SQS
 test_files: []