sidekiq_admin_enquerer 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d94014f28e2cfa95c707791723fd3017c8e8f5f76c932bcd6790c506534b4d1
-  data.tar.gz: d4b101bbe38bfd603e1f920ece7f3acb0390ff244283c3d3af97313a62871d33
+  metadata.gz: 90f5930895e062f99665e5740778c3e658a2b5f15f9c1831715383b8471ae098
+  data.tar.gz: d405c2ee9b8f34e89a2f059f32765dbe7592cd8bd7db75916b04cf915c47c0c2
 SHA512:
-  metadata.gz: 84a0a8b2de2e53fa1bb448fe083f38cee28c3834d4dd812ee8784130143ffc576bf3ca520c543638b4673b51ae8e6a19af350d65bdf2da107082eb87448e995f
-  data.tar.gz: 793eff5d1198b815b9dc29d4edcc1370bdf0e21f929a508ad48c52937891e2c5540eed0321956c201d29bc7beafabfafdb3ca26e9839ed316554ad8c14939c17
+  metadata.gz: 9c0d22153004c8e1133bd48e21f857d7fe085dbaad06557efea53acafed02caab4ae0066b6394f6b1c4dd2cdf2bbe8ff2dd400cdab9df1b1523853dd3d78b9bc
+  data.tar.gz: 63449fc65d48d4d5e83d9bbd82e87b5da352c920d592f3e3ef8ebbc1a37c9af0d4fa495e62a32449632452593b101f67283616df6ee9b580549f6482c7c942c6

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [0.0.0] - 2023-06-05
+## [0.1.0] - 2023-07-09
+
+- Prototype;
+
+## [0.0.0] - 2023-07-05
 
 - RubyGems-placement release;

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq_admin_enquerer (0.0.0)
+    sidekiq_admin_enquerer (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -8,6 +8,12 @@
 - [License](#license)
 - [Authors](#authors)
 
+# TODO:
+
+- interactive UI tabs for each performing method (sidekiq's UI has no jquery and bootstrap-js integrations);
+- job invocation rework (support for kwarg invocation and analysis of passed attributes);
+- specs;
+
 ## Installation
 
 ```ruby
@@ -26,6 +32,18 @@ require 'sidekiq_admin_enquerer'
 
 ## Usage
 
+- it is assumed that you are using `Rails`;
+
+```ruby
+# config/initializers/sidekiq.rb
+
+# ...your sidekiq configs...
+
+SidekiqAdminEnqueuer.load
+```
+
+- navigate to `/your-sidekiq-path/enqueuer`
+
 ---
 
 ## Development

data/lib/sidekiq_admin_enquerer/pages/job.erb

@@ -0,0 +1,34 @@
+<h3>Enqueue Job</h3>
+
+<!-- TODO: add interactive tabs (for each performing method) -->
+<!-- NOTE: sidekiq's UI has no jquery and bootstrap-js integrations -->
+
+<% @job.methods.each do |job_method| %>
+  <div class="form-group"><%= job_method.name %></div>
+  <form method="post" action="<%= side_enq__enqueue_job_path %>">
+    <%= csrf_tag if respond_to?(:csrf_tag) %>
+    <input class="form-control" name="perform_method" value="<%= job_method.name %>" readonly />
+    <input class="form-control" name="job_name" value="<%= @job.name %>" readonly />
+    <% job_method.params.each do |job_param| %>
+      <div class="form-group">
+        <label for="<%= job_method.name %>[<%= job_param.name %>]">
+          <b><%= side_enq__param_requirement(job_param) %></b>: <%= job_param.name %>
+        </label>
+        <input class="form-control" name="<%= job_method.name %>[<%= job_param.name %>]" />
+      </div>
+    <% end %>
+
+    <div class="form-group">
+      <input type="submit" class="btn btn-danger" name="submit" value="enqueue" />
+    </div>
+
+    <div class="form-group">
+      <label for="enqueue_in">Schedule</label>
+      <input class="form-control" name="enqueue_in" placeholder="in seconds" />
+    </div>
+
+    <input type="submit" class="btn btn-danger" name="submit" value="schedule" />
+  </form>
+
+  <hr />
+<% end %>

data/lib/sidekiq_admin_enquerer/pages/jobs.erb

@@ -0,0 +1,27 @@
+<h3>Jobs</h3>
+<table class="table table-hover table-bordered table-striped">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Method Parameters</th>
+      <th>Actions</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @jobs.each do |job| %>
+      <tr>
+        <td><%= job.name %></td>
+        <td>
+          <% job.methods.each do |job_method| %>
+            <div><b><%= job_method.name %></b>: <%= side_enq__method_params(job_method) %></div>
+          <% end %>
+        </td>
+        <td>
+          <a class="btn btn-danger btn-xs" href="<%= side_enq__enqueue_path(job) %>">
+            Enqueue
+          </a>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/sidekiq_admin_enquerer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqAdminEnquerer
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/lib/sidekiq_admin_enquerer/web_app/app_control.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SidekiqAdminEnquerer::WebApp
+  # @api private
+  # @since 0.1.0
+  module AppControl
+    class << self
+      # @return [Array<SidekiqAdminEnquerer::WebApp::JobWrapper>]
+      #
+      # @api private
+      # @since 0.1.0
+      def jobs
+        SidekiqAdminEnquerer.jobs.map { JobWrapper.new(_1) }
+      end
+
+      # @param job_name [String]
+      # @return [SidekiqAdminEnquerer::WebApp::JobWrapper]
+      #
+      # @api private
+      # @since 0.1.0
+      def find_job(job_name)
+        SidekiqAdminEnquerer.find_job(job_name).yield_self { JobWrapper.new(_1) }
+      end
+
+      # @param job_run_params [Hash<Symbol,Any>]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.1.0
+      def run_job(job_run_params)
+        job_name = job_run_params[:job_name]
+        job_klass = SidekiqAdminEnquerer.find_job(job_name)
+        SidekiqAdminEnquerer.run_job(job_klass, job_run_params)
+      end
+    end
+  end
+end

data/lib/sidekiq_admin_enquerer/web_app/job_method_wrapper.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SidekiqAdminEnquerer::WebApp::JobMethodWrapper
+  # @return [Array<Symbol>]
+  #
+  # @api private
+  # @since 0.1.0
+  JOB_INVOCATION_METHODS = %i[
+    perform
+    perform_in
+    perform_async
+    perform_at
+  ].freeze
+
+  class << self
+    # @param job [Class<ActiveJob::Base>, Class<Sidekiq::Worker]
+    # @return [Array<SidekiqAdminEnquerer::WebApp::JobMethodWrapper>]
+    #
+    # @api private
+    # @since 0.1.0
+    def extract_methods_from(job)
+      job.instance_methods.select do |method|
+        JOB_INVOCATION_METHODS.include?(method)
+      end.each_with_object([]) do |method, aggregate|
+        parameters = job.instance_method(method).parameters.map do |(req, name)|
+          SidekiqAdminEnquerer::WebApp::JobParamWrapper.new(job, method, name, req)
+        end # => Array<JobParamWrapper>
+        aggregate << new(job, method, parameters) # => JobMethodWrapper
+      end
+    end
+  end
+
+  # @return [Class<ActiveJob::Base>, Class<Sidekiq::Worker>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :job
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :name
+
+  # @return [Array<SidekiqAdminEnquerer::WebApp::JobParamWrapper>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :params
+
+  # @param job [Class<ActiveJob::Base>, Class<Sidekiq::Worker>]
+  # @param name [Symbol]
+  # @param params [Array<SidekiqAdminEnquerer::WebApp::JobParamWrapper>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(job, name, params)
+    @job = job
+    @name = name
+    @params = params
+  end
+end

data/lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SidekiqAdminEnquerer::WebApp::JobParamWrapper
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :name
+
+  # @return [Class<ActiveJob::Base>, Class<Sidekiq::Worker>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :job
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :req
+
+  # @param job [Class<ActiveJob::Base>, Class<Sidekiq::Worker>]
+  # @param method [Symbol]
+  # @param name [Symbol]
+  # @param req [Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(job, method, name, req)
+    @job = job
+    @name = name
+    @req = req
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def optional?
+    req == :key || req == :opt
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def required?
+    req == :keyreq || req == :req
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def kwarg_attr?
+    req == :key || req == :keyreq
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def named_attr?
+    req == :opt || req == :req
+  end
+end

data/lib/sidekiq_admin_enquerer/web_app/job_wrapper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SidekiqAdminEnquerer::WebApp::JobWrapper
+  # @return [Array<SidekiqAdminEnquerer::WebApp::JobMethodWrapper>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :methods
+
+  # @param job [Class<ActiveJob::Base>, Class<Sidekiq::Worker>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(job)
+    @job = job
+    @methods = SidekiqAdminEnquerer::WebApp::JobMethodWrapper.extract_methods_from(job)
+  end
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def name
+    job.name
+  end
+
+  private
+
+  # @return [Class<ActiveJob::Base>, Class<Sidekiq::Worker>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :job
+end

data/lib/sidekiq_admin_enquerer/web_app/web_helpers.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SidekiqAdminEnquerer::WebApp::WebHelpers
+  # @param job [SidekiqAdminEnquerer::WebApp::JobWrapper]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def side_enq__enqueue_path(job)
+    "#{root_path}enqueuer/#{job.name}"
+  end
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def side_enq__enqueue_job_path
+    "#{root_path}enqueuer"
+  end
+
+  # @param job_method [SidekiqAdminEnquerer::WebApp::JobMethodWrapper]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def side_enq__method_params(job_method)
+    job_method.params.map(&:name).join(', ')
+  end
+
+  # @param job_param [SidekiqAdminEnquerer::WebApp::JobParamWrapper]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  def side_enq__param_requirement(job_param)
+    job_param.required? ? 'required' : 'optional'
+  end
+end

data/lib/sidekiq_admin_enquerer/web_app.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SidekiqAdminEnquerer::WebApp
+  require_relative 'web_app/web_helpers'
+  require_relative 'web_app/job_param_wrapper'
+  require_relative 'web_app/job_method_wrapper'
+  require_relative 'web_app/job_wrapper'
+  require_relative 'web_app/app_control'
+
+  # @return [Hash<Symbol,String>]
+  #
+  # @api private
+  # @since 0.1.0
+  TEMPLATES = {
+    jobs: File.read(File.join(File.expand_path(__dir__), 'pages', 'jobs.erb')),
+    job: File.read(File.join(File.expand_path(__dir__), 'pages', 'job.erb'))
+  }.freeze
+
+  class << self
+    # @param app [?]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def registered(app)
+      app.helpers(WebHelpers)
+
+      app.get('/enqueuer') do
+        @jobs = AppControl.jobs
+        render(:erb, TEMPLATES[:jobs])
+      end
+
+      app.get('/enqueuer/:job_name') do
+        @job = AppControl.find_job(params[:job_name])
+        render(:erb, TEMPLATES[:job])
+      end
+
+      app.post('/enqueuer') do
+        AppControl.run_job(params)
+        redirect File.join(root_path, 'enqueuer')
+      end
+    end
+  end
+end

data/lib/sidekiq_admin_enquerer.rb

@@ -1,5 +1,89 @@
 # frozen_string_literal: true
 
+# @api public
+# @since 0.1.0
 module SidekiqAdminEnquerer
   require_relative 'sidekiq_admin_enquerer/version'
+  require_relative 'sidekiq_admin_enquerer/web_app'
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  JOB_SKIP_LIST = %w[
+    Sidekiq::Extensions::DelayedModel
+    Sidekiq::Extensions::DelayedMailer
+    Sidekiq::Extensions::DelayedClass
+    ApplicationJob
+    ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper
+  ].freeze
+
+  class << self
+    # @return [Array<Class<ActiveJob::Base>,Class<Sidekiq::Worker>>]
+    #
+    # @api private
+    # @since 0.1.0
+    def jobs
+      Rails.application.eager_load!
+
+      ObjectSpace.each_object(Class).select do |job_klass|
+        next if job_klass.singleton_class?
+        next if JOB_SKIP_LIST.any? { job_klass.to_s.include?(_1) }
+        job_klass < ActiveJob::Base || job_klass.included_modules.include?(Sidekiq::Worker)
+      end
+    end
+
+    # @param job_name [String]
+    # @return [Class<ActiveJob::Base>,Class<Sidekiq::Worker>]
+    #
+    # @api private
+    # @since 0.1.0
+    def find_job(job_name)
+      jobs.find { _1.name == job_name || _1.to_s == job_name }
+    end
+
+    # @param job [?]
+    # @param params [?]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    # rubocop:disable Metrics/AbcSize
+    def run_job(job, params)
+      # TODO: rework with attribute analysis
+      job_perform_method = params['perform_method']
+      job_params = params[job_perform_method]
+      job.respond_to?(:sidekiq_options) ? job.sidekiq_options['queue'].to_s : 'default'
+
+      if params['submit'] == 'enqueue'
+        case
+        when job < ActiveJob::Base
+          job.perform_later(*job_params.values)
+        when job_klass.included_modules.include?(Sidekiq::Worker)
+          Sidekiq::Client.enqueue_to(queue, job, *job_params.values)
+        end
+      elsif params['submit'] == 'schedule'
+        case
+        when job < ActiveJob::Base
+          job.set(wait: params['enqueue_in'].to_i.seconds).perform_later(*job_params.values)
+        when job_klass.included_modules.include?(Sidekiq::Worker)
+          Sidekiq::Client.enqueue_to_in(
+            queue, params['enqueue_in'].to_i.seconds, job, *job_params.values
+          )
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # @return [void]
+    #
+    # @api public
+    # @since 0.1.0
+    def load
+      if defined?(Sidekiq::Web)
+        Sidekiq::Web.register(SidekiqAdminEnquerer::WebApp)
+        Sidekiq::Web.tabs['Enqueuer'] = 'enqueuer'
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_admin_enquerer
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,7 +114,15 @@ files:
 - bin/console
 - bin/setup
 - lib/sidekiq_admin_enquerer.rb
+- lib/sidekiq_admin_enquerer/pages/job.erb
+- lib/sidekiq_admin_enquerer/pages/jobs.erb
 - lib/sidekiq_admin_enquerer/version.rb
+- lib/sidekiq_admin_enquerer/web_app.rb
+- lib/sidekiq_admin_enquerer/web_app/app_control.rb
+- lib/sidekiq_admin_enquerer/web_app/job_method_wrapper.rb
+- lib/sidekiq_admin_enquerer/web_app/job_param_wrapper.rb
+- lib/sidekiq_admin_enquerer/web_app/job_wrapper.rb
+- lib/sidekiq_admin_enquerer/web_app/web_helpers.rb
 - sidekiq_admin_enquerer.gemspec
 homepage: https://github.com/0exp/sidekiq_admin_enquerer
 licenses: