Godot Web Build reloads infinitely on github.io

[Swarkin]

Tested versions

4.4.dev2
master branch as of 28.09.2024

System information

Any

Issue description

Recording.2024-09-28.115226.mp4

Steps to reproduce

1. Go to https://swarkin.github.io/wsclicker

Minimal reproduction project (MRP)

Not a MRP but the project in question: https://github.com/Swarkin/wsclicker

[yankscally]

hey - I've been following this project.

tested this and got the same result on ChromeOS

Screen.recording.2024-09-28.10.46.57.AM.webm

[RedMser]

It is caused by following code (note the window.location.reload() at the end):

godot/misc/dist/html/full-size.html

Lines 153 to 171 in 76a1359

	if (missing.length !== 0) {
	if (GODOT_CONFIG['serviceWorker'] && GODOT_CONFIG['ensureCrossOriginIsolationHeaders'] && 'serviceWorker' in navigator) {
	// There's a chance that installing the service worker would fix the issue
	Promise.race([
	navigator.serviceWorker.getRegistration().then((registration) => {
	if (registration != null) {
	return Promise.reject(new Error('Service worker already exists.'));
	}
	return registration;
	}).then(() => engine.installServiceWorker()),
	// For some reason, `getRegistration()` can stall
	new Promise((resolve) => {
	setTimeout(() => resolve(), 2000);
	}),
	]).catch((err) => {
	console.error('Error while registering service worker:', err);
	}).then(() => {
	window.location.reload();
	});

CC @adamscott

As workaround, you can try disabling the "ensure cross origin isolation headers", or PWAs as a whole, in export options @Swarkin

[Swarkin]

I cannot do this as I need CORS headers for threads to work...

[AThousandShips]

For me the following error occurs in the console for the running page:

Uncaught (in promise) TypeError: Failed to execute 'addAll' on 'Cache': Request failed

[RedMser]

I cannot do this as I need CORS headers for threads to work...

I haven't done any threaded web apps before, so my assessment might be wrong. But as far as I can read online (search for "github pages cross origin isolation"), you need to do some additional work to enable cross origin isolation headers on github pages. Here is one example I found: https://docs.wasmer.io/sdk/wasmer-js/how-to/coop-coep-headers

But the infinite reload is still something that should be fixed (show an error message on the web page instead).

[AThousandShips]

But the infinite reload is still something that should be fixed (show an error message on the web page instead).

This might be something that happens before the engine can load properly (it seems at least one error happens immediately in the service worker) so might be something we don't have any power over, but not sure exactly where things are breaking exactly

[adamscott]

I don't have access to a computer this weekend, but I'll see what I can do Monday.

[c6nabors]

I cannot do this as I need CORS headers for threads to work...

https://github.com/gzuidhof/coi-serviceworker gets around the use of headers on hosters where you cannot change them

[adamscott]

I cannot do this as I need CORS headers for threads to work...

https://github.com/gzuidhof/coi-serviceworker gets around the use of headers on hosters where you cannot change them

We do handle this directly in the Web export template since #86089.

[Swarkin]

I am still experiencing this issue, website reloading infinitely. I updated my web build from master an hour ago.
Both firefox and chromium, I have reloaded without cache using ctrl+shift+r as well as ticking the disable cache box in the network debugger.

[mhilbrunner]

cc @adamscott ^

[adamscott]

@Swarkin Did you rename wsclicker_client_web_wasm32.html to index.html?

[Swarkin]

I did, do I need to rename everything containing wsclicker_client_web_wasm32 to index?

[adamscott]

@Swarkin Try exporting the project using index.html as name directly (without any renaming afterwards). We should advise people to never rename files in the docs.

The service worker fails to load wsclicker_client_web_wasm32.html and then everything fails.

[Swarkin]

Seems like that was the actual issue, even though Im pretty sure that it worked this way in the past? Anyways thank you!
Should we convert this into a documentation issue and leave it open?

[adamscott]

Seems like that was the actual issue, even though Im pretty sure that it worked this way in the past? Anyways thank you! Should we convert this into a documentation issue and leave it open?

There's definitely something wrong when a file can't be loaded. I'll try to fix the infinite loading.

[adamscott]

Weird. I tried to rename in a small test project test.html to index.html, and it still works...

I'll create a PR for the documentation and close this issue. Then, if the problem returns, I'll be there to fix it.