change_requests 0.3.0 → 0.4.0

data/lib/tasks/change_requests.rake

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
 # Loaded by the engine's lib/tasks path, so a host gets these from its own `Rails.application
-# .load_tasks` with nothing to require. M3b adds the maintenance sweepers to this namespace.
+# .load_tasks` with nothing to require.
+#
+# The three sweepers below raise on error and say nothing else, so cron's own mail-on-failure is
+# the alarm. See docs/05_execution_and_idempotency.md for which of them belong on a schedule.
 namespace :change_requests do
+  # A local rather than a method: `def` in a .rake file defines on the top level, where it would
+  # collide with whatever the host calls its own helpers. The task blocks close over it.
+  #
+  # Rake exits non-zero when a task raises, so nothing below rescues: an error is an error, and a
+  # sweep that moved nothing is not one.
+  report = lambda do |verb, count|
+    puts "ChangeRequests: #{verb} #{count} #{"request".pluralize(count)}."
+  end
+
   desc "Verify every declared operation: its version, target and workflow (§6.12 point 6)"
   task verify: :environment do
     count = ChangeRequests.operations.keys.size
@@ -18,4 +30,30 @@ namespace :change_requests do
 
     puts "ChangeRequests: #{count} #{"operation".pluralize(count)} verified."
   end
+
+  desc "Expire pending and approved requests whose deadline has passed (§8)"
+  task expire_stale: :environment do
+    report.call("expired", ChangeRequests::Maintenance.expire_stale!)
+  end
+
+  desc "Write off executions nobody settled - OLDER_THAN seconds, default one hour (§8)"
+  task reap_stuck_executions: :environment do
+    older_than = ENV.fetch("OLDER_THAN", nil)&.to_i
+
+    count = if older_than
+              ChangeRequests::Maintenance.reap_stuck_executions!(older_than: older_than)
+            else
+              ChangeRequests::Maintenance.reap_stuck_executions!
+            end
+
+    report.call("reaped", count)
+  end
+
+  # Deliberately not on a schedule: a missing declaration is as likely to be a deploy accident as
+  # a deliberate removal, and `canceled` is final (§5.11). Refusal and invisibility are immediate
+  # and reversible; this is not.
+  desc "Cancel open requests whose operation is no longer declared - run by hand (§5.11)"
+  task cancel_undeclared: :environment do
+    report.call("canceled", ChangeRequests::Maintenance.cancel_undeclared!)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: change_requests
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andreas Finger
@@ -310,6 +310,7 @@ files:
 - Rakefile
 - config/locales/en.yml
 - config/routes.rb
+- docs/05_execution_and_idempotency.md
 - docs/08_events_and_notifications.md
 - docs/adr/0001-headless-domain-core.md
 - docs/adr/0002-mountable-engine-with-isolated-namespace.md
@@ -332,6 +333,13 @@ files:
 - docs/adr/0019-separation-of-duties.md
 - docs/adr/0020-refusal-vocabulary-and-fallback.md
 - docs/adr/0021-serialise-commands-let-the-index-arbitrate.md
+- docs/adr/0022-execution-in-three-transactions.md
+- docs/adr/0023-one-declaration-surface.md
+- docs/adr/0024-idempotence-is-required-not-declared.md
+- docs/adr/0025-verification-from-one-set-of-checks.md
+- docs/adr/0026-distinct-intent-distinct-command.md
+- docs/adr/0027-activejob-is-optional.md
+- docs/adr/0028-sweeps-are-rake-tasks.md
 - docs/adr/README.md
 - lib/change_requests.rb
 - lib/change_requests/authorization/callable.rb
@@ -339,6 +347,7 @@ files:
 - lib/change_requests/commands/approve.rb
 - lib/change_requests/commands/base.rb
 - lib/change_requests/commands/cancel.rb
+- lib/change_requests/commands/cancel_undeclared.rb
 - lib/change_requests/commands/claim_execution.rb
 - lib/change_requests/commands/comment.rb
 - lib/change_requests/commands/create.rb
@@ -346,6 +355,7 @@ files:
 - lib/change_requests/commands/execute.rb
 - lib/change_requests/commands/expire.rb
 - lib/change_requests/commands/override.rb
+- lib/change_requests/commands/reap.rb
 - lib/change_requests/commands/reject.rb
 - lib/change_requests/commands/settle_execution.rb
 - lib/change_requests/commands/unapprove.rb
@@ -356,6 +366,7 @@ files:
 - lib/change_requests/engine.rb
 - lib/change_requests/errors.rb
 - lib/change_requests/execution/dispatcher.rb
+- lib/change_requests/execution/job.rb
 - lib/change_requests/execution/runner.rb
 - lib/change_requests/execution/target_contract.rb
 - lib/change_requests/guards/.keep
@@ -365,8 +376,10 @@ files:
 - lib/change_requests/guards/comment.rb
 - lib/change_requests/guards/execute.rb
 - lib/change_requests/guards/expire.rb
+- lib/change_requests/guards/reap.rb
 - lib/change_requests/guards/reject.rb
 - lib/change_requests/guards/unapprove.rb
+- lib/change_requests/maintenance.rb
 - lib/change_requests/models/.keep
 - lib/change_requests/models/approval.rb
 - lib/change_requests/models/approval_quorum.rb