improve native modules compatibility with old systems

vladimiry · vladimiry · commit 3c70ef0887fd · 2025-07-29T02:37:34.000+03:00
* Run "prepare-native-deps" script on "ubuntu:20.04" docker image (old system). This fixes Snap package (also should benefit some old Linux systems). Tested on Ubuntu 24.04. Originally, the Snap build from https://github.com/vladimiry/ElectronMail/releases/tag/v5.3.1 was failing on Ubuntu 24.04 with error (sodium-native.node binary): /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.33' not found. * Tweak "prepare-native-deps" compiling args on Windows.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -15,7 +15,6 @@ jobs:
       - { uses: actions/checkout@v4 }
       - { uses: pnpm/action-setup@v4, with: { version: 'latest' } }
       - { uses: actions/setup-node@v4, with: { node-version: '${{ env.ELECTRON_MAIL_NODE_VERSION }}', cache: 'pnpm' } }
-      - { name: system setup, if: runner.os == 'Linux', run: ./scripts/ci/github/system-setup-linux.sh }
       - { uses: actions/setup-python@v5, with: { python-version: '3.9' } }
       - { name: envinfo, run: npx envinfo }
       - { name: install node modules, run: 'pnpm install --frozen-lockfile --reporter=append-only' }
@@ -44,7 +43,6 @@ jobs:
       - { uses: actions/checkout@v4 }
       - { uses: pnpm/action-setup@v4, with: { version: 'latest' } }
       - { uses: actions/setup-node@v4, with: { node-version: '${{ env.ELECTRON_MAIL_NODE_VERSION }}', cache: 'pnpm' } }
-      - { name: system setup, if: runner.os == 'Linux', run: ./scripts/ci/github/system-setup-linux.sh }
       - { uses: actions/setup-python@v5, with: { python-version: '3.9' } }
       - { name: envinfo, run: npx envinfo }
       - { name: install node modules, run: 'pnpm install --frozen-lockfile --reporter=append-only' }
@@ -66,7 +64,6 @@ jobs:
       - { uses: actions/checkout@v4 }
       - { uses: pnpm/action-setup@v4, with: { version: 'latest' } }
       - { uses: actions/setup-node@v4, with: { node-version: '${{ env.ELECTRON_MAIL_NODE_VERSION }}', cache: 'pnpm' } }
-      - { name: system setup, if: runner.os == 'Linux', run: ./scripts/ci/github/system-setup-linux.sh }
       - { uses: actions/setup-python@v5, with: { python-version: '3.9' } }
       - { name: envinfo, run: npx envinfo }
       - { name: install node modules, run: 'pnpm install --frozen-lockfile --reporter=append-only' }
@@ -77,6 +74,18 @@ jobs:
       - { name: assets, run: 'yarn assets', env: { ELECTRON_MAIL_SHOULD_FAIL_ON_BUILD: 'true' } }
       - { name: print ./app files, shell: bash, run: ./scripts/ci/list-fs-content.sh ./app }
       - { name: build, if: runner.os == 'Windows', run: ./scripts/ci/github/package-app.ps1 }
+      - name: build native deps in ubuntu:20.04
+        if: runner.os == 'Linux'
+        run: |
+          set -e
+          pnpm run clean:prebuilds
+          docker run --rm \
+            -v ${{ github.workspace }}:/host \
+            -w /tmp \
+            -e ELECTRON_MAIL_NODE_VERSION=${{ env.ELECTRON_MAIL_NODE_VERSION }} \
+            -e GITHUB_REPOSITORY=${{ github.repository }} \
+            -e GITHUB_SHA=${{ github.sha }} \
+            ubuntu:20.04 bash -c "/host/scripts/ci/github/prepare-native-deps-docker.sh"
       - { name: build, if: runner.os == 'Linux', run: ./scripts/ci/github/package-app-linux.sh }
       - {
           name: build,
diff --git a/package.json b/package.json
@@ -56,7 +56,7 @@
     "clean:app": "rimraf ./app",
     "clean:app-dev": "rimraf ./app-dev",
     "clean:output": "rimraf ./output",
-    "clean:prebuilds": "rimraf --glob \"./node_modules/{keytar,sodium-native,msgpackr-extract}/{bin,build,prebuilds}\" \"./node_modules/@msgpackr-extract/\" \"./node_modules/sodium-native/deps/**/!(bin.js)\"",
+    "clean:prebuilds": "rimraf --glob \"./node_modules/{keytar,sodium-native,msgpackr-extract,@msgpackr-extract}/**/*.{node,bare}\" \"./node_modules/@msgpackr-extract/\"",
     "assets": "npm-run-all assets:copy assets:webclient",
     "assets:dev": "npm-run-all assets:copy:dev assets:webclient:dev",
     "assets:copy": "cpx \"./src/assets/dist/**/*\" ./app/assets",
diff --git a/scripts/ci/github/package-app-linux.sh b/scripts/ci/github/package-app-linux.sh
@@ -4,36 +4,20 @@ set -ev
 
 echo "::group::tweak the system"
 sudo apt-get update
-# <purpose: native modules compiling>
-sudo apt-get install --yes --no-install-recommends libtool automake gcc-10 g++-10
-sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave /usr/bin/g++ g++ /usr/bin/g++-10 --slave /usr/bin/gcov gcov /usr/bin/gcov-10
-# purpose: compiling "desktop-idle" native module (issue: No package 'xscrnsaver' found)
-sudo apt-get install --yes --no-install-recommends libxss-dev
-# purpose: tweaking snap package ("unsquashfs" binary)
-sudo apt-get install --yes --no-install-recommends snapcraft squashfs-tools
-# purpose: compiling "node-keytar" native module and keychain initialization
-sudo apt-get install --yes --no-install-recommends libsecret-1-dev
-# purpose: pacman build fails also due missing "bsdtar", see https://github.com/jordansissel/fpm/issues/1453#issuecomment-356138549
-sudo apt-get install --yes --no-install-recommends libarchive-tools
-# purpose: AppImage re-packaging
-sudo apt-get install --yes --no-install-recommends desktop-file-utils
-# </purpose: native modules compiling>
-export CC=gcc-10
-export CXX=g++-10
+# - snapcraft: for snap tweaking
+# - squashfs-tools: for snap tweaking
+# - libarchive-tools: includes bsdtar for pacman builds
+# - desktop-file-utils: needed for AppImage packaging
+sudo apt-get install --yes --no-install-recommends \
+  snapcraft \
+  squashfs-tools \
+  libarchive-tools \
+  desktop-file-utils
 echo "::endgroup::"
 
-# assuming that "ubuntu-22.04" image comes with glibc v2.31, see https://github.com/vladimiry/ElectronMail/issues/389#issuecomment-812071591
-GLIBC_INFO_EXPECTED_SUB="release version 2.35"
-GLIBC_INFO=$(lsof -p $$ | grep libc | awk ' { print $NF" --version"; } ' | sh)
-echo $GLIBC_INFO
-if [[ "$GLIBC_INFO" != *"$GLIBC_INFO_EXPECTED_SUB"* ]]; then
-    echo >&2 "unexpected glibc version detected"
-    exit 1
-fi
-
-echo "::group::compile native modules"
-pnpm run prepare-native-deps
-echo "::endgroup::"
+# echo "::group::compile native modules"
+# pnpm run prepare-native-deps # moved to "./scripts/ci/github/prepare-native-deps-docker.sh"
+# echo "::endgroup::"
 
 echo "::group::test e2e setup"
 echo "initializing xvfb stuff..."
diff --git a/scripts/ci/github/prepare-native-deps-docker.sh b/scripts/ci/github/prepare-native-deps-docker.sh
@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+
+set -ev
+
+: "${ELECTRON_MAIL_NODE_VERSION:?Missing ELECTRON_MAIL_NODE_VERSION}"
+: "${GITHUB_REPOSITORY:?Missing GITHUB_REPOSITORY}"
+: "${GITHUB_SHA:?Missing GITHUB_SHA}"
+
+export DEBIAN_FRONTEND=noninteractive
+
+apt-get update
+
+echo "::group::isntall nodejs & pnpm"
+apt-get install --yes --no-install-recommends ca-certificates curl gnupg
+mkdir -p /etc/apt/keyrings
+curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key \
+  | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_${ELECTRON_MAIL_NODE_VERSION}.x nodistro main" \
+  | tee /etc/apt/sources.list.d/nodesource.list
+apt update
+apt-get install --yes nodejs
+node -v
+npm -v
+corepack enable
+corepack prepare pnpm@latest --activate
+pnpm -v
+echo "::endgroup::"
+
+echo "::group::install system packages"
+apt-get install --yes --no-install-recommends wget lsb-release software-properties-common build-essential python3 git
+echo "::endgroup::"
+
+echo "::group::install clang/ldd setup"
+wget https://apt.llvm.org/llvm.sh
+chmod +x llvm.sh
+./llvm.sh 20
+rm llvm.sh
+echo "::endgroup::"
+
+# picket form "./scripts/ci/github/package-app-linux.sh" of v5.3.0 release (when it still used "ubuntu-20.04" GH CI image)
+echo "::group::install and configure compiling tools"
+apt-get install --yes --no-install-recommends libtool automake gcc-10 g++-10 libsecret-1-dev
+update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave /usr/bin/g++ g++ /usr/bin/g++-10 --slave /usr/bin/gcov gcov /usr/bin/gcov-10
+echo "::endgroup::"
+
+echo "::group::clone project & install node modules"
+git clone "https://github.com/${GITHUB_REPOSITORY}" /build
+cd /build
+git checkout "${GITHUB_SHA}"
+pnpm install --frozen-lockfile
+echo "::endgroup::"
+
+echo "::group::compile native modules"
+pnpm run prepare-native-deps
+echo "::endgroup::"
+
+echo "::group::copy compiled .node files back to host and print GLIBC version strings"
+find node_modules -name '*.node' -exec sh -c '
+  echo "GLIBC symbols in $1:"
+  strings "$1" | grep GLIBC_ | sort | uniq
+  echo "Copying: $1"
+  cp --parents "$1" /host/
+  echo "-----------------------------"
+' _ {} \;
+echo "::endgroup::"
diff --git a/scripts/ci/github/system-setup-linux.sh b/scripts/ci/github/system-setup-linux.sh
diff --git a/scripts/prepare-native-deps.ts b/scripts/prepare-native-deps.ts
@@ -18,7 +18,10 @@ const IS_CROSS_PLATFORM_COMPILATION = DEST_ARCH !== os.arch();
 
 const resolvePlatformEnvVars = ((): () => NodeJS.ProcessEnv => {
     const resolvers: Readonly<Partial<Record<NodeJS.Platform, () => NodeJS.ProcessEnv>>> = {
-        // win32: () => ({GYP_MSVS_VERSION: "2022", CL: "/FS /Zc:__cplusplus /std:c++20"}),
+        win32: () => ({
+            GYP_DEFINES: "win_target=0x0A00 msvs_runtime_static=true",
+            CL: "/MT /D_WIN32_WINNT=0x0A00",
+        }),
         darwin: () => {
             // https://developer.apple.com/documentation/apple-silicon/building-a-universal-macos-binary
             const versionMin = DEST_ARCH === "x64" ? "10.12" : "11";
@@ -52,11 +55,17 @@ const compileRegularNativeDeps = async (): Promise<void> => {
 
     for (const moduleDir of nativeModuleDirs) {
         const moduleName = path.basename(moduleDir);
+        const baseEnvVars = resolvePlatformEnvVars();
         const extraEnvVars = {
-            ...resolvePlatformEnvVars(),
+            ...baseEnvVars,
             ...(os.platform() === "win32" && moduleName === "msgpackr-extract"
-                ? {GYP_MSVS_VERSION: "2022", CL: "/FS /Zc:__cplusplus /std:c++20"}
+                ? {
+                    GYP_MSVS_VERSION: "2022",
+                    GYP_DEFINES: `${baseEnvVars.GYP_DEFINES ?? ""} msvs_version=2022`,
+                    CL: `${baseEnvVars.CL ?? ""} /FS /Zc:__cplusplus /std:c++20`,
+                }
                 : undefined),
+            ...(os.platform() === "linux" ? {CC: "gcc-10", CXX: "g++-10"} : undefined),
         };
 
         await execShell(["npm", [
@@ -90,7 +99,10 @@ const compileRegularNativeDeps = async (): Promise<void> => {
 };
 
 const bareMakeExec = async (cwd: string, ...args: string[]): Promise<void> => {
-    const extraEnvVars = resolvePlatformEnvVars();
+    const extraEnvVars = {
+        ...resolvePlatformEnvVars(),
+        ...(os.platform() === "linux" ? {CC: "clang-20", CXX: "clang++-20"} : undefined),
+    };
     await execShell(
         ["pnpm", ["exec", "bare-make", ...args, "--verbose"], {cwd, env: {...process.env, ...extraEnvVars}}],
         {printEnvWhitelist: [...Object.values(ENV_VAR_NAMES), ...Object.keys(extraEnvVars)]},
diff --git a/src/e2e/lib/init-app.ts b/src/e2e/lib/init-app.ts
@@ -44,12 +44,7 @@ export const initAppWithTestContext = async (
     //      - folder prepared by running "electron-builder --dir"
     const app = testContext.app = await playwright._electron.launch({
         args: [MAIN_SCRIPT_FILE, `--user-data-dir=${testContext.userDataDirPath}`],
-        env: {
-            ...process.env,
-            [RUNTIME_ENV_USER_DATA_DIR]: testContext.userDataDirPath,
-            ELECTRON_ENABLE_LOGGING: "1",
-            // ...(os.platform() === "darwin" ? {ELECTRON_DISABLE_GPU: "1"} : undefined),
-        },
+        env: {...process.env, ELECTRON_ENABLE_LOGGING: "1", [RUNTIME_ENV_USER_DATA_DIR]: testContext.userDataDirPath},
     });
 
     testContext.firstWindowPage = await app.firstWindow();
