The Loader retries loading errored files

pavle-goloskokovic commented 3 months ago

To avoid connectivity issues, usually with poor mobile networks, from breaking games – the Loader could make multiple attempts to reload errored files with exponential delay increase.

Currently if a file errors, depending on file type, it will either cause a breaking error or undesired behavior.

Here are code examples that demonstrate how playcanvas handles described behavior:

Enabling retry on loader level: https://github.com/playcanvas/engine/blob/v1.73.0/src/framework/handlers/loader.js#L325-L338

On file type handler level: https://github.com/playcanvas/engine/blob/v1.73.0/src/framework/handlers/handler.js#L39-L55

And on request level: https://github.com/playcanvas/engine/blob/v1.73.0/src/platform/net/http.js#L504-L525

Ideally, maxRetries setting could be added to the LoaderConfig to be set when creating a game and used globally for loading all files, but also be changed per file type, and even set per file by adding maxRetries option to the xhrSettings.

greptile-apps[bot] commented 3 months ago

For internal use only

To implement retry logic for loading errored files with exponential delay increase, follow these steps:

Add maxRetries to LoaderConfig:
- Modify /src/loader/typedefs/FileConfig.js to include maxRetries property.
```
/**
```
- @property {number} [maxRetries=0] - The maximum number of retry attempts for loading this file. */

Update XHRLoader.js to handle retries:

Modify /src/loader/XHRLoader.js to include retry logic.

function XHRLoader(file, xhrSettings) {
let retries = 0;
const maxRetries = file.maxRetries || 0;
const retryDelay = 1000; // Initial delay in ms

function load() {
   const xhr = new XMLHttpRequest();
   // ... existing XHR setup code ...

   xhr.onloadend = function () {
       if (xhr.status !== 200 && retries < maxRetries) {
           retries++;
           setTimeout(load, retryDelay * Math.pow(2, retries));
       } else {
           // ... existing onloadend logic ...
       }
   };

   xhr.send();
}

load();
}

Update File.js to include maxRetries in file configuration:

Modify /src/loader/File.js to accept maxRetries from FileConfig.

class File {
constructor(loader, fileConfig) {
   // ... existing constructor code ...
   this.maxRetries = fileConfig.maxRetries || 0;
}
}

References

#### About Greptile

This response provides a starting point for your research, not a precise solution. Help us improve! Please leave a 👍 if this is helpful and 👎 if it is irrelevant. [Ask Greptile](https://app.greptile.com/chat/github/phaserjs/phaser/master) · [Edit Issue Bot Settings](https://app.greptile.com/apps/github)

photonstorm commented 3 months ago

Thank you for submitting this feature request. We have implemented this and the feature has been pushed to the master branch. It will be part of the next release. If you get time to build and test it for yourself we would appreciate that.

phaserjs / phaser

The Loader retries loading errored files #6872

For internal use only

References