Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion apps/api/src/routes/__tests__/public-metadata.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Hono } from 'hono'
import { type Mock, beforeEach, describe, expect, it, vi } from 'vitest'
import { beforeEach, describe, expect, it, type Mock, vi } from 'vitest'

vi.mock('../../db/client.js', () => ({
db: {
Expand All @@ -18,6 +18,11 @@ vi.mock('../../db/schema.js', () => ({
},
}))

const isOauthChannelConfigured = vi.fn()
vi.mock('../../lib/oidc.js', () => ({
isOauthChannelConfigured: () => isOauthChannelConfigured(),
}))

import { db } from '../../db/client.js'

import { asyncQuery } from '../../test/async-query.js'
Expand All @@ -39,6 +44,7 @@ describe('Public metadata routes', () => {

beforeEach(async () => {
vi.clearAllMocks()
isOauthChannelConfigured.mockResolvedValue(true)
const mod = await import('../public-metadata.js')
app = new Hono()
app.route('/api/public', mod.default)
Expand Down Expand Up @@ -128,6 +134,41 @@ describe('Public metadata routes', () => {
})
})

it('reports OAuth as disabled when the platform channel is not configured', async () => {
isOauthChannelConfigured.mockResolvedValue(false)
;(db.select as Mock).mockReturnValue(
selectChain([
{
id: 'agt_1',
name: 'Agent One',
description: 'desc',
publishStatus: 'published',
publishChannels: ['oauth'],
oauthAccessMode: 'all_idaas_users',
},
]),
)

const res = await app.request('/api/public/agents/metadata?agentId=agt_1')

expect(res.status).toBe(200)
expect(await res.json()).toEqual({
data: [
{
agentId: 'agt_1',
exists: true,
metadata: {
name: 'Agent One',
description: 'desc',
oauthEnabled: false,
oauthAccessMode: 'all_idaas_users',
},
},
],
})
expect(isOauthChannelConfigured).toHaveBeenCalledTimes(1)
})

it('hides missing, draft, and stopped agents behind exists=false', async () => {
;(db.select as Mock).mockReturnValue(
selectChain([
Expand Down
30 changes: 17 additions & 13 deletions apps/api/src/routes/public-metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Hono } from 'hono'
import { db } from '../db/client.js'
import { agents } from '../db/schema.js'
import { normalizeOauthAccessMode } from '../lib/gateway-auth-errors.js'
import { isOauthChannelConfigured } from '../lib/oidc.js'

const MAX_AGENT_IDS = 50

Expand All @@ -26,22 +27,25 @@ app.get('/agents/metadata', async (c) => {
return c.json({ error: `agentIds supports at most ${MAX_AGENT_IDS} IDs` }, 400)
}

const rows = await db
.select({
id: agents.id,
name: agents.name,
description: agents.description,
publishStatus: agents.publishStatus,
publishChannels: agents.publishChannels,
oauthAccessMode: agents.oauthAccessMode,
})
.from(agents)
.where(inArray(agents.id, requestedIds))
const [rows, oauthChannelConfigured] = await Promise.all([
db
.select({
id: agents.id,
name: agents.name,
description: agents.description,
publishStatus: agents.publishStatus,
publishChannels: agents.publishChannels,
oauthAccessMode: agents.oauthAccessMode,
})
.from(agents)
.where(inArray(agents.id, requestedIds)),
isOauthChannelConfigured(),
])

const byId = new Map(rows.map((agent) => [agent.id, agent]))
const data = requestedIds.map((agentId) => {
const agent = byId.get(agentId)
if (!agent || agent.publishStatus !== 'published') {
if (agent?.publishStatus !== 'published') {
return { agentId, exists: false, metadata: null }
}

Expand All @@ -52,7 +56,7 @@ app.get('/agents/metadata', async (c) => {
metadata: {
name: agent.name,
description: agent.description ?? '',
oauthEnabled: publishChannels.includes('oauth'),
oauthEnabled: publishChannels.includes('oauth') && oauthChannelConfigured,
oauthAccessMode: normalizeOauthAccessMode(agent.oauthAccessMode),
},
}
Expand Down
4 changes: 2 additions & 2 deletions apps/web/src/content/manual/en/12-triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,13 @@ If an external system only needs to display public info about published Agents,
curl ".../api/public/agents/metadata?agentIds=agt_1,agt_2"
```

The returned fields include the Agent name, the description from its config page, whether the OAuth channel is enabled, and the OAuth access mode:
The returned fields include the Agent name, the description from its config page, whether the OAuth channel is currently available, and the OAuth access mode:

| Field | Description |
|------|------|
| `name` | Agent name |
| `description` | Description from the Agent's config page |
| `oauthEnabled` | Whether the publish channels include OAuth |
| `oauthEnabled` | `true` when the Agent publishes OAuth and the platform has enterprise OIDC plus a non-empty OAuth channel audience configured; `false` when the Agent switch is on but the platform cannot yet verify callers |
| `oauthAccessMode` | `all_idaas_users` means all enterprise users; `specified_users` means only the addresses on the allowlist |

Agents that are unpublished, stopped, or nonexistent uniformly return `exists: false`, without exposing draft information.
Expand Down
4 changes: 2 additions & 2 deletions apps/web/src/content/manual/zh/12-triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,13 +140,13 @@ OAuth 调用地址是 `POST /api/oauth/:agentId/invoke`。请求头携带调用
curl ".../api/public/agents/metadata?agentIds=agt_1,agt_2"
```

返回字段包括 Agent 名称、配置页描述、是否开启 OAuth 渠道,以及 OAuth 访问范围:
返回字段包括 Agent 名称、配置页描述、OAuth 渠道当前是否可用,以及 OAuth 访问范围:

| 字段 | 说明 |
|------|------|
| `name` | Agent 名称 |
| `description` | Agent 配置页的描述 |
| `oauthEnabled` | 发布渠道是否包含 OAuth |
| `oauthEnabled` | Agent 已发布 OAuth 渠道,且平台已配置企业 OIDC 与非空的 OAuth 渠道受众时为 `true`;只开启 Agent 渠道但平台尚不能验签时为 `false` |
| `oauthAccessMode` | `all_idaas_users` 表示全体企业用户;`specified_users` 表示仅名单内的指定企业用户 |

未发布、已停止或不存在的 Agent 会统一返回 `exists: false`,不会暴露草稿信息。
Expand Down