Instructions for Local build currently don't work

[micheletascaadevinta]

If one tries to build this extension locally, following the instructions specified in CONTRIBUTING.md:

git clone https://github.com/microsoft/vscode-jupyter
cd vscode-jupyter
npm ci
# Run this to setup the necessary pre-commit hooks.
npm run setup-precommit-hook
python3 -m venv .venv
# Activate the virtual environment as appropriate for your shell, For example, on bash it's ...
source .venv/bin/activate
# and in Windows cmd or PowerShell
.venv\Scripts\activate
# The Python code in the extension is formatted using Black.
python -m pip install black
# The Python code required in the extension
python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r ./requirements.txt

# LOCAL BUILD:

> npm install -g @vscode/vsce
# Perform the next steps in the vscode-jupyter folder.
> npm ci
> python3 -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt --no-user
> npm run clean
> npm run package # This step takes around 10 minutes.
# Resulting in a ms-toolsai-jupyter-insiders.vsix file in your vscode-jupyter folder.

Everything works except the last command, which fails with error

 ERROR  Extension entrypoint(s) missing. Make sure these files exist and aren't ignored by '.vscodeignore':
  extension/out/extension.node.js,
  extension/out/extension.web.bundle.js

Is it possible to solve this?

[DonJayamanne]

That should work, please check your logs, there must be some other errors in the last command
That’s exactly what we run in our ci as well

[DonJayamanne]

See here, same commands running in github actions https://github.com/microsoft/vscode-jupyter/actions/runs/4891723296/jobs/8732601399
Output line 310

[micheletascaadevinta]

Thanks for answering.

To be fair, there was an error.. About Zeromq, of course. See log below.

I thought I solved this error by installing a different version in the package.json, but probably that doesn't work..

I think the CI downloads the prebuilt zermoq from here, is that true? https://api.github.com/repos/microsoft/zeromq-prebuilt/releases/tags/6.0.0-beta.16.4

Unfortunately, that requires a token.. Is it possible to install it in some other way?

(btw I'm on Macos, node --version >> v16.14.2 and npm --version >> 8.15.1 ).

Error log:

$ npm ci

......

npm ERR! code 1
npm ERR! path /Users/Documents/vscode-extensions/test_env/vscode-jupyter/node_modules/zeromq
npm ERR! command failed
npm ERR! command sh /var/folders/px/jj7m7bws4vg2_r0mqrqszfyc0000gn/T/install-477b767d.sh
npm ERR! TOUCH 7722eaf02fcc073df28ffd1fa831e71544edfd42.intermediate
npm ERR!   ACTION binding_gyp_libzmq_target_build_libzmq 7722eaf02fcc073df28ffd1fa831e71544edfd42.intermediate
npm ERR! Downloading libzmq source from https://github.com/zeromq/libzmq/archive/20de92ac0a2b2b9a1869782a429df68f93c3625e.tar.gz
npm ERR! Building libzmq Release
npm ERR! cmake -S "libzmq-20de92ac0a2b2b9a1869782a429df68f93c3625e" -B ./build  -DCMAKE_OSX_DEPLOYMENT_TARGET=10.15 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/Users/Documents/vscode-extensions/test_env/vscode-jupyter/node_modules/zeromq/build/libzmq" -DCMAKE_INSTALL_LIBDIR=lib -DBUILD_STATIC=ON -DBUILD_TESTS=OFF -DBUILD_SHARED=OFF -DWITH_DOCS=OFF -DWITH_LIBSODIUM=ON -DWITH_LIBSODIUM_STATIC=ON
npm ERR! cmake --build ./build --config Release --target install
npm ERR!   TOUCH Release/obj.target/libzmq.stamp
npm ERR!   CXX(target) Release/obj.target/zeromq/src/context.o
npm ERR! rm 7722eaf02fcc073df28ffd1fa831e71544edfd42.intermediate
npm ERR! dlopen(/Users/Documents/vscode-extensions/test_env/vscode-jupyter/node_modules/zeromq/prebuilds/darwin-x64/node.napi.glibc.node, 0x0001): Library not loaded: /usr/local/opt/libsodium/lib/libsodium.23.dylib
npm ERR!   Referenced from: <00BDB276-A607-3D78-B10D-0899069B057C> /Users/Documents/vscode-extensions/test_env/vscode-jupyter/node_modules/zeromq/prebuilds/darwin-x64/node.napi.glibc.node
npm ERR!   Reason: tried: '/usr/local/opt/libsodium/lib/libsodium.23.dylib' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/usr/local/opt/libsodium/lib/libsodium.23.dylib' (no such file), '/usr/local/opt/libsodium/lib/libsodium.23.dylib' (no such file), '/usr/local/lib/libsodium.23.dylib' (no such file), '/usr/lib/libsodium.23.dylib' (no such file, not in dyld cache)
npm ERR! gyp info it worked if it ends with ok
npm ERR! gyp info using [email protected]
npm ERR! gyp info using [email protected] | darwin | x64
npm ERR! gyp info find Python using Python version 3.11.2 found at "/Users/Documents/vscode-extensions/test_env/vscode-jupyter/.venv/bin/python3"
npm ERR! gyp info spawn /Users/Documents/vscode-extensions/test_env/vscode-jupyter/.venv/bin/python3
npm ERR! gyp info spawn args [
npm ERR! gyp info spawn args   '/Users/.nvm/versions/node/v16.14.2/lib/node_modules/npm/node_modules/node-gyp/gyp/gyp_main.py',
npm ERR! gyp info spawn args   'binding.gyp',
npm ERR! gyp info spawn args   '-f',
npm ERR! gyp info spawn args   'make',
npm ERR! gyp info spawn args   '-I',
npm ERR! gyp info spawn args   '/Users/Documents/vscode-extensions/test_env/vscode-jupyter/node_modules/zeromq/build/config.gypi',
npm ERR! gyp info spawn args   '-I',
npm ERR! gyp info spawn args   '/Users/.nvm/versions/node/v16.14.2/lib/node_modules/npm/node_modules/node-gyp/addon.gypi',
npm ERR! gyp info spawn args   '-I',
npm ERR! gyp info spawn args   '/Users/Library/Caches/node-gyp/16.14.2/include/node/common.gypi',
npm ERR! gyp info spawn args   '-Dlibrary=shared_library',
npm ERR! gyp info spawn args   '-Dvisibility=default',
npm ERR! gyp info spawn args   '-Dnode_root_dir=/Users/Library/Caches/node-gyp/16.14.2',
npm ERR! gyp info spawn args   '-Dnode_gyp_dir=/Users/.nvm/versions/node/v16.14.2/lib/node_modules/npm/node_modules/node-gyp',
npm ERR! gyp info spawn args   '-Dnode_lib_file=/Users/Library/Caches/node-gyp/16.14.2/<(target_arch)/node.lib',
npm ERR! gyp info spawn args   '-Dmodule_root_dir=/Users/Documents/vscode-extensions/test_env/vscode-jupyter/node_modules/zeromq',
npm ERR! gyp info spawn args   '-Dnode_engine=v8',
npm ERR! gyp info spawn args   '--depth=.',
npm ERR! gyp info spawn args   '--no-parallel',
npm ERR! gyp info spawn args   '--generator-output',
npm ERR! gyp info spawn args   'build',
npm ERR! gyp info spawn args   '-Goutput_dir=.'
npm ERR! gyp info spawn args ]
npm ERR! gyp info spawn make
npm ERR! gyp info spawn args [ 'BUILDTYPE=Release', '-C', 'build' ]
npm ERR! /bin/sh: cmake: command not found
npm ERR! /bin/sh: cmake: command not found
npm ERR! In file included from ../src/context.cc:2:
npm ERR! In file included from ../src/context.h:4:
npm ERR! ../src/prefix.h:8:10: fatal error: 'zmq.h' file not found
npm ERR! #include <zmq.h>
npm ERR!          ^~~~~~~
npm ERR! 1 error generated.
npm ERR! make: *** [Release/obj.target/zeromq/src/context.o] Error 1
npm ERR! gyp ERR! build error 
npm ERR! gyp ERR! stack Error: `make` failed with exit code: 2
npm ERR! gyp ERR! stack     at ChildProcess.onExit (/Users/.nvm/versions/node/v16.14.2/lib/node_modules/npm/node_modules/node-gyp/lib/build.js:194:23)
npm ERR! gyp ERR! stack     at ChildProcess.emit (node:events:526:28)
npm ERR! gyp ERR! stack     at Process.ChildProcess._handle.onexit (node:internal/child_process:291:12)
npm ERR! gyp ERR! System Darwin 22.1.0
npm ERR! gyp ERR! command "/Users/.nvm/versions/node/v16.14.2/bin/node" "/Users/.nvm/versions/node/v16.14.2/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
npm ERR! gyp ERR! cwd /Users/Documents/vscode-extensions/test_env/vscode-jupyter/node_modules/zeromq
npm ERR! gyp ERR! node -v v16.14.2
npm ERR! gyp ERR! node-gyp -v v9.0.0
npm ERR! gyp ERR! not ok

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/.npm/_logs/2023-05-07T22_39_18_586Z-debug-0.log

[DonJayamanne]

think the CI downloads the prebuilt zermoq from here, is that true?

No that’s not true
The zmq binaries are shipped with the @vscode/zeromq package
If you check the ci logs you can see that there’s no download

ERR! ../src/prefix.h:8:10: fatal error: 'zmq.h' file not found
npm ERR! #include <zmq.h>

looks like some failures at your end in installing the npm package

please can you create a standalone folder and try npm install the zeromq package and see what happens
Ie ignore Jupyter extension completely and just focus on the 3rd party npm package