maintenance_tasks 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e274988d4a5facd653134ab4d4f2c51a71957ad8b2e6e1e16958f3726d50bb1
-  data.tar.gz: beae97f203e12ed5017b9a76e1ced6b8d9f3e9e8ca8bc65a85a63d781d150bcf
+  metadata.gz: '017924f32ef1d9cb9e8ef6b739e1dc7ab60695dce1ee03c9f9f14fcaa35dfdde'
+  data.tar.gz: 17d3d2e220dd8b3cc7270797398abe33e5c90e38a3d19b28a571cb61c94a567c
 SHA512:
-  metadata.gz: 67ed786c6c0281422ef4a10af1167c129cbab7422624656c3cae3eb3fe8f35bc5df00f874f2aee2a1eacf54fe957faccd5a4df12240e3f461b81817cdd5347a7
-  data.tar.gz: 3cf190c896f046accf647b74e6acb58680b9e7eb89d25ea58e1a58e2db48e5437c5a410f2536c440c494efc599ea635a0380fc6a554ae157b53b402efbda4211
+  metadata.gz: '0942f2e8f1d23e1dc180a13deef7af7c198dcb348fdd62ed0c9107d4eded0a7908c0477c6e15c954658f4a99a41c5858fec4b02477d8deed4f72f44c4ae7cb5e'
+  data.tar.gz: 61c1d448e4c1eaf7a8076dc253d72de1d515b70ed4623b76a290b24dd4e6f0c76aff6fccde27619eceffc497ca750910aa9590363f2c3cbd2085a75a8838a18f

data/app/controllers/maintenance_tasks/application_controller.rb

@@ -3,7 +3,7 @@
 module MaintenanceTasks
   # Base class for all controllers used by this engine.
   #
-  # @api private
+  # Can be extended to add different authentication and authorization code.
   class ApplicationController < ActionController::Base
     include Pagy::Backend
 
@@ -22,5 +22,4 @@ module MaintenanceTasks
 
     protect_from_forgery with: :exception
   end
-  private_constant :ApplicationController
 end

data/app/controllers/maintenance_tasks/runs_controller.rb

@@ -30,5 +30,4 @@ module MaintenanceTasks
       @run = Run.find(params.fetch(:id))
     end
   end
-  private_constant :RunsController
 end

data/app/controllers/maintenance_tasks/tasks_controller.rb

@@ -42,5 +42,4 @@ module MaintenanceTasks
       @refresh = 3
     end
   end
-  private_constant :TasksController
 end

data/app/helpers/maintenance_tasks/application_helper.rb

@@ -29,5 +29,4 @@ module MaintenanceTasks
       end
     end
   end
-  private_constant :ApplicationHelper
 end

data/app/helpers/maintenance_tasks/{task_helper.rb → tasks_helper.rb}

@@ -6,7 +6,7 @@ module MaintenanceTasks
   # Helpers for formatting data in the maintenance_tasks views.
   #
   # @api private
-  module TaskHelper
+  module TasksHelper
     STATUS_COLOURS = {
       'new' => ['is-primary'],
       'enqueued' => ['is-primary is-light'],
@@ -114,5 +114,4 @@ module MaintenanceTasks
       )
     end
   end
-  private_constant :TaskHelper
 end

data/app/jobs/maintenance_tasks/task_job.rb

@@ -97,8 +97,27 @@ module MaintenanceTasks
       @ticker.persist
     end
 
+    # We are reopening a private part of Job Iteration's API here, so we should
+    # ensure the method is still defined upstream. This way, in the case where
+    # the method changes upstream, we catch it at load time instead of at
+    # runtime while calling `super`.
+    unless private_method_defined?(:reenqueue_iteration_job)
+      error_message = <<~HEREDOC
+        JobIteration::Iteration#reenqueue_iteration_job is expected to be
+        defined. Upgrading the maintenance_tasks gem should solve this problem.
+      HEREDOC
+      raise error_message
+    end
+    def reenqueue_iteration_job(should_ignore: true)
+      super() unless should_ignore
+      @reenqueue_iteration_job = true
+    end
+
     def after_perform
       @run.save!
+      if defined?(@reenqueue_iteration_job) && @reenqueue_iteration_job
+        reenqueue_iteration_job(should_ignore: false)
+      end
     end
 
     def on_error(error)

data/app/models/maintenance_tasks/application_record.rb

@@ -2,9 +2,9 @@
 module MaintenanceTasks
   # Base class for all records used by this engine.
   #
-  # @api private
+  # Can be extended to setup different database where all tables related to
+  # maintenance tasks will live.
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
   end
-  private_constant :ApplicationRecord
 end

data/app/models/maintenance_tasks/csv_collection.rb

@@ -30,5 +30,4 @@ module MaintenanceTasks
       csv_content.count("\n") - 1
     end
   end
-  private_constant :CsvCollection
 end

data/app/models/maintenance_tasks/progress.rb

@@ -49,7 +49,7 @@ module MaintenanceTasks
     def title
       if !total?
         "Processed #{@run.tick_count} #{'item'.pluralize(@run.tick_count)}."
-      elsif @run.tick_count > @run.tick_total
+      elsif over_total?
         "Processed #{@run.tick_count} #{'item'.pluralize(@run.tick_count)} " \
           "(expected #{@run.tick_total})."
       else
@@ -67,8 +67,11 @@ module MaintenanceTasks
     end
 
     def estimatable?
-      total? && @run.tick_total > @run.tick_count
+      total? && !over_total?
+    end
+
+    def over_total?
+      @run.tick_count > @run.tick_total
     end
   end
-  private_constant :Progress
 end

data/app/models/maintenance_tasks/run.rb

@@ -195,5 +195,4 @@ module MaintenanceTasks
       nil
     end
   end
-  private_constant :Run
 end

data/app/models/maintenance_tasks/task_data.rb

@@ -138,5 +138,4 @@ module MaintenanceTasks
       Run.where(task_name: name).with_attached_csv_file.order(created_at: :desc)
     end
   end
-  private_constant :TaskData
 end

data/app/models/maintenance_tasks/ticker.rb

@@ -54,5 +54,4 @@ module MaintenanceTasks
       Time.now - @last_persisted >= @throttle_duration
     end
   end
-  private_constant :Ticker
 end

data/app/tasks/maintenance_tasks/task.rb

@@ -16,9 +16,12 @@ module MaintenanceTasks
       #
       # @raise [NotFoundError] if a Task with the given name does not exist.
       def named(name)
-        name.constantize
-      rescue NameError
-        raise NotFoundError.new("Task #{name} not found.", name)
+        task = name.safe_constantize
+        raise NotFoundError.new("Task #{name} not found.", name) unless task
+        unless task.is_a?(Class) && task < Task
+          raise NotFoundError.new("#{name} is not a Task.", name)
+        end
+        task
       end
 
       # Returns a list of concrete classes that inherit from the Task

data/app/validators/maintenance_tasks/run_status_validator.rb

@@ -85,5 +85,4 @@ module MaintenanceTasks
       )
     end
   end
-  private_constant :RunStatusValidator
 end

data/app/views/maintenance_tasks/runs/_info.html.erb

@@ -1,5 +1,6 @@
 <h5 class="title is-5">
   <%= time_tag run.created_at, title: run.created_at %>
+  <%= status_tag run.status if with_status %>
 </h5>
 
 <%= progress run %>

data/app/views/maintenance_tasks/runs/_run.html.erb

@@ -1,8 +1,3 @@
 <div class="box">
-  <h5 class="title is-5">
-    <%= time_tag run.created_at, title: run.created_at %>
-    <%= status_tag run.status %>
-  </h5>
-
-  <%= render 'maintenance_tasks/runs/info', run: run %>
+  <%= render 'maintenance_tasks/runs/info', run: run, with_status: true %>
 </div>

data/db/migrate/20210225152418_remove_index_on_task_name.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class RemoveIndexOnTaskName < ActiveRecord::Migration[6.1]
+  def up
+    change_table(:maintenance_tasks_runs) do |t|
+      t.remove_index(:task_name)
+    end
+  end
+
+  def down
+    change_table(:maintenance_tasks_runs) do |t|
+      t.index(:task_name)
+    end
+  end
+end

data/lib/generators/maintenance_tasks/install_generator.rb

@@ -18,5 +18,4 @@ module MaintenanceTasks
       rake('db:migrate')
     end
   end
-  private_constant :InstallGenerator
 end

data/lib/generators/maintenance_tasks/task_generator.rb

@@ -77,5 +77,4 @@ module MaintenanceTasks
       Rails.application.config.generators.options[:rails][:test_framework]
     end
   end
-  private_constant :TaskGenerator
 end

data/lib/maintenance_tasks.rb

@@ -9,6 +9,10 @@ require 'maintenance_tasks/engine'
 require 'pagy'
 require 'pagy/extras/bulma'
 
+# Force the TaskJob class to load so we can verify upstream compatibility with
+# the JobIteration gem
+require_relative '../app/jobs/maintenance_tasks/task_job'
+
 # The engine's namespace module. It provides isolation between the host
 # application's code and the engine-specific code. Top-level engine constants
 # and variables are defined under this module.

data/lib/maintenance_tasks/cli.rb

@@ -51,5 +51,4 @@ module MaintenanceTasks
       end
     end
   end
-  private_constant :CLI
 end

data/lib/maintenance_tasks/engine.rb

@@ -7,6 +7,10 @@ module MaintenanceTasks
   class Engine < ::Rails::Engine
     isolate_namespace MaintenanceTasks
 
+    initializer 'eager_load_for_classic_autoloader' do
+      eager_load! unless Rails.autoloaders.zeitwerk_enabled?
+    end
+
     config.to_prepare do
       unless Rails.autoloaders.zeitwerk_enabled?
         tasks_module = MaintenanceTasks.tasks_module.underscore
@@ -17,7 +21,6 @@ module MaintenanceTasks
     end
 
     config.after_initialize do
-      eager_load! unless Rails.autoloaders.zeitwerk_enabled?
       JobIteration.max_job_runtime ||= 5.minutes
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -107,7 +107,7 @@ files:
 - app/controllers/maintenance_tasks/runs_controller.rb
 - app/controllers/maintenance_tasks/tasks_controller.rb
 - app/helpers/maintenance_tasks/application_helper.rb
-- app/helpers/maintenance_tasks/task_helper.rb
+- app/helpers/maintenance_tasks/tasks_helper.rb
 - app/jobs/maintenance_tasks/task_job.rb
 - app/models/maintenance_tasks/application_record.rb
 - app/models/maintenance_tasks/csv_collection.rb
@@ -136,6 +136,7 @@ files:
 - app/views/maintenance_tasks/tasks/show.html.erb
 - config/routes.rb
 - db/migrate/20201211151756_create_maintenance_tasks_runs.rb
+- db/migrate/20210225152418_remove_index_on_task_name.rb
 - exe/maintenance_tasks
 - lib/generators/maintenance_tasks/install_generator.rb
 - lib/generators/maintenance_tasks/task_generator.rb
@@ -150,10 +151,10 @@ files:
 homepage: https://github.com/Shopify/maintenance_tasks
 licenses: []
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.1.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.1.1
   allowed_push_host: https://rubygems.org
 post_install_message: |-
-  Thank you for installing Maintenance Tasks 1.1.0. To complete, please run:
+  Thank you for installing Maintenance Tasks 1.1.1. To complete, please run:
 
   rails generate maintenance_tasks:install
 rdoc_options: []