Build Error: Incompatibility of `canvas@2.11.2` with Node.js v22.11.0

[bahram-della-ai]

Description:

Hi there,

I'm experiencing build failures when trying to install canvas@2.11.2 using Node.js v22.11.0. It appears there might be compatibility issues between this version of Node.js and the canvas module.

Environment:

• Node.js Version: v22.11.0
• Canvas Version: 2.11.2
• Platform: Linux (Docker base image node:lts-slim as of October 2024)
• Dependency Manager: npm

Steps to Reproduce:

1. Dockerfile Setup:

   FROM node:lts-slim AS build
   RUN apt-get update && apt-get install -y --no-install-recommends \
       make \
       g++ \
       dumb-init \
       build-essential \
       libcairo2-dev \
       libpango1.0-dev \
       libjpeg-dev \
       libgif-dev \
       librsvg2-dev \
       python3 \
       && rm -rf /var/lib/apt/lists/*
   
   WORKDIR /usr
   COPY package*.json tsconfig.json ./
   RUN npm ci

2. Install Dependencies:

   • Run npm ci to install all dependencies, including canvas@2.11.2.

3. Observe the Build Failure:

   • The installation fails during the build process of canvas.

Error Log Highlights:

npm ERR! code 1
npm ERR! path /usr/node_modules/canvas
npm ERR! command failed
npm ERR! command sh -c node-pre-gyp install --fallback-to-build --update-binary
npm ERR! make: Entering directory '/usr/node_modules/canvas/build'
npm ERR!   SOLINK_MODULE(target) Release/obj.target/canvas-postbuild.node
npm ERR!   COPY Release/canvas-postbuild.node
npm ERR!   CXX(target) Release/obj.target/canvas/src/backend/Backend.o
npm ERR! In file included from ../src/backend/Backend.h:6,
npm ERR!                  from ../src/backend/Backend.cc:1:
npm ERR! ../../nan/nan.h: In function 'void Nan::SetAccessor(...)':
npm ERR! ../../nan/nan.h:2546:19: error: no matching function for call to 'v8::ObjectTemplate::SetAccessor(...)'
npm ERR! ...
npm ERR! gyp ERR! build error
npm ERR! gyp ERR! stack Error: `make` failed with exit code: 2
npm ERR! gyp ERR! node -v v22.11.0

Additional Information:

• Downgrading to Node.js v20.x resolves the issue; canvas installs without errors.

Questions:

1. Compatibility Confirmation:

   • Is canvas@2.11.2 compatible with Node.js v22.11?
   • If not, are there plans to support Node.js v22.x in an upcoming release?

2. Workarounds:

   • Are there any recommended steps or patches to make canvas work with Node.js v22.x?

3. Dependency Updates:

   • Should we expect updates to dependencies like nan to address this compatibility issue?

Thank You:

Thank you for your time and assistance. Any guidance or updates on this matter would be greatly appreciated.

[gareth-johnstone]

This is also an issue for us, rolling back to version 20 FROM node:20-slim "fixes" the problem But not ideal.

[bahram-della-ai]

This is also an issue for us, rolling back to version 20 FROM node:20-slim "fixes" the problem But not ideal.

We did not find a better solution either

[daimalou]

same

[usselman]

Having the same issue.

[cmahnke]

Binaries aren't found either:

node-pre-gyp http GET https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v127-linux-glibc-x64.tar.gz
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-v127-linux-glibc-x64.tar.gz 
node-pre-gyp WARN Pre-built binaries not installable for canvas@2.11.2 and node@22.11.0 (node-v127 ABI, glibc) (falling back to source compile with node-gyp) 

This happens on GitHub Actions, since I use actions/setup-node@v4.1.0 with a version of lts/*, maybe the latest LTS has been changed?

[alvis]

My workaround is to upgrade canvas to v3 RC, which removes some deprecated dependencies. However, note that it requires node-gyp version 10 for compilation. The version bundled with Node is often only version 9.

[daimalou]

It often happens that node-gyp fails with errors. It would be great if someone could rewrite it using napi-rs.

[cmahnke]

@daimalou Have a look at https://github.com/Brooooooklyn/canvas

[usselman]

For anyone coming to this in the future, I was able to migrate my canvas application very easily to https://github.com/samizdatco/skia-canvas

I also tried the above napi-rs/canvas but the Rust typing wasn't playing nice with my app, so the package I linked worked better for my use.

Hope this is fixed soon.

[cmahnke]

Since no one mentioned it, but this is actually a problem known for some time:

• 404 Not Found on canvas-v2.11.2-node-v127-win32-unknown-x64.tar.gz #2430

Similar:

• Error : NODE_MODULE_VERSION 102  #2429

Let's face it, given there also is #2433 and the lastest release is one and a half years old it's safe to assume, that this package is't supported anymore. There isn't even a janitor for the issue tracker and the branch for the next version isn't active either.
Time (for downstream projects) to move on...

See ABI versions for the current LTS release here:
https://github.com/electron/node-abi/blob/main/abi_registry.json