jobs_dashboard 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25c8d99bcb3a7e63265c395622e2f8fb9e6b0f046c5f318fa93586b3671871c0
+  data.tar.gz: 1b8a7ffa2afd19d6653e6a0b0e0c771b8c3ebb1bb7f93a5ac27a081563359cb1
+SHA512:
+  metadata.gz: 05b26dd1dc1db903ab5b0742500b8247e19674f115b36e936b84efea73bdb9966121049fa99c63ea03b5b73f6dd5a64e555c6234d8135247cad065cde297f764
+  data.tar.gz: fe57891700e92baa02a191abc88afec92c5b69cf0e8190bf88e6ee919709c3010ed2f6842b93966a2c677f15df7370396fc97aee1943ffeb1f5e036f45795996

data/.github/workflows/gem-push.yml

@@ -0,0 +1,34 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: 3.1.1
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_STORE

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+## [0.3.3] - 2023-11-07
+- Fix crash when there is data without item_type / queue
+
+## [0.3.2] - 2023-10-26
+- Fix display when metadata is nil
+
+## [0.3.1] - 2023-10-26
+- Redesign of job_log#show
+
+## [0.3.0] - 2023-10-20
+
+- Added logs and metadata. Create a migration to add logs:
+```
+class AddLogsAndMetadataToJobsDashboardJobLogs < ActiveRecord::Migration[7.0]
+  def change
+    add_column :jobs_dashboard_job_logs, :logs, :text, limit: 4294967295
+    add_column :jobs_dashboard_job_logs, :metadata, :text, limit: 4294967295
+  end
+end
+```
+## [0.2.2] - 2023-10-19
+
+- Added log of error message. Create a migration to add logging of error message:
+```
+class AddErrorMessageToJobsDashboardJobLogs < ActiveRecord::Migration[7.0]
+  def change
+    add_column :jobs_dashboard_job_logs, :error_message, :text, limit: 4294967295
+  end
+end
+```
+## [0.2.1] - 2023-10-19
+
+- Raise if basic auth params are not defined
+
+## [0.1.7] - 2022-01-28 
+- Improve dashboard performances
+
+## [0.1.5] - 2021-11-18
+
+- Increase limit of args text field.
+
+If you are migrating from < 0.1.5 to 0.1.5 you have to create a migration to update text fields:
+```
+  def change
+    change_column :jobs_dashboard_job_logs, :args, :text, limit: 4294967295
+    change_column :jobs_dashboard_job_logs, :backtrace, :text, limit: 4294967295
+  end
+```
+## [0.1.2] - 2021-11-02
+
+- Add queue information
+- Improve job arguments display
+
+## [0.1.1] - 2021-10-29
+
+- Fix logging of backtrace
+
+## [0.1.0] - 2021-10-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jobs_dashboard.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    jobs_dashboard (0.3.4)
+      kaminari
+      ransack
+      sidekiq (>= 6.0)
+      slim-rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.8)
+      actionview (= 7.0.8)
+      activesupport (= 7.0.8)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.8)
+      activesupport (= 7.0.8)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activerecord (7.0.8)
+      activemodel (= 7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.12.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    minitest (5.20.0)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    ransack (4.1.1)
+      activerecord (>= 6.1.5)
+      activesupport (>= 6.1.5)
+      i18n
+    redis-client (0.18.0)
+      connection_pool
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    sidekiq (7.2.0)
+      concurrent-ruby (< 2)
+      connection_pool (>= 2.3.0)
+      rack (>= 2.2.4)
+      redis-client (>= 0.14.0)
+    slim (5.1.1)
+      temple (~> 0.10.0)
+      tilt (>= 2.1.0)
+    slim-rails (3.6.3)
+      actionpack (>= 3.1)
+      railties (>= 3.1)
+      slim (>= 3.0, < 6.0, != 5.0.0)
+    temple (0.10.3)
+    thor (1.3.0)
+    tilt (2.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jobs_dashboard!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Patryk Warchol
+
+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,133 @@
+# JobsDashboard
+
+JobsDashboard allows you to log all of your sidekiq jobs and provides an interface to visualize them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jobs_dashboard', git: 'https://github.com/9troisquarts/jobs_dashboard'
+```
+
+And then execute:
+
+    $ bundle install
+
+Run the migration generator:
+
+```ruby
+rails generate active_record:job_log_migration
+```
+
+Run the migration:
+
+```ruby
+rails db:migrate
+```
+## Usage
+
+Set JobsDashboard::JobLogger as sidekiq default logger
+
+```ruby
+# initializers/sidekiq.rb
+require 'jobs_dashboard'
+
+Sidekiq.configure_client do |config|
+  # accepts :expiration (optional)
+  JobsDashboard.configure_client_middleware config
+end
+
+Sidekiq.configure_server do |config|
+  # accepts :expiration (optional)
+  JobsDashboard.configure_server_middleware config
+
+  # accepts :expiration (optional)
+  JobsDashboard.configure_client_middleware config
+end
+```
+
+Mount Engine to access web component:
+
+```ruby
+# routes.rb
+require 'jobs_dashboard/engine'
+
+Rails.application.routes.draw do
+  mount JobsDashboard::Engine, at: '/jobs_dashboard'
+end
+```
+
+## Basic authentication
+
+Set environment variable JOBS_DASHBOARD_AUTH_PASSWORD and JOBS_DASHBOARD_AUTH_USERNAME to activate the basic authentication
+
+## Job Options
+
+Options can be specified in worker's sidekiq_options with the key jobs_dashboard
+
+```ruby
+  sidekiq_options jobs_dashboard: { skip: true }
+```
+
+## Add logs or metadata
+
+In the job
+```ruby
+include JobsDashboard::Worker
+# add log line
+add_job_log_line(value)
+
+# add metadata
+add_job_metadata(key, value)
+```
+
+## Add a custom attribute
+
+Custom attribute can be added on the jobs_dashboard_job_logs table
+
+```ruby
+include JobsDashboard::Worker
+add_log_line(message)
+```
+
+## Ajout d'un attribut commun a tous les jobs
+
+Si vous souhaitez ajouter un champ a tous les jobs qui sera utilisé comme filtre / colonnes, suivez les instructions ci dessous :
+
+```ruby
+bundle exec rails g migration add_{{attribute_name}}_to_jobs_dashboard_job_logs
+```
+
+In an initializer
+
+```ruby
+JobsDashboard.setup do |config|
+  config.additional_params = [
+    {
+      attribute_name: 'attribute_name',
+      title: 'Title displayed on column header and more'
+    }
+  ]
+end
+```
+
+In the job
+```ruby
+include JobsDashboard::Worker
+set_job_parameter(attribute_name, value)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jobs_dashboard.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

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

@@ -0,0 +1,214 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+$layout-content-margin-top: 8rem;
+$navbar-height: 80px;
+$white: #FFF;
+$border-radius: 0.5rem;
+$montserrat: 'Montserrat', sans-serif;
+$jet: #2D4047;
+
+@import url('https://fonts.googleapis.com/css2?family=Montserrat:ital,wght@0,100;0,300;0,400;0,500;0,600;0,700;1,300;1,400;1,500;1,600;1,700&display=swap');
+
+@import "reset.scss";
+@import "./variables.sass";
+
+html {
+  font-family: Montserrat, Helvetica, sans-serif;
+  padding: 0px;
+  font-size: 14px;
+  box-sizing: border-box;
+  color: #343434;
+}
+
+a {
+  text-decoration: none;
+  color: $primary-color;
+}
+
+body {
+  background-color: #F5F5F5;
+  font-family: $montserrat;
+  margin: 0;
+  color: $jet;
+  padding-bottom: 1rem;
+}
+
+table {
+  border-collapse: collapse;
+  text-align: left;
+}
+
+table td, table th {
+  border: 1px solid #ddd;
+  padding: 8px;
+}
+
+table tr {
+  background-color: white;
+}
+
+table thead th {
+  padding-top: 12px;
+  padding-bottom: 12px;
+}
+
+
+h1, h2 {
+  font-weight: 600;
+}
+
+h1 {
+  font-size: 30px;
+  margin: 1rem 0;
+}
+
+h2 {
+  font-size: 22px;
+  margin: 0.75rem 0;
+}
+
+.code {
+  padding: 12px;
+  background-color: #2c3e50;
+  color: white;
+}
+
+.pagination {
+  margin-top: 20px;
+  margin-bottom: 20px;
+  text-align: right;
+}
+
+.full-width {
+  width: 100%;
+}
+
+.navbar {
+  background-color: $primary-color;
+  padding: 0rem 32px;
+
+  .title-wrapper {
+    padding-bottom: $layout-content-margin-top;
+    padding-top: 1rem;
+    h1 {
+      color: $white;
+      margin-bottom: 2rem;
+    }
+  }
+
+  .nav-wrapper {
+    width: 100%;
+    display: flex;
+    align-items: center;
+    border-bottom: 1px solid #a75663;
+    .logo {
+      margin-right: 2rem;
+      svg {
+        width: 40px;
+        .fa-secondary {
+          fill: $white;
+        }
+        .fa-primary {
+          fill: $primary-color;
+        }
+      }
+    }
+  }
+
+  .nav-wrapper > ul.nav {
+    display: flex;
+    height: $navbar-height;
+    gap: 16px;
+    align-items: center;
+    letter-spacing: 1px;
+    list-style: none;
+    margin: 0;
+    padding-left: 0;
+    > li.nav-item {
+      display: inline-flex;
+      position: relative;
+      align-items: center;
+      a {
+        font-size: 14px;
+        color: #FFF;
+        border-radius: 4px;
+        padding: 8px 12px;
+        transition: background-color 0.2s ease-in-out;
+      }
+
+      &.active, &:hover {
+        a {
+          background-color: darken($primary-color, 5%);
+        }
+      }
+    }
+  }
+}
+
+.layout-content {
+  padding: 0 32px;
+  margin-top: $layout-content-margin-top * -1;
+}
+
+.page-header {
+  padding: 15px 0px;
+}
+
+.divider {
+  height: 1px;
+  background-color: #E6E6E6;
+  width: 100%;
+}
+
+.mt-1 {
+  margin-top: 1rem;
+}
+
+.mt-2 {
+  margin-top: 30px;
+}
+
+.text-muted {
+  color: $muted;
+}
+
+.d-flex {
+  display: flex;
+}
+
+.mt-0 {
+  margin-top: 0;
+}
+
+.ml-auto {
+  margin-left: auto;
+}
+
+.radius {
+  border-radius: 0.5rem;
+}
+
+.align-items-center {
+  align-items: center;
+}
+
+.text-right {
+  text-align: right;
+}
+
+@import "./modules/*";
+@import "./pages/**/*";

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

@@ -0,0 +1,15 @@
+@import "../variables"
+
+.button
+  border: none
+  padding: 8px 16px
+  border-radius: 5px
+  transition-property: opacity
+  transition-duration: 0.2s
+  transition-delay: 0s
+  cursor: pointer
+  &:hover
+    opacity: 80%
+  &.primary
+    background: $primary-color
+    color: white

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

@@ -0,0 +1,22 @@
+@import "../variables"
+
+.card
+  background-color: #FFF
+  border-radius: 0.5rem
+  &.shadowed
+    box-shadow: 0 0 5px 0 rgba(205, 205, 205, 0.3)
+
+  .card-title
+    padding: 16px 20px
+    color: $jet
+    font-weight: 600
+    font-size: 18px
+    border-bottom: 1px solid $border-color
+
+  .card-content
+    padding: 16px 20px
+    .description
+      border-radius: 5px
+  
+  .no-padding
+    padding: 0px !important

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

@@ -0,0 +1,17 @@
+@import "../variables"
+
+.description
+  display: flex
+  flex-direction: column
+
+  .item
+    display: flex
+    .title
+      padding: 8px 20px
+      flex: 2
+      background: #F5F5F5
+    .value
+      padding: 8px 20px
+      flex: 5
+    &:not(:last-child)
+      border-bottom: 1px solid $border-color