pnpm install errors

[HerbCaudill]

I'm trying to set up a dev environment to explore the codebase, but I'm getting an error running pnpm install.

⚡︎ brew install pkg-config cairo pango libpng jpeg giflib librsvg
...

⚡︎ pnpm i      
Scope: all 171 workspace projects
Lockfile is up to date, resolution step is skipped
Packages: +4271
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Progress: resolved 4271, reused 4234, downloaded 0, added 4271, done
node_modules/.pnpm/[email protected]/node_modules/faiss-node: Running install script...
node_modules/.pnpm/[email protected]/node_modules/canvas: Running install script...
node_modules/.pnpm/[email protected]/node_modules/leveldown: Running install script...
node_modules/.pnpm/[email protected]/node_modules/leveldown: Running install script, failed in 675mse: Running in
.../node_modules/leveldown install$ node-gyp-build
│ gyp info it worked if it ends with ok
│ gyp info using [email protected]
│ gyp info using [email protected] | darwin | arm64
│ gyp info find Python using Python version 3.12.2 found at "/opt/homebrew/opt/[email protected]/bin/python3.12"
│ gyp info spawn /opt/homebrew/opt/[email protected]/bin/python3.12
│ gyp info spawn args [
│ gyp info spawn args   '/Users/herbcaudill/Library/pnpm/global/5/.pnpm/[email protected]/node_modules/pnpm/dist/n…
│ 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   '/Users/herbcaudill/Code/dxos/dxos/node_modules/.pnpm/[email protected]/node_modules/l…
│ gyp info spawn args   '-I',
│ gyp info spawn args   '/Users/herbcaudill/Library/pnpm/global/5/.pnpm/[email protected]/node_modules/pnpm/dist/n…
│ gyp info spawn args   '-I',
│ gyp info spawn args   '/Users/herbcaudill/Library/Caches/node-gyp/20.10.0/include/node/common.gypi',
│ gyp info spawn args   '-Dlibrary=shared_library',
│ gyp info spawn args   '-Dvisibility=default',
│ gyp info spawn args   '-Dnode_root_dir=/Users/herbcaudill/Library/Caches/node-gyp/20.10.0',
│ gyp info spawn args   '-Dnode_gyp_dir=/Users/herbcaudill/Library/pnpm/global/5/.pnpm/[email protected]/node_modu…
│ gyp info spawn args   '-Dnode_lib_file=/Users/herbcaudill/Library/Caches/node-gyp/20.10.0/<(target_arch)/n…
│ gyp info spawn args   '-Dmodule_root_dir=/Users/herbcaudill/Code/dxos/dxos/node_modules/.pnpm/leveldown@5.…
│ 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 ]
│ Traceback (most recent call last):
│   File "/Users/herbcaudill/Library/pnpm/global/5/.pnpm/[email protected]/node_modules/pnpm/dist/node_modules/nod…
│     import gyp  # noqa: E402
│     ^^^^^^^^^^
│   File "/Users/herbcaudill/Library/pnpm/global/5/.pnpm/[email protected]/node_modules/pnpm/dist/node_modules/nod…
│     import gyp.input
│   File "/Users/herbcaudill/Library/pnpm/global/5/.pnpm/[email protected]/node_modules/pnpm/dist/node_modules/nod…
│     from distutils.version import StrictVersion
│ ModuleNotFoundError: No module named 'distutils'
│ gyp ERR! configure error 
│ gyp ERR! stack Error: `gyp` failed with exit code: 1
│ gyp ERR! stack     at ChildProcess.onCpExit (/Users/herbcaudill/Library/pnpm/global/5/.pnpm/[email protected]/no…
│ gyp ERR! stack     at ChildProcess.emit (node:events:514:28)
│ gyp ERR! stack     at ChildProcess._handle.onexit (node:internal/child_process:294:12)
│ gyp ERR! System Darwin 23.1.0
│ gyp ERR! command "/Users/herbcaudill/.asdf/installs/nodejs/20.10.0/bin/node" "/Users/herbcaudill/Library/p…
│ gyp ERR! cwd /Users/herbcaudill/Code/dxos/dxos/node_modules/.pnpm/[email protected]/node_modules/leveldown
│ gyp ERR! node -v v20.10.0
│ gyp ERR! node-gyp -v v9.4.1
│ gyp ERR! not ok 
└─ Failed in 675ms at /Users/herbcaudill/Code/dxos/dxos/node_modules/.pnpm/[email protected]/node_modules/leveldown
node_modules/.pnpm/@[email protected][email protected]/node_modules/@tensorflow/tfjs-node: Running install script...
 ELIFECYCLE  Command failed with exit code 1.

This is with node v20, but I get the same result with v18.

[wittjosiah]

I've not run into this issue myself but I've seen a few people in discord run into this. In one case

it turns out the latest python doesn't have distutils, python v3.9.1 did the trick, node v18.16.1, node-gyp v10.1.0

[HerbCaudill]

Thanks @wittjosiah - that helped me figure it out.

Python distutils is deprecated in favor of setuptools. To install with homebrew:

brew install python-setuptools

[michielbdejong]

I ran into this issue as well, I'll create a PR to add it to the docs!

[michielbdejong]

-> #7062