[#45547] - [5.4] Improve autoupdate UX for local site
- Fixed in Code Base
- 3 Jun 2025
- Medium
- Build: 5.4-dev
- # 45547
- Diff
- SniperSister:5.4-autoupdate-improvements
User tests: Successful: Unsuccessful:
Summary of Changes
So far the autoupdate server did return a server error if a user tried to register a site in non-internet environment, i.e. on local host.
A recent update on the server now returns a dedicated status code for these scenarios, allowing the proper handling of this scenario.
Futher tweaks:
- the guided tour for updated installations showed a "enable now" button that caused a redirect loop and therefore has been removed
- the submitted information has been described in the configuration
Testing Instructions
- Install a new site on a local enviroment
- Quickicon UX fixes: Verify the message and color shown in the autoupdate quick icon
- Config UX fixes: Switch to the config page of com_joomlaupdate and disable autoupdates. Hit save. Re-Enable autoupdates, hit save and check the error message.
- Guided tour fixes: verify that the button has been removed from the language file by code review
- Submitted data description: verify that the updated information block is shown on the config page of com_joomlaupdate
Please note: a JS file has been changed in this PR, so it's necessary to rebuild the NPM dependencies, see https://docs.joomla.org/J4.x:Setting_Up_Your_Local_Environment#Node.2Fnpm_Scripts
Actual result BEFORE applying this Pull Request
- Quickicon showing a red error message about an "unknown health status"; remains the same on refresh
- Config page shows a red error message
- Guided Tour description has button
- Config page shows data info
Expected result AFTER applying this Pull Request
- Quickicon showing an orange warning message about the unavailable of autoupdates; after refresh, icon states that autoupdates are disabled
- Config page shows an orange warning message about
- Guided Tour description doesn't have the button
- Config page shows data info
Screenshot
Link to documentations
Please select:
-
Documentation link for docs.joomla.org:
-
No documentation changes for docs.joomla.org needed
-
Pull Request link for manual.joomla.org:
-
No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Administration com_joomlaupdate Language & Strings JavaScript Repository NPM Change Libraries Front End Plugins |
| Labels |
Added:
Language Change
NPM Resource Changed
PR-5.4-dev
|
||
I have tested this item ✅ successfully on 6102af6
1. Tested with JBT on current 5.4-dev branch on local site
- Before: Red and Error Invalid URL
- After:
- ✅ The automated update service is unavailable for your site as it's not accessible from the internet. Automated updates have been disabled.
- ✅ It is not possible to enable automated updates
- ✅ Big info box is there (Note: if there are other changes, then 'site URL' -> 'Site URL' for consistency?)
- Tested with public availiable site joomla-test.heikol.de as 5.3.1 site copy and updated with Custom URL from artefacts to 5.4.0-alpha2-dev+pr.45547
- ✅ 2-step updated guided tour w/o 'Automated Updates' button
- ✅ Showing new big 'Automated updates' notice and one more notice:
- ✅ 'Automated updates are only supported for the "default" channel and "Minimum Stability" "Stable".'
- ✅ No switch to enable Automated Update exist
- Switched back to update channel 'Default' and enabled Automated Updates
- 14:34 CEST red 'Error while registering to automated update service: (0).
- No log file entries
- Fails also for second and third try
- Counting as using Alpha
- Installing 'System - Alpha Update Server' doesn't help either
- Assume it is not testable in this setup
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45547.
Don't use XHTML markup. There is no need for a line break to have a closure
I've restored @muhme 's test result in the issue tracker as the commits which invalidated the test count were only a fix for the casing of a method parameter name, which I've just reviewed with success, and changes on a language string suggested by him, and finally a change of the markup from <ul> to just text with <br> (with @brianteeman suggestion applied), which I've also just reviewed.
Pre-test question, my quickicon before patch states "Unknown Health status ...", nothing about broken link. Are the testing instructions correct on that step?
@Bodge-IT sounds like the NPM build is missing, I've added a note in the the instructions
@SniperSister His question was related to the situation WITHOUT the PR, BEFORE patch. It should not need NPM for that.
The description in section "Actual result BEFORE applying this Pull Request" says "Quickicon showing a red error message about a broken connection; remains the same on refresh", but @Bodge-IT got "Unknown Health status ...".
Pre-test question, my quickicon before patch states "Unknown Health status ..."
Same for me, before applying this PR on a local (not internet-reachable) site the autoupdate status shows red 'Unknown Health status ...'. The test description may not be entirely correct at this point.
TL;DR: I've updated the test instructions with the correct expected pre-patch message.
Long story: the currently shipped version of the JS does know how to handle the validation error code that's being returned by the updated server version and therefore shows the message about an unknown status.
I have tested this item ✅ successfully on e0b257d
All expected outcomes verified.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45547.
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45547.
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2025-06-03 08:08:02 |
| Closed_By | ⇒ | richard67 | |
| Labels |
Added:
RTC
|
||
Thanks all (author, reviewers and testers).
Please change inaccessible to not accessible