ci: add packaging test workflow

Author: taeold

.github/workflows/packaging.yaml

@@ -0,0 +1,47 @@
+name: Packaging Tests
+
+on:
+  - pull_request
+  - push
+
+env:
+  CI: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 22.x
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+      - run: npm pack
+      - name: Upload tarball
+        uses: actions/upload-artifact@v4
+        with:
+          name: package-tarball
+          path: firebase-functions-*.tgz
+
+  verify:
+    needs: build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 18.x
+          - 20.x
+          - 22.x
+          - 24.x
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Download tarball
+        uses: actions/download-artifact@v4
+        with:
+          name: package-tarball
+      - run: chmod +x ./scripts/test-packaging.sh && ./scripts/test-packaging.sh firebase-functions-*.tgz

scripts/test-packaging.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+set -eux
+
+# Argument 1: Path to a pre-built tarball.
+# If not provided, the script will run 'npm run build' and 'npm pack' locally.
+PREBUILT_TARBALL="$1"
+
+# Setup cleanup
+WORK_DIR=$(mktemp -d)
+function cleanup {
+  rm -rf "$WORK_DIR"
+  echo "Deleted temp working directory $WORK_DIR"
+}
+trap cleanup EXIT
+
+# Save current directory to resolve relative paths later
+START_DIR="$(pwd)"
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+if [ -n "$PREBUILT_TARBALL" ]; then
+  echo "Using prebuilt tarball: $PREBUILT_TARBALL"
+  # Resolve absolute path if it's relative
+  if [[ "$PREBUILT_TARBALL" != /* ]]; then
+    PREBUILT_TARBALL="$START_DIR/$PREBUILT_TARBALL"
+  fi
+  TARBALL_PATH="$PREBUILT_TARBALL"
+else
+  echo "Building project..."
+  cd "$SCRIPT_DIR/.."
+  npm run build
+
+  echo "Packing project..."
+  TARBALL=$(npm pack)
+  mv "$TARBALL" "$WORK_DIR/"
+  TARBALL_PATH="$WORK_DIR/$TARBALL"
+fi
+
+echo "Setting up test project in $WORK_DIR..."
+pushd "$WORK_DIR" > /dev/null
+npm init -y > /dev/null
+npm install "$TARBALL_PATH" > /dev/null
+
+echo "Running verification script..."
+cp "$SCRIPT_DIR/verify-exports.mjs" .
+node verify-exports.mjs
+
+popd > /dev/null

scripts/verify-exports.mjs

@@ -0,0 +1,57 @@
+import fs from 'fs';
+import path from 'path';
+import { createRequire } from 'module';
+
+const require = createRequire(import.meta.url);
+
+// Read the package.json of the INSTALLED package to verify what was actually packed
+const pkgPath = path.resolve(process.cwd(), 'node_modules/firebase-functions/package.json');
+if (!fs.existsSync(pkgPath)) {
+  console.error(`❌ Could not find installed package at ${pkgPath}`);
+  process.exit(1);
+}
+
+const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+const exports = Object.keys(pkg.exports || {});
+
+// Filter out non-code entrypoints (e.g. package.json if it were exported)
+const entryPoints = exports.filter(e => !e.endsWith('.json'));
+
+console.log(`Found ${entryPoints.length} entry points to verify.`);
+
+let hasError = false;
+
+async function verify() {
+  console.log('\n--- Verifying CommonJS (require) ---');
+  for (const exp of entryPoints) {
+    const importPath = exp === '.' ? 'firebase-functions' : `firebase-functions/${exp.replace('./', '')}`;
+    try {
+      require(importPath);
+      console.log(`✅ CJS: ${importPath}`);
+    } catch (e) {
+      console.error(`❌ CJS Failed: ${importPath}`, e.message);
+      hasError = true;
+    }
+  }
+
+  console.log('\n--- Verifying ES Modules (import) ---');
+  for (const exp of entryPoints) {
+    const importPath = exp === '.' ? 'firebase-functions' : `firebase-functions/${exp.replace('./', '')}`;
+    try {
+      await import(importPath);
+      console.log(`✅ ESM: ${importPath}`);
+    } catch (e) {
+      console.error(`❌ ESM Failed: ${importPath}`, e.message);
+      hasError = true;
+    }
+  }
+
+  if (hasError) {
+    console.error('\n❌ Verification failed with errors.');
+    process.exit(1);
+  } else {
+    console.log('\n✨ All entry points verified successfully!');
+  }
+}
+
+verify();