[js/web] optimize module export and deployment

.gitmodules

@@ -7,4 +7,4 @@
 [submodule "cmake/external/emsdk"]
  path = cmake/external/emsdk
  url = https://github.com/emscripten-core/emsdk.git
- branch = 3.1.57
+ branch = 3.1.59

cgmanifests/generated/cgmanifest.json

@@ -6,7 +6,7 @@
  "component": {
  "type": "git",
  "git": {
- "commitHash": "229d83fc706e10a39d4948a804cbbf17225cdda0",
+ "commitHash": "d52c46520124845b1e0e0525f2759299d840143f",
  "repositoryUrl": "https://github.com/emscripten-core/emsdk.git"
  },
  "comments": "git submodule at cmake/external/emsdk"

cmake/onnxruntime_unittests.cmake

@@ -930,12 +930,14 @@ if (onnxruntime_ENABLE_TRAINING_TORCH_INTEROP)
 endif()
 if (CMAKE_SYSTEM_NAME STREQUAL "Emscripten")
  set_target_properties(onnxruntime_test_all PROPERTIES LINK_DEPENDS ${TEST_SRC_DIR}/wasm/onnxruntime_test_all_adapter.js)
- set_target_properties(onnxruntime_test_all PROPERTIES LINK_FLAGS "-s STACK_SIZE=5242880 -s INITIAL_MEMORY=536870912 -s ALLOW_MEMORY_GROWTH=1 -s MAXIMUM_MEMORY=4294967296 -s INCOMING_MODULE_JS_API=[preRun,locateFile,arguments,onExit,wasmMemory,buffer,instantiateWasm] --pre-js \"${TEST_SRC_DIR}/wasm/onnxruntime_test_all_adapter.js\" -s \"EXPORTED_RUNTIME_METHODS=['FS']\" --preload-file ${CMAKE_CURRENT_BINARY_DIR}/testdata@/testdata -s EXIT_RUNTIME=1")
+ set_target_properties(onnxruntime_test_all PROPERTIES LINK_DEPENDS ${ONNXRUNTIME_ROOT}/wasm/pre.js)
+ set_target_properties(onnxruntime_test_all PROPERTIES LINK_FLAGS "-s STACK_SIZE=5242880 -s INITIAL_MEMORY=536870912 -s ALLOW_MEMORY_GROWTH=1 -s MAXIMUM_MEMORY=4294967296 -s INCOMING_MODULE_JS_API=[preRun,locateFile,arguments,onExit,wasmMemory,buffer,instantiateWasm] --pre-js \"${TEST_SRC_DIR}/wasm/onnxruntime_test_all_adapter.js\" --pre-js \"${ONNXRUNTIME_ROOT}/wasm/pre.js\" -s \"EXPORTED_RUNTIME_METHODS=['FS']\" --preload-file ${CMAKE_CURRENT_BINARY_DIR}/testdata@/testdata -s EXIT_RUNTIME=1")
  if (onnxruntime_ENABLE_WEBASSEMBLY_THREADS)
  set_property(TARGET onnxruntime_test_all APPEND_STRING PROPERTY LINK_FLAGS " -s DEFAULT_PTHREAD_STACK_SIZE=131072 -s PROXY_TO_PTHREAD=1")
  endif()
  if (onnxruntime_USE_JSEP)
- set_property(TARGET onnxruntime_test_all APPEND_STRING PROPERTY LINK_FLAGS " --pre-js \"${ONNXRUNTIME_ROOT}/wasm/js_internal_api.js\"")
+ set_target_properties(onnxruntime_test_all PROPERTIES LINK_DEPENDS ${ONNXRUNTIME_ROOT}/wasm/pre-jsep.js)
+ set_property(TARGET onnxruntime_test_all APPEND_STRING PROPERTY LINK_FLAGS " --pre-js \"${ONNXRUNTIME_ROOT}/wasm/pre-jsep.js\"")
  endif()
 
  ###

cmake/onnxruntime_webassembly.cmake

@@ -226,9 +226,12 @@ else()
  "SHELL:-s VERBOSE=0"
  "SHELL:-s FILESYSTEM=0"
  "SHELL:-s INCOMING_MODULE_JS_API=[preRun,locateFile,arguments,onExit,wasmMemory,buffer,instantiateWasm,mainScriptUrlOrBlob]"
+ "SHELL:-s WASM_BIGINT=1"
  ${WASM_API_EXCEPTION_CATCHING}
  --no-entry
+ "SHELL:--pre-js \"${ONNXRUNTIME_ROOT}/wasm/pre.js\""
  )
+ set_target_properties(onnxruntime_webassembly PROPERTIES LINK_DEPENDS ${ONNXRUNTIME_ROOT}/wasm/pre.js)
 
  if (onnxruntime_USE_JSEP)
  # NOTE: "-s ASYNCIFY=1" is required for JSEP to work with WebGPU
@@ -237,11 +240,11 @@ else()
 
  target_compile_definitions(onnxruntime_webassembly PRIVATE USE_JSEP=1)
  target_link_options(onnxruntime_webassembly PRIVATE
- --pre-js "${ONNXRUNTIME_ROOT}/wasm/js_internal_api.js"
+ "SHELL:--pre-js \"${ONNXRUNTIME_ROOT}/wasm/pre-jsep.js\""
  "SHELL:-s ASYNCIFY=1"
  "SHELL:-s ASYNCIFY_STACK_SIZE=65536"
  )
- set_target_properties(onnxruntime_webassembly PROPERTIES LINK_DEPENDS ${ONNXRUNTIME_ROOT}/wasm/js_internal_api.js)
+ set_target_properties(onnxruntime_webassembly PROPERTIES LINK_DEPENDS ${ONNXRUNTIME_ROOT}/wasm/pre-jsep.js)
  endif()
 
  if (onnxruntime_EMSCRIPTEN_SETTINGS)
@@ -252,7 +255,10 @@ else()
 
  if (CMAKE_BUILD_TYPE STREQUAL "Debug")
  target_link_options(onnxruntime_webassembly PRIVATE
- "SHELL:-s ASSERTIONS=2"
+ # NOTE: use "SHELL:-s ASSERTIONS=2" to enable more strict assertions, which may help debugging segfaults.
+ # However, it may be very slow.
+ # "SHELL:-s ASSERTIONS=2"
+ "SHELL:-s ASSERTIONS=1"
  "SHELL:-s SAFE_HEAP=1"
  "SHELL:-s STACK_OVERFLOW_CHECK=2"
  )
@@ -266,7 +272,7 @@ else()
  endif()
 
  if (onnxruntime_USE_WEBNN)
- set_property(TARGET onnxruntime_webassembly APPEND_STRING PROPERTY LINK_FLAGS " --bind -sWASM_BIGINT")
+ set_property(TARGET onnxruntime_webassembly APPEND_STRING PROPERTY LINK_FLAGS " --bind")
  if (onnxruntime_DISABLE_RTTI)
  set_property(TARGET onnxruntime_webassembly APPEND_STRING PROPERTY LINK_FLAGS " -fno-rtti -DEMSCRIPTEN_HAS_UNBOUND_TYPE_NAMES=0")
  endif()
@@ -283,7 +289,7 @@ else()
  target_link_options(onnxruntime_webassembly PRIVATE
  "SHELL:-s EXPORT_NAME=ortWasmThreaded"
  "SHELL:-s DEFAULT_PTHREAD_STACK_SIZE=131072"
- "SHELL:-s PTHREAD_POOL_SIZE=Module[\\\"numThreads\\\"]"
+ "SHELL:-s PTHREAD_POOL_SIZE=Module[\\\"numThreads\\\"]-1"
  )
  else()
  target_link_options(onnxruntime_webassembly PRIVATE
@@ -309,5 +315,9 @@ else()
 
  list(JOIN target_name_list "-" target_name)
 
- set_target_properties(onnxruntime_webassembly PROPERTIES OUTPUT_NAME ${target_name})
+ if (onnxruntime_USE_JSEP)
+ string(APPEND target_name ".jsep")
+ endif()
+
+ set_target_properties(onnxruntime_webassembly PROPERTIES OUTPUT_NAME ${target_name} SUFFIX ".mjs")
 endif()

js/.eslintrc.js

@@ -59,7 +59,8 @@ module.exports = {
  '@typescript-eslint/no-misused-new': 'error',
  '@typescript-eslint/no-namespace': ['error', { 'allowDeclarations': true }],
  '@typescript-eslint/no-non-null-assertion': 'off',
- '@typescript-eslint/no-require-imports': 'error',
+ '@typescript-eslint/no-require-imports': ['error', { 'allow': ['^node:']}],
+ '@typescript-eslint/no-var-requires': ['error', { 'allow': ['^node:']}],
  '@typescript-eslint/no-unnecessary-type-assertion': 'error',
  '@typescript-eslint/no-unused-vars': ['error', { 'argsIgnorePattern': '^_' }],
  '@typescript-eslint/promise-function-async': 'error',
@@ -216,10 +217,6 @@ module.exports = {
  'no-underscore-dangle': 'off',
  'guard-for-in': 'off'
  }
- }, {
- files: ['web/lib/wasm/binding/**/*.ts'], rules: {
- '@typescript-eslint/naming-convention': 'off'
- }
  }, {
  files: ['react_native/e2e/src/**/*.ts', 'react_native/e2e/src/**/*.tsx'], rules: {
  '@typescript-eslint/no-non-null-assertion': 'off',

js/.vscode/launch.json

@@ -16,6 +16,15 @@
  "sourceMaps": true,
  "preLaunchTask": "tsc: build - common/test/tsconfig.json"
  },
+ {
+ "name": "[web] Launch Build script in Node.js",
+ "program": "${workspaceFolder}/web/script/build.js",
+ "request": "launch",
+ "skipFiles": ["<node_internals>/**"],
+ "type": "node",
+ "cwd": "${workspaceFolder}/web",
+ "preLaunchTask": "tsc: build - web/script/tsconfig.json"
+ },
  {
  "name": "[web] Launch Test Runner CLI in Node.js",
  "program": "${workspaceFolder}/web/script/test-runner-cli.js",

js/build_jsep.bat

@@ -3,49 +3,33 @@
 rem build_jsep.bat --- build onnxruntime-web with JSEP
 rem
 rem Usage:
-rem build_jsep.bat config threaded [clean]
+rem build_jsep.bat config [clean]
 rem
 rem Options:
 rem config Build configuration, "d" or "r"
-rem threaded Build with threading support, "st" or "mt"
 rem clean Perform a clean build, "clean" or empty
 
 setlocal enabledelayedexpansion
 
 set ROOT=%~dp0..\
+set BUILD_DIR=%ROOT%build_jsep
 
 :arg1
 if ["%~1"]==["d"] (
  set CONFIG=Debug
- set CONFIG_EXTRA_FLAG=--enable_wasm_debug_info
+ set CONFIG_EXTRA_FLAG=--enable_wasm_debug_info --enable_wasm_profiling
  goto :arg2
 )
 if ["%~1"]==["r"] (
  set CONFIG=Release
- set CONFIG_EXTRA_FLAG=--enable_wasm_api_exception_catching --disable_rtti
+ set CONFIG_EXTRA_FLAG=--enable_wasm_api_exception_catching --disable_rtti --enable_wasm_profiling
  goto :arg2
 )
 echo Invalid configuration "%~1", must be "d"(Debug) or "r"(Release)
 exit /b 1
 
 :arg2
-if ["%~2"]==["st"] (
- set BUILD_DIR=%ROOT%build_jsep_st
- set THREADED_EXTRA_FLAG=
- set TARGET_FILE_PREFIX=ort-wasm-simd
- goto :arg3
-)
-if ["%~2"]==["mt"] (
- set BUILD_DIR=%ROOT%build_jsep_mt
- set THREADED_EXTRA_FLAG=--enable_wasm_threads
- set TARGET_FILE_PREFIX=ort-wasm-simd-threaded
- goto :arg3
-)
-echo Invalid threading option "%~2", must be "st" or "mt"
-exit /b 1
-
-:arg3
-if ["%~3"]==["clean"] (
+if ["%~2"]==["clean"] (
  goto :clean
 )
 if not exist "%ROOT%js\web\dist" (
@@ -80,12 +64,12 @@ popd
 
 set PATH=C:\Program Files\Git\usr\bin;%PATH%
 
-call %ROOT%build.bat --config %CONFIG% %CONFIG_EXTRA_FLAG% %THREADED_EXTRA_FLAG%^
- --skip_submodule_sync --build_wasm --skip_tests --enable_wasm_simd --use_jsep --target onnxruntime_webassembly --build_dir %BUILD_DIR%
+call %ROOT%build.bat --config %CONFIG% %CONFIG_EXTRA_FLAG% --skip_submodule_sync --build_wasm --skip_tests^
+--enable_wasm_simd --enable_wasm_threads --use_jsep --use_webnn --target onnxruntime_webassembly --build_dir %BUILD_DIR%
 
 IF NOT "%ERRORLEVEL%" == "0" (
  exit /b %ERRORLEVEL%
 )
 
-copy /Y %BUILD_DIR%\%CONFIG%\%TARGET_FILE_PREFIX%.js %ROOT%js\web\lib\wasm\binding\%TARGET_FILE_PREFIX%.jsep.js
-copy /Y %BUILD_DIR%\%CONFIG%\%TARGET_FILE_PREFIX%.wasm %ROOT%js\web\dist\%TARGET_FILE_PREFIX%.jsep.wasm
+copy /Y %BUILD_DIR%\%CONFIG%\ort-wasm-simd-threaded.jsep.wasm %ROOT%js\web\dist\
+copy /Y %BUILD_DIR%\%CONFIG%\ort-wasm-simd-threaded.jsep.mjs %ROOT%js\web\dist\

js/common/lib/env.ts

@@ -4,15 +4,32 @@
 import {env as envImpl} from './env-impl.js';
 
 export declare namespace Env {
- export type WasmPrefixOrFilePaths = string|{
- /* eslint-disable @typescript-eslint/naming-convention */
- 'ort-wasm.wasm'?: string;
- 'ort-wasm-threaded.wasm'?: string;
- 'ort-wasm-simd.wasm'?: string;
- 'ort-training-wasm-simd.wasm'?: string;
- 'ort-wasm-simd-threaded.wasm'?: string;
- /* eslint-enable @typescript-eslint/naming-convention */
- };
+ export type WasmPathPrefix = string;
+ export interface WasmFilePaths {
+ /**
+ * Specify the override path for the main .wasm file.
+ *
+ * This path should be an absolute path.
+ *
+ * If not modified, the filename of the .wasm file is:
+ * - `ort-wasm-simd-threaded.wasm` for default build
+ * - `ort-wasm-simd-threaded.jsep.wasm` for JSEP build (with WebGPU and WebNN)
+ * - `ort-training-wasm-simd-threaded.wasm` for training build
+ */
+ wasm?: URL|string;
+ /**
+ * Specify the override path for the main .mjs file.
+ *
+ * This path should be an absolute path.
+ *
+ * If not modified, the filename of the .mjs file is:
+ * - `ort-wasm-simd-threaded.mjs` for default build
+ * - `ort-wasm-simd-threaded.jsep.mjs` for JSEP build (with WebGPU and WebNN)
+ * - `ort-training-wasm-simd-threaded.mjs` for training build
+ */
+ mjs?: URL|string;
+ }
+ export type WasmPrefixOrFilePaths = WasmPathPrefix|WasmFilePaths;
  export interface WebAssemblyFlags {
  /**
  * set or get number of thread(s). If omitted or set to 0, number of thread(s) will be determined by system. If set
@@ -29,6 +46,8 @@ export declare namespace Env {
  *
  * This setting is available only when WebAssembly SIMD feature is available in current context.
  *
+ * @deprecated This property is deprecated. Since SIMD is supported by all major JavaScript engines, non-SIMD
+ * build is no longer provided. This property will be removed in future release.
  * @defaultValue `true`
  */
  simd?: boolean;
@@ -50,8 +69,8 @@ export declare namespace Env {
  initTimeout?: number;
 
  /**
- * Set a custom URL prefix to the .wasm files or a set of overrides for each .wasm file. The override path should be
- * an absolute path.
+ * Set a custom URL prefix to the .wasm/.mjs files, or an object of overrides for both .wasm/.mjs file. The override
+ * path should be an absolute path.
  */
  wasmPaths?: WasmPrefixOrFilePaths;