Add runtime check for outdated Node.js version

lovell · Jan 10, 2024 · 45e8071 · 45e8071
1 parent b96389d
commit 45e8071
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/lib/libvips.js b/lib/libvips.js
@@ -7,6 +7,7 @@ const { spawnSync } = require('node:child_process');
 const { createHash } = require('node:crypto');
 const semverCoerce = require('semver/functions/coerce');
 const semverGreaterThanOrEqualTo = require('semver/functions/gte');
+const semverSatisfies = require('semver/functions/satisfies');
 const detectLibc = require('detect-libc');
 
 const { engines, optionalDependencies } = require('../package.json');
@@ -83,6 +84,15 @@ const buildSharpLibvipsLibDir = () => {
   return '';
 };
 
+const isUnsupportedNodeRuntime = () => {
+  /* istanbul ignore next */
+  if (process.release?.name === 'node' && process.versions) {
+    if (!semverSatisfies(process.versions.node, engines.node)) {
+      return { found: process.versions.node, expected: engines.node };
+    }
+  }
+};
+
 /* istanbul ignore next */
 const isEmscripten = () => {
   const { CC } = process.env;
@@ -174,6 +184,7 @@ module.exports = {
   buildSharpLibvipsIncludeDir,
   buildSharpLibvipsCPlusPlusDir,
   buildSharpLibvipsLibDir,
+  isUnsupportedNodeRuntime,
   runtimePlatformArch,
   log,
   yarnLocator,

diff --git a/lib/sharp.js b/lib/sharp.js
@@ -7,7 +7,7 @@
 
 const { familySync, versionSync } = require('detect-libc');
 
-const { runtimePlatformArch, prebuiltPlatforms, minimumLibvipsVersion } = require('./libvips');
+const { runtimePlatformArch, isUnsupportedNodeRuntime, prebuiltPlatforms, minimumLibvipsVersion } = require('./libvips');
 const runtimePlatform = runtimePlatformArch();
 
 const paths = [
@@ -44,7 +44,14 @@ if (sharp) {
   const messages = errors.map(err => err.message).join(' ');
   help.push('Possible solutions:');
   // Common error messages
-  if (prebuiltPlatforms.includes(runtimePlatform)) {
+  if (isUnsupportedNodeRuntime()) {
+    const { found, expected } = isUnsupportedNodeRuntime();
+    help.push(
+      '- Please upgrade Node.js:',
+      `    Found ${found}`,
+      `    Requires ${expected}`
+    );
+  } else if (prebuiltPlatforms.includes(runtimePlatform)) {
     const [os, cpu] = runtimePlatform.split('-');
     const libc = os.endsWith('musl') ? ' --libc=musl' : '';
     help.push(

diff --git a/test/unit/libvips.js b/test/unit/libvips.js
@@ -123,6 +123,9 @@ describe('libvips binaries', function () {
       const [, arch] = libvips.runtimePlatformArch().split('-');
       assert.strict(['arm', 'arm64', 'ia32', 'x64'].includes(arch));
     });
+    it('isUnsupportedNodeRuntime', () => {
+      assert.strictEqual(libvips.isUnsupportedNodeRuntime(), undefined);
+    });
   });
 
   describe('logger', function () {