wisper-sidekiq-compat 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6a4388e72736b4fdac245dd3cdd98b9fd65b4b88f696f9ead73b394d32125e4
+  data.tar.gz: 20889dbe889541df920687d4aae172dbb8bb576e04f51299e19522e249c52f39
+SHA512:
+  metadata.gz: 4c0b102c2eb662bbca2a7ca78c0fe6463b210183dd9769af23a42cc8ca29eb87eaff5633f89241f4e359236441aef54964c0e5177c2d40dffd3f336e50049e1a
+  data.tar.gz: 29cfb34f718162a6fb297ff6b835551160bd5ea3ad28f379f3ea2fd7c77c8bad4b55d5345bff31114f29a1764cd4729bfda82ec45d147f8d181b7320130e27de

data/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Test
+
+on:
+  push:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.0, 3.1, 3.2]
+    services:
+      redis:
+        image: redis:7-alpine
+        ports:
+          - "6379:6379"
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: |
+          scripts/sidekiq &
+          bundle exec rspec spec

data/.gitignore

@@ -0,0 +1,26 @@
+*.log
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.idea
+.gs

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+## [Unreleased]
+
+## [2.0.0] - 28/Feb/2023
+
+## Changed
+- Name of gem -> wisper-sidekiq-compat
+
+## Removed
+- Support for Ruby < 3
+- Support for Sidekiq < 6.5
+- Rubinius support
+ 
+## Fixed
+- Compatibility with wisper-compat
+- `Psych::DisallowedClass: Tried to load unspecified class:` on Ruby 3.1
+
+## [1.3.0] - 25/Nov/2019
+
+- Add the ability to pass `sidekiq_schedule_options` options in order to schedule jobs to be run in the future
+
+## [1.2.0]
+
+- fixes: gemspec does not allow sidekiq 5.x to be used
+
+## [1.1.0] - 28/Sept/2018
+
+- fixes: `NoMethodError: undefined method `set' for
+  Wisper::SidekiqBroadcaster::Worker:Class` when using Sidekiq 2.x and 3.x.
+
+## [1.0.0] - 28/Sept/2018
+
+### Added
+- sidekiq 5 compatibility (closes [#11](https://github.com/krisleech/wisper-sidekiq/issues/11))
+- support for optional `sidekiq_options` per subscriber class (closes [#15](https://github.com/krisleech/wisper-sidekiq/issues/15))
+
+## [0.0.1] - 06-10-2014
+
+### Added
+- Initial release

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Leech
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Wisper::Sidekiq
+
+Provides [Wisper-Compat](https://github.com/nedap/wisper-compat) with asynchronous event
+publishing using [Sidekiq](https://github.com/mperham/sidekiq).
+
+[![Gem Version](https://badge.fury.io/rb/wisper-sidekiq-compat.png)](http://badge.fury.io/rb/wisper-sidekiq-compat)
+
+## Installation
+
+```ruby
+gem 'wisper-sidekiq-compat'
+```
+
+## Usage
+
+```ruby
+publisher.subscribe(MyListener, async: true)
+```
+
+The listener must be a class (or module), not an object. This is because Sidekiq
+can not reconstruct the state of an object. However a class is easily reconstructed.
+
+Additionally, you should also ensure that your methods used to handle events under `MyListener` are all declared as class methods:
+
+```ruby
+class MyListener
+  def self.event_name
+  end
+end
+```
+
+When publishing events the arguments must be simple as they need to be
+serialized. For example instead of sending an `ActiveRecord` model as an argument
+use its id instead.
+
+See the [Sidekiq best practices](https://github.com/mperham/sidekiq/wiki/Best-Practices)
+for more information.
+
+### Passing down sidekiq options
+
+In order to define custom [sidekiq_options](https://github.com/mperham/sidekiq/wiki/Advanced-Options#workers) you can add `sidekiq_options` class method in your subscriber definition - those options will be passed to Sidekiq's `set` method just before scheduling the asynchronous worker.
+
+### Passing down schedule options
+
+In order be able to schedule jobs to be run in the future following [Scheduled Jobs](https://github.com/mperham/sidekiq/wiki/Scheduled-Jobs) you can add `sidekiq_schedule_options` class method in your subscriber definition - those options will be passed to Sidekiq's `perform_in` method when the worker is called.
+
+This feature is not as powerful as Sidekiq's API that allows you to set this on every job enqueue, in this case you're able to set this for the hole listener class like:
+```ruby
+class MyListener
+  #...
+
+  def self.sidekiq_schedule_options
+    { perform_in: 5 }
+  end
+
+  #...
+end
+```
+Or you can set this per event (method called on the listener), like so:
+```ruby
+class MyListener
+  #...
+
+  def self.sidekiq_schedule_options
+    { event_name: { perform_in: 5 } }
+  end
+
+  def self.event_name
+    #...
+  end
+
+  #...
+end
+```
+In both cases there is also available the `perform_at` option.
+
+## Running Specs
+
+Redis needs to be running. If you don't have an instance of redis on your machine, you can use the provided `docker-compose.yml`:
+
+```
+docker compose up -d
+```
+
+You also need to be running sidekiq via `scripts/sidekiq`:
+
+```
+scripts/sidekiq
+```
+
+Finally:
+
+```
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  redis:
+    image: 'redis:7-alpine'
+    ports:
+      - 6379:6379

data/lib/wisper/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  module Sidekiq
+    VERSION = "2.0.0"
+  end
+end

data/lib/wisper/sidekiq.rb

@@ -0,0 +1,70 @@
+require 'yaml'
+require 'wisper'
+require 'sidekiq'
+require 'wisper/sidekiq/version'
+
+module Wisper
+
+  # based on Sidekiq 4.x #delay method, which is not enabled by default in Sidekiq 5.x
+  # https://github.com/mperham/sidekiq/blob/4.x/lib/sidekiq/extensions/generic_proxy.rb
+  # https://github.com/mperham/sidekiq/blob/4.x/lib/sidekiq/extensions/class_methods.rb
+
+  class SidekiqBroadcaster
+    class Worker
+      include ::Sidekiq::Worker
+
+      def perform(yml)
+        (subscriber, event, args) =
+          if Psych::VERSION.to_i >= 4
+            ::YAML.unsafe_load(yml)
+          else
+            ::YAML.load(yml)
+          end
+        subscriber.public_send(event, *args)
+      end
+    end
+
+    def self.register
+      Wisper.configure do |config|
+        config.broadcaster :sidekiq, SidekiqBroadcaster.new
+        config.broadcaster :async,   SidekiqBroadcaster.new
+      end
+    end
+
+    def broadcast(subscriber, _publisher, event, *args, **_kwargs)
+      options = sidekiq_options(subscriber)
+      schedule_options = sidekiq_schedule_options(subscriber, event)
+
+      Worker.set(options).perform_in(
+        schedule_options.fetch(:delay, 0),
+        ::YAML.dump([subscriber, event, args])
+      )
+    end
+
+    private
+
+    def sidekiq_options(subscriber)
+      subscriber.respond_to?(:sidekiq_options) ? subscriber.sidekiq_options : {}
+    end
+
+    def sidekiq_schedule_options(subscriber, event)
+      return {} unless subscriber.respond_to?(:sidekiq_schedule_options)
+
+      options = subscriber.sidekiq_schedule_options
+
+      if options.has_key?(event.to_sym)
+        delay_option(options[event.to_sym])
+      else
+        delay_option(options)
+      end
+    end
+
+    def delay_option(options)
+      return {} unless options.key?(:perform_in) || options.key?(:perform_at)
+
+      { delay: options[:perform_in] || options[:perform_at] }
+    end
+  end
+end
+
+Wisper::SidekiqBroadcaster.register

data/scripts/sidekiq

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+bundle exec sidekiq --require ./spec/dummy_app/app.rb

data/spec/configuration_spec.rb

@@ -0,0 +1,13 @@
+require 'wisper/sidekiq'
+
+RSpec.describe 'configuration' do
+  let(:configuration) { Wisper.configuration }
+
+  it 'configures sidekiq as a broadcaster' do
+    expect(configuration.broadcasters).to include :sidekiq
+  end
+
+  it 'configures sidekiq as default async broadcaster' do
+    expect(configuration.broadcasters[:async]).to be_an_instance_of(Wisper::SidekiqBroadcaster)
+  end
+end

data/spec/dummy_app/app.rb

@@ -0,0 +1,4 @@
+# This is loaded by Sidekiq
+
+require 'wisper/sidekiq'
+require_relative 'subscriber'

data/spec/dummy_app/subscriber.rb

@@ -0,0 +1,8 @@
+class Subscriber
+  def self.it_happened(message)
+    File.open('/tmp/shared', 'w') do |file|
+      file.puts "pid: #{Process.pid}"
+      file.puts message.inspect
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,48 @@
+require 'wisper/sidekiq'
+
+require_relative 'dummy_app/app'
+require 'sidekiq/api'
+
+RSpec.describe 'integration tests:' do
+  let(:publisher) do
+    Class.new do
+      include Wisper::Publisher
+
+      def run
+        broadcast(:it_happened, { hello: 'world' })
+      end
+    end.new
+  end
+  let(:shared_content) { File.read('/tmp/shared') }
+
+  def ensure_sidekiq_was_running
+    Timeout.timeout(10) do
+      while !File.exist?('/tmp/shared')
+        sleep(0.1)
+      end
+    end
+  end
+
+  before do
+    Sidekiq::Testing.disable!
+    Sidekiq::Queue.new.clear
+    Sidekiq::RetrySet.new.clear
+    File.delete('/tmp/shared') if File.exist?('/tmp/shared')
+  end
+
+  it 'performs event in a different process' do
+    publisher.subscribe(Subscriber, async: Wisper::SidekiqBroadcaster.new)
+    publisher.run
+    ensure_sidekiq_was_running
+
+    expect(shared_content).not_to include("pid: #{Process.pid}\n")
+  end
+
+  it 'performs event' do
+    publisher.subscribe(Subscriber, async: Wisper::SidekiqBroadcaster.new)
+    publisher.run
+    ensure_sidekiq_was_running
+
+    expect(shared_content).to include('{:hello=>"world"}')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'sidekiq/testing'
+
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  YAML::ENGINE.yamler = 'psych'
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 0
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/wisper/sidekiq_broadcaster_spec.rb

@@ -0,0 +1,162 @@
+require 'wisper/sidekiq'
+
+RSpec.describe Wisper::SidekiqBroadcaster do
+  class PublisherUnderTest
+    include Wisper::Publisher
+
+    def run
+      broadcast(:it_happened)
+    end
+  end
+
+  class RegularSubscriberUnderTest
+    def self.it_happened(*_)
+    end
+  end
+
+  class CustomizedSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_options
+      { queue: "my_queue" }
+    end
+  end
+
+  class CustomizedScheduleInJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_in: 5 }
+    end
+  end
+
+  class CustomizedEventScheduleInJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { it_happened: { perform_in: 5 } }
+    end
+  end
+
+  class CustomizedScheduleAtJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_at: Time.now + 5 }
+    end
+  end
+
+  class CustomizedEventScheduleAtJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { it_happened: { perform_at: Time.now + 5 } }
+    end
+  end
+
+  class CustomizedBadScheduleInJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_in: 'not a number', delay: 5 }
+    end
+  end
+
+  class CustomizedBadDefaultScheduleInWithEventScheduleAtJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_in: 'not a number', delay: 5, it_happened: { perform_at: Time.now + 5 } }
+    end
+  end
+
+  let(:publisher) { PublisherUnderTest.new }
+
+  before { Sidekiq::Testing.fake! }
+  after { Sidekiq::Testing.disable! }
+
+  describe '#broadcast' do
+    it 'schedules a sidekiq job' do
+      publisher.subscribe(RegularSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["default"], :size).by(1)
+    end
+
+    it 'schedules to run in some time a sidekiq job' do
+      publisher.subscribe(CustomizedScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    it 'schedules to run in some time a sidekiq job for an event' do
+      publisher.subscribe(CustomizedEventScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    it 'schedules to run at some time a sidekiq job' do
+      publisher.subscribe(CustomizedEventScheduleAtJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    it 'schedules to run at some time a sidekiq job for an event' do
+      publisher.subscribe(CustomizedEventScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    it 'can respect custom sidekiq_options' do
+      publisher.subscribe(CustomizedSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["my_queue"], :size).by(1)
+    end
+
+    it 'schedules a sidekiq job with bad sidekiq_schedule_options' do
+      publisher.subscribe(CustomizedBadScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["default"], :size).by(1)
+      expect { publisher.run }
+        .not_to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }
+    end
+
+    it 'schedules a sidekiq job with bad sidekiq_schedule_options' do
+      publisher.subscribe(CustomizedBadDefaultScheduleInWithEventScheduleAtJobSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    context 'when provides subscriber with args' do
+      let(:subscriber) { RegularSubscriberUnderTest }
+      let(:event) { 'it_happened' }
+      let(:args) { [1,2,3] }
+
+      subject(:broadcast_event) { described_class.new.broadcast(subscriber, nil, event, *args) }
+
+      it 'subscriber receives event with corrects args' do
+        expect(RegularSubscriberUnderTest).to receive(event).with(*args)
+
+        Sidekiq::Testing.inline! { broadcast_event }
+      end
+    end
+  end
+end

data/wisper-sidekiq-compat.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/sidekiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper-sidekiq-compat"
+  spec.version       = Wisper::Sidekiq::VERSION
+  spec.authors       = ["Kris Leech", "Jamie Schembri"]
+  spec.email         = ["kris.leech@gmail.com", "jamie.schembri@nedap.com"]
+  spec.summary       = 'Async publishing for Wisper using Sidekiq'
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/nedap/wisper-sidekiq-compat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 3.0'
+  spec.add_dependency 'wisper-compat'
+  spec.add_dependency 'sidekiq', '>= 6.5', '< 7'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: wisper-sidekiq-compat
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Kris Leech
+- Jamie Schembri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper-compat
+  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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: Async publishing for Wisper using Sidekiq
+email:
+- kris.leech@gmail.com
+- jamie.schembri@nedap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/wisper/sidekiq.rb
+- lib/wisper/sidekiq/version.rb
+- scripts/sidekiq
+- spec/configuration_spec.rb
+- spec/dummy_app/app.rb
+- spec/dummy_app/subscriber.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/wisper/sidekiq_broadcaster_spec.rb
+- wisper-sidekiq-compat.gemspec
+homepage: https://github.com/nedap/wisper-sidekiq-compat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Async publishing for Wisper using Sidekiq
+test_files:
+- spec/configuration_spec.rb
+- spec/dummy_app/app.rb
+- spec/dummy_app/subscriber.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/wisper/sidekiq_broadcaster_spec.rb