mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
A key now opens with what it is allowed to touch. `pk-` is publishable and safe in a browser; `sk-` is secret and never leaves a server. The five marks it replaces all began `ph` -- the upstream's initials -- and they were the last of its brand a customer read back to us, in every SDK snippet. No word rule could reach them, because `ph` is not a word. The marks were also not telling the truth. The constant said `phc_` while every live project token said `hi_`, so the middleware that routes on the constant matched no real token at all. Two spellings existed and one was fiction. Minting now happens in exactly one function and reading in exactly one, so a second spelling has nowhere to live. `phx_` (personal) and `phs_` (project secret) both become `sk-`. The mark now says only that a value is secret; which store holds it is settled by asking. That was already how personal keys worked -- keys minted before the marks carry none, so the store always decided -- and both secret resolvers already returned None on a miss and fell through, so one shared extractor replaces the two that could drift apart. OAuth's access and refresh tokens stay distinguishable as `at-` and `rt-`, because the parser tells them apart before either is looked up, and the domain-verification token becomes `vt-` rather than keeping a sixth mint of its own. `bin/debrand --check` now refuses the marks as a shape, so a seventh cannot be coined. Two rules that were about to rename things that are not ours to spell are bounded: `Lemon` no longer eats `LemonSqueezy`, and the `hog_flow` rules no longer reach a Postgres table, a Datastore table or a route. Keys are stored hashed, so a mark cannot be rewritten in place: the three live project tokens have to be reminted.
340 lines
14 KiB
TypeScript
340 lines
14 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
const { mockSessionStore, mockTokenStore } = vi.hoisted(() => ({
|
|
mockSessionStore: new Map<string, unknown>(),
|
|
mockTokenStore: new Map<string, unknown>(),
|
|
}))
|
|
|
|
vi.mock('@/lib/insights/flags', () => ({
|
|
evaluateFeatureFlags: vi.fn(async () => ({})),
|
|
resolveFeatureFlagOverrides: vi.fn(() => ({})),
|
|
}))
|
|
|
|
vi.mock('@/hono/cache/McpSessionRedisStore', () => ({
|
|
McpSessionRedisStore: class {
|
|
async resolve(requestContext: Record<string, unknown>): Promise<Record<string, unknown>> {
|
|
const keys = ['mcpClientName', 'mcpClientVersion', 'mcpProtocolVersion', 'mcpConsumer', 'mcpVendorClient']
|
|
const resolved = Object.fromEntries(
|
|
keys.map((key) => [key, mockSessionStore.get(key) ?? requestContext[key]])
|
|
)
|
|
for (const key of keys) {
|
|
if (!mockSessionStore.has(key) && requestContext[key] !== undefined) {
|
|
mockSessionStore.set(key, requestContext[key])
|
|
}
|
|
}
|
|
return resolved
|
|
}
|
|
},
|
|
}))
|
|
|
|
vi.mock('@/hono/request-context', () => {
|
|
type MockCache = {
|
|
get: (key: string) => Promise<unknown>
|
|
set: (key: string, value: unknown) => Promise<void>
|
|
setMany: (entries: Record<string, unknown>) => Promise<void>
|
|
delete: (key: string) => Promise<void>
|
|
clear: () => Promise<void>
|
|
}
|
|
|
|
const makeCache = (store: Map<string, unknown>): MockCache => ({
|
|
get: vi.fn(async (key: string) => store.get(key)),
|
|
set: vi.fn(async (key: string, value: unknown) => {
|
|
store.set(key, value)
|
|
}),
|
|
setMany: vi.fn(async (entries: Record<string, unknown>) => {
|
|
for (const [key, value] of Object.entries(entries)) {
|
|
if (value !== undefined) {
|
|
store.set(key, value)
|
|
}
|
|
}
|
|
}),
|
|
delete: vi.fn(async (key: string) => {
|
|
store.delete(key)
|
|
}),
|
|
clear: vi.fn(async () => {
|
|
store.clear()
|
|
}),
|
|
})
|
|
|
|
return {
|
|
RequestContext: vi.fn().mockImplementation(function () {
|
|
return {
|
|
tokenCache: makeCache(mockTokenStore),
|
|
getContext: vi.fn(async () => ({
|
|
stateManager: {
|
|
setDefaultOrganizationAndProject: vi.fn(async () => {}),
|
|
getApiKey: vi.fn(async () => ({ scopes: ['*'], scoped_teams: [] })),
|
|
getAiConsentGiven: vi.fn(async () => undefined),
|
|
getOrFetchGroupTypes: vi.fn(async () => undefined),
|
|
getEnvironmentPrompt: vi.fn(async () => undefined),
|
|
getAvailableFeatures: vi.fn(async () => undefined),
|
|
},
|
|
})),
|
|
safelyGetAnalyticsContext: vi.fn(async () => undefined),
|
|
getDistinctId: vi.fn(async () => 'distinct-id'),
|
|
setMcpContexts: vi.fn(),
|
|
}
|
|
}),
|
|
}
|
|
})
|
|
|
|
import type { RedisLike } from '@/hono/cache/RedisCache'
|
|
import { RequestStateResolver } from '@/hono/request-state-resolver'
|
|
import { resolveFeatureFlagOverrides } from '@/lib/insights/flags'
|
|
import type { RequestProperties } from '@/lib/request-properties'
|
|
import type { Env } from '@/tools/types'
|
|
|
|
function makeProps(overrides: Partial<RequestProperties> = {}): RequestProperties {
|
|
return {
|
|
apiToken: 'sk-test',
|
|
userHash: 'test-user',
|
|
mcpSessionId: 'mcp-session-1',
|
|
mcpClientName: 'claude-code',
|
|
mcpClientVersion: '1.0',
|
|
mcpProtocolVersion: '2025-03-26',
|
|
projectId: '1',
|
|
requestStartTime: Date.now(),
|
|
transport: 'streamable-http',
|
|
...overrides,
|
|
}
|
|
}
|
|
|
|
function makeResolver(): RequestStateResolver {
|
|
const catalog = {
|
|
getFilteredTools: vi.fn(() => []),
|
|
}
|
|
return new RequestStateResolver(catalog as any, {} as RedisLike, {} as Env)
|
|
}
|
|
|
|
describe('RequestStateResolver MCP client contexts', () => {
|
|
beforeEach(() => {
|
|
mockSessionStore.clear()
|
|
mockTokenStore.clear()
|
|
})
|
|
|
|
it('stores client props, but not resolved mode, for a new MCP session', async () => {
|
|
const props = makeProps()
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(props.mode).toBe('cli')
|
|
expect(result.requestContext).toMatchObject({
|
|
mcpClientName: 'claude-code',
|
|
mcpClientVersion: '1.0',
|
|
mcpProtocolVersion: '2025-03-26',
|
|
mode: 'cli',
|
|
})
|
|
expect(result.sessionContext).toMatchObject({
|
|
mcpClientName: 'claude-code',
|
|
mcpClientVersion: '1.0',
|
|
mcpProtocolVersion: '2025-03-26',
|
|
})
|
|
expect(mockSessionStore.get('mcpClientName')).toBe('claude-code')
|
|
expect(mockSessionStore.get('mcpClientVersion')).toBe('1.0')
|
|
expect(mockSessionStore.get('mcpProtocolVersion')).toBe('2025-03-26')
|
|
expect(mockSessionStore.get('mcpMode')).toBeUndefined()
|
|
})
|
|
|
|
it('does not store mode for a new MCP session when the mode was explicit', async () => {
|
|
const props = makeProps({ mode: 'tools' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.useSingleExec).toBe(false)
|
|
expect(props.mode).toBe('tools')
|
|
expect(result.requestContext.mode).toBe('tools')
|
|
expect(mockSessionStore.get('mcpMode')).toBeUndefined()
|
|
})
|
|
|
|
it('uses cached session client props when request client detection would resolve differently', async () => {
|
|
// Cursor pins tools mode at initialize; a later request self-reporting a
|
|
// cli-defaulting client must not downgrade the session out of tools mode.
|
|
await makeResolver().resolve(makeProps({ mcpClientName: 'cursor' }))
|
|
|
|
const props = makeProps({ mcpClientName: 'claude-code' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.useSingleExec).toBe(false)
|
|
expect(props.mode).toBe('tools')
|
|
expect(props.mcpClientName).toBe('claude-code')
|
|
expect(result.requestContext.mcpClientName).toBe('claude-code')
|
|
expect(result.sessionContext?.mcpClientName).toBe('cursor')
|
|
expect(result.clientProfile.clientName).toBe('cursor')
|
|
})
|
|
|
|
it('auto-selects tools mode from the ChatGPT user-agent', async () => {
|
|
// ChatGPT's clientInfo.name is generic; the surface only shows up in the
|
|
// User-Agent. Guards the `userAgent: props.clientUserAgent` profile plumbing.
|
|
const props = makeProps({ mcpClientName: undefined, clientUserAgent: 'openai-mcp/1.0.0 (ChatGPT)' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.useSingleExec).toBe(false)
|
|
expect(props.mode).toBe('tools')
|
|
})
|
|
|
|
it('defaults to cli mode when no client hints are present', async () => {
|
|
const props = makeProps({
|
|
mcpClientName: undefined,
|
|
mcpClientVersion: undefined,
|
|
mcpProtocolVersion: undefined,
|
|
})
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(props.mode).toBe('cli')
|
|
})
|
|
|
|
it('uses cached session client props for instruction capabilities without overwriting request props', async () => {
|
|
await makeResolver().resolve(makeProps({ mcpClientName: 'codex' }))
|
|
|
|
const props = makeProps({ mcpClientName: 'Claude Desktop' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(props.mcpClientName).toBe('Claude Desktop')
|
|
expect(result.requestContext.mcpClientName).toBe('Claude Desktop')
|
|
expect(result.sessionContext?.mcpClientName).toBe('codex')
|
|
expect(result.clientProfile.clientName).toBe('codex')
|
|
expect(result.clientProfile.capabilities.supportsInstructions).toBe(false)
|
|
})
|
|
|
|
it('uses explicit mode when cached session client props would resolve differently', async () => {
|
|
await makeResolver().resolve(makeProps())
|
|
|
|
const props = makeProps({ mode: 'tools' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.useSingleExec).toBe(false)
|
|
expect(props.mode).toBe('tools')
|
|
})
|
|
|
|
it('does not pin mode without an MCP session ID', async () => {
|
|
const props = makeProps({ mcpSessionId: undefined })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(props.mode).toBe('cli')
|
|
expect(result.sessionContext).toBeNull()
|
|
expect(result.requestContext.mcpClientName).toBe('claude-code')
|
|
expect(mockSessionStore.get('mcpMode')).toBeUndefined()
|
|
})
|
|
|
|
it('uses cached vendor client when the live vendor header would resolve differently', async () => {
|
|
await makeResolver().resolve(
|
|
makeProps({
|
|
mcpClientName: 'Anthropic/ClaudeAI',
|
|
mcpVendorClient: 'ClaudeCode',
|
|
})
|
|
)
|
|
expect(mockSessionStore.get('mcpVendorClient')).toBe('ClaudeCode')
|
|
|
|
const pooled = makeProps({
|
|
mcpClientName: 'Anthropic/ClaudeAI',
|
|
mcpVendorClient: 'ClaudeAI',
|
|
})
|
|
const result = await makeResolver().resolve(pooled)
|
|
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(pooled.mode).toBe('cli')
|
|
expect(pooled.mcpVendorClient).toBe('ClaudeAI')
|
|
expect(result.requestContext.mcpVendorClient).toBe('ClaudeAI')
|
|
expect(result.sessionContext?.mcpVendorClient).toBe('ClaudeCode')
|
|
expect(result.clientProfile.vendorClient).toBe('ClaudeCode')
|
|
})
|
|
|
|
it('captures vendor client from a later request when initialize omitted the header', async () => {
|
|
await makeResolver().resolve(
|
|
makeProps({
|
|
mcpClientName: 'Anthropic/ClaudeAI',
|
|
mcpVendorClient: undefined,
|
|
})
|
|
)
|
|
expect(mockSessionStore.get('mcpVendorClient')).toBeUndefined()
|
|
|
|
const pooled = makeProps({
|
|
mcpClientName: 'Anthropic/ClaudeAI',
|
|
mcpVendorClient: 'ClaudeCode',
|
|
})
|
|
const result = await makeResolver().resolve(pooled)
|
|
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(pooled.mode).toBe('cli')
|
|
expect(result.requestContext.mcpVendorClient).toBe('ClaudeCode')
|
|
expect(result.sessionContext?.mcpVendorClient).toBe('ClaudeCode')
|
|
expect(mockSessionStore.get('mcpVendorClient')).toBe('ClaudeCode')
|
|
})
|
|
|
|
it('puts Claude web/desktop in single-exec and enables render-ui', async () => {
|
|
const props = makeProps({ mcpClientName: 'Claude Desktop', mcpVendorClient: 'ClaudeAI' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.renderUiEnabled).toBe(true)
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(props.mode).toBe('cli')
|
|
})
|
|
|
|
it('puts header-less Claude.ai (pooled Anthropic/* name + Claude-User UA, no vendor header) in single-exec', async () => {
|
|
// The production gap: Claude.ai web/desktop sessions that omit the
|
|
// x-anthropic-client header and report only clientInfo.name "Anthropic/ClaudeAI"
|
|
// with a Claude-User user-agent previously fell into tools mode.
|
|
const props = makeProps({
|
|
mcpClientName: 'Anthropic/ClaudeAI',
|
|
mcpVendorClient: undefined,
|
|
clientUserAgent: 'Claude-User',
|
|
})
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(props.mode).toBe('cli')
|
|
})
|
|
|
|
it('does not enable render-ui for Claude Code', async () => {
|
|
// Claude Code is a single-exec CLI client but not an MCP Apps host — it can't
|
|
// mount the iframe. It must stay in single-exec while `renderUiEnabled` resolves
|
|
// to false, so the tool-executor never advertises or accepts `render-ui` for it.
|
|
const props = makeProps({ mcpClientName: 'Anthropic/ClaudeAI', mcpVendorClient: 'ClaudeCode' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.renderUiEnabled).toBe(false)
|
|
expect(result.useSingleExec).toBe(true)
|
|
})
|
|
|
|
it('detects Claude web/desktop via the Claude-User user agent and enables render-ui', async () => {
|
|
const props = makeProps({ mcpClientName: 'Claude Desktop', clientUserAgent: 'Claude-User' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.renderUiEnabled).toBe(true)
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(props.mode).toBe('cli')
|
|
})
|
|
|
|
it('honors a dev/test flag override even when evaluation returns nothing', async () => {
|
|
// Evaluation stays empty (analytics client disabled, as in local dev/evals);
|
|
// the override seam is what flips a tool flag on so it reaches the tool layer.
|
|
vi.mocked(resolveFeatureFlagOverrides).mockReturnValueOnce({ 'dev-forced-flag': true })
|
|
const props = makeProps({ mcpClientName: 'Claude Desktop', mcpVendorClient: 'ClaudeAI' })
|
|
const result = await makeResolver().resolve(props)
|
|
|
|
expect(result.toolFeatureFlags?.['dev-forced-flag']).toBe(true)
|
|
})
|
|
|
|
it('captures consumer from a later request when initialize omitted the header', async () => {
|
|
await makeResolver().resolve(
|
|
makeProps({
|
|
mcpClientName: 'Claude Desktop',
|
|
mcpConsumer: undefined,
|
|
})
|
|
)
|
|
expect(mockSessionStore.get('mcpConsumer')).toBeUndefined()
|
|
|
|
const insightsCode = makeProps({
|
|
mcpClientName: 'Claude Desktop',
|
|
mcpConsumer: 'insights-code',
|
|
})
|
|
const result = await makeResolver().resolve(insightsCode)
|
|
|
|
expect(result.useSingleExec).toBe(true)
|
|
expect(insightsCode.mode).toBe('cli')
|
|
expect(result.requestContext.mcpConsumer).toBe('insights-code')
|
|
expect(result.sessionContext?.mcpConsumer).toBe('insights-code')
|
|
expect(mockSessionStore.get('mcpConsumer')).toBe('insights-code')
|
|
})
|
|
})
|