npm intall not working

[ArtichautDev]

Issue or Feature

• [ yes] If this is an issue with installation, I have read the troubleshooting guide.
  I can't install canvas on my Mac, I have this error:
  artichaut@Pierres-MacBook-Air-3820 SpotiPixel % sudo npm i canvas
  npm ERR! code 1
  npm ERR! path /Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas
  npm ERR! command failed
  npm ERR! command sh -c node-pre-gyp install --fallback-to-build --update-binary
  npm ERR! Failed to execute '/usr/local/bin/node /usr/local/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js configure --fallback-to-build --update-binary --module=/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas/build/Release/canvas.node --module_name=canvas --module_path=/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas/build/Release --napi_version=9 --node_abi_napi=napi --napi_build_version=0 --node_napi_label=node-v108' (1)
  npm ERR! node-pre-gyp info it worked if it ends with ok
  npm ERR! node-pre-gyp info using [email protected]
  npm ERR! node-pre-gyp info using [email protected] | darwin | arm64
  npm ERR! node-pre-gyp http GET https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v108-darwin-unknown-arm64.tar.gz
  npm ERR! node-pre-gyp ERR! install response status 404 Not Found on https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v108-darwin-unknown-arm64.tar.gz
  npm ERR! node-pre-gyp WARN Pre-built binaries not installable for [email protected] and [email protected] (node-v108 ABI, unknown) (falling back to source compile with node-gyp)
  npm ERR! node-pre-gyp WARN Hit error response status 404 Not Found on https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v108-darwin-unknown-arm64.tar.gz
  npm ERR! gyp info it worked if it ends with ok
  npm ERR! gyp info using [email protected]
  npm ERR! gyp info using [email protected] | darwin | arm64
  npm ERR! gyp info ok
  npm ERR! gyp info it worked if it ends with ok
  npm ERR! gyp info using [email protected]
  npm ERR! gyp info using [email protected] | darwin | arm64
  npm ERR! gyp info find Python using Python version 3.12.2 found at "/usr/local/opt/[email protected]/bin/python3.12"
  npm ERR! gyp info spawn /usr/local/opt/[email protected]/bin/python3.12
  npm ERR! gyp info spawn args [
  npm ERR! gyp info spawn args '/usr/local/lib/node_modules/npm/node_modules/node-gyp/gyp/gyp_main.py',
  npm ERR! gyp info spawn args 'binding.gyp',
  npm ERR! gyp info spawn args '-f',
  npm ERR! gyp info spawn args 'make',
  npm ERR! gyp info spawn args '-I',
  npm ERR! gyp info spawn args '/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas/build/config.gypi',
  npm ERR! gyp info spawn args '-I',
  npm ERR! gyp info spawn args '/usr/local/lib/node_modules/npm/node_modules/node-gyp/addon.gypi',
  npm ERR! gyp info spawn args '-I',
  npm ERR! gyp info spawn args '/Users/artichaut/Library/Caches/node-gyp/18.18.0/include/node/common.gypi',
  npm ERR! gyp info spawn args '-Dlibrary=shared_library',
  npm ERR! gyp info spawn args '-Dvisibility=default',
  npm ERR! gyp info spawn args '-Dnode_root_dir=/Users/artichaut/Library/Caches/node-gyp/18.18.0',
  npm ERR! gyp info spawn args '-Dnode_gyp_dir=/usr/local/lib/node_modules/npm/node_modules/node-gyp',
  npm ERR! gyp info spawn args '-Dnode_lib_file=/Users/artichaut/Library/Caches/node-gyp/18.18.0/<(target_arch)/node.lib',
  npm ERR! gyp info spawn args '-Dmodule_root_dir=/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas',
  npm ERR! gyp info spawn args '-Dnode_engine=v8',
  npm ERR! gyp info spawn args '--depth=.',
  npm ERR! gyp info spawn args '--no-parallel',
  npm ERR! gyp info spawn args '--generator-output',
  npm ERR! gyp info spawn args 'build',
  npm ERR! gyp info spawn args '-Goutput_dir=.'
  npm ERR! gyp info spawn args ]
  npm ERR! Traceback (most recent call last):
  npm ERR! File "/usr/local/lib/node_modules/npm/node_modules/node-gyp/gyp/gyp_main.py", line 42, in
  npm ERR! import gyp # noqa: E402
  npm ERR! ^^^^^^^^^^
  npm ERR! File "/usr/local/lib/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/init.py", line 9, in
  npm ERR! import gyp.input
  npm ERR! File "/usr/local/lib/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/input.py", line 19, in
  npm ERR! from distutils.version import StrictVersion
  npm ERR! ModuleNotFoundError: No module named 'distutils'
  npm ERR! gyp ERR! configure error
  npm ERR! gyp ERR! stack Error: gyp failed with exit code: 1
  npm ERR! gyp ERR! stack at ChildProcess.onCpExit (/usr/local/lib/node_modules/npm/node_modules/node-gyp/lib/configure.js:325:16)
  npm ERR! gyp ERR! stack at ChildProcess.emit (node:events:517:28)
  npm ERR! gyp ERR! stack at ChildProcess._handle.onexit (node:internal/child_process:292:12)
  npm ERR! gyp ERR! System Darwin 23.2.0
  npm ERR! gyp ERR! command "/usr/local/bin/node" "/usr/local/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "configure" "--fallback-to-build" "--update-binary" "--module=/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas/build/Release/canvas.node" "--module_name=canvas" "--module_path=/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas/build/Release" "--napi_version=9" "--node_abi_napi=napi" "--napi_build_version=0" "--node_napi_label=node-v108"
  npm ERR! gyp ERR! cwd /Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas
  npm ERR! gyp ERR! node -v v18.18.0
  npm ERR! gyp ERR! node-gyp -v v9.4.0
  npm ERR! gyp ERR! not ok
  npm ERR! node-pre-gyp ERR! build error
  npm ERR! node-pre-gyp ERR! stack Error: Failed to execute '/usr/local/bin/node /usr/local/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js configure --fallback-to-build --update-binary --module=/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas/build/Release/canvas.node --module_name=canvas --module_path=/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas/build/Release --napi_version=9 --node_abi_napi=napi --napi_build_version=0 --node_napi_label=node-v108' (1)
  npm ERR! node-pre-gyp ERR! stack at ChildProcess. (/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/@mapbox/node-pre-gyp/lib/util/compile.js:89:23)
  npm ERR! node-pre-gyp ERR! stack at ChildProcess.emit (node:events:517:28)
  npm ERR! node-pre-gyp ERR! stack at maybeClose (node:internal/child_process:1098:16)
  npm ERR! node-pre-gyp ERR! stack at ChildProcess._handle.onexit (node:internal/child_process:303:5)
  npm ERR! node-pre-gyp ERR! System Darwin 23.2.0
  npm ERR! node-pre-gyp ERR! command "/usr/local/bin/node" "/Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/.bin/node-pre-gyp" "install" "--fallback-to-build" "--update-binary"
  npm ERR! node-pre-gyp ERR! cwd /Users/artichaut/Documents/GitHub/SpotiPixel/node_modules/canvas
  npm ERR! node-pre-gyp ERR! node -v v18.18.0
  npm ERR! node-pre-gyp ERR! node-pre-gyp -v v1.0.11
  npm ERR! node-pre-gyp ERR! not ok

npm ERR! A complete log of this run can be found in: /Users/artichaut/.npm/_logs/2024-03-31T19_47_54_510Z-debug-0.log

(already tried this https://github.com/Automattic/node-canvas/wiki/Installation%3A-Mac-OS-X)
and this https://stackoverflow.com/questions/71352368/is-it-possible-to-install-canvas-with-m1-chip )

Steps to Reproduce

npm I canvas

Your Environment

• Version of node-canvas (output of npm list canvas or yarn list canvas): none
• Environment (e.g. node 20.9.0 on macOS 14.1.1):
  node v18.18.0 on Mac OS Sonoma 14.2.1 m2 MacBook Air

[nnmbzr]

You have error in log:

ModuleNotFoundError: No module named 'distutils'

Try install setuptools

brew install python-setuptools

[ArtichautDev]

yes thank you its working, but now I have this error:
node:internal/modules/cjs/loader:1340
return process.dlopen(module, path.toNamespacedPath(filename));
^

Error: dlopen(/Users/artichaut/Documents/GitHub/2/SpotiPixel/node_modules/canvas/build/Release/canvas.node, 0x0001): symbol not found in flat namespace '_cairo_fill'

I already tried brew install cairo

[nnmbzr]

Okay, maybe you need to install all of this?

brew install pkg-config cairo pango libpng jpeg giflib librsvg

[Hamfri]

If you are on a recent version of Mac OS the default python version is 3.x.x. For unknown reasons canvas could not be compiled if python version was 3.x.x. Run the following commands:-

1. $ brew install pkg-config cairo pango libpng jpeg giflib librsvg

2. $ brew install pyenv

3. $ pyenv install 2.7.18

4. $ brew install python-setuptools

5. Set the following environment variables in your .zshrc or .bashrc depending on your default shell.

   export PATH=$(pyenv root)/shims:$PATH
   export PATH="$(pyenv root)/versions/2.7.18/bin:$PATH"
   

6. $ source ~/.zshrc or ~/.bashrc depending on your default shell.

7. $ npm config set python python2.7

8. $ if on an existing project run $ rm -rf node_module && npm i.

9. For fresh installs run $ npm i canvas

Note: I used this solution on MacBook pro M1 macOS Sonoma 14.4.1

[cmahnke]

Just in case anyone else has this problem on a recent Mac OS: There has been an (brew) update for pango (I guess).
You should also observe Package glib-2.0 was not found in the pkg-config search path. during building.

First, check if pkgconfig find the required dependencies: pkg-config pangocairo --libs
Make sure you get the following result:

-L/opt/homebrew/Cellar/pango/1.52.2/lib -L/opt/homebrew/Cellar/glib/2.80.0_2/lib -L/opt/homebrew/opt/gettext/lib -L/opt/homebrew/Cellar/harfbuzz/8.4.0/lib -L/opt/homebrew/Cellar/cairo/1.18.0/lib -lpangocairo-1.0 -lpango-1.0 -lgobject-2.0 -lglib-2.0 -lintl -lharfbuzz -lcairo

This is an error:

Package gobject-2.0 was not found in the pkg-config search path.
Perhaps you should add the directory containing `gobject-2.0.pc'
to the PKG_CONFIG_PATH environment variable
Package 'gobject-2.0', required by 'pango', not found

If you get an error reinstall glib using brew: brew reinstall glib

[nnmbzr]

If you are on a recent version of Mac OS the default python version is 3.x.x. For unknown reasons canvas could not be compiled if python version was 3.x.x.

In my case, it compiled* on python 3.12.2

* after many painful hours

[cmahnke]

Yes, I forgot to mention it: Python 3.1X is expected to work

[TrevorSayre]

This is my current process for a failed install on Apple Silicon:

brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman [email protected]

rm -rf node_modules

npm install

If you don't have the brew command from homebrew: https://brew.sh

[danidaryaweesh]

Thanks @TrevorSayre saved my day, your suggestion worked!

[zbjornson]

I updated the readme to list python-setuputils as a prereq on macOS. Thanks for the collective troubleshooting!