[Web] Which node.js version is supposed to be supported?

[marcelklehr]

Describe the issue

Which Node.js versions is the current version of onnxruntime-web supposed to be compatible with?

Using node v16

worker sent an error! undefined:undefined: ortWasmThreaded is not defined

node:internal/event_target:969
  process.nextTick(() => { throw err; });
                           ^
ReferenceError [Error]: ortWasmThreaded is not defined

Using node v18 and v20

node:internal/errors:496
    ErrorCaptureStackTrace(err);
    ^

TypeError [ERR_WORKER_PATH]: The worker script or module filename must be an absolute path or a relative path starting with './' or '../'. Received "blob:nodedata:0d99e392-a103-4b96-a185-cdd6b6506805"
    at new NodeError (node:internal/errors:405:5)
    at new Worker (node:internal/worker:168:15)
}

To reproduce

1. require('onnxruntime-web')
2. Run stable-duffusion-xl-1.0-base

Urgency

No response

ONNX Runtime Installation

Released Package

ONNX Runtime Version or Commit ID

1.16.1

Execution Provider

Other / Unknown

[carzh]

node v18 should work, but my understanding is that not all browsers + platforms can support ort-web multithreading. If you are running in Node, the onnxruntime-node package should be used. Could you provide more details on reproducing the issue such as what browser + what commands you are using to launch?

[marcelklehr]

If you are running in Node, the onnxruntime-node package should be used

I want to use onnxruntime-web / WASM as a fallback for machines that are not running on x86, since onnxruntime-node only works on x86

Could you provide more details on reproducing the issue such as what browser + what commands you are using to launch?

I'm running in node, see above. Specifically, I'm running this file ( https://github.com/nextcloud/text2image_stablediffusion/blob/main/src/stablediffusion.mjs ) with onnxruntime-web instead of onnxruntime-node. My understanding is that it should be possible to simply switch out the import statement and it should work.

[carzh]

Hello, where did you see that onnxruntime-node only works on x86 & that it would be possible to swap out the import statements? The npm registry package page indicates that onnxruntime-node supports x64.

Since there is a "node" export in onnxruntime-web's package.json, it does look like onnxruntime-web can work in Node, but it looks like from the build script that the node export is built with multithreading disabled.

You can try a custom build (modify the DISABLE_WASM_THREAD boolean to true for the ort.node.min.js build and then follow these build instructions), but I'm not sure if multithreading in onnxruntime-web in Node is supported yet.

[fs-eire]

onnxruntime-node should have supported win/linux/mac on x64/arm64. @marcelklehr what exact OS/platform are you using?

[marcelklehr]

I can only use pre-built binaries

Following platforms are supported with pre-built binaries:

Windows x64 CPU NAPI_v3
Linux x64 CPU NAPI_v3
MacOS x64 CPU NAPI_v3

I'd like to use it on ARM and on machines that don't have glibc.

On npm it is stated that onnxruntime-web supports node: https://www.npmjs.com/package/onnxruntime-web#compatibility

[fs-eire]

Seems like the document is out of date.

Currently we support 6: Win x64, Win Arm64, Linux x64, Linux Arm64, Mac x64 and Mac arm64

You can check from a CDN (eg. https://www.jsdelivr.com/package/npm/onnxruntime-node?tab=files&path=bin%2Fnapi-v3%2Fwin32) for the subfolder of "bin"

[fs-eire]

I'd like to use it on ARM and on machines that don't have glibc.

I see... I think ONNX Runtime itself may not support this but I am not sure. Are you able to use a docker in your environment?

[marcelklehr]

Are you able to use a docker in your environment?

No, that's the reason I'm looking for WASM support on node.js

[gowy222]

@marcelklehr

onnxruntime-node

not MATTER with node version,
FROM node:lts-slim AS base will works. (x86_64 and arm64 both work!)
docker buildx build --platform linux/arm64
(must be slim!!! GUN C lib -> GLIBC ISSUE! )

[fs-eire]

WASM works on Node.js only when disabling the multi-thread features. They depends on creating web workers on Blob URL which is not supported in node.js