feat(event streaming): configurable worker path, use SharedWorker

[shamardy]

This PR allows any worker path to be used instead of hardcoded worker.js file. The worker path can be specified using worker_path in event_stream_configuration, if not specified worker.js will be used as default. Example:

"event_stream_configuration": {
    "access_control_allow_origin": "*",
    "active_events": {
      "NETWORK": { "stream_interval_seconds": 1.5 }
    },
    "worker_path": "index.js" // This can be added in wasm only configuration
}

[onur-ozkan]

It might not be "worker.js".

[shamardy]

Was already fixing this. Done :)

[borngraced]

we might have another worker.js that serves a diff purpose In the future so why not make it balance_streaming_worker.js as default ?

Also, worker.js is a very basic worker that's not doing much and we might have a more complex worker in the future

[shamardy]

I left it as worker.js for backward compatibility with this https://github.com/KomodoPlatform/react-komodefi-wasm/blob/streaming/worker.js ref #1978 (comment)

[shamardy]

I can make it balance_streaming_worker.js if agreed by @onur-ozkan and they would have to fix it in the react-komodefi-wasm branch

Also, worker.js is a very basic worker that's doing much and we might have a more complex worker in the future

Can you please elaborate on this @borngraced ?

[shamardy]

I believe we should get some feedback from the frontend devs. They may prefer to handle all the events from single worker file by filtering the incoming data.

It's still a single worker file for event streaming

[shamardy]

If they requested multiple workers in the future we can do it in another PR.

[onur-ozkan]

the current worker script used for balance streaming is only logging the messages to the console..

It's just for demonstration, it doesn't have to be that way obviously.

You can handle all kinds of operations from a single worker file by filtering the incoming payload. As I mentioned, this preference should be defined by the frontend developers not by us as this affects their project structure directly.

[onur-ozkan]

It's still a single worker file for event streaming

I am aware of it, I meant event streaming + different tasks on workers

[shamardy]

I am aware of it, I meant event streaming + different tasks on workers

In this case they can change the config I guess.

[shamardy]

@smk762 @gcharang after this is merged to dev, worker.js here https://github.com/KomodoPlatform/react-komodefi-wasm/blob/streaming/worker.js should be renamed to event_streaming_worker.js

[shamardy]

@smk762 @gcharang I changed the worker type to be a shared worker, so the script in event_streaming_worker.js should be changed to the following

// use chrome://inspect in Chrome to debug the worker
// use about:debugging in Firefox to debug the worker
self.onconnect = function(event) {
    var port = event.ports[0];

    console.log('A new connection to the shared worker has been successfully established.');

    port.onmessage = function(e) {
        console.log(e.data);
    };
};

Shared workers debugging can be accessed from chrome://inspect in chrome or about:debugging in Firefox, from there you can navigate to shared workers and choose event_streaming_worker.js and see the console logs.

[onur-ozkan]

🔥

[borngraced]

according to this doc, and usage of shared worker..do you think we need it here just stick to dedicated worker without much stuffs going on in this code.

[borngraced]

LGTM 🔥

[shamardy]

according to this doc, and usage of shared worker..do you think we need it here just stick to dedicated worker without much stuffs going on in this code.

it was requested by @naezith since normal worker doesn't fit his needs in the flutter codebase. Plus, I think it's good to have event streaming worker shared and accessed from multiple contexts.