Evaluate metadata block in the context of the controller (#873)

Author: jennaleeb

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maintenance_tasks (2.3.0)
+    maintenance_tasks (2.3.1)
       actionpack (>= 6.0)
       activejob (>= 6.0)
       activerecord (>= 6.0)

README.md

@@ -840,8 +840,8 @@ or email of the user who performed the maintenance task.
 
 ```ruby
 # config/initializers/maintenance_tasks.rb
-MaintenanceTasks.metadata = -> do
- { user_email: current_user.email }
+MaintenanceTasks.metadata = ->(context) do
+ { user_email: context.current_user.email }
 end
 ```
 

app/controllers/maintenance_tasks/runs_controller.rb

@@ -14,7 +14,7 @@ def create(&block)
         name: params.fetch(:task_id),
         csv_file: params[:csv_file],
         arguments: params.fetch(:task_arguments, {}).permit!.to_h,
-        metadata: MaintenanceTasks.metadata&.call,
+        metadata: instance_exec(&MaintenanceTasks.metadata || -> {}),
         &block
       )
       redirect_to(task_path(task))

maintenance_tasks.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "maintenance_tasks"
-  spec.version = "2.3.0"
+  spec.version = "2.3.1"
   spec.author = "Shopify Engineering"
   spec.email = "[email protected]"
   spec.homepage = "https://github.com/Shopify/maintenance_tasks"

test/system/maintenance_tasks/runs_test.rb

@@ -21,7 +21,7 @@ class RunsTest < ApplicationSystemTestCase
       assert_equal "enqueued", run.status
     end
 
-    test "run a Task and log the user email" do
+    test "run a Task and log the provided metadata" do
       MaintenanceTasks.metadata = -> { { user_email: "[email protected]" } }
       visit(maintenance_tasks_path)