sharp 0.33.0 → 0.33.1-rc.2

package/install/check.js

@@ -3,34 +3,39 @@
 
 'use strict';
 
-const { useGlobalLibvips, globalLibvipsVersion, log, spawnRebuild } = require('../lib/libvips');
+try {
+  const { useGlobalLibvips, globalLibvipsVersion, log, spawnRebuild } = require('../lib/libvips');
 
-const buildFromSource = (msg) => {
-  log(msg);
-  log('Attempting to build from source via node-gyp');
-  try {
-    require('node-addon-api');
-    log('Found node-addon-api');
-  } catch (err) {
-    log('Please add node-addon-api to your dependencies');
-    return;
-  }
-  try {
-    const gyp = require('node-gyp');
-    log(`Found node-gyp version ${gyp().version}`);
-  } catch (err) {
-    log('Please add node-gyp to your dependencies');
-    return;
-  }
-  log('See https://sharp.pixelplumbing.com/install#building-from-source');
-  const status = spawnRebuild();
-  if (status !== 0) {
-    process.exit(status);
-  }
-};
+  const buildFromSource = (msg) => {
+    log(msg);
+    log('Attempting to build from source via node-gyp');
+    try {
+      require('node-addon-api');
+      log('Found node-addon-api');
+    } catch (err) {
+      log('Please add node-addon-api to your dependencies');
+      return;
+    }
+    try {
+      const gyp = require('node-gyp');
+      log(`Found node-gyp version ${gyp().version}`);
+    } catch (err) {
+      log('Please add node-gyp to your dependencies');
+      return;
+    }
+    log('See https://sharp.pixelplumbing.com/install#building-from-source');
+    const status = spawnRebuild();
+    if (status !== 0) {
+      process.exit(status);
+    }
+  };
 
-if (useGlobalLibvips()) {
-  buildFromSource(`Detected globally-installed libvips v${globalLibvipsVersion()}`);
-} else if (process.env.npm_config_build_from_source) {
-  buildFromSource('Detected --build-from-source flag');
+  if (useGlobalLibvips()) {
+    buildFromSource(`Detected globally-installed libvips v${globalLibvipsVersion()}`);
+  } else if (process.env.npm_config_build_from_source) {
+    buildFromSource('Detected --build-from-source flag');
+  }
+} catch (err) {
+  const summary = err.message.split(/\n/).slice(0, 1);
+  console.log(`sharp: skipping install check: ${summary}`);
 }

package/lib/index.d.ts

@@ -126,7 +126,7 @@ declare namespace sharp {
     function counters(): SharpCounters;
 
     /**
-     * Get and set use of SIMD vector unit instructions. Requires libvips to have been compiled with liborc support.
+     * Get and set use of SIMD vector unit instructions. Requires libvips to have been compiled with highway support.
      * Improves the performance of resize, blur and sharpen operations by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
      * @param enable enable or disable use of SIMD vector unit instructions
      * @returns true if usage of SIMD vector unit instructions is enabled

package/lib/libvips.js

@@ -4,11 +4,12 @@
 'use strict';
 
 const { spawnSync } = require('node:child_process');
+const { createHash } = require('node:crypto');
 const semverCoerce = require('semver/functions/coerce');
 const semverGreaterThanOrEqualTo = require('semver/functions/gte');
 const detectLibc = require('detect-libc');
 
-const { engines } = require('../package.json');
+const { engines, optionalDependencies } = require('../package.json');
 
 const minimumLibvipsVersionLabelled = process.env.npm_package_config_libvips || /* istanbul ignore next */
   engines.libvips;
@@ -97,6 +98,17 @@ const isRosetta = () => {
   return false;
 };
 
+const sha512 = (s) => createHash('sha512').update(s).digest('hex');
+
+const yarnLocator = () => {
+  try {
+    const identHash = sha512(`imgsharp-libvips-${buildPlatformArch()}`);
+    const npmVersion = semverCoerce(optionalDependencies[`@img/sharp-libvips-${buildPlatformArch()}`]).version;
+    return sha512(`${identHash}npm:${npmVersion}`).slice(0, 10);
+  } catch {}
+  return '';
+};
+
 /* istanbul ignore next */
 const spawnRebuild = () =>
   spawnSync(`node-gyp rebuild --directory=src ${isEmscripten() ? '--nodedir=emscripten' : ''}`, {
@@ -164,6 +176,7 @@ module.exports = {
   buildSharpLibvipsLibDir,
   runtimePlatformArch,
   log,
+  yarnLocator,
   spawnRebuild,
   globalLibvipsVersion,
   pkgConfigPath,

package/lib/sharp.js

@@ -46,41 +46,63 @@ if (sharp) {
   // Common error messages
   if (prebuiltPlatforms.includes(runtimePlatform)) {
     const [os, cpu] = runtimePlatform.split('-');
-    help.push('- Add platform-specific dependencies:');
-    help.push(`    npm install --os=${os} --cpu=${cpu} sharp`);
-    help.push('  or');
-    help.push(`    npm install --force @img/sharp-${runtimePlatform}`);
+    help.push(
+      '- Ensure optional dependencies can be installed:',
+      '    npm install --include=optional sharp',
+      '    yarn add sharp --ignore-engines',
+      '- Ensure your package manager supports multi-platform installation:',
+      '    See https://sharp.pixelplumbing.com/install#cross-platform',
+      '- Add platform-specific dependencies:',
+      `    npm install --os=${os} --cpu=${cpu} sharp`,
+      `    npm install --force @img/sharp-${runtimePlatform}`
+    );
   } else {
-    help.push(`- Manually install libvips >= ${minimumLibvipsVersion}`);
-    help.push('- Add experimental WebAssembly-based dependencies:');
-    help.push('    npm install --cpu=wasm32 sharp');
+    help.push(
+      `- Manually install libvips >= ${minimumLibvipsVersion}`,
+      '- Add experimental WebAssembly-based dependencies:',
+      '    npm install --cpu=wasm32 sharp',
+      '    npm install --force @img/sharp-wasm32'
+    );
   }
-  if (isLinux && /symbol not found/i.test(messages)) {
+  if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {
     try {
       const { engines } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
       const libcFound = `${familySync()} ${versionSync()}`;
       const libcRequires = `${engines.musl ? 'musl' : 'glibc'} ${engines.musl || engines.glibc}`;
-      help.push('- Update your OS:');
-      help.push(`    Found ${libcFound}`);
-      help.push(`    Requires ${libcRequires}`);
+      help.push(
+        '- Update your OS:',
+        `    Found ${libcFound}`,
+        `    Requires ${libcRequires}`
+      );
     } catch (errEngines) {}
   }
+  if (isLinux && /\/snap\/core[0-9]{2}/.test(messages)) {
+    help.push(
+      '- Remove the Node.js Snap, which does not support native modules',
+      '    snap remove node'
+    );
+  }
   if (isMacOs && /Incompatible library version/.test(messages)) {
-    help.push('- Update Homebrew:');
-    help.push('    brew update && brew upgrade vips');
+    help.push(
+      '- Update Homebrew:',
+      '    brew update && brew upgrade vips'
+    );
   }
   if (errors.some(err => err.code === 'ERR_DLOPEN_DISABLED')) {
     help.push('- Run Node.js without using the --no-addons flag');
   }
-  if (process.versions.pnp) {
-    help.push('- Use a supported yarn linker, either pnpm or node-modules:');
-    help.push('    yarn config set nodeLinker node-modules');
-  }
   // Link to installation docs
   if (isWindows && /The specified procedure could not be found/.test(messages)) {
-    help.push('- Using the canvas package on Windows? See https://sharp.pixelplumbing.com/install#canvas-and-windows');
-  } else {
-    help.push('- Consult the installation documentation: https://sharp.pixelplumbing.com/install');
+    help.push(
+      '- Using the canvas package on Windows?',
+      '    See https://sharp.pixelplumbing.com/install#canvas-and-windows',
+      '- Check for outdated versions of sharp in the dependency tree:',
+      '    npm ls sharp'
+    );
   }
+  help.push(
+    '- Consult the installation documentation:',
+    '    See https://sharp.pixelplumbing.com/install'
+  );
   throw new Error(help.join('\n'));
 }

package/lib/utility.js

@@ -183,17 +183,17 @@ function counters () {
 
 /**
  * Get and set use of SIMD vector unit instructions.
- * Requires libvips to have been compiled with liborc support.
+ * Requires libvips to have been compiled with highway support.
  *
  * Improves the performance of `resize`, `blur` and `sharpen` operations
  * by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
  *
  * @example
  * const simd = sharp.simd();
- * // simd is `true` if the runtime use of liborc is currently enabled
+ * // simd is `true` if the runtime use of highway is currently enabled
  * @example
  * const simd = sharp.simd(false);
- * // prevent libvips from using liborc at runtime
+ * // prevent libvips from using highway at runtime
  *
  * @param {boolean} [simd=true]
  * @returns {boolean}
@@ -201,7 +201,6 @@ function counters () {
 function simd (simd) {
   return sharp.simd(is.bool(simd) ? simd : null);
 }
-simd(true);
 
 /**
  * Block libvips operations at runtime.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sharp",
   "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, GIF, AVIF and TIFF images",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.2",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://github.com/lovell/sharp",
   "contributors": [
@@ -141,8 +141,8 @@
     "semver": "^7.5.4"
   },
   "optionalDependencies": {
-    "@img/sharp-darwin-arm64": "0.33.0",
-    "@img/sharp-darwin-x64": "0.33.0",
+    "@img/sharp-darwin-arm64": "0.33.1-rc.2",
+    "@img/sharp-darwin-x64": "0.33.1-rc.2",
     "@img/sharp-libvips-darwin-arm64": "1.0.0",
     "@img/sharp-libvips-darwin-x64": "1.0.0",
     "@img/sharp-libvips-linux-arm": "1.0.0",
@@ -151,15 +151,15 @@
     "@img/sharp-libvips-linux-x64": "1.0.0",
     "@img/sharp-libvips-linuxmusl-arm64": "1.0.0",
     "@img/sharp-libvips-linuxmusl-x64": "1.0.0",
-    "@img/sharp-linux-arm": "0.33.0",
-    "@img/sharp-linux-arm64": "0.33.0",
-    "@img/sharp-linux-s390x": "0.33.0",
-    "@img/sharp-linux-x64": "0.33.0",
-    "@img/sharp-linuxmusl-arm64": "0.33.0",
-    "@img/sharp-linuxmusl-x64": "0.33.0",
-    "@img/sharp-wasm32": "0.33.0",
-    "@img/sharp-win32-ia32": "0.33.0",
-    "@img/sharp-win32-x64": "0.33.0"
+    "@img/sharp-linux-arm": "0.33.1-rc.2",
+    "@img/sharp-linux-arm64": "0.33.1-rc.2",
+    "@img/sharp-linux-s390x": "0.33.1-rc.2",
+    "@img/sharp-linux-x64": "0.33.1-rc.2",
+    "@img/sharp-linuxmusl-arm64": "0.33.1-rc.2",
+    "@img/sharp-linuxmusl-x64": "0.33.1-rc.2",
+    "@img/sharp-wasm32": "0.33.1-rc.2",
+    "@img/sharp-win32-ia32": "0.33.1-rc.2",
+    "@img/sharp-win32-x64": "0.33.1-rc.2"
   },
   "devDependencies": {
     "@emnapi/runtime": "^0.44.0",

package/src/binding.gyp

@@ -6,6 +6,7 @@
     'vips_version': '<!(node -p "require(\'../lib/libvips\').minimumLibvipsVersion")',
     'platform_and_arch': '<!(node -p "require(\'../lib/libvips\').buildPlatformArch()")',
     'sharp_libvips_version': '<!(node -p "require(\'../package.json\').optionalDependencies[\'@img/sharp-libvips-<(platform_and_arch)\']")',
+    'sharp_libvips_yarn_locator': '<!(node -p "require(\'../lib/libvips\').yarnLocator()")',
     'sharp_libvips_include_dir': '<!(node -p "require(\'../lib/libvips\').buildSharpLibvipsIncludeDir()")',
     'sharp_libvips_cplusplus_dir': '<!(node -p "require(\'../lib/libvips\').buildSharpLibvipsCPlusPlusDir()")',
     'sharp_libvips_lib_dir': '<!(node -p "require(\'../lib/libvips\').buildSharpLibvipsLibDir()")'
@@ -157,7 +158,8 @@
                 '-Wl,-rpath,\'@loader_path/../../sharp-libvips-<(platform_and_arch)/lib\'',
                 '-Wl,-rpath,\'@loader_path/../../../sharp-libvips-<(platform_and_arch)/<(sharp_libvips_version)/lib\'',
                 '-Wl,-rpath,\'@loader_path/../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
-                '-Wl,-rpath,\'@loader_path/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
+                '-Wl,-rpath,\'@loader_path/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
+                '-Wl,-rpath,\'@loader_path/../../../../../@img-sharp-libvips-<(platform_and_arch)-npm-<(sharp_libvips_version)-<(sharp_libvips_yarn_locator)/node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
               ]
             }
           }],
@@ -176,7 +178,8 @@
                 '-Wl,-rpath=\'$$ORIGIN/../../sharp-libvips-<(platform_and_arch)/lib\'',
                 '-Wl,-rpath=\'$$ORIGIN/../../../sharp-libvips-<(platform_and_arch)/<(sharp_libvips_version)/lib\'',
                 '-Wl,-rpath=\'$$ORIGIN/../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
-                '-Wl,-rpath=\'$$ORIGIN/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
+                '-Wl,-rpath=\'$$ORIGIN/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
+                '-Wl,-rpath,\'$$ORIGIN/../../../../../@img-sharp-libvips-<(platform_and_arch)-npm-<(sharp_libvips_version)-<(sharp_libvips_yarn_locator)/node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
               ]
             }
           }],

package/src/pipeline.cc

@@ -794,11 +794,15 @@ class PipelineWorker : public Napi::AsyncWorker {
 
       // Apply output ICC profile
       if (!baton->withIccProfile.empty()) {
-        image = image.icc_transform(const_cast<char*>(baton->withIccProfile.data()), VImage::option()
-          ->set("input_profile", processingProfile)
-          ->set("embedded", TRUE)
-          ->set("depth", sharp::Is16Bit(image.interpretation()) ? 16 : 8)
-          ->set("intent", VIPS_INTENT_PERCEPTUAL));
+        try {
+          image = image.icc_transform(const_cast<char*>(baton->withIccProfile.data()), VImage::option()
+            ->set("input_profile", processingProfile)
+            ->set("embedded", TRUE)
+            ->set("depth", sharp::Is16Bit(image.interpretation()) ? 16 : 8)
+            ->set("intent", VIPS_INTENT_PERCEPTUAL));
+        } catch(...) {
+          sharp::VipsWarningCallback(nullptr, G_LOG_LEVEL_WARNING, "Invalid profile", nullptr);
+        }
       } else if (baton->keepMetadata & VIPS_FOREIGN_KEEP_ICC) {
         image = sharp::SetProfile(image, inputProfile);
       }