[spec-gen-sdk-runner] Move SpecGenSdkArtifactInfo to .github/shared (#38816)

- Prepares to enable `typescript-eslint` in `.github`

Author: mikeharder

.github/shared/src/sdk-types.js

@@ -1,7 +1,43 @@
-/* v8 ignore start */
+import * as z from "zod";
 
 /**
- * @typedef {'azure-sdk-for-go' | 'azure-sdk-for-java' | 'azure-sdk-for-js' | 'azure-sdk-for-net' | 'azure-sdk-for-python'} SdkName
+ * Represents supported SDK language identifiers.
+ *
+ * @readonly
+ * @enum {"azure-sdk-for-go" | "azure-sdk-for-java" | "azure-sdk-for-js" | "azure-sdk-for-net" | "azure-sdk-for-python"}
+ */
+export const SdkName = Object.freeze({
+  Go: "azure-sdk-for-go",
+  Java: "azure-sdk-for-java",
+  Js: "azure-sdk-for-js",
+  Net: "azure-sdk-for-net",
+  Python: "azure-sdk-for-python",
+});
+/** @type {import("zod").ZodType<SdkName>} */
+export const SdkNameSchema = z.enum(Object.values(SdkName));
+
+/*
+ * Data for the API view request.
+ */
+export const APIViewRequestDataSchema = z.object({ packageName: z.string(), filePath: z.string() });
+/**
+ * @typedef {import("zod").infer<typeof APIViewRequestDataSchema>} APIViewRequestData
+ */
+
+/**
+ * Represents the result of the spec-gen-sdk generation process.
+ */
+export const SpecGenSdkArtifactInfoSchema = z.object({
+  language: SdkNameSchema,
+  result: z.string(),
+  headSha: z.string(),
+  prNumber: z.string().optional(),
+  labelAction: z.boolean().optional(),
+  isSpecGenSdkCheckRequired: z.boolean(),
+  apiViewRequestData: z.array(APIViewRequestDataSchema),
+});
+/**
+ * @typedef {import("zod").infer<typeof SpecGenSdkArtifactInfoSchema>} SpecGenSdkArtifactInfo
  */
 
 /**

.github/shared/test/sdk-types.js

@@ -0,0 +1,24 @@
+import { SdkName } from "../src/sdk-types.js";
+
+/**
+ * @typedef {import("../src/sdk-types.js").SpecGenSdkArtifactInfo} SpecGenSdkArtifactInfo
+ */
+
+/**
+ * Create a mock SpecGenSdkArtifactInfo, filling unspecified properties with defaults.
+ *
+ * @param {Partial<import("../src/sdk-types.js").SpecGenSdkArtifactInfo>} [overrides]
+ * @returns {SpecGenSdkArtifactInfo}
+ */
+export function createMockSpecGenSdkArtifactInfo(overrides = {}) {
+  /** @type {SpecGenSdkArtifactInfo} */
+  const defaults = {
+    apiViewRequestData: [],
+    headSha: "abc123",
+    isSpecGenSdkCheckRequired: true,
+    language: SdkName.Go,
+    result: "test result",
+  };
+
+  return { ...defaults, ...overrides };
+}

.github/shared/test/sdk-types.test.js

@@ -0,0 +1,22 @@
+import { describe, expect, it } from "vitest";
+import { sdkLabels, SpecGenSdkArtifactInfoSchema } from "../src/sdk-types.js";
+import { createMockSpecGenSdkArtifactInfo } from "./sdk-types.js";
+
+describe("sdk-types", () => {
+  it("defines sdkLabels", () => {
+    // Ensures constant "sdkLabels" is considered "covered" by codecov
+    expect(sdkLabels).toBeDefined();
+  });
+
+  it("parses SpecGetSdkArtifactInfo", () => {
+    const artifactInfo = createMockSpecGenSdkArtifactInfo();
+
+    const json = JSON.stringify(artifactInfo);
+    expect(json).toMatchInlineSnapshot(
+      `"{"apiViewRequestData":[],"headSha":"abc123","isSpecGenSdkCheckRequired":true,"language":"azure-sdk-for-go","result":"test result"}"`,
+    );
+
+    const parsed = SpecGenSdkArtifactInfoSchema.parse(JSON.parse(json));
+    expect(parsed).toEqual(artifactInfo);
+  });
+});

.github/workflows/src/sdk-breaking-change-labels.js

@@ -1,4 +1,4 @@
-import { sdkLabels } from "../../shared/src/sdk-types.js";
+import { SpecGenSdkArtifactInfoSchema, sdkLabels } from "../../shared/src/sdk-types.js";
 import { getAdoBuildInfoFromUrl, getAzurePipelineArtifact } from "./artifacts.js";
 import { extractInputs } from "./context.js";
 import { LabelAction } from "./label.js";
@@ -72,12 +72,14 @@ export async function getLabelAndActionImpl({ details_url, core, retryOptions =
   } else {
     core.info(`Artifact content: ${result.artifactData}`);
     // Parse the JSON data
-    const specGenSdkArtifactInfo = JSON.parse(result.artifactData);
+    const specGenSdkArtifactInfo = SpecGenSdkArtifactInfoSchema.parse(
+      JSON.parse(result.artifactData),
+    );
     const labelActionText = specGenSdkArtifactInfo.labelAction;
 
     head_sha = specGenSdkArtifactInfo.headSha;
 
-    issue_number = parseInt(specGenSdkArtifactInfo.prNumber, 10);
+    issue_number = parseInt(specGenSdkArtifactInfo.prNumber ?? "", 10);
     if (!issue_number) {
       core.warning(
         `No PR number found in the artifact '${artifactName}' with details_url:${details_url}.`,

.github/workflows/src/spec-gen-sdk-status.js

@@ -1,4 +1,5 @@
 import { CheckStatus, CommitStatusState, PER_PAGE_MAX } from "../../shared/src/github.js";
+import { SpecGenSdkArtifactInfoSchema } from "../../shared/src/sdk-types.js";
 import { getAdoBuildInfoFromUrl, getAzurePipelineArtifact } from "./artifacts.js";
 import { extractInputs } from "./context.js";
 import { writeToActionsSummary } from "./github.js";
@@ -122,7 +123,7 @@ export async function setSpecGenSdkStatusImpl({
 
 /**
  * @param {Object} params
- * @param {Array<any>} params.checkRuns
+ * @param {import("./github.js").CheckRuns} params.checkRuns
  * @param {typeof import("@actions/core")} params.core
  * @returns {Promise<{state: CommitStatusState, description: string}>}
  */
@@ -139,6 +140,9 @@ async function processResult({ checkRuns, core }) {
 
   for (const checkRun of checkRuns) {
     core.info(`Processing check run: ${checkRun.name} (${checkRun.conclusion})`);
+    if (checkRun.details_url === null) {
+      throw new Error(`'details_url' is null in Check Run '${checkRun.name}'`);
+    }
     const buildInfo = getAdoBuildInfoFromUrl(checkRun.details_url);
     const ado_project_url = buildInfo.projectUrl;
     const ado_build_id = buildInfo.buildId;
@@ -159,7 +163,8 @@ async function processResult({ checkRuns, core }) {
         `Artifact '${artifactName}' not found in the build with details_url:${checkRun.details_url}`,
       );
     }
-    const artifactJsonObj = JSON.parse(result.artifactData);
+
+    const artifactJsonObj = SpecGenSdkArtifactInfoSchema.parse(JSON.parse(result.artifactData));
     const language = artifactJsonObj.language;
     const shortLanguageName = language.split("-").pop();
     const executionResult = artifactJsonObj.result;

.github/workflows/test/sdk-breaking-change-labels.test.js

@@ -1,5 +1,6 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { sdkLabels } from "../../shared/src/sdk-types.js";
+import { createMockSpecGenSdkArtifactInfo } from "../../shared/test/sdk-types.js";
 import { LabelAction } from "../src/label.js";
 import {
   getLabelAndActionImpl,
@@ -12,9 +13,11 @@ vi.mock("../src/context.js", () => ({
   extractInputs: vi.fn(),
 }));
 
+/** @type {import('vitest').Mock<(url: string) => Promise<Partial<Response>>>} */
 const mockFetch = vi.fn();
+
 // Mock global fetch
-global.fetch = mockFetch;
+global.fetch = /** @type {import('vitest').MockedFunction<typeof fetch>} */ (mockFetch);
 
 const mockGithub = createMockGithub();
 const mockContext = createMockContext();
@@ -64,20 +67,22 @@ describe("sdk-breaking-change-labels", () => {
       const mockContentResponse = {
         ok: true,
         text: vi.fn().mockResolvedValue(
-          JSON.stringify({
-            labelAction: true,
-            language,
-            prNumber: "123",
-          }),
+          JSON.stringify(
+            createMockSpecGenSdkArtifactInfo({
+              labelAction: true,
+              language,
+              prNumber: "123",
+            }),
+          ),
         ),
       };
 
       // Setup fetch to return different responses for each call
       mockFetch.mockImplementation((url) => {
         if (url.includes("artifacts?artifactName=")) {
-          return mockArtifactResponse;
+          return Promise.resolve(mockArtifactResponse);
         } else {
-          return mockContentResponse;
+          return Promise.resolve(mockContentResponse);
         }
       });
 
@@ -90,6 +95,7 @@ describe("sdk-breaking-change-labels", () => {
 
       // Verify result
       expect(result).toEqual({
+        headSha: "abc123",
         labelName: sdkLabels[language].breakingChange,
         labelAction: LabelAction.Add,
         issueNumber: 123,
@@ -119,21 +125,21 @@ describe("sdk-breaking-change-labels", () => {
       const language = "azure-sdk-for-js";
       const mockContentResponse = {
         ok: true,
-        text: vi.fn().mockResolvedValue(
-          JSON.stringify({
-            labelAction: false,
-            language,
-            prNumber: "123",
-          }),
-        ),
+        text: vi
+          .fn()
+          .mockResolvedValue(
+            JSON.stringify(
+              createMockSpecGenSdkArtifactInfo({ labelAction: false, language, prNumber: "123" }),
+            ),
+          ),
       };
 
       // Setup fetch to return different responses for each call
       mockFetch.mockImplementation((url) => {
         if (url.includes("artifacts?artifactName=")) {
-          return mockArtifactResponse;
+          return Promise.resolve(mockArtifactResponse);
         } else {
-          return mockContentResponse;
+          return Promise.resolve(mockContentResponse);
         }
       });
 
@@ -146,6 +152,7 @@ describe("sdk-breaking-change-labels", () => {
 
       // Verify result has Remove action
       expect(result).toEqual({
+        headSha: "abc123",
         labelName: sdkLabels[language].breakingChange,
         labelAction: LabelAction.Remove,
         issueNumber: 123,
@@ -176,20 +183,22 @@ describe("sdk-breaking-change-labels", () => {
       const mockContentResponse = {
         ok: true,
         text: vi.fn().mockResolvedValue(
-          JSON.stringify({
-            labelAction: false,
-            language,
-            prNumber: "123",
-          }),
+          JSON.stringify(
+            createMockSpecGenSdkArtifactInfo({
+              labelAction: false,
+              language,
+              prNumber: "123",
+            }),
+          ),
         ),
       };
 
       // Setup fetch to return different responses for each call
       mockFetch.mockImplementation((url) => {
         if (url.includes("artifacts?artifactName=")) {
-          return mockArtifactResponse;
+          return Promise.resolve(mockArtifactResponse);
         } else {
-          return mockContentResponse;
+          return Promise.resolve(mockContentResponse);
         }
       });
 
@@ -202,6 +211,7 @@ describe("sdk-breaking-change-labels", () => {
 
       // Verify result has none action
       expect(result).toEqual({
+        headSha: "abc123",
         labelName: sdkLabels[language].breakingChange,
         labelAction: LabelAction.None,
         issueNumber: 123,
@@ -343,11 +353,7 @@ describe("sdk-breaking-change-labels", () => {
       };
 
       // Setup fetch to return different responses for each call
-      mockFetch.mockImplementation((url) => {
-        if (url.includes("artifacts?artifactName=")) {
-          return mockArtifactResponse;
-        }
-      });
+      mockFetch.mockResolvedValue(mockArtifactResponse);
 
       // Call function and expect it to throw
       await expect(
@@ -374,11 +380,7 @@ describe("sdk-breaking-change-labels", () => {
       };
 
       // Setup fetch to return different responses for each call
-      mockFetch.mockImplementation((url) => {
-        if (url.includes("artifacts?artifactName=")) {
-          return mockArtifactResponse;
-        }
-      });
+      mockFetch.mockResolvedValue(mockArtifactResponse);
 
       // Call function and expect it to throw
       await expect(
@@ -419,9 +421,9 @@ describe("sdk-breaking-change-labels", () => {
       // Setup fetch to return different responses for each call
       mockFetch.mockImplementation((url) => {
         if (url.includes("artifacts?artifactName=")) {
-          return mockArtifactResponse;
+          return Promise.resolve(mockArtifactResponse);
         } else {
-          return mockContentResponse;
+          return Promise.resolve(mockContentResponse);
         }
       });