Support Tasks with Params with CLI #428
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gmcgibbon
reviewed
Jun 2, 2021
| option, passing arguments as a set of <key>:<value> pairs: | ||
|
|
||
| ```bash | ||
| $ bundle exec maintenance_tasks perform Maintenance::ParamsTask --arguments post_ids:1,2,3 content:"Hello, World!" |
There was a problem hiding this comment.
I'd love if the example Task in the README match the CLI call here and the task in the dummy app, but I can look into this later, it doesn't need to be in this PR.
There was a problem hiding this comment.
Yeah, let's revisit this later. I'd like to ship custom value types in some form (even if not exactly what's in #414), so we can circle back to this example.
etiennebarrie
approved these changes
Jun 3, 2021
There was a problem hiding this comment.
We may want to fix the exception in arguments_match_task_attributes even if it doesn't impact anything too much, example repro:
diff --git i/test/models/maintenance_tasks/run_test.rb w/test/models/maintenance_tasks/run_test.rb
index 1d0449e..23de80f 100644
--- i/test/models/maintenance_tasks/run_test.rb
+++ w/test/models/maintenance_tasks/run_test.rb
@@ -6,3 +6,3 @@ class RunTest < ActiveSupport::TestCase
test "invalid if the task doesn't exist" do
- run = Run.new(task_name: "Maintenance::DoesNotExist")
+ run = Run.new(task_name: "Maintenance::DoesNotExist", arguments: { a: 0 })
refute_predicate run, :valid?Other feedback but feel free to ignore and 🚢
adrianna-chang-shopify
force-pushed
the
params-cli-support
branch
from
7d6855a to
8f70932
Compare
lawrencewong
pushed a commit
to lawrencewong/maintenance_tasks
that referenced
this pull request
Apr 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up to #413
The final piece of supporting Tasks with custom parameters in the gem - this allows arguments to be specified via the CLI using an
--argumentsflag.As discussed here, the use of Strong Parameters in TasksController to permit only keys matching the Task's attributes is a bit problematic because it results in a 500 instead of alerting the user. We also wanted to apply this same behaviour to the CLI. As such, I moved the check on the argument keys out of the controller and into
task.rb. However, I'm not sure if this is necessary - we could just allowActiveModel::UnknownAttributeErrorto be raised onassign_attributesand let that bubble up. Let me know if you think we're being overly defensive here!🎩 Instructions
cd test/dummy; bundle exec maintenance_tasks perform Maintenance::ParamsTask --arguments=post_ids:"1,2,3"Should see the Task successfully enqueued. To see the Task perform successfully, you can change the Active Job queue adapter to be inline.
cd test/dummy; bundle exec maintenance_tasks perform Maintenance::ParamsTask --arguments=post_ids:"xyz"Should see Validation failed: Arguments are invalid: :post_ids is invalid