Files
openclaw/extensions/google/index.test.ts
2026-08-02 01:25:41 +08:00

614 lines
20 KiB
TypeScript

// Google tests cover index plugin behavior.
import { mkdtemp, writeFile } from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import type { Context, Model } from "openclaw/plugin-sdk/llm";
import type {
ProviderReplaySessionEntry,
ProviderSanitizeReplayHistoryContext,
} from "openclaw/plugin-sdk/plugin-entry";
import { createTestPluginApi } from "openclaw/plugin-sdk/plugin-test-api";
import {
registerProviderPlugin,
requireRegisteredProvider,
} from "openclaw/plugin-sdk/plugin-test-runtime";
import { createCapturedThinkingConfigStream } from "openclaw/plugin-sdk/provider-test-contracts";
import type {
RealtimeVoiceBridge,
RealtimeVoiceBridgeCreateRequest,
RealtimeVoiceProviderPlugin,
} from "openclaw/plugin-sdk/realtime-voice";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { registerGoogleGeminiCliProvider } from "./gemini-cli-provider.js";
import googlePlugin from "./index.js";
import googleProviderDiscovery from "./provider-discovery.js";
import { registerGoogleProvider } from "./provider-registration.js";
const { createRealtimeBridgeMock } = vi.hoisted(() => ({
createRealtimeBridgeMock: vi.fn<(req: RealtimeVoiceBridgeCreateRequest) => RealtimeVoiceBridge>(),
}));
vi.mock("./realtime-voice-provider.js", () => ({
buildGoogleRealtimeVoiceProvider: () => ({
id: "google",
label: "Google Live Voice",
createBridge: createRealtimeBridgeMock,
}),
}));
const googleProviderPlugin = {
register(api: Parameters<typeof registerGoogleProvider>[0]) {
registerGoogleProvider(api);
registerGoogleGeminiCliProvider(api);
},
};
function createDeferred<T>() {
let resolve!: (value: T | PromiseLike<T>) => void;
let reject!: (reason?: unknown) => void;
const promise = new Promise<T>((resolvePromise, rejectPromise) => {
resolve = resolvePromise;
reject = rejectPromise;
});
return { promise, resolve, reject };
}
function createMockRealtimeBridge(connectImpl: () => Promise<void> = async () => {}) {
const connect = vi.fn(connectImpl);
const sendUserMessage = vi.fn();
const triggerGreeting = vi.fn();
const close = vi.fn();
const bridge: RealtimeVoiceBridge = {
supportsToolResultContinuation: false,
supportsToolResultSuppression: false,
connect,
sendAudio: vi.fn(),
setMediaTimestamp: vi.fn(),
sendUserMessage,
triggerGreeting,
handleBargeIn: vi.fn(),
submitToolResult: vi.fn(),
acknowledgeMark: vi.fn(),
close,
isConnected: vi.fn(() => false),
};
return { bridge, close, connect, sendUserMessage, triggerGreeting };
}
function createLazyRealtimeBridge(onError = vi.fn(), onReady?: () => void) {
let realtimeProvider: RealtimeVoiceProviderPlugin | undefined;
googlePlugin.register(
createTestPluginApi({
registerRealtimeVoiceProvider(provider) {
realtimeProvider = provider;
},
}),
);
const bridge = realtimeProvider?.createBridge({
providerConfig: { apiKey: "gemini-key" },
onAudio() {},
onClearAudio() {},
onError,
onReady,
});
if (!bridge) {
throw new Error("expected Google realtime bridge");
}
return { bridge, onError };
}
function signalRealtimeBridgeReady() {
const request = createRealtimeBridgeMock.mock.calls.at(-1)?.[0];
if (!request) {
throw new Error("expected Google realtime bridge request");
}
request.onReady?.();
}
describe("google provider plugin hooks", () => {
beforeEach(() => {
createRealtimeBridgeMock.mockReset();
});
it("owns replay policy and reasoning mode for the direct Gemini provider", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const provider = requireRegisteredProvider(providers, "google");
const customEntries: ProviderReplaySessionEntry[] = [];
expect(
provider.buildReplayPolicy?.({
provider: "google",
modelApi: "google-generative-ai",
modelId: "gemini-3.1-pro-preview",
} as never),
).toEqual({
sanitizeMode: "full",
sanitizeToolCallIds: true,
toolCallIdMode: "strict",
sanitizeThoughtSignatures: {
allowBase64Only: true,
includeCamelCase: true,
},
repairToolUseResultPairing: true,
applyAssistantFirstOrderingFix: true,
validateGeminiTurns: true,
validateAnthropicTurns: false,
allowSyntheticToolResults: true,
});
expect(
provider.resolveReasoningOutputMode?.({
provider: "google",
modelApi: "google-generative-ai",
modelId: "gemini-3.1-pro-preview",
} as never),
).toBe("native");
expect(
provider.resolveReasoningOutputMode?.({
provider: "google",
modelId: "gemini-3.1-pro-preview",
} as never),
).toBe("native");
const sanitized = await Promise.resolve(
provider.sanitizeReplayHistory?.({
provider: "google",
modelApi: "google-generative-ai",
modelId: "gemini-3.1-pro-preview",
sessionId: "session-1",
messages: [
{
role: "assistant",
content: [{ type: "text", text: "hello" }],
},
],
sessionState: {
getCustomEntries: () => customEntries,
appendCustomEntry: (customType: string, data: unknown) => {
customEntries.push({ customType, data });
},
},
} as ProviderSanitizeReplayHistoryContext),
);
const bootstrapMessage = sanitized?.[0] as
| { role?: string; content?: unknown; timestamp?: unknown }
| undefined;
expect(bootstrapMessage?.role).toBe("user");
expect(bootstrapMessage?.content).toBe("(session bootstrap)");
expect(typeof bootstrapMessage?.timestamp).toBe("number");
expect(sanitized?.[1]).toEqual({
role: "assistant",
content: [{ type: "text", text: "hello" }],
});
expect(customEntries).toHaveLength(1);
expect(customEntries[0]?.customType).toBe("google-turn-ordering-bootstrap");
});
it("keeps google-gemini-cli on tagged reasoning mode", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const cliProvider = requireRegisteredProvider(providers, "google-gemini-cli");
expect(
cliProvider.resolveReasoningOutputMode?.({
provider: "google-gemini-cli",
modelApi: "google-gemini-cli",
modelId: "gemini-2.5-pro",
} as never),
).toBe("tagged");
});
it("keeps the Gemini CLI runtime without OpenClaw-owned OAuth surfaces", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const cliProvider = requireRegisteredProvider(providers, "google-gemini-cli");
expect(cliProvider.label).toBe("Gemini CLI runtime");
expect(cliProvider.auth).toEqual([]);
expect(cliProvider.envVars).toEqual([]);
expect(cliProvider.wizard).toBeUndefined();
expect(cliProvider.refreshOAuth).toBeUndefined();
expect(cliProvider.resolveUsageAuth).toBeUndefined();
expect(cliProvider.fetchUsageSnapshot).toBeUndefined();
});
it("keeps google-antigravity hook aliases on tagged reasoning mode", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const provider = requireRegisteredProvider(providers, "google-antigravity");
expect(
provider.resolveReasoningOutputMode?.({
provider: "google-antigravity",
modelApi: "openai-completions",
modelId: "gemini-3-pro-low",
} as never),
).toBe("tagged");
});
it("keeps google-vertex hook aliases on native reasoning mode", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const provider = requireRegisteredProvider(providers, "google-vertex");
expect(
provider.resolveReasoningOutputMode?.({
provider: "google-vertex",
modelApi: "google-vertex",
modelId: "gemini-3.1-pro-preview",
} as never),
).toBe("native");
expect(
provider.resolveReasoningOutputMode?.({
provider: "google-vertex",
modelId: "gemini-3.1-pro-preview",
} as never),
).toBe("native");
});
it("resolves Google Vertex ADC auth evidence to the config marker", async () => {
const tempDir = await mkdtemp(path.join(os.tmpdir(), "openclaw-google-vertex-config-key-"));
const credentialsPath = path.join(tempDir, "application_default_credentials.json");
await writeFile(
credentialsPath,
JSON.stringify({
type: "authorized_user",
client_id: "client-id",
client_secret: "client-secret",
refresh_token: "refresh-token",
}),
"utf8",
);
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const provider = requireRegisteredProvider(providers, "google-vertex");
expect(
provider.resolveConfigApiKey?.({
provider: "google-vertex",
env: {
GOOGLE_APPLICATION_CREDENTIALS: credentialsPath,
GOOGLE_CLOUD_PROJECT: "vertex-project",
GOOGLE_CLOUD_LOCATION: "global",
},
}),
).toBe("gcp-vertex-credentials");
expect(
provider.resolveConfigApiKey?.({
provider: "google-vertex",
env: {
GOOGLE_APPLICATION_CREDENTIALS: credentialsPath,
GOOGLE_CLOUD_PROJECT: "",
GCLOUD_PROJECT: "vertex-project",
GOOGLE_CLOUD_LOCATION: "global",
},
}),
).toBe("gcp-vertex-credentials");
expect(
googleProviderDiscovery.resolveConfigApiKey?.({
provider: "google-vertex",
env: {
GOOGLE_APPLICATION_CREDENTIALS: credentialsPath,
GOOGLE_CLOUD_PROJECT: "vertex-project",
GOOGLE_CLOUD_LOCATION: "global",
},
}),
).toBe("gcp-vertex-credentials");
});
it("owns Gemini tool schema normalization for direct and CLI providers", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const providerIds = ["google", "google-gemini-cli"] as const;
for (const providerId of providerIds) {
const provider = requireRegisteredProvider(providers, providerId);
const [tool] =
provider.normalizeToolSchemas?.({
provider: providerId,
tools: [
{
name: "write_file",
description: "Write a file",
parameters: {
type: "object",
additionalProperties: false,
properties: {
path: { type: "string", pattern: "^src/" },
},
},
},
],
} as never) ?? [];
expect(tool).toEqual({
name: "write_file",
description: "Write a file",
parameters: {
type: "object",
properties: {
path: { type: "string" },
},
},
});
expect(tool?.parameters).not.toHaveProperty("additionalProperties");
expect(
(tool?.parameters as { properties?: { path?: Record<string, unknown> } })?.properties?.path,
).not.toHaveProperty("pattern");
expect(
provider.inspectToolSchemas?.({
provider: providerId,
tools: [tool],
} as never),
).toEqual([]);
}
});
it("wires google-thinking stream hooks for direct and Gemini CLI providers", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const googleProvider = requireRegisteredProvider(providers, "google");
const cliProvider = requireRegisteredProvider(providers, "google-gemini-cli");
const capturedStream = createCapturedThinkingConfigStream();
const runCase = (provider: typeof googleProvider, providerId: string) => {
const wrapped = provider.wrapStreamFn?.({
provider: providerId,
modelId: "gemini-3.1-pro-preview",
thinkingLevel: "high",
streamFn: capturedStream.streamFn,
} as never);
void wrapped?.(
{
api: "google-generative-ai",
provider: providerId,
id: "gemini-3.1-pro-preview",
} as Model<"google-generative-ai">,
{ messages: [] } as Context,
{},
);
const capturedPayload = capturedStream.getCapturedPayload();
expect(capturedPayload).toEqual({
config: {
thinkingConfig: {
thinkingLevel: "HIGH",
},
},
});
const thinkingConfig = (
(capturedPayload as Record<string, unknown>).config as Record<string, unknown>
).thinkingConfig as Record<string, unknown>;
expect(thinkingConfig).not.toHaveProperty("thinkingBudget");
};
runCase(googleProvider, "google");
runCase(cliProvider, "google-gemini-cli");
});
it("wires Vertex transport before request-time metadata ADC detection", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const provider = requireRegisteredProvider(providers, "google");
expect(
provider.createStreamFn?.({
model: {
api: "google-vertex",
provider: "google",
id: "gemini-2.5-pro",
},
} as never),
).toEqual(expect.any(Function));
});
it("advertises adaptive thinking for Gemini dynamic thinking", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const provider = requireRegisteredProvider(providers, "google");
if (!provider.resolveThinkingProfile) {
throw new Error("expected Google provider thinking profile resolver");
}
const resolveThinkingProfile = provider.resolveThinkingProfile;
const gemini3Profile = resolveThinkingProfile({
provider: "google",
modelId: "gemini-3.1-pro-preview",
} as never);
const gemini25Profile = resolveThinkingProfile({
provider: "google",
modelId: "gemini-2.5-flash",
} as never);
expect(gemini3Profile?.levels).toEqual([
{ id: "off" },
{ id: "low" },
{ id: "adaptive" },
{ id: "high" },
]);
expect(gemini25Profile?.levels).toEqual([
{ id: "off" },
{ id: "minimal" },
{ id: "low" },
{ id: "medium" },
{ id: "adaptive" },
{ id: "high" },
]);
});
it("shares Gemini replay and stream hooks across Google provider variants", async () => {
const { providers } = await registerProviderPlugin({
plugin: googleProviderPlugin,
id: "google",
name: "Google Provider",
});
const googleProvider = requireRegisteredProvider(providers, "google");
const cliProvider = requireRegisteredProvider(providers, "google-gemini-cli");
expect(googleProvider.buildReplayPolicy).toBe(cliProvider.buildReplayPolicy);
expect(googleProvider.wrapStreamFn).toBe(cliProvider.wrapStreamFn);
});
it("buffers early realtime audio while the lazy Google bridge loads", () => {
const { bridge } = createLazyRealtimeBridge();
expect(bridge.supportsToolResultContinuation).toBe(false);
expect(bridge.supportsToolResultSuppression).toBe(false);
expect(bridge.sendAudio(Buffer.alloc(160))).toBeUndefined();
expect(bridge.setMediaTimestamp(20)).toBeUndefined();
expect(bridge.sendUserMessage?.("hello")).toBeUndefined();
});
it("preserves queued user messages until the loaded bridge reports ready", async () => {
const connected = createDeferred<void>();
const loaded = createMockRealtimeBridge(() => connected.promise);
createRealtimeBridgeMock.mockReturnValue(loaded.bridge);
const { bridge } = createLazyRealtimeBridge();
bridge.sendUserMessage?.("before connect");
const connectPromise = bridge.connect();
await vi.waitFor(() => expect(loaded.connect).toHaveBeenCalledOnce());
bridge.sendUserMessage?.("during connect");
expect(loaded.sendUserMessage).not.toHaveBeenCalled();
connected.resolve();
await connectPromise;
expect(loaded.sendUserMessage).not.toHaveBeenCalled();
signalRealtimeBridgeReady();
expect(loaded.sendUserMessage.mock.calls.map(([text]) => text)).toEqual([
"before connect",
"during connect",
]);
});
it("rejects each user message beyond the lazy startup queue count", async () => {
const loaded = createMockRealtimeBridge();
createRealtimeBridgeMock.mockReturnValue(loaded.bridge);
const { bridge, onError } = createLazyRealtimeBridge();
for (let index = 0; index < 130; index += 1) {
bridge.sendUserMessage?.(`message-${index}`);
}
await bridge.connect();
signalRealtimeBridgeReady();
expect(loaded.sendUserMessage).toHaveBeenCalledTimes(128);
expect(loaded.sendUserMessage.mock.calls.map(([text]) => text)).toEqual(
Array.from({ length: 128 }, (_, index) => `message-${index}`),
);
expect(onError).toHaveBeenCalledTimes(2);
expect(onError).toHaveBeenNthCalledWith(
1,
expect.objectContaining({ message: expect.stringContaining("queue overflow") }),
);
expect(onError).toHaveBeenNthCalledWith(
2,
expect.objectContaining({ message: expect.stringContaining("queue overflow") }),
);
});
it("bounds the lazy startup queue by aggregate UTF-8 bytes", async () => {
const loaded = createMockRealtimeBridge();
createRealtimeBridgeMock.mockReturnValue(loaded.bridge);
const { bridge, onError } = createLazyRealtimeBridge();
const exactLimit = "🙂".repeat((256 * 1024) / 4);
expect(Buffer.byteLength(exactLimit, "utf8")).toBe(256 * 1024);
bridge.sendUserMessage?.(exactLimit);
bridge.sendUserMessage?.("overflow");
await bridge.connect();
signalRealtimeBridgeReady();
expect(loaded.sendUserMessage).toHaveBeenCalledOnce();
expect(loaded.sendUserMessage).toHaveBeenCalledWith(exactLimit);
expect(onError).toHaveBeenCalledOnce();
});
it("closes a bridge that loads after the lazy wrapper is closed", async () => {
const loaded = createMockRealtimeBridge();
createRealtimeBridgeMock.mockReturnValue(loaded.bridge);
const { bridge } = createLazyRealtimeBridge();
bridge.sendUserMessage?.("before connect");
const connectPromise = bridge.connect();
bridge.close();
bridge.close();
bridge.sendUserMessage?.("after close");
await connectPromise;
expect(loaded.connect).not.toHaveBeenCalled();
expect(loaded.close).toHaveBeenCalledOnce();
expect(loaded.sendUserMessage).not.toHaveBeenCalled();
});
it("clears queued messages and ignores a late connect completion after close", async () => {
const connected = createDeferred<void>();
const loaded = createMockRealtimeBridge(() => connected.promise);
createRealtimeBridgeMock.mockReturnValue(loaded.bridge);
const { bridge } = createLazyRealtimeBridge();
bridge.sendUserMessage?.("before connect");
const connectPromise = bridge.connect();
await vi.waitFor(() => expect(loaded.connect).toHaveBeenCalledOnce());
bridge.sendUserMessage?.("during connect");
bridge.close();
bridge.close();
bridge.sendUserMessage?.("after close");
connected.resolve();
await connectPromise;
signalRealtimeBridgeReady();
expect(loaded.close).toHaveBeenCalledOnce();
expect(loaded.sendUserMessage).not.toHaveBeenCalled();
});
it("keeps close precedence when the readiness callback closes the lazy bridge", async () => {
const loaded = createMockRealtimeBridge();
createRealtimeBridgeMock.mockReturnValue(loaded.bridge);
const bridgeRef: { current?: RealtimeVoiceBridge } = {};
const onReady = vi.fn(() => bridgeRef.current?.close());
const { bridge } = createLazyRealtimeBridge(vi.fn(), onReady);
bridgeRef.current = bridge;
bridge.sendUserMessage?.("queued prompt");
bridge.triggerGreeting?.("queued greeting");
await bridge.connect();
signalRealtimeBridgeReady();
expect(onReady).toHaveBeenCalledOnce();
expect(loaded.close).toHaveBeenCalledOnce();
expect(loaded.sendUserMessage).not.toHaveBeenCalled();
expect(loaded.triggerGreeting).not.toHaveBeenCalled();
});
});