NodeJs: Build fails for project with canvas library

[ArunJRK]

Hello Team! Thanks for this amazing tool. I have a problem when I am trying to build nodejs project with canvas library in nixpacks. It was working on railway a few days back. Now there is a python not found error. I have added the canvas package in package.json as per the documentation. Here is the error below:

49.21 gyp ERR! find Python 
49.21 gyp ERR! find Python **********************************************************
49.21 gyp ERR! find Python You need to install the latest version of Python.
49.21 gyp ERR! find Python Node-gyp should be able to find and use Python. If not,
49.21 gyp ERR! find Python you can try one of the following options:
49.21 gyp ERR! find Python - Use the switch --python="/path/to/pythonexecutable"
49.21 gyp ERR! find Python   (accepted by both node-gyp and npm)
49.21 gyp ERR! find Python - Set the environment variable PYTHON
49.21 gyp ERR! find Python - Set the npm configuration variable python:
49.21 gyp ERR! find Python   npm config set python "/path/to/pythonexecutable"
49.21 gyp ERR! find Python For more information consult the documentation at:
49.21 gyp ERR! find Python https://github.com/nodejs/node-gyp#installation
49.21 gyp ERR! find Python **********************************************************
49.21 gyp ERR! find Python 
49.21 gyp ERR! configure error 
49.21 gyp ERR! stack Error: Could not find any Python installation to use

Full Error

65.26 [5/5] Building fresh packages...
66.53 error /app/node_modules/canvas: Command failed.
66.53 Exit code: 1
66.53 Command: node-pre-gyp install --fallback-to-build --update-binary
66.53 Arguments: 
66.53 Directory: /app/node_modules/canvas
66.53 Output:
66.53 node-pre-gyp info it worked if it ends with ok
66.53 node-pre-gyp info using [email protected]
66.53 node-pre-gyp info using [email protected] | linux | arm64
66.53 node-pre-gyp http GET https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v115-linux-glibc-arm64.tar.gz
66.53 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-v115-linux-glibc-arm64.tar.gz 
66.53 node-pre-gyp WARN Pre-built binaries not installable for [email protected] and [email protected] (node-v115 ABI, glibc) (falling back to source compile with node-gyp) 
66.53 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-v115-linux-glibc-arm64.tar.gz 
66.53 gyp info it worked if it ends with ok
66.53 gyp info using [email protected]
66.53 gyp info using [email protected] | linux | arm64
66.53 gyp info ok 
66.53 gyp info it worked if it ends with ok
66.53 gyp info using [email protected]
66.53 gyp info using [email protected] | linux | arm64
66.53 gyp ERR! find Python 
66.53 gyp ERR! find Python Python is not set from command line or npm configuration
66.53 gyp ERR! find Python Python is not set from environment variable PYTHON
66.53 gyp ERR! find Python checking if "python3" can be used
66.53 gyp ERR! find Python - "python3" is not in PATH or produced an error
66.53 gyp ERR! find Python checking if "python" can be used
66.53 gyp ERR! find Python - "python" is not in PATH or produced an error
66.53 gyp ERR! find Python 
66.53 gyp ERR! find Python **********************************************************
66.53 gyp ERR! find Python You need to install the latest version of Python.
66.53 gyp ERR! find Python Node-gyp should be able to find and use Python. If not,
66.53 gyp ERR! find Python you can try one of the following options:
66.53 gyp ERR! find Python - Use the switch --python="/path/to/pythonexecutable"
66.53 gyp ERR! find Python   (accepted by both node-gyp and npm)
66.53 gyp ERR! find Python - Set the environment variable PYTHON
66.53 gyp ERR! find Python - Set the npm configuration variable python:
66.53 gyp ERR! find Python   npm config set python "/path/to/pythonexecutable"
66.53 gyp ERR! find Python For more information consult the documentation at:
66.53 gyp ERR! find Python https://github.com/nodejs/node-gyp#installation
66.53 gyp ERR! find Python **********************************************************
66.53 gyp ERR! find Python 
66.53 gyp ERR! configure error 
66.53 gyp ERR! stack Error: Could not find any Python installation to use
66.53 gyp ERR! stack     at PythonFinder.fail (/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/lib/node_modules/npm/node_modules/node-gyp/lib/find-python.js:330:47)
66.53 gyp ERR! stack     at PythonFinder.runChecks (/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/lib/node_modules/npm/node_modules/node-gyp/lib/find-python.js:159:21)
66.53 gyp ERR! stack     at PythonFinder.<anonymous> (/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/lib/node_modules/npm/node_modules/node-gyp/lib/find-python.js:202:16)
66.53 gyp ERR! stack     at PythonFinder.execFileCallback (/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/lib/node_modules/npm/node_modules/node-gyp/lib/find-python.js:294:16)
66.53 gyp ERR! stack     at exithandler (node:child_process:430:5)
66.53 gyp ERR! stack     at ChildProcess.errorhandler (node:child_process:442:5)
66.53 gyp ERR! stack     at ChildProcess.emit (node:events:514:28)
66.53 gyp ERR! stack     at ChildProcess._handle.onexit (node:internal/child_process:292:12)
66.53 gyp ERR! stack     at onErrorNT (node:internal/child_process:484:16)
66.53 gyp ERR! stack     at process.processTicksAndRejections (node:internal/process/task_queues:82:21)
66.53 gyp ERR! System Linux 6.3.13-linuxkit
66.53 gyp ERR! command "/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/bin/node" "/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "configure" "--fallback-to-build" "--update-binary" "--module=/app/node_modules/canvas/build/Release/canvas.node" "--module_name=canvas" "--module_path=/app/node_modules/canvas/build/Release" "--napi_version=9" "--node_abi_napi=napi" "--napi_build_version=0" "--node_napi_label=node-v115"
66.53 gyp ERR! cwd /app/node_modules/canvas
66.53 gyp ERR! node -v v20.6.1
66.53 gyp ERR! node-gyp -v v9.4.0
66.53 gyp ERR! not ok 
66.53 node-pre-gyp ERR! build error 
66.53 node-pre-gyp ERR! stack Error: Failed to execute '/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/bin/node /nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js configure --fallback-to-build --update-binary --module=/app/node_modules/canvas/build/Release/canvas.node --module_name=canvas --module_path=/app/node_modules/canvas/build/Release --napi_version=9 --node_abi_napi=napi --napi_build_version=0 --node_napi_label=node-v115' (1)
66.53 node-pre-gyp ERR! stack     at ChildProcess.<anonymous> (/app/node_modules/@mapbox/node-pre-gyp/lib/util/compile.js:89:23)
66.53 node-pre-gyp ERR! stack     at ChildProcess.emit (node:events:514:28)
66.53 node-pre-gyp ERR! stack     at maybeClose (node:internal/child_process:1105:16)
66.53 node-pre-gyp ERR! stack     at ChildProcess._handle.onexit (node:internal/child_process:305:5)
66.53 node-pre-gyp ERR! System Linux 6.3.13-linuxkit
66.53 node-pre-gyp ERR! command "/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/bin/node" "/app/node_modules/canvas/node_modules/.bin/node-pre-gyp" "install" "--fallback-to-build" "--update-binary"
66.53 node-pre-gyp ERR! cwd /app/node_modules/canvas
66.53 node-pre-gyp ERR! node -v v20.6.1
66.53 node-pre-gyp ERR! node-pre-gyp -v v1.0.11
66.53 node-pre-gyp ERR! not ok 
66.53 Failed to execute '/nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/bin/node /nix/store/n49p920r37bpk6cjslvs53nfvdax6s2h-nodejs-20.6.1/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js configure --fallback-to-build --update-binary --module=/app/node_modules/canvas/build/Release/canvas.node --module_name=canvas --module_path=/app/node_modules/canvas/build/Release --napi_version=9 --node_abi_napi=napi --napi_build_version=0 --node_napi_label=node-v115' (1)
66.53 info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
------
Dockerfile:20
--------------------
  18 |     ENV NIXPACKS_PATH /app/node_modules/.bin:$NIXPACKS_PATH
  19 |     COPY . /app/.
  20 | >>> RUN --mount=type=cache,id=t7p1EEhkg9E-/usr/local/share/cache/yarn/v6,target=/usr/local/share/.cache/yarn/v6 yarn install --frozen-lockfile
  21 |     
  22 |     # build phase
--------------------
ERROR: failed to solve: process "/bin/bash -ol pipefail -c yarn install --frozen-lockfile" did not complete successfully: exit code: 1 

[coffee-cup]

Thanks for the bug report. We recently updated the Nix archive version that is used (the previous one was 8 months old). But that has brought with it a myriad of node-gyp issues :/ You can revert to version 1.15 to go back to the old archive version where it should work.

I am planning on looking into these issues next week. If anyone wants to help fix this, that would also be greatly appreciated 😅

[ArunJRK]

Thanks I will try it

[ArunJRK]

Is there a way to put that up in nixpacks.toml in railway?