[EngSys] Convert GitHub actions to ESM, add placeholder tests (#32376)

- Convert all actions to ESM
- Add placeholder tests for actions
- Add vitest to package.json
- Rename and move update-labels JS

Author: mikeharder

.github/actions/setup-node-install-deps/action.yaml

@@ -0,0 +1,37 @@
+name: Setup Node and install dependencies
+description: Uses specified Node version and installs dependencies (typically using "npm")
+
+inputs:
+  node-version:
+    description: 'Node version to use'
+    default: 22.x
+  install-command:
+    description: 'Command to install dependencies'
+    default: 'npm ci'
+  working-directory:
+    description: 'Working directory'
+    default: '.'
+
+runs:
+  using: "composite"
+
+  steps:
+    - uses: actions/setup-node@v4
+      with:
+        node-version: ${{ inputs.node-version }}
+
+    - run: |
+        echo "::group::$INSTALL_COMMAND"
+        $INSTALL_COMMAND
+        echo "::endgroup::"
+      shell: bash
+      env:
+        INSTALL_COMMAND: ${{ inputs.install-command }}
+      working-directory: ${{ inputs.working-directory }}
+
+    - run: |
+        echo "::group::npm ls -a"
+        npm ls -a || true
+        echo "::endgroup::"
+      shell: bash
+      working-directory: ${{ inputs.working-directory }}

.github/actions/setup-node-npm-ci/action.yaml

@@ -20,7 +20,7 @@ runs:
   using: composite
 
   steps:
-    - name: Set Label
+    - name: Update Labels
       uses: actions/github-script@v7
       env:
         OWNER: ${{ inputs.owner }}
@@ -29,5 +29,6 @@ runs:
         RUN_ID: ${{ inputs.run_id }}
       with:
         script: |
-          const action = require('./.github/actions/update-labels/action.js')
-          await action({ github, context, core });
+          const { default: updateLabels } =
+            await import('${{ github.workspace }}/.github/actions/update-labels/src/update-labels.js');
+          await updateLabels({ github, context, core });

.github/actions/update-labels/action.yaml

@@ -1,11 +1,11 @@
 // @ts-check
 
-const { extractInputs } = require("../context");
+import { extractInputs } from "../../../src/context.js";
 
 /**
  * @param {import('github-script').AsyncFunctionArguments} AsyncFunctionArguments
  */
-module.exports = async ({ github, context, core }) => {
+export default async function updateLabels({ github, context, core }) {
   let owner = process.env.OWNER;
   let repo = process.env.REPO;
   let issue_number = parseInt(process.env.ISSUE_NUMBER || "");
@@ -82,7 +82,7 @@ module.exports = async ({ github, context, core }) => {
   }
 
   if (labelsToRemove.length > 0) {
-    // Must loop over labelsToRemove ourselves, since GitHub doesn't expose a REST API to remove in bulk. 
+    // Must loop over labelsToRemove ourselves, since GitHub doesn't expose a REST API to remove in bulk.
     for (const name of labelsToRemove) {
       try {
         await github.rest.issues.removeLabel({
@@ -100,4 +100,4 @@ module.exports = async ({ github, context, core }) => {
       }
     }
   }
-};
+}

.github/actions/update-labels/action.js renamed to .github/actions/update-labels/src/update-labels.js

@@ -0,0 +1,11 @@
+import { describe, expect, it } from "vitest";
+import updateLabels from "../src/update-labels.js";
+
+describe("update-labels", () => {
+  // TODO: Replace with better tests
+  it("throws if inputs null", async () => {
+    await expect(
+      updateLabels({ github: null, context: null, core: null }),
+    ).rejects.toThrow();
+  });
+});

.github/actions/update-labels/test/update-labels.test.js

@@ -1,8 +1,15 @@
 {
+  "type": "module",
   "devDependencies": {
     "@types/node": "^20.0.0",
     "@types/github-script": "github:actions/github-script",
     "@octokit/webhooks-types": "^7.5.1",
-    "prettier": "^3.3.3"
+    "@vitest/coverage-v8": "^3.0.2",
+    "prettier": "^3.3.3",
+    "vitest": "^3.0.4"
+  },
+  "scripts": {
+    "test": "vitest",
+    "test:ci": "vitest run --coverage --reporter=verbose"
   }
 }

.github/package.json

@@ -3,13 +3,13 @@
 /**
  * Extracts inputs from context based on event name and properties.
  * run_id is only defined for "workflow_run:completed" events.
- * 
+ *
  * @param {import('github-script').AsyncFunctionArguments['github']} github
  * @param {import('github-script').AsyncFunctionArguments['context']} context
  * @param {import('github-script').AsyncFunctionArguments['core']} core
  * @returns {Promise<{owner: string, repo: string, head_sha: string, issue_number: number, run_id: number }>}
  */
-async function extractInputs(github, context, core) {
+export async function extractInputs(github, context, core) {
   core.info(`extractInputs(${context.eventName}, ${context.payload.action})`);
 
   // Add support for more event types as needed
@@ -24,11 +24,11 @@ async function extractInputs(github, context, core) {
       repo: payload.repository.name,
       head_sha: payload.pull_request.head.sha,
       issue_number: payload.number,
-      run_id: NaN
+      run_id: NaN,
     };
-  
+
     core.info(`inputs: ${JSON.stringify(inputs)}`);
-  
+
     return inputs;
   } else if (
     context.eventName === "workflow_run" &&
@@ -91,5 +91,3 @@ async function extractInputs(github, context, core) {
     );
   }
 }
-
-module.exports = { extractInputs };

.github/actions/context.js renamed to .github/src/context.js

@@ -0,0 +1,9 @@
+import { describe, expect, it } from "vitest";
+import { extractInputs } from "../src/context.js";
+
+describe("context", () => {
+  // TODO: Replace with better tests
+  it("throws if inputs null", async () => {
+    await expect(extractInputs(null, null, null)).rejects.toThrow();
+  });
+});

.github/test/context.test.js

@@ -20,8 +20,8 @@ jobs:
           # Required since "HEAD^" is passed to Get-ChangedFiles
           fetch-depth: 2
 
-      - name: Setup Node and run `npm ci`
-        uses: ./.github/actions/setup-node-npm-ci
+      - name: Setup Node and install deps
+        uses: ./.github/actions/setup-node-install-deps
 
       - name: Get GitHub PullRequest Changed Files
         shell: pwsh

.github/workflows/SDK-Suppressions-Label.yaml

@@ -46,8 +46,8 @@ jobs:
             eng
             ${{ inputs.sparse-checkout-paths }}
 
-      - name: Setup Node ${{ matrix.node-version }} and run `npm ci`
-        uses: ./.github/actions/setup-node-npm-ci
+      - name: Setup Node ${{ matrix.node-version }} and install deps
+        uses: ./.github/actions/setup-node-install-deps
         with:
           node-version: ${{ matrix.node-version }}.x