message_bus_client_worker 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e11858a4762c2a446881b531dc10c0f5d74490a01b61697a3fe9100bf399553
-  data.tar.gz: 364a0bbdcc1f7a3906ac4a3d2343ab16b7c518afe8fde6a408b6b0b4651f2f73
+  metadata.gz: c4ef20ee860c68da5470850b190d1b9cb5362361d3dbfd27b0bd5f12fbc5390b
+  data.tar.gz: 5d481f4e6e10a217494271d47c3a65c02fc91401f13103c98cb169a75ff0b289
 SHA512:
-  metadata.gz: 511394ec3c064c50e616625b2ba1baf0b7b05bf047eb75b66110ef9e5132ebb398bffa0cf7f34a308965dca583cd8e2e9bc0fc78db99a8a7df94801337b3928f
-  data.tar.gz: 65c0a9f3eec5b469fec84450fac71db37d011d261b06ba934bb1ddcc8013579a485d6f5bb801eae6ed43889fb91035117e3813999d16e8186af95f95ffed67a0
+  metadata.gz: 849f256761e8c427f7d5e16d7b80928764f41d54e85e6c5711d3bd5e02052b3fb19240b50daa90e854bbba400b83026dcba7d5c39d67f157ad5076c437ad3658
+  data.tar.gz: 550137b3cc5fd47f6b19fea9ba784069363e368a0a6f35f68dfd6a48763d7cb94d7f234d7b5ee865df35e4bd085198db12cba0c5384240aa5a25cb2a5757a15e

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.0
+    - name: Start dbs
+      run: docker-compose up --detach sidekiq chat
+    - name: Copy config
+      run: cp spec/config.yml{.sample,}
+    - name: Run tests
+      run: docker-compose run gem bundle exec rspec spec

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.3

data/CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.1.0] - 2021-10-01
+### Added
+- `MessageBusClientWorker.subscribe(host, config)` which recommended over setting subscriptions via `configure`
+
+## [2.0.0] - 2020-03-12
+### Changed
+- Update logging in Sidekiq; requires Sidekiq 6
+
+## [1.2.2] - 2020-03-12
+### Fixed
+- ensure sidekiq `< 6` is installed, since `Sidekiq::Logging` is not available
+
+## [1.2.1] - 2019-06-11
+### Fixed
+- conflicting last id when differentiating with headers
+
 ## [1.2.0] - 2018-02-24
 ### Added
 - Add ability to customise client_id

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.5.1
+FROM ruby:2.6.3
 
 WORKDIR /gem
 
@@ -9,7 +9,7 @@ ENV BUNDLE_GEMFILE=/gem/Gemfile \
 COPY Gemfile Gemfile.lock message_bus_client_worker.gemspec /gem/
 COPY lib/message_bus_client_worker/version.rb /gem/lib/message_bus_client_worker/
 
-RUN gem install bundler --no-ri --no-rdoc && \
+RUN gem install bundler && \
   bundle install --jobs 20 --retry 5
 
 COPY . /gem

data/Gemfile.lock

@@ -1,49 +1,50 @@
 PATH
   remote: .
   specs:
-    message_bus_client_worker (1.2.0)
+    message_bus_client_worker (2.1.0)
       activesupport
       addressable
       excon
       gem_config
       light-service
-      sidekiq (>= 5.1)
+      sidekiq (~> 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     byebug (10.0.2)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.9)
     connection_pool (2.2.2)
     diff-lcs (1.3)
-    excon (0.62.0)
-    gem_config (0.3.1)
-    i18n (1.5.3)
+    excon (0.85.0)
+    gem_config (0.3.2)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    light-service (0.11.0)
-      activesupport (>= 3.0)
+    light-service (0.17.0)
+      activesupport (>= 4.0.0)
     method_source (0.9.0)
-    minitest (5.11.3)
+    minitest (5.14.4)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    public_suffix (3.0.3)
-    rack (2.0.6)
-    rack-protection (2.0.3)
+    public_suffix (4.0.6)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
       rack
     rake (10.5.0)
-    redis (4.0.1)
+    redis (4.1.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -60,21 +61,20 @@ GEM
       rspec-core (~> 3.0, >= 3.0.0)
       sidekiq (>= 2.4.0)
     rspec-support (3.7.1)
-    sidekiq (5.1.3)
+    sidekiq (6.0.5)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-      connection_pool (~> 2.2, >= 2.2.0)
-      rack-protection (>= 1.5.0)
-      redis (>= 3.3.5, < 5)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     wait (0.5.3)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
   message_bus_client_worker!
   pry-byebug
   rake (~> 10.0)
@@ -83,4 +83,4 @@ DEPENDENCIES
   wait
 
 BUNDLED WITH
-   1.16.6
+   2.2.28

data/README.md

@@ -7,6 +7,8 @@ Subscribe to [MessageBus](https://github.com/SamSaffron/message_bus) using Sidek
 - do not unnecessarily add noise when starting the console like `rails console`
 - recover from downtime by keeping track of the last message it processed per channel
 
+This gem does **not** promise that the message are processed only once. You must put safeguards in place if it is imperative that messages are not processed more than once.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,10 +34,15 @@ MessageBusClientWorker.configure do |c|
   c.subscriptions = {
     # Format is
     # "https://domain.com" => {
-    #   "/a_channel" => {
-    #     processor: "ProcessorClass",
-    #     message_id: 0,
-    #   }
+    #   headers: {
+    #     "Some header" => "only if you want",
+    #   },
+    #   channels: {
+    #     "/a_channel" => {
+    #       processor: "ProcessorClass",
+    #       message_id: 0,
+    #     }
+    #   },
     # }
     "https://etc.com" => {
       headers: {

data/docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3.2"
 services:
   redis:
-    image: redis:4.0.10
+    image: redis:5.0.7
     ports:
       - "6379:6379"
   gem:

data/lib/message_bus_client_worker/services/polling/gen_last_id_key.rb

@@ -2,8 +2,13 @@ module MessageBusClientWorker
   module Polling
     class GenLastIdKey
 
-      def self.call(host, channel)
-        [host, channel].join("-")
+      def self.call(host:, channel:, headers: {})
+        key_parts = [host, channel]
+        (headers || {}).each do |key, value|
+          key_parts << [key, value].join("_")
+        end
+
+        Digest::SHA256.hexdigest(key_parts.join("-"))
       end
 
     end

data/lib/message_bus_client_worker/services/polling/generate_params.rb

@@ -3,7 +3,7 @@ module MessageBusClientWorker
     class GenerateParams
       extend LightService::Action
 
-      expects :host, :subscriptions
+      expects :host, :subscriptions, :headers
       promises :params, :form_params
 
       DEFAULT_MESSAGE_ID = "-1".freeze
@@ -13,8 +13,16 @@ module MessageBusClientWorker
 
         c.params = { dlp: 't' }
         c.form_params = channels.each_with_object({}) do |sub, hash|
+          channel = sub[0]
           custom_message_id = sub[1][:message_id] ? sub[1][:message_id].to_s : nil
-          hash[sub[0]] = GetLastId.(c.host, sub[0]) ||
+
+          last_id_in_memory = GetLastId.(
+            host: c.host,
+            channel: channel,
+            headers: c.headers,
+          )
+
+          hash[channel] = last_id_in_memory ||
             custom_message_id ||
             DEFAULT_MESSAGE_ID
         end

data/lib/message_bus_client_worker/services/polling/get_last_id.rb

@@ -2,8 +2,8 @@ module MessageBusClientWorker
   module Polling
     class GetLastId
 
-      def self.call(host, channel)
-        hash_key = GenLastIdKey.(host, channel)
+      def self.call(host:, channel:, headers: {})
+        hash_key = GenLastIdKey.(host: host, channel: channel, headers: headers)
         Sidekiq.redis { |r| r.hget(SetLastId::CHANNEL_INDICES_NAME, hash_key) }
       end
 

data/lib/message_bus_client_worker/services/polling/process_payload.rb

@@ -21,7 +21,12 @@ module MessageBusClientWorker
         next c if channel_config.nil?
 
         processor_class = Kernel.const_get(channel_config[:processor])
-        SetLastId.(c.host, channel, payload["message_id"])
+        SetLastId.(
+          host: c.host,
+          channel: channel,
+          message_id: payload["message_id"],
+          headers: c.headers,
+        )
 
         data = payload["data"]
 

data/lib/message_bus_client_worker/services/polling/set_last_id.rb

@@ -3,8 +3,8 @@ module MessageBusClientWorker
     class SetLastId
 
       CHANNEL_INDICES_NAME = "message_bus_client_worker_channel_indices".freeze
-      def self.call(host, channel, message_id)
-        hash_key = GenLastIdKey.(host, channel)
+      def self.call(host:, channel:, message_id:, headers:)
+        hash_key = GenLastIdKey.(host: host, channel: channel, headers: headers)
 
         id = Sidekiq.redis do |r|
           r.hset(CHANNEL_INDICES_NAME, hash_key, message_id)

data/lib/message_bus_client_worker/version.rb

@@ -1,3 +1,3 @@
 module MessageBusClientWorker
-  VERSION = "1.2.0"
+  VERSION = "2.1.0"
 end

data/lib/message_bus_client_worker/workers/subscription_worker.rb

@@ -13,7 +13,7 @@ module MessageBusClientWorker
 
     def log(host, subscriptions)
       subscriptions[:channels].each do |channel, _|
-        Sidekiq::Logging.logger.info "Enqueued #{host} for #{channel}"
+        logger.info "Enqueued #{host} for #{channel}"
       end
     end
 

data/lib/message_bus_client_worker.rb

@@ -1,4 +1,5 @@
 require "addressable"
+require "digest"
 require "excon"
 require "gem_config"
 require "light-service"
@@ -25,8 +26,18 @@ module MessageBusClientWorker
   include GemConfig::Base
 
   with_configuration do
-    has :subscriptions, classes: Hash
+    has :subscriptions, classes: [Hash, NilClass]
     has :client_id, classes: [Proc, String], default: -> {SecureRandom.uuid}
   end
 
+  def self.subscribe(host, options)
+    self.configuration.subscriptions ||= {}
+
+    if self.configuration.subscriptions.keys.include?(host)
+      warn "[#{self.name}] #{host} already configured, overwriting (called from #{caller.first})"
+    end
+
+    self.configuration.subscriptions[host] = options
+  end
+
 end

data/message_bus_client_worker.gemspec

@@ -31,13 +31,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "gem_config"
-  spec.add_dependency "sidekiq", ">= 5.1"
+  spec.add_dependency "sidekiq", "~> 6.0"
   spec.add_dependency "excon"
   spec.add_dependency "addressable"
   spec.add_dependency "light-service"
   spec.add_dependency "activesupport"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-sidekiq"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus_client_worker
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ramon Tayag
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-24 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
@@ -28,16 +28,16 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -164,17 +150,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - ramon.tayag@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
@@ -205,7 +191,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,9 +206,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Subscribe to MessageBus using Sidekiq workers
 test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_script:
-  - cp spec/config.yml{.sample,}
-  - docker-compose up -d sidekiq chat
-script: docker-compose run gem bundle exec rspec spec