Page MenuHomePhabricator
Create Task
Maniphest T315099

zObject creation: errors / blockers to saving are not surfaced well or at all
Closed, ResolvedPublic
Actions

Description

Every zObject requires a label for the save button to be enabled (it is disabled by default). For ZImplementations and ZTesters, the save button further requires the selection of a zFunction.

There is no feedback to the user as to why the save button is grayed out and what they need to do for it to be un-grayed out. We need to surface form validation errors in a comprehensible way. Additionally, we need to ensure when saving does fail, it is clear to the user what to do to correct it.

Details

SubjectRepoBranchLines +/-
Add checks for missing inputs for ZImplementation and ZTestermediawiki/extensions/WikiLambdamaster+225 -42
allow ZObject saving at all times, and surface errors for ZFunction, ZImplementation and ZTestermediawiki/extensions/WikiLambdamaster+431 -110
Customize query in gerrit

Related Objects
Search...

Event Timeline

• JKieserman created this task.Aug 12 2022, 5:27 PM
DVrandecic moved this task from To triage to Phase θ – Throttling on the Abstract Wikipedia team board.Aug 16 2022, 6:46 PM
DVrandecic edited projects, added Abstract Wikipedia team (Phase θ – Throttling); removed Abstract Wikipedia team.
DVrandecic added a subtask: T315002: Error handling in the front-end after returning the response for every API.
gengh subscribed.Aug 22 2022, 2:27 PM

Needs discussion with Amin on what kinds of front-end validation we should do, and what should be the format of the errors surfaced.

For the moment I believe this patch can be addressed and limited to the following:

  • remove isCurrentZObjectValid from the :disabled parameter of the save button
  • modify isCurrentZObjectValid so that it's a method that instead of just returning true/false it also returns something identifying the type of error that we are getting.
  • call isCurrentZObjectValid when clicking the error and showing the identifying message if it returns false.

We should make these changes as expansible as possible so that:

  • validation method can be cleanly expanded once we decide all different use cases that will be detected in the front-end as invalid
  • we currently show the output error in the simplest way possible, but in the future we can decide to:
    • show the message in a toast or a dialog, or
    • show the message next to the related input field, or
    • both
gengh added projects: WikiLambda, WikiLambda Front-end.Aug 22 2022, 2:27 PM
gengh moved this task from Incoming to Ready: G5. Fallback view on the Abstract Wikipedia team (Phase θ – Throttling) board.
• JKieserman claimed this task.Sep 19 2022, 6:26 PM
gerritbot added a comment.Oct 3 2022, 10:21 PM

Change 837752 had a related patch set uploaded (by Jkieserman; author: Jkieserman):

[mediawiki/extensions/WikiLambda@master] errors

https://gerrit.wikimedia.org/r/837752

gerritbot added a project: Patch-For-Review.Oct 3 2022, 10:21 PM
gerritbot added a comment.Oct 14 2022, 3:21 PM

Change 837752 abandoned by Jkieserman:

[mediawiki/extensions/WikiLambda@master] allow ZObject saving at all times, and surface errors for ZFunction, ZImplementation and ZTester

Reason:

in favor of https://gerrit.wikimedia.org/r/c/mediawiki/extensions/WikiLambda/+/842834

https://gerrit.wikimedia.org/r/837752

Maintenance_bot removed a project: Patch-For-Review.Oct 14 2022, 3:29 PM
gengh mentioned this in T321381: Publish component: Create a publish component used in all Wikifunctions create and edit pages.Oct 21 2022, 10:05 AM
• JKieserman added a subtask: T320269: Don't disable buttons on failed validation, instead, surface errors and highlight missing fields when button is clicked.Oct 21 2022, 4:36 PM
• JKieserman added a subtask: T321401: Catch missing ZTester and ZImplementation properties with FE error management.
gengh mentioned this in T320269: Don't disable buttons on failed validation, instead, surface errors and highlight missing fields when button is clicked.Oct 24 2022, 9:57 AM
• JKieserman added a subtask: T321623: modify error message system to accomodate links and special formatting.Oct 25 2022, 8:20 PM
• JKieserman moved this task from Ready: G5. Fallback view to QA / Ready to close on the Abstract Wikipedia team (Phase θ – Throttling) board.Nov 14 2022, 2:21 PM
gerritbot added a comment.Nov 15 2022, 4:28 PM

Change 857005 had a related patch set uploaded (by Jkieserman; author: Jkieserman):

[mediawiki/extensions/WikiLambda@master] Add checks for missing inputs for ZImplementation and ZTester

https://gerrit.wikimedia.org/r/857005

gerritbot added a project: Patch-For-Review.Nov 15 2022, 4:28 PM
gengh moved this task from QA / Ready to close to Ready: G5. Fallback view on the Abstract Wikipedia team (Phase θ – Throttling) board.Nov 15 2022, 7:26 PM
gengh closed subtask T320269: Don't disable buttons on failed validation, instead, surface errors and highlight missing fields when button is clicked as Resolved.Nov 15 2022, 8:05 PM
gerritbot added a comment.Nov 18 2022, 2:22 AM

Change 857005 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] Add checks for missing inputs for ZImplementation and ZTester

https://gerrit.wikimedia.org/r/857005

Maintenance_bot removed a project: Patch-For-Review.Nov 18 2022, 2:30 AM
ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.12; 2022-11-28).Nov 18 2022, 3:00 AM
• JKieserman moved this task from Ready: G5. Fallback view to QA / Ready to close on the Abstract Wikipedia team (Phase θ – Throttling) board.Nov 21 2022, 2:25 PM
gengh closed subtask T321401: Catch missing ZTester and ZImplementation properties with FE error management as Resolved.Nov 23 2022, 8:53 AM
gengh moved this task from QA / Ready to close to Ready: G5. Fallback view on the Abstract Wikipedia team (Phase θ – Throttling) board.Nov 23 2022, 12:20 PM
• JKieserman closed subtask T321623: modify error message system to accomodate links and special formatting as Invalid.Nov 28 2022, 3:04 PM
• JKieserman closed subtask T315002: Error handling in the front-end after returning the response for every API as Resolved.Nov 29 2022, 3:29 PM
• JKieserman moved this task from Ready: G5. Fallback view to QA / Ready to close on the Abstract Wikipedia team (Phase θ – Throttling) board.Dec 7 2022, 11:15 PM
• RWambua-WMF added a parent task: T324802: Phase θ Goal 5: Fallback view.Dec 8 2022, 11:51 PM
• RWambua-WMF closed this task as Resolved.Jan 4 2023, 9:16 PM
• RWambua-WMF closed subtask T321404: update cdx-text-input to use native codex error state as part of FE error management as Resolved.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits