feat(poc): implement poc for web workers

[JammingBen]

Description

This is a proof of concept web worker implementation. It implements the basic architecture (or how it could look like) and demonstrates the functionality by handling file deletion in a web worker.

I was facing mainly 2 challenges here. Firstly, a web worker lives completely isolated from the main thread, hence it has no knowledge about things like the DOM, browser storage etc. All things a worker might need must be serialized and passed into the worker. This also means that only serializable data can be passed, no functions e.g. This hurts especially since it means we can't use the factories from web-client to build requests. We can still use the web-client here, just not the ClientService.

The second challenge I faced was that workers need to be informed about potential token updates during an ongoing worker process. This means, if a token is being updated, all potential existing web workers need to be updated with the new token.

Architecture

The implementation consists of 3 main parts. First we have the WebWorkersStore that acts like a registry. It can create and terminate web workers and update access tokens for all active workers. The idea behind this store is to have some instance that always knows which and how many workers are currently active.

Then there are the actual workers. These are isolated ts files that always have a self.onmessage method to receive data from the main thread.

At last there are worker composables that are responsible for creating instances of web workers and registering them in the WebWorkersStore. They also handle serialization and termination after a process has finished. These composables act like an interface between the store, the actual worker and the "outside world", where they are supposed to be used. They need to be given all relevant data and a potential callback.

Related Issue

• refs [Web] Research for long running actions (~ Web Worker) #10855
• refs Async interactions - fix "hanging" UI during long running actions #7039
• refs [files] Batch actions need some kind of working in progress-feedback (loading spinner) #9182

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Technical debt
• Tests
• Documentation
• Maintenance (e.g. dependency updates or tooling)

[update-docs]

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

[JammingBen]

This is ready for a general review. I added a 2 second timer to the delete action to better visualize the process (hence this is still a draft). Once we decide if/how to move forward here I'll remove it of course.

[sonarcloud]

Quality Gate passed

Issues
18 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[kulmann]

I like this big time! 😍