chore(github): add a fuller smoke test to CI checks

Author: JamieMason

.github/workflows/ci.yaml

@@ -11,8 +11,8 @@ on:
       - v14-alpha
 
 jobs:
-  lint-and-test:
-    name: Lint and test
+  build-for-npm:
+    name: Build packages
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
@@ -26,10 +26,18 @@ jobs:
           components: rustfmt, clippy
       - name: Set up cargo cache
         uses: Swatinem/rust-cache@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+      - name: Install npm dependencies
+        run: npm install
       - name: Install just
         uses: extractions/setup-just@v1
         with:
           just-version: 1.35.0
+      - name: Install jq
+        run: sudo apt-get update && sudo apt-get install -y jq
       - name: Check cargo
         run: just check-cargo
       - name: Lint formatting
@@ -38,3 +46,34 @@ jobs:
         run: just check-clippy
       - name: Cargo test
         run: just test
+      - name: Build npm packages
+        run: just build-for-platform linux-x64-glibc
+      - name: Upload npm packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: npm-packages
+          path: npm/
+
+  smoke-test:
+    name: Smoke Test Node.js ${{ matrix.node-version }})
+    runs-on: ubuntu-22.04
+    needs: build-for-npm
+    strategy:
+      matrix:
+        node-version: [16, 18, 20, 22]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Download npm packages
+        uses: actions/download-artifact@v4
+        with:
+          name: npm-packages
+          path: npm/
+      - name: Smoke test
+        run: |
+          cd fixtures/fluid-framework
+          ../../npm/packages/syncpack/index.cjs --dependencies jest

.github/workflows/matrix.json

@@ -2,37 +2,31 @@
   {
     "NAME": "linux-x64-glibc",
     "OS": "ubuntu-22.04",
-    "RUN_LOCALLY": true,
     "TARGET": "x86_64-unknown-linux-gnu"
   },
   {
     "NAME": "linux-arm64-glibc",
     "OS": "ubuntu-22.04",
-    "RUN_LOCALLY": false,
     "TARGET": "aarch64-unknown-linux-gnu"
   },
   {
     "NAME": "win32-x64-msvc",
     "OS": "windows-2022",
-    "RUN_LOCALLY": false,
     "TARGET": "x86_64-pc-windows-msvc"
   },
   {
     "NAME": "win32-arm64-msvc",
     "OS": "windows-2022",
-    "RUN_LOCALLY": false,
     "TARGET": "aarch64-pc-windows-msvc"
   },
   {
     "NAME": "darwin-x64",
     "OS": "macos-13",
-    "RUN_LOCALLY": false,
     "TARGET": "x86_64-apple-darwin"
   },
   {
     "NAME": "darwin-arm64",
     "OS": "macos-13",
-    "RUN_LOCALLY": false,
     "TARGET": "aarch64-apple-darwin"
   }
 ]

justfile

@@ -7,6 +7,14 @@ no_pattern := ""
 default:
     just --list
 
+# List all available platforms from matrix.json
+list-platforms:
+    #!/usr/bin/env bash
+    set -euxo pipefail
+
+    echo "Available platforms:"
+    cat .github/workflows/matrix.json | jq -r '.[] | "\(.NAME) (target: \(.TARGET), os: \(.OS))"'
+
 # ==============================================================================
 # Onboarding
 # ==============================================================================
@@ -162,36 +170,70 @@ watch-fluid:
 # Build
 # ==============================================================================
 
-# Build the npm package and rust binary package for mac
-build-local:
+
+
+# Build the npm package and rust binary package for a specific platform
+build-for-platform name:
     #!/usr/bin/env bash
     set -euxo pipefail
 
+    # Read platform details from matrix.json
+    PLATFORM_JSON=$(cat .github/workflows/matrix.json | jq -r --arg name "{{name}}" '.[] | select(.NAME == $name)')
+
+    if [ -z "$PLATFORM_JSON" ]; then
+        echo "Platform '{{name}}' not found in matrix.json"
+        exit 1
+    fi
+
+    TARGET=$(echo "$PLATFORM_JSON" | jq -r '.TARGET')
+    OS=$(echo "$PLATFORM_JSON" | jq -r '.OS')
+
+    echo "Building for platform: {{name}}"
+    echo "Target: $TARGET"
+    echo "OS: $OS"
+
     rm -rf npm/packages
-    cargo build --release --locked --target x86_64-apple-darwin
-    just --dotenv-filename .env.darwin-x64 create-npm-binary-package
-    just --dotenv-filename .env.darwin-x64 create-npm-root-package
-    just patch-local
+    cargo build --release --locked --target "$TARGET"
+
+    # Set environment variables for npm package creation
+    export TARGET="$TARGET"
+    export NODE_PKG_NAME="syncpack-{{name}}"
+    export NODE_PKG_DIR_PATH="npm/packages/syncpack-{{name}}"
+    export RUST_BINARY_PATH="target/$TARGET/release/syncpack$(if [[ "$TARGET" == *"windows"* ]]; then echo ".exe"; fi)"
+    export NODE_PKG_RUST_BINARY_PATH="$NODE_PKG_DIR_PATH/bin/syncpack$(if [[ "$TARGET" == *"windows"* ]]; then echo ".exe"; fi)"
+    export NODE_OS=$(echo "{{name}}" | cut -d'-' -f1)
+    export NODE_ARCH=$(echo "{{name}}" | cut -d'-' -f2)
+    export NODE_ROOT_PKG_DIR_PATH="npm/packages/syncpack"
+
+    just create-npm-binary-package
+    just create-npm-root-package
+    just patch-for-platform {{name}}
     cd npm/packages/syncpack
     npm install
 
-# Modify the local package.json file to only have a mac optionalDependency
-patch-local:
+# Modify the local package.json file to only have the specified platform's optionalDependency
+patch-for-platform name:
     #!/usr/bin/env node
     const fs = require("fs");
     const path = require("path");
     const srcPath = path.resolve("npm/packages/syncpack/package.json");
     const pkg = require(srcPath);
+    const platformName = "{{name}}";
+    const optionalDepName = `syncpack-${platformName}`;
     const nextPkg = {
         ...pkg,
         optionalDependencies: {
-            "syncpack-darwin-x64": "file:../syncpack-darwin-x64"
+            [optionalDepName]: `file:../${optionalDepName}`
         }
     };
     const json = JSON.stringify(nextPkg, null, 2);
     console.log(json);
     fs.writeFileSync(srcPath, json);
 
+# Modify the local package.json file to only have a mac optionalDependency (legacy command)
+patch-local:
+    just patch-for-platform darwin-x64
+
 # Build a rust binary and corresponding npm package for a specific target
 build-binary-package:
     just create-rust-binary