feat(websocket-websys): add support for different WASM environments

[jsdanielh]

Description

We introduce a WebContext enum that abstracts and detects the Window vs the WorkerGlobalScope API.

Related: wasm-bindgen/wasm-bindgen#1046.

Change checklist

• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• A changelog entry has been made in the appropriate crates

[sisou]

For some added context: this uses the same approach as for gloo-timers: ranile/gloo#185, extended already by the codegen fix of ranile/gloo#283.

This makes it possible to run this transport in environments that support setInterval, but don't have a window global. This way it also works in NodeJS, Deno and Bun (although Deno provides a window for compatibility).

[thomaseizinger]

For some added context: this uses the same approach as for gloo-timers: rustwasm/gloo#185, extended already by the codegen fix of rustwasm/gloo#283.

This makes it possible to run this transport in environments that support setInterval, but don't have a window global. This way it also works in NodeJS, Deno and Bun (although Deno provides a window for compatibility).

I've updated the PR description to reflect what I think is what is happening here, let me know if that is correct.

[thomaseizinger]

Thanks!

I am not entirely opposed to this change but it isn't particularly clean. The idea of libp2p-websocket-websys was that we provide WASM bindings via web-sys.

We are now working around the web-sys crate which is a bit odd. Would it make sense to perhaps upstream this change to web-sys instead by offering setInterval and clearInterval as top-level functions instead of always going through window?

[sisou]

Unfortunately, there was no interest in web-sys last time this was brought up, and not since: wasm-bindgen/wasm-bindgen#1046. As you can see at the bottom of that PR, lots of people had to implement this themselves already.

Another method to do it is with an enum over window vs. worker, like this: Globidev/reqwest@9898e62

A third way is unchecked-casting web_sys::global() to whichever env is detected. This might be the best solution using web-sys: https://github.com/gfx-rs/wgpu/pull/2858/files

[thomaseizinger]

Another method to do it is with an enum over window vs. worker, like this: Globidev/reqwest@9898e62

I think I'd prefer this. It is unfortunate that web-sys doesn't provide something out of the box here but at least, it makes it obvious what we are supporting here instead of binding to global functions.

Mind updating the PR and the description to explain the solution?

[jsdanielh]

Another method to do it is with an enum over window vs. worker, like this: Globidev/reqwest@9898e62

I think I'd prefer this. It is unfortunate that web-sys doesn't provide something out of the box here but at least, it makes it obvious what we are supporting here instead of binding to global functions.

Mind updating the PR and the description to explain the solution?

Sure. Done. And also implemented the requested changes in the review.

[jsdanielh]

Another method to do it is with an enum over window vs. worker, like this: Globidev/reqwest@9898e62

I think I'd prefer this. It is unfortunate that web-sys doesn't provide something out of the box here but at least, it makes it obvious what we are supporting here instead of binding to global functions.
Mind updating the PR and the description to explain the solution?

Sure. Done. And also implemented the requested changes in the review.

Ah wait, I thought this was referring to the current implementation but now that I read it again with the quote I think you meant this. In this case, I'll update the PR with this.

[thomaseizinger]

Another method to do it is with an enum over window vs. worker, like this: Globidev/reqwest@9898e62

I think I'd prefer this. It is unfortunate that web-sys doesn't provide something out of the box here but at least, it makes it obvious what we are supporting here instead of binding to global functions.
Mind updating the PR and the description to explain the solution?

Sure. Done. And also implemented the requested changes in the review.

Ah wait, I thought this was referring to the current implementation but now that I read it again with the quote I think you meant this. In this case, I'll update the PR with this.

Yeah I was referring to an implementation that uses an enum and detects the context accordingly! :)

[jsdanielh]

Another method to do it is with an enum over window vs. worker, like this: Globidev/reqwest@9898e62

I think I'd prefer this. It is unfortunate that web-sys doesn't provide something out of the box here but at least, it makes it obvious what we are supporting here instead of binding to global functions.
Mind updating the PR and the description to explain the solution?

Sure. Done. And also implemented the requested changes in the review.

Ah wait, I thought this was referring to the current implementation but now that I read it again with the quote I think you meant this. In this case, I'll update the PR with this.

Yeah I was referring to an implementation that uses an enum and detects the context accordingly! :)

Ok, now it's updated with this implementation. Let me know if you have more comments.

[thomaseizinger]

Thank you!

Overall concept looks great, just a few nits :)

[thomaseizinger]

Great work!

Thank you for iterating on this with me :)

[thomaseizinger]

We don't have any automated tests for web workers, mind testing this PR manually on your end before we merge it?

[jsdanielh]

We don't have any automated tests for web workers, mind testing this PR manually on your end before we merge it?

Already did for web workers :)