Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better error reporting in Wikibase schema #5131

Merged
merged 6 commits into from
Aug 13, 2022

Conversation

wetneb
Copy link
Member

@wetneb wetneb commented Jul 30, 2022

Fixes #4724.

This adds explicit error messages indicating which parts of the schema are incomplete.
For now they can only be partially localized, but once backend localization is introduced in the Wikidata extension, the error messages that are generated there could also be localized too.

Screenshot

image

@wetneb wetneb requested review from lozanaross and elebitzero July 30, 2022 12:53
@github-actions github-actions bot added Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements. error handling Improving the ways errors are reported to users wikibase Related to wikidata/wikibase integration labels Jul 30, 2022
Copy link
Member

@elebitzero elebitzero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. If I add a statement, and leave the property empty and click 'Save Schema', I see an exception. (Screenshot#1):
    image

  2. If I add a term, and leave it empty and then click 'Save Schema', it appears to do it (Screenshot#2), but the previous behavior would not save and displays an error message "Your schema is incomplete so it cannot be saved yet" (Screenshot#3):
    image

image

@wetneb
Copy link
Member Author

wetneb commented Aug 5, 2022

Thanks a lot, this was very sloppy on my side!

In terms of user experience, I am not completely satisfied with the current situation. The validation errors are displayed in the Issues and Preview tab, but will users look for them there? Should we change the message in the alert to indicate that users can go to the issues tab to see the validation errors? Alternatively, we could remove this alert and simply switch users to the Issues tab whenever they try to save an incomplete schema, perhaps?

@wetneb
Copy link
Member Author

wetneb commented Aug 13, 2022

Since this is getting stale, let's just merge it and deal with any improvements in follow-up PRs.

@wetneb wetneb merged commit 4e90cba into master Aug 13, 2022
@lozanaross
Copy link

In terms of user experience, I am not completely satisfied with the current situation. The validation errors are displayed in the Issues and Preview tab, but will users look for them there? Should we change the message in the alert to indicate that users can go to the issues tab to see the validation errors? Alternatively, we could remove this alert and simply switch users to the Issues tab whenever they try to save an incomplete schema, perhaps?

I think a better alert message would be preferable to just unexpetedly switching users to another tab. Something like: "You schema is incomplete so cannot be saved yet. Go to the Issues tab to review validation errors."

@wetneb wetneb deleted the 4724-better-schema-error-reporting branch October 7, 2022 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
error handling Improving the ways errors are reported to users Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements. wikibase Related to wikidata/wikibase integration
Projects
None yet
3 participants