CommonJS compatibility broken due to dynamic import issues

[bgrgicak]

@php-wasm/node-* and @php-wasm/web-* packages fail to load in CommonJS environments:

Error [ERR_REQUIRE_ESM]: require() of ES Module .../php_8_5.js not supported.

From what I understood, PR #3062 set the CJS build config to use { 'dynamic-import': false } in build.js. This makes esbuild convert import() to require(), which fails when loading ES modules.
@adamziel was there a reason for disabling Dynamic imports in the CJS build?

CI didn't catch this because the CommonJS test suite tests against outdated npm packages, not the locally built ones.

Steps to recreate the issue

• cd packages/playground/test-built-npm-packages/commonjs-and-jest
• update the @wp-playground/cli package to the latest version
• npm test

[adamziel]

@bgrgicak no specific reason, it must have fallen through the cracks. We'll need to find a way to run those CI tests against the locally built modules to prevent breaking it again.

[adamziel]

CI didn't catch this because the CommonJS test suite tests against outdated npm packages, not the locally built ones.

I wonder how that's possible though. Any ideas? package.json lists the most recently built version of the Playground CLI package. If the dependencies are not available, shouldn't the entire job fail on the first unmet dependency? 🤔

[adamziel]

What are the reproduction steps for this error @bgrgicak?

@php-wasm/node seems to run just fine in CJS mode on Node 22:

package.json

{
  "name": "cjs-issue-test",
  "version": "1.0.0",
  "main": "index.js",
  "type": "commonjs",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "description": "",
  "dependencies": {
    "@php-wasm/node": "^3.0.33"
  }
}

test.js

const { loadNodeRuntime } = require("@php-wasm/node");

async function test() {
	console.log("Before load");
	await loadNodeRuntime('8.3');
	console.log("Done");
}
test();

Output:

Before load
Done

---

I've also tried this:

const { PHP } = require('@php-wasm/universal');
const { loadNodeRuntime } = require('@php-wasm/node');

async function test() {
        const php = new PHP( await loadNodeRuntime( '8.5' ) );
        console.log("Has PHP");
        const result = await php.run({ code: '<?php echo "Hi from CJS!"; ' });
        console.log(result.text);
}
test();

And got the following output:

Has PHP
Hi from CJS!

---

I've also tried requiring a built PHP version package directly to trigger the nested require() and that worked as well:

const php85 = require("@php-wasm/node-8-5");

php85.getPHPLoaderModule().then(result => {
        console.log(result);
}); 

I've also tried bundling it with Vite and that worked, too.

[adamziel]

also cc @wojtekn

[bgrgicak]

What are the reproduction steps for this error @bgrgicak?

• open packages/playground/test-built-npm-packages/commonjs-and-jest/package.json and update @wp-playground/cli to the 3.0.33 version
• cd packages/playground/test-built-npm-packages/commonjs-and-jest
• run npm install
• run npm run test

@wojtekn mentioned that this is still an issue, so I will test it with a local package build today.

CI didn't catch this because the CommonJS test suite tests against outdated npm packages, not the locally built ones.

This isn't correct, at the time of writing I forgot that CI runs a local package server and installs @wp-playground/cli from that server.

[bgrgicak]

I tested the issue manually again and can confirm that version 3.0.34 resolves the Error [ERR_REQUIRE_ESM]: require() of ES Module ... not supported. error in Playground's commonjs-and-jest tests.

To test it, I used the above testing instructions. Version 3.0.33 fails with the ERR_REQUIRE_ESM error, while 3.0.34 successfully passes all tests.