Show messages for users if the ROOT_URL is wrong, show JavaScript errors #18971

wxiaoguang · 2022-03-02T11:05:17Z

ROOT_URL issues

Many maintainers have answered the issues about incorrect ROOT_URL again and again.

Using HTMLURL(absolute URL) in templates is the root case that Gitea can only serve web under ROOT_URL. That's why we have to force users to set ROOT_URL correctly, and that's why this PR came. If all URLs in template can be refactored to use Relative URL correctly, then we do not need to force users set ROOT_URL correctly again and again.

Actually, at the moment, there are 2 major cases:

The assets can not be loaded (AppSubUrl != "" and users try to access http://host:3000/)
The ROOT_URL is wrong, then many URLs in Gitea are broken.

This PR can detect these problems, and show enough information to users. No i18n is needed because these messages should only be processed by Gitea admin.

JavaScript error issues

And, there are many users affected by JavaScript errors:

And more and more

If these problems (JS errors) can be found at first time, then maintainers do not need to ask about how bug occurs again and again.

Screenshots:

Can not load `index.js`

Incorrect ROOT_URL

JavaScript error

mainly caused by incorrect customized templates, or incorrect cached files

`window.config` broken

FAQ

What if some users do not want to see these errors?

There is a specialized CSS class "js-global-error" for the error message, then end users still have a chance to hide these error messages by customized CSS styles. But please DO NOT do so, otherwise if the users ignore the warning, there will be a lot of UI problem on their side, for example: the issue preview / inline PR comment don't work, etc.

What if I see "Your ROOT_URL in app.ini is undefined"

There must be something wrong with your JS assets or templates. Check your CDN/static files/customized templates, etc. Make sure the JS assets and templates are correct.

What if I see "Your ROOT_URL in app.ini is https://..... but you are visiting https://....."

Check the ROOT_URL config in your app.ini

[server]
ROOT_URL = https://.....

And check Gitea's startup logs:

AppURL(ROOT_URL): https://......

Make sure the ROOT_URL matches the base URL you are visiting.

What if I see "JavaScript error"

It could be caused by:

(either) incorrect template/JS assets on your side (including CDN/cache problems)
(or) a frontend bug in Gitea or in your customized JS code

web_src/js/features/common-global.js

wxiaoguang · 2022-03-29T08:55:11Z

@go-gitea/maintainers I think we need this PR to save all active maintainers' time.

lunny · 2022-03-29T09:01:47Z

How about to force redirect to ROOT_URL when visit from a non-ROOT_URL address?

wxiaoguang · 2022-03-29T09:05:51Z

How about to force redirect to ROOT_URL when visit from a non-ROOT_URL address?

It will cause problems if the ROOT_URL is localhost but the user is visiting Gitea from another host.

wxiaoguang · 2022-03-29T09:07:01Z

And I think we can wait for a few days before merge after lgtm/done.

Maybe some maintainers have new opinions. 🙏

…hance to hide error messages by customized CSS styles.

… part, then it's much safer.

silverwind · 2022-03-29T10:10:37Z

templates/base/head_script.tmpl

@@ -0,0 +1,44 @@
+<script>
+	<!-- /* eslint-disable */ -->
+	window.addEventListener('error', function(e) {window._globalHandlerErrors=window._globalHandlerErrors||[]; window._globalHandlerErrors.push(e);});


Should probably create a separate webpack chunk that loads beforeindex.js for this instead of inlining it. That way, you also shouldn't need this global variable.

However, index.js is very late, the layout is:

window.addEventListener('error') window.config = // error occurs template <script> // error occurs index.js - bootstrap.js (the old publicpath.js) - others (initXxx) // error occurs

So the window.addEventListener must be the first one in script tag.

…line.

Gusted · 2022-03-29T11:09:25Z

How about to force redirect to ROOT_URL when visit from a non-ROOT_URL address?

That will be putting up a bandaid around possible incorrect configuration. To show the error seems the best option IMO. If they suddenly will be redirected to a new URL, how will they know what's going on and how to fix it?

wxiaoguang · 2022-03-30T05:49:46Z

Let's merge and see user's reactions. If it helps, that's good. If some users feel annoying, we should find the real problem behind these users.

* giteaoffical/main: (31 commits) Add Package Registry (go-gitea#16510) Show messages for users if the ROOT_URL is wrong, show JavaScript errors (go-gitea#18971) [skip ci] Updated translations via Crowdin Make git.OpenRepository accept Context (go-gitea#19260) Use full output of git show-ref --tags to get tags for PushUpdateAddTag (go-gitea#19235) When conflicts have been previously detected ensure that they can be resolved (go-gitea#19247) More commit info from API (go-gitea#19252) Move some issue methods as functions (go-gitea#19255) Move project files into models/project sub package (go-gitea#17704) Granular webhook events in editHook (go-gitea#19251) Provide configuration to allow camo-media proxying (go-gitea#12802) Move init repository related functions to modules (go-gitea#19159) Move organization related structs into sub package (go-gitea#18518) Refactor repo clone button and repo clone links, fix JS error on empty repo page (go-gitea#19208) Show last cron messages on monitor page (go-gitea#19223) Allow API to create file on empty repo (go-gitea#19224) Use goproxy.io instead of goproxy.cn (go-gitea#19242) New cron task: delete old system notices (go-gitea#19219) Let web and API routes have different auth methods group (go-gitea#19168) Only send webhook events to active system webhooks and only deliver to active hooks (go-gitea#19234) ...

wxiaoguang · 2022-04-08T04:10:10Z

FYI:

Using HTMLURL in templates is the root case that Gitea can only serve web under ROOT_URL. That's why we have to force users to set ROOT_URL correctly, and that's why this PR came.

If all URLs in template can be refactored to use Relative URL correctly, then we do not need to force users set ROOT_URL correctly again and again.

wxiaoguang · 2022-06-17T15:16:44Z

Some updates about this PR (which may be useful for future readers).

The show JavaScript errors really helps to catch some frontend bugs, including:

And

Some commits are shown as ... in file list with js error: JavaScript error: Uncaught TypeError: Cannot read properties of undefined (reading 'replaceWith') #19995
Fix a JS error in initRepoCommitLastCommitLoader's entryMap #19996

The ROOT_URL detection also helps issues like #19972 and some users in discord.

I believe it's on the right way. If there are new issues about it in the future, these related bugs could also be fixed.

Show messages for users if the ROOT_URL is wrong

3d369bb

wxiaoguang added this to the 1.17.0 milestone Mar 2, 2022

wxiaoguang added the topic/ui Change the appearance of the Gitea UI label Mar 2, 2022

Gusted reviewed Mar 2, 2022

View reviewed changes

web_src/js/features/common-global.js Outdated Show resolved Hide resolved

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 2, 2022

Gusted approved these changes Mar 2, 2022

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Mar 2, 2022

Merge branch 'main' into detect-wrong-url

8b2b973

wxiaoguang mentioned this pull request Mar 29, 2022

Some buttons doesn't work on issues screen #19245

Closed

add global error handler

94e6862

wxiaoguang changed the title ~~Show messages for users if the ROOT_URL is wrong~~ Show messages for users if the ROOT_URL is wrong, show JavaScript errors Mar 29, 2022

wxiaoguang mentioned this pull request Mar 29, 2022

Please revert gidelines to create repo to use ssh origin link instead of http #19205

Closed

Merge branch 'main' into detect-wrong-url

8d72750

add comments

223900e

delvh approved these changes Mar 29, 2022

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Mar 29, 2022

wxiaoguang added 3 commits March 29, 2022 17:15

use specialized CSS class "js-global-error", end users still have a c…

7228a3a

…hance to hide error messages by customized CSS styles.

make sure error handler can always be executed

8f42b72

Some people like to modify the head.tmpl, so we separate the script…

dd95b55

… part, then it's much safer.

silverwind reviewed Mar 29, 2022

View reviewed changes

wxiaoguang added 3 commits March 29, 2022 18:11

fix lint

1dfbe4d

Add ==== DO NOT EDIT ==== warning to head_script.tmpl

48eaaee

fix comment

e1236a9

wxiaoguang added the type/refactoring Existing code has been cleaned up. There should be no new functionality. label Mar 29, 2022

wxiaoguang added the skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. label Mar 29, 2022

wxiaoguang added 2 commits March 29, 2022 18:52

add appUrl to window.config again

93446c6

No necessary to support html msg, so just use pre-line to render new …

ce5a9b7

…line.

Merge branch 'main' into detect-wrong-url

f655cf6

This comment was marked as off-topic.

Sign in to view

wxiaoguang requested a review from silverwind March 29, 2022 13:25

Merge branch 'main' into detect-wrong-url

a880d80

wxiaoguang merged commit 2bce1ea into go-gitea:main Mar 30, 2022

wxiaoguang deleted the detect-wrong-url branch March 30, 2022 05:52

This was referenced Apr 1, 2022

Skip frontend ROOT_URL check on installation page, remove unnecessary global var #19291

Merged

Remove dependent on session auth for api/v1 routers #19321

Merged

This was referenced Apr 8, 2022

Dissimilar URLs #19340

Closed

Multi-domain support, ROOT_URL problem, use relative URLs in templates instead of absolute URLs #19345

Closed

Preview of Markdown not working, getting 403 #17843

Closed

This was referenced Apr 15, 2022

How to handle incorrect ROOT_URL for gitea.com #19407

Closed

JS error in imagediff.js #19414

Closed

go-gitea locked and limited conversation to collaborators Apr 28, 2022

6543 removed the skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. label Jun 20, 2022

Gusted added the pr/breaking Merging this PR means builds will break. Needs a description what exactly breaks, and how to fix it! label Jul 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show messages for users if the ROOT_URL is wrong, show JavaScript errors #18971

Show messages for users if the ROOT_URL is wrong, show JavaScript errors #18971

wxiaoguang commented Mar 2, 2022 •

edited

Loading

wxiaoguang commented Mar 29, 2022

lunny commented Mar 29, 2022

wxiaoguang commented Mar 29, 2022

wxiaoguang commented Mar 29, 2022 •

edited

Loading

silverwind Mar 29, 2022

wxiaoguang Mar 29, 2022 •

edited

Loading

Gusted commented Mar 29, 2022

This comment was marked as off-topic.

wxiaoguang commented Mar 30, 2022

wxiaoguang commented Apr 8, 2022 •

edited

Loading

wxiaoguang commented Jun 17, 2022

Show messages for users if the ROOT_URL is wrong, show JavaScript errors #18971

Show messages for users if the ROOT_URL is wrong, show JavaScript errors #18971

Conversation

wxiaoguang commented Mar 2, 2022 • edited Loading

ROOT_URL issues

JavaScript error issues

Screenshots:

Can not load index.js

Incorrect ROOT_URL

JavaScript error

window.config broken

FAQ

What if some users do not want to see these errors?

What if I see "Your ROOT_URL in app.ini is undefined"

What if I see "Your ROOT_URL in app.ini is https://..... but you are visiting https://....."

What if I see "JavaScript error"

wxiaoguang commented Mar 29, 2022

lunny commented Mar 29, 2022

wxiaoguang commented Mar 29, 2022

wxiaoguang commented Mar 29, 2022 • edited Loading

silverwind Mar 29, 2022

Choose a reason for hiding this comment

wxiaoguang Mar 29, 2022 • edited Loading

Choose a reason for hiding this comment

Gusted commented Mar 29, 2022

This comment was marked as off-topic.

wxiaoguang commented Mar 30, 2022

wxiaoguang commented Apr 8, 2022 • edited Loading

wxiaoguang commented Jun 17, 2022

wxiaoguang commented Mar 2, 2022 •

edited

Loading

Can not load `index.js`

`window.config` broken

wxiaoguang commented Mar 29, 2022 •

edited

Loading

wxiaoguang Mar 29, 2022 •

edited

Loading

wxiaoguang commented Apr 8, 2022 •

edited

Loading