[.github] type-check tests

.github/shared/src/exec.js

@@ -1,3 +1,3 @@
 import child_process from "child_process";
 import { dirname, join } from "path";
 import { promisify } from "util";
@@ -36,7 +36,7 @@
  * Wraps `child_process.execFile()`, adding logging and a larger default maxBuffer.
  *
  * @param {string} file
- * @param {string[]} args
+ * @param {string[]} [args]
  * @param {ExecOptions} [options]
  * @returns {Promise<ExecResult>}
  * @throws {ExecError}

.github/tsconfig.json

@@ -1,3 +1,3 @@
 // Only used for type-checking of JavaScript sources.  Folder should contain no TypeScript sources.
 {
   "extends": "@tsconfig/node20/tsconfig.json",
@@ -8,8 +8,4 @@
     "incremental": false,
     "noEmit": true,
   },
-  "include": [
-    // Only check runtime sources.  Tests currently have too many errors.
-    "**/src/**/*.js",
-  ],
 }

.github/vitest.config.js

@@ -1,16 +1,17 @@
 import { configDefaults, defineConfig } from "vitest/config";
 
 export default defineConfig({
   esbuild: {
     // Ignore tsconfig.json, since it's only used for type checking, and causes
     // a warning if vitest tries to load it
+    // @ts-expect-error: tsConfig' does not exist in type 'ESBuildOptions'
     tsConfig: false,
   },
 
   test: {
     coverage: {
       exclude: [
-        ...configDefaults.coverage.exclude,
+        ...(configDefaults.coverage.exclude ?? []),
 
         // Not worth testing CLI code
         "**/cmd/**",

.github/workflows/test/arm-auto-signoff.test.js

@@ -1,3 +1,3 @@
 import { describe, expect, it } from "vitest";
 import { CommitStatusState } from "../../shared/src/github.js";
 import { getLabelActionImpl } from "../src/arm-auto-signoff.js";
@@ -43,7 +43,9 @@
 
 describe("getLabelActionImpl", () => {
   it("throws if inputs null", async () => {
-    await expect(getLabelActionImpl({})).rejects.toThrow();
+    await expect(
+      getLabelActionImpl(/** @type {Parameters<typeof getLabelActionImpl>[0]} */ ({})),
+    ).rejects.toThrow();
   });
 
   it("throws if no artifact from incremental typespec", async () => {

.github/workflows/test/arm-incremental-typespec.test.js

@@ -1,3 +1,3 @@
 import { relative, resolve } from "path";
 import { afterEach, describe, expect, it, vi } from "vitest";
 import { repoRoot } from "../../shared/test/repo.js";
@@ -16,11 +16,20 @@
   swaggerHandWritten,
   swaggerTypeSpecGenerated,
 } from "../../shared/test/examples.js";
-import incrementalTypeSpec from "../src/arm-incremental-typespec.js";
+import incrementalTypeSpecImpl from "../src/arm-incremental-typespec.js";
 import { createMockCore } from "./mocks.js";
 
 const core = createMockCore();
 
+/**
+ * @param {unknown} asyncFunctionArgs
+ */
+function incrementalTypeSpec(asyncFunctionArgs) {
+  return incrementalTypeSpecImpl(
+    /** @type {import("@actions/github-script").AsyncFunctionArguments} */ (asyncFunctionArgs),
+  );
+}
+
 describe("incrementalTypeSpec", () => {
   afterEach(() => {
     vi.clearAllMocks();
@@ -131,8 +140,27 @@
 
     const showSpy = vi
       .mocked(simpleGit.simpleGit().show)
-      .mockImplementation(async ([treePath]) =>
-        treePath.split(":")[0] == "HEAD" ? swaggerTypeSpecGenerated : swaggerHandWritten,
+      .mockImplementation(
+        (
+          /** @type {import("simple-git").SimpleGitTaskCallback|string|string[]|undefined} */ optionsOrCallback,
+        ) => {
+          /** @type {string} */
+          let option;
+
+          if (Array.isArray(optionsOrCallback)) {
+            option = optionsOrCallback[0];
+          } else if (typeof optionsOrCallback === "string") {
+            option = optionsOrCallback;
+          } else {
+            throw new Error(`Unexpected argument: ${optionsOrCallback}`);
+          }
+
+          return /** @type {import("simple-git").Response<string>} */ (
+            Promise.resolve(
+              option?.split(":")[0] == "HEAD" ? swaggerTypeSpecGenerated : swaggerHandWritten,
+            )
+          );
+        },
       );
 
     const lsTreeSpy = vi.mocked(simpleGit.simpleGit().raw).mockResolvedValue(swaggerPath);
@@ -199,16 +227,37 @@
 
     vi.spyOn(changedFiles, "getChangedFiles").mockResolvedValue([readmePath]);
 
-    const showSpy = vi.mocked(simpleGit.simpleGit().show).mockImplementation(async ([treePath]) => {
-      const path = treePath.split(":")[1];
-      if (path === swaggerPath) {
-        return swaggerTypeSpecGenerated;
-      } else if (path === readmePath) {
-        return contosoReadme;
-      } else {
-        throw new Error("does not exist");
-      }
-    });
+    const showSpy = vi
+      .mocked(simpleGit.simpleGit().show)
+      .mockImplementation(
+        (
+          /** @type {import("simple-git").SimpleGitTaskCallback|string|string[]|undefined} */ optionsOrCallback,
+        ) => {
+          /** @type {string} */
+          let option;
+
+          if (Array.isArray(optionsOrCallback)) {
+            option = optionsOrCallback[0];
+          } else if (typeof optionsOrCallback === "string") {
+            option = optionsOrCallback;
+          } else {
+            throw new Error(`Unexpected argument: ${optionsOrCallback}`);
+          }
+
+          const path = option.split(":")[1];
+          if (path === swaggerPath) {
+            return /** @type {import("simple-git").Response<string>} */ (
+              Promise.resolve(swaggerTypeSpecGenerated)
+            );
+          } else if (path === readmePath) {
+            return /** @type {import("simple-git").Response<string>} */ (
+              Promise.resolve(contosoReadme)
+            );
+          } else {
+            throw new Error("does not exist");
+          }
+        },
+      );
 
     const lsTreeSpy = vi.mocked(simpleGit.simpleGit().raw).mockResolvedValue(swaggerPath);
 

.github/workflows/test/artifacts.test.js

@@ -1,3 +1,3 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import {
   fetchFailedArtifact,
@@ -12,7 +12,8 @@
 }));
 
 // Mock global fetch
-global.fetch = vi.fn();
+const mockFetch = vi.fn();
+global.fetch = mockFetch;
 const mockCore = createMockCore();
 
 describe("getAzurePipelineArtifact function", () => {
@@ -78,7 +79,7 @@
     };
 
     // Setup fetch to capture headers and return appropriate responses
-    global.fetch.mockImplementation((url, options) => {
+    mockFetch.mockImplementation((url, options) => {
       // For all calls, verify the headers include the authorization token
       if (options && options.headers) {
         expect(options.headers).toEqual(expectedHeaders);
@@ -152,7 +153,7 @@
     };
 
     // Setup fetch with a spy to capture the headers
-    global.fetch.mockImplementation((url, options) => {
+    mockFetch.mockImplementation((url, options) => {
       if (url.includes("artifacts?artifactName=")) {
         // Verify headers contain Authorization
         expect(options.headers).toHaveProperty("Authorization", `Bearer ${testToken}`);
@@ -189,7 +190,7 @@
 
   it("should handle API failure", async () => {
     // Mock fetch failure
-    global.fetch.mockResolvedValue({
+    mockFetch.mockResolvedValue({
       ok: false,
       status: 500,
       statusText: "Server Error",
@@ -216,7 +217,7 @@
 
   it("should complete without op when artifact does not exist", async () => {
     // Mock fetch failure
-    global.fetch.mockResolvedValue({
+    mockFetch.mockResolvedValue({
       ok: false,
       status: 404,
       statusText: "Not Found",
@@ -289,7 +290,7 @@
     };
 
     // Setup fetch to return different responses based on the URL
-    global.fetch.mockImplementation((url) => {
+    mockFetch.mockImplementation((url) => {
       // First attempted artifact request with 404
       if (url.includes(`artifacts?artifactName=${inputs.artifactName}&api-version=7.0`)) {
         return mockInitialResponse;
@@ -340,7 +341,7 @@
     };
 
     // Setup fetch to return different responses for each call
-    global.fetch.mockImplementation((url) => {
+    mockFetch.mockImplementation((url) => {
       if (url.includes("artifacts?artifactName=")) {
         return mockArtifactResponse;
       }
@@ -368,7 +369,7 @@
     };
 
     // Setup fetch to return different responses for each call
-    global.fetch.mockImplementation((url) => {
+    mockFetch.mockImplementation((url) => {
       if (url.includes("artifacts?artifactName=")) {
         return mockArtifactResponse;
       }
@@ -408,7 +409,7 @@
     };
 
     // Setup fetch to return different responses for each call
-    global.fetch.mockImplementation((url) => {
+    mockFetch.mockImplementation((url) => {
       if (url.includes("artifacts?artifactName=")) {
         return mockArtifactResponse;
       } else {
@@ -430,7 +431,7 @@
 
   it("should handle exception during processing", async () => {
     // Mock fetch to throw an error
-    global.fetch.mockImplementation(() => {
+    mockFetch.mockImplementation(() => {
       throw new Error("Network error");
     });
 
@@ -473,7 +474,7 @@
     };
 
     // Setup fetch to return different responses for each call
-    global.fetch.mockImplementation((url) => {
+    mockFetch.mockImplementation((url) => {
       if (url.includes("artifacts?artifactName=")) {
         return mockArtifactResponse;
       } else {
@@ -587,7 +588,7 @@
     };
 
     // Setup fetch with a spy to capture the headers
-    global.fetch.mockImplementation((url, options) => {
+    mockFetch.mockImplementation((url, options) => {
       // Verify that the custom headers are included in all requests
       expect(options.headers).toEqual(customHeaders);
 
@@ -654,7 +655,7 @@
     };
 
     // Setup fetch to return different responses for each call
-    global.fetch.mockImplementation((url) => {
+    mockFetch.mockImplementation((url) => {
       if (url.includes("artifacts?api-version")) {
         return mockListResponse;
       } else if (url.includes("artifactName=spec-gen-sdk-artifact-FailedAttempt2")) {
@@ -689,7 +690,7 @@
       statusText: "OK",
     };
 
-    global.fetch.mockResolvedValue(mockListResponse);
+    mockFetch.mockResolvedValue(mockListResponse);
 
     // Call the function and expect it to return a 404 response
     const response = await fetchFailedArtifact(defaultParams);
@@ -708,7 +709,7 @@
       statusText: "Internal Server Error",
     };
 
-    global.fetch.mockResolvedValue(mockErrorResponse);
+    mockFetch.mockResolvedValue(mockErrorResponse);
 
     // Call the function and expect it to throw
     await expect(fetchFailedArtifact(defaultParams)).rejects.toThrow(
@@ -751,7 +752,7 @@
     };
 
     // Setup fetch to return different responses for each call
-    global.fetch.mockImplementation((url) => {
+    mockFetch.mockImplementation((url) => {
       if (url.includes("artifacts?api-version")) {
         return mockListResponse;
       } else if (url.includes("artifactName=spec-gen-sdk-artifact-FailedAttempt3")) {

.github/workflows/test/avocado-code.test.js

@@ -1,3 +1,3 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 // Mock fs/promises before imports
@@ -5,10 +5,9 @@
 
 import * as fs from "fs/promises";
 
-/** @type {import("vitest").Mock} */
-const readFileMock = fs.readFile;
+const readFileMock = /** @type {import("vitest").Mock} */ (fs.readFile);
 
-import generateJobSummary from "../src/avocado-code.js";
+import generateJobSummaryImpl from "../src/avocado-code.js";
 import { MessageLevel, MessageType } from "../src/message.js";
 import { stringify } from "../src/ndjson.js";
 import { createMockCore } from "./mocks.js";
@@ -17,6 +16,15 @@
 const outputFile = "avocado.ndjson";
 
 describe("generateJobSummary", () => {
+  /**
+   * @param {unknown} asyncFunctionArgs
+   */
+  function generateJobSummary(asyncFunctionArgs) {
+    return generateJobSummaryImpl(
+      /** @type {import("@actions/github-script").AsyncFunctionArguments} */ (asyncFunctionArgs),
+    );
+  }
+
   beforeEach(() => {
     vi.stubEnv("AVOCADO_OUTPUT_FILE", outputFile);
     readFileMock.mockReset();
@@ -31,7 +39,9 @@
       `[Error: Env var AVOCADO_OUTPUT_FILE must be set]`,
     );
 
-    expect(core.info.mock.calls.at(-1)[0]).toMatchInlineSnapshot(`"avocadoOutputFile: undefined"`);
+    expect(core.info.mock.calls.at(-1)?.[0]).toMatchInlineSnapshot(
+      `"avocadoOutputFile: undefined"`,
+    );
   });
 
   it("no-ops if file cannot be read", async () => {
@@ -41,7 +51,7 @@
 
     await expect(generateJobSummary({ core })).resolves.toBeUndefined();
 
-    expect(core.info.mock.calls.at(-1)[0]).toMatchInlineSnapshot(
+    expect(core.info.mock.calls.at(-1)?.[0]).toMatchInlineSnapshot(
       `"Error reading 'avocado.ndjson': Error: ENOENT: no such file or directory, open 'avocado.ndjson'"`,
     );
   });
@@ -51,7 +61,7 @@
 
     await expect(generateJobSummary({ core })).resolves.toBeUndefined();
 
-    expect(core.notice.mock.calls.at(-1)[0]).toMatchInlineSnapshot(
+    expect(core.notice.mock.calls.at(-1)?.[0]).toMatchInlineSnapshot(
       `"No messages in 'avocado.ndjson'"`,
     );
   });