pwwka 0.22.2 → 0.22.7.RC

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1388132955d9c594eeeaa04a7d28cc0e7f496dd643ef126b5e48f97677a2b95c
-  data.tar.gz: fd9c2c8ec635b09f9834d2ad5436d686718d201f9c2f3340c845db54cf73e5ea
+  metadata.gz: 965ff1503560b0afd024c39ff93d9e1411e1cd928dd701a3bf41cd5116be5212
+  data.tar.gz: 0f0c8c330746ee727780759649c781aba69aa36d8c42904d9f3bdf8a044e5772
 SHA512:
-  metadata.gz: aa79d1ad17757b4e091c157d4d4f58be251c87779429d0ccab954f1ee44735769c102e0e421f3151a88665d42e156d293504f55091b18bd70c0fd8bcc535bff5
-  data.tar.gz: 9f5cef8900f0d9add15efa40bbbd23c45d2f41da39b5bd9f631194f6370c78828ac684448740aca3d3d9750bc004a09d12cd3ebc2f29392466aa5a6b630aa399
+  metadata.gz: 43809503913bf7b18ae45ee3ecbcf26074e9182afb938262777782ff8a433191ed10461a6938a3db0d904e409dcb783df98a27a18d14723407eca56346ce7dd7
+  data.tar.gz: 9b6afecdce66ed9d36536c8f7eea142093fea738dcbc76225c72704d31e5a60e592cb9e3029dd57039dc0b228a39a5a1852ee6696bfbfe0ecfed4761bcdfea1a

data/.circleci/config.yml

@@ -3,16 +3,31 @@
 ---
 version: 2
 jobs:
-  ruby-2.5.3-rails-5.2:
+  release:
     docker:
-    - image: circleci/ruby:2.5.3
+    - image: circleci/ruby:2.7.1
+    steps:
+    - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
+    - run: bundle install --full-index
+    - run:
+        name: Artifactory login
+        command: mkdir -p ~/.gem && curl -u$ARTIFACTORY_USER:$ARTIFACTORY_TOKEN https://stitchfix01.jfrog.io/stitchfix01/api/gems/eng-gems/api/v1/api_key.yaml
+          > ~/.gem/credentials && chmod 0600 ~/.gem/credentials
+    - run:
+        name: Build/release gem to artifactory
+        command: bundle exec rake push_artifactory
+  ruby-2.7.1-rails-6.0:
+    docker:
+    - image: circleci/ruby:2.7.1
       environment:
-        BUNDLE_GEMFILE: Gemfile.rails-5.2
+        BUNDLE_GEMFILE: Gemfile.rails-6.0
     - image: redis:2.8.12
     - image: rabbitmq:3.5.6
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
@@ -22,20 +37,21 @@ jobs:
           fi
     - run:
         name: Notify Pager Duty
-        command: 'bundle exec y-notify #eng-platform'
+        command: bundle exec y-notify "#eng-messaging-ops"
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.4.5-rails-5.2:
+  ruby-2.6.6-rails-6.0:
     docker:
-    - image: circleci/ruby:2.4.5
+    - image: circleci/ruby:2.6.6
       environment:
-        BUNDLE_GEMFILE: Gemfile.rails-5.2
+        BUNDLE_GEMFILE: Gemfile.rails-6.0
     - image: redis:2.8.12
     - image: rabbitmq:3.5.6
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
@@ -45,20 +61,21 @@ jobs:
           fi
     - run:
         name: Notify Pager Duty
-        command: 'bundle exec y-notify #eng-platform'
+        command: bundle exec y-notify "#eng-messaging-ops"
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.5.3-rails-5.1:
+  ruby-2.7.1-rails-5.2:
     docker:
-    - image: circleci/ruby:2.5.3
+    - image: circleci/ruby:2.7.1
       environment:
-        BUNDLE_GEMFILE: Gemfile.rails-5.1
+        BUNDLE_GEMFILE: Gemfile.rails-5.2
     - image: redis:2.8.12
     - image: rabbitmq:3.5.6
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
@@ -68,20 +85,21 @@ jobs:
           fi
     - run:
         name: Notify Pager Duty
-        command: 'bundle exec y-notify #eng-platform'
+        command: bundle exec y-notify "#eng-messaging-ops"
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.4.5-rails-5.1:
+  ruby-2.6.6-rails-5.2:
     docker:
-    - image: circleci/ruby:2.4.5
+    - image: circleci/ruby:2.6.6
       environment:
-        BUNDLE_GEMFILE: Gemfile.rails-5.1
+        BUNDLE_GEMFILE: Gemfile.rails-5.2
     - image: redis:2.8.12
     - image: rabbitmq:3.5.6
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
@@ -91,7 +109,7 @@ jobs:
           fi
     - run:
         name: Notify Pager Duty
-        command: 'bundle exec y-notify #eng-platform'
+        command: bundle exec y-notify "#eng-messaging-ops"
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
@@ -99,14 +117,38 @@ workflows:
   version: 2
   on-commit:
     jobs:
-    - ruby-2.5.3-rails-5.2:
+    - release:
+        context: org-global
+        requires:
+        - ruby-2.7.1-rails-6.0
+        - ruby-2.6.6-rails-6.0
+        - ruby-2.7.1-rails-5.2
+        - ruby-2.6.6-rails-5.2
+        filters:
+          tags:
+            only: /^[0-9]+\.[0-9]+\.[0-9]+(\.?(RC|rc)[-\.]?\d*)?$/
+          branches:
+            ignore: /.*/
+    - ruby-2.7.1-rails-6.0:
         context: org-global
-    - ruby-2.4.5-rails-5.2:
+        filters:
+          tags:
+            only: &1 /.*/
+    - ruby-2.6.6-rails-6.0:
         context: org-global
-    - ruby-2.5.3-rails-5.1:
+        filters:
+          tags:
+            only: *1
+    - ruby-2.7.1-rails-5.2:
         context: org-global
-    - ruby-2.4.5-rails-5.1:
+        filters:
+          tags:
+            only: *1
+    - ruby-2.6.6-rails-5.2:
         context: org-global
+        filters:
+          tags:
+            only: *1
   scheduled:
     triggers:
     - schedule:
@@ -116,11 +158,11 @@ workflows:
             only:
             - master
     jobs:
-    - ruby-2.5.3-rails-5.2:
+    - ruby-2.7.1-rails-6.0:
         context: org-global
-    - ruby-2.4.5-rails-5.2:
+    - ruby-2.6.6-rails-6.0:
         context: org-global
-    - ruby-2.5.3-rails-5.1:
+    - ruby-2.7.1-rails-5.2:
         context: org-global
-    - ruby-2.4.5-rails-5.1:
+    - ruby-2.6.6-rails-5.2:
         context: org-global

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.7.1

data/CODEOWNERS

@@ -0,0 +1 @@
+* @stitchfix/eng-messaging

data/Gemfile.rails-5.1

@@ -1,7 +1,6 @@
 # DO NOT MODIFY - this is managed by Git Reduce in goro
 #
-source 'https://gem.fury.io/me/'
-source 'https://www.rubygems.org'
+source 'https://stitchfix01.jfrog.io/stitchfix01/api/gems/eng-gems/'
 
 gemspec
 

data/Gemfile.rails-5.2

@@ -1,7 +1,6 @@
 # DO NOT MODIFY - this is managed by Git Reduce in goro
 #
-source 'https://gem.fury.io/me/'
-source 'https://www.rubygems.org'
+source 'https://stitchfix01.jfrog.io/stitchfix01/api/gems/eng-gems/'
 
 gemspec
 

data/Gemfile.rails-6.0

@@ -0,0 +1,7 @@
+# DO NOT MODIFY - this is managed by Git Reduce in goro
+#
+source 'https://stitchfix01.jfrog.io/stitchfix01/api/gems/eng-gems/'
+
+gemspec
+
+gem 'activesupport', '~> 6.0.0'

data/lib/pwwka/channel_connector.rb

@@ -19,15 +19,19 @@ module Pwwka
         @connection = Bunny.new(configuration.rabbit_mq_host, connection_options)
         @connection.start
       rescue => e
-        logf "ERROR Connecting to RabbitMQ", error: e
+        logf "ERROR Connecting to RabbitMQ: #{e}", at: :error
+
         @connection.close if @connection
         raise e
       end
 
       begin
         @channel = @connection.create_channel
+        @channel.on_error do |ch, method|
+          logf "ERROR On RabbitMQ channel: #{method.inspect}"
+        end
       rescue => e
-        logf "ERROR Opening RabbitMQ channel", error: e
+        logf "ERROR Opening RabbitMQ channel: #{e}", at: :error
         @connection.close if @connection
         raise e
       end
@@ -81,13 +85,14 @@ module Pwwka
       begin
         channel.close
       rescue => e
-        logf "ERROR Closing RabbitMQ channel", error: e
+        logf "ERROR Closing RabbitMQ channel: #{e}", at: :error
+        raise e
       end
 
       begin
         connection.close
       rescue => e
-        logf "ERROR Closing connection to RabbitMQ", error: e
+        logf "ERROR Closing connection to RabbitMQ: #{e}", at: :error
         raise e
       end
     end

data/lib/pwwka/configuration.rb

@@ -45,10 +45,15 @@ module Pwwka
     def app_id
       if @app_id.to_s.strip == ""
         if defined?(Rails)
-          if Rails.respond_to?(:application)
-            Rails.application.class.parent.name
+          if Rails.respond_to?(:application) && Rails.respond_to?(:version)
+            # Module#module_parent is the preferred technique, but we keep usage
+            # of the deprecated Module#parent for Rails 5 compatibility. see
+            # https://github.com/stitchfix/pwwka/issues/91 for context.
+            app_klass = Rails.application.class
+            app_parent = Rails.version =~ /^6/ ? app_klass.module_parent : app_klass.parent
+            app_parent.name
           else
-            raise "'Rails' is defined, but it doesn't respond to #application, so could not derive the app_id; you must explicitly set it"
+            raise "'Rails' is defined, but it doesn't respond to #application or #version, so could not derive the app_id; you must explicitly set it"
           end
         else
           raise "Could not derive the app_id; you must explicitly set it"

data/lib/pwwka/transmitter.rb

@@ -29,7 +29,7 @@ module Pwwka
       @channel_connector = ChannelConnector.new(connection_name: "p: #{Pwwka.configuration.app_id} #{Pwwka.configuration.process_name}".strip)
     end
 
-    # Send an important message that must go through.  This method allows any raised exception 
+    # Send an important message that must go through.  This method allows any raised exception
     # to pass through.
     #
     # payload:: Hash of what you'd like to include in your message
@@ -95,11 +95,24 @@ module Pwwka
       job = Pwwka.configuration.async_job_klass
 
       if background_job_processor == :resque
-        # Be perhaps too carefully making sure we queue jobs in the legacy way
-        if type == nil && message_id == :auto_generate && headers == nil
-          Resque.enqueue_in(delay_by_ms/1000, job, payload, routing_key)
+        resque_args = [job, payload, routing_key]
+
+        unless type == nil && message_id == :auto_generate && headers == nil
+          # NOTE: (jdlubrano)
+          # Why can't we pass these options all of the time?  Well, if a user
+          # of pwwka has configured their own async_job_klass that only has an
+          # arity of 2 (i.e. payload and routing key), then passing these options
+          # as an additional argument would break the user's application.  In
+          # order to maintain compatibility with preceding versions of Pwwka,
+          # we need to ensure that the same arguments passed into this method
+          # result in compatible calls to enqueue any Resque jobs.
+          resque_args << { type: type, message_id: message_id, headers: headers }
+        end
+
+        if delay_by_ms.zero?
+          Resque.enqueue(*resque_args)
         else
-          Resque.enqueue_in(delay_by_ms/1000, job, payload, routing_key, type: type, message_id: message_id, headers: headers)
+          Resque.enqueue_in(delay_by_ms/1000, *resque_args)
         end
       elsif background_job_processor == :sidekiq
         options = { delay_by_ms: delay_by_ms, type: type, message_id: message_id, headers: headers }

data/lib/pwwka/version.rb

@@ -1,4 +1,4 @@
 module Pwwka
-  VERSION = '0.22.2'
+  VERSION = '0.22.7.RC'
 end
 

data/owners.json

@@ -1,7 +1,7 @@
 {
   "owners": [
     {
-      "team": "platform"
+      "team": "messaging"
     }
   ]
 }

data/pwwka.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")
   s.add_development_dependency("resque")
-  s.add_development_dependency("resque-retry")
+  s.add_development_dependency("resque-retry", "~> 1.5.3")
   s.add_development_dependency("sidekiq")
   s.add_development_dependency("simplecov")
   s.add_development_dependency("resqutils")

data/spec/integration/send_and_receive_spec.rb

@@ -11,6 +11,9 @@ describe "sending and receiving messages", :integration do
   include IntegrationTestHelpers
   include Resqutils::Spec::ResqueHelpers
 
+  let(:async_resque_queue) { 'pwwka_send_message_async' }
+  let(:delayed_resque_queue) { :delayed }
+
   before do
     ENV["JOB_KLASS"] = MyTestJob.name
     ENV["PWWKA_QUEUE_EXTENDED_INFO"] = "true"
@@ -30,7 +33,8 @@ describe "sending and receiving messages", :integration do
     FooReceiver.reset!
     MultiRoutingReceived.reset!
     OtherFooReceiver.reset!
-    clear_queue(:delayed)
+    clear_queue(async_resque_queue)
+    clear_queue(delayed_resque_queue)
     clear_queue(MyTestJob)
   end
 
@@ -144,7 +148,7 @@ describe "sending and receiving messages", :integration do
 
       expect(AllReceiver.messages_received.size).to eq(0)
 
-      process_resque_job(Pwwka::SendMessageAsyncJob,:delayed)
+      process_resque_job(Pwwka::SendMessageAsyncJob, async_resque_queue)
 
       allow_receivers_to_process_queues
 
@@ -166,7 +170,7 @@ describe "sending and receiving messages", :integration do
 
       expect(AllReceiver.messages_received.size).to eq(0)
 
-      process_resque_job(Pwwka::SendMessageAsyncJob,:delayed)
+      process_resque_job(Pwwka::SendMessageAsyncJob, async_resque_queue)
 
       allow_receivers_to_process_queues
 
@@ -186,12 +190,28 @@ describe "sending and receiving messages", :integration do
 
       allow(Pwwka).to receive(:configuration).and_return(configuration)
 
-      allow(Resque).to receive(:enqueue_in)
+      allow(Resque).to receive(:enqueue)
 
       Pwwka::Transmitter.send_message_async({ sample: "payload", has: { deeply: true, nested: 4 }},
                                             "pwwka.testing.bar")
 
-      expect(Resque).to have_received(:enqueue_in).with(anything, async_job_klass, anything, anything)
+      expect(Resque).to have_received(:enqueue).with(async_job_klass, anything, anything)
+    end
+
+    it "can queue a job to send a message with a delay" do
+      Pwwka::Transmitter.send_message_async({ sample: "payload" },
+                                            "pwwka.testing.bar",
+                                            delay_by_ms: 1)
+
+      allow_receivers_to_process_queues # not expecting anything to be processed
+
+      expect(AllReceiver.messages_received.size).to eq(0)
+
+      process_resque_job(Pwwka::SendMessageAsyncJob, delayed_resque_queue)
+
+      allow_receivers_to_process_queues
+
+      expect(AllReceiver.messages_received.size).to eq(1)
     end
   end
 

data/spec/unit/channel_connector_spec.rb

@@ -14,6 +14,7 @@ describe Pwwka::ChannelConnector do
       allow(bunny_session).to receive(:start)
       allow(bunny_session).to receive(:close)
       allow(bunny_session).to receive(:create_channel).and_return(bunny_channel)
+      allow(bunny_channel).to receive(:on_error)
     end
 
     it "sets a prefetch value if configured to do so" do
@@ -22,6 +23,11 @@ describe Pwwka::ChannelConnector do
       described_class.new(prefetch: 10)
     end
 
+    it "sets an on_error handler" do
+      expect(bunny_channel).to receive(:on_error)
+      described_class.new
+    end
+
     it "does not set a prefetch value unless configured" do
       expect(bunny_channel).not_to receive(:prefetch).with(10)
 
@@ -67,10 +73,14 @@ describe Pwwka::ChannelConnector do
   end
 
   describe "raise_if_delayed_not_allowed" do
+    let(:bunny_channel) { instance_double(Bunny::Channel) }
+
     before do
       allow(Bunny).to receive(:new).and_return(bunny_session)
       allow(bunny_session).to receive(:start)
-      allow(bunny_session).to receive(:create_channel)
+      allow(bunny_session).to receive(:close)
+      allow(bunny_session).to receive(:create_channel).and_return(bunny_channel)
+      allow(bunny_channel).to receive(:on_error)
       @default_allow_delayed = Pwwka.configuration.options[:allow_delayed]
     end
 

data/spec/unit/configuration_spec.rb

@@ -75,6 +75,10 @@ describe Pwwka::Configuration do
           def self.application
             MyAmazingApp::Application.new
           end
+
+          def self.version
+            '5.2.0'
+          end
         end
         Object.const_set("Rails",rails)
       end
@@ -97,7 +101,7 @@ describe Pwwka::Configuration do
       it "blows up when not set" do
         expect {
           configuration.app_id
-        }.to raise_error(/'Rails' is defined, but it doesn't respond to #application, so could not derive the app_id; you must explicitly set it/)
+        }.to raise_error(/'Rails' is defined, but it doesn't respond to #application or #version, so could not derive the app_id; you must explicitly set it/)
       end
     end
   end

data/spec/unit/transmitter_spec.rb

@@ -312,19 +312,19 @@ describe Pwwka::Transmitter do
       end
       context "on_error: :resque" do
         it "queues a Resque job" do
-          allow(Resque).to receive(:enqueue_in)
+          allow(Resque).to receive(:enqueue)
           described_class.send_message!(payload,routing_key, on_error: :resque)
-          expect(Resque).to have_received(:enqueue_in).with(0,Pwwka::SendMessageAsyncJob,payload,routing_key)
+          expect(Resque).to have_received(:enqueue).with(Pwwka::SendMessageAsyncJob,payload,routing_key)
         end
         context "when there is a problem queueing the resque job" do
           it "raises the original exception job" do
-            allow(Resque).to receive(:enqueue_in).and_raise("NOPE")
+            allow(Resque).to receive(:enqueue).and_raise("NOPE")
             expect {
               described_class.send_message!(payload,routing_key, on_error: :resque)
             }.to raise_error(/OH NOES/)
           end
           it "logs the Resque error as a warning" do
-            allow(Resque).to receive(:enqueue_in).and_raise("NOPE")
+            allow(Resque).to receive(:enqueue).and_raise("NOPE")
             begin
               described_class.send_message!(payload,routing_key, on_error: :resque)
             rescue => ex
@@ -338,18 +338,18 @@ describe Pwwka::Transmitter do
         context "when configured background_job_processor is Resque" do
           context "when the job is queued successfully" do
             before do
-              allow(Resque).to receive(:enqueue_in)
+              allow(Resque).to receive(:enqueue)
             end
 
             it "queues a Resque job" do
               described_class.send_message!(payload, routing_key, on_error: :retry_async)
-              expect(Resque).to have_received(:enqueue_in).with(0, Pwwka::SendMessageAsyncJob, payload, routing_key)
+              expect(Resque).to have_received(:enqueue).with(Pwwka::SendMessageAsyncJob, payload, routing_key)
             end
           end
 
           context "when there is a problem queueing the Resque job" do
             before do
-              allow(Resque).to receive(:enqueue_in).and_raise("NOPE")
+              allow(Resque).to receive(:enqueue).and_raise("NOPE")
             end
 
             it "raises the original exception job" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.22.2
+  version: 0.22.7.RC
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -119,16 +119,16 @@ dependencies:
   name: resque-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +235,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -242,6 +243,7 @@ files:
 - Gemfile.rails-5.0
 - Gemfile.rails-5.1
 - Gemfile.rails-5.2
+- Gemfile.rails-6.0
 - LICENSE
 - README.md
 - Rakefile
@@ -313,12 +315,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Send and receive messages via RabbitMQ