nodejs-workflow.yml

name: Build Node.js Module

on:
  workflow_dispatch:
    inputs:
      precompiledRunId:
        description: "Run ID of the precompiled-bin job whose artifacts should be used"
        required: true
        type: string
      nodeVersion:
        description: "Node.js version used to build/test this workflow"
        required: false
        default: "22"
        type: string
      linuxBuilderImage:
        description: "Ubuntu 22.04 image with GCC 13 for Linux builds"
        required: false
        default: "ghcr.io/ladybugdb/ubuntu-22.04-gcc13:latest"
        type: string
      useBuiltExtensions:
        description: "Use the lbug-extensions artifact from this workflow run for Node.js tests"
        required: false
        default: false
        type: boolean
  workflow_call:
    inputs:
      isNightly:
        type: boolean
        required: true
        default: false
      precompiledRunId:
        type: string
        required: true
      nodeVersion:
        type: string
        required: false
        default: "22"
      artifactSuffix:
        type: string
        required: false
        default: ""
      linuxBuilderImage:
        type: string
        required: false
        default: "ghcr.io/ladybugdb/ubuntu-22.04-gcc13:latest"
      useBuiltExtensions:
        type: boolean
        required: false
        default: false

jobs:
  build-nodejs:
    runs-on: ${{ matrix.os }}
    container: ${{ fromJSON(matrix.platform == 'linux' && format('{{"image":"{0}"}}', inputs.linuxBuilderImage) || 'null') }}
    env:
      LBUG_LINUX_VARIANT: compat
      LBUG_NODEJS_PRECOMPILED_DIR: ${{ github.workspace }}/precompiled-liblbug
      LBUG_NODEJS_PRECOMPILED_LIB_PATH: ${{ matrix.platform == 'win32' && format('{0}/precompiled-liblbug/lbug.lib', github.workspace) || format('{0}/precompiled-liblbug/liblbug.a', github.workspace) }}
    strategy:
      matrix:
        include:
          - os: ubuntu-22.04
            arch: x64
            platform: linux
            artifact_name: linux-nodejs-module-x86_64
            node_name: lbugjs-linux-x64.node
          - os: ubuntu-22.04-arm
            arch: arm64
            platform: linux
            artifact_name: linux-nodejs-module-aarch64
            node_name: lbugjs-linux-arm64.node
          - os: macos-latest
            arch: arm64
            platform: darwin
            artifact_name: mac-nodejs-module-arm64
            node_name: lbugjs-darwin-arm64.node
            mac_env: true
          - os: macos-15-intel
            arch: x64
            platform: darwin
            artifact_name: mac-nodejs-module-x64
            node_name: lbugjs-darwin-x64.node
            mac_env: true
          - os: windows-latest
            arch: x64
            platform: win32
            artifact_name: windows-nodejs-module
            node_name: lbugjs-win32-x64.node
    steps:
      - uses: actions/checkout@v4

      - name: Mark workspace safe for git (Linux container)
        if: ${{ matrix.platform == 'linux' }}
        run: git config --global --add safe.directory '*'

      - name: Set precompiled lib path (Linux container)
        if: ${{ matrix.platform == 'linux' }}
        run: |
          echo "LBUG_NODEJS_PRECOMPILED_DIR=${GITHUB_WORKSPACE}/precompiled-liblbug" >> "$GITHUB_ENV"
          echo "LBUG_NODEJS_PRECOMPILED_LIB_PATH=${GITHUB_WORKSPACE}/precompiled-liblbug/liblbug.a" >> "$GITHUB_ENV"

      - name: Update submodules
        run: git submodule update --init --recursive tools/nodejs_api dataset

      - name: Set up Node.js (with npm cache)
        if: ${{ hashFiles('tools/nodejs_api/package-lock.json') != '' }}
        uses: actions/setup-node@v4
        with:
          node-version: ${{ inputs.nodeVersion }}

      - name: Set up Node.js (without npm cache)
        if: ${{ hashFiles('tools/nodejs_api/package-lock.json') == '' }}
        uses: actions/setup-node@v4
        with:
          node-version: ${{ inputs.nodeVersion }}

      - name: Select GCC 13 (Linux)
        if: ${{ matrix.platform == 'linux' }}
        run: |
          echo "CC=gcc-13" >> $GITHUB_ENV
          echo "CXX=g++-13" >> $GITHUB_ENV

      - name: Download precompiled liblbug
        shell: bash
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          LBUG_LIB_KIND: static
          LBUG_PRECOMPILED_RUN_ID: ${{ inputs.precompiledRunId }}
        run: |
          export LBUG_TARGET_DIR="$LBUG_NODEJS_PRECOMPILED_DIR"
          rm -rf "$LBUG_TARGET_DIR"
          ./scripts/download-liblbug.sh

      - name: Update nightly version
        if: ${{ inputs.isNightly == true }}
        run: |
          pip3 install packaging
          python3 update-nightly-build-version.py
        working-directory: scripts
        shell: bash
        env:
          PIP_BREAK_SYSTEM_PACKAGES: ${{ matrix.mac_env && '1' || '' }}

      - name: Create Node.js source distribution
        if: ${{ matrix.platform != 'win32' }}
        working-directory: tools/nodejs_api
        run: |
          rm -rf lbug-source.tar.gz package *.node
          node package

      - name: Extract tarball
        if: ${{ matrix.platform != 'win32' }}
        working-directory: tools/nodejs_api
        run: tar -xvzf lbug-source.tar.gz

      - name: Install Node.js dependencies (non-Windows)
        if: ${{ matrix.platform != 'win32' }}
        working-directory: tools/nodejs_api/package
        run: npm i --ignore-scripts
        env:
          CMAKE_C_COMPILER_LAUNCHER: ccache
          CMAKE_CXX_COMPILER_LAUNCHER: ccache
          MACOSX_DEPLOYMENT_TARGET: ${{ matrix.mac_env && '13.3' || '' }}
          ARCHFLAGS: ${{ matrix.mac_env && format('-arch {0}', matrix.arch) || '' }}

      - name: Install Node.js dependencies (non-Windows, tests)
        if: ${{ matrix.platform != 'win32' }}
        working-directory: tools/nodejs_api
        run: npm i --ignore-scripts

      - name: Install Node.js dependencies (Windows)
        if: ${{ matrix.platform == 'win32' }}
        working-directory: tools/nodejs_api
        run: npm i --ignore-scripts

      - name: Setup ccache (Linux/macOS)
        if: ${{ matrix.platform != 'win32' }}
        uses: hendrikmuhs/ccache-action@v1.2
        with:
          key: nodejs-${{ runner.os }}-${{ matrix.arch }}-${{ github.ref }}
          max-size: 2G
          restore-keys: |
            nodejs-${{ runner.os }}-${{ matrix.arch }}-refs/heads/main
            nodejs-${{ runner.os }}-${{ matrix.arch }}-

      - name: Enable long paths (Windows)
        if: ${{ matrix.platform == 'win32' }}
        run: |
          New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
          git config --system core.longpaths true
        shell: pwsh

      - name: Build Node.js native module (Windows)
        if: ${{ matrix.platform == 'win32' }}
        shell: cmd
        run: |
          choco install ccache -y
          echo CMAKE_C_COMPILER_LAUNCHER=ccache>> %GITHUB_ENV%
          echo CMAKE_CXX_COMPILER_LAUNCHER=ccache>> %GITHUB_ENV%
          echo CCACHE_DIR=D:\c>> %GITHUB_ENV%
          echo CCACHE_TEMPDIR=D:\t>> %GITHUB_ENV%
          if not exist D:\c mkdir D:\c
          if not exist D:\t mkdir D:\t
          ccache --set-config=max_size=2G
          ccache --set-config=compression=true
          ccache --set-config=cache_dir=D:\c
          ccache --set-config=temporary_dir=D:\t
        env:
          CMAKE_C_COMPILER_LAUNCHER: ccache
          CMAKE_CXX_COMPILER_LAUNCHER: ccache

      - name: Cache ccache directory (Windows)
        if: ${{ matrix.platform == 'win32' }}
        uses: actions/cache@v4
        with:
          path: D:\c
          key: ${{ runner.os }}-ccache-node-${{ hashFiles('**/CMakeLists.txt', '**/*.cpp', '**/*.h', 'tools/nodejs_api/**') }}
          restore-keys: |
            ${{ runner.os }}-ccache-node-

      - name: Build Node.js native module with ccache (Windows)
        if: ${{ matrix.platform == 'win32' }}
        shell: cmd
        env:
          EXTRA_CMAKE_FLAGS: -DBUILD_LBUG=FALSE -DBUILD_SHELL=FALSE -DLBUG_API_USE_PRECOMPILED_LIB=TRUE -DLBUG_API_PRECOMPILED_LIB_PATH=${{ env.LBUG_NODEJS_PRECOMPILED_LIB_PATH }}
        run: |
          powershell.exe -Command "Add-MpPreference -ExclusionPath '${{ github.workspace }}'"
          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
          ccache -s
          make GEN=Ninja nodejs
          ccache -s

      - name: Build Node.js native module (non-Windows)
        if: ${{ matrix.platform != 'win32' }}
        env:
          CMAKE_C_COMPILER_LAUNCHER: ccache
          CMAKE_CXX_COMPILER_LAUNCHER: ccache
          LDFLAGS: ${{ matrix.platform == 'linux' && '-static-libstdc++' || '' }}
        run: |
          export EXTRA_CMAKE_FLAGS="-DBUILD_LBUG=FALSE -DBUILD_SHELL=FALSE -DLBUG_API_USE_PRECOMPILED_LIB=TRUE -DLBUG_API_PRECOMPILED_LIB_PATH=${LBUG_NODEJS_PRECOMPILED_LIB_PATH}"
          ccache -s
          make GEN=Ninja nodejs
          ccache -s

      - name: Download built extensions for tests
        if: ${{ inputs.useBuiltExtensions == true }}
        uses: actions/download-artifact@v4
        with:
          name: lbug-extensions
          path: nodejs-extension-repo

      - name: Start built extension repository for tests (non-Windows)
        if: ${{ inputs.useBuiltExtensions == true && matrix.platform != 'win32' }}
        shell: bash
        run: |
          set -euo pipefail
          mkdir -p nodejs-extension-server
          cp -R nodejs-extension-repo/releases/. nodejs-extension-server/
          if [ -d nodejs-extension-repo/dataset ]; then
            cp -R nodejs-extension-repo/dataset nodejs-extension-server/dataset
          fi
          extension_server="$PWD/nodejs-extension-server"
          python3 -m http.server 8000 --bind 127.0.0.1 --directory "$extension_server" > nodejs-extension-server.log 2>&1 &
          case "${{ matrix.platform }}-${{ matrix.arch }}" in
            darwin-x64) platform_dir="osx_amd64" ;;
            darwin-arm64) platform_dir="osx_arm64" ;;
            linux-x64) platform_dir="linux_amd64" ;;
            linux-arm64) platform_dir="linux_arm64" ;;
            *) echo "Unsupported extension test platform: ${{ matrix.platform }}-${{ matrix.arch }}" && exit 1 ;;
          esac
          extension_version="$(grep 'DLBUG_EXTENSION_VERSION' CMakeLists.txt | cut -d '"' -f 2)"
          extension_url="http://127.0.0.1:8000/v${extension_version}/${platform_dir}/json/libjson.lbug_extension"
          for _ in {1..10}; do
            if curl --fail --silent --show-error --noproxy '*' "$extension_url" >/dev/null; then
              exit 0
            fi
            sleep 1
          done
          cat nodejs-extension-server.log
          exit 1

      - name: Start built extension repository for tests (Windows)
        if: ${{ inputs.useBuiltExtensions == true && matrix.platform == 'win32' }}
        shell: pwsh
        run: |
          New-Item -ItemType Directory -Force -Path nodejs-extension-server
          Copy-Item -Recurse nodejs-extension-repo\releases\* nodejs-extension-server\
          if (Test-Path nodejs-extension-repo\dataset) {
            Copy-Item -Recurse nodejs-extension-repo\dataset nodejs-extension-server\dataset
          }
          $extensionServer = Join-Path $PWD "nodejs-extension-server"
          Start-Process -FilePath python -ArgumentList "-m", "http.server", "8000", "--bind", "127.0.0.1", "--directory", $extensionServer -WindowStyle Hidden
          $platform = "win_amd64"
          $extensionVersion = (Select-String -Path CMakeLists.txt -Pattern 'DLBUG_EXTENSION_VERSION="([^"]+)"').Matches[0].Groups[1].Value
          $url = "http://127.0.0.1:8000/v$extensionVersion/$platform/json/libjson.lbug_extension"
          for ($i = 0; $i -lt 10; $i++) {
            try {
              Invoke-WebRequest -UseBasicParsing -Uri $url -TimeoutSec 2 | Out-Null
              exit 0
            } catch {
              Start-Sleep -Seconds 1
            }
          }
          Invoke-WebRequest -UseBasicParsing -Uri $url -TimeoutSec 2

      - name: Use built extension repository in Node.js tests
        if: ${{ inputs.useBuiltExtensions == true }}
        shell: bash
        run: |
          sed -i.bak "s|INSTALL JSON|INSTALL JSON FROM 'http://127.0.0.1:8000/'|" tools/nodejs_api/test/test_data_type.js

      - name: Run Node.js tests
        working-directory: tools/nodejs_api
        run: npm test

      - name: Move Node.js native module (Linux)
        if: ${{ matrix.platform == 'linux' }}
        working-directory: tools/nodejs_api
        run: mv build/lbugjs.node ${{ matrix.node_name }}

      - name: Move Node.js native module (Mac)
        if: ${{ matrix.platform == 'darwin' }}
        working-directory: tools/nodejs_api
        run: mv build/lbugjs.node ${{ matrix.node_name }}

      - name: Move Node.js native module (Windows)
        if: ${{ matrix.platform == 'win32' }}
        working-directory: tools/nodejs_api/build
        run: ren lbugjs.node ${{ matrix.node_name }}
        shell: cmd

      - uses: actions/upload-artifact@v4
        with:
          name: ${{ format('{0}{1}', matrix.artifact_name, inputs.artifactSuffix) }}
          path: tools/nodejs_api/${{ matrix.platform == 'win32' && 'build/' || '' }}${{ matrix.node_name }}

      - name: Clean up
        if: ${{ matrix.platform == 'darwin' }}
        working-directory: tools/nodejs_api/
        run: rm -rf package