XWIKI-22830: CreateWiki: Next step button remains disabled if one fills the wiki identifier before the pretty name #3852
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
…ls the wiki identifier before the pretty name * Added changes to the next-step button in the prettyName event handler.
mflorea
requested changes
Feb 4, 2025
There was a problem hiding this comment.
The way we validate the wiki name and pretty name needs to be refactored a bit. My suggestion is to:
- have a validation function for each field that requires validation; this can be either synchronous (as for wiki pretty name) or asynchronous (as for wiki name); what's important is that each field can be in 3 states: valid, invalid, loading
- have a function that updates the state of the Next button: enables it only if all fields are in valid state (i.e. no loading and no invalid)
- a change on a field triggers the validation function for that field which triggers the Next button state update
- for asynchronous validation functions the practice is usually that when a change is detected:
- the previously scheduled validation is aborted (usually with
clearTimeoutor aborting the HTTP request) - the field is put in loading state
- a new validation is scheduled in 500ms or so (to not validate on each keystroke but rather when the user stops typing)
- the previously scheduled validation is aborted (usually with
| @@ -857,6 +858,7 @@ $xwiki.getURL('XWiki.XWikiPreferences', 'admin', "editor=globaladmin&section | |||
| if(prettyName.value.blank()){ | |||
| $('wikiprettynamevalidation').innerHTML = "$MSG_ERROR_WIKIPRETTYNAMEEMPTY"; | |||
| prettyName.addClassName('xErrorField'); | |||
| $('wizard-next').disabled = true; | |||
There was a problem hiding this comment.
The wiki name validation is asynchronous, which means we can have this case:
- the user types a valid wiki name, which triggers a validation HTTP request
- the network is slow, so the user can clear the wiki pretty name before the validation response is received; this disables the Next button
- the validation response is received, and the Next button is enabled => the user can move to the next step with an empty wiki pretty name
| @@ -866,6 +868,11 @@ $xwiki.getURL('XWiki.XWikiPreferences', 'admin', "editor=globaladmin&section | |||
| wikiName.value = prettyName.value.replace(/[^a-zA-Z0-9]/g,'_').toLowerCase(); | |||
| validateWikiName(); | |||
| } | |||
| // No matter the path, at this point, the wikiName has been already validated. | |||
There was a problem hiding this comment.
This is not true, because the wiki name validation is asynchronous. We can have this case:
- the user types an invalid wiki name, which triggers a validation HTTP request
- the network is slow, so the user can type the wiki pretty name before the validation response is received; this enables the Next button => the user can move to the next step with an invalid wiki name
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.
Jira URL
https://jira.xwiki.org/browse/XWIKI-22830
Changes
Description
Screenshots & Video
In the video demo below, I tried out a bunch of combinations, to show that the state of the button is the right one no matter the operations made by the user on the form. Among them, I showcase that the use case that was failing and reported in the ticket is fixed.
2025-01-29.17-32-23.mp4
Executed Tests
Manual tests, see demo above.
Successfully built the module with a change with the quality profile:
mvn clean install -f xwiki-platform-core/xwiki-platform-wiki/xwiki-platform-wiki-ui/xwiki-platform-wiki-ui-mainwiki -PqualityExpected merging strategy