[BUG] tweetnacl library causes bundling issues in various configurations

[pospi]

Describe the bug

This library is a very mature nodejs package (read: old & infrequently updated). Being in an older format can cause compatibility issues with more modern development environments and build tooling.

Presently it has become problematic in neighbour-hoods/applet-template#9 (comment). I wish I'd been tracking other times it has been an issue with bundlers, 'cos this is not the first time I've had to go into arcane Nodejs internals because of its presence in the stack.

Expected behavior

Developers shouldn't have to think about this module's compatibility with TypeScript, Rollup, Webpack, Web Dev Server, Babel, ESM modules or anything else. At least, not beyond the normal level of consideration that would apply to any other module being included in a project.

Could we try swapping it out for tweetnacl-ts or another alternative with broader module compatibility?

[jost-s]

Hi @pospi, to reproduce this problem and test with a replacement, can I set up a rollup and web dev server project and use tweetnacl in it? tweetnacl-ts is even older, but it promises TS and bundler support. I want to test that before making a decision.

[pospi]

You should be able to, yeah- a WDS config similar to this one should reproduce (differently) the bug with or without the commonjs plugin active.

I don't know that tweetnacl-ts is such a great suggestion, either. I figure there are possibly other alternatives out there that cover the same signing functionality?

[jost-s]

I can reproduce the problem, I believe. Running WDS with tweetnacl commonjs-rollup'd in the web-dev-server.config results in a "no default export in tweetnacl" error in the browser.
When changing the import of tweetnacl to import * as nacl from "tweetnacl", it succeeds, but the properties of nacl are not present. Some CommonJS weirdness, I suppose, that I don't fully get.

I'm looking for a replacement that is compatible with ES modules.

[jost-s]

I've found a great replacement for tweetnacl and it works well: https://www.npmjs.com/package/@noble/ed25519
ESM compatible and works in browser and Nodejs.

When trying the client in WDS, isomorphic-ws is giving me grief. It's somewhat semi-CJS/ESM. I'm looking for a fix and will then release the client as WDS-compatible ;-)

[jost-s]

I've chimed in on the commonjs issue in the WDS repo modernweb-dev/web#1700 (comment)

[jost-s]

This has been a time-consuming endeavor, and it's still not working. I've submitted another issue with WDS because I can't even use ws with it. modernweb-dev/web#2248

[jost-s]

v0.14.0 is released with the replaced NPM package. I'll open a new issue for WDS compatibility, even though the JS client can only wait for the WDS issues to be fixed.