Fix dual ESM/CJS support on various JS runtimes

Node.js does not support 'await import' with binaries

Author: lovell

lib/libvips.mjs

@@ -5,15 +5,13 @@
 
 import { spawnSync } from 'node:child_process';
 import { createHash } from 'node:crypto';
-import semverCoerce from 'semver/functions/coerce';
-import semverGreaterThanOrEqualTo from 'semver/functions/gte';
-import semverSatisfies from 'semver/functions/satisfies';
+import semver from 'semver';
 import detectLibc from 'detect-libc';
 import pkg from '../package.json' with { type: 'json' };
 
 /* node:coverage ignore next */
 const minimumLibvipsVersionLabelled = process.env.npm_package_config_libvips || pkg.config.libvips;
-const minimumLibvipsVersion = semverCoerce(minimumLibvipsVersionLabelled).version;
+const minimumLibvipsVersion = semver.coerce(minimumLibvipsVersionLabelled).version;
 
 const prebuiltPlatforms = [
   'darwin-arm64', 'darwin-x64',
@@ -82,7 +80,7 @@ const buildSharpLibvipsLibDir = () => {
 
 const isUnsupportedNodeRuntime = () => {
   if (process.release?.name === 'node' && process.versions) {
-    if (!semverSatisfies(process.versions.node, pkg.engines.node)) {
+    if (!semver.satisfies(process.versions.node, pkg.engines.node)) {
       return { found: process.versions.node, expected: pkg.engines.node };
     }
   }
@@ -108,7 +106,7 @@ const sha512 = (s) => createHash('sha512').update(s).digest('hex');
 const yarnLocator = () => {
   try {
     const identHash = sha512(`imgsharp-libvips-${buildPlatformArch()}`);
-    const npmVersion = semverCoerce(pkg.optionalDependencies[`@img/sharp-libvips-${buildPlatformArch()}`], {
+    const npmVersion = semver.coerce(pkg.optionalDependencies[`@img/sharp-libvips-${buildPlatformArch()}`], {
       includePrerelease: true
     }).version;
     return sha512(`${identHash}npm:${npmVersion}`).slice(0, 10);
@@ -193,7 +191,7 @@ const useGlobalLibvips = (logger) => {
   }
   const globalVipsVersion = globalLibvipsVersion();
   /* node:coverage ignore next */
-  return !!globalVipsVersion && semverGreaterThanOrEqualTo(globalVipsVersion, minimumLibvipsVersion);
+  return !!globalVipsVersion && semver.gte(globalVipsVersion, minimumLibvipsVersion);
 };
 
 export default {

lib/sharp.mjs

@@ -5,24 +5,30 @@
 
 // Inspects the runtime environment and exports the relevant sharp.node binary
 
+import { createRequire } from "node:module"
 import { familySync, versionSync } from "detect-libc";
 
-import { version } from '../package.json';
-import { runtimePlatformArch, isUnsupportedNodeRuntime, prebuiltPlatforms, minimumLibvipsVersion } from "./libvips.mjs";
+import libvips from "./libvips.mjs";
+import pkg from '../package.json' with { type: 'json' };
+
+const require = createRequire(import.meta.url);
+const { version } = pkg;
+
+const { runtimePlatformArch, isUnsupportedNodeRuntime, prebuiltPlatforms, minimumLibvipsVersion } = libvips;
 const runtimePlatform = runtimePlatformArch();
 
 /* node:coverage disable */
 
 let sharp;
 const errors = [];
 try {
-  sharp = await import(`../src/build/Release/sharp-${runtimePlatform}-${version}.node`);
+  sharp = require(`../src/build/Release/sharp-${runtimePlatform}-${version}.node`);
 } catch (err) {
   errors.push(err);
 }
 if (!sharp) {
   try {
-    sharp = await import(`../src/build/Release/sharp-wasm32-${version}.node`);
+    sharp = require(`../src/build/Release/sharp-wasm32-${version}.node`);
   } catch (err) {
     errors.push(err);
   }
@@ -31,53 +37,53 @@ if (!sharp) {
   try {
     switch (runtimePlatform) {
       case "darwin-arm64":
-        sharp = await import("@img/sharp-darwin-arm64/sharp.node");
+        sharp = require("@img/sharp-darwin-arm64/sharp.node");
         break;
       case "darwin-x64":
-        sharp = await import("@img/sharp-darwin-x64/sharp.node");
+        sharp = require("@img/sharp-darwin-x64/sharp.node");
         break;
       case "linux-arm":
-        sharp = await import("@img/sharp-linux-arm/sharp.node");
+        sharp = require("@img/sharp-linux-arm/sharp.node");
         break;
       case "linux-arm64":
-        sharp = await import("@img/sharp-linux-arm64/sharp.node");
+        sharp = require("@img/sharp-linux-arm64/sharp.node");
         break;
       case "linux-ppc64":
-        sharp = await import("@img/sharp-linux-ppc64/sharp.node");
+        sharp = require("@img/sharp-linux-ppc64/sharp.node");
         break;
       case "linux-riscv64":
-        sharp = await import("@img/sharp-linux-riscv64/sharp.node");
+        sharp = require("@img/sharp-linux-riscv64/sharp.node");
         break;
       case "linux-s390x":
-        sharp = await import("@img/sharp-linux-s390x/sharp.node");
+        sharp = require("@img/sharp-linux-s390x/sharp.node");
         break;
       case "linux-x64":
-        sharp = await import("@img/sharp-linux-x64/sharp.node");
+        sharp = require("@img/sharp-linux-x64/sharp.node");
         break;
       case "linuxmusl-arm64":
-        sharp = await import("@img/sharp-linuxmusl-arm64/sharp.node");
+        sharp = require("@img/sharp-linuxmusl-arm64/sharp.node");
         break;
       case "linuxmusl-x64":
-        sharp = await import("@img/sharp-linuxmusl-x64/sharp.node");
+        sharp = require("@img/sharp-linuxmusl-x64/sharp.node");
         break;
       case "win32-arm64":
-        sharp = await import("@img/sharp-win32-arm64/sharp.node");
+        sharp = require("@img/sharp-win32-arm64/sharp.node");
         break;
       case "win32-ia32":
-        sharp = await import("@img/sharp-win32-ia32/sharp.node");
+        sharp = require("@img/sharp-win32-ia32/sharp.node");
         break;
       case "win32-x64":
-        sharp = await import("@img/sharp-win32-x64/sharp.node");
+        sharp = require("@img/sharp-win32-x64/sharp.node");
         break;
       case "freebsd-arm64":
       case "freebsd-x64":
-        sharp = await import("@img/sharp-freebsd-wasm32/sharp.node");
+        sharp = require("@img/sharp-freebsd-wasm32/sharp.node");
         break;
       case "linux-wasm32":
-        sharp = await import("@img/sharp-webcontainers-wasm32/sharp.node");
+        sharp = require("@img/sharp-webcontainers-wasm32/sharp.node");
         break;
       default:
-        sharp = await import("@img/sharp-wasm32/sharp.node");
+        sharp = require("@img/sharp-wasm32/sharp.node");
         break;
     }
     if (["linux-x64", "linuxmusl-x64"].includes(runtimePlatform) && !sharp._isUsingX64V2()) {
@@ -96,7 +102,7 @@ if (!sharp) {
 
   const help = [`Could not load the "sharp" module using the ${runtimePlatform} runtime`];
   errors.forEach((err) => {
-    if (err.code !== "MODULE_NOT_FOUND") {
+    if (!err.code.endsWith("MODULE_NOT_FOUND")) {
       help.push(`${err.code}: ${err.message}`);
     }
   });
@@ -127,7 +133,7 @@ if (!sharp) {
   }
   if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {
     try {
-      const { config } = await import(`@img/sharp-libvips-${runtimePlatform}/package`);
+      const { config } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
       const libcFound = `${familySync()} ${versionSync()}`;
       const libcRequires = `${config.musl ? "musl" : "glibc"} ${config.musl || config.glibc}`;
       help.push("- Update your OS:", `    Found ${libcFound}`, `    Requires ${libcRequires}`);

lib/utility.mjs

@@ -4,14 +4,17 @@
 */
 
 import events from 'node:events';
+import { createRequire } from "node:module";
+import { availableParallelism } from "node:os";
 import detectLibc from 'detect-libc';
 
 import is from './is.mjs';
-import { runtimePlatformArch } from './libvips.mjs';
+import libvips from './libvips.mjs';
 import sharp from './sharp.mjs';
 import pkg from "../package.json" with { type: "json" };
 
-const runtimePlatform = runtimePlatformArch();
+const require = createRequire(import.meta.url);
+const runtimePlatform = libvips.runtimePlatformArch();
 const libvipsVersion = sharp.libvipsVersion();
 
 /**
@@ -62,15 +65,15 @@ let versions = {
 if (!libvipsVersion.isGlobal) {
   if (!libvipsVersion.isWasm) {
     try {
-      versions = await import(`@img/sharp-${runtimePlatform}/versions`);
+      versions = require(`@img/sharp-${runtimePlatform}/versions`);
     } catch (_) {
       try {
-        versions = await import(`@img/sharp-libvips-${runtimePlatform}/versions`);
+        versions = require(`@img/sharp-libvips-${runtimePlatform}/versions`);
       } catch (_) {}
     }
   } else {
     try {
-      versions = await import('@img/sharp-wasm32/versions');
+      versions = require('@img/sharp-wasm32/versions');
     } catch (_) {}
   }
 }
@@ -157,7 +160,6 @@ if (detectLibc.familySync() === detectLibc.GLIBC && !sharp._isUsingJemalloc()) {
   sharp.concurrency(1);
 } else if (detectLibc.familySync() === detectLibc.MUSL && sharp.concurrency() === 1024) {
   // Reduce default concurrency when musl thread over-subscription detected
-  const { availableParallelism } = await import('node:os')
   sharp.concurrency(availableParallelism());
 }
 

scripts/build.mjs

@@ -21,14 +21,16 @@ function cjsToEsm(input) {
     )
     .replace(/import\s+('[^']+'|"[^"]+")(?:\s+with\s+\{[^}]*\})?;?/g, (_, path) => `require(${path.replace(".mjs", ".cjs")});`)
     // Transforms TLA
-    .replaceAll("await import(", "require(")
     .replaceAll("export default", "module.exports =")
+    // Remove createRequire
+    .replaceAll("const { createRequire } = require(\"node:module\");\n", "")
+    .replaceAll("const require = createRequire(import.meta.url);\n", "")
 }
 
-const entries = (await fs.readdir(libDir, { recursive: true })).filter(e => e.endsWith('.mjs'));
+const entries = (await fs.readdir(libDir)).filter(e => e.endsWith('.mjs'));
 
 for (const entry of entries) {
   await fs.cp(new URL(entry, libDir), new URL(entry, distDir));
   const contents = await fs.readFile(new URL(entry, libDir), "utf-8");
   await fs.writeFile(new URL(entry.replace(".mjs", ".cjs"), distDir), cjsToEsm(contents));
-}
+}