refactor(classifier): make task.required a boolean #6094
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
eatyourgreens
commented
May 15, 2024
| @@ -6,10 +6,22 @@ const Task = types.model('Task', { | |||
| // override annotation in individual task models with specific annotation types | |||
| annotation: types.safeReference(Annotation), | |||
| taskKey: types.identifier, | |||
| required: types.maybe(types.union(types.string, types.boolean)), // text task required default = false | |||
| required: types.optional(types.boolean, false), // text task required default = false | |||
There was a problem hiding this comment.
Does anyone remember what the comment means here?
eatyourgreens
force-pushed
the
refactor-task-required
branch
7 times, most recently
from
be8797c
to
fca9cc2
Compare
Remove `types.string` from `task.required`. Fixes a small bug where a task with `required: 'false'` would be required. String values are now coerced to booleans in a snapshot preprocessor.
eatyourgreens
force-pushed
the
refactor-task-required
branch
from
fca9cc2
to
0b28270
Compare
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.
Remove
types.stringfromtask.required. Fixes a small bug where a task withrequired: 'false'would be required. String values are now coerced to booleans in a snapshot preprocessor.Please request review from
@zooniverse/frontendteam or an individual member of that team.Package
Linked Issue and/or Talk Post
How to Review
This shouldn't change any live projects. The project builder nowadays should be saving
task.requiredas a boolean, so the string type was only needed for very old workflows. You could deliberately create a workflow task withrequired: 'false', with an API client, but I've added tests to verify that legacy string values are handled correctly now.Checklist
PR Creator - Please cater the checklist to fit the review needed for your code changes.
PR Reviewer - Use the checklist during your review. Each point should be checkmarked or discussed before PR approval.
General
yarn panic && yarn bootstrapordocker-compose up --buildand FEM works as expectedGeneral UX
Example Staging Project: i-fancy-cats
Refactoring