Fix `dyld[]: missing symbol called` errors when running Node.js programs on M1 Macs (apple silicon)

fix-dyld-missing-symbol-called-errors-on-m1-macs.md

Problem

If you're getting this kind of error when running Node.js programs with binary dependencies that don't support M1 yet, e.g.:

$ yarn test
dyld[51175]: missing symbol called
dyld[51176]: missing symbol called

Solution

tl;dr: (Re)install a x64 build of Node.js.

Steps to follow

1. Start a new shell using Rosetta2

   $ arch -x86_64 zsh

2. In that shell, reinstall the x64 version of Node.js

   $ nvm use system
   $ nvm cache clear
   $ nvm uninstall 16 # or the version you need
   $ nvm install 16   # or the version you need
   $ nvm use 16       # or the version you need

3. Still in that shell, reinstall and build npm dependencies from scratch

   $ rm -rf node_modules
   $ yarn cache clean
   $ yarn install

4. Whenever you come back to your project (e.g. after restarting), don't forget to select that same version of Node.js!

   $ nvm use 16 # or the one you installed in step 2

Troubleshooting

If you still see the error:

• Try (re)installing your dependencies with npm install instead of yarn install.

• It could be that the node command is not linked to nvm.

  • To check that, run nvm use 16; nvm ls and check that the little arrow (->) targets v16.
  • If it targets system, you may want to uninstall any other installation of node (e.g. which node; brew uninstall node), then retry the whole procedure.

M2 chip here:

For those using @google-cloud/storage (or firebase-admin storage module), it optionally uses fast-crc32c which is not compatible with ARM, hence the dyld[...]: missing symbol called. ([email protected] at the time of writing).

Performance is a concern for us, and we weren't sure whether it was worse to slow down CRC calculation or to slow down all the rest by running unnecessarily under Rosetta.

We decided to get rid of fast-crc32c and keep running under ARM. But we haven't really benchmarked yet to make sure it was actually convenient. If anyone has, please advice.

EDIT:
That above all happened while we were running under Node 16.
We just migrated to Node 20 and decided to try again using [email protected] and it did work under ARM without Rosetta.
It didn't under Node 16 🤷‍♀️ Oh, well...

not work 😢

(base) ➜  server git:(main) ✗ bun ./src/index.ts
dyld[25666]: missing symbol called
[1]    25666 killed     bun ./src/index.ts
(base) ➜  server git:(main) ✗ arch -x86_64 zsh
(base) ➜  server git:(main) ✗ nvm use system
Now using system version of node: v21.6.0 (npm v10.2.4)
(base) ➜  server git:(main) ✗ nvm cache clear
nvm cache cleared.
(base) ➜  server git:(main) ✗ nvm uninstall v21.6.0
N/A version is not installed...
(base) ➜  server git:(main) ✗ nvm install v21.6.0 
Downloading and installing node v21.6.0...
Downloading https://nodejs.org/dist/v21.6.0/node-v21.6.0-darwin-x64.tar.xz...
################################################################################ 100.0%
Computing checksum with shasum -a 256
Checksums matched!
Now using node v21.6.0 (npm v10.2.4)
(base) ➜  server git:(main) ✗ nvm use v21.6.0     
Now using node v21.6.0 (npm v10.2.4)
(base) ➜  server git:(main) ✗ rm -rf node_modules    
(base) ➜  server git:(main) ✗ bun i       
[0.25ms] ".env.local"
bun install v1.0.24 (6fa35839)

 + @types/[email protected]
 + @types/[email protected]
 + @types/[email protected]
 + @types/[email protected]
 + @types/[email protected]
 + @types/[email protected]
 + @types/[email protected]
 + @types/[email protected]
 + [email protected]
 + [email protected]
 + @supabase/[email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]
 + [email protected]

warn: canvas's install script took 5m11.2s

 241 packages installed [312.43s]
(base) ➜  server git:(main) ✗ 
(base) ➜  server git:(main) ✗ 
(base) ➜  server git:(main) ✗ 
(base) ➜  server git:(main) ✗ 
(base) ➜  server git:(main) ✗ 
(base) ➜  server git:(main) ✗ 
(base) ➜  server git:(main) ✗ 
(base) ➜  server git:(main) ✗ bun ./src/index.ts   
1 | 'use strict'
2 | 
3 | const bindings = require('../build/Release/canvas.node')
          ^
TypeError: dlopen(/Users/stepbystep/Documents/typing-app/server/node_modules/canvas/build/Release/canvas.node, 0x0001): tried: '/Users/stepbystep/Documents/typing-app/server/node_modules/canvas/build/Release/canvas.node' (mach-o file, but is an incompatible architecture (have 'x86_64', need 'arm64')), '/System/Volumes/Preboot/Cryptexes/OS/Users/stepbystep/Documents/typing-app/server/node_modules/canvas/build/Release/canvas.node' (no such file), '/Users/stepbystep/Documents/typing-app/server/node_modules/canvas/build/Release/canvas.node' (mach-o file, but is an incompatible architecture (have 'x86_64', need 'arm64'))
      at /Users/stepbystep/Documents/typing-app/server/node_modules/canvas/lib/bindings.js:3:7
      at /Users/stepbystep/Documents/typing-app/server/node_modules/canvas/lib/canvas.js:9:7
      at /Users/stepbystep/Documents/typing-app/server/node_modules/canvas/index.js:1:7
(base) ➜  server git:(main) ✗ 

niubi

good it's work for me