RubyGems - jobs_dashboard - Versions diffs - 0.3.4 - Mend

jobs_dashboard 0.3.4

Files changed (62) hide show

checksums.yaml +7 -0
data/.github/workflows/gem-push.yml +34 -0
data/.gitignore +12 -0
data/.rspec +3 -0
data/CHANGELOG.md +60 -0
data/Gemfile +10 -0
data/Gemfile.lock +129 -0
data/LICENSE.txt +21 -0
data/README.md +133 -0
data/Rakefile +8 -0
data/app/assets/stylesheets/jobs_dashboard/application.scss +214 -0
data/app/assets/stylesheets/jobs_dashboard/modules/buttons.sass +15 -0
data/app/assets/stylesheets/jobs_dashboard/modules/card.sass +22 -0
data/app/assets/stylesheets/jobs_dashboard/modules/description.sass +17 -0
data/app/assets/stylesheets/jobs_dashboard/modules/grid.sass +17 -0
data/app/assets/stylesheets/jobs_dashboard/modules/inputs.sass +31 -0
data/app/assets/stylesheets/jobs_dashboard/modules/item-list.sass +10 -0
data/app/assets/stylesheets/jobs_dashboard/modules/labels.sass +12 -0
data/app/assets/stylesheets/jobs_dashboard/modules/statistics.sass +15 -0
data/app/assets/stylesheets/jobs_dashboard/modules/table.sass +38 -0
data/app/assets/stylesheets/jobs_dashboard/pages/jobs_logs/show.sass +36 -0
data/app/assets/stylesheets/jobs_dashboard/reset.scss +135 -0
data/app/assets/stylesheets/jobs_dashboard/variables.sass +6 -0
data/app/controllers/jobs_dashboard/application_controller.rb +20 -0
data/app/controllers/jobs_dashboard/dashboard_controller.rb +12 -0
data/app/controllers/jobs_dashboard/job_logs_controller.rb +17 -0
data/app/helpers/jobs_dashboard/application_helper.rb +31 -0
data/app/models/jobs_dashboard/application_record.rb +5 -0
data/app/models/jobs_dashboard/job_log.rb +32 -0
data/app/views/jobs_dashboard/dashboard/_job_row.slim +8 -0
data/app/views/jobs_dashboard/dashboard/index.slim +40 -0
data/app/views/jobs_dashboard/job_logs/_stats.html.erb +0 -0
data/app/views/jobs_dashboard/job_logs/index.slim +84 -0
data/app/views/jobs_dashboard/job_logs/show.slim +89 -0
data/app/views/kaminari/jobs_dashboard/_first_page.html.erb +11 -0
data/app/views/kaminari/jobs_dashboard/_gap.html.erb +8 -0
data/app/views/kaminari/jobs_dashboard/_last_page.html.erb +11 -0
data/app/views/kaminari/jobs_dashboard/_next_page.html.erb +11 -0
data/app/views/kaminari/jobs_dashboard/_page.html.erb +12 -0
data/app/views/kaminari/jobs_dashboard/_paginator.html.erb +25 -0
data/app/views/kaminari/jobs_dashboard/_prev_page.html.erb +11 -0
data/app/views/layouts/jobs_dashboard/application.html.erb +15 -0
data/app/views/shared/_logo.slim +4 -0
data/app/views/shared/_navigation.slim +12 -0
data/bin/console +15 -0
data/bin/setup +8 -0
data/config/initializers/ransack.rb +11 -0
data/config/locales/default.fr.yml +219 -0
data/config/locales/jobs_dashboard.en.yml +33 -0
data/config/locales/jobs_dashboard.fr.yml +37 -0
data/config/routes.rb +5 -0
data/jobs_dashboard.gemspec +38 -0
data/lib/generators/active_record/job_log_migration_generator.rb +24 -0
data/lib/generators/active_record/templates/migration.rb +20 -0
data/lib/jobs_dashboard/client_middleware.rb +56 -0
data/lib/jobs_dashboard/engine.rb +18 -0
data/lib/jobs_dashboard/server_middleware.rb +62 -0
data/lib/jobs_dashboard/storage.rb +54 -0
data/lib/jobs_dashboard/version.rb +5 -0
data/lib/jobs_dashboard/worker.rb +25 -0
data/lib/jobs_dashboard.rb +12 -0
metadata +161 -0

data/app/views/kaminari/jobs_dashboard/_last_page.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<%# Link to the "Last" page
+  - available local variables
+    url:           url to the last page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="last">
+  <%= link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote %>
+</span>

data/app/views/kaminari/jobs_dashboard/_next_page.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="next">
+  <%= link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote %>
+</span>

data/app/views/kaminari/jobs_dashboard/_page.html.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page<%= ' current' if page.current? %>">
+  <%= link_to_unless page.current?, page, url, {remote: remote, rel: page.rel} %>
+</span>

data/app/views/kaminari/jobs_dashboard/_paginator.html.erb ADDED Viewed

@@ -0,0 +1,25 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%= paginator.render do -%>
+  <nav class="pagination" role="navigation" aria-label="pager">
+    <%= first_page_tag unless current_page.first? %>
+    <%= prev_page_tag unless current_page.first? %>
+    <% each_page do |page| -%>
+      <% if page.display_tag? -%>
+        <%= page_tag page %>
+      <% elsif !page.was_truncated? -%>
+        <%= gap_tag %>
+      <% end -%>
+    <% end -%>
+    <% unless current_page.out_of_range? %>
+      <%= next_page_tag unless current_page.last? %>
+      <%= last_page_tag unless current_page.last? %>
+    <% end %>
+  </nav>
+<% end -%>

data/app/views/kaminari/jobs_dashboard/_prev_page.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="prev">
+  <%= link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote %>
+</span>

data/app/views/layouts/jobs_dashboard/application.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+  <html>
+  <head>
+    <title>Jobs dashboard</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag "jobs_dashboard/application", media: "all" %>
+  </head>
+  <body class="<%= controller_name %>-<%= action_name %>">
+    <%= render partial: 'shared/navigation' %>
+    <div class="layout-content">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/app/views/shared/_logo.slim ADDED Viewed

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
+  <!--! Font Awesome Pro 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. --><
+  defs><style>.fa-secondary{opacity:.4}</style></>
+  <path class="fa-primary" d="M112 192c0-35.3 28.7-64 64-64H336c35.3 0 64 28.7 64 64V384c0 35.3-28.7 64-64 64H176c-35.3 0-64-28.7-64-64V192zm48 24v80c0 13.3 10.7 24 24 24H328c13.3 0 24-10.7 24-24V216c0-13.3-10.7-24-24-24H184c-13.3 0-24 10.7-24 24zm96 200a32 32 0 1 0 0-64 32 32 0 1 0 0 64z"/><path class="fa-secondary" d="M256 0C114.6 0 0 114.6 0 256V448c0 35.3 28.7 64 64 64h41.4l64.3-64.3C137.3 444.5 112 417.2 112 384V192c0-35.3 28.7-64 64-64H336c35.3 0 64 28.7 64 64V384c0 33.2-25.3 60.5-57.7 63.7L406.6 512H448c35.3 0 64-28.7 64-64V256C512 114.6 397.4 0 256 0zM361.4 512l-64-64H214.6l-64 64H361.4zM160 216v80c0 13.3 10.7 24 24 24H328c13.3 0 24-10.7 24-24V216c0-13.3-10.7-24-24-24H184c-13.3 0-24 10.7-24 24z"/></svg>

data/app/views/shared/_navigation.slim ADDED Viewed

@@ -0,0 +1,12 @@
+.navbar
+  .nav-wrapper
+    .logo
+      = render 'shared/logo'
+    ul.nav
+      li.nav-item class="#{'active' if current_page?(root_path)}"
+        = link_to t(:'jobs_dashboard.menu.dashboard'), root_path
+      li.nav-item class="#{'active' if params[:controller] == 'jobs_dashboard/job_logs'}"
+        = link_to t(:'jobs_dashboard.menu.logs'), job_logs_path
+  header.title-wrapper
+    h1
+      = @title || t(:"jobs_dashboard.#{controller.controller_name}.#{controller.action_name}.title")

data/bin/console ADDED Viewed

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require "bundler/setup"
+require "jobs_dashboard"
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+require "irb"
+IRB.start(__FILE__)

data/bin/setup ADDED Viewed

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle install
+# Do any other automated setup that you need to do here

data/config/initializers/ransack.rb ADDED Viewed

@@ -0,0 +1,11 @@
+Ransack.configure do |config|
+  config.add_predicate 'dategteq',
+    arel_predicate: 'gteq',
+    formatter: proc { |v| v.beginning_of_day },
+    type: :date
+  config.add_predicate 'datelteq',
+    arel_predicate: 'lteq',
+    formatter: proc { |v| v.end_of_day },
+    type: :date
+end

data/config/locales/default.fr.yml ADDED Viewed

@@ -0,0 +1,219 @@
+---
+fr:
+  activerecord:
+    errors:
+      messages:
+        record_invalid: 'La validation a échoué : %{errors}'
+        restrict_dependent_destroy:
+          has_one: Vous ne pouvez pas supprimer l'enregistrement car un(e) %{record}
+            dépendant(e) existe
+          has_many: Vous ne pouvez pas supprimer l'enregistrement parce que les %{record}
+            dépendants existent
+  date:
+    abbr_day_names:
+    - dim
+    - lun
+    - mar
+    - mer
+    - jeu
+    - ven
+    - sam
+    abbr_month_names:
+    -
+    - jan.
+    - fév.
+    - mar.
+    - avr.
+    - mai
+    - juin
+    - juil.
+    - août
+    - sept.
+    - oct.
+    - nov.
+    - déc.
+    day_names:
+    - dimanche
+    - lundi
+    - mardi
+    - mercredi
+    - jeudi
+    - vendredi
+    - samedi
+    formats:
+      default: "%d/%m/%Y"
+      long: "%e %B %Y"
+      short: "%e %b"
+    month_names:
+    -
+    - janvier
+    - février
+    - mars
+    - avril
+    - mai
+    - juin
+    - juillet
+    - août
+    - septembre
+    - octobre
+    - novembre
+    - décembre
+    order:
+    - :day
+    - :month
+    - :year
+  datetime:
+    distance_in_words:
+      about_x_hours:
+        one: environ une heure
+        other: environ %{count} heures
+      about_x_months:
+        one: environ un mois
+        other: environ %{count} mois
+      about_x_years:
+        one: environ un an
+        other: environ %{count} ans
+      almost_x_years:
+        one: presqu'un an
+        other: presque %{count} ans
+      half_a_minute: une demi‑minute
+      less_than_x_seconds:
+        zero: moins d'une seconde
+        one: moins d'une seconde
+        other: moins de %{count} secondes
+      less_than_x_minutes:
+        zero: moins d'une minute
+        one: moins d'une minute
+        other: moins de %{count} minutes
+      over_x_years:
+        one: plus d'un an
+        other: plus de %{count} ans
+      x_seconds:
+        one: 1 seconde
+        other: "%{count} secondes"
+      x_minutes:
+        one: 1 minute
+        other: "%{count} minutes"
+      x_days:
+        one: 1 jour
+        other: "%{count} jours"
+      x_months:
+        one: 1 mois
+        other: "%{count} mois"
+      x_years:
+        one: 1 an
+        other: "%{count} ans"
+    prompts:
+      second: Seconde
+      minute: Minute
+      hour: Heure
+      day: Jour
+      month: Mois
+      year: Année
+  errors:
+    format: "%{attribute} %{message}"
+    messages:
+      accepted: doit être accepté(e)
+      blank: doit être rempli(e)
+      confirmation: ne concorde pas avec %{attribute}
+      empty: doit être rempli(e)
+      equal_to: doit être égal à %{count}
+      even: doit être pair
+      exclusion: n'est pas disponible
+      greater_than: doit être supérieur à %{count}
+      greater_than_or_equal_to: doit être supérieur ou égal à %{count}
+      inclusion: n'est pas inclus(e) dans la liste
+      invalid: n'est pas valide
+      less_than: doit être inférieur à %{count}
+      less_than_or_equal_to: doit être inférieur ou égal à %{count}
+      model_invalid: 'Validation échouée : %{errors}'
+      not_a_number: n'est pas un nombre
+      not_an_integer: doit être un nombre entier
+      odd: doit être impair
+      other_than: doit être différent de %{count}
+      present: doit être vide
+      required: doit exister
+      taken: est déjà utilisé(e)
+      too_long:
+        one: est trop long (pas plus d'un caractère)
+        other: est trop long (pas plus de %{count} caractères)
+      too_short:
+        one: est trop court (au moins un caractère)
+        other: est trop court (au moins %{count} caractères)
+      wrong_length:
+        one: ne fait pas la bonne longueur (doit comporter un seul caractère)
+        other: ne fait pas la bonne longueur (doit comporter %{count} caractères)
+    template:
+      body: 'Veuillez vérifier les champs suivants : '
+      header:
+        one: 'Impossible d''enregistrer ce(tte) %{model} : 1 erreur'
+        other: 'Impossible d''enregistrer ce(tte) %{model} : %{count} erreurs'
+  helpers:
+    select:
+      prompt: Veuillez sélectionner
+    submit:
+      create: Créer un(e) %{model}
+      submit: Enregistrer ce(tte) %{model}
+      update: Modifier ce(tte) %{model}
+  number:
+    currency:
+      format:
+        delimiter: " "
+        format: "%n %u"
+        precision: 2
+        separator: ","
+        significant: false
+        strip_insignificant_zeros: false
+        unit: "€"
+    format:
+      delimiter: " "
+      precision: 3
+      separator: ","
+      significant: false
+      strip_insignificant_zeros: false
+    human:
+      decimal_units:
+        format: "%n %u"
+        units:
+          billion: milliard
+          million: million
+          quadrillion: million de milliards
+          thousand: millier
+          trillion: billion
+          unit: ''
+      format:
+        delimiter: ''
+        precision: 3
+        significant: true
+        strip_insignificant_zeros: true
+      storage_units:
+        format: "%n %u"
+        units:
+          byte:
+            one: octet
+            other: octets
+          eb: Eo
+          gb: Go
+          kb: ko
+          mb: Mo
+          pb: Po
+          tb: To
+    percentage:
+      format:
+        delimiter: ''
+        format: "%n%"
+    precision:
+      format:
+        delimiter: ''
+  support:
+    array:
+      last_word_connector: " et "
+      two_words_connector: " et "
+      words_connector: ", "
+  time:
+    am: am
+    formats:
+      default: "%d %B %Y %Hh %Mmin %Ss"
+      long: "%A %d %B %Y %Hh%M"
+      short: "%d %b %Hh%M"
+    pm: pm

data/config/locales/jobs_dashboard.en.yml ADDED Viewed

@@ -0,0 +1,33 @@
+en:
+  form:
+    select:
+      all: All
+  jobs_dashboard:
+    dashboard:
+      index:
+        title: Dashboard
+    statuses:
+      complete: Complete
+      queued: Queued
+      failed: Failed
+      interrupted: Interrupted
+      retrying: Retrying
+      working: Working
+    menu:
+      dashboard: Dashboard
+      logs: Logs
+    table:
+      headers:
+        finished_at: Finished at
+        created_at: Created at
+        job: Job
+        sidekiq_jid: Sidekiq ID
+        queue: Queue
+        status: Status
+    sentences:
+      clear_filters: Clear filters
+      no_ongoing_jobs: No ongoing jobs
+      no_awaiting_jobs: No awaiting jobs
+    words:
+      to: to
+      submit: 'Apply filters'

data/config/locales/jobs_dashboard.fr.yml ADDED Viewed

@@ -0,0 +1,37 @@
+fr:
+  form:
+    select:
+      all: Tout
+  jobs_dashboard:
+    job_logs:
+      index:
+        title: Job logs
+    dashboard:
+      index:
+        title: Dashboard
+    statuses:
+      complete: Terminé
+      queued: En attente
+      failed: Échoué
+      interrupted: Interrompu
+      retrying: Nouvelle tentative
+      working: En cours
+    menu:
+      dashboard: Dashboard
+      logs: Job logs
+    table:
+      headers:
+        finished_at: Terminé le
+        created_at: Créé le
+        item_type: Job
+        job_id: Sidekiq ID
+        sidekiq_jid: Sidekiq ID
+        queue: File
+        status: Statut
+    sentences:
+      clear_filters: Supprimer les filtres
+      no_ongoing_jobs: Aucun job en cours
+      no_awaiting_jobs: Aucun job en attente
+    words:
+      to: au
+      submit: 'Filtrer'

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,5 @@
+JobsDashboard::Engine.routes.draw do
+  root 'dashboard#index'
+  resources :job_logs
+end

data/jobs_dashboard.gemspec ADDED Viewed

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require_relative "lib/jobs_dashboard/version"
+Gem::Specification.new do |spec|
+  spec.name          = "jobs_dashboard"
+  spec.version       = JobsDashboard::VERSION
+  spec.authors       = ["Patryk"]
+  spec.email         = ["patryk@9troisquarts.com"]
+  spec.summary       = "Sidekiq jobs dashboard"
+  spec.homepage      = "https://github.com/9troisquarts/jobs_dashboard"
+  spec.license       = "MIT"
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/9troisquarts/jobs_dashboard"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'sidekiq', '>= 6.0'
+  spec.add_dependency 'kaminari'
+  spec.add_dependency 'slim-rails'
+  spec.add_dependency 'ransack'
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/generators/active_record/job_log_migration_generator.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'rails/generators/active_record'
+module ActiveRecord
+  module Generators
+    class JobLogMigrationGenerator < Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :name, :type => :string, :default => "add_job_logs_table"
+      def create_migration_file
+        migration_template "migration.rb", "db/migrate/#{file_name}.rb"
+      end
+      protected
+        def job_log_table_name
+          'jobs_dashboard_job_logs'
+        end
+        def migration_version
+          "[#{ActiveRecord::Migration.current_version}]"
+        end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb ADDED Viewed

@@ -0,0 +1,20 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= job_log_table_name %> do |t|
+      t.string :sidekiq_jid, :null => false
+      t.string :status
+      t.string :item_type
+      t.text :args, limit: 4294967295
+      t.text :logs, limit: 4294967295
+      t.boolean :retry, null: false, default: false
+      t.string :queue
+      t.text :error_message, limit: 4294967295
+      t.text :backtrace, limit: 4294967295
+      t.datetime :finished_at
+      t.timestamps
+    end
+    add_index :<%= job_log_table_name %>, :sidekiq_jid, :unique => true
+    add_index :<%= job_log_table_name %>, :updated_at
+  end
+end

data/lib/jobs_dashboard/client_middleware.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'sidekiq/api'
+require 'jobs_dashboard/storage'
+module JobsDashboard
+# Should be in the client middleware chain
+  class ClientMiddleware
+    include Storage
+    # Parameterized initialization, use it when adding middleware to client chain
+    # chain.add JobsDashboard::ClientMiddleware
+    # @param [Hash] opts middleware initialization options
+    # @option opts [Fixnum] :expiration ttl for complete jobs
+    def initialize(opts = {})
+      @expiration = opts[:expiration]
+    end
+    # Uses msg['jid'] id and puts :queued status in the job's Redis hash
+    # @param [Class] worker_class if includes JobsDashboard::Worker, the job gets processed with the plugin
+    # @param [Array] msg job arguments
+    # @param [String] queue the queue's name
+    # @param [ConnectionPool] redis_pool optional redis connection pool
+    def call(worker, msg, queue, redis_pool=nil)
+      unless get_jobs_dashboard_options(msg)[:skip]
+        store_for_id(msg['jid'], {
+          item_type: msg['class'],
+          retry: msg['retry'],
+          queue: msg['queue'],
+          args: msg['args'],
+          status: 'queued'
+        })
+      end
+      yield
+    end
+    private
+      def get_jobs_dashboard_options(msg)
+        klass = msg["args"][0]["job_class"] || msg["class"] rescue msg["class"]
+        job_class = klass.is_a?(Class) ? klass : Module.const_get(klass)
+        job_class.get_sidekiq_options['jobs_dashboard'] || {}
+      end
+  end
+  # Helper method to easily configure sidekiq-status client middleware
+  # whatever the Sidekiq version is.
+  # @param [Sidekiq] sidekiq_config the Sidekiq config
+  # @param [Hash] client_middleware_options client middleware initialization options
+  # @option client_middleware_options [Fixnum] :expiration ttl for complete jobs
+  def self.configure_client_middleware(sidekiq_config, client_middleware_options = {})
+    sidekiq_config.client_middleware do |chain|
+      chain.add JobsDashboard::ClientMiddleware, client_middleware_options
+    end
+  end
+end

data/lib/jobs_dashboard/engine.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module JobsDashboard
+  class Engine < ::Rails::Engine
+    isolate_namespace JobsDashboard
+    initializer "jobs_dashboard.assets.precompile" do |app|
+      app.config.assets.precompile += %w( jobs_dashboard/application.css )
+    end
+    require 'slim-rails'
+  end
+  self.mattr_accessor :additional_params
+  self.additional_params = []
+  def self.setup(&block)
+    yield self
+  end
+end

data/lib/jobs_dashboard/server_middleware.rb ADDED Viewed

@@ -0,0 +1,62 @@
+require 'jobs_dashboard/storage'
+module JobsDashboard
+  class ServerMiddleware
+    include JobsDashboard::Storage
+    # Options can be send in sidekiq.rb initializer
+    # @param [Hash] opts middleware initialization options
+    # @option opts
+    def initialize(opts = {})
+    end
+    # Uses sidekiq's internal jid as id
+    # Store worker status in DB
+    # @param [Worker] worker worker instance
+    # @param [Array] msg job args, should have jid format
+    # @param [String] queue name
+    def call(worker, msg, queue)
+      # Determine the actual job class
+      # Bypass if attributes skip is set
+      if get_jobs_dashboard_options(worker)[:skip]
+        yield
+        return
+      end
+      update_job_status worker.jid, 'working'
+      yield
+      update_job_status worker.jid, 'complete'
+    #rescue Worker::Stopped
+    # update_job_status worker.jid, 'stopped'
+    rescue SystemExit, Interrupt
+      update_job_status worker.jid, 'interrupted'
+      raise
+    rescue Exception => e
+      status = :failed
+      update_job_status worker.jid, 'failed'
+      store_for_id(worker.jid, {
+        error_message: e.message,
+        backtrace: e.backtrace
+      })
+      raise
+    end
+    private
+      def get_jobs_dashboard_options(worker)
+        worker.class.get_sidekiq_options['jobs_dashboard'] || {}
+      end
+  end
+  # Helper method to easily configure sidekiq-status server middleware
+  # whatever the Sidekiq version is.
+  # @param [Sidekiq] sidekiq_config the Sidekiq config
+  # @param [Hash] server_middleware_options server middleware initialization options
+  # @option server_middleware_options
+  def self.configure_server_middleware(sidekiq_config, server_middleware_options = {})
+    sidekiq_config.server_middleware do |chain|
+      chain.add JobsDashboard::ServerMiddleware, server_middleware_options
+    end
+  end
+end