[esm-integration] Allow for module argument processing

This change delays module argument processing until the init function
is run.  This means that at least some INCOMING_MODULE_JS_API properties
can be supported with ESM integration.

Author: sbc100

src/jsifier.mjs

@@ -10,6 +10,7 @@
 import assert from 'node:assert';
 import * as fs from 'node:fs/promises';
 import {
+  ATPREINITS,
   ATEXITS,
   ATINITS,
   ATPOSTCTORS,
@@ -873,6 +874,7 @@ var proxiedFunctionTable = [
           asyncFuncs,
           libraryDefinitions: LibraryManager.libraryDefinitions,
           ATPRERUNS: ATPRERUNS.join('\n'),
+          ATPREINITS: ATPREINITS.join('\n'),
           ATINITS: ATINITS.join('\n'),
           ATPOSTCTORS: ATPOSTCTORS.join('\n'),
           ATMAINS: ATMAINS.join('\n'),

src/lib/libcore.js

@@ -2283,7 +2283,8 @@ addToLibrary({
   $wasmTable: undefined,
 #endif
 
-  $noExitRuntime: "{{{ makeModuleReceiveExpr('noExitRuntime', !EXIT_RUNTIME) }}}",
+  $noExitRuntime__postset: () => addAtPreInit(makeModuleReceive('noExitRuntime')),
+  $noExitRuntime: {{{ !EXIT_RUNTIME }}},
 
   // The following addOn<X> functions are for adding runtime callbacks at
   // various executions points. Each addOn<X> function has a corresponding

src/lib/libfs_shared.js

@@ -5,7 +5,8 @@
  */
 
 addToLibrary({
-  $preloadPlugins: "{{{ makeModuleReceiveExpr('preloadPlugins', '[]') }}}",
+  $preloadPlugins__postset: () => addAtPreInit(makeModuleReceive('preloadPlugins')),
+  $preloadPlugins: [],
 
 #if !MINIMAL_RUNTIME
   // Tries to handle an input byteArray using preload plugins. Returns true if

src/modules.mjs

@@ -22,7 +22,7 @@ import {
   mergeInto,
   localFile,
 } from './utility.mjs';
-import {preprocess, processMacros} from './parseTools.mjs';
+import {addAtPreInit, preprocess, processMacros} from './parseTools.mjs';
 
 // Various namespace-like modules
 
@@ -401,7 +401,6 @@ function addMissingLibraryStubs(unusedLibSymbols) {
     rtn += `  '${sym}',\n`;
   }
   rtn += '];\n';
-  rtn += 'missingLibrarySymbols.forEach(missingLibrarySymbol)\n';
   return rtn;
 }
 
@@ -515,9 +514,7 @@ function exportRuntime() {
     // in ASSERTIONS mode we show a useful error if it is used without being
     // exported.  See `unexportedRuntimeSymbol` in runtime_debug.js.
     const unusedLibSymbols = getUnusedLibrarySymbols();
-    if (unusedLibSymbols.size) {
-      results.push(addMissingLibraryStubs(unusedLibSymbols));
-    }
+    results.push(addMissingLibraryStubs(unusedLibSymbols));
 
     const unexported = [];
     for (const name of runtimeElements) {
@@ -526,15 +523,12 @@ function exportRuntime() {
       }
     }
 
-    if (unexported.length || unusedLibSymbols.size) {
-      let unexportedStubs = 'var unexportedSymbols = [\n';
-      for (const sym of unexported) {
-        unexportedStubs += `  '${sym}',\n`;
-      }
-      unexportedStubs += '];\n';
-      unexportedStubs += 'unexportedSymbols.forEach(unexportedRuntimeSymbol);\n';
-      results.push(unexportedStubs);
+    let unexportedStubs = 'var unexportedSymbols = [\n';
+    for (const sym of unexported) {
+      unexportedStubs += `  '${sym}',\n`;
     }
+    unexportedStubs += '];\n';
+    results.push(unexportedStubs);
   }
 
   return results.join('\n') + '\n';

src/parseTools.mjs

@@ -720,6 +720,14 @@ function makeEval(code) {
   return ret;
 }
 
+// Add code that runs before the wasm modules is loaded.  This is the first
+// point at which the global `Module` object is guaranteed to exist. This hooks
+// is mostly used to read incoming `Module` properties.
+export const ATPREINITS = [];
+export function addAtPreInit(code) {
+  ATPREINITS.push(code);
+}
+
 // Add code to run soon after the Wasm module has been loaded. This is the first
 // injection point before all the other addAt<X> functions below. The code will
 // be executed after the runtime `onPreRuns` callbacks.
@@ -888,7 +896,7 @@ function makeModuleReceive(localName, moduleName) {
   if (expectToReceiveOnModule(moduleName)) {
     // Usually the local we use is the same as the Module property name,
     // but sometimes they must differ.
-    ret = `\nif (Module['${moduleName}']) ${localName} = Module['${moduleName}'];`;
+    ret = `if (Module['${moduleName}']) ${localName} = Module['${moduleName}'];`;
   }
   ret += makeRemovedModuleAPIAssert(moduleName, localName);
   return ret;
@@ -907,20 +915,15 @@ function makeModuleReceiveWithVar(localName, moduleName, defaultValue, noAssert)
   moduleName ||= localName;
   checkReceiving(moduleName);
   let ret = `var ${localName}`;
-  if (!expectToReceiveOnModule(moduleName)) {
-    if (defaultValue) {
-      ret += ` = ${defaultValue}`;
-    }
-    ret += ';';
-  } else {
-    if (defaultValue) {
-      ret += ` = Module['${moduleName}'] || ${defaultValue};`;
-    } else {
-      ret += ` = Module['${moduleName}'];`;
-    }
+  if (defaultValue) {
+    ret += ` = ${defaultValue}`;
+  }
+  ret += ';';
+  if (expectToReceiveOnModule(moduleName)) {
+    addAtPreInit(`if (Module['${moduleName}']) ${localName} = Module['${moduleName}'];`);
   }
   if (!noAssert) {
-    ret += makeRemovedModuleAPIAssert(moduleName, localName);
+    addAtPreInit(makeRemovedModuleAPIAssert(moduleName, localName));
   }
   return ret;
 }
@@ -1129,6 +1132,7 @@ addToCompileTimeContext({
   ENVIRONMENT_IS_WORKER_THREAD,
   addAtExit,
   addAtPreRun,
+  addAtPreInit,
   addAtInit,
   addAtPostCtor,
   addAtPreMain,

src/postamble.js

@@ -199,7 +199,7 @@ function run() {
 #endif
 
 #if HAS_MAIN
-    {{{ makeModuleReceiveWithVar('noInitialRun', undefined, !INVOKE_RUN) }}}
+    var noInitialRun = {{{ makeModuleReceiveExpr('noInitialRun', !INVOKE_RUN) }}};
 #if MAIN_READS_PARAMS
     if (!noInitialRun) callMain(args);
 #else
@@ -287,26 +287,15 @@ function checkUnflushedContent() {
 #endif // EXIT_RUNTIME
 #endif // ASSERTIONS
 
-#if expectToReceiveOnModule('preInit')
-if (Module['preInit']) {
-  if (typeof Module['preInit'] == 'function') Module['preInit'] = [Module['preInit']];
-  while (Module['preInit'].length > 0) {
-    Module['preInit'].shift()();
-  }
-}
-#if ASSERTIONS
-consumedModuleProp('preInit');
-#endif
-#endif
-
-
 #if WASM_ESM_INTEGRATION
 export default function init(moduleArg = {}) {
-  // TODO(sbc): moduleArg processing
+  Module = moduleArg;
   updateMemoryViews();
+  processModuleArgs();
   run();
 }
 #else
+processModuleArgs();
 run();
 #endif
 

src/postamble_minimal.js

@@ -136,6 +136,8 @@ WebAssembly.instantiateStreaming(fetch('{{{ TARGET_BASENAME }}}.wasm'), imports)
 if (!Module['wasm']) throw 'Must load WebAssembly Module in to variable Module.wasm before adding compiled output .js script to the DOM';
 #endif
 
+<<< ATPREINITS >>>
+
 WebAssembly.instantiate(Module['wasm'], imports).then((output) => {
 #endif
 

src/preamble.js

@@ -158,10 +158,6 @@ assert(typeof Int32Array != 'undefined' && typeof Float64Array !== 'undefined' &
 #if IMPORTED_MEMORY
 // In non-standalone/normal mode, we create the memory here.
 #include "runtime_init_memory.js"
-#elif ASSERTIONS
-// If memory is defined in wasm, the user can't provide it, or set INITIAL_MEMORY
-assert(!Module['wasmMemory'], 'Use of `wasmMemory` detected.  Use -sIMPORTED_MEMORY to define wasmMemory externally');
-assert(!Module['INITIAL_MEMORY'], 'Detected runtime INITIAL_MEMORY setting.  Use -sIMPORTED_MEMORY to define wasmMemory dynamically');
 #endif // !IMPORTED_MEMORY && ASSERTIONS
 
 #if RELOCATABLE
@@ -461,8 +457,8 @@ var FS = {
 
   ErrnoError() { FS.error() },
 };
-Module['FS_createDataFile'] = FS.createDataFile;
-Module['FS_createPreloadedFile'] = FS.createPreloadedFile;
+//Module['FS_createDataFile'] = FS.createDataFile;
+//Module['FS_createPreloadedFile'] = FS.createPreloadedFile;
 #endif
 
 #if ASSERTIONS
@@ -1086,3 +1082,68 @@ function getCompilerSetting(name) {
 // dynamic linker as symbols are loaded.
 var asyncifyStubs = {};
 #endif
+
+function processModuleArgs() {
+#if ASSERTIONS
+  checkIncomingModuleAPI();
+#endif
+
+  <<< ATPREINITS >>>
+
+#if expectToReceiveOnModule('preInit')
+  if (Module['preInit']) {
+    if (typeof Module['preInit'] == 'function') Module['preInit'] = [Module['preInit']];
+    while (Module['preInit'].length > 0) {
+      Module['preInit'].shift()();
+    }
+  }
+#if ASSERTIONS
+  consumedModuleProp('preInit');
+#endif
+#endif
+
+  {{{ makeModuleReceive('arguments_', 'arguments') }}}
+  {{{ makeModuleReceive('thisProgram') }}}
+
+
+#if ASSERTIONS
+  // Assertions on removed incoming Module JS APIs.
+  assert(typeof Module['memoryInitializerPrefixURL'] == 'undefined', 'Module.memoryInitializerPrefixURL option was removed, use Module.locateFile instead');
+  assert(typeof Module['pthreadMainPrefixURL'] == 'undefined', 'Module.pthreadMainPrefixURL option was removed, use Module.locateFile instead');
+  assert(typeof Module['cdInitializerPrefixURL'] == 'undefined', 'Module.cdInitializerPrefixURL option was removed, use Module.locateFile instead');
+  assert(typeof Module['filePackagePrefixURL'] == 'undefined', 'Module.filePackagePrefixURL option was removed, use Module.locateFile instead');
+  assert(typeof Module['read'] == 'undefined', 'Module.read option was removed');
+  assert(typeof Module['readAsync'] == 'undefined', 'Module.readAsync option was removed (modify readAsync in JS)');
+  assert(typeof Module['readBinary'] == 'undefined', 'Module.readBinary option was removed (modify readBinary in JS)');
+  assert(typeof Module['setWindowTitle'] == 'undefined', 'Module.setWindowTitle option was removed (modify emscripten_set_window_title in JS)');
+  assert(typeof Module['TOTAL_MEMORY'] == 'undefined', 'Module.TOTAL_MEMORY has been renamed Module.INITIAL_MEMORY');
+  assert(typeof Module['ENVIRONMENT'] == 'undefined', 'Module.ENVIRONMENT has been deprecated. To force the environment, use the ENVIRONMENT compile-time option (for example, -sENVIRONMENT=web or -sENVIRONMENT=node)');
+  assert(typeof Module['STACK_SIZE'] == 'undefined', 'STACK_SIZE can no longer be set at runtime.  Use -sSTACK_SIZE at link time')
+#if !IMPORTED_MEMORY
+  // If memory is defined in wasm, the user can't provide it, or set INITIAL_MEMORY
+  assert(typeof Module['wasmMemory'] == 'undefined', 'Use of `wasmMemory` detected.  Use -sIMPORTED_MEMORY to define wasmMemory externally');
+  assert(typeof Module['INITIAL_MEMORY'] == 'undefined', 'Detected runtime INITIAL_MEMORY setting.  Use -sIMPORTED_MEMORY to define wasmMemory dynamically');
+#endif
+  {{{ makeRemovedModuleAPIAssert('asm', 'wasmExports', false) }}}
+  {{{ makeRemovedModuleAPIAssert('readAsync') }}}
+  {{{ makeRemovedModuleAPIAssert('readBinary') }}}
+  {{{ makeRemovedModuleAPIAssert('setWindowTitle') }}}
+  {{{ makeRemovedFSAssert('IDBFS') }}}
+  {{{ makeRemovedFSAssert('PROXYFS') }}}
+  {{{ makeRemovedFSAssert('WORKERFS') }}}
+  {{{ makeRemovedFSAssert('FETCHFS') }}}
+  {{{ makeRemovedFSAssert('ICASEFS') }}}
+  {{{ makeRemovedFSAssert('JSFILEFS') }}}
+  {{{ makeRemovedFSAssert('OPFS') }}}
+
+#if !NODERAWFS
+  {{{ makeRemovedFSAssert('NODEFS') }}}
+#endif
+
+#if !EXPORT_ALL
+  unexportedSymbols.forEach(unexportedRuntimeSymbol);
+  missingLibrarySymbols.forEach(missingLibrarySymbol);
+#endif
+
+#endif // ASSERTIONS
+}

src/shell.js

@@ -21,7 +21,7 @@
 // before the code. Then that object will be used in the code, and you
 // can continue to use Module afterwards as well.
 #if WASM_ESM_INTEGRATION
-var Module = {};
+var Module;
 #elif MODULARIZE
 var Module = moduleArg;
 #elif USE_CLOSURE_COMPILER
@@ -403,47 +403,9 @@ if (ENVIRONMENT_IS_NODE) {
 #endif
 
 #if ASSERTIONS
-checkIncomingModuleAPI();
-#endif
-
-// Emit code to handle expected values on the Module object. This applies Module.x
-// to the proper local x. This has two benefits: first, we only emit it if it is
-// expected to arrive, and second, by using a local everywhere else that can be
-// minified.
-{{{ makeModuleReceive('arguments_', 'arguments') }}}
-{{{ makeModuleReceive('thisProgram') }}}
-
-// perform assertions in shell.js after we set up out() and err(), as otherwise if an assertion fails it cannot print the message
-#if ASSERTIONS
-// Assertions on removed incoming Module JS APIs.
-assert(typeof Module['memoryInitializerPrefixURL'] == 'undefined', 'Module.memoryInitializerPrefixURL option was removed, use Module.locateFile instead');
-assert(typeof Module['pthreadMainPrefixURL'] == 'undefined', 'Module.pthreadMainPrefixURL option was removed, use Module.locateFile instead');
-assert(typeof Module['cdInitializerPrefixURL'] == 'undefined', 'Module.cdInitializerPrefixURL option was removed, use Module.locateFile instead');
-assert(typeof Module['filePackagePrefixURL'] == 'undefined', 'Module.filePackagePrefixURL option was removed, use Module.locateFile instead');
-assert(typeof Module['read'] == 'undefined', 'Module.read option was removed');
-assert(typeof Module['readAsync'] == 'undefined', 'Module.readAsync option was removed (modify readAsync in JS)');
-assert(typeof Module['readBinary'] == 'undefined', 'Module.readBinary option was removed (modify readBinary in JS)');
-assert(typeof Module['setWindowTitle'] == 'undefined', 'Module.setWindowTitle option was removed (modify emscripten_set_window_title in JS)');
-assert(typeof Module['TOTAL_MEMORY'] == 'undefined', 'Module.TOTAL_MEMORY has been renamed Module.INITIAL_MEMORY');
-assert(typeof Module['ENVIRONMENT'] == 'undefined', 'Module.ENVIRONMENT has been deprecated. To force the environment, use the ENVIRONMENT compile-time option (for example, -sENVIRONMENT=web or -sENVIRONMENT=node)');
-assert(typeof Module['STACK_SIZE'] == 'undefined', 'STACK_SIZE can no longer be set at runtime.  Use -sSTACK_SIZE at link time')
-
-{{{ makeRemovedModuleAPIAssert('asm', 'wasmExports', false) }}}
-{{{ makeRemovedModuleAPIAssert('readAsync') }}}
-{{{ makeRemovedModuleAPIAssert('readBinary') }}}
-{{{ makeRemovedModuleAPIAssert('setWindowTitle') }}}
-{{{ makeRemovedFSAssert('IDBFS') }}}
-{{{ makeRemovedFSAssert('PROXYFS') }}}
-{{{ makeRemovedFSAssert('WORKERFS') }}}
-{{{ makeRemovedFSAssert('FETCHFS') }}}
-{{{ makeRemovedFSAssert('ICASEFS') }}}
-{{{ makeRemovedFSAssert('JSFILEFS') }}}
-{{{ makeRemovedFSAssert('OPFS') }}}
-
-#if !NODERAWFS
-{{{ makeRemovedFSAssert('NODEFS') }}}
-#endif
 
+// perform assertions in shell.js after we set up out() and err(), as otherwise
+// if an assertion fails it cannot print the message
 #if PTHREADS
 assert(
 #if AUDIO_WORKLET

test/other/codesize/test_codesize_cxx_ctors1.gzsize

@@ -1 +1 @@
-8233
+8257

test/other/codesize/test_codesize_cxx_ctors1.jssize

@@ -1 +1 @@
-19989
+20052

test/other/codesize/test_codesize_cxx_ctors2.gzsize

@@ -1 +1 @@
-8220
+8245

test/other/codesize/test_codesize_cxx_ctors2.jssize

@@ -1 +1 @@
-19967
+20030

test/other/codesize/test_codesize_cxx_except.gzsize

@@ -1 +1 @@
-9231
+9259

test/other/codesize/test_codesize_cxx_except.jssize

@@ -1 +1 @@
-23726
+23789

test/other/codesize/test_codesize_cxx_except_wasm.gzsize

@@ -1 +1 @@
-8176
+8198

test/other/codesize/test_codesize_cxx_except_wasm.jssize

@@ -1 +1 @@
-19881
+19945

test/other/codesize/test_codesize_cxx_except_wasm_legacy.gzsize

@@ -1 +1 @@
-8176
+8198

test/other/codesize/test_codesize_cxx_except_wasm_legacy.jssize

@@ -1 +1 @@
-19881
+19945

test/other/codesize/test_codesize_cxx_lto.gzsize

@@ -1 +1 @@
-8245
+8269

test/other/codesize/test_codesize_cxx_lto.jssize

@@ -1 +1 @@
-20063
+20127

test/other/codesize/test_codesize_cxx_mangle.gzsize

@@ -1 +1 @@
-9269
+9297

test/other/codesize/test_codesize_cxx_mangle.jssize

@@ -1 +1 @@
-23840
+23903

test/other/codesize/test_codesize_cxx_noexcept.gzsize

@@ -1 +1 @@
-8233
+8257

test/other/codesize/test_codesize_cxx_noexcept.jssize

@@ -1 +1 @@
-19989
+20052

test/other/codesize/test_codesize_cxx_wasmfs.gzsize

@@ -1 +1 @@
-3436
+3451

test/other/codesize/test_codesize_cxx_wasmfs.jssize

@@ -1 +1 @@
-7425
+7487

test/other/codesize/test_codesize_files_js_fs.gzsize

@@ -1 +1 @@
-7540
+7563