Zeromq for Mac M1 & other linux distros

[DonJayamanne]

Zeromq is used to communicate with kernels. If zeromq didn't work on an os, then we rely on users installing jupyter, which will install python and zeromq will get built on the os.
Mac m1 is an os for which we don't have a prebuilt binary.

• I can confirm building zeromq works on Mac M1, & this works in a Mac

TODO:

• Ship this as an experiment (for controlled roll out)
• Consider contributing upstream
• Sign & Build dependencies (build pipeline)
• Should we sign & build dependencies for all OS & linux distros (even though we already have pre-built packages via npm)
• How to detect what's a Mac M1
  • We could optionally load currrenly shipped zeromq and then if that fails, try our build.
  • Would require some changes to the zeromq package code or we'll need to update the files during runtime.

[xiajunwen1007]

Any progress here? There is a similar issue caused by this #4.

[DonJayamanne]

Summary of discussion with @deepak1556

Build

• Build on the CI pipeline (with Mac OS SDK), we provide the target arch (e.g. arm64) - via a cross compilation
• We cross compile as there's no arm64 machine on CI
• Ensure zeromq has the build targets for arm64 (seems to work for Don on his M1, hence things should work as expected)
• Create separate pipeline for building on Mac arm
• Here's an sample pipeline https://github.com/microsoft/vscode/blob/4c72dedb4ad283a569f83a7389468c3ae2c642c3/build/azure-pipelines/darwin/product-build-darwin.yml#L98-L116

Signing

• Check with Steven/Isidor about signing contents in the vsix (are they signed today)

OS

• On website
• Platform all 3 arcs (32, 64, arm64)
• No support for linux 32
• Check link provided for supported - (https://code.visualstudio.com/docs/supporting/requirements#_platforms)
  • These are the minimum versions supported
  • We might want to consider building for these as well.

Mac Universal?

• This is the future (no arch specific builds)
• Highly recommended (core ships universal for binaries)
• We might want to build a universal binary for Mac (then we ship just a single binary)
• Build x64 and arm64, then use mac toolchain to create universal binary (lipo)
  • https://github.com/microsoft/vscode/blob/4c72dedb4ad283a569f83a7389468c3ae2c642c3/build/azure-pipelines/darwin/product-build-darwin-universal.yml
• We might want to add a universal tag into extension package.json so it shows up in marketplace

[DonJayamanne]

Internal (planning) notes

Notes

• Turn off libsodium in our builds
  see Bartel-C8/zeromq.js@006f817
  DBUILD_SHARED=OFF -DWITH_DOCS=OFF -DWITH_LIBSODIUM=OFF`

• Set the env variable for focring node-gyp to use 32
  $env:npm_config_arch="x86"

• Invevstigate building using a single ubuntu with musl
  docker_cmd: apk add --no-cache pkgconfig curl tar python3 make gcc g++ cmake musl-dev && npm i -g pnpm && pnpm ins

Status

• Binaries built here https://github.com/microsoft/zeromq-prebuilt
• Test matrix and status here Testing of binaries zeromq-prebuilt#5
• Shipped in Jupyter extension (pre-release)