build fails for canvas@2.11.2 with nodejs@v23 on Linux

[sahal]

Operating system

Linux

Joplin version

3.1.24

Desktop version info

No response

Current behaviour

This is related to Automattic/node-canvas#2448

I used this Dockerfile:

Based on node:lts-slim: Dockerhub Build Dockerfile

Node version: 20.11.0

FROM node:lts-slim AS build

ARG JOPLIN_VERSION=3.1.24

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 \
    wget \
    && rm -rf /var/lib/apt/lists/*

COPY install.sh /home/node/
RUN /home/node/install.sh "${JOPLIN_VERSION}"

With the following install script:

#!/usr/bin/env bash

set -o errexit
set -o nounset

JOPLIN_VERSION="${1:-3.1.24}"

wget --no-check-certificate "https://github.com/laurent22/joplin/archive/refs/tags/v${JOPLIN_VERSION}.tar.gz" -O joplin.tar.gz

mkdir -p joplin
tar xvvf joplin.tar.gz -C joplin

pushd joplin

JOPLIN_VER_DIR=$(find . -maxdepth 1 -type d -name "joplin*")
pushd "${JOPLIN_VER_DIR}"

yarn_bin="$(find .yarn/releases -type f -name "*.cjs")"
"${yarn_bin}" install --inline-builds

Based on your build for the latest release, you're using Node v18.15.0. Will add a comment when after I rerun the build with a lower version. AFAIK, there are currently no upper limits in your package.json for node versions, however.

Expected behaviour

Joplin build doesn't fail.

Logs

joplin-build-log-2024-11-15.txt

[sahal]

OK, I did some more testing and it looks like this is consistently failing only on node 23 right now. At least in docker/podman.

This is my methodology for testing: https://gist.github.com/sahal/ec57d2e63764e7b125fca54267977bdc

build-log-joplin-18.txt
build-log-joplin-19.txt
build-log-joplin-20.txt
build-log-joplin-21.txt
build-log-joplin-22.txt
build-log-joplin-23-0.txt
build-log-joplin-23-1.txt
build-log-joplin-23-2.txt

Canvas seems to build successfully on its own when using yarn add on all versions 18-23:
Automattic/node-canvas#2448 (comment)

Looking at the failed node 23 builds, it looks like this might be related to nodejs/nan#979 rather than the canvas issue linked above. When I isolate the canvas build, it will work every time in node 18-23.

[github-actions]

Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? If you require support or are requesting an enhancement or feature then please create a topic on the Joplin forum. This issue may be closed if no further activity occurs. You may comment on the issue and I will leave it open. Thank you for your contributions.

[sahal]

Hey,
this is definitely still a problem.

I reproduced it using your own github actions on my forked version of your dev repo:

• https://github.com/sahal/joplin/actions/runs/12424525544/job/34689818374

The diffs only show updates to the node version:

• dev...sahal:joplin:dev

If the build isn't going to be tested on multiple node versions, can you put an upper limit on the node version specified in the package.json?

I'm not sure what else to say.

[sahal]

Canvas maintainers released v3.0.0 which removes dependency on nan. 🤞🏾 This will now build on node23.

• https://github.com/Automattic/node-canvas/releases/tag/v3.0.0

[github-actions]

Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? If you require support or are requesting an enhancement or feature then please create a topic on the Joplin forum. This issue may be closed if no further activity occurs. You may comment on the issue and I will leave it open. Thank you for your contributions.

[sahal]

Yes, this build is still failing on

• node 22.13.1: https://github.com/sahal/joplin/actions/runs/12933699523/job/36072932821
• node 23.6.1: https://github.com/sahal/joplin/actions/runs/12933941495

Again, still due to canvas build issues that were resolved by them removing nan from their packages. It looks like joplin still requires an older version of canvas though.

• Build Error: Incompatibility of canvas@2.11.2 with Node.js v22.11.0 Automattic/node-canvas#2448 (comment)
• https://github.com/sahal/joplin/actions/runs/12933735690

In terms of upstream changes that Joplin can take advantage of now, the lib package could be upgraded to 3.1.0 (or any version greater than 3.0.0).

Tried upgrading canvas here:

• dev...sahal:joplin:refs/heads/dev-23-upgrade-canvas

Troubleshooting now.

[github-actions]

Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? If you require support or are requesting an enhancement or feature then please create a topic on the Joplin forum. This issue may be closed if no further activity occurs. You may comment on the issue and I will leave it open. Thank you for your contributions.