sidekiq-bus 0.8.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c633c91c5b55a5e08ec80f73ee6a174df07d59c
-  data.tar.gz: '00095d6bcdc1407137cab9051990b91f359df304'
+SHA256:
+  metadata.gz: 866c59dd8c86269bcbf074c6f3ee4e4e4ec0e9de7f80535325a8716265166323
+  data.tar.gz: 77943838139481632a6647f133fa37e6970a7b4b1cbade052dbf480b46f4dea4
 SHA512:
-  metadata.gz: a4dcb3d6a379ceda40fe1da42c6cdb00662b85f37bbfcf9010ed7303883d8e44a9f43f9ab9c587793503ce4ade15a09f1c23cbdd6ec07ae5f4d85af0ce8ced04
-  data.tar.gz: 2631baff2bc6724686516f34cc04955fef78884228566f961b2f51dd069130bf67c65a562200299e833b241d8ed18c6e7a17636768bfd6310d318de1c8997c0f
+  metadata.gz: fecd3c6a09178d511def70fae49a6ca050288f40c02491a656a12f3f4b646fb4ff0386c7eb92d806675a1d734db3ec6c92b71f0718eae4f9b4077db2d002cc5a
+  data.tar.gz: 2632c35bc3e5c09b31d03b632796355dc16005e55bcd875956c4c0ed4b1083540c2744d4308fd8a18a880620cba744a352d7c1a698530f70157dad064422d8bf

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0] - 2025-05-13
+
+### Changed
+- [BREAKING] Updated sidekiq-scheduler to 4.0.3. This adds support for Redis 5 and Sidekiq 6, but removes support for Redis < 4.2 and Sidekiq < 4.X. The dropped versions are long out of support; please use this release to facilitate an update.
+
+## [0.9.0] - 2019-12-03
+
+### Added
+- Tab in sidekiq web ui for bus info
+
 ### [0.8.2] - 2019-08-06
 
 ### Fixed

data/lib/sidekiq-bus.rb

@@ -3,6 +3,7 @@
 require 'queue-bus'
 require 'sidekiq_bus/adapter'
 require 'sidekiq_bus/version'
+require 'sidekiq_bus/server'
 require 'sidekiq_bus/middleware/retry'
 
 module SidekiqBus

data/lib/sidekiq_bus/server/views/bus.erb

@@ -0,0 +1,202 @@
+
+<script LANGUAGE="JavaScript">
+<!--
+function confirmSubmit()
+{
+var agree=confirm("Are you sure you wish to continue?");
+if (agree)
+	return true ;
+else
+	return false ;
+}
+
+function setSample() {
+  var text = document.getElementById("query_attributes").textContent;
+  var textArea = document.getElementById('querytext');
+  textArea.value = text;
+  return false;
+}
+// -->
+</script>
+
+<%
+  app_hash = {}
+  class_hash = {}
+  event_hash = {}
+  query_string = params[:query].to_s.strip
+
+  query_attributes = nil
+  query_error = nil
+  if query_string.length > 0
+    begin
+      query_attributes = ::SidekiqBus::Server::Helpers.parse_query(query_string)
+      raise "Not a JSON Object" unless query_attributes.is_a?(Hash)
+    rescue Exception => e
+      query_attributes = nil
+      query_error = e.message
+    end
+
+    if query_attributes
+      # sort keys for display
+      query_attributes = ::SidekiqBus::Server::Helpers.sort_query(query_attributes)
+    end
+  end
+
+  # collect each differently
+  ::QueueBus::Application.all.each do |app|
+    app_key = app.app_key
+
+    subscriptions = ::SidekiqBus::Server::Helpers.query_subscriptions(app, query_attributes)
+    subscriptions.each do |sub|
+      class_name = sub.class_name
+      queue = sub.queue_name
+      filters = sub.matcher.filters
+      sub_key = sub.key
+
+      if filters["bus_event_type"]
+        event = filters["bus_event_type"]
+      else
+        event = "see filter"
+      end
+
+      app_hash[app_key] ||= []
+      app_hash[app_key] << [sub_key, event, class_name, queue, filters]
+
+      class_hash[class_name] ||= []
+      class_hash[class_name] << [app_key, sub_key, event, queue, filters]
+
+      event_hash[event] ||= []
+      event_hash[event] << [app_key, sub_key, class_name, queue, filters]
+    end
+  end
+
+  # sort each list item by secondary label
+  class_hash.each do |_, array|
+    array.sort!{ |a,b| a.first <=> b.first }
+  end
+  event_hash.each do |_, array|
+    array.sort!{ |a,b| a.first <=> b.first }
+  end
+
+  # helper to display either
+  def display_row(name, val, button=nil, first=false)
+    form = ""
+    if button
+      text, url = button
+      form = "<form method='POST' action='#{url}' style='float:left; padding:0 5px 0 0;margin:0;'>#{csrf_tag}<input type='submit' name='' value='#{h(text)}' style='padding:0;margin:0;' onclick=\"return confirmSubmit();\"/><input type='hidden' name='name' value='#{h(name)}' /></form>"
+    end
+
+    if !val
+      out = "<td>&nbsp;</td><td>&nbsp;</td>"
+    else
+      one, two, three, queue, filters = val
+      out = "<td>#{h(one)}</td><td>#{h(two)}</td><td>#{h(three)}</td><td><a href='#{"queues/#{queue}"}'>#{h(queue)}</a></td>"
+      out << "<td>#{h(::QueueBus::Util.encode(filters).gsub(/\"bus_special_value_(\w+)\"/){ "(#{$1})" }).gsub(" ", "&nbsp;").gsub('&quot;,&quot;', '&quot;, &quot;')}</td>"
+    end
+
+    if first
+      "<tr><td>#{h(name)}#{form}</td>#{out}</tr>\n"
+    else
+      "<tr><td>&nbsp;</td>#{out}</tr>\n"
+    end
+  end
+
+  def output_hash(hash, action=nil)
+    out = ""
+    hash.keys.sort.each do |item|
+      display = hash[item]
+      first = display.shift
+      out << display_row(item, first, action, true)
+      display.each do |val|
+        out << display_row(item, val, action)
+      end
+    end
+    out
+  end
+%>
+
+<h1 class='wi'>Sample Event</h1>
+<p class='intro'>Enter JSON of an event to see applicable subscriptions.</p>
+<div style="text-align: center;width:700px;">
+  -<form method="GET" action="<%= "bus" %>" style="float:none;padding:0;margin:0;">
+    <textarea id="querytext" name="query" style="padding: 10px;height:150px;width:700px;font-size:14px;font-family:monospace"><%=
+      h(query_string)
+    %></textarea>
+    <br/>
+    <button onclick="window.location.href = '<%= "bus" %>'; return false;">Clear</button>
+    <input type="submit" name="" value="Filter results to this event"/>
+  </form>
+</div>
+
+<% if query_error %>
+  <blockquote><pre style="text-align:left;font-family:monospace;margin:5px 0 5px 0;padding:10px;background:#f2dede;color:#a94442;"><code><%=
+  h(query_error.strip)
+  %></code></pre></blockquote>
+<% end %>
+<% if query_attributes %>
+  <blockquote><pre style="text-align:left;font-family:monospace;margin:5px 0 5px 0;padding:10px;background:#dff0d8;color:#3c763d;"><code id="query_attributes"><%=
+  h(JSON.pretty_generate(query_attributes).strip)
+  %></code></pre></blockquote>
+  <div style="text-align:right;">
+    <button onclick="return setSample();">Set Sample</button>
+  </div>
+<% end %>
+
+<hr/>
+
+<h1 class='wi'>Applications</h1>
+<p class='intro'>The apps below have registered the given classes and queues.</p>
+<table class='table-striped table-bordered'>
+  <thead class="thead-dark">
+  <tr>
+    <th>App Key</th>
+    <th>Subscription Key</th>
+    <th>Event Type</th>
+    <th>Class Name</th>
+    <th>Queue</th>
+    <th>Filters</th>
+  </tr>
+  </thead>
+
+  <%= output_hash(app_hash, query_attributes ? false : ["Unsubscribe", "bus/unsubscribe"]) %>
+</table>
+
+<p>&nbsp;</p>
+
+<h1 class='wi'>Events</h1>
+<p class='intro'>The events below have been registered by the given applications and queues.</p>
+
+<table class='table-striped table-bordered'>
+  <thead class="thead-dark">
+  <tr>
+    <th>Event Type</th>
+    <th>App Key</th>
+    <th>Subscription Key</th>
+    <th>Class Name</th>
+    <th>Queue</th>
+    <th>Filters</th>
+  </tr>
+  </thead>
+  <%= output_hash(event_hash, false) %>
+</table>
+
+
+
+<p>&nbsp;</p>
+
+<h1 class='wi'>Classes</h1>
+<p class='intro'>The classes below have been registered by the given applications and queues.</p>
+<table class='table-striped table-bordered'>
+  <thead class="thead-dark">
+  <tr>
+    <th>Class Name</th>
+    <th>App Key</th>
+    <th>Subscription Key</th>
+    <th>Event Type</th>
+    <th>Queue</th>
+    <th>Filters</th>
+  </tr>
+  </thead>
+  <%= output_hash(class_hash, false) %>
+</table>
+

data/lib/sidekiq_bus/server.rb

@@ -0,0 +1,139 @@
+require 'sidekiq/web'
+
+module SidekiqBus
+  module Server
+    def self.registered(app)
+      app.get('/bus') do
+        # you can define @instance_variables for passing into template
+        # Sidekiq uses erb for its templates so you should do it aswell
+        erb File.read(File.join(File.dirname(__FILE__), "server/views/bus.erb"))
+       end
+
+      app.post '/bus/unsubscribe' do
+        bus_app = ::QueueBus::Application.new(params[:name]).unsubscribe
+        redirect "#{root_path}bus"
+      end
+    end
+
+    class Helpers
+      class << self
+        def parse_query(query_string)
+          has_open_brace = query_string.include?("{")
+          has_close_brace = query_string.include?("}")
+          has_multiple_lines = query_string.include?("\n")
+          has_colon = query_string.include?(":")
+          has_comma = query_string.include?(",")
+          has_quote = query_string.include?("\"")
+
+          exception = nil
+
+          # first let's see if it parses
+          begin
+            query_attributes = JSON.parse(query_string)
+            raise "Not a JSON Object" unless query_attributes.is_a?(Hash)
+          rescue Exception => e
+            exception = e
+          end
+          return query_attributes unless exception
+
+          if query_attributes
+            # it parsed but it's something else
+            if query_attributes.is_a?(Array) && query_attributes.length == 1
+              # maybe it's the thing from the queue
+              json_string = query_attributes.first
+              fixed = JSON.parse(json_string) rescue nil
+              return fixed if fixed
+            end
+
+            # something else?
+            raise exception
+          end
+
+          if !has_open_brace && !has_close_brace
+            # maybe they just forgot the braces
+            fixed = JSON.parse("{ #{query_string} }") rescue nil
+            return fixed if fixed
+          end
+
+          if !has_open_brace
+            # maybe they just forgot the braces
+            fixed = JSON.parse("{ #{query_string}") rescue nil
+            return fixed if fixed
+          end
+
+          if !has_close_brace
+            # maybe they just forgot the braces
+            fixed = JSON.parse("#{query_string} }") rescue nil
+            return fixed if fixed
+          end
+
+          if !has_multiple_lines && !has_colon && !has_open_brace && !has_close_brace
+            # we say they just put a bus_event type here, so help them out
+            return {"bus_event_type" => query_string, "more_here" => true}
+          end
+
+          if has_colon && !has_quote
+            # maybe it's some search syntax like this: field: value other: true, etc
+            # maybe use something like this later: https://github.com/dxwcyber/search-query-parser
+
+            # quote all the strings, (simply) tries to avoid integers
+            test_query = query_string.gsub(/([a-zA-z]\w*)/,'"\0"')
+            if !has_comma
+              test_query.gsub!("\n", ",\n")
+            end
+            if !has_open_brace  && !has_close_brace
+              test_query = "{ #{test_query} }"
+            end
+
+            fixed = JSON.parse(test_query) rescue nil
+            return fixed if fixed
+          end
+
+          if has_open_brace && has_close_brace
+            # maybe the whole thing is a hash output from a hash.inspect log
+            ruby_hash_text = query_string.clone
+            # https://stackoverflow.com/questions/1667630/how-do-i-convert-a-string-object-into-a-hash-object
+            # Transform object string symbols to quoted strings
+            ruby_hash_text.gsub!(/([{,]\s*):([^>\s]+)\s*=>/, '\1"\2"=>')
+            # Transform object string numbers to quoted strings
+            ruby_hash_text.gsub!(/([{,]\s*)([0-9]+\.?[0-9]*)\s*=>/, '\1"\2"=>')
+            # Transform object value symbols to quotes strings
+            ruby_hash_text.gsub!(/([{,]\s*)(".+?"|[0-9]+\.?[0-9]*)\s*=>\s*:([^,}\s]+\s*)/, '\1\2=>"\3"')
+            # Transform array value symbols to quotes strings
+            ruby_hash_text.gsub!(/([\[,]\s*):([^,\]\s]+)/, '\1"\2"')
+            # fix up nil situation
+            ruby_hash_text.gsub!(/=>nil/, '=>null')
+            # Transform object string object value delimiter to colon delimiter
+            ruby_hash_text.gsub!(/([{,]\s*)(".+?"|[0-9]+\.?[0-9]*)\s*=>/, '\1\2:')
+            fixed = JSON.parse(ruby_hash_text) rescue nil
+            return fixed if fixed
+          end
+
+          raise exception
+        end
+
+        def sort_query(query_attributes)
+          query_attributes.each do |key, value|
+            if value.is_a?(Hash)
+              query_attributes[key] = sort_query(value)
+            end
+          end
+          query_attributes.sort_by { |key| key }.to_h
+        end
+
+        def query_subscriptions(app, query_attributes)
+          # TODO: all of this can move to method in queue-bus to replace event_display_tuples
+          if query_attributes
+            subscriptions = app.subscription_matches(query_attributes)
+          else
+            subscriptions = app.send(:subscriptions).all
+          end
+        end
+      end
+    end
+  end
+end
+
+Sidekiq::Web.register SidekiqBus::Server
+Sidekiq::Web.locales << File.expand_path(File.dirname(__FILE__) + "/web/locales")
+Sidekiq::Web.tabs['Bus'] = 'bus'

data/lib/sidekiq_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqBus
-  VERSION = '0.8.2'
+  VERSION = '1.0.0'
 end

data/sidekiq-bus.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency('queue-bus', ['>= 0.7', '< 1'])
   s.add_dependency('sidekiq', ['>= 3.0.0', '~> 5.0'])
-  s.add_dependency('sidekiq-scheduler', '~> 3.0')
+  s.add_dependency('sidekiq-scheduler', ['>= 3.0', '< 5.0'])
 
   s.add_development_dependency("rspec")
   s.add_development_dependency("fakeredis")

data/spec/adapter/integration_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require 'celluloid' if Sidekiq::VERSION < '4'
 require 'sidekiq/scheduled'
 
 describe 'Sidekiq Integration' do
@@ -88,22 +87,14 @@ describe 'Sidekiq Integration' do
       val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
       expect(val).to eq(nil) # nothing really added
 
-      if Sidekiq::VERSION < '4'
-        Sidekiq::Scheduled::Poller.new.poll
-      else
-        Sidekiq::Scheduled::Poller.new.enqueue
-      end
+      Sidekiq::Scheduled::Poller.new.enqueue
 
       val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
       expect(val).to eq(nil) # nothing added yet
 
       # process scheduler in future
       Timecop.freeze(worktime) do
-        if Sidekiq::VERSION < '4'
-          Sidekiq::Scheduled::Poller.new.poll
-        else
-          Sidekiq::Scheduled::Poller.new.enqueue
-        end
+        Sidekiq::Scheduled::Poller.new.enqueue
 
         val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
         hash = JSON.parse(val)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-bus
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian Leonard
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: queue-bus
@@ -54,16 +53,22 @@ dependencies:
   name: sidekiq-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -171,11 +176,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rbenv-version"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -184,6 +186,8 @@ files:
 - lib/sidekiq-bus.rb
 - lib/sidekiq_bus/adapter.rb
 - lib/sidekiq_bus/middleware/retry.rb
+- lib/sidekiq_bus/server.rb
+- lib/sidekiq_bus/server/views/bus.erb
 - lib/sidekiq_bus/tasks.rb
 - lib/sidekiq_bus/version.rb
 - sidekiq-bus.gemspec
@@ -209,7 +213,6 @@ files:
 homepage: https://github.com/queue-bus/sidekiq-bus
 licenses: []
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -224,9 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.6.6
 specification_version: 4
 summary: A simple event bus on top of Sidekiq
 test_files:

data/.rbenv-version

@@ -1 +0,0 @@
-2.3.4

data/.ruby-gemset

@@ -1,2 +0,0 @@
-sidekiq-bus
-

data/.ruby-version

@@ -1 +0,0 @@
-2.3.4