From 8f64ac12840ea5f874555d8a5f663a339e4c3cd6 Mon Sep 17 00:00:00 2001 From: Sean Goedecke Date: Mon, 21 Jul 2025 04:31:06 +0000 Subject: [PATCH] Fixup types and tests --- __tests__/main-prompt-integration.test.ts | 79 +++++++++++++---------- src/helpers.ts | 4 +- src/inference.ts | 24 +++++-- src/main.ts | 5 +- 4 files changed, 69 insertions(+), 43 deletions(-) diff --git a/__tests__/main-prompt-integration.test.ts b/__tests__/main-prompt-integration.test.ts index a401a47..4a53896 100644 --- a/__tests__/main-prompt-integration.test.ts +++ b/__tests__/main-prompt-integration.test.ts @@ -1,31 +1,42 @@ import { describe, it, expect, beforeEach, jest } from '@jest/globals' -import * as core from '@actions/core' -import * as fs from 'fs' -import * as path from 'path' -import { fileURLToPath } from 'url' -import { run } from '../src/main' +import * as core from '../__fixtures__/core.js' -const __filename = fileURLToPath(import.meta.url) -const __dirname = path.dirname(__filename) +// Create fs mocks +const mockExistsSync = jest.fn() +const mockReadFileSync = jest.fn() +const mockWriteFileSync = jest.fn() -// Mock the action toolkit functions -jest.mock('@actions/core') +// Create inference mocks +// eslint-disable-next-line @typescript-eslint/no-explicit-any +const mockSimpleInference = jest.fn() as jest.MockedFunction +const mockMcpInference = jest.fn() -// Mock fs to handle temporary file creation -jest.mock('fs') +// Create MCP mocks +const mockConnectToGitHubMCP = jest.fn() + +// Mock fs module +jest.unstable_mockModule('fs', () => ({ + existsSync: mockExistsSync, + readFileSync: mockReadFileSync, + writeFileSync: mockWriteFileSync +})) // Mock the inference functions -jest.mock('../src/inference', () => ({ - simpleInference: jest.fn(), - mcpInference: jest.fn() +jest.unstable_mockModule('../src/inference.js', () => ({ + simpleInference: mockSimpleInference, + mcpInference: mockMcpInference })) // Mock the MCP connection -jest.mock('../src/mcp', () => ({ - connectToGitHubMCP: jest.fn() +jest.unstable_mockModule('../src/mcp.js', () => ({ + connectToGitHubMCP: mockConnectToGitHubMCP })) -import { simpleInference } from '../src/inference' +jest.unstable_mockModule('@actions/core', () => core) + +// The module being tested should be imported dynamically. This ensures that the +// mocks are used in place of any actual dependencies. +const { run } = await import('../src/main.js') describe('main.ts - prompt.yml integration', () => { beforeEach(() => { @@ -35,8 +46,7 @@ describe('main.ts - prompt.yml integration', () => { process.env['GITHUB_TOKEN'] = 'test-token' // Mock core.getInput to return appropriate values - const mockGetInput = core.getInput as jest.Mock - mockGetInput.mockImplementation((name: string) => { + core.getInput.mockImplementation((name: string) => { switch (name) { case 'model': return 'openai/gpt-4o' @@ -55,12 +65,7 @@ describe('main.ts - prompt.yml integration', () => { const mockGetBooleanInput = core.getBooleanInput as jest.Mock mockGetBooleanInput.mockReturnValue(false) - // Mock fs.existsSync - const mockExistsSync = fs.existsSync as jest.Mock - mockExistsSync.mockReturnValue(true) - // Mock fs.readFileSync for prompt file - const mockReadFileSync = fs.readFileSync as jest.Mock mockReadFileSync.mockReturnValue(` messages: - role: system @@ -71,17 +76,15 @@ model: openai/gpt-4o `) // Mock fs.writeFileSync - const mockWriteFileSync = fs.writeFileSync as jest.Mock mockWriteFileSync.mockImplementation(() => {}) // Mock simpleInference - const mockSimpleInference = simpleInference as jest.Mock mockSimpleInference.mockResolvedValue('Mocked AI response') }) it('should handle prompt YAML files with template variables', async () => { - const mockGetInput = core.getInput as jest.Mock - mockGetInput.mockImplementation((name: string) => { + mockExistsSync.mockReturnValue(true) + core.getInput.mockImplementation((name: string) => { switch (name) { case 'prompt-file': return 'test.prompt.yml' @@ -103,7 +106,6 @@ model: openai/gpt-4o await run() // Verify simpleInference was called with the correct message structure - const mockSimpleInference = simpleInference as jest.Mock expect(mockSimpleInference).toHaveBeenCalledWith( expect.objectContaining({ messages: [ @@ -135,8 +137,8 @@ model: openai/gpt-4o }) it('should fall back to legacy format when not using prompt YAML', async () => { - const mockGetInput = core.getInput as jest.Mock - mockGetInput.mockImplementation((name: string) => { + mockExistsSync.mockReturnValue(false) + core.getInput.mockImplementation((name: string) => { switch (name) { case 'prompt': return 'Hello, world!' @@ -157,12 +159,19 @@ model: openai/gpt-4o await run() - // Verify simpleInference was called with legacy format - const mockSimpleInference = simpleInference as jest.Mock + // Verify simpleInference was called with converted message format expect(mockSimpleInference).toHaveBeenCalledWith( expect.objectContaining({ - systemPrompt: 'You are helpful', - prompt: 'Hello, world!', + messages: [ + { + role: 'system', + content: 'You are helpful' + }, + { + role: 'user', + content: 'Hello, world!' + } + ], modelName: 'openai/gpt-4o', maxTokens: 200, endpoint: 'https://models.github.ai/inference', diff --git a/src/helpers.ts b/src/helpers.ts index 01d4116..106c5d8 100644 --- a/src/helpers.ts +++ b/src/helpers.ts @@ -96,7 +96,9 @@ export function buildMessages( /** * Build response format object for API from prompt config */ -export function buildResponseFormat(promptConfig?: PromptConfig): any { +export function buildResponseFormat( + promptConfig?: PromptConfig +): { type: 'json_schema'; json_schema: unknown } | undefined { if ( promptConfig?.responseFormat === 'json_schema' && promptConfig.jsonSchema diff --git a/src/inference.ts b/src/inference.ts index df4db28..e837e17 100644 --- a/src/inference.ts +++ b/src/inference.ts @@ -1,16 +1,30 @@ import * as core from '@actions/core' import ModelClient, { isUnexpected } from '@azure-rest/ai-inference' import { AzureKeyCredential } from '@azure/core-auth' -import { GitHubMCPClient, executeToolCalls } from './mcp.js' +import { GitHubMCPClient, executeToolCalls, MCPTool, ToolCall } from './mcp.js' import { handleUnexpectedResponse } from './helpers.js' +interface ChatMessage { + role: string + content: string | null + tool_calls?: ToolCall[] +} + +interface ChatCompletionsRequestBody { + messages: ChatMessage[] + max_tokens: number + model: string + response_format?: { type: 'json_schema'; json_schema: unknown } + tools?: MCPTool[] +} + export interface InferenceRequest { messages: Array<{ role: string; content: string }> modelName: string maxTokens: number endpoint: string token: string - responseFormat?: any // Will contain the processed response format for the API + responseFormat?: { type: 'json_schema'; json_schema: unknown } // Processed response format for the API } export interface InferenceResponse { @@ -41,7 +55,7 @@ export async function simpleInference( } ) - const requestBody: any = { + const requestBody: ChatCompletionsRequestBody = { messages: request.messages, max_tokens: request.maxTokens, model: request.modelName @@ -84,7 +98,7 @@ export async function mcpInference( ) // Start with the pre-processed messages - const messages: Array = [...request.messages] + const messages: ChatMessage[] = [...request.messages] let iterationCount = 0 const maxIterations = 5 // Prevent infinite loops @@ -93,7 +107,7 @@ export async function mcpInference( iterationCount++ core.info(`MCP inference iteration ${iterationCount}`) - const requestBody: any = { + const requestBody: ChatCompletionsRequestBody = { messages: messages, max_tokens: request.maxTokens, model: request.modelName, diff --git a/src/main.ts b/src/main.ts index 982a813..c317441 100644 --- a/src/main.ts +++ b/src/main.ts @@ -8,7 +8,8 @@ import { loadContentFromFileOrInput, buildInferenceRequest } from './helpers.js' import { loadPromptFile, parseTemplateVariables, - isPromptYamlFile + isPromptYamlFile, + PromptConfig } from './prompt.js' const RESPONSE_FILE = 'modelResponse.txt' @@ -23,7 +24,7 @@ export async function run(): Promise { const promptFilePath = core.getInput('prompt-file') const inputVariables = core.getInput('input') - let promptConfig: any = undefined + let promptConfig: PromptConfig | undefined = undefined let systemPrompt: string | undefined = undefined let prompt: string | undefined = undefined