diff --git a/src/backend/drivers/ai-chat/providers/moonshot/MoonshotProvider.test.ts b/src/backend/drivers/ai-chat/providers/moonshot/MoonshotProvider.test.ts new file mode 100644 index 000000000..9ae61ace6 --- /dev/null +++ b/src/backend/drivers/ai-chat/providers/moonshot/MoonshotProvider.test.ts @@ -0,0 +1,759 @@ +/* + * Copyright (C) 2024-present Puter Technologies Inc. + * + * This file is part of Puter. + * + * Puter is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published + * by the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +/** + * Offline unit tests for MoonshotProvider. + * + * Boots a real PuterServer (in-memory sqlite + dynamo + s3 + mock + * redis) and constructs MoonshotProvider directly against the live + * wired `MeteringService` so the recording side is exercised end-to- + * end. Moonshot is OpenAI-compatible so the OpenAI SDK is mocked at + * the module boundary; that's the real network egress point. Image- + * inlining behaviour is covered by `imageHandling.test.ts`; here we + * stub `inlineHttpImageUrls` so http URLs in vision messages don't + * trigger network fetches and only verify the provider invokes it + * for vision-capable models. The companion integration test + * (MoonshotProvider.integration.test.ts) exercises the real Moonshot + * endpoint. + */ + +import { Writable } from 'node:stream'; +import { + afterAll, + afterEach, + beforeAll, + beforeEach, + describe, + expect, + it, + vi, + type MockInstance, +} from 'vitest'; + +import { SYSTEM_ACTOR } from '../../../../core/actor.js'; +import type { MeteringService } from '../../../../services/metering/MeteringService.js'; +import { PuterServer } from '../../../../server.js'; +import { setupTestServer } from '../../../../testUtil.js'; +import { withTestActor } from '../../../integrationTestUtil.js'; +import { AIChatStream } from '../../utils/Streaming.js'; +import { MOONSHOT_MODELS } from './models.js'; +import { MoonshotProvider } from './MoonshotProvider.js'; + +// ── OpenAI SDK mock ───────────────────────────────────────────────── + +const { createMock, openAICtor } = vi.hoisted(() => { + const createMock = vi.fn(); + const openAICtor = vi.fn(); + return { createMock, openAICtor }; +}); + +vi.mock('openai', () => { + const OpenAICtor = vi.fn().mockImplementation(function ( + this: Record, + opts: unknown, + ) { + openAICtor(opts); + this.chat = { completions: { create: createMock } }; + }); + // Some providers (e.g. OllamaChatProvider, GeminiChatProvider) + // import the default export and access `.OpenAI` on it, so expose + // the same constructor under both shapes — the test server boots + // every provider, not just Moonshot. + return { OpenAI: OpenAICtor, default: { OpenAI: OpenAICtor } }; +}); + +// ── imageHandling stub ────────────────────────────────────────────── + +const { inlineHttpImageUrlsMock } = vi.hoisted(() => ({ + inlineHttpImageUrlsMock: vi.fn(async () => {}), +})); + +vi.mock('./imageHandling.js', () => ({ + inlineHttpImageUrls: inlineHttpImageUrlsMock, +})); + +// ── Test harness ──────────────────────────────────────────────────── + +let server: PuterServer; +let recordSpy: MockInstance; + +beforeAll(async () => { + server = await setupTestServer(); +}); + +afterAll(async () => { + await server?.shutdown(); +}); + +const makeProvider = () => { + const provider = new MoonshotProvider( + { apiKey: 'test-key' }, + server.services.metering, + ); + return { provider }; +}; + +const asAsyncIterable = (items: T[]): AsyncIterable => ({ + async *[Symbol.asyncIterator]() { + for (const item of items) { + yield item; + } + }, +}); + +const makeCapturingChatStream = () => { + const chunks: string[] = []; + const sink = new Writable({ + write(chunk, _enc, cb) { + chunks.push(chunk.toString('utf8')); + cb(); + }, + }); + const chatStream = new AIChatStream({ stream: sink }); + return { + chatStream, + events: () => + chunks + .join('') + .split('\n') + .filter(Boolean) + .map((line) => JSON.parse(line)), + }; +}; + +beforeEach(() => { + createMock.mockReset(); + openAICtor.mockReset(); + inlineHttpImageUrlsMock.mockReset(); + inlineHttpImageUrlsMock.mockImplementation(async () => {}); + recordSpy = vi.spyOn(server.services.metering, 'utilRecordUsageObject'); +}); + +afterEach(() => { + vi.restoreAllMocks(); +}); + +// ── Construction ──────────────────────────────────────────────────── + +describe('MoonshotProvider construction', () => { + it('points the OpenAI SDK at the Moonshot base URL with the configured key', () => { + makeProvider(); + expect(openAICtor).toHaveBeenCalledTimes(1); + expect(openAICtor).toHaveBeenCalledWith({ + apiKey: 'test-key', + baseURL: 'https://api.moonshot.ai/v1', + }); + }); +}); + +// ── Model catalog ─────────────────────────────────────────────────── + +describe('MoonshotProvider model catalog', () => { + it('returns kimi-k2.6 as the default', () => { + const { provider } = makeProvider(); + expect(provider.getDefaultModel()).toBe('kimi-k2.6'); + }); + + it('exposes the static MOONSHOT_MODELS list verbatim from models()', () => { + const { provider } = makeProvider(); + expect(provider.models()).toBe(MOONSHOT_MODELS); + }); + + it('list() flattens canonical ids and aliases (returned via async)', async () => { + const { provider } = makeProvider(); + const names = await provider.list(); + for (const m of MOONSHOT_MODELS) { + expect(names).toContain(m.id); + for (const a of m.aliases ?? []) { + expect(names).toContain(a); + } + } + expect(names).toContain('kimi'); + expect(names).toContain('kimi-k2.6'); + }); +}); + +// ── Request shape ─────────────────────────────────────────────────── + +describe('MoonshotProvider.complete request shape', () => { + const baseCompletion = { + choices: [ + { + message: { content: 'hi', role: 'assistant' }, + finish_reason: 'stop', + }, + ], + usage: { prompt_tokens: 1, completion_tokens: 1 }, + }; + + it('forwards model + messages and locks max_tokens=1000', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hello' }], + }), + ); + + const [args] = createMock.mock.calls[0]!; + expect(args.model).toBe('kimi-k2.6'); + expect(args.messages).toEqual([{ role: 'user', content: 'hello' }]); + // max_tokens is hardcoded by the provider — the call to Moonshot + // should always cap at 1000 tokens of completion. + expect(args.max_tokens).toBe(1000); + }); + + it('omits the `tools` key entirely when no tools are supplied', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hi' }], + }), + ); + + const [args] = createMock.mock.calls[0]!; + expect('tools' in args).toBe(false); + }); + + it('passes tool definitions through unchanged when supplied', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + const tools = [ + { + type: 'function', + function: { + name: 'lookup', + description: 'find a thing', + parameters: { + type: 'object', + properties: { q: { type: 'string' } }, + required: ['q'], + }, + }, + }, + ]; + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hi' }], + tools, + }), + ); + + const [args] = createMock.mock.calls[0]!; + expect(args.tools).toBe(tools); + }); + + it('only sets stream_options.include_usage when streaming', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hi' }], + stream: false, + }), + ); + const [nonStreamArgs] = createMock.mock.calls[0]!; + expect(nonStreamArgs.stream).toBe(false); + expect('stream_options' in nonStreamArgs).toBe(false); + + createMock.mockReturnValueOnce(asAsyncIterable([])); + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hi' }], + stream: true, + }), + ); + const [streamArgs] = createMock.mock.calls[1]!; + expect(streamArgs.stream).toBe(true); + expect(streamArgs.stream_options).toEqual({ include_usage: true }); + }); + + it('hoists Puter-style tool_use blocks into OpenAI tool_calls before sending', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [ + { + role: 'assistant', + content: [ + { + type: 'tool_use', + id: 'call_1', + name: 'lookup', + input: { q: 'puter' }, + }, + ], + }, + ], + }), + ); + + const [args] = createMock.mock.calls[0]!; + expect(args.messages[0].content).toBeNull(); + expect(args.messages[0].tool_calls).toEqual([ + { + id: 'call_1', + type: 'function', + function: { + name: 'lookup', + arguments: JSON.stringify({ q: 'puter' }), + }, + }, + ]); + }); +}); + +// ── Image inlining for vision models ──────────────────────────────── + +describe('MoonshotProvider image inlining', () => { + const baseCompletion = { + choices: [ + { + message: { content: 'ok', role: 'assistant' }, + finish_reason: 'stop', + }, + ], + usage: { prompt_tokens: 1, completion_tokens: 1 }, + }; + + it('routes vision-capable models through inlineHttpImageUrls', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + const messages = [ + { + role: 'user', + content: [ + { type: 'text', text: 'what is this?' }, + { + type: 'image_url', + image_url: { url: 'https://example.com/img.png' }, + }, + ], + }, + ]; + + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.5', // kimi-k2.5 declares image input modality + messages: messages as unknown as { role: string; content: unknown }[], + }), + ); + + expect(inlineHttpImageUrlsMock).toHaveBeenCalledTimes(1); + // The provider passes the same messages array — image inlining + // mutates parts in place before process_input_messages runs. + expect(inlineHttpImageUrlsMock.mock.calls[0]![0]).toBe(messages); + }); + + it('does not invoke inlineHttpImageUrls for text-only models', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hi' }], + }), + ); + + expect(inlineHttpImageUrlsMock).not.toHaveBeenCalled(); + }); +}); + +// ── Model resolution ──────────────────────────────────────────────── + +describe('MoonshotProvider model resolution', () => { + const baseCompletion = { + choices: [ + { + message: { content: 'ok', role: 'assistant' }, + finish_reason: 'stop', + }, + ], + usage: { prompt_tokens: 1, completion_tokens: 1 }, + }; + + it('resolves an exact canonical id', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + await withTestActor(() => + provider.complete({ + model: 'moonshot-v1-32k', + messages: [{ role: 'user', content: 'hi' }], + }), + ); + + expect(createMock.mock.calls[0]![0].model).toBe('moonshot-v1-32k'); + expect(recordSpy).toHaveBeenCalledWith( + expect.any(Object), + expect.anything(), + 'moonshotai:moonshot-v1-32k', + expect.any(Object), + ); + }); + + it('resolves an alias to its canonical id (alias rewriting)', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + await withTestActor(() => + provider.complete({ + model: 'kimi', + messages: [{ role: 'user', content: 'hi' }], + }), + ); + + expect(createMock.mock.calls[0]![0].model).toBe('kimi-k2.6'); + expect(recordSpy).toHaveBeenCalledWith( + expect.any(Object), + expect.anything(), + 'moonshotai:kimi-k2.6', + expect.any(Object), + ); + }); + + it('falls back to the default model when given an unknown id', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce(baseCompletion); + + await withTestActor(() => + provider.complete({ + model: 'totally-not-a-real-model', + messages: [{ role: 'user', content: 'hi' }], + }), + ); + + expect(createMock.mock.calls[0]![0].model).toBe('kimi-k2.6'); + expect(recordSpy).toHaveBeenCalledWith( + expect.any(Object), + expect.anything(), + 'moonshotai:kimi-k2.6', + expect.any(Object), + ); + }); +}); + +// ── Non-stream completion ─────────────────────────────────────────── + +describe('MoonshotProvider.complete non-stream output', () => { + it('returns the first choice and runs the metered usage calculator', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce({ + choices: [ + { + message: { content: 'hi there', role: 'assistant' }, + finish_reason: 'stop', + }, + ], + usage: { + prompt_tokens: 100, + completion_tokens: 50, + prompt_tokens_details: { cached_tokens: 10 }, + }, + }); + + const result = await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hi' }], + }), + ); + + expect(result).toMatchObject({ + message: { content: 'hi there', role: 'assistant' }, + finish_reason: 'stop', + }); + expect((result as { usage: unknown }).usage).toEqual({ + prompt_tokens: 100, + completion_tokens: 50, + cached_tokens: 10, + }); + + // kimi-k2.6 costs: prompt=95, completion=400, cached=16. + const kimi = MOONSHOT_MODELS.find((m) => m.id === 'kimi-k2.6')!; + expect(recordSpy).toHaveBeenCalledTimes(1); + const [usage, actor, prefix, overrides] = recordSpy.mock.calls[0]!; + expect(usage).toEqual({ + prompt_tokens: 100, + completion_tokens: 50, + cached_tokens: 10, + }); + expect(actor).toBe(SYSTEM_ACTOR); + expect(prefix).toBe('moonshotai:kimi-k2.6'); + expect(overrides).toEqual({ + prompt_tokens: 100 * Number(kimi.costs.prompt_tokens), + completion_tokens: 50 * Number(kimi.costs.completion_tokens), + cached_tokens: 10 * Number(kimi.costs.cached_tokens ?? 0), + }); + }); + + it('preserves OpenAI-shaped tool_calls on the assistant response', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce({ + choices: [ + { + message: { + role: 'assistant', + content: null, + tool_calls: [ + { + id: 'call_1', + type: 'function', + function: { + name: 'lookup', + arguments: '{"q":"puter"}', + }, + }, + ], + }, + finish_reason: 'tool_calls', + }, + ], + usage: { prompt_tokens: 1, completion_tokens: 1 }, + }); + + const result = (await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'do a tool call' }], + tools: [ + { + type: 'function', + function: { name: 'lookup', parameters: {} }, + }, + ], + }), + )) as { message: { tool_calls?: unknown[] }; finish_reason: string }; + + expect(result.finish_reason).toBe('tool_calls'); + expect(result.message.tool_calls).toEqual([ + { + id: 'call_1', + type: 'function', + function: { + name: 'lookup', + arguments: '{"q":"puter"}', + }, + }, + ]); + }); + + it('zeroes cached_tokens when prompt_tokens_details is missing', async () => { + const { provider } = makeProvider(); + createMock.mockResolvedValueOnce({ + choices: [ + { + message: { content: 'ok', role: 'assistant' }, + finish_reason: 'stop', + }, + ], + usage: { prompt_tokens: 7, completion_tokens: 3 }, + }); + + await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'hi' }], + }), + ); + + const [usage, , , overrides] = recordSpy.mock.calls[0]!; + expect(usage.cached_tokens).toBe(0); + expect(overrides).toMatchObject({ cached_tokens: 0 }); + }); +}); + +// ── Streaming deltas ──────────────────────────────────────────────── + +describe('MoonshotProvider.complete streaming', () => { + it('streams text deltas through to text events and meters final usage', async () => { + const { provider } = makeProvider(); + createMock.mockReturnValueOnce( + asAsyncIterable([ + { choices: [{ delta: { content: 'hel' } }] }, + { choices: [{ delta: { content: 'lo' } }] }, + { + choices: [{ delta: {} }], + usage: { + prompt_tokens: 4, + completion_tokens: 2, + prompt_tokens_details: { cached_tokens: 1 }, + }, + }, + ]), + ); + + const result = await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'say hi' }], + stream: true, + }), + ); + expect((result as { stream: boolean }).stream).toBe(true); + + const harness = makeCapturingChatStream(); + await ( + result as { + init_chat_stream: (p: { chatStream: unknown }) => Promise; + } + ).init_chat_stream({ chatStream: harness.chatStream }); + + const events = harness.events(); + const textEvents = events.filter((e) => e.type === 'text'); + expect(textEvents.map((e) => e.text)).toEqual(['hel', 'lo']); + + const usageEvent = events.find((e) => e.type === 'usage'); + expect(usageEvent?.usage).toEqual({ + prompt_tokens: 4, + completion_tokens: 2, + cached_tokens: 1, + }); + + const kimi = MOONSHOT_MODELS.find((m) => m.id === 'kimi-k2.6')!; + expect(recordSpy).toHaveBeenCalledTimes(1); + const [, , prefix, overrides] = recordSpy.mock.calls[0]!; + expect(prefix).toBe('moonshotai:kimi-k2.6'); + expect(overrides).toEqual({ + prompt_tokens: 4 * Number(kimi.costs.prompt_tokens), + completion_tokens: 2 * Number(kimi.costs.completion_tokens), + cached_tokens: 1 * Number(kimi.costs.cached_tokens ?? 0), + }); + }); + + it('builds a tool_use block from streamed function-call deltas', async () => { + const { provider } = makeProvider(); + createMock.mockReturnValueOnce( + asAsyncIterable([ + { + choices: [ + { + delta: { + tool_calls: [ + { + index: 0, + id: 'call_1', + function: { + name: 'lookup', + arguments: '{"q":', + }, + }, + ], + }, + }, + ], + }, + { + choices: [ + { + delta: { + tool_calls: [ + { + index: 0, + function: { arguments: '"puter"}' }, + }, + ], + }, + }, + ], + }, + { + choices: [{ delta: {} }], + usage: { prompt_tokens: 1, completion_tokens: 1 }, + }, + ]), + ); + + const result = await withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'do tool call' }], + tools: [ + { + type: 'function', + function: { name: 'lookup', parameters: {} }, + }, + ], + stream: true, + }), + ); + + const harness = makeCapturingChatStream(); + await ( + result as { + init_chat_stream: (p: { chatStream: unknown }) => Promise; + } + ).init_chat_stream({ chatStream: harness.chatStream }); + + const events = harness.events(); + const toolEvent = events.find((e) => e.type === 'tool_use'); + expect(toolEvent).toBeDefined(); + expect(toolEvent?.id).toBe('call_1'); + expect(toolEvent?.name).toBe('lookup'); + expect(toolEvent?.input).toEqual({ q: 'puter' }); + }); +}); + +// ── Error mapping ─────────────────────────────────────────────────── + +describe('MoonshotProvider.complete error mapping', () => { + it('logs and rethrows errors raised by the OpenAI client unchanged', async () => { + const { provider } = makeProvider(); + const apiError = new Error('Moonshot exploded'); + createMock.mockRejectedValueOnce(apiError); + const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {}); + + await expect( + withTestActor(() => + provider.complete({ + model: 'kimi-k2.6', + messages: [{ role: 'user', content: 'boom' }], + }), + ), + ).rejects.toBe(apiError); + + expect(recordSpy).not.toHaveBeenCalled(); + expect(logSpy).toHaveBeenCalled(); + }); +}); + +// ── Moderation ────────────────────────────────────────────────────── + +describe('MoonshotProvider.checkModeration', () => { + it('throws — Moonshot provider does not implement moderation', () => { + const { provider } = makeProvider(); + expect(() => provider.checkModeration('anything')).toThrow( + /not implemented/i, + ); + }); +});