mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
1c7d419444
Frontend, plugin server, MCP service, Stripe app, CLI, Playwright and the CI scripts now say /v1/. Three of these were invisible to a plain search for the literal, and each would have silently stopped matching: - api.ts PROJECT_ID_REGEX, which guards against null/undefined project ids - isExternalLink's scheme test in lib/utils/url.ts - the exporter's interview-token redaction Two more that a naive sweep would have missed: our own cloud hosts precede the path in test assertions and pagination fixtures (us.hanzo.ai/api/…, testserver/api/…), and stripe-app.json's CSP connect-src had to move or the deployed app's /v1/ fetches would be blocked by the browser. Also stops tracking the compiled InsightsQL parser. Building it locally is what makes the URLconf boot at all, and an earlier commit of mine swept the output into git along with this worktree's absolute path; .gitignore now keeps it out. Still at /api/, named rather than assumed: the plugin server's own Express routes (the ingress splits on that prefix and lives in another repo), the SDK aliases the ingress routes to the Rust fleets, the cross-region EU->US spend redirect, and the MCP tool tests that assert paths from generated handlers -- those move with the regeneration, not before it.
312 lines
12 KiB
TypeScript
312 lines
12 KiB
TypeScript
import { describe, expect, it, vi } from 'vitest'
|
|
|
|
import { ApiClient } from '@/api/client'
|
|
import { USER_AGENT, getUserAgent } from '@/lib/constants'
|
|
|
|
describe('ApiClient', () => {
|
|
it('should create ApiClient with required config', () => {
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: 'https://example.com',
|
|
})
|
|
|
|
expect(client).toBeInstanceOf(ApiClient)
|
|
})
|
|
|
|
it('should use custom baseUrl when provided', () => {
|
|
const customUrl = 'https://custom.example.com'
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: customUrl,
|
|
})
|
|
|
|
const baseUrl = (client as any).baseUrl
|
|
expect(baseUrl).toBe(customUrl)
|
|
})
|
|
|
|
describe('publicBaseUrl', () => {
|
|
it('defaults publicBaseUrl to baseUrl when not provided', () => {
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: 'http://insights-web-django.insights.svc.cluster.local:8000',
|
|
})
|
|
expect(client.publicBaseUrl).toBe('http://insights-web-django.insights.svc.cluster.local:8000')
|
|
})
|
|
|
|
it('uses publicBaseUrl override when provided', () => {
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: 'http://insights-web-django.insights.svc.cluster.local:8000',
|
|
publicBaseUrl: 'https://us.hanzo.ai',
|
|
})
|
|
expect(client.baseUrl).toBe('http://insights-web-django.insights.svc.cluster.local:8000')
|
|
expect(client.publicBaseUrl).toBe('https://us.hanzo.ai')
|
|
})
|
|
|
|
it('getProjectBaseUrl uses publicBaseUrl, not baseUrl', () => {
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: 'http://insights-web-django.insights.svc.cluster.local:8000',
|
|
publicBaseUrl: 'https://us.hanzo.ai',
|
|
})
|
|
expect(client.getProjectBaseUrl('42')).toBe('https://us.hanzo.ai/project/42')
|
|
})
|
|
|
|
it('getProjectBaseUrl returns publicBaseUrl alone for @current', () => {
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: 'http://insights-web-django.insights.svc.cluster.local:8000',
|
|
publicBaseUrl: 'https://us.hanzo.ai',
|
|
})
|
|
expect(client.getProjectBaseUrl('@current')).toBe('https://us.hanzo.ai')
|
|
})
|
|
|
|
it('getProjectBaseUrl falls back to baseUrl when publicBaseUrl is unset', () => {
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: 'https://eu.hanzo.ai',
|
|
})
|
|
expect(client.getProjectBaseUrl('7')).toBe('https://eu.hanzo.ai/project/7')
|
|
})
|
|
|
|
it('falls back to baseUrl when publicBaseUrl is an empty string', () => {
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token',
|
|
baseUrl: 'https://eu.hanzo.ai',
|
|
publicBaseUrl: '',
|
|
})
|
|
expect(client.publicBaseUrl).toBe('https://eu.hanzo.ai')
|
|
expect(client.getProjectBaseUrl('7')).toBe('https://eu.hanzo.ai/project/7')
|
|
})
|
|
})
|
|
|
|
it('should send correct headers on fetch', async () => {
|
|
const mockFetch = vi.fn().mockResolvedValue(new Response(JSON.stringify({}), { status: 200 }))
|
|
vi.stubGlobal('fetch', mockFetch)
|
|
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token-123',
|
|
baseUrl: 'https://example.com',
|
|
})
|
|
|
|
// Call the private fetch method
|
|
await (client as any).fetch('https://example.com/v1/test', {
|
|
method: 'POST',
|
|
body: JSON.stringify({ key: 'value' }),
|
|
})
|
|
|
|
expect(mockFetch).toHaveBeenCalledOnce()
|
|
const [, options] = mockFetch.mock.calls[0]!
|
|
expect(options.headers).toEqual({
|
|
Authorization: 'Bearer test-token-123',
|
|
'Content-Type': 'application/json',
|
|
'User-Agent': USER_AGENT,
|
|
'X-Insights-Client': 'mcp',
|
|
})
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
it('should send x-insights-mcp-user-agent header when clientUserAgent is provided', async () => {
|
|
const mockFetch = vi.fn().mockResolvedValue(new Response(JSON.stringify({}), { status: 200 }))
|
|
vi.stubGlobal('fetch', mockFetch)
|
|
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token-123',
|
|
baseUrl: 'https://example.com',
|
|
clientUserAgent: 'insights/wizard 1.0.0',
|
|
})
|
|
|
|
await (client as any).fetch('https://example.com/v1/test', {
|
|
method: 'POST',
|
|
body: JSON.stringify({ key: 'value' }),
|
|
})
|
|
|
|
expect(mockFetch).toHaveBeenCalledOnce()
|
|
const [, options] = mockFetch.mock.calls[0]!
|
|
expect(options.headers).toEqual({
|
|
Authorization: 'Bearer test-token-123',
|
|
'Content-Type': 'application/json',
|
|
'User-Agent': getUserAgent({ clientUserAgent: 'insights/wizard 1.0.0' }),
|
|
'X-Insights-Client': 'mcp',
|
|
'x-insights-mcp-user-agent': 'insights/wizard 1.0.0',
|
|
})
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
it('forwards mcpConsumer as x-insights-mcp-consumer without altering User-Agent', async () => {
|
|
const mockFetch = vi.fn().mockResolvedValue(new Response(JSON.stringify({}), { status: 200 }))
|
|
vi.stubGlobal('fetch', mockFetch)
|
|
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token-123',
|
|
baseUrl: 'https://example.com',
|
|
mcpConsumer: 'plugin',
|
|
mcpClientName: 'claude-code',
|
|
})
|
|
|
|
await (client as any).fetch('https://example.com/v1/test', {
|
|
method: 'POST',
|
|
body: JSON.stringify({ key: 'value' }),
|
|
})
|
|
|
|
expect(mockFetch).toHaveBeenCalledOnce()
|
|
const [, options] = mockFetch.mock.calls[0]!
|
|
expect(options.headers).toEqual({
|
|
Authorization: 'Bearer test-token-123',
|
|
'Content-Type': 'application/json',
|
|
'User-Agent': USER_AGENT,
|
|
'X-Insights-Client': 'mcp',
|
|
'x-insights-mcp-client-name': 'claude-code',
|
|
'x-insights-mcp-consumer': 'plugin',
|
|
})
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
it('forwards mcpConsumer alone when mcpClientName is missing', async () => {
|
|
const mockFetch = vi.fn().mockResolvedValue(new Response(JSON.stringify({}), { status: 200 }))
|
|
vi.stubGlobal('fetch', mockFetch)
|
|
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token-123',
|
|
baseUrl: 'https://example.com',
|
|
mcpConsumer: 'slack',
|
|
})
|
|
|
|
await (client as any).fetch('https://example.com/v1/test', { method: 'GET' })
|
|
|
|
const [, options] = mockFetch.mock.calls[0]!
|
|
expect(options.headers['User-Agent']).toBe(USER_AGENT)
|
|
expect(options.headers['x-insights-mcp-consumer']).toBe('slack')
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
it.each([
|
|
[
|
|
'both ids set',
|
|
{ mcpSessionId: 'abc123session', mcpConversationId: '01984ad9-bda4-7000-8000-abcdef012345' },
|
|
{
|
|
'x-insights-mcp-session-id': 'abc123session',
|
|
'x-insights-mcp-conversation-id': '01984ad9-bda4-7000-8000-abcdef012345',
|
|
},
|
|
],
|
|
['only session id set', { mcpSessionId: 'only-session' }, { 'x-insights-mcp-session-id': 'only-session' }],
|
|
['neither id set', {}, {}],
|
|
] as const)('forwards mcp id headers — %s', async (_label, extraConfig, expectedHeaders) => {
|
|
const mockFetch = vi.fn().mockResolvedValue(new Response(JSON.stringify({}), { status: 200 }))
|
|
vi.stubGlobal('fetch', mockFetch)
|
|
|
|
const client = new ApiClient({
|
|
apiToken: 'test-token-123',
|
|
baseUrl: 'https://example.com',
|
|
...extraConfig,
|
|
})
|
|
|
|
await (client as any).fetch('https://example.com/v1/test', { method: 'GET' })
|
|
|
|
const [, options] = mockFetch.mock.calls[0]!
|
|
for (const [header, value] of Object.entries(expectedHeaders)) {
|
|
expect(options.headers[header]).toBe(value)
|
|
}
|
|
const absent = ['x-insights-mcp-session-id', 'x-insights-mcp-conversation-id'].filter(
|
|
(h) => !(h in expectedHeaders)
|
|
)
|
|
for (const header of absent) {
|
|
expect(options.headers).not.toHaveProperty(header)
|
|
}
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
describe('insights().get() — overrides forwarding', () => {
|
|
const variablesOverride =
|
|
'{"019d4838-1da4-0000-33c7-2561bf01f1c9":{"code_name":"eventname","variableId":"019d4838-1da4-0000-33c7-2561bf01f1c9","value":"signed_up"}}'
|
|
const filtersOverride = '{"date_from":"-7d"}'
|
|
|
|
function setupClient(): { client: ApiClient; mockFetch: ReturnType<typeof vi.fn> } {
|
|
const mockFetch = vi.fn()
|
|
vi.stubGlobal('fetch', mockFetch)
|
|
const client = new ApiClient({ apiToken: 'test-token', baseUrl: 'https://example.com' })
|
|
return { client, mockFetch }
|
|
}
|
|
|
|
it('hits the retrieve endpoint with no query string when called by numeric id and no overrides', async () => {
|
|
const { client, mockFetch } = setupClient()
|
|
mockFetch.mockResolvedValueOnce(
|
|
new Response(JSON.stringify({ id: 42, short_id: 'abc12345' }), { status: 200 })
|
|
)
|
|
|
|
await client.insights({ projectId: '1' }).get({ insightId: '42' })
|
|
|
|
expect(mockFetch).toHaveBeenCalledTimes(1)
|
|
const [url] = mockFetch.mock.calls[0]!
|
|
expect(url).toBe('https://example.com/v1/projects/1/insights/42/')
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
it('hits the retrieve endpoint with the override query string when called by numeric id with overrides', async () => {
|
|
const { client, mockFetch } = setupClient()
|
|
mockFetch.mockResolvedValueOnce(
|
|
new Response(JSON.stringify({ id: 42, short_id: 'abc12345' }), { status: 200 })
|
|
)
|
|
|
|
await client.insights({ projectId: '1' }).get({
|
|
insightId: '42',
|
|
variables_override: variablesOverride,
|
|
filters_override: filtersOverride,
|
|
})
|
|
|
|
expect(mockFetch).toHaveBeenCalledTimes(1)
|
|
const [url] = mockFetch.mock.calls[0]!
|
|
expect(url).toContain('https://example.com/v1/projects/1/insights/42/?')
|
|
expect(url).toContain(`variables_override=${encodeURIComponent(variablesOverride)}`)
|
|
expect(url).toContain(`filters_override=${encodeURIComponent(filtersOverride)}`)
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
it('resolves short_id via the list endpoint in one hop when no overrides are provided', async () => {
|
|
const { client, mockFetch } = setupClient()
|
|
mockFetch.mockResolvedValueOnce(
|
|
new Response(JSON.stringify({ results: [{ id: 42, short_id: 'abc12345' }] }), { status: 200 })
|
|
)
|
|
|
|
const result = await client.insights({ projectId: '1' }).get({ insightId: 'abc12345' })
|
|
|
|
expect(mockFetch).toHaveBeenCalledTimes(1)
|
|
const [url] = mockFetch.mock.calls[0]!
|
|
expect(url).toContain('/v1/projects/1/insights/?short_id=abc12345')
|
|
expect(result.success).toBe(true)
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
|
|
it('resolves short_id and applies overrides in a single list call', async () => {
|
|
const { client, mockFetch } = setupClient()
|
|
mockFetch.mockResolvedValueOnce(
|
|
new Response(JSON.stringify({ results: [{ id: 42, short_id: 'abc12345' }] }), { status: 200 })
|
|
)
|
|
|
|
await client.insights({ projectId: '1' }).get({
|
|
insightId: 'abc12345',
|
|
variables_override: variablesOverride,
|
|
})
|
|
|
|
// The list endpoint runs the same InsightSerializer.to_representation
|
|
// and applies overrides from query_params, so a single hop suffices.
|
|
expect(mockFetch).toHaveBeenCalledTimes(1)
|
|
const [url] = mockFetch.mock.calls[0]!
|
|
expect(url).toContain('/v1/projects/1/insights/?')
|
|
expect(url).toContain('short_id=abc12345')
|
|
expect(url).toContain(`variables_override=${encodeURIComponent(variablesOverride)}`)
|
|
expect(url).not.toContain('filters_override')
|
|
|
|
vi.unstubAllGlobals()
|
|
})
|
|
})
|
|
})
|