summaryrefslogtreecommitdiffhomepage
path: root/packages/openai-stream/src/provider.test.ts
blob: 13a303e97df71c2c1807f490c27b424ac8ddb286 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
import type { ApiKeyCredentials, ChatMessage, ProviderStreamOptions } from "@dispatch/kernel";
import type { FetchLike } from "@dispatch/trace-replay";
import { describe, expect, it, vi } from "vitest";
import { createOpenAICompatProvider } from "./provider.js";

function makeCreds(): ApiKeyCredentials {
  return {
    type: "api-key",
    apiKey: "sk-test-1234567890abcdef",
    baseURL: "https://api.example.com/v1",
  };
}

function makeMessages(): readonly ChatMessage[] {
  return [{ role: "user", chunks: [{ type: "text", text: "Hello" }] }];
}

function sseBody(...lines: string[]): ReadableStream<Uint8Array> {
  const encoder = new TextEncoder();
  const chunks = lines.map((l) => encoder.encode(`${l}\n`));
  let index = 0;
  return new ReadableStream<Uint8Array>({
    pull(controller) {
      if (index < chunks.length) {
        const chunk = chunks[index];
        if (chunk === undefined) throw new Error("empty chunk");
        controller.enqueue(chunk);
        index++;
      } else {
        controller.close();
      }
    },
  });
}

function okSseResponse(): Response {
  return new Response(
    sseBody(
      'data: {"id":"cmpl-1","choices":[{"delta":{"content":"Hi"},"index":0}]}',
      'data: {"id":"cmpl-1","choices":[{"delta":{},"finish_reason":"stop","index":0}]}',
      "data: [DONE]",
    ),
    { status: 200, headers: { "Content-Type": "text/event-stream" } },
  );
}

async function collectEvents(iter: AsyncIterable<unknown>): Promise<unknown[]> {
  const events: unknown[] = [];
  for await (const event of iter) {
    events.push(event);
  }
  return events;
}

describe("createOpenAICompatProvider stamps the given id on the ProviderContract + listModels", () => {
  it("stamps opts.id on ProviderContract.id", () => {
    const provider = createOpenAICompatProvider({
      credentials: makeCreds(),
      model: "test-model",
      id: "my-custom-id",
    });
    expect(provider.id).toBe("my-custom-id");
  });

  it("uses opts.id in listModels error labels (was hardcoded 'openai-compat')", async () => {
    const fetchFn = vi.fn(
      () =>
        new Response("Unauthorized", {
          status: 401,
          headers: { "Content-Type": "text/plain" },
        }) as unknown as ReturnType<FetchLike>,
    );
    const provider = createOpenAICompatProvider({
      credentials: makeCreds(),
      model: "test-model",
      id: "my-custom-id",
      fetchFn,
    });
    const listModels = provider.listModels;
    if (!listModels) throw new Error("listModels not defined");

    await expect(listModels()).rejects.toThrow("listModels[my-custom-id]: HTTP 401 — Unauthorized");
  });

  it("exposes getUsage that returns the upstream concurrent_sessions", async () => {
    const fetchFn = vi.fn(
      () =>
        new Response(JSON.stringify({ usage: { concurrent_sessions: 2 } }), {
          status: 200,
          headers: { "Content-Type": "application/json" },
        }) as unknown as ReturnType<FetchLike>,
    );
    const provider = createOpenAICompatProvider({
      credentials: makeCreds(),
      model: "test-model",
      id: "umans",
      fetchFn,
    });
    const getUsage = provider.getUsage;
    if (!getUsage) throw new Error("getUsage not defined");

    const usage = await getUsage();
    expect(usage).toEqual({ concurrentSessions: 2 });
  });
});

describe("transformBody", () => {
  it("transformBody merges its returned fields into the request body", async () => {
    let capturedInit: RequestInit | undefined;
    const fetchFn = vi.fn(async (_url: string | URL | Request, init?: RequestInit) => {
      capturedInit = init;
      return okSseResponse();
    }) as unknown as FetchLike;

    let receivedBody: Record<string, unknown> | undefined;
    let receivedOpts: ProviderStreamOptions | undefined;
    const provider = createOpenAICompatProvider({
      credentials: makeCreds(),
      model: "test-model",
      id: "umans",
      fetchFn,
      transformBody: (body, opts) => {
        receivedBody = body;
        receivedOpts = opts;
        return { reasoning_effort: "high" };
      },
    });

    await collectEvents(provider.stream(makeMessages(), [], { temperature: 0.5 }));

    // The hook was called with the body built so far + the stream opts.
    expect(receivedBody).toBeDefined();
    expect(receivedOpts?.temperature).toBe(0.5);
    expect(receivedBody?.model).toBe("test-model");

    // The captured wire body carries the merged field.
    expect(capturedInit?.body).toBeTypeOf("string");
    const wireBody = JSON.parse(capturedInit?.body as string) as Record<string, unknown>;
    expect(wireBody.reasoning_effort).toBe("high");
    expect(wireBody.model).toBe("test-model");
    expect(wireBody.stream).toBe(true);
    expect(wireBody.temperature).toBe(0.5);
  });

  it("transformBody absent → body byte-identical to before (regression)", async () => {
    let capturedInit: RequestInit | undefined;
    const fetchFn = vi.fn(async (_url: string | URL | Request, init?: RequestInit) => {
      capturedInit = init;
      return okSseResponse();
    }) as unknown as FetchLike;

    const provider = createOpenAICompatProvider({
      credentials: makeCreds(),
      model: "test-model",
      id: "openai-compat",
      fetchFn,
      // No transformBody — default behavior.
    });

    await collectEvents(provider.stream(makeMessages(), [], { temperature: 0.5, maxTokens: 42 }));

    expect(capturedInit?.body).toBeTypeOf("string");
    const wireBody = JSON.parse(capturedInit?.body as string) as Record<string, unknown>;
    // Exact pre-refactor shape — no extra fields, no transformBody key leakage.
    expect(wireBody).toEqual({
      model: "test-model",
      messages: [{ role: "user", content: "Hello" }],
      stream: true,
      stream_options: { include_usage: true },
      temperature: 0.5,
      max_tokens: 42,
    });
    expect("reasoning_effort" in wireBody).toBe(false);
  });
});