Skip to content
Snippets Groups Projects

FreeBSD builds broken due to canvas not supporting platform

    • Closed Issue created by dos kel @doskel

    What happened?

    pnpm start fails after INFO * [db sql] SELECT version(); with a MODULE_NOT_FOUND error for @napi-rs/canvas-freebsd-x64.

    What did you expect to happen?

    pnpm start succeeds and instance starts.

    Version

    git develop

    Instance

    n/a

    What type of issue is this?

    Backend

    How do you deploy Sharkey on your server? (Server-side issues only)

    Bare metal.

    What operating system are you using? (Server-side issues only)

    FreeBSD

    Relevant log output 

    [sharkey@moriarty ~/Sharkey]$ pnpm start

> sharkey@2024.11.2 start /opt/sharkey/Sharkey
> pnpm check:connect && cd packages/backend && MK_WARNED_ABOUT_CONFIG=true node ./built/boot/entry.js


> sharkey@2024.11.2 check:connect /opt/sharkey/Sharkey
> cd packages/backend && pnpm check:connect


> backend@ check:connect /opt/sharkey/Sharkey/packages/backend
> node ./scripts/check_connect.js

INFO *	[db sql]	SELECT * FROM current_schema()
INFO *	[db sql]	info
INFO *	[db sql]	SELECT version();
node:internal/modules/cjs/loader:1225
  const err = new Error(message);
              ^

Error: Cannot find module '@napi-rs/canvas-freebsd-x64'
Require stack:
- /opt/sharkey/Sharkey/node_modules/.pnpm/@napi-rs+canvas@0.1.56/node_modules/@napi-rs/canvas/js-binding.js
- /opt/sharkey/Sharkey/node_modules/.pnpm/@napi-rs+canvas@0.1.56/node_modules/@napi-rs/canvas/index.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1225:15)
    at Module._load (node:internal/modules/cjs/loader:1051:27)
    at Module.require (node:internal/modules/cjs/loader:1311:19)
    at require (node:internal/modules/helpers:179:18)
    at Object.<anonymous> (/opt/sharkey/Sharkey/node_modules/.pnpm/@napi-rs+canvas@0.1.56/node_modules/@napi-rs/canvas/js-binding.js:136:25)
    at Module._compile (node:internal/modules/cjs/loader:1469:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1548:10)
    at Module.load (node:internal/modules/cjs/loader:1288:32)
    at Module._load (node:internal/modules/cjs/loader:1104:12)
    at Module.require (node:internal/modules/cjs/loader:1311:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/opt/sharkey/Sharkey/node_modules/.pnpm/@napi-rs+canvas@0.1.56/node_modules/@napi-rs/canvas/js-binding.js',
    '/opt/sharkey/Sharkey/node_modules/.pnpm/@napi-rs+canvas@0.1.56/node_modules/@napi-rs/canvas/index.js'
  ]
}

Node.js v20.18.1
 ELIFECYCLE  Command failed with exit code 1.

    Contribution Guidelines

    By submitting this issue, you agree to follow our Contribution Guidelines

    • I agree to follow this project's Contribution Guidelines
    • I have searched the issue tracker for similar issues, and this is not a duplicate.
    ✓ 2 of 2 checklist items completed · Edited

    Designs

      Child items 0

      2. No child items are currently assigned. Use child items to break down this issue into smaller parts.

      Activity

      • Hazelnoot added bugbackend label

        added bugbackend label

      • dos kel changed the description

        changed the description

      • Marie mentioned in merge request !887 (merged)

        mentioned in merge request !887 (merged)

      • Marie
        Marie @Marie ·
        Developer

        I have opened !887 (merged) to fix this issue as well as another issue on FreeBSD caused by NestJS no functionality has been lost with this MR btw. You can try using that Branch and report back on the MR or here if it works.

        (also make sure that all modules are rebuilt by doing pnpm clean-all and then pnpm i)

        Edited by Marie
      • dos kel
        dos kel @doskel ·
        Author

        New issue: canvas fails to build, seeimgly with libc issues? On pnpm install --prod I get the following:

        node_modules/.pnpm/canvas@3.1.0/node_modules/canvas: Running install script, failed in 54.7s
.../canvas@3.1.0/node_modules/canvas install$ prebuild-install -r napi || node-gyp rebuild
│ prebuild-install warn install No prebuilt binaries found (target=7 runtime=napi arch=x64 libc= platform=freebsd)
│ gyp info it worked if it ends with ok
│ gyp info using node-gyp@10.1.0
│ gyp info using node@22.13.1 | freebsd | x64
│ gyp info find Python using Python version 3.11.11 found at "/usr/local/bin/python3.11"
│ gyp info spawn /usr/local/bin/python3.11
│ gyp info spawn args [
│ gyp info spawn args '/opt/sharkey/.cache/node/corepack/v1/pnpm/9.6.0/dist/node_modules/node-gyp/gyp/gyp_main.py',
│ gyp info spawn args 'binding.gyp',
│ gyp info spawn args '-f',
│ gyp info spawn args 'make',
│ gyp info spawn args '-I',
│ gyp info spawn args '/opt/sharkey/Sharkey/node_modules/.pnpm/canvas@3.1.0/node_modules/canvas/build/config.gypi',
│ gyp info spawn args '-I',
│ gyp info spawn args '/opt/sharkey/.cache/node/corepack/v1/pnpm/9.6.0/dist/node_modules/node-gyp/addon.gypi',
│ gyp info spawn args '-I',
│ gyp info spawn args '/opt/sharkey/.cache/node-gyp/22.13.1/include/node/common.gypi',
│ gyp info spawn args '-Dlibrary=shared_library',
│ gyp info spawn args '-Dvisibility=default',
│ gyp info spawn args '-Dnode_root_dir=/opt/sharkey/.cache/node-gyp/22.13.1',
│ gyp info spawn args '-Dnode_gyp_dir=/opt/sharkey/.cache/node/corepack/v1/pnpm/9.6.0/dist/node_modules/node-gyp',
│ gyp info spawn args '-Dnode_lib_file=/opt/sharkey/.cache/node-gyp/22.13.1/<(target_arch)/node.lib',
│ gyp info spawn args '-Dmodule_root_dir=/opt/sharkey/Sharkey/node_modules/.pnpm/canvas@3.1.0/node_modules/canvas',
│ gyp info spawn args '-Dnode_engine=v8',
│ gyp info spawn args '--depth=.',
│ gyp info spawn args '--no-parallel',
│ gyp info spawn args '--generator-output',
│ gyp info spawn args 'build',
│ gyp info spawn args '-Goutput_dir=.'
│ gyp info spawn args ]
│ gyp info spawn gmake
│ gyp info spawn args [ 'BUILDTYPE=Release', '-C', 'build' ]
│ gmake: Entering directory '/opt/sharkey/Sharkey/node_modules/.pnpm/canvas@3.1.0/node_modules/canvas/build'
│   SOLINK_MODULE(target) Release/obj.target/canvas-postbuild.node
│   COPY Release/canvas-postbuild.node
│   CXX(target) Release/obj.target/canvas/src/backend/Backend.o
│   CXX(target) Release/obj.target/canvas/src/backend/ImageBackend.o
│   CXX(target) Release/obj.target/canvas/src/backend/PdfBackend.o
│   CXX(target) Release/obj.target/canvas/src/backend/SvgBackend.o
│   CXX(target) Release/obj.target/canvas/src/bmp/BMPParser.o
│   CXX(target) Release/obj.target/canvas/src/Backends.o
│   CXX(target) Release/obj.target/canvas/src/Canvas.o
│   CXX(target) Release/obj.target/canvas/src/CanvasGradient.o
│   CXX(target) Release/obj.target/canvas/src/CanvasPattern.o
│   CXX(target) Release/obj.target/canvas/src/CanvasRenderingContext2d.o
│   CXX(target) Release/obj.target/canvas/src/closure.o
│   CXX(target) Release/obj.target/canvas/src/color.o
│   CXX(target) Release/obj.target/canvas/src/Image.o
│ In file included from ../src/Image.cc:28:
│ /usr/include/c++/v1/csetjmp:40:6: error: "If libc++ starts defining <setjmp.h>, the __has_include check should move to libc++'s <setjmp.h>"
│    40 | #    error "If libc++ starts defining <setjmp.h>, the __has_include check should move to libc++'s <setjmp.h>"
│       |      ^
│ 1 error generated.
│ gmake: *** [canvas.target.mk:158: Release/obj.target/canvas/src/Image.o] Error 1
│ gmake: Leaving directory '/opt/sharkey/Sharkey/node_modules/.pnpm/canvas@3.1.0/node_modules/canvas/build'
│ gyp ERR! build error 
│ gyp ERR! stack Error: `gmake` failed with exit code: 2
│ gyp ERR! stack at ChildProcess.<anonymous> (/opt/sharkey/.cache/node/corepack/v1/pnpm/9.6.0/dist/node_modules/node-gyp/lib/build.js:209:23)
│ gyp ERR! System FreeBSD 14.2-RELEASE-p1
│ gyp ERR! command "/usr/local/bin/node" "/opt/sharkey/.cache/node/corepack/v1/pnpm/9.6.0/dist/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
│ gyp ERR! cwd /opt/sharkey/Sharkey/node_modules/.pnpm/canvas@3.1.0/node_modules/canvas
│ gyp ERR! node -v v22.13.1
│ gyp ERR! node-gyp -v v10.1.0
│ gyp ERR! not ok 
└─ Failed in 54.7s at /opt/sharkey/Sharkey/node_modules/.pnpm/canvas@3.1.0/node_modules/canvas
node_modules/.pnpm/cypress@13.15.2/node_modules/cypress: Running postinstall script, failed in 844ms (skipped as optional)
 ELIFECYCLE  Command failed with exit code 1.
      • dos kel
        dos kel @doskel ·
        Author

        Hm. Seems that it requires glibc; I'll have to dig around for how to make that happen on FreeBSD. I don't think that's particularly supported?

        Edited by dos kel
      • dos kel
        dos kel @doskel ·
        Author

        This might well be the killer: I think this demands glibc and making that exist on BSD is... not a good idea, if you could get it to work at all. Perhaps upstream would be willing to add some workarounds, or there's some full alternative to canvas? Not sure. Thanks for the attempts.

      • Marie
        Marie @Marie ·
        Developer

        It works fine for me on FreeBSD/GhostBSD do you have all the dev packages installed on your machine?

      • Marie
        Marie @Marie ·
        Developer

        this is my output with pnpm install --prod

        Scope: all 11 workspace projects
Lockfile is up to date, resolution step is skipped
Packages: +1390
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Downloading @phosphor-icons/web@2.1.1: 12.42 MB/12.42 MB, done
Downloading @swc/core-freebsd-x64@1.3.11: 19.49 MB/19.49 MB, done
Downloading @ruffle-rs/ruffle@0.1.0-nightly.2024.10.15: 10.04 MB/10.04 MB, done
Downloading three@0.169.0: 7.10 MB/7.10 MB, done
Packages are hard linked from the content-addressable store to the virtual store.
  Content-addressable store is at: /home/marie/.local/share/pnpm/store/v3
  Virtual store is at:             node_modules/.pnpm
Progress: resolved 1390, reused 0, downloaded 1387, added 1390, done
Downloading typescript@5.1.6: 7.15 MB/7.15 MB, done
node_modules/.pnpm/bufferutil@4.0.7/node_modules/bufferutil: Running install script...
node_modules/.pnpm/esbuild@0.24.0/node_modules/esbuild: Running postinstall scrinode_modules/.pnpm/esbuild@0.24.0/node_modules/esbuild: Running postinstall script, done in 138msm/sharp@0.33.5/node_modules/sharp: Running install script...
node_modules/.pnpm/cypress@13.15.2/node_modules/cypress: Running postinstall script...
node_modules/.pnpm/utf-8-validate@6.0.3/node_modules/utf-8-validate: Running insnode_modules/.pnpm/bufferutil@4.0.7/node_modules/bufferutil: Running install script, done in 2.4sm/@nestjs+core@10.4.7_@nestjs+common@10.4.7_reflect-metadata@0.2.2_rxjs@7.8.1__@nestjs+platform_dknnhm2i44x3ubitelusxcvlgm/node_modules/@nestjsnode_modules/.pnpm/@nestjs+core@10.4.7_@nestjs+common@10.4.7_reflect-metadata@0.node_modules/.pnpm/cypress@13.15.2/node_modules/cypress: Running postinstall script, failed in 2.7s (skipped as optional)n 899ms
node_modules/.pnpm/@sentry+profiling-node@8.38.0/node_modules/@sentry/profiling-node: Running install script...
node_modules/.pnpm/@swc+core@1.9.2/node_modules/@swc/core: Running postinstall snode_modules/.pnpm/utf-8-validate@6.0.3/node_modules/utf-8-validate: Running install script, done in 3.7sore@1.9.2/node_modules/@swc/core: Running postinstall script, done in 156ms
node_modules/.pnpm/argon2@0.40.1/node_modules/argon2: Running install script, donode_modules/.pnpm/nice-napi@1.0.2/node_modules/nice-napi: Running install script, done in 1.2snpm/msgpackr-extract@3.0.2/node_modules/msgpackr-extract: Runningnode_modules/.pnpm/sharp@0.33.5/node_modules/sharp: Running install script, done in 19.1sscript, done in 1.1s.0/node_modules/canvas: Running install script...
node_modules/.pnpm/re2@1.21.4/node_modules/re2: Running install script...
node_modules/.pnpm/@sentry+profiling-node@8.38.0/node_modules/@sentry/profiling-node: Running install script, done in 2.7sules/esbuild: Running postinstall script, done in 117ms
node_modules/.pnpm/vue-demi@0.14.7_vue@3.5.12_typescript@5.6.3_/node_modules/vuenode_modules/.pnpm/vue-demi@0.14.7_vue@3.5.12_typescript@5.6.3_/node_modules/vue-demi: Running postinstall script, done in 129ms
node_modules/.pnpm/canvas@3.1.0/node_modules/canvas: Running install script, done in 26.5ses/.pnpm/re2@1.21.4/node_modules/re2: Running install script, done in 14.5sdone in 361ms
node_modules/.pnpm/utf-8-validate@6.0.4/node_modules/utf-8-validate: Running insnode_modules/.pnpm/utf-8-validate@6.0.4/node_modules/utf-8-validate: Running install script, done in 1.2s
node_modules/.pnpm/v-code-diff@1.13.1_vue@3.5.12_typescript@5.6.3_/node_modules/node_modules/.pnpm/v-code-diff@1.13.1_vue@3.5.12_typescript@5.6.3_/node_modules/v-code-diff: Running postinstall script, done in 169ms

dependencies:
+ cssnano 6.1.2
+ esbuild 0.24.0
+ execa 8.0.1
+ fast-glob 3.3.2
+ glob 11.0.0
+ ignore-walk 6.0.5
+ js-yaml 4.1.0
+ postcss 8.4.49
+ tar 6.2.1
+ terser 5.36.0
+ typescript 5.6.3

optionalDependencies:
+ cypress 13.15.2

devDependencies: skipped

Done in 1m 5.3s

        node_modules/.pnpm/canvas@3.1.0/node_modules/canvas: Running install script, done in 26.5s

        as can be seen Canvas builds successfully

        While I have basically every dev package installed as well as make, cmake and etc

        GhostBSD-blocklist-dev-24.10.1
GhostBSD-bluetooth-dev-24.10.1
GhostBSD-bootloader-dev-24.10.1
GhostBSD-bsnmp-dev-24.10.1
GhostBSD-clang-dev-24.10.1
GhostBSD-clibs-dev-24.10.1
GhostBSD-devmatch-dev-24.10.1
GhostBSD-dpv-dev-24.10.1
GhostBSD-dtrace-dev-24.10.1
GhostBSD-efi-tools-dev-24.10.1
GhostBSD-fetch-dev-24.10.1
GhostBSD-kerberos-lib-dev-24.10.1
GhostBSD-lib9p-dev-24.10.1
GhostBSD-libarchive-dev-24.10.1
GhostBSD-libbegemot-dev-24.10.1
GhostBSD-libblocksruntime-dev-24.10.1
GhostBSD-libbsdstat-dev-24.10.1
GhostBSD-libbsm-dev-24.10.1
GhostBSD-libbz2-dev-24.10.1
GhostBSD-libcasper-dev-24.10.1
GhostBSD-libcompat-dev-24.10.1
GhostBSD-libcompiler_rt-dev-24.10.1
GhostBSD-libcuse-dev-24.10.1
GhostBSD-libdwarf-dev-24.10.1
GhostBSD-libevent1-dev-24.10.1
GhostBSD-libexecinfo-dev-24.10.1
GhostBSD-libipt-dev-24.10.1
GhostBSD-libldns-dev-24.10.1
GhostBSD-liblzma-dev-24.10.1
GhostBSD-libmagic-dev-24.10.1
GhostBSD-libpathconv-dev-24.10.1
GhostBSD-librpcsec_gss-dev-24.10.1
GhostBSD-librss-dev-24.10.1
GhostBSD-libsdp-dev-24.10.1
GhostBSD-libsqlite3-dev-24.10.1
GhostBSD-libstdbuf-dev-24.10.1
GhostBSD-libstdthreads-dev-24.10.1
GhostBSD-libthread_db-dev-24.10.1
GhostBSD-libucl-dev-24.10.1
GhostBSD-libvgl-dev-24.10.1
GhostBSD-libvmmapi-dev-24.10.1
GhostBSD-liby-dev-24.10.1
GhostBSD-natd-dev-24.10.1
GhostBSD-netmap-dev-24.10.1
GhostBSD-openssl-lib-dev-24.10.1
GhostBSD-pf-dev-24.10.1
GhostBSD-runtime-dev-24.10.1
GhostBSD-sendmail-dev-24.10.1
GhostBSD-smbutils-dev-24.10.1
GhostBSD-ssh-dev-24.10.1
GhostBSD-tcpd-dev-24.10.1
GhostBSD-tests-dev-24.10.1
GhostBSD-ufs-dev-24.10.1
GhostBSD-unbound-dev-24.10.1
GhostBSD-utilities-dev-24.10.1
GhostBSD-zfs-dev-24.10.1
      • Marie
        Marie @Marie ·
        Developer

        it seems that this issue can also be related due to old left over files as per https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=279692 or per https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=278657

        Also check this note: https://cgit.freebsd.org/src/commit/?id=157802238b5aa7722aff40317fe6d05f5c975d71

        Edited by Marie
      • dos kel
        dos kel @doskel ·
        Author

        ah yeah that was it; just had to pull down /usr/include/c++ from the binary distribution and copy that into place. also, had to manually pnpm install -w matter-js seedrandom and run pnpm install without --prod. not sure what the actual behind-the-scenes stuff that causes that is, but it's worth noting. that said, it's now running fine! yippee

      • Marie
        Marie @Marie ·
        Developer

        the fact you had to manually run a few pnpm commands could have just been a bug/glitch with pnpm's cache/store stuff happens sometimes with node package managers being funky. But happy to hear that it works with the Branch 😃

      • Marie mentioned in commit 9731a614

        mentioned in commit 9731a614

      • Marie closed with merge request !887 (merged)

        closed with merge request !887 (merged)

      Please register or sign in to reply