Prerelease v0.33.1-rc.0

The official Node.js Snap as distributed via the Ubuntu Snap Store
does not provide support for native modules.

Sometimes, if the version of the core matches the version of the
underlying OS, then it will appear to work.

There are quite a few open issues relating to this in the
nodejs/snap repo.

.github/ISSUE_TEMPLATE/installation.md

@@ -27,21 +27,28 @@ If you are using another package which depends on a version of `sharp` that is n
 
 <!-- Please place an [x] in the relevant box to confirm. -->
 
-- [ ] I am using Node.js 18 with a version >= 18.17.0
-- [ ] I am using Node.js 20 with a version >= 20.3.0
-- [ ] I am using Node.js 21 or later
+- [ ] I am using Node.js with a version that satisfies `^18.17.0 || ^20.3.0 || >=21.0.0`
+- [ ] I am using Deno
+- [ ] I am using Bun
 
-If you cannot confirm any of these, please upgrade to the latest version and try again before opening an issue.
+If you cannot confirm any of these,
+please upgrade to the latest version
+and try again before opening an issue.
 
-### Are you using a supported package manager?
+### Are you using a supported package manager and installing optional dependencies?
 
 <!-- Please place an [x] in the relevant box to confirm. -->
 
-- [ ] I am using npm >= 9.6.5
-- [ ] I am using yarn >= 3.2.0
-- [ ] I am using pnpm >= 7.1.0
+- [ ] I am using npm >= 9.6.5 with `--include=optional`
+- [ ] I am using yarn >= 3.2.0 and I am not using the "Plug'n'Play" linker
+- [ ] I am using pnpm >= 7.1.0 with `--no-optional=false`
+- [ ] I am using Deno
+- [ ] I am using Bun
 
-If you cannot confirm any of these, please upgrade to the latest version and try again before opening an issue.
+If you cannot confirm any of these,
+please upgrade to the latest version of your chosen package manager
+and ensure you are allowing the installation of optional dependencies
+before opening an issue.
 
 ### What is the complete output of running `npm install --verbose --foreground-scripts sharp` in an empty directory?
 

.github/workflows/npm.yml

@@ -139,6 +139,17 @@ jobs:
           yarn install
           node release.mjs
 
+      - name: Run with Node.js + yarn pnp
+        if: ${{ matrix.runtime == 'node' && matrix.package-manager == 'yarn' }}
+        run: |
+          corepack enable
+          yarn set version stable
+          yarn config set enableImmutableInstalls false
+          yarn config set enableScripts false
+          yarn config set nodeLinker pnp
+          yarn install
+          node release.mjs
+
       - name: Run with Deno
         if: ${{ matrix.runtime == 'deno' }}
         run: deno run --allow-read --allow-ffi release.mjs

docs/changelog.md

@@ -4,6 +4,11 @@
 
 Requires libvips v8.15.0
 
+### v0.33.1 - TBD
+
+* Add support for Yarn Plug'n'Play filesystem layout.
+  [#3888](https://github.com/lovell/sharp/issues/3888)
+
 ### v0.33.0 - 29th November 2023
 
 * Drop support for Node.js 14 and 16, now requires Node.js >= 18.17.0

docs/install.md

@@ -2,6 +2,8 @@
 
 Works with your choice of JavaScript package manager.
 
+> ⚠️  **Please ensure your package manager is configured to install optional dependencies**
+
 ```sh
 npm install sharp
 ```
@@ -11,7 +13,12 @@ pnpm add sharp
 ```
 
 ```sh
-yarn add sharp # v3 recommended, Plug'n'Play unsupported
+yarn add sharp
+```
+
+```sh
+# yarn v1 (maintenance mode)
+yarn add sharp --ignore-engines
 ```
 
 ```sh

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,

lib/sharp.js

@@ -46,41 +46,64 @@ 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',
+      '  or',
+      '    yarn add sharp --ignore-engines',
+      '- Add platform-specific dependencies:',
+      `    npm install --os=${os} --cpu=${cpu} sharp`,
+      '  or',
+      `    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',
+      '  or',
+      '    npm install --force @img/sharp-wasm32'
+    );
   }
   if (isLinux && /symbol not found/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:',
+    '    https://sharp.pixelplumbing.com/install'
+  );
   throw new Error(help.join('\n'));
 }

npm/darwin-arm64/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-darwin-arm64",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with macOS 64-bit ARM",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/darwin-x64/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-darwin-x64",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with macOS x64",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/linux-arm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-linux-arm",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Linux (glibc) ARM (32-bit)",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/linux-arm64/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-linux-arm64",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Linux (glibc) 64-bit ARM",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/linux-s390x/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-linux-s390x",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Linux (glibc) s390x",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/linux-x64/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-linux-x64",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Linux (glibc) x64",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/linuxmusl-arm64/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-linuxmusl-arm64",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Linux (musl) 64-bit ARM",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/linuxmusl-x64/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-linuxmusl-x64",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Linux (musl) x64",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "private": "true",
   "workspaces": [
     "darwin-arm64",

npm/wasm32/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-wasm32",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with wasm32",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/win32-ia32/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-win32-ia32",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Windows x86 (32-bit)",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

npm/win32-x64/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@img/sharp-win32-x64",
-  "version": "0.33.0",
+  "version": "0.33.1-rc.0",
   "description": "Prebuilt sharp for use with Windows x64",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",

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.0",
   "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.0",
+    "@img/sharp-darwin-x64": "0.33.1-rc.0",
     "@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.0",
+    "@img/sharp-linux-arm64": "0.33.1-rc.0",
+    "@img/sharp-linux-s390x": "0.33.1-rc.0",
+    "@img/sharp-linux-x64": "0.33.1-rc.0",
+    "@img/sharp-linuxmusl-arm64": "0.33.1-rc.0",
+    "@img/sharp-linuxmusl-x64": "0.33.1-rc.0",
+    "@img/sharp-wasm32": "0.33.1-rc.0",
+    "@img/sharp-win32-ia32": "0.33.1-rc.0",
+    "@img/sharp-win32-x64": "0.33.1-rc.0"
   },
   "devDependencies": {
     "@emnapi/runtime": "^0.44.0",

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\''
               ]
             }
           }],

test/unit/libvips.js

@@ -144,4 +144,26 @@ describe('libvips binaries', function () {
       libvips.log(new Error('problem'));
     });
   });
+
+  describe('yarn locator hash', () => {
+    it('known platform', () => {
+      const cc = process.env.CC;
+      delete process.env.CC;
+      process.env.npm_config_platform = 'linux';
+      process.env.npm_config_arch = 's390x';
+      process.env.npm_config_libc = '';
+      const locatorHash = libvips.yarnLocator();
+      assert.strictEqual(locatorHash, '86cc8ee6e4');
+      delete process.env.npm_config_platform;
+      delete process.env.npm_config_arch;
+      delete process.env.npm_config_libc;
+      process.env.CC = cc;
+    });
+    it('unknown platform', () => {
+      process.env.npm_config_platform = 'unknown-platform';
+      const locatorHash = libvips.yarnLocator();
+      assert.strictEqual(locatorHash, '');
+      delete process.env.npm_config_platform;
+    });
+  });
 });