jobs_dashboard 0.3.4

data/app/assets/stylesheets/jobs_dashboard/modules/grid.sass

@@ -0,0 +1,17 @@
+@import "../variables"
+
+.row
+  display: flex
+  margin:
+    left: -16px
+    right: -16px
+
+div[class^='col-']
+  display: flex
+  padding: 0 16px
+
+.col-12
+  width: 50%
+
+.col-24
+  width: 100%

data/app/assets/stylesheets/jobs_dashboard/modules/inputs.sass

@@ -0,0 +1,31 @@
+.form-inline
+  display: flex
+  gap: 16px
+  flex-wrap: wrap
+  align-items: center
+  &.submit
+    margin-top: 1rem
+    justify-content: flex-end
+    align-items: baseline
+
+  > .input
+    label
+      display: block
+      font-weight: 600
+      line-height: 2rem
+      color: #343434
+    input, select
+      min-width: 150px
+    &.group
+      display: flex
+      flex-direction: column
+
+    input, select
+      border-radius: 0.375rem
+      padding: 0px 12px
+      border: 1px solid #6b7280
+      box-shadow: none
+      font-size: 1rem
+      line-height: 1.5rem
+      height: 37px
+      outline-color: #A63446

data/app/assets/stylesheets/jobs_dashboard/modules/item-list.sass

@@ -0,0 +1,10 @@
+@import "../variables"
+
+ul.item-list
+  list-style: none
+  padding: 0
+  margin: 0
+  > li
+    padding: 8px 0
+  > li:not(:last-child)
+    border-bottom: 1px solid $border-color

data/app/assets/stylesheets/jobs_dashboard/modules/labels.sass

@@ -0,0 +1,12 @@
+.status-label
+  width: 10px
+  height: 10px
+  display: inline-block
+  border-radius: 99px
+  margin-right: 5px
+  background: #3F84E5
+  &.success
+    background: #2ecc71
+  &.error
+    background: #e74c3c
+  

data/app/assets/stylesheets/jobs_dashboard/modules/statistics.sass

@@ -0,0 +1,15 @@
+@import "../variables"
+.statistics
+  display: flex
+  justify-content: space-around
+  .stat
+    text-align: center
+    strong
+      font-size: 24px
+      margin-bottom: 1rem
+      justify-content: center
+      display: flex
+      color: $primary-color
+      font-weight: 600
+    font-size: 14px
+    color: $jet

data/app/assets/stylesheets/jobs_dashboard/modules/table.sass

@@ -0,0 +1,38 @@
+$header-color: #f5f5f5
+$table-radius: 6px
+$cell-padding: 14px 10px
+$table-border-color: #e4e4e4
+
+table
+  border-radius: $table-radius
+  border: 1px solid $table-border-color
+  border-spacing: 0
+  border-collapse: separate
+  
+  > thead
+    > tr
+      > th
+        border: 0
+        border-bottom: 1px solid $table-border-color
+        font-weight: 600
+        background-color: $header-color
+        color: darken($header-color, 40%)
+        padding: $cell-padding
+
+        &:first-child
+          border-top-left-radius: $table-radius
+        &:last-child
+          border-top-right-radius: $table-radius
+  > tbody
+    > tr
+      > td
+        border: 0
+        border-bottom: 1px solid $table-border-color
+        padding: $cell-padding
+        &:first-child
+          border-bottom-left-radius: $table-radius
+        &:last-child
+          border-bottom-right-radius: $table-radius
+
+table tbody tr:hover
+  background-color: $header-color

data/app/assets/stylesheets/jobs_dashboard/pages/jobs_logs/show.sass

@@ -0,0 +1,36 @@
+.job_logs-show
+  .page-container
+    display: flex
+    flex-direction: column
+    width: 100%
+
+  .page-header
+    display: flex
+    flex-direction: column
+    gap: 20px
+
+    .title
+      font-size: 18px
+      font-weight: 600
+
+  .page-body
+    display: flex
+    flex-direction: row
+    gap: 20px
+
+    .main-container
+      flex: 8
+      display: flex
+      flex-direction: column
+      gap: 20px
+
+    .side-container
+      flex: 3
+
+
+  .no-padding
+    padding: 0 !important
+
+  .card-no-padding-title
+    padding: 18px 30px
+  

data/app/assets/stylesheets/jobs_dashboard/reset.scss

@@ -0,0 +1,135 @@
+/* http://meyerweb.com/eric/tools/css/reset/ 
+   v2.0 | 20110126
+   License: none (public domain)
+*/
+
+html,
+body,
+div,
+span,
+applet,
+object,
+iframe,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+p,
+blockquote,
+pre,
+a,
+abbr,
+acronym,
+address,
+big,
+cite,
+code,
+del,
+dfn,
+em,
+img,
+ins,
+kbd,
+q,
+s,
+samp,
+small,
+strike,
+strong,
+sub,
+sup,
+tt,
+var,
+b,
+u,
+i,
+center,
+dl,
+dt,
+dd,
+ol,
+ul,
+li,
+fieldset,
+form,
+label,
+legend,
+table,
+caption,
+tbody,
+tfoot,
+thead,
+tr,
+th,
+td,
+article,
+aside,
+canvas,
+details,
+embed,
+figure,
+figcaption,
+footer,
+header,
+hgroup,
+menu,
+nav,
+output,
+ruby,
+section,
+summary,
+time,
+mark,
+audio,
+video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+
+/* HTML5 display-role reset for older browsers */
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+menu,
+nav,
+section {
+  display: block;
+}
+
+body {
+  line-height: 1;
+}
+
+ol,
+ul {
+  list-style: none;
+}
+
+blockquote,
+q {
+  quotes: none;
+}
+
+blockquote:before,
+blockquote:after,
+q:before,
+q:after {
+  content: '';
+  content: none;
+}
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}

data/app/assets/stylesheets/jobs_dashboard/variables.sass

@@ -0,0 +1,6 @@
+$primary-color: #A63446
+$montserrat: 'Montserrat', sans-serif
+$jet: #2D4047
+$muted: #696969
+
+$border-color: #E6E6E6

data/app/controllers/jobs_dashboard/application_controller.rb

@@ -0,0 +1,20 @@
+require 'kaminari'
+module JobsDashboard
+  class ApplicationController < ActionController::Base
+    before_action :basic_auth
+    before_action :set_locale
+
+    private
+
+      def basic_auth
+        if ENV["JOBS_DASHBOARD_AUTH_USERNAME"].blank? || ENV["JOBS_DASHBOARD_AUTH_PASSWORD"].blank?
+          raise 'Define a JOBS_DASHBOARD_AUTH_USERNAME and JOBS_DASHBOARD_AUTH_PASSWORD to access jobs dashboard' 
+        end
+        self.class.http_basic_authenticate_with name: ENV["JOBS_DASHBOARD_AUTH_USERNAME"], password: ENV["JOBS_DASHBOARD_AUTH_PASSWORD"]
+      end
+      
+      def set_locale
+        I18n.locale = :fr
+      end
+  end
+end

data/app/controllers/jobs_dashboard/dashboard_controller.rb

@@ -0,0 +1,12 @@
+module JobsDashboard
+  class DashboardController < ApplicationController
+
+    def index
+      @stats = JobLog.all.select("COUNT(id) as count, status").group(:status)
+      @awaiting_jobs = JobLog.queued
+      @ongoing_jobs = JobLog.working
+    end
+
+  end
+
+end

data/app/controllers/jobs_dashboard/job_logs_controller.rb

@@ -0,0 +1,17 @@
+module JobsDashboard
+  class JobLogsController < ApplicationController
+    def index
+      @q = JobLog.ransack(params[:q])
+
+      @job_logs = @q.result(distinct: true).order(created_at: :desc)
+      if @job_logs.respond_to?(:page)
+        @job_logs = @job_logs.page(params[:page]).per(100)
+      end
+    end
+
+    def show
+      @job_log = JobLog.find_by(sidekiq_jid: params[:id])
+      @title = "#{@job_log.item_type}"
+    end
+  end
+end

data/app/helpers/jobs_dashboard/application_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module JobsDashboard
+  module ApplicationHelper
+    def display_time time
+      time.in_time_zone(DEFAULT_LOCAL_TIME_ZONE).strftime("%Y-%m-%d %I:%M:%S")
+    end
+
+    def status_label status
+      case status
+      when 'complete'
+        return 'success'
+      when 'failed', 'interrupted'
+        return 'error'
+      end
+    end
+
+    def item_types_collection
+      JobLog.pluck(:item_type).compact.uniq.sort
+    end
+
+    def statuses_collection
+      JobLog.statuses.keys.map do |key|
+        [I18n.t("jobs_dashboard.statuses.#{key}"), key]
+      end
+    end
+
+    def queues_collection
+      JobLog.pluck(:queue).compact.uniq.sort
+    end
+  end
+end

data/app/models/jobs_dashboard/application_record.rb

@@ -0,0 +1,5 @@
+module JobsDashboard
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/jobs_dashboard/job_log.rb

@@ -0,0 +1,32 @@
+module JobsDashboard
+  DEFAULT_LOCAL_TIME_ZONE = 'Europe/Paris'
+
+  class JobLog < ApplicationRecord
+    enum status: {
+      queued: 'queued',
+      working: 'working',
+      retrying: 'retrying',
+      complete: 'complete',
+      failed: 'failed',
+      interrupted: 'interrupted'
+    }
+
+    serialize :args, Array
+    serialize :metadata, Hash
+    serialize :logs, Array
+    serialize :backtrace, Array
+
+    validates :sidekiq_jid, presence: true, uniqueness: true
+
+    def self.ransackable_attributes(auth_object = nil)
+      [
+        "sidekiq_jid",
+        "item_type",
+        "queue",
+        "status",
+        "created_at", 
+        "finished_at", 
+      ]
+    end
+  end
+end

data/app/views/jobs_dashboard/dashboard/_job_row.slim

@@ -0,0 +1,8 @@
+li
+  div.d-flex
+    = link_to job.sidekiq_jid, job_log_path(job.sidekiq_jid)
+    small.ml-auto
+      = l job.created_at, format: :short
+
+  div
+    small.text-muted= job.item_type

data/app/views/jobs_dashboard/dashboard/index.slim

@@ -0,0 +1,40 @@
+.row
+  .col-24
+    .card.shadowed.full-width
+      .card-content
+        .statistics
+          - [:working, :queued, :complete, :failed].each do |state|
+            .stat
+              strong
+                = @stats.find{|stat| stat[:status] === state.to_s }.try(:[], :count) || 0
+              = t state, scope: :'jobs_dashboard.statuses'
+
+.row.mt-1
+  .col-12
+    .card.shadowed.full-width
+      .card-title
+        => t :'jobs_dashboard.statuses.working'
+        - if @ongoing_jobs.count > 0
+          |(#{@ongoing_jobs.count})
+      .card-content
+        - if @ongoing_jobs.any?
+          ul.item-list
+            - @ongoing_jobs.limit(10).each do |job|
+              = render partial: 'job_row', locals: { job: job }
+        - else
+          small.text-muted
+            = t :'jobs_dashboard.sentences.no_ongoing_jobs'
+  .col-12
+    .card.shadowed.full-width
+      .card-title
+        => t :'jobs_dashboard.statuses.queued'
+        - if @awaiting_jobs.count > 0
+          |(#{@awaiting_jobs.count})
+      .card-content
+        - if @awaiting_jobs.any?
+          ul.item-list
+            - @awaiting_jobs.limit(10).each do |job|
+              = render partial: 'job_row', locals: { job: job }
+        - else
+          small.text-muted
+            = t :'jobs_dashboard.sentences.no_awaiting_jobs'

data/app/views/jobs_dashboard/job_logs/index.slim

@@ -0,0 +1,84 @@
+.card
+  .card-content
+    div
+      = search_form_for @q do |f|
+        .form-inline
+          .input
+            = f.label :sidekiq_jid_eq, t(:sidekiq_jid, scope: 'jobs_dashboard.table.headers')
+            = f.search_field :sidekiq_jid_eq
+          .input
+            = f.label :item_type_eq, t(:item_type, scope: 'jobs_dashboard.table.headers')
+            = f.select :item_type_eq,
+                    options_for_select(item_types_collection,
+                            params.dig(:q, :item_type_eq)),
+                    { include_blank: t('form.select.all') },
+                    { multiple: false }
+          .input
+            = f.label :status_eq, t(:status, scope: 'jobs_dashboard.table.headers')
+            = f.select :status_eq,
+                    options_for_select(statuses_collection,
+                            params.dig(:q, :status_eq)),
+                    { include_blank: t('form.select.all') },
+                    { multiple: false }
+          .input
+            = f.label :queue_eq, t(:queue, scope: 'jobs_dashboard.table.headers')
+            = f.select :queue_eq,
+                    options_for_select(queues_collection,
+                            params.dig(:q, :queue_eq)),
+                    { include_blank: t('form.select.all') },
+                    { multiple: false }
+          .input.group
+            = f.label :created_at_dategteq, t(:created_at, scope: 'jobs_dashboard.table.headers')
+            .d-flex.align-items-center
+              = f.date_field :created_at_dategteq
+              div style="margin-right: 5px; margin-left: 5px" = t('jobs_dashboard.words.to')
+              = f.date_field :created_at_datelteq
+
+          .input.group
+            = f.label :finished_at_dategteq, t(:finished_at, scope: 'jobs_dashboard.table.headers')
+            .d-flex.align-items-center
+              = f.date_field :finished_at_dategteq
+              div style="margin-right: 5px; margin-left: 5px" = t('jobs_dashboard.words.to')
+              = f.date_field :finished_at_datelteq
+        .form-inline.submit
+          = link_to t('jobs_dashboard.sentences.clear_filters'), job_logs_path
+          div style="margin-left: 30px"
+            = f.submit t('jobs_dashboard.words.submit'), class: 'button primary'
+    .row.mt-2
+      .col-24
+        table class="full-width"
+          thead
+            tr
+              th
+                = t(:sidekiq_jid, scope: 'jobs_dashboard.table.headers')
+              th
+                = t(:status, scope: 'jobs_dashboard.table.headers')
+              th
+                = t(:queue, scope: 'jobs_dashboard.table.headers')
+              th
+                = t(:item_type, scope: 'jobs_dashboard.table.headers')
+              - JobsDashboard.additional_params.each do |param|
+                th= param[:title]
+              th.text-right
+                = t(:created_at, scope: 'jobs_dashboard.table.headers')
+              th.text-right
+                = t(:finished_at, scope: 'jobs_dashboard.table.headers')
+          tbody
+            - @job_logs.each do |job_log|
+              tr
+                td= link_to job_log.sidekiq_jid, job_log_path(job_log.sidekiq_jid)
+                td
+                  .status-label class=(status_label(job_log.status))
+                  = t job_log.status, scope: 'jobs_dashboard.statuses'
+                td= job_log.queue
+                td= job_log.item_type
+                - JobsDashboard.additional_params.each do |param|
+                  td
+                    = job_log.try(:[], param[:attribute_name])
+                td.text-right
+                  = display_time job_log.created_at
+                td.text-right
+                  = job_log.finished_at.present? ? display_time(job_log.finished_at) : '-'
+
+        .pagination
+          = paginate @job_logs, theme: 'jobs_dashboard'

data/app/views/jobs_dashboard/job_logs/show.slim

@@ -0,0 +1,89 @@
+.page-container
+  .page-body
+    .main-container
+      - if @job_log.backtrace.present?
+        .card.shadowed
+          .card-title Error message
+          .card-content
+            code 
+              = @job_log.error_message
+
+        .card.shadowed
+          .card-title Backtrace
+          .card-content
+            div.radius style="max-height: 400px; overflow-y: auto;"
+              .code
+                code 
+                  - @job_log.backtrace.each do |b|
+                    div = b
+
+      - if @job_log.args.present?
+        .card.shadowed
+          .card-title Arguments
+          .card-content.no-padding
+            div.radius style="max-height: 400px; overflow-y: auto;"
+              .description
+                - @job_log.args.each do |arg|
+                  - if arg.is_a? Hash
+                    - arg.each do |k,v|
+                      .item
+                        .title
+                          code = k
+                        .value
+                          code = v
+                  - else
+                    .item
+                      .title 
+                        code = @job_log.args.index(arg)
+                      .value 
+                        code = arg
+
+      - if @job_log.respond_to?(:metadata) && @job_log.metadata.present?
+        .card.shadowed.no-padding
+          .card-title Metadata
+          .card-content
+            div.radius style="max-height: 400px; overflow-y: auto;"
+              .description
+                - @job_log.metadata.each do |k, v|
+                  .item
+                    .title
+                      code = k
+                    .value
+                      code = v
+
+      - if @job_log.respond_to?(:logs) && @job_log.logs.any?
+        .card.shadowed
+          .card-title Logs
+          .card-content.no-padding
+            div.radius style="max-height: 400px; overflow-y: auto;"
+              .description
+                - @job_log.logs.each do |log|
+                  .item
+                    .title = display_time(log[:created_at])
+                    .value = log[:value]
+
+    .side-container
+      .card.shadowed
+        .card-title Infos
+        .card-content.no-padding
+          .description
+            .item
+              .title = t(:job_id, scope: 'jobs_dashboard.table.headers')
+              .value = @job_log.sidekiq_jid
+            .item
+              .title = t(:item_type, scope: 'jobs_dashboard.table.headers')
+              .value = @job_log.item_type
+            .item
+              .title = t(:created_at, scope: 'jobs_dashboard.table.headers')
+              .value = display_time(@job_log.created_at)
+            .item
+              .title = t(:finished_at, scope: 'jobs_dashboard.table.headers')
+              .value = @job_log.finished_at.present? ? display_time(@job_log.finished_at) : '-'
+            .item
+              .title = t(:status, scope: 'jobs_dashboard.table.headers')
+              .value
+                .status-label class=(status_label(@job_log.status))
+                = t @job_log.status, scope: 'jobs_dashboard.statuses'
+            .item
+              .title = t(:queue, scope: 'jobs_dashboard.table.headers')
+              .value = @job_log.queue

data/app/views/kaminari/jobs_dashboard/_first_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "First" page
+  - available local variables
+    url:           url to the first 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="first">
+  <%= link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote %>
+</span>

data/app/views/kaminari/jobs_dashboard/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - 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
+-%>
+<span class="page gap"><%= t('views.pagination.truncate').html_safe %></span>