Convert GoodJob into a single mountable engine (instead of a plugin p…

…lus optional engine)
bensheldon · Apr 5, 2022 · cf51d76 · cf51d76
1 parent af4aa5b
commit cf51d76
Show file tree

Hide file tree

Showing 64 changed files with 131 additions and 43 deletions.
diff --git a/Procfile b/Procfile
@@ -1,2 +1,2 @@
-release: bin/test_app_rake heroku:release
+release: bin/test_app heroku:release
 web: bin/test_app server
diff --git a/README.md b/README.md
@@ -323,19 +323,6 @@ _🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and cod
 
 GoodJob includes a Dashboard as a mountable `Rails::Engine`.
 
-1. Explicitly require the Engine code at the top of your `config/application.rb` file, immediately after Rails is required and before Bundler requires the Rails' groups. This is necessary because the mountable engine is an optional feature of GoodJob.
-
-    ```ruby
-    # config/application.rb
-    require_relative 'boot'
-
-    require 'rails/all'
-    require 'good_job/engine' # <= Add this line
-    # ...
-    ```
-
-   Note: If you find the dashboard fails to reload due to a routing error and uninitialized constant `GoodJob::ExecutionsController`, this is likely because you are not requiring the engine early enough.
-
 1. Mount the engine in your `config/routes.rb` file. The following will mount it at `http://example.com/good_job`.
 
     ```ruby
@@ -344,7 +331,7 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
     mount GoodJob::Engine => 'good_job'
     ```
 
-    Because jobs can potentially contain sensitive information, you should authorize access. For example, using Devise's `authenticate` helper, that might look like:
+1. Configure authentication. Because jobs can potentially contain sensitive information, you should authorize access. For example, using Devise's `authenticate` helper, that might look like:
 
     ```ruby
     # config/routes.rb

diff --git a/app.json b/app.json
@@ -29,6 +29,6 @@
     }
   ],
   "scripts": {
-    "postdeploy": "bin/test_app_rake heroku:postdeploy"
+    "postdeploy": "bin/test_app heroku:postdeploy"
   }
 }
diff --git a/engine/app/assets/scripts.js → app/assets/scripts.js b/engine/app/assets/scripts.js → app/assets/scripts.js
diff --git a/engine/app/assets/style.css → app/assets/style.css b/engine/app/assets/style.css → app/assets/style.css
diff --git a/.../vendor/bootstrap/bootstrap.bundle.min.js → .../vendor/bootstrap/bootstrap.bundle.min.js b/.../vendor/bootstrap/bootstrap.bundle.min.js → .../vendor/bootstrap/bootstrap.bundle.min.js
diff --git a/...assets/vendor/bootstrap/bootstrap.min.css → ...assets/vendor/bootstrap/bootstrap.min.css b/...assets/vendor/bootstrap/bootstrap.min.css → ...assets/vendor/bootstrap/bootstrap.min.css
diff --git a/...ne/app/assets/vendor/chartjs/chart.min.js → app/assets/vendor/chartjs/chart.min.js b/...ne/app/assets/vendor/chartjs/chart.min.js → app/assets/vendor/chartjs/chart.min.js
diff --git a/engine/app/assets/vendor/rails_ujs.js → app/assets/vendor/rails_ujs.js b/engine/app/assets/vendor/rails_ujs.js → app/assets/vendor/rails_ujs.js
diff --git a/...arts/good_job/scheduled_by_queue_chart.rb → ...arts/good_job/scheduled_by_queue_chart.rb b/...arts/good_job/scheduled_by_queue_chart.rb → ...arts/good_job/scheduled_by_queue_chart.rb
diff --git a/...ollers/good_job/application_controller.rb → ...ollers/good_job/application_controller.rb b/...ollers/good_job/application_controller.rb → ...ollers/good_job/application_controller.rb
diff --git a/...controllers/good_job/assets_controller.rb → ...controllers/good_job/assets_controller.rb b/...controllers/good_job/assets_controller.rb → ...controllers/good_job/assets_controller.rb
diff --git a/...llers/good_job/cron_entries_controller.rb → ...llers/good_job/cron_entries_controller.rb b/...llers/good_job/cron_entries_controller.rb → ...llers/good_job/cron_entries_controller.rb
diff --git a/...rollers/good_job/executions_controller.rb → ...rollers/good_job/executions_controller.rb b/...rollers/good_job/executions_controller.rb → ...rollers/good_job/executions_controller.rb
diff --git a/...p/controllers/good_job/jobs_controller.rb → app/controllers/good_job/jobs_controller.rb b/...p/controllers/good_job/jobs_controller.rb → app/controllers/good_job/jobs_controller.rb
diff --git a/...trollers/good_job/processes_controller.rb → ...trollers/good_job/processes_controller.rb b/...trollers/good_job/processes_controller.rb → ...trollers/good_job/processes_controller.rb
diff --git a/engine/app/filters/good_job/base_filter.rb → app/filters/good_job/base_filter.rb b/engine/app/filters/good_job/base_filter.rb → app/filters/good_job/base_filter.rb
diff --git a/...app/filters/good_job/executions_filter.rb → app/filters/good_job/executions_filter.rb b/...app/filters/good_job/executions_filter.rb → app/filters/good_job/executions_filter.rb
diff --git a/engine/app/filters/good_job/jobs_filter.rb → app/filters/good_job/jobs_filter.rb b/engine/app/filters/good_job/jobs_filter.rb → app/filters/good_job/jobs_filter.rb
diff --git a/...pp/helpers/good_job/application_helper.rb → app/helpers/good_job/application_helper.rb b/...pp/helpers/good_job/application_helper.rb → app/helpers/good_job/application_helper.rb
diff --git a/lib/good_job/assignable_connection.rb → ...oncerns/good_job/assignable_connection.rb b/lib/good_job/assignable_connection.rb → ...oncerns/good_job/assignable_connection.rb
diff --git a/lib/good_job/filterable.rb → app/models/concerns/good_job/filterable.rb b/lib/good_job/filterable.rb → app/models/concerns/good_job/filterable.rb
diff --git a/lib/good_job/lockable.rb → app/models/concerns/good_job/lockable.rb b/lib/good_job/lockable.rb → app/models/concerns/good_job/lockable.rb
diff --git a/lib/good_job/active_job_job.rb → app/models/good_job/active_job_job.rb b/lib/good_job/active_job_job.rb → app/models/good_job/active_job_job.rb
@@ -16,7 +16,7 @@ class ActiveJobJob < BaseRecord
     DiscardJobError = Class.new(StandardError)
 
     class << self
-      delegate :table_name, to: Execution
+      delegate :table_name, to: ::GoodJob::Execution
 
       def table_name=(_value)
         raise NotImplementedError, 'Assign GoodJob::Execution.table_name directly'
@@ -26,7 +26,7 @@ def table_name=(_value)
     self.primary_key = 'active_job_id'
     self.advisory_lockable_column = 'active_job_id'
 
-    has_many :executions, -> { order(created_at: :asc) }, class_name: 'GoodJob::Execution', foreign_key: 'active_job_id', inverse_of: :job
+    has_many :executions, -> { order(created_at: :asc) }, class_name: 'GoodJob::Execution', foreign_key: 'active_job_id', inverse_of: :job # rubocop:disable Rails/HasManyOrHasOneDependent
 
     # Only the most-recent unretried execution represents a "Job"
     default_scope { where(retried_good_job_id: nil) }

diff --git a/lib/good_job/base_record.rb → app/models/good_job/base_record.rb b/lib/good_job/base_record.rb → app/models/good_job/base_record.rb
diff --git a/lib/good_job/execution.rb → app/models/good_job/execution.rb b/lib/good_job/execution.rb → app/models/good_job/execution.rb
diff --git a/lib/good_job/job.rb → app/models/good_job/job.rb b/lib/good_job/job.rb → app/models/good_job/job.rb
diff --git a/lib/good_job/process.rb → app/models/good_job/process.rb b/lib/good_job/process.rb → app/models/good_job/process.rb
diff --git a/...iews/good_job/cron_entries/index.html.erb → ...iews/good_job/cron_entries/index.html.erb b/...iews/good_job/cron_entries/index.html.erb → ...iews/good_job/cron_entries/index.html.erb
diff --git a/...views/good_job/cron_entries/show.html.erb → ...views/good_job/cron_entries/show.html.erb b/...views/good_job/cron_entries/show.html.erb → ...views/good_job/cron_entries/show.html.erb
diff --git a/.../app/views/good_job/executions/_table.erb → app/views/good_job/executions/_table.erb b/.../app/views/good_job/executions/_table.erb → app/views/good_job/executions/_table.erb
diff --git a/.../views/good_job/executions/index.html.erb → app/views/good_job/executions/index.html.erb b/.../views/good_job/executions/index.html.erb → app/views/good_job/executions/index.html.erb
diff --git a/engine/app/views/good_job/jobs/_table.erb → app/views/good_job/jobs/_table.erb b/engine/app/views/good_job/jobs/_table.erb → app/views/good_job/jobs/_table.erb
diff --git a/...ne/app/views/good_job/jobs/index.html.erb → app/views/good_job/jobs/index.html.erb b/...ne/app/views/good_job/jobs/index.html.erb → app/views/good_job/jobs/index.html.erb
diff --git a/engine/app/views/good_job/jobs/show.html.erb → app/views/good_job/jobs/show.html.erb b/engine/app/views/good_job/jobs/show.html.erb → app/views/good_job/jobs/show.html.erb
diff --git a/...p/views/good_job/processes/index.html.erb → app/views/good_job/processes/index.html.erb b/...p/views/good_job/processes/index.html.erb → app/views/good_job/processes/index.html.erb
diff --git a/engine/app/views/good_job/shared/_alert.erb → app/views/good_job/shared/_alert.erb b/engine/app/views/good_job/shared/_alert.erb → app/views/good_job/shared/_alert.erb
diff --git a/...p/views/good_job/shared/_announcement.erb → app/views/good_job/shared/_announcement.erb b/...p/views/good_job/shared/_announcement.erb → app/views/good_job/shared/_announcement.erb
diff --git a/engine/app/views/good_job/shared/_chart.erb → app/views/good_job/shared/_chart.erb b/engine/app/views/good_job/shared/_chart.erb → app/views/good_job/shared/_chart.erb
diff --git a/engine/app/views/good_job/shared/_filter.erb → app/views/good_job/shared/_filter.erb b/engine/app/views/good_job/shared/_filter.erb → app/views/good_job/shared/_filter.erb
diff --git a/engine/app/views/good_job/shared/_footer.erb → app/views/good_job/shared/_footer.erb b/engine/app/views/good_job/shared/_footer.erb → app/views/good_job/shared/_footer.erb
diff --git a/engine/app/views/good_job/shared/_navbar.erb → app/views/good_job/shared/_navbar.erb b/engine/app/views/good_job/shared/_navbar.erb → app/views/good_job/shared/_navbar.erb
diff --git a/...ob/shared/icons/_arrow_clockwise.html.erb → ...ob/shared/icons/_arrow_clockwise.html.erb b/...ob/shared/icons/_arrow_clockwise.html.erb → ...ob/shared/icons/_arrow_clockwise.html.erb
diff --git a/...ews/good_job/shared/icons/_check.html.erb → ...ews/good_job/shared/icons/_check.html.erb b/...ews/good_job/shared/icons/_check.html.erb → ...ews/good_job/shared/icons/_check.html.erb
diff --git a/...od_job/shared/icons/_exclamation.html.erb → ...od_job/shared/icons/_exclamation.html.erb b/...od_job/shared/icons/_exclamation.html.erb → ...od_job/shared/icons/_exclamation.html.erb
diff --git a/...iews/good_job/shared/icons/_play.html.erb → ...iews/good_job/shared/icons/_play.html.erb b/...iews/good_job/shared/icons/_play.html.erb → ...iews/good_job/shared/icons/_play.html.erb
diff --git a/...d_job/shared/icons/_skip_forward.html.erb → ...d_job/shared/icons/_skip_forward.html.erb b/...d_job/shared/icons/_skip_forward.html.erb → ...d_job/shared/icons/_skip_forward.html.erb
diff --git a/...iews/good_job/shared/icons/_stop.html.erb → ...iews/good_job/shared/icons/_stop.html.erb b/...iews/good_job/shared/icons/_stop.html.erb → ...iews/good_job/shared/icons/_stop.html.erb
diff --git a/...ews/good_job/shared/icons/_trash.html.erb → ...ews/good_job/shared/icons/_trash.html.erb b/...ews/good_job/shared/icons/_trash.html.erb → ...ews/good_job/shared/icons/_trash.html.erb
diff --git a/...ews/layouts/good_job/application.html.erb → ...ews/layouts/good_job/application.html.erb b/...ews/layouts/good_job/application.html.erb → ...ews/layouts/good_job/application.html.erb
diff --git a/app/views/layouts/good_job/base.html.erb b/app/views/layouts/good_job/base.html.erb
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>Good Job Dashboard</title>
+  <meta charset="utf-8">
+  <meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport">
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%# Assets must use *_url route helpers to avoid being overriden by config.asset_host %>
+  <%= stylesheet_link_tag bootstrap_url(format: :css, v: GoodJob::VERSION), skip_pipeline: true %>
+  <%= stylesheet_link_tag style_url(format: :css, v: GoodJob::VERSION) %>
+
+  <%= javascript_include_tag bootstrap_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+  <%= javascript_include_tag chartjs_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+  <%= javascript_include_tag scripts_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+
+  <%= javascript_include_tag rails_ujs_url(format: :js, v: GoodJob::VERSION), nonce: true %>
+</head>
+<body>
+  <nav class="navbar navbar-expand-lg navbar-light bg-light">
+    <div class="container-fluid">
+      <%= link_to "GoodJob 👍", root_path, class: 'navbar-brand mb-0 h1' %>
+      <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+        <span class="navbar-toggler-icon"></span>
+      </button>
+
+      <div class="collapse navbar-collapse" id="navbarSupportedContent">
+        <ul class="navbar-nav me-auto">
+          <li class="nav-item">
+            <%= link_to "All Executions", root_path, class: ["nav-link", ("active" if current_page?(root_path))] %>
+          </li>
+          <li class="nav-item">
+            <%= link_to "All Jobs", jobs_path, class: ["nav-link", ("active" if current_page?(jobs_path))] %>
+          </li>
+          <li class="nav-item">
+            <%= link_to "Cron Schedules", cron_entries_path, class: ["nav-link", ("active" if current_page?(cron_entries_path))] %>
+          </li>
+          <li class="nav-item">
+            <%= link_to "Processes", processes_path, class: ["nav-link", ("active" if current_page?(processes_path))] %>
+          </li>
+          <li class="nav-item">
+            <div class="nav-link">
+              <span class="badge bg-secondary">More views coming soon</span>
+            </div>
+          </li>
+        </ul>
+        <div>
+          <input type="checkbox" id="toggle-poll" name="toggle-poll" data-gj-action='change#togglePoll' <%= 'checked' if params[:poll].present? %>>
+          <label for="toggle-poll">Live Poll</label>
+        </div>
+      </div>
+    </div>
+  </nav>
+
+  <div class="container-fluid">
+    <div class="card border-warning text-dark my-3">
+      <div class="card-body">
+        <p class="card-text">🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and code on <a href="https://github.com/bensheldon/good_job/issues" target="_blank" rel="nofollow noopener noreferrer">Github</a>.</p>
+      </div>
+    </div>
+
+    <% if notice %>
+      <div class="alert alert-success alert-dismissible fade show d-flex align-items-center offset-md-3 col-6" role="alert">
+        <%= render "good_job/shared/icons/check", class: "flex-shrink-0 me-2" %>
+        <div><%= notice %></div>
+        <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
+      </div>
+    <% elsif alert %>
+      <div class="alert alert-warning alert-dismissible fade show d-flex align-items-center offset-md-3 col-6" role="alert">
+        <%= render "good_job/shared/icons/exclamation", class: "flex-shrink-0 me-2" %>
+        <div><%= alert %></div>
+        <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
+      </div>
+    <% end %>
+
+    <%= yield %>
+  </div>
+
+  <footer class="footer mt-auto py-3 bg-light fixed-bottom" id="footer" data-gj-poll-replace>
+    <div class="container-fluid">
+      <div class="row">
+        <div class="col-6">
+          <span class="text-muted">
+            Last updated: <time id="page-updated-at" datetime="<%= Time.current.utc.iso8601 %>"><%= Time.current %></time>
+          </span>
+        </div>
+
+        <div class="col-6 text-end">
+          Remember, you're doing a Good Job too!
+        </div>
+      </div>
+    </div>
+  </footer>
+</body>
+</html>
diff --git a/bin/lint b/bin/lint
@@ -31,15 +31,15 @@ FileUtils.chdir GEM_ROOT do
 
   puts "\n== ERB Lint =="
   if options[:nofix]
-    system!("bundle exec erblint engine/app/views")
+    system!("bundle exec erblint app/views")
   else
     # Must run twice to run all linters
     # https://github.com/Shopify/erb-lint/issues/145
     puts "Running ERB Lint with autocorrectable linters"
-    system!("bundle exec erblint --autocorrect engine/app/views")
+    system!("bundle exec erblint --autocorrect app/views")
 
     puts "\nRunning ERB Lint with all linters"
-    system!("bundle exec erblint engine/app/views")
+    system!("bundle exec erblint app/views")
   end
 
   puts "\n== Markdown Lint =="

diff --git a/bin/test_app b/bin/test_app
@@ -1,4 +1,15 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../spec/test_app/config/application', __dir__)
-require_relative '../spec/test_app/config/boot'
-require 'rails/commands'
+#
+# Note: this command cannot be named "rails" because it will break generator specs with the message:
+# "Can't initialize a new Rails application within the directory of another, please change to a non-Rails directory first."
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/good_job/engine", __dir__)
+APP_PATH = File.expand_path("../spec/test_app/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"
diff --git a/bin/test_app_rake b/bin/test_app_rake
diff --git a/engine/config/locales/en.yml → config/locales/en.yml b/engine/config/locales/en.yml → config/locales/en.yml
diff --git a/engine/config/locales/es.yml → config/locales/es.yml b/engine/config/locales/es.yml → config/locales/es.yml
diff --git a/engine/config/routes.rb → config/routes.rb b/engine/config/routes.rb → config/routes.rb
diff --git a/engine/lib/good_job/engine.rb b/engine/lib/good_job/engine.rb
diff --git a/good_job.gemspec b/good_job.gemspec
@@ -28,7 +28,8 @@ Gem::Specification.new do |spec|
   }
 
   spec.files = Dir[
-    "engine/**/*",
+    "app/**/*",
+    "config/**/*",
     "lib/**/*",
     "README.md",
     "CHANGELOG.md",

diff --git a/config/i18n-tasks.yml → i18n-tasks.yml b/config/i18n-tasks.yml → i18n-tasks.yml
diff --git a/lib/good_job.rb b/lib/good_job.rb
@@ -1,7 +1,4 @@
 # frozen_string_literal: true
-require "rails"
-require "active_job"
-require "active_job/queue_adapters"
 
 require "zeitwerk"
 Zeitwerk::Loader.for_gem.tap do |loader|
@@ -12,7 +9,8 @@
   loader.setup
 end
 
-require "good_job/railtie"
+require "good_job/version"
+require "good_job/engine"
 
 # GoodJob is a multithreaded, Postgres-based, ActiveJob backend for Ruby on Rails.
 #

diff --git a/lib/good_job/railtie.rb → lib/good_job/engine.rb b/lib/good_job/railtie.rb → lib/good_job/engine.rb
@@ -1,7 +1,14 @@
 # frozen_string_literal: true
+
+require "rails"
+require "active_job"
+require "active_job/queue_adapters"
+
 module GoodJob
   # Ruby on Rails integration.
-  class Railtie < ::Rails::Railtie
+  class Engine < ::Rails::Engine
+    isolate_namespace GoodJob
+
     config.good_job = ActiveSupport::OrderedOptions.new
     config.good_job.cron = {}
 

diff --git a/spec/lib/good_job/railtie_spec.rb → spec/lib/good_job/engine_spec.rb b/spec/lib/good_job/railtie_spec.rb → spec/lib/good_job/engine_spec.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'rails_helper'
 
-RSpec.describe GoodJob::Railtie do
+RSpec.describe GoodJob::Engine do
   it 'copies over the Rails logger by default' do
     expect(GoodJob.logger).to eq Rails.logger
   end

diff --git a/spec/test_app/config/application.rb b/spec/test_app/config/application.rb
@@ -1,7 +1,6 @@
 require_relative 'boot'
 
 require 'rails/all'
-require "good_job/engine"
 
 Bundler.require(*Rails.groups)
 require "good_job"