arcrun — AI workflow execution engine (clean history)
Self-hosted 開源：WASM 零件 + recipe + cypher-executor，跑在你自己的 Cloudflare。 此為重建的乾淨歷史起點（移除曾誤 commit 的 GCP SA 金鑰，舊歷史保留在 richblack/arcrun 與本地 backup 分支）。含： - acr init --self-hosted installer（建 KV/R2 + codeload 拉預編譯 wasm + wrangler deploy + seed recipe） - recipe push 把關（資料外流提醒 + 打通檢查） - 19 個正當零件預編譯 wasm（claude_api/km_writer/kbdb_upsert_block 排除：違反 DECISIONS §1） - CLI / cypher-executor / registry / 完整 SDD Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
uncle6me-web
@@ -0,0 +1,611 @@
|
||||
# Design Document: arcrun MVP
|
||||
|
||||
## Overview
|
||||
|
||||
arcrun MVP 的核心設計原則是**最小異動、最快可用**。所有目標都能透過以下三個操作達成：
|
||||
1. **Cherry-pick**：從 `matrix` 搬移指定目錄，不重寫
|
||||
2. **Carve-out**：移除 cypher-executor 中與 InkStone 耦合的程式碼路徑
|
||||
3. **Supplement**：補充 contract.yaml 缺少的欄位、新增 CLI
|
||||
|
||||
不建立新的抽象層，不改變現有零件邏輯，只做讓開源可用所需的最小改動。
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
### 目標 Repo 結構
|
||||
|
||||
```
|
||||
arcrun/（新獨立開源 repo）
|
||||
├── README.md
|
||||
├── CONTRIBUTING.md
|
||||
├── cypher-executor/
|
||||
│ ├── src/
|
||||
│ │ ├── index.ts
|
||||
│ │ ├── types.ts
|
||||
│ │ ├── graph-executor.ts
|
||||
│ │ ├── lib/
|
||||
│ │ │ ├── component-loader.ts ← 改：只從 WASM_BUCKET 讀，移除 KBDB/REGISTRY 邏輯
|
||||
│ │ │ ├── component-dispatcher.ts
|
||||
│ │ │ ├── wasm-executor.ts
|
||||
│ │ │ ├── wasi-shim.ts
|
||||
│ │ │ └── constants.ts ← 改：移除 MINI_ME / KBDB 特殊零件 hardcode
|
||||
│ │ └── actions/
|
||||
│ │ ├── triplet-parser.ts
|
||||
│ │ ├── graph-builder.ts
|
||||
│ │ ├── execution-evaluator.ts
|
||||
│ │ ├── execution-logger.ts
|
||||
│ │ ├── webhook-handlers.ts
|
||||
│ │ ├── webhook-graph-resolver.ts ← 改：加入 credential 注入邏輯
|
||||
│ │ └── (移除 autoPublishMissing.ts)
|
||||
│ └── wrangler.toml ← 改：移除 9 個 InkStone bindings，新增 CREDENTIALS_KV
|
||||
├── credentials/ ← 直接搬移，無需修改
|
||||
│ └── src/...
|
||||
├── builtins/ ← 直接搬移，無需修改
|
||||
│ └── src/...
|
||||
└── registry/
|
||||
└── components/ ← 搬移後補充 contract.yaml
|
||||
├── gmail/
|
||||
├── google_sheets/
|
||||
├── telegram/
|
||||
├── line_notify/
|
||||
├── ... (其餘 17 個零件)
|
||||
└── cli/ ← 新增：arcrun CLI
|
||||
├── package.json
|
||||
├── tsconfig.json
|
||||
└── src/
|
||||
├── index.ts
|
||||
├── commands/
|
||||
│ ├── init.ts
|
||||
│ ├── creds.ts
|
||||
│ ├── push.ts
|
||||
│ ├── run.ts
|
||||
│ ├── validate.ts
|
||||
│ ├── parts.ts
|
||||
│ ├── list.ts
|
||||
│ └── logs.ts
|
||||
└── lib/
|
||||
├── config.ts # 讀寫 ~/.arcrun/config.yaml
|
||||
├── cf-api.ts # Cloudflare KV / R2 HTTP API wrapper
|
||||
└── yaml-parser.ts # workflow.yaml 解析與三元組轉換
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Component Loader 改造（關鍵變更）
|
||||
|
||||
### 現況（matrix 版）
|
||||
|
||||
```typescript
|
||||
// component-loader.ts 現有四層優先序：
|
||||
// 1. 特殊零件 hardcode → MINI_ME / KBDB Service Binding
|
||||
// 2. 內建零件 Map → 本地純轉換
|
||||
// 3. 新版：查詢 KBDB record 含 component_type → WASM 或 Service Binding
|
||||
// 4. 舊版 fallback：查詢無 component_type 的 KBDB record
|
||||
```
|
||||
|
||||
### 開源版（arcrun）
|
||||
|
||||
```typescript
|
||||
// component-loader.ts 簡化為三層：
|
||||
// 1. 內建零件 Map → 本地純轉換（passthrough / counter 等，保留）
|
||||
// 2. WASM_BUCKET R2 直讀 → component-name.wasm
|
||||
// 3. 找不到 → 回傳結構化錯誤
|
||||
|
||||
async function loadComponent(componentId: string, env: Env) {
|
||||
// 層 1：內建零件（無需 R2）
|
||||
if (BUILTIN_COMPONENTS.has(componentId)) {
|
||||
return BUILTIN_COMPONENTS.get(componentId)
|
||||
}
|
||||
|
||||
// 層 2：從 WASM_BUCKET R2 讀取
|
||||
const wasmKey = `${componentId}/${componentId}.wasm`
|
||||
const wasmObj = await env.WASM_BUCKET.get(wasmKey)
|
||||
if (wasmObj) {
|
||||
return { type: 'wasm', buffer: await wasmObj.arrayBuffer() }
|
||||
}
|
||||
|
||||
// 層 3：找不到
|
||||
throw new Error(`Component not found: ${componentId}. 請確認 ${wasmKey} 存在於 WASM_BUCKET。`)
|
||||
}
|
||||
```
|
||||
|
||||
移除：`MINI_ME`、`KBDB` 特殊零件的 hardcode 路徑（`comp_claude_chat`、`comp_kbdb_search`、`comp_kbdb_history`）。
|
||||
|
||||
---
|
||||
|
||||
## Credential 注入流程設計
|
||||
|
||||
### 執行時序
|
||||
|
||||
```
|
||||
acr run newsletter_subscribe
|
||||
↓
|
||||
cypher-executor POST /webhook/:id
|
||||
↓
|
||||
webhook-graph-resolver 讀 WEBHOOKS KV → workflow 定義
|
||||
↓
|
||||
graph-executor 執行節點 send_thanks
|
||||
↓
|
||||
執行前：credential-injector（新增）
|
||||
查 send_thanks 對應零件 canonical_id = "gmail"
|
||||
讀 registry/components/gmail/component.contract.yaml
|
||||
發現 credentials_required: [{key: "gmail_token", inject_as: "access_token"}]
|
||||
GET CREDENTIALS_KV["gmail_token"] → AES-GCM 解密
|
||||
input.access_token = decryptedToken
|
||||
↓
|
||||
wasm-executor 執行 gmail.wasm（stdin = 含 access_token 的完整 input）
|
||||
↓
|
||||
回傳結果
|
||||
```
|
||||
|
||||
### credential-injector 實作位置
|
||||
|
||||
放在 `cypher-executor/src/actions/credential-injector.ts`（新增），由 `graph-executor.ts` 在每個節點執行前呼叫。
|
||||
|
||||
```typescript
|
||||
async function injectCredentials(
|
||||
componentId: string,
|
||||
input: Record<string, unknown>,
|
||||
env: Env
|
||||
): Promise<Record<string, unknown>> {
|
||||
const contract = await loadContract(componentId) // 從 WASM_BUCKET 或本地讀取
|
||||
if (!contract.credentials_required) return input
|
||||
|
||||
const enriched = { ...input }
|
||||
for (const cred of contract.credentials_required) {
|
||||
const record = await env.CREDENTIALS_KV.get(cred.key)
|
||||
if (!record) {
|
||||
throw new Error(
|
||||
`缺少 credential: ${cred.key}\n修復：在 credentials.yaml 加入 ${cred.key} 後執行 acr creds push`
|
||||
)
|
||||
}
|
||||
const { encrypted, iv } = JSON.parse(record)
|
||||
enriched[cred.inject_as] = await decrypt(encrypted, iv, env.ENCRYPTION_KEY)
|
||||
}
|
||||
return enriched
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## workflow.yaml 解析設計
|
||||
|
||||
### CLI push 流程
|
||||
|
||||
```
|
||||
acr push newsletter_subscribe.yaml
|
||||
↓
|
||||
yaml-parser.ts 讀取 workflow.yaml
|
||||
↓
|
||||
解析 flow[] 三元組 → triplets: [{subject, relation, object}]
|
||||
驗證關係詞（拒絕 PIPE）
|
||||
↓
|
||||
POST cypher-executor /cypher/search → ExecutionGraph（節點 + 邊）
|
||||
↓
|
||||
合併 config: + ExecutionGraph → WorkflowDefinition
|
||||
↓
|
||||
PUT WEBHOOKS KV[workflow_name] = JSON.stringify(WorkflowDefinition)
|
||||
↓
|
||||
輸出 webhook URL
|
||||
```
|
||||
|
||||
### workflow.yaml 格式（確認版）
|
||||
|
||||
```yaml
|
||||
name: newsletter_subscribe
|
||||
description: 訂閱電子報，發感謝信並記錄到 GSheets
|
||||
|
||||
flow:
|
||||
- "input >> 完成後 >> send_thanks"
|
||||
- "input >> 完成後 >> save_to_sheet"
|
||||
- "send_thanks >> 完成後 >> output"
|
||||
- "send_thanks >> 失敗時 >> notify_error"
|
||||
- "save_to_sheet >> 完成後 >> output"
|
||||
|
||||
config:
|
||||
send_thanks:
|
||||
to: "{{input.email}}"
|
||||
subject: "感謝訂閱！"
|
||||
body: "歡迎加入！"
|
||||
# access_token 由 credentials.yaml 的 gmail_token 自動注入
|
||||
|
||||
save_to_sheet:
|
||||
action: write
|
||||
spreadsheet_id: "{{creds.sheet_id}}"
|
||||
range: "訂閱者!A:B"
|
||||
values: [["{{input.email}}", "{{input.timestamp}}"]]
|
||||
|
||||
notify_error:
|
||||
chat_id: "{{creds.telegram_chat_id}}"
|
||||
text: "發信失敗：{{input.email}}"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## contract.yaml 補充欄位格式
|
||||
|
||||
### credentials_required（gmail 範例）
|
||||
|
||||
```yaml
|
||||
credentials_required:
|
||||
- key: gmail_token
|
||||
type: google_oauth
|
||||
description: "Google OAuth access token（gmail.send scope）"
|
||||
inject_as: access_token
|
||||
```
|
||||
|
||||
### config_example（gmail 範例）
|
||||
|
||||
```yaml
|
||||
config_example: |
|
||||
send_email: # 節點名稱（可自訂）
|
||||
to: "" # 收件人 Email（必填）
|
||||
subject: "" # 主旨（必填）
|
||||
body: "" # 內文（必填）
|
||||
# access_token 由 credentials.yaml 的 gmail_token 自動注入
|
||||
```
|
||||
|
||||
### 各零件 credentials_required 對照表
|
||||
|
||||
| 零件 | key | type | inject_as |
|
||||
|------|-----|------|-----------|
|
||||
| gmail | gmail_token | google_oauth | access_token |
|
||||
| google_sheets | google_oauth | google_oauth | access_token |
|
||||
| telegram | telegram_bot_token | telegram_bot_token | bot_token |
|
||||
| line_notify | line_token | line_token | token |
|
||||
|
||||
---
|
||||
|
||||
## CLI 技術設計
|
||||
|
||||
### 依賴
|
||||
|
||||
```json
|
||||
{
|
||||
"dependencies": {
|
||||
"commander": "^12.0.0",
|
||||
"js-yaml": "^4.1.0",
|
||||
"chalk": "^5.3.0",
|
||||
"ora": "^8.0.1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### config.yaml 格式（~/.arcrun/config.yaml）
|
||||
|
||||
```yaml
|
||||
cloudflare_account_id: abc123
|
||||
webhooks_kv_id: xyz789
|
||||
credentials_kv_id: abc456
|
||||
wasm_bucket: arcrun-wasm
|
||||
cypher_executor_url: https://cypher-executor.xxx.workers.dev
|
||||
credentials_worker_url: https://arcrun-credentials.xxx.workers.dev
|
||||
api_token: ***（加密存本機）
|
||||
```
|
||||
|
||||
### Cloudflare API 操作
|
||||
|
||||
CLI 使用 Cloudflare REST API（不依賴 Wrangler CLI）：
|
||||
- KV 寫入：`PUT /client/v4/accounts/{id}/storage/kv/namespaces/{ns_id}/values/{key}`
|
||||
- KV 讀取：`GET /client/v4/accounts/{id}/storage/kv/namespaces/{ns_id}/values/{key}`
|
||||
- KV 列出：`GET /client/v4/accounts/{id}/storage/kv/namespaces/{ns_id}/keys`
|
||||
|
||||
---
|
||||
|
||||
## wrangler.toml 變更對照
|
||||
|
||||
### 移除（InkStone 專屬）
|
||||
|
||||
```toml
|
||||
# 全部移除：
|
||||
[[services]]
|
||||
binding = "KBDB"
|
||||
service = "inkstone-kbdb-api"
|
||||
|
||||
[[services]]
|
||||
binding = "REGISTRY"
|
||||
service = "inkstone-component-registry"
|
||||
|
||||
[[services]]
|
||||
binding = "CLINIC_GDRIVE"
|
||||
service = "clinic-gdrive"
|
||||
|
||||
# ... CLINIC_EXCEL, CLINIC_ANALYSIS, CLINIC_RENDER, CLINIC_GSHEETS
|
||||
|
||||
[[services]]
|
||||
binding = "AICEO"
|
||||
service = "inkstone-aiceo-bot"
|
||||
|
||||
[[services]]
|
||||
binding = "MINI_ME"
|
||||
service = "inkstone-mini-me"
|
||||
```
|
||||
|
||||
### 保留
|
||||
|
||||
```toml
|
||||
[[kv_namespaces]]
|
||||
binding = "EXEC_CONTEXT"
|
||||
|
||||
[[kv_namespaces]]
|
||||
binding = "WEBHOOKS"
|
||||
|
||||
[[r2_buckets]]
|
||||
binding = "WASM_BUCKET"
|
||||
|
||||
[ai]
|
||||
binding = "AI"
|
||||
```
|
||||
|
||||
### 新增
|
||||
|
||||
```toml
|
||||
[[kv_namespaces]]
|
||||
binding = "CREDENTIALS_KV"
|
||||
id = "" # 用戶自行填入
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Standard 模式架構（用戶自己的 KV，arcrun.dev 的引擎）
|
||||
|
||||
### 儲存責任分界
|
||||
|
||||
```
|
||||
arcrun.dev 負責：
|
||||
WASM_BUCKET 公眾零件庫（.wasm 二進位）
|
||||
ANALYTICS_KV 零件執行統計
|
||||
ACCOUNTS_KV API Key → tenant_id + CF API Token 對應
|
||||
SUBMISSIONS_KV 零件提交審核狀態
|
||||
|
||||
用戶自己負責（一個 CF KV，arcrun.dev 不存取明文）：
|
||||
USER_KV
|
||||
workflow:{name} → workflow 執行圖（JSON）
|
||||
cred:{key} → AES-GCM 加密 credential
|
||||
```
|
||||
|
||||
### 完整系統圖
|
||||
|
||||
```
|
||||
┌──────────────────────────────────────────────────────────────┐
|
||||
│ arcrun.dev（你的 Cloudflare 帳號） │
|
||||
│ │
|
||||
│ auth-worker（api.arcrun.dev） │
|
||||
│ POST /register → { api_key, tenant_id } │
|
||||
│ ACCOUNTS_KV: { tenant_id, cf_api_token, api_key_hash } │
|
||||
│ ※ 不儲存用戶 credential 或 workflow 內容 │
|
||||
│ │
|
||||
│ cypher-executor（cypher.arcrun.dev，共享） │
|
||||
│ X-Arcrun-API-Key → tenant_id → cf_api_token │
|
||||
│ 用 cf_api_token 呼叫 CF KV API → 讀用戶自己的 USER_KV │
|
||||
│ WASM_BUCKET: gmail.wasm / telegram.wasm / ...（共享） │
|
||||
│ │
|
||||
│ public registry（registry.arcrun.dev） │
|
||||
│ GET /components → 零件清單 + 統計 + author + visibility │
|
||||
│ POST /submit → 接收零件，沙盒驗收後設 author_only │
|
||||
│ POST /analytics/record → 執行統計（非同步） │
|
||||
└──────────────────────────────────────────────────────────────┘
|
||||
|
||||
↕ CF KV API（用戶的 cf_api_token，KV Edit 權限）
|
||||
|
||||
┌──────────────────────────────────────────────────────────────┐
|
||||
│ 用戶自己的 CF 帳號 │
|
||||
│ USER_KV │
|
||||
│ workflow:newsletter → { triplets, config } │
|
||||
│ cred:gmail_token → { encrypted, iv } │
|
||||
│ cred:telegram_bot → { encrypted, iv } │
|
||||
└──────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### acr init 互動流程
|
||||
|
||||
```
|
||||
$ acr init
|
||||
|
||||
? 你的 Cloudflare Account ID: abc123
|
||||
? USER_KV Namespace ID（在 CF Dashboard 建立一個 KV 後貼上）: kv_xyz
|
||||
? CF API Token（只需 KV Edit 權限，arcrun 用此存取你的 KV）: ***
|
||||
? Email（取得 arcrun.dev API Key）: you@example.com
|
||||
|
||||
→ 呼叫 POST https://api.arcrun.dev/register { email, cf_api_token_hash }
|
||||
→ 取得 api_key: ak_xxxxxxxx
|
||||
|
||||
✓ 設定完成 → ~/.arcrun/config.yaml
|
||||
✓ 建立 credentials.yaml（已加入 .gitignore）
|
||||
|
||||
你的 credential 與 workflow 存在你自己的 CF KV，arcrun 不會儲存它們。
|
||||
```
|
||||
|
||||
### API Key 驗證與 KV 存取 Middleware
|
||||
|
||||
```typescript
|
||||
// cypher-executor/src/lib/tenant.ts（新增）
|
||||
export async function resolveUserKv(request: Request, env: Env) {
|
||||
if (env.MULTI_TENANT === 'false') {
|
||||
// Self-hosted：直接用本地 KV binding
|
||||
return { kv: env.LOCAL_KV, prefix: '' }
|
||||
}
|
||||
|
||||
const apiKey = request.headers.get('X-Arcrun-API-Key')
|
||||
if (!apiKey) throw new Response('Missing API Key', { status: 401 })
|
||||
|
||||
const hash = await sha256(apiKey)
|
||||
const account = await env.ACCOUNTS_KV.get(`hash:${hash}`)
|
||||
if (!account) throw new Response('Invalid API Key', { status: 401 })
|
||||
|
||||
const { cf_api_token, account_id, kv_namespace_id } = JSON.parse(account)
|
||||
|
||||
// 回傳 CF KV API wrapper，用用戶自己的 token 存取
|
||||
return {
|
||||
kv: new CfKvClient({ cf_api_token, account_id, kv_namespace_id }),
|
||||
prefix: ''
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### USER_KV Key Schema
|
||||
|
||||
```
|
||||
Standard 模式（用戶自己的 KV）：
|
||||
workflow:{name} → WorkflowDefinition JSON
|
||||
cred:{key} → { encrypted (base64), iv (base64) }
|
||||
|
||||
Self-hosted（本地 KV binding）：
|
||||
維持現有 key 格式，無 prefix
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 執行統計設計
|
||||
|
||||
### Analytics Record（非同步，不阻擋執行）
|
||||
|
||||
```typescript
|
||||
// cypher-executor/src/actions/analytics.ts（新增）
|
||||
export function recordExecution(
|
||||
componentId: string,
|
||||
version: string,
|
||||
success: boolean,
|
||||
durationMs: number
|
||||
): void {
|
||||
// fire-and-forget，不 await
|
||||
fetch('https://registry.arcrun.dev/analytics/record', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ canonical_id: componentId, version, success, duration_ms: durationMs })
|
||||
}).catch(() => {}) // 統計失敗不影響執行
|
||||
}
|
||||
```
|
||||
|
||||
### 統計聚合（registry Worker）
|
||||
|
||||
```
|
||||
ANALYTICS_KV 結構：
|
||||
"stats:gmail:v1" → { total_runs: 140382, success_runs: 139444, total_ms: 16845840 }
|
||||
|
||||
每次 POST /analytics/record：
|
||||
原子更新（KV 樂觀鎖）→ total_runs++, success_runs += success, total_ms += duration_ms
|
||||
|
||||
GET /components 回傳：
|
||||
success_rate = success_runs / total_runs * 100
|
||||
avg_duration_ms = total_ms / total_runs
|
||||
排序：total_runs × success_rate（DESC）
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 零件貢獻流程設計
|
||||
|
||||
### `acr parts publish` 流程
|
||||
|
||||
```
|
||||
$ acr parts publish gmail-v2
|
||||
|
||||
1. CLI 讀取 registry/components/gmail-v2/ 目錄
|
||||
- component.contract.yaml（必須有 author 欄位）
|
||||
- main.go
|
||||
- gmail-v2.wasm
|
||||
|
||||
2. POST https://registry.arcrun.dev/submit
|
||||
multipart form:
|
||||
contract: <yaml content>
|
||||
source: <main.go content>
|
||||
wasm: <binary>
|
||||
Header: X-Arcrun-API-Key: ak_xxxxx
|
||||
|
||||
3. registry 回應：
|
||||
{ submission_id: "sub_abc123", status: "pending_review" }
|
||||
|
||||
4. CLI 輸出：
|
||||
✓ 提交成功（submission_id: sub_abc123）
|
||||
查詢進度：acr parts publish --status sub_abc123
|
||||
```
|
||||
|
||||
### Registry 沙盒驗收與 visibility 狀態機
|
||||
|
||||
```
|
||||
POST /submit 觸發（非同步執行）：
|
||||
|
||||
[整合類零件：gmail、telegram、google_sheets、line_notify、http_request]
|
||||
Step 1: 體積檢查（< 2048KB）
|
||||
Step 2: syscall 掃描（無 filesystem syscall；網路 syscall 允許，因需呼叫外部 API）
|
||||
通過 → visibility: author_only（作者立即可用，等人工審核）
|
||||
|
||||
[功能類零件：所有其他零件]
|
||||
Step 1: 體積檢查（< 2048KB）
|
||||
Step 2: 冷啟動時間（< 50ms）
|
||||
Step 3: syscall 掃描（無網路 / 無 filesystem）
|
||||
Step 4: Gherkin 測試（contract 中所有 scenario 100% 通過）
|
||||
通過 → visibility: author_only（作者立即可用，等人工審核）
|
||||
|
||||
任一步驟失敗 → status: rejected（回傳 failed_step + reason）
|
||||
|
||||
人工審核通過 → visibility: public
|
||||
- 零件出現在所有人的 GET /components
|
||||
- 開始累積公開執行統計
|
||||
|
||||
人工審核拒絕 → visibility 維持 author_only
|
||||
- 作者仍可使用，但收到拒絕原因
|
||||
- 作者修改後可重新提交
|
||||
|
||||
acr parts 顯示規則：
|
||||
visibility: author_only → [待審核] 只有你可用（不顯示統計）
|
||||
visibility: public → ★ 成功率 | N 次執行 | by @author
|
||||
|
||||
任一失敗 → status: rejected
|
||||
- 回傳 { failed_step, reason }，格式與 Requirement 2 相同
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 開發順序（Phase 對齊 requirements）
|
||||
|
||||
```
|
||||
Phase 1：搬移與清理（Requirement 1）
|
||||
1.1 建立 arcrun repo，搬移四個目錄
|
||||
1.2 清理 cypher-executor/wrangler.toml
|
||||
1.3 改寫 component-loader（移除 KBDB/REGISTRY/MINI_ME 路徑）
|
||||
1.4 移除 autoPublishMissing.ts（依賴 REGISTRY binding）
|
||||
1.5 本機 wrangler dev 測試 /health
|
||||
|
||||
Phase 2：零件完整度（Requirement 2）
|
||||
2.1 審查 21 個零件 contract.yaml（表格回報）
|
||||
2.2 補充 credentials_required（4 個零件）
|
||||
2.3 補充 config_example（全部 21 個）
|
||||
2.4 驗證 main.go required 與 contract 一致
|
||||
|
||||
Phase 3：credential 注入（Requirement 3）
|
||||
3.1 新增 credential-injector.ts
|
||||
3.2 整合進 graph-executor 節點執行前
|
||||
3.3 測試 gmail 零件端對端（credentials.yaml → push → run）
|
||||
|
||||
Phase 4：CLI（Requirement 4）
|
||||
4.1 acr init（--hosted / --self-hosted 分支）
|
||||
4.2 acr creds push（Hosted 走 API，Self-hosted 走 KV）
|
||||
4.3 acr push
|
||||
4.4 arcrun run
|
||||
4.5 acr validate
|
||||
4.6 acr parts / acr parts scaffold / acr parts publish
|
||||
4.7 acr list / acr logs
|
||||
|
||||
Phase 5：開源發布（Requirement 5）
|
||||
5.1 撰寫 README.md（含 --hosted 快速開始）
|
||||
5.2 撰寫 CONTRIBUTING.md
|
||||
5.3 確認無 InkStone 內部資訊殘留
|
||||
5.4 GitHub 發布 + npm publish
|
||||
|
||||
Phase 6：Hosted SaaS（Requirement 6）
|
||||
6.1 建立 auth-worker（api.arcrun.dev）
|
||||
6.2 cypher-executor 加入 tenant middleware
|
||||
6.3 CREDENTIALS_KV key schema 加 tenant prefix
|
||||
6.4 部署至 arcrun.dev
|
||||
|
||||
Phase 7：統計與貢獻（Requirement 7 + 8）
|
||||
7.1 analytics.ts（執行後 fire-and-forget）
|
||||
7.2 registry /analytics/record 端點
|
||||
7.3 ANALYTICS_KV 聚合邏輯
|
||||
7.4 GET /components 加入統計排序
|
||||
7.5 POST /submit 沙盒驗收 + author 寫入
|
||||
7.6 acr parts publish 指令
|
||||
```
|
||||
@@ -0,0 +1,180 @@
|
||||
# Requirements Document
|
||||
|
||||
## Introduction
|
||||
|
||||
arcrun MVP 是從 `matrix` monorepo 中 cherry-pick 出最小可獨立運作的 AI 工作流執行引擎，目標是作為**獨立開源 repo**（`arcrun`）發布。
|
||||
|
||||
**背景**：`matrix` 因為同時承載 InkStone 內部服務（KBDB、CLINIC_*、AICEO、MINI_ME 等）與核心執行引擎，複雜度過高，難以讓外部開發者使用或貢獻。MVP 的任務是將執行引擎從內部服務中解耦，讓任何人都能自行在 Cloudflare 上部署一套完整的 AI 工作流系統。
|
||||
|
||||
**護城河邏輯**：
|
||||
- 開源：cypher-executor（執行引擎）、WASM 零件庫（21 個）、credentials Worker、CLI
|
||||
- Hosted SaaS：一行指令註冊取得 API Key，直接使用公眾零件庫，無需部署任何 Worker
|
||||
- 閉源（InkStone 付費）：KBDB 向量搜尋、graph 查詢、Persona SDK、MatchGPT
|
||||
|
||||
**不在此次範圍**：KBDB 整合、前端管理介面、向量搜尋、新增 WASM 零件。
|
||||
|
||||
---
|
||||
|
||||
## Glossary
|
||||
|
||||
- **cypher-executor**：原 `matrix/cypher-executor`，執行 workflow 的 Cloudflare Worker。開源版移除所有 InkStone 內部 Service Binding，只保留 KV / R2 / Workers AI。
|
||||
- **component（零件）**：以 TinyGo 編譯的 `.wasm` 檔案，以 WASI preview1 / stdin-stdout JSON 為 I/O 模型。
|
||||
- **component.contract.yaml**：每個零件的規格宣告，含 `canonical_id`、`input_schema`、`output_schema`、`gherkin_tests`，開源版補充 `credentials_required` 與 `config_example`。
|
||||
- **credentials Worker**：`arcrun/credentials`，以 AES-GCM 加密存取 API token，部署在用戶自己的 CF 帳號。
|
||||
- **WASM_BUCKET**：arcrun.dev 的 R2 bucket，儲存所有公眾 `.wasm` 零件二進位，由 Arcrun 負責。
|
||||
- **USER_KV**：用戶自己 CF 帳號下的 KV Namespace，同時存放 workflow YAML 與加密 credential，由用戶負責，Arcrun 不經手。
|
||||
- **workflow.yaml**：用戶撰寫的工作流定義，`flow:` 用 `>>` 三元組描述，`config:` 對應各節點參數，存在用戶自己的 USER_KV。
|
||||
- **CLI（套件名 arcrun，指令 acr）**：Node.js/TypeScript CLI 工具，管理 credentials、workflow 的上傳與執行。安裝：`npm i -g arcrun`，使用：`acr <指令>`。
|
||||
- **credentials_required**：contract.yaml 新欄位，宣告零件需要哪個 credential 以及注入到哪個 input 欄位。
|
||||
- **config_example**：contract.yaml 新欄位，提供 `acr parts scaffold` 指令使用的 config 範本。
|
||||
- **Standard 模式（預設）**：用戶只需在自己 CF 帳號開一個 KV（存 credential + workflow），使用 arcrun.dev 的執行引擎與公眾零件庫，無需部署任何 Worker。
|
||||
- **Self-hosted 模式**：用戶自行部署全套 Worker 至自己的 Cloudflare 帳號，有完全控制權，可貢獻零件至公眾庫。
|
||||
- **auth-worker**：arcrun.dev 上的帳號服務 Worker，處理 `POST /register` 自動發放 API Key，不儲存用戶 credential。
|
||||
- **tenant_id**：每個 API Key 對應的租戶識別碼，用於讓 cypher-executor 知道要用哪個 Cloudflare API Token 去存取用戶的 USER_KV。
|
||||
- **public registry**：arcrun.dev 上的公眾零件庫，所有人共用，有執行統計與 author 資訊。
|
||||
- **`acr parts publish`**：CLI 指令，自架用戶將自製零件提交至公眾 registry 審核。
|
||||
- **execution analytics**：每次零件執行後非同步記錄的統計資料（使用次數、成功率），公開顯示於 `acr parts`。
|
||||
- **visibility**：contract.yaml 欄位，值為 `author_only`（沙盒通過後作者立即可用）或 `public`（人工審核後所有人可用）。
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement 1：搬移 cypher-executor 至獨立 repo 並移除 InkStone bindings
|
||||
|
||||
**User Story:** As a 開源用戶, I want 自行部署 cypher-executor 至我的 Cloudflare 帳號, so that 我不需要依賴 InkStone 的任何服務就能執行 AI 工作流。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE cypher-executor `wrangler.toml` SHALL 移除以下 Service Bindings：`KBDB`、`REGISTRY`、`CLINIC_GDRIVE`、`CLINIC_EXCEL`、`CLINIC_ANALYSIS`、`CLINIC_RENDER`、`CLINIC_GSHEETS`、`AICEO`、`MINI_ME`。
|
||||
2. THE cypher-executor `wrangler.toml` SHALL 保留以下 bindings：`EXEC_CONTEXT`（KV）、`WEBHOOKS`（KV）、`WASM_BUCKET`（R2）、`AI`（Workers AI）。
|
||||
3. THE cypher-executor `wrangler.toml` SHALL 新增 `CREDENTIALS_KV`（KV Namespace binding），用於 credential 解密注入。
|
||||
4. THE component-loader SHALL 從 `WASM_BUCKET` R2 直接讀取 `.wasm` 檔案，不透過任何 Service Binding 或外部 HTTP 查詢。
|
||||
5. WHEN cypher-executor 收到執行請求，THE cypher-executor SHALL 不依賴 `KBDB`、`REGISTRY` 或任何 InkStone 內部 Service Binding，只使用 KV / R2 / Workers AI 完成執行。
|
||||
6. THE arcrun repo SHALL 包含以下目錄：`cypher-executor/`、`credentials/`、`builtins/`、`registry/components/`（21 個零件）。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 2：component.contract.yaml 完整度補充
|
||||
|
||||
**User Story:** As a 零件使用者, I want 每個零件的 contract.yaml 都有 `credentials_required` 與 `config_example`, so that CLI 能自動注入 credential，用戶也能快速知道如何設定節點。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE `credentials_required` 欄位 SHALL 出現在以下 4 個零件的 contract.yaml 中：`gmail`、`google_sheets`、`telegram`、`line_notify`。
|
||||
2. WHEN `credentials_required` 存在，THE 欄位 SHALL 包含以下子欄位：`key`（對應 credentials.yaml 的 key 名稱）、`type`（token 類型，如 `google_oauth`、`telegram_bot_token`）、`description`（說明）、`inject_as`（執行時注入到 input 的哪個欄位名稱）。
|
||||
3. THE `config_example` 欄位 SHALL 出現在所有 21 個零件的 contract.yaml 中。
|
||||
4. WHEN `config_example` 存在，THE 欄位 SHALL 為 YAML 字串，內容為可直接貼入 workflow.yaml `config:` 區塊的範本，需有人類可讀的說明註解。
|
||||
5. FOR 需要 credential 的零件，THE `config_example` SHALL 包含一行註解，說明哪個 credential key 會被自動注入到哪個欄位（如 `# access_token 由 credentials.yaml 的 gmail_token 自動注入`）。
|
||||
6. THE main.go 的 `required` 欄位 SHALL 與 contract 的 `input_schema.required[]` 保持一致，不得有欄位名稱不符。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 3：workflow YAML 格式與執行時 credential 注入
|
||||
|
||||
**User Story:** As a 工作流設計者, I want 用有語意的關係詞撰寫 workflow.yaml，且 credential 自動注入, so that workflow 定義中完全不出現明文 token。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE workflow.yaml `flow:` 欄位 SHALL 以 `"A >> 關係詞 >> B"` 三元組陣列描述資料流。
|
||||
2. THE cypher-executor SHALL 支援以下關係詞：`完成後`、`失敗時`、`對每個`、`條件滿足時`、`ON_SUCCESS`、`ON_FAIL`、`FOREACH`、`IF`、`ON_CLICK`、`CALLS_SUBFLOW`。
|
||||
3. THE cypher-executor SHALL 拒絕使用 `PIPE` 關係詞，並回傳明確錯誤訊息。
|
||||
4. WHEN cypher-executor 執行一個節點，THE cypher-executor SHALL 查詢該節點對應零件的 `credentials_required`，若存在則從 `CREDENTIALS_KV` 解密對應 credential，並注入到 input 的 `inject_as` 欄位。
|
||||
5. THE credential 注入 SHALL 發生在 WASM 執行前，用戶的 workflow `config:` 中不需也不應包含 token 值。
|
||||
6. IF `credentials_required` 宣告的 credential key 在 `CREDENTIALS_KV` 中不存在，THE cypher-executor SHALL 回傳結構化錯誤，包含缺少的 key 名稱與修復步驟說明。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 4：CLI（arcrun，指令 acr）核心指令
|
||||
|
||||
**User Story:** As a 開發者, I want 透過 `acr` CLI 管理 workflow 與 credentials, so that 不需要直接操作 Cloudflare KV / R2 API 就能完成部署與執行。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE CLI SHALL 以 Node.js/TypeScript 實作，套件名 `arcrun`，bin 名 `acr`，可透過 `npm i -g arcrun` 安裝，依賴只使用 `commander`、`js-yaml`、`chalk`、`ora`。
|
||||
2. THE `acr init` 指令 SHALL 以互動式問答產生 `~/.arcrun/config.yaml`，問答內容為：CF Account ID、USER_KV namespace ID、CF API Token（用於 cypher-executor 代存取用戶 KV）、email（取得 arcrun.dev API Key）；並建立空白本機 `credentials.yaml`。
|
||||
3. THE `acr creds push [credentials.yaml]` 指令 SHALL 讀取 credentials.yaml，逐一加密上傳至用戶自己的 USER_KV，並顯示每個 key 的上傳結果。
|
||||
4. THE `acr push <workflow.yaml>` 指令 SHALL 解析 `flow:` 三元組，轉換成執行圖，連同 `config:` 存入 `WEBHOOKS KV`，並輸出 webhook URL。
|
||||
5. THE `acr run <workflow_name> [--input key=value...]` 指令 SHALL 觸發 cypher-executor 執行指定 workflow，顯示各節點執行結果；失敗時顯示具體節點、原因與修復步驟。
|
||||
6. THE `acr validate <workflow.yaml>` 指令 SHALL 在執行前驗證：YAML 格式、關係詞合法性（無 PIPE）、所有節點在 config 中有對應、所有零件存在於 WASM_BUCKET、所有 credentials 已上傳至 CREDENTIALS_KV。
|
||||
7. THE `acr parts` 指令 SHALL 列出所有可用零件（按類型分組），顯示每個零件的必填欄位與所需 credential。
|
||||
8. THE `acr parts scaffold <component>` 指令 SHALL 從 contract 的 `config_example` 輸出可直接貼入 workflow.yaml 的 config 範本，以及對應的 credentials.yaml 欄位範本。
|
||||
9. THE `acr list` 指令 SHALL 列出 WEBHOOKS KV 中所有已上傳的 workflow，顯示名稱與更新時間。
|
||||
10. THE `acr logs <workflow_name>` 指令 SHALL 顯示最近執行記錄，包含時間、成功/失敗狀態、執行時間，失敗時顯示失敗節點與原因。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 5：README 與開源發布準備
|
||||
|
||||
**User Story:** As a 外部開發者, I want 看到清楚的 README，5 分鐘內能完成部署, so that 降低試用門檻，吸引社群貢獻。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE README.md SHALL 包含以下章節：專案定位（開源核心 vs 閉源付費服務說明）、快速開始（`acr init` → `acr creds push` → `acr push` → `acr run` 四步驟）、零件列表（21 個零件分類說明）、workflow YAML 語法說明（三元組 + 關係詞表格）、自行部署說明（Cloudflare Workers 部署步驟）。
|
||||
2. THE README.md 快速開始 SHALL 以 `newsletter_subscribe` 為範例 workflow，展示 gmail + google_sheets + telegram 的完整串接。
|
||||
3. THE repo SHALL 包含 `CONTRIBUTING.md`，說明如何新增零件（TinyGo 開發環境、contract.yaml 格式、本機測試指令）。
|
||||
4. THE repo SHALL 確保所有 InkStone 內部資訊（Worker URL、KV namespace ID、帳號資訊）不出現在任何已提交的檔案中。
|
||||
5. WHEN cypher-executor 部署後第一次被呼叫，THE cypher-executor SHALL 能正常回應 health check（`GET /health` 回傳 `{ ok: true }`），不需要任何 InkStone 服務可用。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 6：Standard 模式 — API Key 註冊與用戶 KV 存取
|
||||
|
||||
**User Story:** As a 新用戶, I want 只需開一個 CF KV 就能開始使用 Arcrun，不需要部署任何 Worker, so that 最低門檻試用整個平台，且我的 credential 永遠在我自己的環境。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE auth-worker SHALL 提供 `POST /register` 端點，接受 `{ email }` 後自動生成 API Key（格式：`ak_` 前綴 + 32 字元隨機字串），無需人工審核，立即回傳 `{ api_key, tenant_id }`。
|
||||
2. THE auth-worker SHALL 將 `{ tenant_id, email, created_at, api_key_hash }` 存入 `ACCOUNTS_KV`，只存 hash 不存明文 API Key。arcrun.dev 不儲存任何用戶 credential 或 workflow 內容。
|
||||
3. WHEN `acr init` 執行，THE CLI SHALL 互動式詢問以下資料並寫入 `~/.arcrun/config.yaml`：
|
||||
- CF Account ID（用戶自己的）
|
||||
- USER_KV namespace ID（用戶自己開的，存 credential + workflow）
|
||||
- CF API Token（供 cypher-executor 用 CF API 存取用戶 KV，只需 KV Edit 權限）
|
||||
- email（呼叫 `POST https://api.arcrun.dev/register` 取得 API Key）
|
||||
4. THE cypher-executor SHALL 在每個 request 的 header 讀取 `X-Arcrun-API-Key`，驗證後取得該 tenant 的 CF API Token，用 Cloudflare API 存取用戶自己的 USER_KV；缺少或無效的 API Key 回傳 `401 Unauthorized`。
|
||||
5. THE `acr creds push` 指令 SHALL 使用用戶的 CF API Token，直接呼叫 Cloudflare KV API 將加密 credential 寫入用戶自己的 USER_KV，不經過 arcrun.dev。
|
||||
6. THE `acr push <workflow.yaml>` 指令 SHALL 同樣直接寫入用戶自己的 USER_KV，不經過 arcrun.dev。
|
||||
7. WHEN Self-hosted 模式，THE cypher-executor SHALL 可透過環境變數 `MULTI_TENANT=false` 停用 API Key 驗證，直接使用本地 KV binding，與現有行為相容。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 7：公眾零件庫執行統計與貢獻榮譽
|
||||
|
||||
**User Story:** As a 零件使用者, I want 在 `acr parts` 看到每個零件的真實執行統計與作者資訊, so that 我能選擇最可靠的零件；As a 零件貢獻者, I want 我的名字和統計數字公開顯示, so that 我有動機將好零件推入公眾庫而非留在私庫。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE contract.yaml SHALL 新增可選欄位 `author`（GitHub username，如 `@alice`），在 `acr parts` 顯示時一起展示。
|
||||
2. WHEN cypher-executor 執行完一個零件節點，THE cypher-executor SHALL 非同步 POST 以下資料至 `https://registry.arcrun.dev/analytics/record`，不阻擋主流程：
|
||||
```json
|
||||
{ "canonical_id": "gmail", "version": "v1", "success": true, "duration_ms": 120 }
|
||||
```
|
||||
不含任何用戶資料或 tenant_id。
|
||||
3. THE public registry SHALL 聚合每個零件的執行統計：`total_runs`（總執行次數）、`success_rate`（成功率，百分比）、`avg_duration_ms`（平均執行時間）。
|
||||
4. THE `acr parts` 指令 SHALL 顯示每個零件的統計資料，格式為：
|
||||
```
|
||||
• gmail Gmail 發信 by @alice
|
||||
★ 99.2% 成功 | 140,382 次執行 | 平均 120ms
|
||||
```
|
||||
5. IF 零件存在於用戶自架的私有 WASM_BUCKET 而非公眾庫，THE `acr parts` SHALL 顯示該零件但標註 `[私有]`，不顯示統計數字與 author。
|
||||
6. THE public registry SHALL 在 `GET /components` 回傳的零件清單中，依 `total_runs × success_rate` 排序，讓高品質高使用量的零件排在前面。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 8：零件貢獻流程與 visibility 狀態
|
||||
|
||||
**User Story:** As a 零件開發者, I want 提交零件後立即能自己使用，等審核通過後公開給所有人, so that 不用等待審核就能驗證自己的零件是否有用。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE contract.yaml SHALL 包含 `visibility` 欄位，值為 `author_only`（沙盒通過後作者立即可用）或 `public`（人工審核通過後所有人可用）。
|
||||
2. THE `acr parts publish <component>` 指令 SHALL 打包指定零件的原始碼、`component.contract.yaml`、`.wasm`，POST 至 `https://registry.arcrun.dev/submit`（帶 `X-Arcrun-API-Key` header）。原始碼語言不限，但編譯產出必須為 WASM + WASI preview1。
|
||||
3. WHEN 零件提交後，THE registry SHALL 依零件類型執行不同層級的沙盒驗收：
|
||||
- **整合類**（需呼叫外部 API，如 gmail、telegram）：體積 / syscall 掃描通過 → `author_only`
|
||||
- **功能類**（純邏輯，如 string_ops、if_control）：體積 / syscall 掃描 / Gherkin 測試全通過 → `author_only`
|
||||
- 任一必要步驟失敗 → `rejected`（回傳具體失敗步驟與原因）
|
||||
4. WHEN 零件 visibility 為 `author_only`，THE registry SHALL 讓該零件只對提交者的 API Key 可見，`acr parts` 顯示時標註 `[待審核]`，其他用戶看不到。
|
||||
5. WHEN 人工審核通過，THE registry SHALL 將 visibility 改為 `public`，零件立即出現在所有人的 `acr parts` 清單，並開始累積公開執行統計。
|
||||
6. WHEN 審核拒絕，THE registry SHALL 回傳具體失敗原因，零件保留 `author_only` 狀態讓作者繼續修改後重新提交。
|
||||
7. THE `acr parts publish` 指令 SHALL 在提交後顯示 `submission_id`、目前 visibility 狀態，以及查詢審核進度的指令提示。
|
||||
8. THE `acr parts` 指令 SHALL 對 `author_only` 零件顯示「[待審核] 只有你可用」，對 `public` 零件顯示執行統計與 author，讓貢獻者清楚知道零件的可用範圍。
|
||||
@@ -0,0 +1,206 @@
|
||||
# Implementation Plan: arcrun MVP
|
||||
|
||||
## Overview
|
||||
|
||||
依照 Design 的七個 Phase 實作。原則：最小異動，不重寫現有邏輯，只 cherry-pick + carve-out + supplement。
|
||||
所有 Phase 1–3 工作在 `matrix` repo 對應目錄驗證後再搬到新 repo。
|
||||
|
||||
**PR #2（claude/review-mvp-specs-8Bvdu）狀態：** 初始實作已提交，已修復以下問題後準備 merge：
|
||||
- CF API Token 傳至 arcrun.dev 安全問題（已修復）
|
||||
- 加密 fallback 格式不相容（已修復）
|
||||
- submitComponent KBDB 依賴（已修復，改用 SUBMISSIONS_KV）
|
||||
- Webhook 路由缺 analytics（已修復）
|
||||
- `require()` 在 ES module 中（已修復）
|
||||
- api 類零件 `no_network_syscall: true` 錯誤（已修復）
|
||||
|
||||
---
|
||||
|
||||
## Phase 1：搬移與清理
|
||||
|
||||
- [x] 1. 建立 `arcrun` 獨立 repo 並初始化
|
||||
- [x] 1.1 在 GitHub 建立新的 public repo（使用 matrix monorepo 的 `arcrun/` 子目錄代替，PR #2）
|
||||
- [x] 1.2 設定 `.gitignore`（排除 `node_modules/`、`.wrangler/`、`credentials.yaml`、`~/.arcrun/`）
|
||||
- [x] 1.3 從 `matrix` cherry-pick 四個目錄：
|
||||
- `matrix/cypher-executor/` → `arcrun/cypher-executor/`
|
||||
- `matrix/u6u-core/credentials/` → `arcrun/credentials/`
|
||||
- `matrix/u6u-core/registry/components/` → `arcrun/registry/components/`
|
||||
- _Requirements: 1.6_
|
||||
|
||||
- [x] 2. 清理 `cypher-executor/wrangler.toml`
|
||||
- [x] 2.1 移除 9 個 InkStone Service Bindings（KBDB、REGISTRY、CLINIC_*、AICEO、MINI_ME）
|
||||
- [x] 2.2 確認保留：`EXEC_CONTEXT`、`WEBHOOKS`、`WASM_BUCKET`、`AI`
|
||||
- [x] 2.3 新增 `CREDENTIALS_KV` 與 `ANALYTICS_KV` KV namespace binding
|
||||
- [x] 2.4 更新 `name` 為 `arcrun-cypher-executor`
|
||||
- _Requirements: 1.1, 1.2, 1.3_
|
||||
|
||||
- [x] 3. 改寫 `cypher-executor/src/lib/component-loader.ts`
|
||||
- [x] 3.1 移除對 MINI_ME、KBDB、InkStone bindings 的 hardcode
|
||||
- [x] 3.2 實作三層邏輯：builtin Map → WASM_BUCKET R2 直讀 → 結構化錯誤
|
||||
- _Requirements: 1.4, 1.5_
|
||||
|
||||
- [x] 4. 移除對 InkStone bindings 的依賴程式碼
|
||||
- [x] 4.1 刪除 `autoPublishMissing.ts`（依賴 REGISTRY binding）
|
||||
- [x] 4.2 移除所有 `env.KBDB`、`env.REGISTRY`、`env.MINI_ME`、`env.AICEO`、`env.CLINIC_*` 引用
|
||||
- _Requirements: 1.1, 1.5_
|
||||
|
||||
- [ ] 5. 本機驗證
|
||||
- [ ] 5.1 `cd arcrun/cypher-executor && wrangler dev` 能啟動（無 binding 錯誤）
|
||||
- [ ] 5.2 `GET /health` 回傳 `{ ok: true }`
|
||||
- [ ] 5.3 上傳 `validate_json.wasm` 到 WASM_BUCKET，執行 `POST /execute` 能正常回傳結果
|
||||
- _Requirements: 1.5, 5.5_
|
||||
|
||||
---
|
||||
|
||||
## Phase 2：零件完整度補充
|
||||
|
||||
- [x] 6. api 類零件 `no_network_syscall` 修正
|
||||
- [x] 6.1 gmail、telegram、google_sheets、line_notify、http_request 改為 `no_network_syscall: false`
|
||||
- _Requirements: 2.1_
|
||||
|
||||
- [ ] 7. 審查 21 個零件 contract.yaml 並補充 `credentials_required`
|
||||
- [ ] 7.1 確認 gmail、google_sheets、telegram、line_notify 有 `credentials_required`（PR #2 已加入，需驗證格式正確）
|
||||
- [ ] 7.2 確認所有 21 個零件有 `config_example` 欄位
|
||||
- [ ] 7.3 驗證 `main.go` required 欄位與 `contract.yaml` input_schema.required[] 一致
|
||||
- _Requirements: 2.1, 2.2, 2.3_
|
||||
|
||||
---
|
||||
|
||||
## Phase 3：Credential 注入整合
|
||||
|
||||
- [x] 10. `credential-injector.ts` 已實作（`arcrun/cypher-executor/src/actions/credential-injector.ts`）
|
||||
- [x] 10.1 讀取 contract.yaml from R2，解析 `credentials_required`
|
||||
- [x] 10.2 從 `CREDENTIALS_KV` 讀取 AES-GCM 加密 token，注入到 input 對應欄位（inject_as）
|
||||
- [x] 10.3 credential 不存在時拋出結構化錯誤（含 key 名稱與修復步驟）
|
||||
- _Requirements: 3.4, 3.5, 3.6_
|
||||
|
||||
- [ ] 11. 驗證 credential 注入整合進 graph-executor
|
||||
- [ ] 11.1 確認 `graph-executor.ts` 在節點執行前正確呼叫 `injectCredentials`
|
||||
- [ ] 11.2 確認注入只影響 WASM input，不修改 WEBHOOKS KV 中儲存的 workflow 定義
|
||||
- _Requirements: 3.4, 3.5_
|
||||
|
||||
- [ ] 12. 端對端測試（手動）
|
||||
- [ ] 12.1 建立 `credentials.yaml`，加入測試 token
|
||||
- [ ] 12.2 執行 `acr creds push`，確認寫入 CREDENTIALS_KV 格式為 `{ encrypted, iv }`（無 `mode: 'base64'`）
|
||||
- [ ] 12.3 執行含 credential 的 workflow，確認 inject_as 欄位正確注入
|
||||
- _Requirements: 3.4, 3.5_
|
||||
|
||||
---
|
||||
|
||||
## Phase 4：CLI 開發
|
||||
|
||||
- [x] 13. CLI 專案骨架已建立（`arcrun/cli/`）
|
||||
- [x] 13.1 `package.json`（name: `arcrun`，bin: `acr`）
|
||||
- [x] 13.2 `tsconfig.json`（module: NodeNext）
|
||||
- [x] 13.3 所有 10 個指令已實作骨架
|
||||
- _Requirements: 4.1_
|
||||
|
||||
- [x] 14. `acr init` 已實作，修正項：
|
||||
- [x] 14.1 Standard 模式不再傳送 `cf_api_token` 至 arcrun.dev（只傳 `email`）
|
||||
- [x] 14.2 `require()` 改用 `await import()` 修正 ES module 相容
|
||||
- [ ] 14.3 **待補**：`acr init` 需詢問 `ARCRUN_ENCRYPTION_KEY` 並寫入 config（目前加密 key 需手動設定）
|
||||
- _Requirements: 4.2, 6.3_
|
||||
|
||||
- [x] 15. `acr creds push` 已實作
|
||||
- [x] 15.1 讀取 `credentials.yaml`，AES-GCM 加密後寫入用戶 CF KV（`cred:{name}`）
|
||||
- [x] 15.2 加密 fallback（base64）已移除，key 不足時直接拋錯提示生成指令
|
||||
- _Requirements: 4.3, 6.5_
|
||||
|
||||
- [x] 16. `acr push` 已實作
|
||||
- _Requirements: 4.4_
|
||||
|
||||
- [x] 17. `acr run` 已實作
|
||||
- _Requirements: 4.5_
|
||||
|
||||
- [ ] 18. `acr validate` credential 檢測邏輯有誤，需修復
|
||||
- [ ] 18.1 `extractCredentialRefs()` 目前掃描 `{{creds.xxx}}` 語法，但 injection 使用 `inject_as` key
|
||||
- [ ] 18.2 改為讀取 contract.yaml 的 `credentials_required[].key`，與 `cred:{key}` KV 存在性比對
|
||||
- _Requirements: 4.6_
|
||||
|
||||
- [x] 19. `acr parts`、`acr parts scaffold`、`acr parts publish` 已實作
|
||||
- [ ] 19.1 `acr parts` 中 YAML 解析改用 `js-yaml`（目前用 regex，可能解析失敗）
|
||||
- _Requirements: 4.7, 4.8_
|
||||
|
||||
- [x] 20. `acr list` 與 `acr logs` 已實作
|
||||
- _Requirements: 4.9, 4.10_
|
||||
|
||||
---
|
||||
|
||||
## Phase 5：開源發布準備
|
||||
|
||||
- [x] 21. README.md 已撰寫（`arcrun/README.md`）
|
||||
- [x] 22. CONTRIBUTING.md 已撰寫（`arcrun/CONTRIBUTING.md`）
|
||||
- [ ] 23. 安全審查（PR merge 前執行）
|
||||
- [ ] 23.1 搜尋 `.workers.dev` InkStone 網域
|
||||
- [ ] 23.2 確認 wrangler.toml 所有 KV id 欄位留空
|
||||
- [ ] 23.3 確認 `credentials.yaml` 在 `.gitignore` 中
|
||||
- _Requirements: 5.4_
|
||||
|
||||
- [ ] 24. 發布（安全審查後）
|
||||
- [ ] 24.1 `npm publish`（CLI package `arcrun`）
|
||||
- _Requirements: 5.1_
|
||||
|
||||
---
|
||||
|
||||
## Phase 6：Standard 模式 — auth-worker 與用戶 KV 代存取
|
||||
|
||||
- [ ] 25. 建立 `auth-worker`（新 Worker，部署至 `api.arcrun.dev`）
|
||||
- [ ] 25.1 建立 `auth-worker/` 目錄，初始化 Hono + wrangler.toml
|
||||
- [ ] 25.2 實作 `POST /register`：接收 `{ email, account_id, kv_namespace_id }` + CF API Token 透過 header 傳入
|
||||
- **不在 request body 中接收 CF API Token**（Token 透過 header `CF-Api-Token` 傳入，減少 TLS 以外的洩漏面）
|
||||
- 生成 `tenant_id` 與 `api_key`，存入 `ACCOUNTS_KV`
|
||||
- [ ] 25.3 Bindings：`ACCOUNTS_KV`
|
||||
- _Requirements: 6.1, 6.2_
|
||||
|
||||
- [ ] 26. 改造 `cypher-executor` 支援 multi-tenant 用戶 KV 代存取
|
||||
- [ ] 26.1 讀取 `MULTI_TENANT` env var（目前已宣告但未讀取），實作 tenant middleware
|
||||
- [ ] 26.2 `X-Arcrun-API-Key` → 查 `ACCOUNTS_KV` → 取得用戶 cf_api_token + kv_namespace_id → 建立 `CfKvClient`
|
||||
- [ ] 26.3 `CfKvClient` 已實作（`arcrun/cli/src/lib/cf-api.ts`），需移植到 `cypher-executor/src/lib/`
|
||||
- [ ] 26.4 `credential-injector.ts` 改用 userKv 取得加密 credential
|
||||
- [ ] 26.5 webhook 路由注入 userKv
|
||||
- _Requirements: 6.4, 6.5, 6.6_
|
||||
|
||||
- [ ] 27. 端對端測試（用戶 KV 隔離）
|
||||
- _Requirements: 6.4, 6.5_
|
||||
|
||||
---
|
||||
|
||||
## Phase 7：公眾零件統計與貢獻審核
|
||||
|
||||
- [x] 28. Analytics 基礎設施已建立
|
||||
- [x] 28.1 `execution-logger.ts` 建立，`writeExecutionVerdict` 寫入 `ANALYTICS_KV`（fire-and-forget）
|
||||
- [x] 28.2 `/execute` 路由已整合 `waitUntil(writeExecutionVerdict(...))`
|
||||
- [x] 28.3 `/webhooks/:token/trigger` 路由已補上 `waitUntil(writeExecutionVerdict(...))`
|
||||
- _Requirements: 7.2_
|
||||
|
||||
- [ ] 29. registry Worker analytics 端點
|
||||
- [ ] 29.1 新增 `POST /analytics/record` 路由，原子更新 `ANALYTICS_KV`
|
||||
- [ ] 29.2 `GET /components` 回傳加入 `total_runs`、`success_rate`、`avg_duration_ms`
|
||||
- _Requirements: 7.3, 7.6_
|
||||
|
||||
- [x] 30. `author` 欄位已加入 contract.yaml 規格
|
||||
- _Requirements: 7.1_
|
||||
|
||||
- [x] 31. 零件提交審核流程已實作（`arcrun/registry/src/actions/submitComponent.ts`）
|
||||
- [x] 31.1 沙盒驗收流程（sandboxAcceptance.ts）：size_check + syscall_scan 已實作；cold_start + gherkin_tests 為 Phase 0 mock
|
||||
- [x] 31.2 `SUBMISSIONS_KV` 儲存元數據，預設 `visibility: author_only`
|
||||
- [ ] 31.3 `PATCH /submit/:id/approve` → 將 visibility 改為 `public`（待實作）
|
||||
- [ ] 31.4 Gherkin 測試執行（取代 mock）
|
||||
- _Requirements: 8.2, 8.3, 8.4, 8.5_
|
||||
|
||||
---
|
||||
|
||||
## 待辦（無相依順序，可平行處理）
|
||||
|
||||
- [ ] A. `builtins/` 清理：`initComponents.ts` 仍用舊的 HTTP endpoint 模式上架零件（`buildComponentDefs` 含 URL），應改為呼叫 `POST /submit` 送 WASM binary + contract，或直接移除 builtins（功能已整合到 registry）
|
||||
- [ ] B. `validate` 指令 credential 檢測邏輯修復（見 Phase 4 Task 18）
|
||||
- [ ] C. `acr init` 加入 `ARCRUN_ENCRYPTION_KEY` 設定步驟
|
||||
- [ ] D. `acr parts` YAML 解析改用 `js-yaml`
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- 標記 `*` 的子任務為選填，可跳過以加速 MVP 交付
|
||||
- Gherkin 測試執行（sandbox 步驟 d）為 Phase 0 mock，Phase 7 補充
|
||||
- cold-start 測量（sandbox 步驟 b）為 Phase 0 mock，Phase 2 補充
|
||||
- CF API Token 永遠不離開用戶本機，arcrun.dev 只收 email + account_id + kv_namespace_id
|
||||
@@ -0,0 +1,822 @@
|
||||
# Design Document: u6u Platform Evolution
|
||||
|
||||
## Overview
|
||||
|
||||
u6u 平台演進的核心目標是將現有的「HTTP endpoint 零件 + 單一 Cloudflare 部署」架構，演進為「WASM 零件模型 + 三層物理部署 + 雙面翻轉畫布」的完整平台。
|
||||
|
||||
設計的最高原則是 **Dogfooding**：每一層都是下一層的第一個用戶。底層先建立最小可運行的能力，再用自己的方式往上蓋。這確保每個設計決策都被真實使用場景驗證，而非紙上談兵。
|
||||
|
||||
### Bootstrap 順序（不可跳過）
|
||||
|
||||
```
|
||||
Phase 0：最小 WASM 執行核心
|
||||
→ Component Dispatcher 能在 CF Workers 執行一個 .wasm（stdin/stdout JSON）
|
||||
→ validate_json.wasm 作為第一個真實零件（TinyGo，< 50KB，驗證整個 pipeline）
|
||||
→ Component Registry API（/guide、/validate-contract、/components）
|
||||
|
||||
Phase 1：遷移現有零件
|
||||
→ 將 u6u-builtins 的 20 個 HTTP endpoint 逐一遷移為 .wasm
|
||||
→ 遷移期間 Component Dispatcher 雙模式並存（HTTP fallback）
|
||||
→ 每個零件附帶 component.contract.yaml
|
||||
|
||||
Phase 2：Cypher 語意擴展 + Multi-Tier Dispatcher
|
||||
→ 支援 IS_A、ON_SUCCESS、ON_FAIL、CALLS_SUBFLOW、ON_CLICK
|
||||
→ Component Dispatcher 路由層（Tier 1 CF / Tier 2 workerd / Tier 3 Wazero）
|
||||
|
||||
Phase 3：前端畫布（用自己的 Web Components 開發）
|
||||
→ 先建立 Web Components 零件庫（u6u-btn、u6u-card 等）
|
||||
→ 畫布本身用這些 Web Components 組裝
|
||||
→ 雙面翻轉介面
|
||||
```
|
||||
|
||||
### 關鍵設計約束
|
||||
|
||||
- **KBDB 不變量**：永遠只有三張表（blocks / templates / slots），不新增表
|
||||
- **API-First 鐵律**：所有跨服務通訊只透過 HTTP API，禁止相對路徑引用
|
||||
- **零件 I/O 不變量**：唯一合法的 I/O 模型是 `stdin_stdout_json`
|
||||
- **Tier 3 約束**：無 V8、無 Node.js、無網路，所有零件必須在 Wazero 上跑
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
### 系統全景圖
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph "Tier 1 — Cloudflare Workers（雲端）"
|
||||
CE[Cypher Executor<br/>GraphExecutor]
|
||||
CD[Component Dispatcher<br/>路由層]
|
||||
CR[Component Registry<br/>KBDB HTTP API]
|
||||
KBDB[(KBDB<br/>blocks/templates/slots<br/>+ Vectorize)]
|
||||
R2[(R2<br/>.wasm 二進位)]
|
||||
CE --> CD
|
||||
CD --> CR
|
||||
CR --> KBDB
|
||||
CR --> R2
|
||||
end
|
||||
|
||||
subgraph "Tier 2 — workerd self-hosted（企業地端）"
|
||||
T2D[Tier 2 Dispatcher<br/>同 wasi-shim，不同部署]
|
||||
T2R[本地 Registry 快取]
|
||||
T2D --> T2R
|
||||
end
|
||||
|
||||
subgraph "Tier 3 — 邊緣載具"
|
||||
T3E[Go 排程引擎]
|
||||
Wazero[Wazero Runtime]
|
||||
SQLite[(SQLite<br/>本地 KBDB)]
|
||||
DTN[DTN 佇列]
|
||||
T3E --> Wazero
|
||||
T3E --> SQLite
|
||||
T3E --> DTN
|
||||
end
|
||||
|
||||
subgraph "前端"
|
||||
Canvas[雙面翻轉畫布<br/>React 19 + Web Components]
|
||||
WC[Web Components 零件庫<br/>u6u-btn / u6u-card / ...]
|
||||
Canvas --> WC
|
||||
end
|
||||
|
||||
CD -->|WASM 執行| Tier1WASM[.wasm 執行]
|
||||
CD -->|Cypher binding| ExtSvc[外部服務<br/>MCP / n8n / 任意 URL]
|
||||
CD -->|HTTP| T2D
|
||||
T2D -->|Wazero IPC| Wazero
|
||||
DTN -->|Burst 傳輸| T2D
|
||||
Canvas -->|u6u:trigger event| CE
|
||||
```
|
||||
|
||||
### Cypher Binding 的正確定義
|
||||
|
||||
**Cypher binding** 是 u6u 的核心執行機制，指「用 Cypher 三元組語法把零件串接成工作流，串接關係儲存在 KBDB，不寫死在程式碼裡」。
|
||||
|
||||
這個概念相對於 Cloudflare Workers 原生的 **Service Binding**（需要 deploy、串接關係寫死在 wrangler.toml）。
|
||||
|
||||
`cypher-executor` 就是執行 Cypher binding 的引擎。
|
||||
|
||||
**零件本身只有兩種 component_type：**
|
||||
|
||||
| component_type | 說明 | 需要 deploy？ |
|
||||
|---|---|---|
|
||||
| `wasm` | 所有後端零件（內建或用戶自建），本地 WASM 執行 | 否 |
|
||||
| `service_binding` | 多個零件預組合成單一高頻零件的效能最佳化（如 OAuth + GSheets 常用組合） | 是 |
|
||||
|
||||
> **重要：`cypher_binding` 不是 component_type。** 它是整個執行引擎的名字，描述「零件如何被串接」，而不是「零件如何被執行」。所有零件（不管是內建還是用戶自建、不管是打外部 API 還是純邏輯）都是 `.wasm`，透過 Cypher 三元組串接。
|
||||
|
||||
> **所有後端零件都是 `.wasm`。** 需要呼叫外部 HTTP API 的零件（如 google-sheets、http-request），透過 WASI shim 注入的 **host function** 發出網路請求，不在 .wasm 內部直接呼叫網路 syscall。
|
||||
|
||||
### Component Dispatcher 路由決策樹
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[Cypher Executor 呼叫零件 id] --> B{查 Component Registry<br/>取得合約}
|
||||
B --> C{component_type?}
|
||||
C -->|wasm| E{當前 Tier?}
|
||||
C -->|service_binding| SB{有 CF Service Binding?}
|
||||
SB -->|是| SBExec[CF Service Binding 執行<br/>需 deploy，效能最佳]
|
||||
SB -->|否| SBErr[回傳錯誤：binding 未宣告]
|
||||
E -->|Tier 1 / Tier 2| I[workerd WASM<br/>WebAssembly.instantiate<br/>+ WASI shim（兩者相同）]
|
||||
E -->|Tier 3| L[Wazero IPC<br/>stdin/stdout，完全離線]
|
||||
I --> RC{runtime_compat<br/>包含 cf-workers?}
|
||||
RC -->|否| J[回傳 RUNTIME_INCOMPATIBLE 錯誤]
|
||||
RC -->|是| Exec[執行 .wasm]
|
||||
```
|
||||
|
||||
### KBDB 資料模型（tpl-component）
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
TEMPLATES {
|
||||
string template_id "tpl-component"
|
||||
string name
|
||||
string description
|
||||
}
|
||||
BLOCKS {
|
||||
string block_id "comp-{id}-{version}"
|
||||
string template_id
|
||||
string user_id
|
||||
string page_name
|
||||
}
|
||||
SLOTS {
|
||||
string slot_id
|
||||
string block_id
|
||||
string key
|
||||
string value
|
||||
}
|
||||
TEMPLATES ||--o{ BLOCKS : "defines"
|
||||
BLOCKS ||--o{ SLOTS : "has"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Components and Interfaces
|
||||
|
||||
### 1. Component Registry（`u6u-core/registry/`）
|
||||
|
||||
Component Registry 是 KBDB 的薄包裝層，透過 HTTP API 管理零件合約。
|
||||
|
||||
#### 零件命名機制
|
||||
|
||||
零件有兩個名稱，職責完全不同：
|
||||
|
||||
| 欄位 | 由誰決定 | 用途 | 範例 |
|
||||
|---|---|---|---|
|
||||
| `display_name` | 建立者自由取 | 顯示用，不影響任何邏輯 | `宇宙無敵 GSheets 超級寫入器` |
|
||||
| `canonical_id` | Registry AI 正規化後確認 | 搜尋、版本控制、Cypher 引用的唯一鍵 | `gsheets_create_table` |
|
||||
|
||||
**canonical_id 正規化流程：**
|
||||
|
||||
```
|
||||
提交者輸入 display_name
|
||||
↓
|
||||
Registry 用 Workers AI 建議 canonical_id
|
||||
（格式：{service}_{verb}_{object}，全小寫底線）
|
||||
↓
|
||||
同時搜尋 Vectorize，若相似度 > 0.9 的 canonical_id 已存在
|
||||
→ 提示「可能與 gsheets_create_table 重複，是否作為新版本提交？」
|
||||
↓
|
||||
提交者確認或修改 canonical_id
|
||||
↓
|
||||
上架，canonical_id 永久不變
|
||||
```
|
||||
|
||||
#### 零件分類機制
|
||||
|
||||
採用「強制 category + 自由 tags」雙層分類：
|
||||
|
||||
- **`category`**：強制填，有限集合，定義前後端邊界
|
||||
- `logic`：後端邏輯零件（.wasm，純計算/轉換）
|
||||
- `api`：後端 API 零件（.wasm + cypher_binding，呼叫外部服務）
|
||||
- `ui`：前端 UI 元件（Web Component，瀏覽器執行）
|
||||
- `style`：前端樣式零件（CSS tokens）
|
||||
- `anim`：前端動畫零件
|
||||
|
||||
- **`tags`**：自由增加，跨零件共享語意
|
||||
- 例：`gsheets_create_table` 有 `["google", "sheets", "spreadsheet", "storage", "write"]`
|
||||
- 例：`excel_write_row` 有 `["microsoft", "excel", "spreadsheet", "storage", "write"]`
|
||||
- 搜尋「外部存儲」時，兩個都能透過 Vectorize 語意搜尋找到
|
||||
|
||||
**HTTP 端點：**
|
||||
|
||||
```
|
||||
GET /components/guide → 機器可讀開發指引（Markdown）
|
||||
POST /components/validate-contract → 驗證 component.contract.yaml 格式
|
||||
POST /components → 提交零件（.wasm + contract）觸發沙盒驗收
|
||||
GET /components/:id → 取得零件合約（最優版本）
|
||||
GET /components/:id/versions → 取得所有版本清單（含評分）
|
||||
GET /components/search?q=... → 語意搜尋零件
|
||||
```
|
||||
|
||||
**KBDB 整合：**
|
||||
- 每個零件版本 = 一個 Block，`block_id = comp-{id}-{version}`
|
||||
- Template = `tpl-component`（預先建立，不新增表）
|
||||
- `.wasm` 二進位存 R2，KBDB slot 只存 `wasm_r2_key`
|
||||
- `description` + `tags` 欄位寫入 Vectorize 索引，支援語意搜尋
|
||||
|
||||
**Slot 欄位對應（tpl-component）：**
|
||||
|
||||
| Slot key | 說明 | 範例值 |
|
||||
|---|---|---|
|
||||
| `canonical_id` | 正規化功能名稱（永久不變，搜尋/版本控制用） | `gsheets_create_table` |
|
||||
| `display_name` | 建立者自取的顯示名稱 | `宇宙無敵 GSheets 超級寫入器` |
|
||||
| `category` | 零件分類（有限集合） | `logic` / `api` / `ui` / `style` / `anim` |
|
||||
| `version` | 實作版本 | `v1` |
|
||||
| `wasi_target` | WASM 目標 | `preview1` |
|
||||
| `stability` | 穩定性標籤 | `floating` |
|
||||
| `runtime_compat` | 相容 runtime（JSON 陣列） | `["cf-workers","wazero"]` |
|
||||
| `component_type` | 零件類型 | `wasm` / `service_binding` |
|
||||
| `max_size_kb` | 體積上限 | `2048` |
|
||||
| `max_cold_start_ms` | 冷啟動上限 | `50` |
|
||||
| `no_network_syscall` | 禁止網路 syscall | `true` |
|
||||
| `input_schema` | JSON Schema（JSON 字串） | `{"type":"object",...}` |
|
||||
| `output_schema` | JSON Schema（JSON 字串） | `{"type":"object",...}` |
|
||||
| `gherkin_tests` | 測試案例（JSON 字串） | `[{"scenario":"..."}]` |
|
||||
| `wasm_r2_key` | R2 物件鍵（wasm 模式） | `components/validate_json/v1.wasm` |
|
||||
| `service_binding_key` | CF binding key（service_binding 模式） | `CLINIC_GSHEETS` |
|
||||
| `description` | 自然語言描述（寫入 Vectorize） | `在 Google Sheets 建立新工作表` |
|
||||
| `tags` | 自由標籤（JSON 陣列，跨零件共享語意） | `["google","sheets","storage","write"]` |
|
||||
| `success_rate` | 成功率（0-1） | `0.98` |
|
||||
| `avg_duration_ms` | 平均執行時間 | `12` |
|
||||
| `call_count` | 被調用次數 | `1024` |
|
||||
| `status` | 狀態 | `active` / `deprecated` / `tombstone` |
|
||||
| `deprecated_at` | 棄用時間戳記 | `1700000000000` |
|
||||
|
||||
### 2. Component Dispatcher（`cypher-executor/src/lib/component-loader.ts` 擴展）
|
||||
|
||||
Component Dispatcher 是 `createComponentLoader` 的升級版，新增 WASM 執行路徑。
|
||||
|
||||
**介面定義：**
|
||||
|
||||
```typescript
|
||||
// 零件類型（只有兩種）
|
||||
type ComponentType =
|
||||
| 'wasm' // 所有後端零件，透過 Cypher binding 串接，本地 WASM 執行
|
||||
| 'service_binding'; // 效能最佳化：CF Service Binding，需 deploy，用於高頻預組合零件
|
||||
|
||||
// 新版 ComponentDescriptor
|
||||
type ComponentDescriptor = {
|
||||
component_type: ComponentType;
|
||||
// WASM 模式
|
||||
wasm_r2_key?: string;
|
||||
runtime_compat?: string[];
|
||||
max_cold_start_ms?: number;
|
||||
// Service Binding 模式（CF Worker 間高效呼叫，需 deploy）
|
||||
binding?: string; // wrangler.toml 中宣告的 binding key
|
||||
path?: string;
|
||||
};
|
||||
```
|
||||
|
||||
**Tier 1 WASM 執行（CF Workers 原生）：**
|
||||
|
||||
Cloudflare Workers 原生支援 `WebAssembly.instantiate`，但 WASI preview1 需要手動實作 WASI imports。設計採用輕量 WASI shim 方案：
|
||||
|
||||
```typescript
|
||||
// WASI preview1 shim（只實作 stdin/stdout/stderr，其餘 syscall 回傳 ENOSYS）
|
||||
function createWasiImports(stdin: Uint8Array): {
|
||||
imports: WebAssembly.Imports;
|
||||
getStdout: () => Uint8Array;
|
||||
} {
|
||||
const stdoutChunks: Uint8Array[] = [];
|
||||
let stdinOffset = 0;
|
||||
|
||||
return {
|
||||
imports: {
|
||||
wasi_snapshot_preview1: {
|
||||
fd_write: (fd: number, iovs: number, iovs_len: number, nwritten: number) => { /* ... */ },
|
||||
fd_read: (fd: number, iovs: number, iovs_len: number, nread: number) => { /* ... */ },
|
||||
proc_exit: (code: number) => { throw new Error(`wasm exit: ${code}`); },
|
||||
// 其餘 syscall 回傳 ENOSYS（76）
|
||||
fd_seek: () => 76,
|
||||
fd_close: () => 0,
|
||||
environ_get: () => 0,
|
||||
environ_sizes_get: () => 0,
|
||||
args_get: () => 0,
|
||||
args_sizes_get: () => 0,
|
||||
clock_time_get: () => 0,
|
||||
random_get: (buf: number, buf_len: number) => { /* crypto.getRandomValues */ return 0; },
|
||||
},
|
||||
},
|
||||
getStdout: () => { /* 合併 stdoutChunks */ },
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
> **設計決策**：不使用 `@cloudflare/workers-wasi`（已停止維護）。改用自製輕量 WASI shim，只實作 `fd_read`/`fd_write`/`proc_exit`/`random_get`，其餘 syscall 回傳 `ENOSYS`。這足以支援 TinyGo/Rust/AssemblyScript 的 stdin/stdout 零件，且不引入外部依賴。
|
||||
|
||||
**執行流程：**
|
||||
|
||||
```
|
||||
1. 從 R2 取得 .wasm 二進位（ArrayBuffer）
|
||||
2. WebAssembly.compile(buffer) → WebAssembly.Module
|
||||
3. 建立 WASI imports shim（注入 stdin = JSON.stringify(input)）
|
||||
4. WebAssembly.instantiate(module, imports)
|
||||
5. 呼叫 _start() 或 main()
|
||||
6. 從 stdout buffer 讀取輸出
|
||||
7. JSON.parse(stdout) → output
|
||||
```
|
||||
|
||||
**R2 快取策略：**
|
||||
- 第一次呼叫：從 R2 fetch `.wasm`，`WebAssembly.compile` 後快取 `WebAssembly.Module`（Worker 記憶體，跨請求共享）
|
||||
- 後續呼叫：直接用快取的 Module，只重新 instantiate（避免重複編譯）
|
||||
|
||||
### 3. Cypher Triplet Parser 擴展（`cypher-executor/src/actions/triplet-parser.ts`）
|
||||
|
||||
現有 parser 只支援 `PIPE / IF / FOREACH / CONTINUE`。需擴展支援新語意關係。
|
||||
|
||||
**新增 EdgeType：**
|
||||
|
||||
```typescript
|
||||
export type EdgeType =
|
||||
| 'PIPE' | 'IF' | 'FOREACH' | 'CONTINUE' // 現有
|
||||
| 'IS_A' | 'ON_SUCCESS' | 'ON_FAIL' // 新增：執行語意
|
||||
| 'ON_CLICK' | 'CALLS_SUBFLOW' // 新增：觸發語意
|
||||
| 'CONTAINS' | 'HAS_STYLE' | 'HAS_BEHAVIOR'; // 新增：結構語意
|
||||
```
|
||||
|
||||
**URI 協議解析：**
|
||||
|
||||
```typescript
|
||||
// 節點 componentId 解析
|
||||
function resolveComponentId(uri: string): {
|
||||
type: 'component' | 'workflow' | 'ui' | 'style';
|
||||
canonicalId: string;
|
||||
stability: 'floating' | 'stable' | 'pinned';
|
||||
pinnedVersion?: string;
|
||||
} {
|
||||
// component://validate_json@stable → { type: 'component', canonicalId: 'validate_json', stability: 'stable' }
|
||||
// component://validate_json@pinned:v1 → { type: 'component', canonicalId: 'validate_json', stability: 'pinned', pinnedVersion: 'v1' }
|
||||
// workflow://wf_save_to_db → { type: 'workflow', canonicalId: 'wf_save_to_db', stability: 'floating' }
|
||||
// ui://u6u-btn → { type: 'ui', canonicalId: 'u6u-btn', stability: 'floating' }
|
||||
}
|
||||
```
|
||||
|
||||
**ON_SUCCESS / ON_FAIL 執行語意：**
|
||||
|
||||
GraphExecutor 需要區分「節點執行成功」vs「節點執行失敗」，而非依賴 context 欄位：
|
||||
|
||||
```typescript
|
||||
// 在 executeNode 中，捕捉 try/catch 後分別走 ON_SUCCESS / ON_FAIL 邊
|
||||
case 'ON_SUCCESS':
|
||||
// 只在上游節點成功時執行
|
||||
if (!nodeError) {
|
||||
result = await this.executeNode(nextNode, ...);
|
||||
}
|
||||
break;
|
||||
case 'ON_FAIL':
|
||||
// 只在上游節點失敗時執行（接收 error context）
|
||||
if (nodeError) {
|
||||
result = await this.executeNode(nextNode, graph, { ...context, error: nodeError }, ...);
|
||||
}
|
||||
break;
|
||||
```
|
||||
|
||||
**CALLS_SUBFLOW 執行語意：**
|
||||
|
||||
```typescript
|
||||
case 'CALLS_SUBFLOW': {
|
||||
// 從 KBDB 載入子 Workflow 定義
|
||||
const subWorkflowId = nextNode.componentId!.replace('workflow://', '');
|
||||
const subGraph = await loadWorkflowFromKBDB(subWorkflowId, env);
|
||||
const subExecutor = new GraphExecutor(loader);
|
||||
const subResult = await subExecutor.execute(subGraph, result as Record<string, unknown>, kvNamespace);
|
||||
result = { ...(result as Record<string, unknown>), ...subResult.data as Record<string, unknown> };
|
||||
break;
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Web Components 零件庫（`u6u-core/web-components/`）
|
||||
|
||||
Web Components 以原生 Custom Elements API 實作，不依賴任何框架。
|
||||
|
||||
**`<u6u-btn>` 介面：**
|
||||
|
||||
```typescript
|
||||
// HTML attributes
|
||||
interface U6uBtnAttributes {
|
||||
label: string; // 顯示文字
|
||||
color?: string; // 主題色（CSS custom property）
|
||||
tooltip?: string; // 滑鼠懸停提示（純靜態）
|
||||
workflow?: string; // workflow://id
|
||||
disabled?: boolean;
|
||||
}
|
||||
|
||||
// 發出的自訂事件
|
||||
interface U6uTriggerEvent extends CustomEvent {
|
||||
detail: {
|
||||
workflowId: string;
|
||||
payload: Record<string, unknown>;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
**`<u6u-card>` Smart Container 邏輯：**
|
||||
|
||||
```typescript
|
||||
// u6u-card 攔截子元件的 u6u:trigger 事件
|
||||
// 收集同容器內所有 u6u-text-input / u6u-text-field 的值
|
||||
// 合併至 payload 後再向上冒泡
|
||||
connectedCallback() {
|
||||
this.addEventListener('u6u:trigger', (e: Event) => {
|
||||
const trigger = e as CustomEvent;
|
||||
e.stopPropagation();
|
||||
|
||||
const inputs = this.querySelectorAll('u6u-text-input, u6u-text-field');
|
||||
const collected: Record<string, unknown> = {};
|
||||
inputs.forEach(input => {
|
||||
const name = input.getAttribute('name');
|
||||
const value = (input as any).value;
|
||||
if (name) collected[name] = value;
|
||||
});
|
||||
|
||||
this.dispatchEvent(new CustomEvent('u6u:trigger', {
|
||||
bubbles: true,
|
||||
composed: true,
|
||||
detail: {
|
||||
...trigger.detail,
|
||||
payload: { ...trigger.detail.payload, ...collected },
|
||||
},
|
||||
}));
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### 5. 雙面翻轉畫布（`inkstone-admin/frontend/web/`）
|
||||
|
||||
畫布本身用 React 19 + Web Components 組裝，體現 dogfooding 原則。
|
||||
|
||||
**翻轉狀態機：**
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> UIView: 初始狀態
|
||||
UIView --> LogicView: 點擊翻面按鈕
|
||||
LogicView --> UIView: 點擊翻面按鈕
|
||||
LogicView --> Editing: 修改三元組
|
||||
Editing --> Saving: 確認儲存
|
||||
Saving --> LogicView: KBDB 寫入成功
|
||||
Saving --> LogicView: KBDB 寫入失敗（顯示錯誤）
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Data Models
|
||||
|
||||
### Component Contract YAML（完整規格）
|
||||
|
||||
```yaml
|
||||
canonical_id: "validate_json" # 正規化功能名稱（永久不變，Registry AI 正規化後確認）
|
||||
display_name: "JSON 格式驗證器" # 建立者自取，顯示用
|
||||
category: "logic" # logic | api | ui | style | anim
|
||||
version: "v1" # 實作版本
|
||||
wasi_target: "preview1" # WASM 目標格式
|
||||
stability: "floating" # floating | stable | pinned
|
||||
|
||||
runtime_compat:
|
||||
- "cf-workers"
|
||||
- "workerd"
|
||||
- "wazero"
|
||||
|
||||
constraints:
|
||||
max_size_kb: 2048
|
||||
max_cold_start_ms: 50
|
||||
no_network_syscall: true
|
||||
no_filesystem_syscall: true
|
||||
io_model: "stdin_stdout_json" # 唯一合法值
|
||||
|
||||
input_schema:
|
||||
type: object
|
||||
required: ["json_string"]
|
||||
properties:
|
||||
json_string:
|
||||
type: string
|
||||
description: "待驗證的 JSON 字串"
|
||||
|
||||
output_schema:
|
||||
type: object
|
||||
properties:
|
||||
valid:
|
||||
type: boolean
|
||||
error:
|
||||
type: string
|
||||
description: "驗證失敗時的錯誤訊息"
|
||||
|
||||
gherkin_tests:
|
||||
- scenario: "合法 JSON 通過驗證"
|
||||
given: '{"json_string":"{\"key\":\"value\"}"}'
|
||||
then_contains: '{"valid":true}'
|
||||
- scenario: "非法 JSON 回傳錯誤"
|
||||
given: '{"json_string":"not-json"}'
|
||||
then_contains: '{"valid":false,"error":'
|
||||
|
||||
tags: ["validation", "json", "utility"]
|
||||
description: "驗證輸入字串是否為合法 JSON 格式"
|
||||
```
|
||||
|
||||
### 零件開發語言決策
|
||||
|
||||
**內建零件使用 TinyGo**（純邏輯零件）和 TinyGo + `json.RawMessage`（需要任意 HTTP body 的零件）。不引入 Rust 作為內建零件語言。
|
||||
|
||||
**用戶自建零件支援三種語言，按難度分層：**
|
||||
|
||||
| 語言 | 目標用戶 | JSON 能力 | 備註 |
|
||||
|---|---|---|---|
|
||||
| **AssemblyScript** | 一般用戶（TS 背景） | 社群套件 `assemblyscript-json`，支援動態 JSON | 語法最接近 TS，門檻最低；靜默錯誤風險，沙盒驗收必須通過 |
|
||||
| **TinyGo** | 技術較強用戶（Go 背景） | 靜態 struct 完整支援；`json.RawMessage` 處理任意 body | 編譯期報錯，AI 生成安全性較高 |
|
||||
| **Rust** | 進階用戶 | `serde_json::Value` 完整動態 JSON | 生態最成熟，體積最小；學習曲線陡 |
|
||||
|
||||
**`/components/guide` 端點提供三份語言範例**，用戶根據自身背景選擇。
|
||||
|
||||
**內建零件 JSON 策略（TinyGo）：**
|
||||
|
||||
```go
|
||||
// 固定 schema 零件（google-sheets、gmail 等）→ 靜態 struct
|
||||
type Input struct {
|
||||
SpreadsheetId string `json:"spreadsheet_id"`
|
||||
Range string `json:"range"`
|
||||
AccessToken string `json:"access_token"`
|
||||
}
|
||||
|
||||
// 任意 body 零件（http-request）→ json.RawMessage 傳遞 raw bytes，不解析
|
||||
type Input struct {
|
||||
URL string `json:"url"`
|
||||
Method string `json:"method"`
|
||||
Body json.RawMessage `json:"body"` // 任意 JSON，不解析
|
||||
}
|
||||
```
|
||||
|
||||
### Workflow Cypher 三元組（完整語法）
|
||||
|
||||
```yaml
|
||||
kind: Workflow
|
||||
id: wf_submit_form
|
||||
|
||||
triplets:
|
||||
# 節點類型宣告
|
||||
- "btn_submit >> IS_A >> ui://u6u-btn"
|
||||
- "step_validate >> IS_A >> component://validate_json"
|
||||
- "step_save >> IS_A >> component://kbdb_write"
|
||||
|
||||
# 前端觸發後端
|
||||
- "btn_submit >> ON_CLICK >> step_validate"
|
||||
|
||||
# 成功/失敗分支
|
||||
- "step_validate >> ON_SUCCESS >> step_save"
|
||||
- "step_validate >> ON_FAIL >> step_notify_error"
|
||||
|
||||
# 子流程呼叫
|
||||
- "step_save >> ON_SUCCESS >> CALLS_SUBFLOW >> workflow://wf_notify_user"
|
||||
|
||||
# 容器結構
|
||||
- "card_main >> CONTAINS >> btn_submit"
|
||||
- "card_main >> CONTAINS >> input_name"
|
||||
```
|
||||
|
||||
### Evaluation Block（KBDB tpl-evaluation）
|
||||
|
||||
每次 Workflow 執行後，Evaluator Agent 寫入一個 Evaluation Block：
|
||||
|
||||
| Slot key | 說明 |
|
||||
|---|---|
|
||||
| `run_id` | 執行唯一 ID |
|
||||
| `workflow_id` | Workflow ID |
|
||||
| `component_id` | 被評價的零件 ID |
|
||||
| `verdict` | `success` / `failed` / `timeout` |
|
||||
| `duration_ms` | 執行時間 |
|
||||
| `error_message` | 失敗訊息（可選） |
|
||||
| `evaluated_at` | 評價時間戳記 |
|
||||
|
||||
### Pitfall Block（KBDB tpl-pitfall）
|
||||
|
||||
| Slot key | 說明 |
|
||||
|---|---|
|
||||
| `component_id` | 問題零件 ID |
|
||||
| `failure_pattern` | 失敗模式描述 |
|
||||
| `first_seen_at` | 首次發現時間戳記 |
|
||||
| `occurrence_count` | 發生次數 |
|
||||
|
||||
---
|
||||
|
||||
## Correctness Properties
|
||||
|
||||
*A property is a characteristic or behavior that should hold true across all valid executions of a system — essentially, a formal statement about what the system should do. Properties serve as the bridge between human-readable specifications and machine-verifiable correctness guarantees.*
|
||||
|
||||
|
||||
### Property Reflection（去重分析）
|
||||
|
||||
在寫出最終屬性前，先做冗餘分析：
|
||||
|
||||
- **1.1 + 1.2**：都是合約欄位完整性驗證，合併為 Property 1「合約格式完整性」
|
||||
- **2.1 + 2.2**：驗收流程執行 + 失敗回報，合併為 Property 2「沙盒驗收流程正確性」
|
||||
- **2.3 + 2.4**：提交後可讀取 + 冪等提交，合併為 Property 3「零件提交冪等性與持久性」
|
||||
- **3.1 + 3.5**：WASM 執行 + 雙模式路由，合併為 Property 4「Component Dispatcher 路由正確性」
|
||||
- **3.4 + 6.4**：不相容 Tier 回傳錯誤 + 結構化錯誤，合併為 Property 5「Dispatcher 錯誤結構完整性」
|
||||
- **4.1**：URI 解析 round-trip，獨立為 Property 6
|
||||
- **4.2 + 4.4**：版本選擇算法（floating 最高分 + pinned 固定版本），合併為 Property 7「版本選擇策略正確性」
|
||||
- **4.5**：版本保留不變量，獨立為 Property 8
|
||||
- **5.7**：Confluence 屬性，獨立為 Property 9
|
||||
- **8.3 + 8.4 + 8.5**：Web Components 事件與渲染，合併為 Property 10「Web Components 事件與渲染冪等性」
|
||||
- **10.6 + 12.5**：評價冪等性 + 查詢冪等性，合併為 Property 11「系統操作冪等性」
|
||||
|
||||
最終保留 11 個屬性，每個提供獨立驗證價值。
|
||||
|
||||
---
|
||||
|
||||
### Property 1: 合約格式完整性
|
||||
|
||||
*For any* component contract object，若缺少任何必填欄位（`id`、`version`、`wasi_target`、`stability`、`runtime_compat`、`constraints.max_size_kb`、`constraints.max_cold_start_ms`、`constraints.no_network_syscall`、`constraints.io_model`、`input_schema`、`output_schema`、`gherkin_tests`），合約驗證器 SHALL 拒絕該合約並回傳包含缺失欄位名稱的錯誤；反之，包含所有必填欄位的合約 SHALL 通過格式驗證。
|
||||
|
||||
**Validates: Requirements 1.1, 1.2, 1.4**
|
||||
|
||||
---
|
||||
|
||||
### Property 2: 沙盒驗收流程正確性
|
||||
|
||||
*For any* 提交的零件（.wasm + contract），若零件在驗收步驟 N 失敗，Component_Registry 的回應 SHALL 包含步驟 N 的名稱與具體失敗原因，且不執行步驟 N+1 之後的步驟。
|
||||
|
||||
**Validates: Requirements 2.1, 2.2**
|
||||
|
||||
---
|
||||
|
||||
### Property 3: 零件提交冪等性與持久性
|
||||
|
||||
*For any* 通過驗收的零件（id, version），提交後從 Component_Registry 讀取該零件的合約，所有欄位值 SHALL 與提交時的合約完全一致（序列化 round-trip）；對相同 (id, version) 重複提交 N 次，KBDB 中 SHALL 只存在一個對應的 Block。
|
||||
|
||||
**Validates: Requirements 2.3, 2.4**
|
||||
|
||||
---
|
||||
|
||||
### Property 4: Component Dispatcher 路由正確性
|
||||
|
||||
*For any* 零件合約，若 `io_model = "stdin_stdout_json"`，Component_Dispatcher SHALL 使用 WASM 執行路徑，將 input JSON 寫入 stdin，從 stdout 讀取 output JSON；若 `io_model = "http_endpoint"`，SHALL 使用 HTTP 路徑。對任意合法 JSON input，WASM 執行路徑的輸出 SHALL 與 HTTP 執行路徑的輸出語意等效。
|
||||
|
||||
**Validates: Requirements 3.1, 3.5, 3.6**
|
||||
|
||||
---
|
||||
|
||||
### Property 5: Dispatcher 錯誤結構完整性
|
||||
|
||||
*For any* (component_id, tier) 組合，若該零件的 `runtime_compat` 不包含當前 tier，Component_Dispatcher 的錯誤回應 SHALL 同時包含：零件 id、當前 tier 名稱、已嘗試的呼叫路徑清單，三個欄位缺一不可。
|
||||
|
||||
**Validates: Requirements 3.4, 6.4**
|
||||
|
||||
---
|
||||
|
||||
### Property 6: 零件 URI 解析 Round-Trip
|
||||
|
||||
*For any* 合法的零件 URI 字串（格式為 `component://id`、`component://id@stable`、`component://id@pinned:vN`），解析後再重新序列化 SHALL 產生與原始 URI 語意等效的字串；解析出的 `id`、`stability`、`pinnedVersion` 欄位 SHALL 與原始 URI 中的對應部分完全一致。
|
||||
|
||||
**Validates: Requirements 4.1**
|
||||
|
||||
---
|
||||
|
||||
### Property 7: 版本選擇策略正確性
|
||||
|
||||
*For any* 零件 id 下的版本集合（每個版本有 success_rate、avg_duration_ms、call_count 評分），當 stability = `floating` 時，Component_Dispatcher SHALL 選取「成功率 × 速度評分 × 被調用次數」最高的版本；當 stability = `pinned:vN` 時，無論版本集合中其他版本的評分如何，SHALL 永遠選取版本 vN。
|
||||
|
||||
**Validates: Requirements 4.2, 4.4**
|
||||
|
||||
---
|
||||
|
||||
### Property 8: 歷史版本永久保留不變量
|
||||
|
||||
*For any* 已上架的零件版本（id, version），無論該版本後來被標記為 `deprecated` 或 `tombstone`，其 `.wasm` 二進位 SHALL 永遠可從 R2 讀取，且 `pinned` 引用 SHALL 永遠能透過 Component_Dispatcher 執行該版本。
|
||||
|
||||
**Validates: Requirements 4.5, 10.5**
|
||||
|
||||
---
|
||||
|
||||
### Property 9: Cypher 三元組解析 Confluence（順序無關性）
|
||||
|
||||
*For any* 合法的 Cypher 三元組集合，無論三元組在輸入陣列中的排列順序如何，`parseTriplets` 產生的執行圖（節點集合、邊集合、拓撲結構）SHALL 語意等效——即相同的節點 id 集合、相同的 (from, to, type) 邊集合。
|
||||
|
||||
**Validates: Requirements 5.7**
|
||||
|
||||
---
|
||||
|
||||
### Property 10: Web Components 事件與渲染冪等性
|
||||
|
||||
*For any* workflow URI 設定於 `<u6u-btn>` 的 `workflow` attribute，使用者點擊後發出的 `u6u:trigger` 事件 detail 中的 `workflowId` SHALL 與 URI 中的 id 完全一致；*For any* 一組具名 `<u6u-text-input>` 元件置於 `<u6u-card>` 內，觸發事件後收集到的 payload SHALL 包含所有輸入元件的 name-value 對；*For any* attribute 值，對同一 Web Component 設定相同 attribute 值 N 次，渲染結果 SHALL 與設定一次相同（冪等渲染）。
|
||||
|
||||
**Validates: Requirements 8.3, 8.4, 8.5**
|
||||
|
||||
---
|
||||
|
||||
### Property 11: 系統操作冪等性
|
||||
|
||||
*For any* Workflow 執行日誌（run_id），Evaluator_Agent 對相同 run_id 處理 N 次，KBDB 中 SHALL 只存在一個對應的 Evaluation Block，不產生重複記錄；*For any* Component_Registry 讀取操作的查詢參數，在 KBDB 資料不變的前提下，對相同參數呼叫 N 次 SHALL 回傳完全相同的結果。
|
||||
|
||||
**Validates: Requirements 10.6, 12.5**
|
||||
|
||||
---
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Component Dispatcher 錯誤分類
|
||||
|
||||
| 錯誤類型 | 觸發條件 | 回應格式 |
|
||||
|---|---|---|
|
||||
| `COMPONENT_NOT_FOUND` | KBDB 中找不到零件 | `{ error: "COMPONENT_NOT_FOUND", component_id, tier }` |
|
||||
| `RUNTIME_INCOMPATIBLE` | runtime_compat 不含當前 Tier | `{ error: "RUNTIME_INCOMPATIBLE", component_id, tier, attempted_paths: [] }` |
|
||||
| `WASM_EXECUTION_TIMEOUT` | 超過 max_cold_start_ms | `{ error: "WASM_EXECUTION_TIMEOUT", component_id, timeout_ms }` |
|
||||
| `WASM_INVALID_OUTPUT` | stdout 不是合法 JSON | `{ error: "WASM_INVALID_OUTPUT", component_id, raw_output }` |
|
||||
| `WASM_SYSCALL_VIOLATION` | .wasm 嘗試網路/檔案 syscall | `{ error: "WASM_SYSCALL_VIOLATION", component_id, syscall_name }` |
|
||||
| `CONTRACT_VALIDATION_FAILED` | 合約格式不合規 | `{ error: "CONTRACT_VALIDATION_FAILED", missing_fields: [] }` |
|
||||
|
||||
### 沙盒驗收失敗回應格式
|
||||
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"failed_step": "syscall_scan",
|
||||
"reason": "發現禁止的 syscall：sock_connect",
|
||||
"guide_anchor": "#syscall-constraints",
|
||||
"component_id": "my_component",
|
||||
"version": "v1"
|
||||
}
|
||||
```
|
||||
|
||||
### Tier 3 離線錯誤處理
|
||||
|
||||
Tier 3 在離線環境中，所有無法執行的操作都寫入 DTN 佇列，不拋出錯誤：
|
||||
|
||||
```go
|
||||
// Go 排程引擎的錯誤處理策略
|
||||
type DTNEntry struct {
|
||||
Type string // "missing_component" | "sync_log" | "request_wasm"
|
||||
Payload json.RawMessage
|
||||
CreatedAt time.Time
|
||||
RetryCount int
|
||||
}
|
||||
```
|
||||
|
||||
### Web Components 錯誤邊界
|
||||
|
||||
`<u6u-btn>` 在 `workflow` attribute 未設定時，點擊不發出事件，僅在 console 輸出警告：
|
||||
|
||||
```
|
||||
[u6u-btn] workflow attribute is not set, click event ignored
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### 雙軌測試策略
|
||||
|
||||
本功能採用「單元測試 + 屬性測試」雙軌策略：
|
||||
|
||||
- **單元測試（Vitest）**：驗證具體範例、邊界條件、錯誤情境
|
||||
- **屬性測試（fast-check）**：驗證上述 11 個 Correctness Properties，每個屬性最少執行 100 次迭代
|
||||
|
||||
### 屬性測試配置
|
||||
|
||||
使用 `fast-check`（已在 tech stack 中），每個屬性測試標記格式：
|
||||
|
||||
```typescript
|
||||
// Feature: arcrun-platform-evolution, Property N: {property_text}
|
||||
it.prop([fc.record({ id: fc.string(), version: fc.string(), ... })])(
|
||||
'Property 1: 合約格式完整性',
|
||||
(contract) => {
|
||||
// ...
|
||||
},
|
||||
{ numRuns: 100 }
|
||||
);
|
||||
```
|
||||
|
||||
### 各 Phase 測試重點
|
||||
|
||||
**Phase 0（WASM 執行核心）：**
|
||||
- Property 4：WASM 執行路徑 round-trip（`validate_json.wasm` 作為 ground truth）
|
||||
- Property 1：合約格式驗證
|
||||
- 單元測試：WASI shim 的 `fd_read`/`fd_write` 正確性
|
||||
|
||||
**Phase 1（零件遷移）：**
|
||||
- Property 3：提交冪等性（20 個零件各提交兩次，驗證無重複）
|
||||
- Property 2：沙盒驗收流程（各步驟失敗案例）
|
||||
- Property 8：歷史版本保留（deprecate 後仍可讀取）
|
||||
|
||||
**Phase 2（Cypher 擴展）：**
|
||||
- Property 9：Confluence（三元組順序無關性，fast-check shuffle）
|
||||
- Property 6：URI 解析 round-trip
|
||||
- Property 7：版本選擇策略（floating 最高分、pinned 固定版本）
|
||||
- Property 5：錯誤結構完整性
|
||||
|
||||
**Phase 3（前端畫布）：**
|
||||
- Property 10：Web Components 事件與渲染冪等性（`@testing-library/react` + fast-check）
|
||||
- Property 11：評價冪等性（Evaluator Agent 重複處理）
|
||||
|
||||
### 整合測試
|
||||
|
||||
以下場景使用整合測試（1-3 個具體範例，不用 PBT）：
|
||||
|
||||
- Tier 1 CF Workers 環境中實際執行 `validate_json.wasm`（驗證 WASM 在 Workers 環境可運行）
|
||||
- KBDB tpl-component Template 建立與 Slot 讀寫（驗證 KBDB 整合）
|
||||
- R2 `.wasm` 上傳與讀取（驗證 R2 整合）
|
||||
- Vectorize 語意搜尋（驗證「查詢 Google Sheets 資料」能找到 `gsheets_get_entries`）
|
||||
|
||||
### 單元測試重點（非 PBT）
|
||||
|
||||
- WASI shim：`fd_read` 正確讀取 stdin、`fd_write` 正確寫入 stdout
|
||||
- `evaluateCondition`：現有條件評估函數的邊界案例
|
||||
- `resolveComponentId`：URI 解析的邊界案例（空字串、特殊字元）
|
||||
- `<u6u-card>` Smart Container：巢狀容器的事件冒泡行為
|
||||
@@ -0,0 +1,219 @@
|
||||
# Requirements Document
|
||||
|
||||
## Introduction
|
||||
|
||||
u6u 平台演進規格描述從現況（HTTP endpoint 零件、單一 Cloudflare 部署、無前端畫布）
|
||||
到目標架構（WASM 零件模型、三層物理部署、雙面翻轉畫布）的完整演進路徑。
|
||||
|
||||
本規格涵蓋三個核心演進軸：
|
||||
|
||||
1. **零件模型遷移**：將 20 個內建零件從 Cloudflare Worker HTTP endpoint 遷移至 WASI preview1 `.wasm` 格式，附帶 `component.contract.yaml`，以 stdin/stdout JSON 作為唯一 I/O 模型。
|
||||
2. **多 Tier 執行抽象**：讓 Cypher Executor 透過統一的 Component Dispatcher 介面，跨 Tier 1（Cloudflare Workers）、Tier 2（workerd 地端叢集）、Tier 3（Go + Wazero 邊緣載具）呼叫零件。
|
||||
3. **前端雙面畫布**：建立以 Web Components 為基礎的視覺化畫布，正面為 UI 視圖，反面為 Cypher 邏輯視圖，智慧容器自動打包表單值。
|
||||
|
||||
---
|
||||
|
||||
## Glossary
|
||||
|
||||
- **Component（零件）**：系統最小執行單元，一個零件只做一件事，以 `.wasm`（WASI preview1）或 Web Component 形式存在。
|
||||
- **Component_Contract**：每個零件附帶的 `component.contract.yaml`，定義 id、version、wasi_target、stability、runtime_compat、constraints、input_schema、output_schema、gherkin_tests。
|
||||
- **Component_Registry**：KBDB 中儲存所有零件合約與 `.wasm` 位置的索引，以 `tpl-component` Template Block 實作。
|
||||
- **Component_Dispatcher**：Cypher Executor 內部的路由層，根據零件的 `runtime_compat` 與目標 Tier 決定呼叫路徑（Service Binding / workerd HTTP / Wazero IPC）。
|
||||
- **Cypher_Executor**：Workflow 執行引擎，解析三元組語法，透過 GraphExecutor 執行節點，現部署於 Cloudflare Workers。
|
||||
- **Cypher_Triplet**：`"A >> 關係 >> B"` 格式的三元組，描述節點間的語意關係。
|
||||
- **KBDB**：三位一體記憶庫（blocks / templates / slots），搭配 Cloudflare Vectorize，是平台唯一的持久化狀態來源。
|
||||
- **Tier_1**：雲端層，Cloudflare Workers + D1 + Vectorize + R2，全球無伺服器部署。
|
||||
- **Tier_2**：企業地端層，workerd 叢集 + Kùzu 或 PostgreSQL + AGE，高機密內網環境。
|
||||
- **Tier_3**：邊緣載具層，Go 排程引擎 + 內嵌 Wazero + SQLite，無 V8、無網路的極限環境（無人機、AGV）。
|
||||
- **WASI_Preview1**：WebAssembly System Interface preview1 規格，零件唯一合法的 WASM 目標格式。
|
||||
- **Canvas（畫布）**：前端雙面翻轉介面，正面為 UI 視圖，反面為 Cypher 邏輯視圖。
|
||||
- **Smart_Container**：畫布上的排版容器（如 `<u6u-card>`），自動打包同容器內所有輸入元件的值並附加至觸發事件的 payload。
|
||||
- **Forge_AI**：工匠 AI，負責在 Tier 2 地端接收零件規格、生成 TinyGo 程式碼、編譯並測試 `.wasm`。
|
||||
- **Evaluator_Agent**：強制評價代理，每次 Workflow 執行後自動評估成功率、效能、警告訊息。
|
||||
- **Pitfall_Block**：KBDB 中記錄已知問題的 Block，AI 搜尋時強制讀取以繞道。
|
||||
- **Stability_Tag**：零件版本穩定性標籤，值為 `floating`（AI 自動選最優）、`stable`（人工確認才換）、`pinned`（版本凍結）。
|
||||
- **DTN**：Delay-Tolerant Networking，Tier 3 邊緣載具在間歇性網路下的短點射傳輸協議。
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement 1：零件合約規格標準化
|
||||
|
||||
**User Story:** As a 平台架構師, I want 每個零件都有標準化的 `component.contract.yaml` 合約, so that AI 能透過統一介面讀取零件能力，並在任何 Tier 上驗證相容性。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Component_Contract SHALL 包含以下必填欄位：`canonical_id`（功能合約名稱，永久不變）、`display_name`（人類可讀名稱，可自由撰寫）、`description`（語意搜尋用途，需精確描述零件能做什麼、適用情境，至少 20 字）、`version`（實作版本）、`wasi_target`（值為 `"preview1"`）、`stability`（值為 `floating`、`stable` 或 `pinned` 之一）、`runtime_compat`（陣列，值為 `cf-workers`、`workerd`、`wazero` 的子集）、`constraints`、`input_schema`、`output_schema`、`gherkin_tests`。
|
||||
1a. THE `canonical_id` SHALL 遵循以下命名規範，以確保全庫一致性：
|
||||
- 格式：`{scope}_{action}` 或 `{scope}_{object}` 或 `{scope}`（單詞），全部小寫底線，不超過 4 個單詞
|
||||
- **整合類**（category: api）：以服務名稱為 scope，可加動作；範例：`gmail`、`gmail_send`、`google_sheets`、`google_sheets_append`、`telegram`、`telegram_send`
|
||||
- **資料處理類**（category: data）：以資料型別或操作為 scope；範例：`string_ops`、`array_ops`、`date_ops`、`json_transform`
|
||||
- **控制流類**（category: logic）：以控制結構名稱命名；範例：`if_control`、`foreach_control`、`try_catch`、`switch`、`wait`
|
||||
- **AI 類**（category: ai）：以 `ai_` 為前綴；範例：`ai_transform_compile`、`ai_summarize`、`ai_classify`
|
||||
- 禁止：中文、空格、大寫、連字號（`-`）、版本號混入 id（`gmail_v2` 用 `version: v2` 表達）
|
||||
1b. THE `display_name` SHALL 為人類可讀的自由格式名稱（可中文、可含空格）；此欄位供 UI 顯示用，不作為系統識別符。範例：`canonical_id: google_sheets_append` 配 `display_name: "Google Sheets — 新增一列"`。
|
||||
1c. THE `description` SHALL 用於 Vectorize 語意搜尋索引；撰寫時應以「能做什麼、適合什麼情境」為核心，避免只寫零件名稱的同義詞。範例：`"傳送 Gmail 電子郵件，適合 Workflow 完成時通知使用者、訂閱確認信、錯誤警報等場景。需要 Gmail OAuth token。"` 而非 `"Gmail 發信零件"`。
|
||||
2. THE Component_Contract SHALL 在 `constraints` 中包含以下欄位：`max_size_kb`（上限 2048）、`max_cold_start_ms`（上限 50）、`no_network_syscall`（布林值）、`io_model`（值為 `"stdin_stdout_json"`）。
|
||||
3. WHEN 一個零件的 `id` 已存在於 Component_Registry，THE Component_Registry SHALL 允許以新 `version` 值新增該零件的新實作，而不覆蓋舊版本。
|
||||
4. THE Component_Contract SHALL 在 `gherkin_tests` 中至少包含一個正常情境（happy path）與一個錯誤情境（error path）的測試案例。
|
||||
5. IF 一個零件的 `input_schema` 或 `output_schema` 涉及序列化或反序列化操作，THEN THE Component_Contract SHALL 包含一個 round-trip 測試案例，驗證 `parse(format(x)) == x`。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 2：零件沙盒驗收流程
|
||||
|
||||
**User Story:** As a 零件提交者（AI 或開發者）, I want 提交的零件自動通過沙盒驗收, so that 只有符合品質標準的零件才能進入零件宇宙。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. WHEN 一個零件被提交至 Component_Registry，THE Component_Registry SHALL 依序執行以下驗收步驟：（a）體積檢查（`.wasm` 小於 `max_size_kb`）、（b）冷啟動時間測量（小於 `max_cold_start_ms`）、（c）syscall 掃描（不含網路或檔案系統 syscall）、（d）Gherkin 測試執行（所有 scenario 100% 通過）、（e）多 runtime 相容測試（`runtime_compat` 列出的所有 runtime）。
|
||||
2. IF 任一驗收步驟失敗，THEN THE Component_Registry SHALL 拒絕該零件上架，並回傳包含失敗步驟名稱與具體原因的錯誤訊息。
|
||||
3. WHEN 所有驗收步驟通過，THE Component_Registry SHALL 將零件合約存入 KBDB 的 `tpl-component` Template Block，並記錄上架時間戳記。
|
||||
4. THE Component_Registry SHALL 以冪等方式執行驗收流程，對相同 `id` 與 `version` 的重複提交回傳相同結果而不重複執行測試。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 3：現有 HTTP 零件遷移至 WASM
|
||||
|
||||
**User Story:** As a 平台開發者, I want 將現有 20 個 HTTP endpoint 零件遷移為 WASI preview1 `.wasm` 格式, so that 零件能在 Tier 3 邊緣載具（無 V8、無網路）上執行，消除技術債。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Component_Dispatcher SHALL 支援以 WASM 模式呼叫零件：讀取 `.wasm` 二進位、透過 WASI preview1 runtime 執行、將 input JSON 寫入 stdin、從 stdout 讀取 output JSON。
|
||||
2. WHEN 一個 WASM 零件需要呼叫外部 HTTP API（如 Google Sheets），THE Component_Dispatcher SHALL 透過 host function 注入方式提供網路能力，而非允許 `.wasm` 內部直接發出網路 syscall。
|
||||
3. THE Component_Dispatcher SHALL 在 Tier 1（Cloudflare Workers）環境中，以 `workerd` 內建的 WASM 執行能力執行 WASI preview1 零件。
|
||||
4. WHEN 一個零件的 `runtime_compat` 不包含當前執行環境的 Tier，THE Component_Dispatcher SHALL 回傳錯誤，說明該零件不相容於當前 Tier，而非嘗試執行。
|
||||
5. THE Component_Dispatcher SHALL 在遷移期間同時支援舊有 HTTP endpoint 模式（Service Binding 或外部 URL）與新 WASM 模式，以 Component_Contract 的 `io_model` 欄位區分呼叫路徑。
|
||||
6. FOR ALL 現有 20 個內建零件，遷移後的 WASM 版本 SHALL 通過與原 HTTP 版本相同的 Gherkin 測試案例（round-trip 等效性）。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 4：零件版本控制與穩定性標籤
|
||||
|
||||
**User Story:** As a Workflow 設計者, I want 在 Cypher 三元組中指定零件的穩定性需求, so that 關鍵業務流程不會因 AI 自動升級零件而中斷。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Cypher_Executor SHALL 支援以下三種零件引用語法：`component://id`（預設 floating）、`component://id@stable`、`component://id@pinned:vN`。
|
||||
2. WHEN 一個 Workflow 引用 `component://id`（floating），THE Component_Dispatcher SHALL 從 Component_Registry 選取該 `id` 下「成功率 × 速度 × 被調用次數」評分最高的版本執行。
|
||||
3. WHEN 一個 Workflow 引用 `component://id@stable`，THE Component_Dispatcher SHALL 使用當前標記為 stable 的版本，並在有更優版本時記錄提示至 KBDB，但不自動切換。
|
||||
4. WHEN 一個 Workflow 引用 `component://id@pinned:vN`，THE Component_Dispatcher SHALL 永遠使用版本 `vN`，即使該版本已被標記為 Deprecated。
|
||||
5. THE Component_Registry SHALL 保留所有歷史版本的 `.wasm` 二進位，不因版本淘汰而刪除檔案。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 5：Cypher 語意關係擴展
|
||||
|
||||
**User Story:** As a Workflow 設計者, I want Cypher 三元組支援完整的語意關係集合, so that 能描述條件分支、子流程呼叫、前端觸發等複雜業務邏輯。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Cypher_Executor SHALL 解析並執行以下語意關係：`IS_A`（節點類型宣告）、`ON_SUCCESS`（成功後繼）、`ON_FAIL`（失敗後繼）、`ON_CLICK`（前端點擊觸發）、`CALLS_SUBFLOW`（呼叫子 Workflow）、`CONTAINS`（容器包含關係）、`HAS_STYLE`（樣式關聯）、`HAS_BEHAVIOR`（行為關聯）。
|
||||
2. WHEN 解析 `IS_A` 關係，THE Cypher_Executor SHALL 從 Component_Registry 載入對應的零件合約，並以合約的 `input_schema` 驗證節點的輸入 context。
|
||||
3. WHEN 解析 `ON_SUCCESS` 或 `ON_FAIL` 關係，THE Cypher_Executor SHALL 根據上游節點的執行結果（成功或拋出錯誤）決定走向，而非依賴 context 中的特定欄位。
|
||||
4. WHEN 解析 `CALLS_SUBFLOW` 關係，THE Cypher_Executor SHALL 以當前 context 作為子 Workflow 的 initialContext 執行，並將子 Workflow 的輸出合併回主流程 context。
|
||||
5. WHEN 解析 `ON_CLICK` 關係，THE Cypher_Executor SHALL 接受來自前端 Smart_Container 打包的 payload，並以該 payload 作為 Workflow 的 initialContext。
|
||||
6. THE Cypher_Executor SHALL 支援 URI 協議前綴：`component://`（零件引用）、`workflow://`（Workflow 引用）、`ui://`（前端零件引用）、`style://`（樣式零件引用）。
|
||||
7. FOR ALL 合法的 Cypher 三元組序列，THE Cypher_Executor SHALL 保證解析結果的冪等性：對相同輸入三元組集合，無論排列順序，產生語意等效的執行圖（Confluence 屬性）。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 6：Component Dispatcher 多 Tier 路由
|
||||
|
||||
**User Story:** As a 平台架構師, I want Cypher Executor 透過統一的 Component Dispatcher 介面呼叫跨 Tier 零件, so that Workflow 設計者不需要知道零件部署在哪個 Tier。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Component_Dispatcher SHALL 根據以下優先序決定呼叫路徑：（1）Tier 1：Cloudflare Service Binding（若零件部署為 Worker）或 WASM 直接執行；（2）Tier 2：workerd 叢集 HTTP endpoint；（3）Tier 3：Wazero IPC（stdin/stdout）。
|
||||
2. WHEN Component_Dispatcher 在 Tier 1 環境中呼叫一個 `runtime_compat` 包含 `cf-workers` 的零件，THE Component_Dispatcher SHALL 優先使用 Cloudflare Service Binding，若 binding 不存在則退回 WASM 執行模式。
|
||||
3. WHEN Component_Dispatcher 在 Tier 3 環境中呼叫零件，THE Component_Dispatcher SHALL 只使用 Wazero 執行本地 `.wasm` 檔案，不發出任何網路請求。
|
||||
4. IF Component_Dispatcher 無法在當前 Tier 找到可用的呼叫路徑，THEN THE Component_Dispatcher SHALL 回傳結構化錯誤，包含：零件 id、當前 Tier、嘗試的呼叫路徑清單。
|
||||
5. THE Component_Dispatcher SHALL 對每次零件呼叫記錄執行時間（ms）、成功或失敗狀態，並非同步寫入 KBDB 的 Evaluation Block，不阻擋主流程。
|
||||
6. WHILE Component_Dispatcher 執行零件呼叫，THE Component_Dispatcher SHALL 強制套用 Component_Contract 中的 `max_cold_start_ms` 作為逾時上限，超時後回傳逾時錯誤。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 7：Tier 3 邊緣離線生存能力
|
||||
|
||||
**User Story:** As a 邊緣載具操作者（無人機、AGV）, I want 載具在完全離線環境中仍能執行預載的 Workflow, so that 業務不因網路中斷而停擺。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Tier_3 執行引擎 SHALL 在無網路連線的環境中，使用本地 SQLite 作為 KBDB 替代儲存，執行預先下載的 Cypher Workflow 與 `.wasm` 零件。
|
||||
2. WHEN Tier_3 執行引擎在執行中發現缺少所需零件，THE Tier_3 執行引擎 SHALL 記錄缺失零件的 `id` 與 `input_schema` 至本地 DTN 佇列，待下次連網時以 Burst 傳輸方式送至 Tier_2 請求代工。
|
||||
3. WHEN Tier_3 執行引擎收到來自 Tier_2 的新 `.wasm` 零件，THE Tier_3 執行引擎 SHALL 在執行前對該零件進行 syscall 掃描，確認不含網路或檔案系統 syscall，通過後才載入執行。
|
||||
4. THE Tier_3 執行引擎 SHALL 在 Cypher 圖譜執行中途動態替換失敗零件（如感測器零件因環境變化失效），以 Component_Registry 中相同 `input_schema` 的備用零件繼續執行，不中斷整體 Workflow。
|
||||
5. WHEN Tier_3 執行引擎重新連線至 Tier_2，THE Tier_3 執行引擎 SHALL 將本地執行日誌（包含 trace、評價結果、Pitfall 記錄）同步至 Tier_2 的 KBDB，確保全局狀態一致。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 8：前端 Web Components 零件庫
|
||||
|
||||
**User Story:** As a 前端開發者, I want 一套以 Web Components 標準實作的 u6u UI 零件庫, so that 畫布上的 UI 元件能在任何現代瀏覽器中獨立運作，不依賴特定前端框架。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Canvas SHALL 提供以下核心 Web Components：`<u6u-btn>`（按鈕）、`<u6u-text-input>`（文字輸入）、`<u6u-text-field>`（多行文字）、`<u6u-chart>`（圖表）、`<u6u-card>`（智慧容器）。
|
||||
2. THE `<u6u-btn>` SHALL 支援以下 HTML attributes：`label`（顯示文字）、`color`（主題色）、`tooltip`（滑鼠懸停提示，純靜態，不觸發 Webhook）、`workflow`（綁定的 Workflow URI，格式為 `workflow://id`）。
|
||||
3. WHEN `<u6u-btn>` 的 `workflow` attribute 被設定且使用者點擊按鈕，THE `<u6u-btn>` SHALL 發出 `u6u:trigger` 自訂事件，事件 detail 包含 `{ workflowId, payload }`。
|
||||
4. THE `<u6u-card>` SHALL 在接收到子元件的 `u6u:trigger` 事件時，自動收集同容器內所有 `<u6u-text-input>` 與 `<u6u-text-field>` 的當前值，合併至事件的 `payload` 後再向上冒泡。
|
||||
5. FOR ALL Web Components，THE Canvas SHALL 保證元件的 HTML attribute 變更能即時反映至視覺渲染，且渲染結果與 attribute 值之間的對應關係具有冪等性（相同 attribute 值永遠產生相同渲染結果）。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 9：雙面翻轉畫布介面
|
||||
|
||||
**User Story:** As a 業務使用者（非工程師）, I want 畫布上每個 UI 元件都能翻面查看並編輯其 Cypher 邏輯連線, so that 不需要寫程式就能理解並修改業務邏輯。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Canvas SHALL 為每個 UI 零件提供「翻面」操作，切換至邏輯視圖後，顯示該零件關聯的 Cypher 三元組（以視覺化節點連線方式呈現）。
|
||||
2. WHEN 使用者在邏輯視圖中修改 Cypher 連線（新增、刪除或修改三元組），THE Canvas SHALL 即時更新對應 Workflow 的 KBDB Block，並在正面 UI 視圖中反映連線狀態變更（如按鈕顏色或 badge 提示）。
|
||||
3. THE Canvas SHALL 在邏輯視圖中提供 Workflow URI 選擇器，列出 KBDB 中所有可用的 Workflow，讓使用者透過下拉選單完成 `ON_CLICK >> workflow://id` 的綁定，不需手動輸入 URI。
|
||||
4. WHEN 使用者在畫布上將兩個 UI 零件拖入同一個 `<u6u-card>` 容器，THE Canvas SHALL 自動在邏輯視圖中顯示 Smart_Container 的自動打包關係，說明哪些輸入值會被自動收集。
|
||||
5. THE Canvas SHALL 在使用者嘗試替換一個已綁定 Workflow 的 UI 零件時，只顯示 Component_Registry 中具備相同觸發能力（即 `u6u:trigger` 事件）的候選零件，過濾掉不相容的零件。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 10：自動演化評價迴圈
|
||||
|
||||
**User Story:** As a 平台維運者, I want 每次 Workflow 執行後自動觸發 AI 評價, so that 系統能持續識別問題零件並累積避坑知識。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. WHEN 一個 Workflow 執行完畢（無論成功或失敗），THE Evaluator_Agent SHALL 在執行結束後非同步評估以下維度：執行狀態（成功 / 失敗 / 逾時）、各節點執行時間、零件錯誤率趨勢。
|
||||
2. WHEN Evaluator_Agent 發現某零件的錯誤率在連續 5 次執行中超過 50%，THE Evaluator_Agent SHALL 在 KBDB 中為該零件建立 Pitfall_Block，記錄：零件 id、失敗模式描述、首次發現時間戳記。
|
||||
3. WHEN Component_Dispatcher 在 Component_Registry 搜尋零件時，THE Component_Dispatcher SHALL 讀取目標零件的所有關聯 Pitfall_Block，並在選擇版本時降低有 Pitfall 記錄的版本的評分權重。
|
||||
4. WHEN 一個零件連續 30 天無任何 Workflow 引用，THE Component_Registry SHALL 將該零件標記為 `Deprecated`，並從預設搜尋結果中移除，但保留 `.wasm` 二進位與合約。
|
||||
5. WHEN 一個 `Deprecated` 零件再經過 90 天仍無引用，THE Component_Registry SHALL 將該零件移入墓地（tombstone 狀態），從所有搜尋結果中移除，但 `pinned` 版本的 `.wasm` 永遠保留且可被 Component_Dispatcher 存取。
|
||||
6. THE Evaluator_Agent SHALL 以冪等方式處理重複的執行日誌，對相同 `run_id` 的重複評價請求回傳相同結果而不重複建立 Pitfall_Block。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 11：零件開發指引（Component Authoring Guide）
|
||||
|
||||
**User Story:** As a 零件開發者（使用自己的 AI 工具，如 Claude、GPT、本地模型）, I want 平台提供完整的零件開發指引, so that 我的 AI 能根據指引生成符合合約規格的 `.wasm` 零件，並一次通過沙盒驗收。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Component_Registry SHALL 在 `GET /components/guide` 端點提供機器可讀的開發指引文件（Markdown 格式），內容包含：零件合約 YAML 完整範例、I/O 模型說明（stdin/stdout JSON）、各語言（TinyGo、Rust、AssemblyScript）的最小可運行範例程式碼、本地測試指令（`wasmtime` 執行方式）、常見錯誤與解法。
|
||||
2. THE Component_Registry SHALL 在開發指引中明確列出所有禁止行為：網路 syscall、檔案系統 syscall、打包 runtime（QuickJS、Node.js 等）、超過 2MB、混合前後端邏輯於同一零件。
|
||||
3. THE Component_Registry SHALL 在開發指引中提供 `component.contract.yaml` 的 JSON Schema 定義，讓開發者的 AI 能在提交前自行驗證合約格式正確性。
|
||||
4. WHEN 一個零件提交驗收失敗，THE Component_Registry SHALL 在錯誤回應中附上指向開發指引對應章節的錨點連結（如 `#syscall-constraints`），讓開發者的 AI 能直接定位修復方向。
|
||||
5. THE Component_Registry SHALL 提供 `POST /components/validate-contract` 端點，接受 `component.contract.yaml` 內容，回傳格式驗證結果（欄位完整性、schema 合法性、gherkin_tests 最低數量），讓開發者在提交 `.wasm` 前先驗證合約。
|
||||
6. FOR ALL 開發指引中的程式碼範例，THE Component_Registry SHALL 保證範例能通過 Requirement 2 定義的沙盒驗收流程（指引本身是可執行的 ground truth）。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 12：KBDB Component Registry 整合
|
||||
|
||||
**User Story:** As a 系統開發者, I want Component Registry 完全以 KBDB 的 Template/Block/Slot 機制實作, so that 零件狀態與平台其他知識共享同一個持久化層，不引入新的資料庫。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Component_Registry SHALL 以 KBDB 的 `tpl-component` Template 儲存零件合約，每個零件版本對應一個 Block，Block 的 slots 對應合約的各欄位（id、version、wasi_target、stability、runtime_compat、constraints 等）。
|
||||
2. THE Component_Registry SHALL 以 KBDB 的 Vectorize 索引零件的 `description` 與 `tags` 欄位，支援語意搜尋（如「查詢 Google Sheets 資料」能找到 `gsheets_get_entries`）。
|
||||
3. WHEN Component_Dispatcher 搜尋零件時，THE Component_Registry SHALL 回傳按「成功率 × 速度評分 × 被調用次數」排序的版本清單，最多回傳 10 個候選版本。
|
||||
4. THE Component_Registry SHALL 透過 KBDB 的 HTTP API 存取所有資料，不直接操作 D1 SQL，符合平台的 API-First 通訊鐵律。
|
||||
5. FOR ALL Component_Registry 的讀取操作，THE Component_Registry SHALL 保證在 KBDB 資料不變的情況下，對相同查詢參數回傳相同結果（查詢冪等性）。
|
||||
@@ -0,0 +1,411 @@
|
||||
# Implementation Plan: u6u Platform Evolution
|
||||
|
||||
## Overview
|
||||
|
||||
依照 Bootstrap 順序分四個 Phase 實作，每個 Phase 都是下一個 Phase 的基礎。
|
||||
技術棧：TypeScript、Hono、Zod、Vitest、fast-check，部署於 Cloudflare Workers。
|
||||
|
||||
---
|
||||
|
||||
## Phase 0：最小 WASM 執行核心
|
||||
|
||||
- [x] 1. 建立 Component Registry 基礎架構（`u6u-core/registry/`）
|
||||
- [x] 1.1 建立 `tpl-component` Template Block（透過 KBDB HTTP API）
|
||||
- 呼叫 KBDB `/templates` 建立 `tpl-component` template（若不存在）
|
||||
- 定義所有 slot keys（canonical_id、display_name、category、version、wasi_target、stability、runtime_compat、constraints、input_schema、output_schema、gherkin_tests、wasm_r2_key、cypher_binding_url、service_binding_key、description、tags、success_rate、avg_duration_ms、call_count、status、deprecated_at）
|
||||
- _Requirements: 12.1_
|
||||
|
||||
- [x] 1.2 實作 `POST /components/validate-contract` 端點
|
||||
- 以 Zod schema 驗證 component.contract.yaml 所有必填欄位
|
||||
- 回傳缺失欄位清單（`missing_fields: string[]`）
|
||||
- _Requirements: 1.1, 1.2, 11.5_
|
||||
|
||||
- [ ]* 1.3 寫 property test for 合約格式完整性
|
||||
- **Property 1: 合約格式完整性**
|
||||
- **Validates: Requirements 1.1, 1.2, 1.4**
|
||||
- 用 fast-check 生成隨機缺少任意必填欄位的合約物件，驗證 validator 必定拒絕並回傳該欄位名稱
|
||||
- 用 fast-check 生成包含所有必填欄位的合約物件，驗證 validator 必定通過
|
||||
|
||||
- [x] 1.4 實作 `GET /components/guide` 端點
|
||||
- 回傳 Markdown 格式開發指引（TinyGo 白名單、禁止行為、contract YAML 範例、wasmtime 測試指令）
|
||||
- _Requirements: 11.1, 11.2, 11.3_
|
||||
|
||||
- [x] 1.5 實作 `POST /components` 零件提交端點（沙盒驗收流程）
|
||||
- 依序執行五個驗收步驟：(a) 體積檢查、(b) 冷啟動時間測量、(c) syscall 掃描、(d) Gherkin 測試執行、(e) runtime 相容測試
|
||||
- 任一步驟失敗立即停止，回傳 `{ success: false, failed_step, reason, guide_anchor, component_id, version }`
|
||||
- 通過後以 KBDB HTTP API 寫入 Block（`block_id = comp-{id}-{version}`）
|
||||
- 同時上傳 `.wasm` 至 R2，slot `wasm_r2_key` 記錄 R2 key
|
||||
- _Requirements: 2.1, 2.2, 2.3_
|
||||
|
||||
- [ ]* 1.6 寫 property test for 沙盒驗收流程正確性
|
||||
- **Property 2: 沙盒驗收流程正確性**
|
||||
- **Validates: Requirements 2.1, 2.2**
|
||||
- 用 fast-check 生成在步驟 N 失敗的零件，驗證回應包含步驟 N 名稱與原因，且不執行步驟 N+1
|
||||
|
||||
- [ ]* 1.7 寫 property test for 零件提交冪等性與持久性
|
||||
- **Property 3: 零件提交冪等性與持久性**
|
||||
- **Validates: Requirements 2.3, 2.4**
|
||||
- 用 fast-check 生成通過驗收的零件，提交後讀取合約驗證所有欄位 round-trip 一致
|
||||
- 對相同 (id, version) 重複提交 N 次，驗證 KBDB 只存在一個 Block
|
||||
|
||||
- [x] 2. 實作 WASI preview1 shim 與 WASM 執行核心（`cypher-executor/src/lib/`）
|
||||
- [x] 2.1 實作輕量 WASI preview1 shim（`wasi-shim.ts`）
|
||||
- 實作 `fd_read`（從 stdin buffer 讀取）、`fd_write`（寫入 stdout/stderr buffer）、`proc_exit`（拋出 Error）、`random_get`（`crypto.getRandomValues`）
|
||||
- 其餘 syscall 一律回傳 ENOSYS（76）
|
||||
- 不引入任何外部依賴（不使用 `@cloudflare/workers-wasi`）
|
||||
- _Requirements: 3.1, 3.3_
|
||||
|
||||
- [x]* 2.2 寫單元測試 for WASI shim
|
||||
- 測試 `fd_read` 正確讀取 stdin buffer（含多次讀取、邊界條件）
|
||||
- 測試 `fd_write` 正確寫入 stdout buffer（fd=1）與 stderr buffer（fd=2）
|
||||
- 測試 `proc_exit` 拋出 Error
|
||||
|
||||
- [x] 2.3 實作 Tier 1 WASM 執行器（`wasm-executor.ts`）
|
||||
- 從 R2 fetch `.wasm` ArrayBuffer
|
||||
- `WebAssembly.compile` 後快取 `WebAssembly.Module`（Worker 記憶體，跨請求共享）
|
||||
- 建立 WASI shim，注入 stdin = `JSON.stringify(input)`
|
||||
- `WebAssembly.instantiate(module, imports)` → 呼叫 `_start()` 或 `main()`
|
||||
- 從 stdout buffer 讀取輸出，`JSON.parse` 後回傳
|
||||
- 套用 `max_cold_start_ms` 逾時（`Promise.race`）
|
||||
- _Requirements: 3.1, 3.3, 6.6_
|
||||
|
||||
- [ ]* 2.4 寫 property test for Component Dispatcher 路由正確性
|
||||
- **Property 4: Component Dispatcher 路由正確性**
|
||||
- **Validates: Requirements 3.1, 3.5, 3.6**
|
||||
- 用 fast-check 生成合法 JSON input，驗證 WASM 執行路徑輸出與預期語意等效
|
||||
|
||||
- [x] 3. 建立 `validate_json.wasm` 第一個真實零件（TinyGo）
|
||||
- [x] 3.1 撰寫 `validate_json` TinyGo 原始碼（`u6u-core/registry/components/validate_json/main.go`）
|
||||
- 只使用白名單 import：`os`、`io`、`encoding/json`
|
||||
- 讀取 stdin JSON，解析 `json_string` 欄位，嘗試 `json.Unmarshal`
|
||||
- 成功輸出 `{"valid":true}`，失敗輸出 `{"valid":false,"error":"..."}`
|
||||
- _Requirements: 3.1, 11.6_
|
||||
|
||||
- [x] 3.2 撰寫 `validate_json` component.contract.yaml
|
||||
- 包含所有必填欄位、gherkin_tests（happy path + error path）
|
||||
- `runtime_compat: ["cf-workers","workerd","wazero"]`
|
||||
- _Requirements: 1.1, 1.2, 1.4_
|
||||
|
||||
- [ ]* 3.3 寫單元測試 for validate_json（Gherkin 場景驗證）
|
||||
- 測試合法 JSON 輸入回傳 `{"valid":true}`
|
||||
- 測試非法 JSON 輸入回傳 `{"valid":false,"error":...}`
|
||||
|
||||
- [x] 4. Checkpoint — Phase 0 驗收
|
||||
- 確認 `validate_json.wasm` 能在 CF Workers 環境中透過 WASM 執行器執行
|
||||
- 確認 Component Registry `/guide`、`/validate-contract`、`/components` 端點可用
|
||||
- 確認所有 Phase 0 測試通過，向使用者確認是否繼續 Phase 1
|
||||
|
||||
---
|
||||
|
||||
## Phase 1：遷移現有零件（20 個 HTTP → WASM）
|
||||
|
||||
- [x] 5. 升級 Component Dispatcher 支援雙模式（`cypher-executor/src/lib/component-loader.ts`）
|
||||
- [x] 5.1 重構 `ComponentDescriptor` 型別（移除舊 `http_endpoint`，新增 `component_type`）
|
||||
- 定義 `ComponentType = 'wasm' | 'cypher_binding' | 'service_binding'`
|
||||
- 新版 `ComponentDescriptor` 欄位：`component_type`、`wasm_r2_key`、`runtime_compat`、`max_cold_start_ms`、`url`（cypher_binding）、`method`、`binding`（service_binding）、`path`
|
||||
- _Requirements: 3.5_
|
||||
|
||||
- [x] 5.2 實作路由決策邏輯（`component-dispatcher.ts`）
|
||||
- 查 Component Registry 取得合約
|
||||
- 依 `component_type` 分流：`wasm` → WASM 執行器；`cypher_binding` → HTTP POST 到外部 URL；`service_binding` → CF Service Binding
|
||||
- 檢查 `runtime_compat` 是否包含當前 Tier，不包含則回傳 `RUNTIME_INCOMPATIBLE` 錯誤
|
||||
- _Requirements: 3.4, 6.1, 6.2_
|
||||
|
||||
- [ ]* 5.3 寫 property test for Dispatcher 錯誤結構完整性
|
||||
- **Property 5: Dispatcher 錯誤結構完整性**
|
||||
- **Validates: Requirements 3.4, 6.4**
|
||||
- 用 fast-check 生成 (component_id, tier) 組合，當 runtime_compat 不含當前 tier，驗證錯誤回應同時包含 component_id、tier、attempted_paths 三個欄位
|
||||
|
||||
- [x] 6. 遷移 20 個內建零件（`u6u-core/builtins/` → `u6u-core/registry/components/`）
|
||||
- [x] 6.1 為每個零件撰寫 TinyGo 原始碼與 component.contract.yaml（批次作業）
|
||||
- 每個零件：只用白名單 import、stdin/stdout JSON I/O、附帶 gherkin_tests
|
||||
- 需要外部 API 的零件（如 gsheets）：改用 `cypher_binding` 模式，contract 中記錄 `cypher_binding_url`
|
||||
- _Requirements: 3.6, 11.6_
|
||||
|
||||
- [x] 6.2 透過 `POST /components` 批次提交 20 個零件至 Component Registry
|
||||
- 每個零件通過沙盒驗收後自動寫入 KBDB
|
||||
- 驗證 20 個零件的 Gherkin 測試全部通過
|
||||
- _Requirements: 2.1, 3.6_
|
||||
|
||||
- [ ]* 6.3 寫 property test for 歷史版本永久保留不變量
|
||||
- **Property 8: 歷史版本永久保留不變量**
|
||||
- **Validates: Requirements 4.5, 10.5**
|
||||
- 用 fast-check 生成已上架零件，標記為 deprecated 後，驗證 `.wasm` 仍可從 R2 讀取，pinned 引用仍可執行
|
||||
|
||||
- [x] 7. 實作 Component Registry 查詢端點
|
||||
- [x] 7.1 實作 `GET /components/:id` 與 `GET /components/:id/versions`
|
||||
- 透過 KBDB HTTP API 查詢 `tpl-component` blocks
|
||||
- `/versions` 回傳按「成功率 × 速度評分 × 被調用次數」排序的版本清單（最多 10 個）
|
||||
- _Requirements: 12.3_
|
||||
|
||||
- [x] 7.2 實作 `GET /components/search?q=...` 語意搜尋
|
||||
- 呼叫 KBDB Vectorize API，以 `description` + `tags` 欄位做語意搜尋
|
||||
- _Requirements: 12.2_
|
||||
|
||||
- [ ]* 7.3 寫單元測試 for 查詢冪等性
|
||||
- 驗證相同查詢參數在 KBDB 資料不變時回傳相同結果
|
||||
|
||||
- [x] 8. Checkpoint — Phase 1 驗收
|
||||
- 確認 20 個零件全部通過沙盒驗收並存入 KBDB
|
||||
- 確認 Component Dispatcher 雙模式路由正確（WASM + cypher_binding）
|
||||
- 確認所有 Phase 1 測試通過，向使用者確認是否繼續 Phase 2
|
||||
|
||||
---
|
||||
|
||||
## Phase 2：Cypher 語意擴展 + Multi-Tier Dispatcher
|
||||
|
||||
- [x] 9. 擴展 Cypher Triplet Parser（`cypher-executor/src/actions/triplet-parser.ts`）
|
||||
- [x] 9.1 新增 EdgeType 定義
|
||||
- 在現有 `PIPE | IF | FOREACH | CONTINUE` 基礎上新增：`IS_A | ON_SUCCESS | ON_FAIL | ON_CLICK | CALLS_SUBFLOW | CONTAINS | HAS_STYLE | HAS_BEHAVIOR`
|
||||
- _Requirements: 5.1_
|
||||
|
||||
- [x] 9.2 實作 URI 協議解析函數（`resolveComponentId`）
|
||||
- 解析 `component://id`、`component://id@stable`、`component://id@pinned:vN`、`workflow://id`、`ui://id`、`style://id`
|
||||
- 回傳 `{ type, canonicalId, stability, pinnedVersion? }`
|
||||
- _Requirements: 4.1, 5.6_
|
||||
|
||||
- [ ]* 9.3 寫 property test for 零件 URI 解析 Round-Trip
|
||||
- **Property 6: 零件 URI 解析 Round-Trip**
|
||||
- **Validates: Requirements 4.1**
|
||||
- 用 fast-check 生成合法 URI 字串，解析後再序列化，驗證語意等效；驗證解析出的 id、stability、pinnedVersion 與原始 URI 完全一致
|
||||
|
||||
- [ ]* 9.4 寫 property test for Cypher 三元組解析 Confluence
|
||||
- **Property 9: Cypher 三元組解析 Confluence（順序無關性）**
|
||||
- **Validates: Requirements 5.7**
|
||||
- 用 fast-check 生成合法三元組集合，用 `fc.shuffledSubarray` 打亂順序，驗證 `parseTriplets` 產生相同節點集合與邊集合
|
||||
|
||||
- [x] 10. 擴展 GraphExecutor 執行語意（`cypher-executor/src/graph-executor.ts`）
|
||||
- [x] 10.1 實作 `IS_A` 關係處理
|
||||
- 從 Component Registry 載入零件合約，以 `input_schema` 驗證節點輸入 context
|
||||
- _Requirements: 5.2_
|
||||
|
||||
- [x] 10.2 實作 `ON_SUCCESS` / `ON_FAIL` 分支執行
|
||||
- 在 `executeNode` 的 try/catch 中，成功走 `ON_SUCCESS` 邊，失敗走 `ON_FAIL` 邊（傳遞 error context）
|
||||
- _Requirements: 5.3_
|
||||
|
||||
- [x] 10.3 實作 `CALLS_SUBFLOW` 子流程呼叫
|
||||
- 從 KBDB 載入子 Workflow 定義，建立子 GraphExecutor 執行，將輸出合併回主流程 context
|
||||
- _Requirements: 5.4_
|
||||
|
||||
- [x] 10.4 實作 `ON_CLICK` 前端觸發處理
|
||||
- 接受來自前端 Smart Container 打包的 payload，作為 Workflow initialContext
|
||||
- _Requirements: 5.5_
|
||||
|
||||
- [x] 10.5 實作 `CONTAINS` / `HAS_STYLE` / `HAS_BEHAVIOR` 結構語意解析（不執行，僅記錄圖結構）
|
||||
- _Requirements: 5.1_
|
||||
|
||||
- [x] 11. 實作版本選擇策略（Component Dispatcher 升級）
|
||||
- [x] 11.1 實作 floating 版本選擇算法
|
||||
- 從 KBDB 查詢該 id 下所有版本，計算「成功率 × 速度評分 × 被調用次數」，選取最高分版本
|
||||
- _Requirements: 4.2_
|
||||
|
||||
- [x] 11.2 實作 stable / pinned 版本選擇
|
||||
- `stable`：使用當前標記為 stable 的版本，有更優版本時記錄提示至 KBDB 但不切換
|
||||
- `pinned:vN`：永遠使用版本 vN，即使已 deprecated
|
||||
- _Requirements: 4.3, 4.4_
|
||||
|
||||
- [ ]* 11.3 寫 property test for 版本選擇策略正確性
|
||||
- **Property 7: 版本選擇策略正確性**
|
||||
- **Validates: Requirements 4.2, 4.4**
|
||||
- 用 fast-check 生成版本集合（各有不同 success_rate、avg_duration_ms、call_count），驗證 floating 選最高分；驗證 pinned:vN 無論其他版本評分如何永遠選 vN
|
||||
|
||||
- [x] 12. 實作 Evaluator Agent 與評價迴圈（`cypher-executor/src/actions/`）
|
||||
- [x] 12.1 實作 `execution-evaluator.ts`（擴展現有 `execution-logger.ts`）
|
||||
- Workflow 執行完畢後非同步寫入 KBDB Evaluation Block（`tpl-evaluation`）
|
||||
- 記錄：run_id、workflow_id、component_id、verdict、duration_ms、error_message、evaluated_at
|
||||
- 冪等處理：相同 run_id 不重複建立 Block
|
||||
- _Requirements: 10.1, 10.6_
|
||||
|
||||
- [x] 12.2 實作 Pitfall Block 建立邏輯
|
||||
- 偵測某零件連續 5 次執行錯誤率 > 50%，建立 `tpl-pitfall` Block
|
||||
- 版本選擇時降低有 Pitfall 記錄的版本評分權重
|
||||
- _Requirements: 10.2, 10.3_
|
||||
|
||||
- [x] 12.3 實作零件自動 Deprecated / Tombstone 狀態轉換
|
||||
- 連續 30 天無引用 → 標記 `deprecated`，從預設搜尋移除
|
||||
- 再 90 天無引用 → 標記 `tombstone`，從所有搜尋移除（pinned `.wasm` 永久保留）
|
||||
- _Requirements: 10.4, 10.5_
|
||||
|
||||
- [ ]* 12.4 寫 property test for 系統操作冪等性
|
||||
- **Property 11: 系統操作冪等性**
|
||||
- **Validates: Requirements 10.6, 12.5**
|
||||
- 用 fast-check 生成 run_id，對相同 run_id 呼叫 Evaluator N 次，驗證 KBDB 只存在一個 Evaluation Block
|
||||
- 驗證相同查詢參數在資料不變時回傳相同結果
|
||||
|
||||
- [x] 13. Checkpoint — Phase 2 驗收
|
||||
- 確認新 EdgeType 全部可解析執行（IS_A、ON_SUCCESS、ON_FAIL、CALLS_SUBFLOW、ON_CLICK）
|
||||
- 確認版本選擇策略（floating / stable / pinned）行為正確
|
||||
- 確認 Evaluator Agent 冪等寫入 KBDB
|
||||
- 確認所有 Phase 2 測試通過，向使用者確認是否繼續 Phase 3
|
||||
|
||||
---
|
||||
|
||||
## Phase 3：前端畫布（Web Components + 雙面翻轉）
|
||||
|
||||
- [x] 14. 建立 Web Components 零件庫（`u6u-core/web-components/`）
|
||||
- [x] 14.1 實作 `<u6u-btn>` Custom Element
|
||||
- 支援 attributes：`label`、`color`、`tooltip`、`workflow`、`disabled`
|
||||
- `workflow` 設定且點擊時發出 `u6u:trigger` CustomEvent（`{ workflowId, payload }`）
|
||||
- `workflow` 未設定時點擊不發出事件，console 輸出警告
|
||||
- _Requirements: 8.2, 8.3_
|
||||
|
||||
- [x] 14.2 實作 `<u6u-text-input>` 與 `<u6u-text-field>` Custom Elements
|
||||
- 支援 `name`、`placeholder`、`value` attributes
|
||||
- `value` property 可被 `<u6u-card>` 讀取
|
||||
- _Requirements: 8.1_
|
||||
|
||||
- [x] 14.3 實作 `<u6u-card>` Smart Container
|
||||
- 攔截子元件的 `u6u:trigger` 事件（`stopPropagation`）
|
||||
- 收集同容器內所有 `<u6u-text-input>` / `<u6u-text-field>` 的 name-value 對
|
||||
- 合併至 payload 後重新發出 `u6u:trigger`（`bubbles: true, composed: true`）
|
||||
- _Requirements: 8.4_
|
||||
|
||||
- [x] 14.4 實作 `<u6u-chart>` Custom Element（基礎版）
|
||||
- 支援 `data` attribute（JSON 字串）、基本折線圖渲染
|
||||
- _Requirements: 8.1_
|
||||
|
||||
- [ ]* 14.5 寫 property test for Web Components 事件與渲染冪等性
|
||||
- **Property 10: Web Components 事件與渲染冪等性**
|
||||
- **Validates: Requirements 8.3, 8.4, 8.5**
|
||||
- 用 fast-check 生成 workflow URI，驗證點擊後 `u6u:trigger` detail.workflowId 與 URI id 完全一致
|
||||
- 用 fast-check 生成具名 input 集合置於 u6u-card，驗證收集到的 payload 包含所有 name-value 對
|
||||
- 用 fast-check 生成 attribute 值，對同一元件設定相同值 N 次，驗證渲染結果冪等
|
||||
|
||||
- [x] 15. 建立雙面翻轉畫布（`inkstone-admin/frontend/web/`）
|
||||
- [x] 15.1 實作翻轉狀態機（`Canvas.tsx`）
|
||||
- 狀態：`UIView` ↔ `LogicView`（點擊翻面按鈕切換）
|
||||
- `LogicView` → `Editing`（修改三元組）→ `Saving`（確認儲存）→ `LogicView`
|
||||
- _Requirements: 9.1_
|
||||
|
||||
- [x] 15.2 實作邏輯視圖（Cypher 三元組視覺化）
|
||||
- 顯示零件關聯的 Cypher 三元組（節點連線方式）
|
||||
- 修改三元組後即時更新 KBDB Workflow Block（透過 KBDB HTTP API）
|
||||
- _Requirements: 9.2_
|
||||
|
||||
- [x] 15.3 實作 Workflow URI 選擇器
|
||||
- 列出 KBDB 中所有可用 Workflow，下拉選單完成 `ON_CLICK >> workflow://id` 綁定
|
||||
- _Requirements: 9.3_
|
||||
|
||||
- [x] 15.4 實作 Smart Container 拖放與自動打包關係顯示
|
||||
- 拖入同一 `<u6u-card>` 時，邏輯視圖自動顯示 CONTAINS 關係與自動打包說明
|
||||
- _Requirements: 9.4_
|
||||
|
||||
- [x] 15.5 實作零件替換過濾器
|
||||
- 替換已綁定 Workflow 的 UI 零件時，只顯示具備 `u6u:trigger` 能力的候選零件
|
||||
- _Requirements: 9.5_
|
||||
|
||||
- [x] 15.6 在畫布中整合 u6u Web Components（Dogfooding）
|
||||
- 畫布 UI 本身使用 `<u6u-btn>`、`<u6u-card>`、`<u6u-text-input>` 組裝
|
||||
- 驗證 Web Components 在 React 19 環境中正確運作
|
||||
- _Requirements: 8.1, 9.1_
|
||||
|
||||
- [ ]* 15.7 寫整合測試 for 畫布翻轉流程
|
||||
- 測試 UIView → LogicView → Editing → Saving → LogicView 完整狀態轉換
|
||||
- 測試 KBDB 寫入成功與失敗兩種情境
|
||||
|
||||
- [x] 16. Final Checkpoint — 全平台驗收
|
||||
- 確認四個 Phase 的所有測試通過（`pnpm test` in each service）
|
||||
- 確認 Dogfooding：畫布本身用 u6u Web Components 組裝，每一層都是下一層的第一個用戶
|
||||
- 確認 KBDB 不變量：仍只有三張表（blocks / templates / slots）
|
||||
- 確認 API-First 鐵律：所有跨服務通訊只透過 HTTP API
|
||||
- 向使用者確認所有任務完成
|
||||
|
||||
---
|
||||
|
||||
## Phase 4：邊緣基礎設施（Tier 3 支援）
|
||||
|
||||
> 這個 Phase 不在零件遷移範圍內，是獨立的基礎設施工作。
|
||||
|
||||
- [ ] 17. Credentials 邊緣支援評估與改寫（`u6u-core/credentials/`）
|
||||
- [ ] 17.1 評估 Tier 3 是否需要 Credentials
|
||||
- 場景：無人機在有網路時呼叫外部 API（如取得感測器資料），需要 access_token
|
||||
- 結論：Tier 3 需要在連網時從 Tier 2 取得 Credential，離線時使用本地快取的加密 token
|
||||
- _Requirements: 7.1, 7.2_
|
||||
|
||||
- [ ] 17.2 實作 Credential 本地快取機制（Tier 3 用）
|
||||
- Tier 3 Go 排程引擎在連網時從 Tier 2 Credentials Worker 取得加密 token
|
||||
- 存入本地 SQLite（AES-GCM 加密，key 存於設備安全儲存）
|
||||
- 離線時從本地快取讀取，過期時加入 DTN 佇列等待更新
|
||||
- _Requirements: 7.1, 7.3_
|
||||
|
||||
- [ ] 18. Go Cypher Executor（Tier 3 邊緣執行引擎）（`u6u-core/executor/`）
|
||||
- [ ] 18.1 用 Go 實作 Cypher 三元組解析器
|
||||
- 解析 `"A >> 關係 >> B"` 格式，建立執行圖（nodes + edges）
|
||||
- 支援 IS_A、ON_SUCCESS、ON_FAIL、CALLS_SUBFLOW、ON_CLICK 語意關係
|
||||
- 對應 `cypher-executor/src/actions/triplet-parser.ts` 的 Go 版本
|
||||
- _Requirements: 5.1, 5.7_
|
||||
|
||||
- [ ] 18.2 用 Go + Wazero 實作 WASM 零件執行器
|
||||
- 載入本地 `.wasm` 檔案，透過 Wazero 原生 WASI preview1 執行
|
||||
- 注入 `u6u` host module（`http_request` host function，透過 DTN 或直接 HTTP）
|
||||
- stdin/stdout JSON I/O，與 Tier 1/2 的 `wasm-executor.ts` 語意等效
|
||||
- _Requirements: 7.1, 7.4_
|
||||
|
||||
- [ ] 18.3 實作 DTN 佇列（離線請求緩衝）
|
||||
- 零件需要網路但當前離線時，寫入本地 SQLite DTN 佇列
|
||||
- 連網時 Burst 傳輸：批次送出佇列中的請求，接收回應後繼續執行
|
||||
- _Requirements: 7.2, 7.5_
|
||||
|
||||
- [ ]* 18.4 整合測試：validate_json.wasm 在 Wazero 執行
|
||||
- 確認同一個 `.wasm` 在 Tier 1（wasi-shim.ts）和 Tier 3（Wazero）執行結果一致
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- 標記 `*` 的子任務為選填，可跳過以加速 MVP 交付
|
||||
- 每個任務都引用具體的 Requirements 條款以確保可追溯性
|
||||
- Checkpoint 任務確保每個 Phase 完成後有明確的驗收點
|
||||
- Property tests 使用 fast-check，每個屬性最少執行 100 次迭代
|
||||
- 所有跨服務呼叫只透過 KBDB HTTP API，不直接操作 D1 SQL
|
||||
- TinyGo 零件只使用白名單 import（`os`、`io`、`encoding/json`）
|
||||
|
||||
## Phase 5：u6u-mcp 對齊新 Registry + u6u-gui 前端
|
||||
|
||||
> 壓測前必須完成，讓 AI（u6u-mcp）和人類（u6u-gui）都能操作新的 WASM 零件架構。
|
||||
|
||||
- [x] 19. 更新 u6u-mcp 對齊新 Component Registry（`u6u-mcp/src/tools/`）
|
||||
- [x] 19.1 更新 `u6u_publish_component`
|
||||
- 舊：呼叫 `/components/publish`，payload 為 `{ component_id, gherkin, api_config }`
|
||||
- 新：呼叫 `POST /components`，payload 為 `{ contract: ComponentContract, wasm_base64: string }`
|
||||
- 新增 `contract` 和 `wasm_base64` 參數，更新工具描述說明 TinyGo 零件提交流程
|
||||
|
||||
- [x] 19.2 更新 `u6u_search_components`
|
||||
- 舊：呼叫 `/components/match`（不存在的端點）
|
||||
- 新：呼叫 `GET /components/search?q={query}`（新 Registry 語意搜尋端點）
|
||||
- 更新工具描述：AI 可用自然語言搜尋零件（如「查詢 Google Sheets 資料」）
|
||||
|
||||
- [x] 19.3 更新 `u6u_get_component`
|
||||
- 舊：讀舊格式 slots（`component_id`、`name`、`published_at`）
|
||||
- 新：對齊 `tpl-component` slot 欄位（`canonical_id`、`display_name`、`category`、`version`、`stability`、`wasm_r2_key` 等）
|
||||
- 呼叫新 Registry `GET /components/:id` 端點
|
||||
|
||||
- [x] 19.4 新增 `u6u_get_component_guide` 工具
|
||||
- 呼叫 `GET /components/guide`，回傳開發指引給 AI
|
||||
- AI 在開發新零件前可先讀取指引，確保生成符合規範的 TinyGo 程式碼
|
||||
|
||||
- [x] 20. 建立 u6u-gui 前端（`u6u-gui/`）
|
||||
- [x] 20.1 建立 Cloudflare Pages 專案結構
|
||||
- React 19 + Vite + Tailwind CSS v4
|
||||
- 整合 `@u6u/web-components`（alias 指向 `u6u-core/web-components/src`）
|
||||
- wrangler.toml 設定 Pages 部署
|
||||
|
||||
- [x] 20.2 建立主畫布頁面（`/canvas`）
|
||||
- 整合 `Canvas.tsx`（從 inkstone-admin 移植）
|
||||
- 連接 Cypher Executor API（`POST /cypher/execute`）
|
||||
- 連接 Component Registry API（搜尋、查詢零件）
|
||||
- AI 操作後（透過 u6u-mcp 修改 KBDB）畫布即時反映變更
|
||||
|
||||
- [x] 20.3 建立零件庫頁面（`/components`）
|
||||
- 列出所有已上架零件（呼叫 `GET /components/search`）
|
||||
- 顯示零件合約、評分、版本歷史
|
||||
- 提供「提交新零件」入口（連結到開發指引）
|
||||
|
||||
- [x] 20.4 建立 Workflow 管理頁面（`/workflows`）
|
||||
- 列出所有 Workflow（從 KBDB 查詢 `tpl-workflow`）
|
||||
- 點擊進入畫布編輯
|
||||
- 顯示執行歷史（Evaluation Block）
|
||||
|
||||
- [x] 20.5 部署至 Cloudflare Pages
|
||||
- `pnpm build && npx wrangler pages deploy dist`
|
||||
- 設定環境變數（KBDB_URL、CYPHER_URL、REGISTRY_URL）
|
||||
@@ -0,0 +1,381 @@
|
||||
# arcrun — 進度與待辦
|
||||
|
||||
> 設計細節見 `arcrun/README.md`（產品說明）和 `arcrun/BETA_TEST.md`（封測指南）。
|
||||
> 這份文件只記錄：目前狀態、還差什麼、封測能不能啟動。
|
||||
|
||||
---
|
||||
|
||||
## 一、封測目標場景
|
||||
|
||||
封測者是工程師朋友，有自己的網頁，需要後端自動化。目標是他能在 AI 協助下，一次或很少次完成以下完整流程：
|
||||
|
||||
1. `acr init` 取得 api_key
|
||||
2. `acr parts scaffold` 查零件格式，AI 幫寫 workflow YAML
|
||||
3. 若內建零件不足，`acr recipe push` 增加打外部 API 的 recipe
|
||||
4. `acr creds push` 上傳 OAuth token（gmail / google_sheets 等）
|
||||
5. `acr push` 部署 workflow，取得 Webhook URL
|
||||
6. 網頁 POST /webhooks/named/{name}/trigger，結果存 Google Sheets
|
||||
|
||||
---
|
||||
|
||||
## 二、場景各步驟驗證狀態
|
||||
|
||||
### Step 1：acr init → api_key
|
||||
- [x] `acr init` Standard 模式完成，api_key 存入 `~/.arcrun/config.yaml`
|
||||
- [x] 已驗證：`mode: standard, api_key: ak_...` 正確
|
||||
|
||||
### Step 2：acr parts scaffold → AI 看到零件格式
|
||||
- [x] `acr parts` 列出 21 個零件，完全內建，不依賴 registry.arcrun.dev
|
||||
- [x] `acr parts scaffold google_sheets` 輸出 spreadsheet_id / range / operation / values 格式與 credentials.yaml 範本
|
||||
- [x] 已驗證：輸出可直接貼入 YAML
|
||||
|
||||
### Step 3：acr recipe push → 打外部 API
|
||||
- [x] `acr recipe push` 上傳成功，回傳 rec_hash
|
||||
- [x] workflow 使用 `component: rec_xxxxxxxx`，acr push 後 trigger 能正確呼叫外部 API
|
||||
- [x] 已驗證（2026-04-18）：httpbin_post recipe → trigger → httpbin.org/post 回傳正確 ✅
|
||||
|
||||
### Step 4：acr creds push → 自動注入 token
|
||||
- [x] `POST /credentials` API 完成，以 `{api_key}:cred:{name}` 存入 KV
|
||||
- [x] Webhook trigger 時 injectCredentials 從 KV 取得 token 自動注入
|
||||
- [x] `/register` 現在回傳 `encryption_key`，`acr init` 自動存入 config
|
||||
- [x] `acr creds push` 從 config 讀 encryption_key，不再需要手動設定環境變數
|
||||
- [x] 已驗證（2026-04-18）：beta@arcrun.dev 帳號完整流程：init → creds push → trigger → credential 注入成功 ✅
|
||||
|
||||
### Step 5：acr push → Webhook URL
|
||||
- [x] `acr push workflow.yaml` 部署成功，顯示 Webhook URL 和完整 curl 範例
|
||||
- [x] config 中的 `component` / 參數在 push 時套入 graph 節點
|
||||
- [x] 已驗證（2026-04-18）：sheet-test workflow push 成功 ✅
|
||||
|
||||
### Step 6：網頁 POST → 執行 → 結果到 Google Sheets
|
||||
- [x] `POST /webhooks/named/{name}/trigger -H 'X-Arcrun-API-Key: ...'` 觸發執行正常
|
||||
- [x] google_sheets 零件有實作（append row 到 Sheets API）
|
||||
- [x] 已驗證（2026-04-18）：trigger sheet-test → 報「缺少 credential」（符合預期，credential 未上傳）✅
|
||||
- [ ] **未驗證**：真實 google_oauth token + acr creds push → trigger → Google Sheets 實際寫入
|
||||
- 需要真實 OAuth token 才能完整驗證
|
||||
|
||||
---
|
||||
|
||||
## 三、封測啟動阻擋項
|
||||
|
||||
P0 全部清除才啟動封測。
|
||||
|
||||
| # | 項目 | 狀態 | 說明 |
|
||||
|---|------|------|------|
|
||||
| 1 | acr parts scaffold 正確輸出 | ✅ 完成 | 21 個零件內建清單 |
|
||||
| 2 | acr recipe push 端對端 | ✅ 完成 | httpbin_post 驗證通過 |
|
||||
| 3 | acr creds push 代碼 | ✅ 完成 | 需 ARCRUN_ENCRYPTION_KEY |
|
||||
| 4 | credential 注入端對端 | ✅ 完成 | 無 token 時錯誤訊息正確 |
|
||||
| 5 | acr push + webhook trigger | ✅ 完成 | 端對端驗證通過 |
|
||||
| 6 | acr creds push 實測 | ✅ 完成 | /register 回傳 encryption_key，acr init 自動存入 config（CLI 1.0.9）|
|
||||
| 7 | Google Sheets 真實寫入 | ⚠️ 部分驗證 | credential 注入已驗證；實際 Sheets 寫入需真實 OAuth token |
|
||||
| 8 | 第三方服務認證 recipe | ✅ 完成 | 20 個服務（Notion/Slack/GitHub/OpenAI 等），CLI 1.1.0 |
|
||||
| **9** | **cypher-executor outbound HTTP fetch 全失效** | ✅ **已解決 2026-05-13**（CF 同 zone 自循環死鎖，改走 workers.dev）| 詳見下方專段 |
|
||||
| **10** | **multi-node chain context propagation 漏失** | ✅ **已解決 2026-05-13**（ON_SUCCESS/ON_FAIL/IF/ON_CLICK 沒 spread baseCtx）| 詳見下方專段 |
|
||||
|
||||
**目前狀況**：P0 全部解決。
|
||||
- #9 修復方式：component worker URL 從 `*.arcrun.dev`（同 cypher zone）改走 `arcrun-{name}.{WORKER_SUBDOMAIN}.workers.dev`（避開同 zone 自循環）
|
||||
- #10 修復方式：4 個 edge type 補 `{...baseCtx, ...result}`，跟 PIPE/FOREACH 一致
|
||||
|
||||
兩個 P0 解完 mira 7 節點 workflow 端對端通（含真 Claude 16 秒呼叫）。
|
||||
|
||||
---
|
||||
|
||||
### ✅ P0 #9（2026-05-13 已解決）：cypher-executor outbound fetch 全失效
|
||||
|
||||
**完整事件報告（含誤判路徑）**：[docs/incidents/2026-05-13-cypher-outbound-522.md](../../../docs/incidents/2026-05-13-cypher-outbound-522.md)
|
||||
|
||||
**修復方式**：cypher-executor fetch component worker 從 `*.arcrun.dev`（同 zone）改走 `arcrun-{name}.{WORKER_SUBDOMAIN}.workers.dev`。對外 `cypher.arcrun.dev` 不變，用戶 0 感知。
|
||||
|
||||
**改動檔案**（2026-05-13）：
|
||||
- `cypher-executor/src/lib/component-loader.ts`：`wasmWorkerUrl(canonicalId, subdomain)` 簽名加 subdomain 參數 + URL pattern 改 workers.dev
|
||||
- `cypher-executor/src/actions/auth-dispatcher.ts`：同步新簽名
|
||||
- `cypher-executor/src/types.ts`：`Bindings` 加 `WORKER_SUBDOMAIN: string`
|
||||
- `cypher-executor/wrangler.toml`：`[vars]` 加 `WORKER_SUBDOMAIN = "uncle6-me"`
|
||||
- 5 個 component worker 在 dashboard 啟用 workers.dev URL（kbdb-get / kbdb-ingest / kbdb-create-block / kbdb-patch-block / claude-api，**未來新 component 也都要開**）
|
||||
|
||||
**驗證**：cypher-executor → kbdb-get / claude-api 從 522 → 200。mira `acr run wiki_synthesis` 5 節點 workflow 跑通前 3 節點（kbdb_get chain）。
|
||||
|
||||
**Self-hosted fork 注意**：必須改 `wrangler.toml [vars] WORKER_SUBDOMAIN` 為自己的 CF 帳號 subdomain，並把所有 component worker 在 dashboard 啟用 workers.dev URL。
|
||||
|
||||
---
|
||||
|
||||
### ✅ P0 #10（2026-05-13 已解決）：multi-node chain context propagation 漏失
|
||||
|
||||
**現象**：cypher binding workflow 從第 2 個節點開始，原始 input context（top-level `api_key` / `mira_token` 等）丟失，下游節點 `{{api_key}}` 模板原文未替換傳給零件 → 401 Unauthorized 或類似錯。
|
||||
|
||||
**測試重現**：
|
||||
|
||||
```yaml
|
||||
flow:
|
||||
- "input >> ON_SUCCESS >> n1"
|
||||
- "n1 >> ON_SUCCESS >> n2"
|
||||
config:
|
||||
n1: { component: kbdb_get, api_key: "{{api_key}}", block_id: "{{b1}}" }
|
||||
n2: { component: kbdb_get, api_key: "{{api_key}}", block_id: "{{b2}}" }
|
||||
context: { api_key: "ak_xxx", b1: "...", b2: "..." }
|
||||
```
|
||||
|
||||
n1 收到 ctx 含 `api_key / b1 / b2` ✓ → 跑通。
|
||||
n2 收到的 ctx 只有 `n1.output spread`（blocks/count/success/block_id），**`api_key / b1 / b2` 不見**，`{{api_key}}` 原文傳到零件回 401。
|
||||
|
||||
**根因**：`graph-executor.ts` 在 PIPE / FOREACH 邊類型已修「baseCtx ∪ result」，但 **ON_SUCCESS / ON_FAIL / IF / ON_CLICK 四個 edge type 沒套同模式**，直接把 `result` 當下游 ctx 傳，丟掉原始 context。
|
||||
|
||||
**修法**（`cypher-executor/src/graph-executor.ts` line 407 / 415 / 423 / 472）：
|
||||
|
||||
```typescript
|
||||
// 改前
|
||||
result = await this.executeNode(nextNode, graph, result, ...);
|
||||
|
||||
// 改後（同 PIPE/FOREACH 模式）
|
||||
const baseCtx = (typeof context === 'object' && context !== null) ? context as Record<string, unknown> : {};
|
||||
const baseResult = (typeof result === 'object' && result !== null) ? result as Record<string, unknown> : {};
|
||||
const mergedCtx = { ...baseCtx, ...baseResult };
|
||||
result = await this.executeNode(nextNode, graph, mergedCtx, ...);
|
||||
```
|
||||
|
||||
**驗證**：mira `acr run wiki_synthesis` 7 節點 workflow 端對端跑通（16 秒，含真 Claude 呼叫）。每個節點都拿到正確 `api_key` 不再 401。
|
||||
|
||||
**歷史脈絡**：類似問題 2026-05-07 commit e8fca33 在 FOREACH edge 已修一次（"FOREACH preserves outer context"），但當時沒同步處理另外 4 個 edge type。本次補完。
|
||||
|
||||
---
|
||||
|
||||
### ✅ P0 #10 補完三個衍生問題（2026-05-13 晚 ~ 2026-05-14）
|
||||
|
||||
P0 #10 修完後 mira 嘗試做 wiki 多段結構，又踩出三個 cypher binding 設計缺陷。**都是同一天解掉**。
|
||||
|
||||
#### A. interpolateData() 不遞迴 nested object
|
||||
|
||||
**現象**：`set` / `kbdb_create_block` 的 `values: { text: "{{classify.data.text}}" }`、`tags_json: ["facet:{{paragraph.facet}}"]` 等 nested config 內的 `{{x}}` 不被替換，原文傳給零件。
|
||||
|
||||
**根因**：`interpolateData()` 只 iterate top-level，對非 string 值（object / array）直接 pass-through 不下沉。
|
||||
|
||||
**修法**：拆 `interpolateString` + `interpolateValue`（遞迴 object / array），`interpolateData` 改 call `interpolateValue`。
|
||||
|
||||
**測試**：`set values: { text: "hello {{name}}", arr: ["item {{name}}"] }` 帶 `name=world` → 全展開。
|
||||
|
||||
#### B. ctx 沒存上游 output 的 node id namespace
|
||||
|
||||
**現象**：`{{classify.data.text}}` 找不到上游 classify 的 output；只能用 `{{data.text}}`（直接 spread 取），但會被下個節點覆蓋，多節點 chain 用不了。
|
||||
|
||||
**根因**：`propagateCtx` 只把上游 result spread 進 ctx，沒額外存 `[node.id]: result`。
|
||||
|
||||
**修法**：`propagateCtx` 改回傳 `{ ...baseCtx, ...baseResult, [upstreamNodeId]: upstreamResult }`。讓下游能用 `{{node_id.data.text}}` 從 namespace 取，永不被覆蓋。
|
||||
|
||||
**測試**：5 節點 chain 用 `{{load_schema.blocks.0.content}}` / `{{classify.data.text}}` 全展開。
|
||||
|
||||
#### C. FOREACH 找 iterable 只看 result，不看 ctx + 不看 nested
|
||||
|
||||
**現象**：mira wiki_synthesis 雙重 FOREACH（外層 `對每個 paragraph`、內層 `對每個 triplet`），外層 OK，內層跑 0 次。
|
||||
|
||||
**根因 (C1)**：`getIterableFromContext(result, key)` 只看當前節點 output。`result` 是 `create_paragraph` output（`{data, success}`），不含 paragraphs。但 `paragraphs` 早就在 ctx 從 classify spread 來。
|
||||
|
||||
**根因 (C2)**：當外層 FOREACH 把 `paragraph` item 注入 ctx，內層 FOREACH 要找 `paragraph.triplets`。`getIterableFromContext` 只看 top-level，看不到 `paragraph` 物件裡的 `triplets`。
|
||||
|
||||
**修法**：
|
||||
- (C1) FOREACH `result` 找不到 iterable → fallback 找 `context`
|
||||
- (C2) `getIterableFromContext` 加一輪「掃 ctx 內每個 object 找 nested key」
|
||||
|
||||
**測試**：mira wiki_synthesis 3 層樹（wiki-page → paragraphs → triplets）端對端跑通，KBDB 內驗證 `物理 AI` wiki 有 2 段 paragraph + 4 個 triplet，parent_id 正確接到對應 paragraph。
|
||||
|
||||
#### Edge type 一致化
|
||||
|
||||
抽 `propagateCtx(context, result, upstreamNodeId)` helper，5 個 edge type（PIPE / ON_SUCCESS / ON_FAIL / IF / ON_CLICK / FOREACH）全部用同一 function 組下游 ctx。**未來新 edge type 必須用這 helper**，避免再漏。
|
||||
|
||||
#### CLI validator 同步
|
||||
|
||||
`cli/src/lib/yaml-parser.ts` validateRelations 加 regex 支援 `對每個 X` / `FOREACH X` 迭代器命名（之前 validator 字串完全比對擋住，但 graph-builder 執行端早已支援）。
|
||||
|
||||
---
|
||||
|
||||
### 三-A、P1 待改進（不擋封測，但 mira 已踩到）
|
||||
|
||||
#### ✅ P1 #3：cypher-executor `scheduled()` handler（2026-05-14 完成）
|
||||
|
||||
**原痛點**：cron 零件只做 expression validation；cypher-executor 沒 `scheduled()` handler。寫了 cron 首節點的 workflow 不會真的跑。
|
||||
|
||||
**之前的 workaround**（已撤）：mira 寫了個 `/mira/wiki-from-raw` route 從前端 fire-and-forget 觸發 wiki_synthesis。但這違反「一律 arcrun-native」原則，也讓 arcrun 永遠補不齊缺失。**已刪 route，回 arcrun-native 路線**。
|
||||
|
||||
**落地**：
|
||||
1. `wrangler.toml`：`[triggers] crons = ["* * * * *"]`（每分鐘 tick）
|
||||
2. `src/lib/cron-match.ts`：5 欄位 cron expression matcher（支援 `*` / `N` / `*/N` / `1-5` / `5,10` 組合）
|
||||
3. `src/scheduled.ts`：scheduled handler 掃 KV `cron-idx:` prefix，比對 controller.scheduledTime，匹配就 `executeWebhookGraph` 背景跑
|
||||
4. `routes/webhooks-named.ts`：acr push 偵測首節點是 cron 零件 → 抽 `cron_expr` 存進 record + 額外寫 `cron-idx:{api_key}:{name}` 輕量 index entry。DELETE 一併清理
|
||||
5. `src/index.ts`：export default 改 `{ fetch, scheduled }`
|
||||
6. cypher-executor 自己加 `workers_dev = true` 給未來 self-trigger 用（fork 用 path-based 子 trigger 也走 workers.dev 避同 zone）
|
||||
|
||||
**workflow YAML 慣例**：
|
||||
```yaml
|
||||
flow:
|
||||
- "my_cron >> ON_SUCCESS >> downstream_node"
|
||||
config:
|
||||
my_cron:
|
||||
component: cron
|
||||
cron_expr: "*/5 * * * *" # 每 5 分鐘
|
||||
```
|
||||
acr push 就會自動建立 cron-idx 並開始定時觸發。
|
||||
|
||||
**測試**：`tests/arcrun-test/cron_heartbeat.yaml` — 每分鐘 fire 一次 + set 節點 log。
|
||||
`wrangler tail arcrun-cypher-executor` 應看 `[scheduled] trigger cron_heartbeat ...`。
|
||||
|
||||
**對應 use case**：mira `mira_feed_watcher`（7B.3h，下一輪做）/ RSS 每日抓 / voice-stt 每小時掃 / 等所有 cron-driven source。
|
||||
|
||||
---
|
||||
|
||||
#### P1 #1：workflow 缺 IF/branch 能力（2026-05-14 mira 7B.3f 提出）
|
||||
|
||||
**現象**：mira 想做「找有則 PATCH 沒則 CREATE」（index-entry upsert），arcrun 目前只有 `ON_SUCCESS` + `對每個 X`（FOREACH）+ 已存在但壞掉的 `if_control`（見已知限制 #1），沒有 `>> ON_TRUE >>` / `>> ON_FALSE >>` 條件路由。
|
||||
|
||||
**短期 workaround**（已採用，2026-05-14）：建 `kbdb_upsert_block` 零件，把分支邏輯封進零件內部（GET by page_name → 找到 PATCH 沒找到 POST）。caller 看到的是單純的 upsert 介面。
|
||||
|
||||
**長期解**：升 `if_control` false branch 路由 / 加 `>> ON_TRUE >>` edge type，讓 workflow 層可表達分支。對未來所有「找則改否則建」/「條件分流」場景都會撞到，不只 mira。
|
||||
|
||||
**位置**：cypher-executor/src/graph-executor.ts edge type 處理（5 個 edge type 抽出 `propagateCtx` 後新增 IF 應該不難）+ cli/src/lib/yaml-parser.ts validator。
|
||||
|
||||
---
|
||||
|
||||
#### P0 #11（2026-05-14 已解決）：interpolateString stringify array 撐爆下游
|
||||
|
||||
**現象**：mira_feed_watcher 用 `items: "{{list_raws.blocks}}"` 把 kbdb_get 拿到的 blocks 陣列傳給 filter 零件。watcher 跑 264ms 完成、0 raw 處理。
|
||||
|
||||
**根因**：`interpolateString` 看到模板就用 `String.replace`，非 string 值（陣列）一律 `JSON.stringify`。filter 零件收到字串 `"[{...},{...}]"` 不是 array，items 被忽略 → 0 matches → FOREACH 跑 0 次。
|
||||
|
||||
**修法**：`interpolateString` 加 single-ref pass-through 規則：若整個值是純單一 `{{x}}` 引用，回 raw value（保留 array / object 型別）。多 ref / 混合文字仍 stringify 拼接字串。
|
||||
|
||||
**測試**：mira_feed_watcher 推到 prod 後下一個 cron tick 觀察 wiki-processed tag 是否在 raws 上出現。
|
||||
|
||||
---
|
||||
|
||||
### 三-B、新零件加入紀錄
|
||||
|
||||
| 日期 | 零件 | 動機 | 對應 SDD |
|
||||
|---|---|---|---|
|
||||
| 2026-05-14 | `kbdb_upsert_block` | mira 7B.3f index-entry per-entity upsert，繞過 workflow 缺 IF/branch 能力（P1 #1）。內部 GET by page_name → 找到 PATCH 沒找到 POST。page_name 當 idempotency key。 | polaris/mira/.agents/specs/mira-app/design.md §3.5.12.4.1 |
|
||||
|
||||
**新零件 checklist（避免 P1 #1 重蹈 kbdb_upsert_block 漏白名單覆轍）**：
|
||||
|
||||
每加一個 API/data 零件（不是 logic primitive），都要：
|
||||
- [ ] `registry/components/{name}/main.go` + `component.contract.yaml` + `go.mod`
|
||||
- [ ] `tinygo build -target=wasi` 通
|
||||
- [ ] `.component-builds/{name}/` 完整 4 檔（`wrangler.toml` 含 `workers_dev = true` + `pnpm-lock.yaml` + `tsconfig.json` + `src/index.ts`）
|
||||
- [ ] **`cypher-executor/src/lib/component-loader.ts` 的 `WASM_HTTP_RUNNER_IDS` 加 canonical_id**（漏這條 cypher-executor 永遠拋「找不到零件」，端對端會死靜悄悄）
|
||||
- [ ] `acr validate workflow.yaml` 通
|
||||
- [ ] 直接 curl `https://{kebab}.arcrun.dev` + `https://arcrun-{kebab}.{WORKER_SUBDOMAIN}.workers.dev` 都 200
|
||||
|
||||
---
|
||||
|
||||
### 三-C、P1 #2：workers_dev = true 全 component 自動化（2026-05-14 已收）
|
||||
|
||||
**原痛點**：每新部署一個 component worker，要去 CF Dashboard 手動 Enable workers.dev URL，否則 cypher-executor fetch 該 worker 會 404。
|
||||
|
||||
**解**：32 個 `.component-builds/*/wrangler.toml` 全部加 `workers_dev = true`。CI 每次 deploy 自動啟用對應 workers.dev URL，零手動。
|
||||
|
||||
**未來新 component**：模板 (`component-worker-template/`) 應該預設帶 `workers_dev = true`，新人 fork 不會踩。已列入「新零件 checklist」第 3 條。
|
||||
|
||||
**為何不走 `*.acr-comp.uncle6.me` 自訂 zone**：CF Universal SSL 只發一層子域，sub-sub `*.acr-comp.uncle6.me` 不蓋；要 ACM ($10/月) 才能簽。違反 arcrun「fork 後 self-host 用 free tier 跑得起來」核心目標。workers_dev=true 走 CF 默認的 workers.dev cert，free tier OK，更乾淨。
|
||||
|
||||
---
|
||||
|
||||
### 原 P0 #9 調查紀錄（保留作歷史參考）
|
||||
|
||||
**現象**：cypher-executor 的 `makeHttpRunner` (`cypher-executor/src/lib/component-loader.ts:142`) 對任何 outbound URL fetch 都回 CF **522 (origin timeout, ~1000ms)**。
|
||||
|
||||
**測試矩陣**（mira repo `polaris/mira/arcrun/wiki_synthesis.yaml` 端對端壓測時發現）：
|
||||
|
||||
| 路徑 | 結果 | 證明 |
|
||||
|---|---|---|
|
||||
| 本機 curl → kbdb-get.arcrun.dev | 200 (22ms) | KBDB worker 本身健康 |
|
||||
| cypher-executor → kbdb-get.arcrun.dev (HTTP) | **522** (1002ms) | outbound HTTP fetch 壞 |
|
||||
| cypher-executor → claude-api.arcrun.dev (HTTP) | **522** | 同 zone 也壞 |
|
||||
| cypher-executor → httpbin.org (外部) | **522** | 不只是 same-account loop |
|
||||
| cypher-executor → string_ops (Service Binding) | 200 ✅ | SVC_* 路徑正常 |
|
||||
| acr run hello (built-in via SB) | ✅ | hello.yaml 仍跑得通 |
|
||||
|
||||
**衍生小 bug**：`set` 零件 input schema 變了（要 `assignments` 陣列或 `values` 物件，不是 `value`）。tests/arcrun-test/hello.yaml 跑 string_ops 沒踩到。
|
||||
|
||||
**影響範圍（封測啟動阻擋）**：
|
||||
|
||||
- 任何用戶 workflow 含 outbound HTTP 都壞：
|
||||
- 用戶 `acr recipe push` 後 trigger → 打外部 API 全 522（推翻 P0 #2 4/18 紀錄）
|
||||
- 用戶要存資料進 arcrun 內建 KBDB → 522（mira 7B.3c 卡這裡）
|
||||
- 任何 auth primitive 走獨立 Worker URL 路徑 → 522
|
||||
- Google Sheets 寫入 → 522（推翻 P0 #7「待真實 OAuth 驗證」評估，根本還沒到 OAuth 步驟就壞）
|
||||
- 只有「全內建邏輯零件 + 純 service binding」workflow 還能跑
|
||||
|
||||
**根因（2026-05-13 確認）：5/8-5/9 9 次 manual `wrangler deploy` 把含 WIP bug 的 cypher-executor 推上 prod**
|
||||
|
||||
調查路徑（按時序）：
|
||||
|
||||
1. 一開始懷疑 free tier CPU cap（10ms / invocation）→ 對照測試「5 節點 SB chain」跑了 2.2 秒卻通過，**推翻**
|
||||
2. 換懷疑 CF zone 規則 / Bot Fight Mode → dashboard bindings 乾淨無攔截，**推翻**
|
||||
3. 用戶補繳費恢復 Workers Paid → 重測仍全 522，**徹底排除付費假設**
|
||||
4. 看 dashboard Version History：5/8 4 次 + 5/9 5 次 = **9 次 manual `wrangler deploy by uncle6.me`**
|
||||
5. 對照 GitHub Actions：4/24 後完全沒 deploy（最後是 commit e222116 `fix(wasi-shim)`）
|
||||
6. 對照 git：本機 main **領先 origin/main 3 commits 未 push**，含：
|
||||
- `497f92a feat(arcrun): recipe system + resumable workflow + component registry canon`
|
||||
- `e8fca33 feat(cypher): 3-node wiki workflow end-to-end (FOREACH + nested interp + unified parsing)`
|
||||
- `519423c feat(arcrun): mira wiki page with tag filter + accumulated WIP`（自描含 `cypher-executor: auth-dispatcher / wasi-shim adjustments (WIP)`）
|
||||
|
||||
**結論**：那 9 次 manual deploy 把上面 3 個 unpushed commit 的 cypher-executor 改動推上 prod，其中至少一個改動破壞了 outbound fetch（最可能是 519423c WIP 內的 wasi-shim / auth-dispatcher 改動）。GitHub Actions 因為沒 push 沒跑，CI 沒 catch，4/18-4/24 那段 SDD「驗證通過」的紀錄是 truth，現在 prod 是壞的版本。
|
||||
|
||||
**為何 SB 路徑沒事 / HTTP 路徑全死**：SB 走 cypher-executor 內部 service binding API（`env.SVC_X.fetch()`），不經過 outbound HTTP code path。HTTP 路徑走 `makeHttpRunner` (component-loader.ts:142) 的 `fetch(url, ...)`，這條路被 WIP code 弄壞。具體壞在哪要 diff 那 3 個 commit 的 cypher-executor 改動才知道。
|
||||
|
||||
**驗證 wrangler tail 證據**：trigger 任何 outbound HTTP 的 graph，cypher-executor 自己 `wallTime: 497ms, cpuTime: 2ms, outcome: ok`、無 logs、無 exceptions。代表 cypher-executor 把「fetch 失敗的 522 response」當作 component 正常輸出包回 client，自己沒撞任何錯。
|
||||
|
||||
**解法（三選一）**：
|
||||
|
||||
- **A. Rollback prod 到 4/24 的 e222116** — CF dashboard → arcrun-cypher-executor → Deployments → 找 4/24 那筆 → Rollback。5 分鐘恢復 outbound fetch，丟失 wiki workflow / recipe / resumable 等 cypher 端 WIP 改動（但前端、registry components、KBDB blocks 都不丟，因為它們是別的 worker / 別的儲存）。**richblack 操作。**
|
||||
- **B. Diff 3 個 unpushed commit 找出壞掉的改動修掉** — 不丟功能，但要動 src code 走 SDD 協議，30min - 數小時。
|
||||
- **C. 架構切換**（mira 老闆 2026-05-13 提的）：sub-workflow 自殺交棒模式，cypher-executor 不再做集中 graph executor。從根本繞開「cypher-executor 一個 invocation 跑長 graph」這條脆弱路徑。一勞永逸但是大改。
|
||||
|
||||
**衍生小 bug 仍要修**（跟付費無關）：`set` 零件 input schema 變了（要 `assignments` 陣列或 `values` 物件，不是 `value`）。要嘛 update set 零件 contract 容錯，要嘛文件化新 schema。
|
||||
|
||||
**為什麼這直接擋封測**：
|
||||
|
||||
封測場景 Step 6「網頁 POST → 結果存 Google Sheets」走 google_sheets 零件 (HTTP outbound to googleapis.com)。如果 cypher-executor outbound 全壞，**封測者跑任何含外部 API 的 workflow 都會 522**，不是「Google Sheets 實際寫入未驗證」級別的小事。
|
||||
|
||||
**也直接擋 mira**：[polaris/mira/.agents/specs/mira-app/tasks.md] 7B.3c-f（wiki 合成 workflow）卡這裡。
|
||||
|
||||
---
|
||||
|
||||
## 四、封測前 P3（啟動當天）
|
||||
|
||||
- [ ] 用封測者 email 呼叫 `/register`，取得 api_key
|
||||
- [ ] 將 ARCRUN_ENCRYPTION_KEY 以安全方式提供給封測者
|
||||
- [ ] 確認聯絡管道
|
||||
|
||||
---
|
||||
|
||||
## 五、已知限制（封測期間不修）
|
||||
|
||||
1. `if_control` false branch 不路由（條件 false 時後續節點不執行）→ 升級計畫見 P1 #1，2026-05-14 mira 用 `kbdb_upsert_block` workaround
|
||||
2. 多節點 context 不自動解包（上游輸出 flat merge，下游需從 `data.result` 取值）
|
||||
3. 用戶自製邏輯零件（Phase 5）封測後才實作
|
||||
|
||||
---
|
||||
|
||||
## 六、實作進度
|
||||
|
||||
| Phase | 內容 | 狀態 |
|
||||
|-------|------|------|
|
||||
| 0 | Workers 部署、CI/CD、DNS | ✅ |
|
||||
| 1 | CLI 基礎（init / validate / run / parts） | ✅ |
|
||||
| 2 | /register、/cypher/execute、21 個零件 | ✅ |
|
||||
| 3 | Service Binding 架構、{{variable}} 插值、ON_FAIL 修正 | ✅ |
|
||||
| 4 | 動態 Recipe KV（CRUD）、acr recipe 指令 | ✅ |
|
||||
| 5 | 用戶自製邏輯零件（WASM push） | ⏸ 封測後 |
|
||||
| 6 | Credential 多租戶（{api_key}:cred:{name}）、acr creds push | ✅ |
|
||||
| 7 | acr parts 內建清單、acr parts scaffold | ✅ |
|
||||
| 8 | /webhooks/named、acr push 改版、config 套入 graph | ✅ |
|
||||
|
||||
### CLI 版本
|
||||
|
||||
| 版本 | 變更 |
|
||||
|------|------|
|
||||
| 1.1.0 | auth recipe 系統：20 個服務預建（Notion/Slack/GitHub/OpenAI/Google SA 等）；acr auth-recipe 指令 |
|
||||
| 1.0.9 | /register 回傳 encryption_key；acr init 自動儲存；creds push 不需手動設環境變數 |
|
||||
| 1.0.8 | acr push → webhooks/named；config 套入 graph；acr parts 內建清單 |
|
||||
| 1.0.7 | acr creds push → POST /credentials |
|
||||
| 1.0.6 | acr recipe push / list / delete |
|
||||
| 1.0.5 | hello.yaml 改 string_ops，--version 修正 |
|
||||
| 1.0.4 | config/context 分離 |
|
||||
| 1.0.3 | 初始發布 |
|
||||
@@ -0,0 +1,274 @@
|
||||
# Auth Recipe System — SDD
|
||||
|
||||
> 文件類型：SDD（Software Design Document）
|
||||
> 建立：2026-04-19
|
||||
> 狀態：實作中
|
||||
|
||||
---
|
||||
|
||||
## 一、目標
|
||||
|
||||
封測前完成，讓封測者碰到「我要連 X 服務」都有辦法，而不是「還沒做」。
|
||||
|
||||
**精神**：`http_request` 是容器零件，auth recipe 是「如何對這個服務認證」的設定層，兩者分離。新增一個服務 = 寫一份 YAML，不需要改程式碼、不需要重新部署 Worker。
|
||||
|
||||
---
|
||||
|
||||
## 二、三層模型
|
||||
|
||||
```
|
||||
Layer 3: Auth Recipe (YAML/JSON in RECIPES KV)
|
||||
公共，描述「如何對某服務認證」
|
||||
key: auth_recipe:{service}
|
||||
例: auth_recipe:notion, auth_recipe:slack
|
||||
↓ 引用
|
||||
Layer 2: Auth Primitive (TypeScript in Worker)
|
||||
四個通用認證邏輯：static_key | oauth2 | service_account | mtls
|
||||
封測只做 static_key 和 service_account (Google JWT)
|
||||
↑ 使用
|
||||
Layer 1: Tenant Secret (CREDENTIALS_KV)
|
||||
每個 tenant 自己的加密 credential
|
||||
key: {api_key}:cred:{name}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 三、Auth Recipe Schema
|
||||
|
||||
```typescript
|
||||
interface AuthRecipeDefinition {
|
||||
kind: 'auth_recipe'; // 區別 RecipeDefinition 用
|
||||
service: string; // canonical_id, e.g. "notion"
|
||||
version: number;
|
||||
primitive: 'static_key' | 'oauth2' | 'service_account' | 'mtls';
|
||||
base_url: string;
|
||||
display_name?: string;
|
||||
description?: string;
|
||||
|
||||
// service_account 用
|
||||
service_account_kind?: 'google_jwt';
|
||||
token_exchange?: {
|
||||
endpoint: string; // e.g. https://oauth2.googleapis.com/token
|
||||
scopes: string[];
|
||||
};
|
||||
|
||||
required_secrets: Array<{
|
||||
key: string; // CREDENTIALS_KV 的名稱
|
||||
label: string; // UI/CLI 顯示
|
||||
type?: 'string' | 'json_blob'; // default: string
|
||||
help?: string;
|
||||
help_url?: string;
|
||||
}>;
|
||||
|
||||
inject: {
|
||||
header?: Record<string, string>; // "Authorization": "Bearer {{secret.token}}"
|
||||
query?: Record<string, string>;
|
||||
body?: Record<string, string>;
|
||||
// path：注入 endpoint URL path 的 secret（2026-05-29 加）。
|
||||
// 解 telegram 類「token 在 URL path」（/bot{token}/）—— header/query/body 都不適用。
|
||||
// key = 模板變數名，API recipe 的 endpoint 用 {{auth.K}} 引用。
|
||||
// 例：auth_recipe:telegram inject.path = { bot_token: "{{secret.telegram_bot_token}}" }
|
||||
// recipe:telegram_send endpoint = "https://api.telegram.org/bot{{auth.bot_token}}/sendMessage"
|
||||
path?: Record<string, string>;
|
||||
};
|
||||
|
||||
created_at: number;
|
||||
updated_at: number;
|
||||
}
|
||||
```
|
||||
|
||||
**Template 語法**：
|
||||
- `{{secret.KEY}}` → 從 tenant 的 CREDENTIALS_KV 解密取值
|
||||
- `{{runtime.access_token}}` → service_account JWT exchange 後取得的短期 token
|
||||
|
||||
---
|
||||
|
||||
## 四、KV 儲存
|
||||
|
||||
沿用現有 `RECIPES` KV namespace，不新增 binding。
|
||||
|
||||
```
|
||||
auth_recipe:{service} → AuthRecipeDefinition JSON
|
||||
```
|
||||
|
||||
與現有 `recipe:{id}` / `idx:{hash}` 的 key 不衝突。
|
||||
|
||||
---
|
||||
|
||||
## 五、執行流程
|
||||
|
||||
### 5.1 static_key（涵蓋 ~80% 服務）
|
||||
|
||||
```
|
||||
trigger → graph-executor
|
||||
→ injectCredentials(componentId, input, env, apiKey)
|
||||
→ resolveAuthRecipe("notion", RECIPES KV)
|
||||
→ 取得 required_secrets: [{key: "notion_token", ...}]
|
||||
→ 從 CREDENTIALS_KV 讀 "{api_key}:cred:notion_token"
|
||||
→ AES-GCM 解密
|
||||
→ 展開 inject.header templates ({{secret.notion_token}} → 實際值)
|
||||
→ 注入 _auth_headers, _auth_query, _auth_body 到 input
|
||||
→ makeAuthRecipeRunner(recipe)
|
||||
→ 合併 _auth_headers 到 fetch headers
|
||||
→ 呼叫 recipe.base_url + input._path
|
||||
→ 回傳結果
|
||||
```
|
||||
|
||||
### 5.2 service_account（Google 家族）
|
||||
|
||||
```
|
||||
injectCredentials
|
||||
→ resolveAuthRecipe("google_sheets_sa", RECIPES KV)
|
||||
→ 解密 service_account_json (JSON blob)
|
||||
→ signGoogleJwt(serviceAccountJson, scopes) via crypto.subtle (RSASSA-PKCS1-v1_5 + SHA-256)
|
||||
→ POST token_exchange.endpoint → 取得 access_token
|
||||
→ 展開 inject.header: { Authorization: "Bearer {{runtime.access_token}}" }
|
||||
→ 注入 _auth_headers
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、Context key 慣例
|
||||
|
||||
注入後的認證資訊以 `_auth_` 前綴攜帶，不污染業務欄位：
|
||||
|
||||
| Key | 說明 |
|
||||
|---|---|
|
||||
| `_auth_headers` | `Record<string, string>` — 要合併進 fetch headers |
|
||||
| `_auth_query` | `Record<string, string>` — 要附加到 URL query string |
|
||||
| `_auth_body` | `Record<string, string>` — 要合併進 request body |
|
||||
| `_auth_path` | `Record<string, string>` — endpoint URL path 用（2026-05-29 加）。`makeRecipeRunner` 的 endpoint interpolate 用 `{{auth.K}}` 從這裡取值 |
|
||||
|
||||
`makeAuthRecipeRunner` / `makeRecipeRunner` 在發出 fetch 前讀取這些 `_auth_*` 欄位，
|
||||
之後從 auto-body 中剔除所有 `_` 前綴欄位（不洩漏給下游）。
|
||||
|
||||
## 七、API recipe 的 auth_service（多 recipe 共用一把 auth，2026-05-29 加）
|
||||
|
||||
`RecipeDefinition` 加 `auth_service?: string` 欄位：API recipe **自報它屬於哪個服務**，
|
||||
auth-dispatcher 用它查 `auth_recipe:{auth_service}`，而非假設 componentId == service name。
|
||||
|
||||
- 讓多個 recipe 共用同一把 auth：`recipe:kbdb_get` / `kbdb_create_block` 都設 `auth_service: "kbdb"`
|
||||
→ 共用唯一的 `auth_recipe:kbdb`，加新 action 不必複製 auth recipe。
|
||||
- auth-dispatcher 解析順序：先查 `recipe:{componentId}` 拿 `auth_service`，有就用它；
|
||||
沒有則 fallback 把 componentId 當 service name（向後相容舊行為）。
|
||||
- 這是「服務身分標籤」非「許可清單」：auth_recipe 只定義「怎麼認證」，不含「誰准用」。
|
||||
授權由發 API key 的服務裁決，arcrun 不做內部授權判斷（見 DECISIONS.md「arcrun 不做授權判斷」）。
|
||||
|
||||
---
|
||||
|
||||
## 七、向後相容
|
||||
|
||||
- 現有 `BUILTIN_API_RECIPES`（gmail, google_sheets, telegram, line_notify）**不動**
|
||||
- 現有 `BUILTIN_CREDENTIALS_MAP` **不動**
|
||||
- auth recipe 解析在 component-loader step 5.5（新增），在 step 6 KV recipe 和 step 7 builtin 之前
|
||||
- 若 `auth_recipe:{service}` 不存在 → 繼續往下走，行為與現在完全相同
|
||||
|
||||
---
|
||||
|
||||
## 八、新增/修改的檔案
|
||||
|
||||
| 檔案 | 類型 | 說明 |
|
||||
|---|---|---|
|
||||
| `cypher-executor/src/routes/recipes.ts` | 修改 | 加 `AuthRecipeDefinition` 型別、`resolveAuthRecipe`、`/auth-recipes` CRUD routes |
|
||||
| `cypher-executor/src/actions/credential-injector.ts` | 修改 | 加 auth recipe 分支：static_key + service_account |
|
||||
| `cypher-executor/src/lib/jwt-signer.ts` | 新增 | Google JWT signing via crypto.subtle |
|
||||
| `cypher-executor/src/lib/component-loader.ts` | 修改 | step 5.5 auth recipe lookup + `makeAuthRecipeRunner` |
|
||||
| `cypher-executor/src/lib/auth-recipe-seeds.ts` | 新增 | 20 個常用服務的 auth recipe 定義 |
|
||||
| `cli/src/commands/auth-recipe.ts` | 新增 | `acr auth-recipe list/info/scaffold` |
|
||||
| `cli/src/commands/parts.ts` | 修改 | `cmdPartsScaffold` fallback 到 auth recipe |
|
||||
| `cli/src/index.ts` | 修改 | 註冊 auth-recipe 指令 |
|
||||
|
||||
---
|
||||
|
||||
## 九、封測前預計的 Auth Recipe 清單（20 個）
|
||||
|
||||
### static_key 類（~80% 服務）
|
||||
|
||||
| service | 認證方式 | credential key |
|
||||
|---|---|---|
|
||||
| `notion` | Bearer token (header) | `notion_token` |
|
||||
| `slack` | Bot Token (Bearer) | `slack_bot_token` |
|
||||
| `github` | PAT (Bearer) | `github_token` |
|
||||
| `openai` | API key (Bearer) | `openai_api_key` |
|
||||
| `anthropic` | API key (x-api-key) | `anthropic_api_key` |
|
||||
| `airtable` | PAT (Bearer) | `airtable_token` |
|
||||
| `discord` | Bot token ("Bot TOKEN") | `discord_bot_token` |
|
||||
| `stripe` | Secret key (Bearer) | `stripe_secret_key` |
|
||||
| `twilio` | AccountSid + AuthToken (Basic Auth) | `twilio_account_sid`, `twilio_auth_token` |
|
||||
| `sendgrid` | API key (Bearer) | `sendgrid_api_key` |
|
||||
| `hubspot` | Private App token (Bearer) | `hubspot_token` |
|
||||
| `linear` | API key (Bearer) | `linear_api_key` |
|
||||
| `shopify` | Admin API token (X-Shopify-Access-Token) | `shopify_access_token` |
|
||||
| `resend` | API key (Bearer) | `resend_api_key` |
|
||||
| `supabase` | Service role key (Bearer + apikey) | `supabase_service_key` |
|
||||
| `typeform` | PAT (Bearer) | `typeform_token` |
|
||||
| `jira` | API token + email (Basic Auth) | `jira_api_token`, `jira_email` |
|
||||
|
||||
### service_account 類（Google 家族，JWT signing）
|
||||
|
||||
| service | scopes | credential key |
|
||||
|---|---|---|
|
||||
| `google_sheets_sa` | spreadsheets | `google_service_account` |
|
||||
| `google_gmail_sa` | gmail.send | `google_service_account` |
|
||||
| `google_drive_sa` | drive | `google_service_account` |
|
||||
|
||||
> 注意：三個 Google 服務可共用同一個 `google_service_account` credential，只是 scope 不同。
|
||||
|
||||
---
|
||||
|
||||
## 十、實作進度
|
||||
|
||||
### Server (cypher-executor)
|
||||
|
||||
- [x] `AuthRecipeDefinition` 型別 + `resolveAuthRecipe`
|
||||
- [x] `/auth-recipes` CRUD routes
|
||||
- [x] `injectFromAuthRecipe` — static_key primitive
|
||||
- [x] `lib/jwt-signer.ts` — Google JWT via crypto.subtle
|
||||
- [x] `injectFromAuthRecipe` — service_account primitive
|
||||
- [x] `makeAuthRecipeRunner` in component-loader
|
||||
- [x] step 5.5 in createComponentLoader
|
||||
- [x] auth-recipe-seeds.ts (20 services)
|
||||
- [x] seed script / deploy seeds to KV（2026-04-19 全部 ✅）
|
||||
|
||||
### CLI (arcrun)
|
||||
|
||||
- [x] `commands/auth-recipe.ts` — list / info / scaffold
|
||||
- [x] 更新 `commands/parts.ts` — scaffold fallback
|
||||
- [x] 更新 `index.ts` — 註冊指令
|
||||
- [x] 版本升 1.1.0
|
||||
- [x] npm publish（arcrun@1.1.0）
|
||||
|
||||
### 驗證
|
||||
|
||||
- [ ] notion (static_key) 端對端
|
||||
- [ ] google_sheets_sa (service_account) 端對端
|
||||
- [ ] 舊有 google_sheets builtin 向後相容確認
|
||||
|
||||
---
|
||||
|
||||
## 十一、長期演進：TinyGo WASM Primitive（封測後）
|
||||
|
||||
> 參考：`docs/user_requirements/arcrun/credential_parts.md`
|
||||
|
||||
**目前封測版**：Layer 2 primitive 邏輯在 `cypher-executor` TypeScript 中實作（`credential-injector.ts`）。
|
||||
|
||||
**長期目標**：四個 primitive 各自編譯為獨立 TinyGo WASM，取代現有 TS 實作：
|
||||
|
||||
```
|
||||
arcrun/registry/components/auth_static_key/ ← TinyGo WASM
|
||||
arcrun/registry/components/auth_oauth2/ ← TinyGo WASM
|
||||
arcrun/registry/components/auth_service_account/ ← TinyGo WASM
|
||||
arcrun/registry/components/auth_mtls/ ← TinyGo WASM
|
||||
```
|
||||
|
||||
每個 primitive 實作統一 interface（`Authenticate` / `NeedsRefresh` / `Refresh` / `Test`）。
|
||||
切換時 `cypher-executor` 的 `injectFromAuthRecipe` 改為呼叫對應 WASM，邏輯不變。
|
||||
|
||||
**何時做**：封測驗證完成、TinyGo crypto 支援確認後（特別是 RS256/ES256 JWT signing）。
|
||||
在此之前，**不建立任何 TypeScript SDK 或 Python SDK 來包裝 credential 邏輯**。
|
||||
|
||||
### 禁止的做法
|
||||
|
||||
- ❌ 建立 `js-sdk/`、`python-sdk/` 包裝 credential 加解密
|
||||
- ❌ 在 client 端重實作 AES-GCM encrypt/decrypt
|
||||
- ❌ 用 TypeScript 重寫已計劃用 TinyGo 實作的 primitive 邏輯
|
||||
@@ -0,0 +1,178 @@
|
||||
# Design Document: Credential Primitives TS → WASM 改寫
|
||||
|
||||
## Overview
|
||||
|
||||
將 `cypher-executor` 中以 TypeScript 實作的 credential 注入邏輯，改寫為 4 個獨立的 WASM 零件。這是 `credential_parts.md` 長期規格的實現，不再是「未來 Phase」。
|
||||
|
||||
**動機**：TS 實作無法在地端（workerd）和邊緣端（Wazero）執行。WASM 零件跨 runtime 可攜，符合 u6u 三層部署架構。
|
||||
|
||||
**嚴格規範（richblack 2026-04-19 確認）**：cypher-executor TS **完全不實作**任何 credential / auth / template / JWT / 解密邏輯。所有業務邏輯必須在 TinyGo WASM 零件內。TS 僅負責 HTTP routing + 呼叫 WASM + host function 提供 runtime primitive（crypto.subtle / KV / fetch）。
|
||||
|
||||
---
|
||||
|
||||
## 現有 TS 實作（要刪除的）
|
||||
|
||||
| 檔案 | 功能 | 對應 WASM Primitive |
|
||||
|------|------|---------------------|
|
||||
| `credential-injector.ts` — `injectFromAuthRecipe()` | static_key template 展開 | `auth_static_key` |
|
||||
| `credential-injector.ts` — service_account 分支 | JWT signing + token exchange | `auth_service_account` |
|
||||
| `credential-injector.ts` — `decryptCredential()` | AES-GCM 解密 | host function（所有 primitive 共用） |
|
||||
| `credential-injector.ts` — `interpolateTemplate()` | `{{secret.KEY}}` 替換 | 內建在各 primitive |
|
||||
| `jwt-signer.ts` — `exchangeGoogleJwt()` | PEM→PKCS8→RS256→token | `auth_service_account` |
|
||||
| `component-loader.ts` — BUILTIN_API_RECIPES | gmail/telegram/line/gsheets 寫死邏輯 | 刪除，改用 auth recipe + `http_request` 零件 |
|
||||
| `credential-injector.ts` — BUILTIN_CREDENTIALS_MAP | 舊路徑 flat injection | 刪除，統一走 auth recipe |
|
||||
| `arcrun/credentials/` | 重複的 credentials Worker | 刪除，路由已在 cypher-executor |
|
||||
|
||||
---
|
||||
|
||||
## 4 個 WASM Primitive 設計
|
||||
|
||||
### 統一 I/O 介面（stdin/stdout JSON）
|
||||
|
||||
```
|
||||
stdin（Worker → WASM）：
|
||||
{
|
||||
"action": "authenticate" | "needs_refresh" | "refresh" | "test",
|
||||
"api_key": "ak_xxx", // 租戶識別，用來組 KV key
|
||||
"service": "openai", // 對應 auth_recipe:{service}
|
||||
"request": { "method": "GET", "url": "/path", "headers": {}, "body": null }
|
||||
}
|
||||
|
||||
WASM 內部流程：
|
||||
1. recipeJSON = kv_get("auth_recipe:" + service)
|
||||
2. 依 recipe.required_secrets 逐一 kv_get("{api_key}:cred:{name}") → {encrypted, iv}
|
||||
3. secrets[name] = crypto_decrypt(encrypted, iv)
|
||||
4. （service_account）crypto_sign_rs256(jwt, pkcs8) + http_request 換 token
|
||||
5. 展開 recipe.inject 的 {{secret.X}} / {{runtime.X}} 模板
|
||||
|
||||
stdout（WASM → Worker）：
|
||||
{
|
||||
"success": true,
|
||||
"auth_headers": { "Authorization": "Bearer xxx" },
|
||||
"auth_query": {},
|
||||
"auth_body": {},
|
||||
"runtime": { ... updated runtime state，供下次 refresh 用 }
|
||||
}
|
||||
```
|
||||
|
||||
### auth_static_key
|
||||
|
||||
**位置**：`arcrun/registry/components/auth_static_key/`
|
||||
**語言**：TinyGo 或 AssemblyScript
|
||||
|
||||
功能：
|
||||
1. 讀取 `recipe.inject.header/query/body` 模板
|
||||
2. 用 `secrets` 展開 `{{secret.KEY}}` 模板
|
||||
3. 回傳 `auth_headers` / `auth_query` / `auth_body`
|
||||
|
||||
涵蓋：~80% 服務（Bearer token, API Key, Basic Auth, custom header）
|
||||
|
||||
### auth_service_account
|
||||
|
||||
**位置**：`arcrun/registry/components/auth_service_account/`
|
||||
**語言**：TinyGo 或 AssemblyScript
|
||||
|
||||
功能：
|
||||
1. 從 `secrets.service_account_json` 解析 private key
|
||||
2. JWT signing（RS256：PEM→PKCS8→sign）
|
||||
3. POST token exchange endpoint → 取得 access_token
|
||||
4. 展開 `{{runtime.access_token}}` 模板
|
||||
|
||||
**crypto 考量**：
|
||||
- TinyGo 的 `crypto/rsa` + `crypto/x509` 支援有限
|
||||
- 若 TinyGo 不支援 RS256：使用 host function 讓 Worker 的 `crypto.subtle` 代簽
|
||||
- 或改用 AssemblyScript（有 as-crypto 套件）
|
||||
|
||||
### auth_oauth2（新建）
|
||||
|
||||
**位置**：`arcrun/registry/components/auth_oauth2/`
|
||||
|
||||
功能：
|
||||
1. `needs_refresh`：檢查 `runtime.expires_at` 是否過期
|
||||
2. `refresh`：用 `runtime.refresh_token` + `secrets.client_secret` 換新 token
|
||||
3. `authenticate`：展開 `{{runtime.access_token}}` 到 headers
|
||||
|
||||
### auth_mtls（新建）
|
||||
|
||||
**位置**：`arcrun/registry/components/auth_mtls/`
|
||||
|
||||
功能：
|
||||
1. 從 `secrets` 讀取 client cert + key
|
||||
2. 回傳 TLS 設定（由 Worker runtime 執行實際 mTLS handshake）
|
||||
|
||||
---
|
||||
|
||||
## cypher-executor 改動
|
||||
|
||||
### 保留（TS routing 層）
|
||||
|
||||
- `routes/credentials.ts` — HTTP CRUD for credentials（接收加密的 payload）
|
||||
- `routes/recipes.ts` — HTTP CRUD for auth recipes
|
||||
- `routes/auth.ts` — OAuth flow routing
|
||||
- `graph-executor.ts` — workflow 執行排程
|
||||
- `lib/wasi-shim.ts` — WASM runtime + host functions（加解密 / KV / 簽章 / HTTP 實際由 `crypto.subtle` / env binding / fetch 執行，但**呼叫時機由 WASM 決定**）
|
||||
|
||||
### 修改
|
||||
|
||||
- `actions/credential-injector.ts` — **整檔刪除**，改為新檔 `actions/auth-dispatcher.ts`（約 30 行）：
|
||||
1. 查 `resolveAuthRecipe(componentId)` 取得 `primitive` 名稱（static_key / service_account / oauth2 / mtls）
|
||||
2. 載入對應的 `auth_{primitive}.wasm`
|
||||
3. 送 stdin：`{ action, api_key, service, request }`（**不送 secrets、不送 recipe plaintext**）
|
||||
4. WASM 透過 host function 自行 `kv_get` 讀 recipe + 加密 secret，`crypto_decrypt` 解密
|
||||
5. 讀 stdout → 合併 `_auth_headers` / `_auth_query` / `_auth_body` 進 ctx
|
||||
|
||||
- `lib/component-loader.ts` — **刪除 `BUILTIN_API_RECIPES`**（含 http_request / gmail / telegram / line_notify / google_sheets 的 TS 實作），全部改走 WASM runner。每個 `.wasm` 零件都已編譯並以獨立 Worker 部署（`{canonical-id-kebab}.arcrun.dev`）。loader 新增的「WASM runner」路徑就是「canonical_id → HTTP URL 查表後 fetch」，**不做** WASM instantiate。
|
||||
- **R2 動態注入 WASM 路徑作廢**（richblack 2026-04-19 確認：CF workerd 無法以 R2 物件臨時 instantiate WASM）。用戶自製零件（Phase 5）同樣走「產生獨立 Worker」流程，不從 R2 讀。
|
||||
|
||||
### 刪除
|
||||
|
||||
- `lib/jwt-signer.ts` — 整檔刪除，RS256 簽章移入 `auth_service_account` WASM（透過 host function `crypto_sign_rs256`）
|
||||
- `credential-injector.ts` 整檔刪除（見上）
|
||||
- `component-loader.ts` 的 `BUILTIN_API_RECIPES` 整段刪除
|
||||
- `BUILTIN_CREDENTIALS_MAP` 已在 `credential-injector.ts` 內，隨檔一併刪
|
||||
|
||||
---
|
||||
|
||||
## Host Functions（WASM ↔ Worker 的橋接）
|
||||
|
||||
auth primitive WASM 需要呼叫外部能力時，透過 host function。全部放 `u6u` namespace。**錯誤回傳非零 uint32；成功 = 0 且把結果寫入 `outPtr` 指向的 buffer**。
|
||||
|
||||
| Host Function | TinyGo 簽章 | 用途 |
|
||||
|---|---|---|
|
||||
| `http_request` | `(urlPtr/Len, methodPtr/Len, headersPtr/Len, bodyPtr/Len, outPtr, outLenPtr) uint32` | HTTP 請求（已實作） |
|
||||
| `kv_get` | `(keyPtr, keyLen, outPtr, outLenPtr) uint32` | 讀 KV。Worker 依 key 前綴路由到 `CREDENTIALS_KV` / `RECIPES` |
|
||||
| `crypto_decrypt` | `(encPtr, encLen, ivPtr, ivLen, outPtr, outLenPtr) uint32` | AES-GCM 解密。encryption key 由 Worker 從 `env.ENCRYPTION_KEY` 內部讀取，**永遠不暴露給 WASM** |
|
||||
| `crypto_sign_rs256` | `(dataPtr, dataLen, pkcs8Ptr, pkcs8Len, outPtr, outLenPtr) uint32` | Worker 用 `crypto.subtle.sign('RSASSA-PKCS1-v1_5' + SHA-256)`；private key 以 PKCS8 bytes 傳入 |
|
||||
|
||||
這些 host function 在 `lib/wasi-shim.ts` 中以 WASI import 提供。
|
||||
|
||||
### 安全邊界
|
||||
|
||||
- `ENCRYPTION_KEY` 只在 `crypto_decrypt` host function 內部使用，**絕不**經 stdin / 回傳值 / 任何路徑傳給 WASM
|
||||
- `api_key` 經 stdin 傳入 WASM（讓 WASM 自己組 `{api_key}:cred:{name}` KV key）
|
||||
- `kv_get` 在 Worker 側檢查 key 前綴：
|
||||
- `auth_recipe:*` → 讀 `RECIPES`
|
||||
- `{api_key}:cred:*` → 讀 `CREDENTIALS_KV`，且 `{api_key}` 必須等於 stdin 傳入的 api_key（防越權）
|
||||
- 其他前綴 → 回傳錯誤
|
||||
|
||||
---
|
||||
|
||||
## 關於解密位置
|
||||
|
||||
採用**方案 B（唯一方案）**：WASM 透過 host function `crypto_decrypt()` 自行解密。
|
||||
|
||||
- cypher-executor TS 完全不解密、不知道 plaintext
|
||||
- `ENCRYPTION_KEY` 永遠留在 Worker host function 內
|
||||
- WASM 知道要解哪份 ciphertext（經 `kv_get` 讀到的 `{encrypted, iv}`），但拿不到 encryption key
|
||||
- 這樣 TS 層完全沒有零件業務邏輯，符合 CLAUDE.md §禁止行為 1/6
|
||||
|
||||
（歷史註記：曾規劃方案 A「TS 先解密再送 stdin」，已廢棄 — 違反「TS 不得實作零件邏輯」。）
|
||||
|
||||
---
|
||||
|
||||
## 不做的事
|
||||
|
||||
- ❌ 不改 recipe YAML schema — 沿用現有格式
|
||||
- ❌ 不改 KV 儲存結構 — `auth_recipe:{service}` / `{api_key}:cred:{name}` 不變
|
||||
- ❌ 不改 SDK API — SDK 仍是 HTTP thin wrapper
|
||||
- ❌ 不建新的 Worker — 在 cypher-executor 內完成
|
||||
@@ -0,0 +1,168 @@
|
||||
# Implementation Tasks: Credential Primitives TS → WASM
|
||||
|
||||
**嚴格規範（richblack 2026-04-19）**：cypher-executor TS 不得實作任何 credential / auth / template / JWT / 解密邏輯。全部走 TinyGo WASM + host functions（方案 B）。
|
||||
|
||||
**封測狀態**：推遲（richblack 2026-04-19 決定）。先完成 Phase 1-3 清除違規 TS，再啟動封測。
|
||||
|
||||
---
|
||||
|
||||
## Phase 0：核心合併（u6u-core → arcrun）
|
||||
|
||||
- [x] 0.1 把 `u6u-core/builtins/` 搬到 `arcrun/builtins/`
|
||||
- [x] 0.2 確認 `arcrun/registry/components/` 21 個零件的 contract.yaml 完整（21/21）
|
||||
- [x] 0.3 刪除 `arcrun/credentials/` 整個目錄（重複，credential route 已在 cypher-executor）
|
||||
- [x] 0.4 更新 `arcrun/cypher-executor/wrangler.toml`：確認 CREDENTIALS_KV binding 存在
|
||||
- [x] 0.5 刪除 `matrix/u6u-core/` 整個目錄（2026-04-19 完成，只剩 credentials/ 已被 cypher-executor 取代）
|
||||
- [x] 0.6 在 `cypher-executor/src/lib/wasi-shim.ts` 新增 host functions：
|
||||
- `u6u.kv_get(keyPtr, keyLen, outPtr, outLenPtr) uint32` — 依 key 前綴路由到 `CREDENTIALS_KV` / `RECIPES`，越權檢查 api_key
|
||||
- `u6u.crypto_decrypt(encPtr, encLen, ivPtr, ivLen, outPtr, outLenPtr) uint32` — 用 `env.ENCRYPTION_KEY` + `crypto.subtle` AES-GCM 解密；key 不暴露給 WASM
|
||||
- `u6u.crypto_sign_rs256(dataPtr, dataLen, pkcs8Ptr, pkcs8Len, outPtr, outLenPtr) uint32` — `crypto.subtle.sign('RSASSA-PKCS1-v1_5' + SHA-256)`
|
||||
- 2026-04-19 完成：wasi-shim.ts 新增 `createArcrunHostFunctions(env, apiKey)` factory，集中 AES-GCM 解密 + RSA sign + KV 前綴路由越權檢查。WASI imports 的 u6u namespace wiring 本來就已接好（只是當時沒有實作 factory）。typecheck 通過。
|
||||
- [x] 0.7 在 `cypher-executor/src/lib/component-loader.ts` 新增 WASM runner 路徑：
|
||||
- 所有 WASM 零件（含 auth primitive、API 零件、未來用戶自製）一律走 HTTP URL（`{canonical-id-kebab}.arcrun.dev`）到獨立 Worker
|
||||
- **R2 動態注入路徑作廢**（richblack 2026-04-19 確認：CF workerd 不支援以 R2 物件臨時 instantiate WASM；用戶自製零件同樣走「產生獨立 Worker」流程，不走 R2）
|
||||
- cypher-executor 本身**不做** WASM instantiate，也不直接呼叫 `createArcrunHostFunctions`；那個 factory 是**零件 Worker 側**（`.component-builds/{name}/src/index.ts`）用的，在 Phase 1 建立 auth_static_key Worker 時接上
|
||||
- 2026-04-19 完成：`component-loader.ts` 新增 `WASM_HTTP_RUNNER_IDS`（10 個 canonical_id，6 個 API 零件 + 4 個 auth primitive）＋ `wasmWorkerUrl()` URL 慣例輔助函數；解析鏈新增為第 8 層（放在 `BUILTIN_API_RECIPES` fallback 之後，避免 Phase 3 尚未完成時 API 零件 Worker 未部署造成 404；Phase 3 刪除 `BUILTIN_API_RECIPES` 後，API 零件會自然落到此層）。auth primitive 從此層進入。`tsc --noEmit` 通過。
|
||||
|
||||
---
|
||||
|
||||
## Phase 1：auth_static_key WASM（優先，涵蓋 80% 服務）
|
||||
|
||||
方案 B：WASM 自行讀 KV + 解密，TS 不碰 plaintext。
|
||||
|
||||
- [x] 1.1 建立 `arcrun/registry/components/auth_static_key/` 目錄
|
||||
- [x] 1.2 寫 `component.contract.yaml`（input: `{action, api_key, service, request}` → output: `{success, auth_headers, auth_query, auth_body, runtime}`）
|
||||
- [x] 1.3 實作 `main.go`（TinyGo）：
|
||||
- 宣告 host imports：`kv_get` / `crypto_decrypt`（static_key 不需要 http_request）
|
||||
- 從 stdin 讀 `{action, api_key, service}`
|
||||
- `kv_get("auth_recipe:" + service)` → recipe JSON → 驗證 `primitive == "static_key"`
|
||||
- 對每個 non-optional `recipe.required_secrets`：`kv_get("{api_key}:cred:{name}")` → `{encrypted, iv}` → `crypto_decrypt` → plaintext
|
||||
- 展開 `{{secret.X}}` / `{{runtime.X}}` 模板於 `inject.header/query/body`；未知 key 展空字串（與 TS parity）；其他 namespace 的 `{{...}}` 原樣保留
|
||||
- 輸出 stdout JSON `{success, auth_headers, auth_query, auth_body, runtime}`
|
||||
- [x] 1.4 `tinygo build -o auth_static_key.wasm -target=wasi main.go` — 2026-04-19 編譯通過（1.1MB，在 contract 限制 2MB 內）
|
||||
- [🔄] 1.5 建立 `.component-builds/auth_static_key/`（用 `component-worker-template`）並部署到 `auth-static-key.arcrun.dev`
|
||||
- 2026-04-20 完成**建置**部分:`.component-builds/auth_static_key/{wrangler.toml, package.json, tsconfig.json, src/index.ts, component.wasm}` 全數到位
|
||||
- 方案 A:`src/index.ts` 直接 import `../../../cypher-executor/src/lib/wasi-shim` 的 `createWasiShim` + `createArcrunHostFunctions`(以 `ArcrunHostEnv` 結構型別相容);AES 解密邏輯仍只存在於 wasi-shim.ts 一處(rule 02 §2.2)
|
||||
- 綁同組 KV:CREDENTIALS_KV (e7f4320f88d343f187e35e3543dd74c9) / RECIPES (9cf9db905c6241f78503199e58b2ffe0);ENCRYPTION_KEY 走 `wrangler secret put`
|
||||
- `wrangler deploy --dry-run` 通過(1192 KiB, 419 KiB gzip);實際 `wrangler deploy` + `secret put ENCRYPTION_KEY` 留給 richblack 執行
|
||||
- [x] 1.6 建立 `auth-dispatcher.ts`（取代 `credential-injector.ts`）：查 auth recipe → HTTP POST 到對應 auth primitive URL → 合併 `_auth_headers` 進 ctx
|
||||
- 2026-04-20 完成:`cypher-executor/src/actions/auth-dispatcher.ts` 新建,export `tryAuthDispatch(componentId, input, env, apiKey)`
|
||||
- 流程:查 `resolveAuthRecipe` → primitive 在 `SUPPORTED_PRIMITIVES`(目前只有 `static_key`)→ fetch `wasmWorkerUrl('auth_static_key')` → 合併 `_auth_headers/_auth_query/_auth_body`
|
||||
- 自引用防護:`AUTH_PRIMITIVE_IDS` set 排除 4 個 `auth_*` componentId
|
||||
- `wasmWorkerUrl` 從 `component-loader.ts` export 出來共用
|
||||
- `graph-executor.ts` 改為:先試 `tryAuthDispatch`(新路徑),沒命中 fallback 到舊 `injectCredentials`(Phase 1.9 刪)
|
||||
- 檢查過 auth-dispatcher.ts 無 `crypto.subtle` / `interpolate` / `{{secret.` / hard-code API URL,符合 rule 02 §2.2
|
||||
- `tsc --noEmit` 通過
|
||||
- [ ] 1.7 端對端測試：openai recipe → 成功注入 `Authorization: Bearer <openai_key>`
|
||||
- [ ] 1.8 端對端測試：twilio recipe（Basic Auth）→ 成功注入
|
||||
- [ ] 1.9 **刪除 `credential-injector.ts` 整檔**（`decryptCredential` / `decryptSecrets` / `interpolateTemplate` / `BUILTIN_CREDENTIALS_MAP` 全刪）
|
||||
|
||||
---
|
||||
|
||||
## Phase 2：auth_service_account WASM
|
||||
|
||||
- [🔄] 2.1 建立 `arcrun/registry/components/auth_service_account/` 目錄
|
||||
- [🔄] 2.2 寫 `component.contract.yaml`
|
||||
- [🔄] 2.3 實作 `main.go`：
|
||||
- 從 stdin 讀 `{api_key, service}` + `kv_get` 拿 recipe + 解密 SA JSON
|
||||
- 解析 SA JSON 取 `client_email` / `private_key`（PEM）
|
||||
- PEM → PKCS8 bytes（純 Go，base64 decode + 去 header/footer）
|
||||
- 組 JWT header + payload（base64url），呼叫 `crypto_sign_rs256(signingInput, pkcs8)` 拿 signature
|
||||
- 組完整 JWT → `http_request` POST `token_uri` → 拿 `access_token`
|
||||
- 展開 `{{runtime.access_token}}` 模板
|
||||
- [x] 2.4 `tinygo build -o auth_service_account.wasm -target=wasi main.go` — 2026-04-20 編譯通過（1.1MB,在 contract 限制 2MB 內）
|
||||
- [x] 2.5 建立 `.component-builds/auth_service_account/` 並部署到 `auth-service-account.arcrun.dev`
|
||||
- 2026-04-20 完成**建置**部分:`.component-builds/auth_service_account/{wrangler.toml, package.json, tsconfig.json, src/index.ts, component.wasm}` 全數到位
|
||||
- 方案 A:`src/index.ts` 重用 `createArcrunHostFunctions` 提供 kv_get/crypto_decrypt/crypto_sign_rs256,**額外加 `http_request` host function**(token exchange 用,非 crypto 不受 §2.2 約束)。http_request 直接回 response body 原文(WASM 端 json.Unmarshal 找 access_token)
|
||||
- 綁同組 KV:CREDENTIALS_KV / RECIPES;ENCRYPTION_KEY 走 `wrangler secret put`
|
||||
- `wrangler deploy --dry-run` 通過(1248 KiB, 440 KiB gzip);實際 `wrangler deploy` + `secret put ENCRYPTION_KEY` 留給 richblack 執行
|
||||
- `auth-dispatcher.ts` 的 `SUPPORTED_PRIMITIVES` 加入 `'service_account'`,workflow 用 google SA recipe 會自動走新 WASM 路徑
|
||||
- [ ] 2.6 端對端測試：google_sheets_sa recipe → 成功取得 access_token → 注入 header
|
||||
- [x] 2.7 **刪除 `lib/jwt-signer.ts` 整檔** — 2026-04-20 完成
|
||||
- `cypher-executor/src/lib/jwt-signer.ts` 已刪除(RS256 JWT 邏輯移入 `auth_service_account.wasm`)
|
||||
- `credential-injector.ts` 原 line 23 `import { exchangeGoogleJwt }` 移除
|
||||
- `credential-injector.ts` 原 line 140-150 service_account 分支改為 throw(任何 service_account recipe 已被 auth-dispatcher 攔截;這條 TS fallback 若被觸發即表架構錯亂,直接爆錯比沈默解密更安全)
|
||||
- `cypher-executor` tsc --noEmit 通過
|
||||
|
||||
---
|
||||
|
||||
## Phase 3：清理 component-loader 的 TS 實作（全刪）
|
||||
|
||||
目標：`BUILTIN_API_RECIPES` 整段刪除，所有服務走 WASM runner（HTTP URL 路徑）。
|
||||
|
||||
- [x] 3.1 確認 `http_request.wasm` / `gmail.wasm` / `telegram.wasm` / `line_notify.wasm` / `google_sheets.wasm` 都在 `registry/components/` 且可執行 — 2026-04-20 驗證 6 個(含 cron)全數存在,main.go + .wasm 齊備
|
||||
- [x] 3.2 確認上述零件 Worker 都已部署（`{name}.arcrun.dev` 可用） — 2026-04-20 完成**建置**部分
|
||||
- 6 個 Worker 建置到位:`.component-builds/{http_request, gmail, telegram, line_notify, google_sheets, cron}/{wrangler.toml, package.json, tsconfig.json, src/index.ts, component.wasm}`
|
||||
- 方案 A:5 個需 http_request 的零件(http_request/gmail/telegram/line_notify/google_sheets)`src/index.ts` 共用模板;cron 是純計算不註冊 host function
|
||||
- 全部透過 `createWasiShim` 複用 cypher-executor/src/lib/wasi-shim.ts(rule 02 §2.2 邊界)
|
||||
- 6 個 `wrangler deploy --dry-run` 全通過(~1.17 MB / ~413 KB gzip 每個);實際 `wrangler deploy` 留給 richblack 執行
|
||||
- [x] 3.3 `component-loader.ts` 的內建路徑改為查對應 Worker URL → HTTP POST — 2026-04-20 完成
|
||||
- 原本第 7 層是 `BUILTIN_API_RECIPES` fallback、第 8 層是 `WASM_HTTP_RUNNER_IDS` (HTTP URL);兩層合併為第 7 層 `WASM_HTTP_RUNNER_IDS` 直接走 `makeHttpRunner(wasmWorkerUrl(id))`
|
||||
- 解析鏈新編號 1-8,順序不變(外部 URL → recipe hash → component hash → R2 → Service Binding → auth recipe runner → WASM HTTP runner → 找不到)
|
||||
- [x] 3.4 **刪除 `BUILTIN_API_RECIPES` 整個 Record**（`http_request` / `gmail` / `telegram` / `line_notify` / `google_sheets` / `cron` 的 TS 實作全刪） — 2026-04-20 完成
|
||||
- `cypher-executor/src/lib/component-loader.ts` 原 line 253-326 `BUILTIN_API_RECIPES` 常數 + fallback lookup 全刪(約 80 行)
|
||||
- 全域搜尋確認:`gmail.googleapis.com/...messages/send` / `api.telegram.org/bot.*sendMessage` / `sheets.googleapis.com/v4/spreadsheets` / `notify-api.line.me/api/notify` 在 cypher-executor TS 中已不存在(auth-recipe-seeds.ts 的 `base_url` 是 recipe 資料欄位,不是 hard-coded API call)
|
||||
- `cypher-executor` tsc --noEmit 通過
|
||||
- [ ] 3.5 端對端測試：workflow 用 gmail auth recipe + gmail.wasm Worker → 成功發信
|
||||
- [ ] 3.6 端對端測試：workflow 用 http_request.wasm Worker + auth_static_key 注入 → 成功呼叫任意 API
|
||||
|
||||
---
|
||||
|
||||
## Phase 4：auth_oauth2 + auth_mtls WASM（封測後）
|
||||
|
||||
- [ ] 4.1 建立 `arcrun/registry/components/auth_oauth2/`
|
||||
- [ ] 4.2 實作：`needs_refresh` / `refresh` / `authenticate` 三個 action
|
||||
- [ ] 4.3 建立 `arcrun/registry/components/auth_mtls/`
|
||||
- [ ] 4.4 實作：輸出 TLS cert/key（實際 mTLS handshake 由 Worker runtime 執行，WASM 無法做 socket）
|
||||
|
||||
---
|
||||
|
||||
## Phase 5：封測啟動門檻 — 核心穩定驗證
|
||||
|
||||
**全部通過才能啟動封測**。
|
||||
|
||||
- [ ] 5.1 所有 20 個 auth recipe seed 可正常運作（static_key 17 個 + service_account 3 個）
|
||||
- [ ] 5.2 `cypher-executor/src/actions/credential-injector.ts` **不存在**
|
||||
- [ ] 5.3 `cypher-executor/src/lib/jwt-signer.ts` **不存在**
|
||||
- [ ] 5.4 `cypher-executor/src/lib/component-loader.ts` 無 `BUILTIN_API_RECIPES` / `BUILTIN_CREDENTIALS_MAP`
|
||||
- [ ] 5.5 `cypher-executor/src/` 全域搜尋 `crypto.subtle.decrypt` 只出現在 `wasi-shim.ts` 的 `crypto_decrypt` host function
|
||||
- [ ] 5.6 `cypher-executor/src/` 全域搜尋 `crypto.subtle.sign` 只出現在 `wasi-shim.ts` 的 `crypto_sign_rs256` host function
|
||||
- [ ] 5.7 `cypher-executor/src/` 全域搜尋 `interpolate` 回傳 0 筆（template 展開全在 WASM）
|
||||
- [ ] 5.8 全域搜尋 `{{secret\.` / `{{runtime\.` 在 TS 檔案中回傳 0 筆
|
||||
|
||||
---
|
||||
|
||||
## Phase 6:通用 CI/CD deploy workflow
|
||||
|
||||
**背景**(2026-04-20 richblack 決定):現 `.github/workflows/deploy.yml` 只部署 cypher-executor + registry + 已刪除的 credentials,漏掉 Phase 1-3 產出的 8 個 Worker,且硬編碼每個 job 導致未來新增 Worker 都要改 CI。改為**通用掃描式 workflow**:任何含 `wrangler.toml` 的目錄 = 部署單位,改到該目錄下任何檔案 = 觸發重新 deploy。
|
||||
|
||||
**關鍵決策**:
|
||||
- 零件 `.wasm` 由 CI build(不 commit):`registry/components/{name}/main.go` 改動時才重 build,用 timestamp / content hash 判斷
|
||||
- `.component-builds/{name}/component.wasm` 由 CI 從 `registry/components/{name}/{name}.wasm` 複製產生(deploy 前一步)
|
||||
- 統一用 pnpm(`.component-builds/*` 本來就是;順勢把 cypher-executor 的 `package-lock.json` 砍了)
|
||||
- runtime secret(`ENCRYPTION_KEY`)不進 CI,由 richblack 一次性 `wrangler secret put`
|
||||
- registry Worker 的 `wrangler.toml` 現階段不改(職責是合約管理,與封測無關;`sandboxAcceptance.ts` 的 rule 02 §2.2 審查留到 Phase 5 用戶自製零件啟動時)
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] 6.1 改寫 `.github/workflows/deploy.yml`:動態掃描所有含 `wrangler.toml` 的目錄(排除 `node_modules/` + Pages 專案),用 matrix job fanout 部署;分兩層(tier1=`.component-builds/*`,tier2=其他),tier1 全綠後才 tier2(避免 service binding target 未存在)
|
||||
- [x] 6.2 加上 TinyGo build 步驟:tier1 matrix 一律 setup-tinygo + 從 `registry/components/{name}/main.go` rebuild `.wasm` → copy 到 `.component-builds/{name}/component.wasm`
|
||||
- [x] 6.3 diff-aware:push 到 main 時比對 `github.event.before..github.sha`,只 deploy 有 diff 的 Worker(含 `registry/components/{name}/` 連動 `.component-builds/{name}/`);`workflow_dispatch` 提供 `force_all` + `only` 選項
|
||||
- [x] 6.4 統一 pnpm:刪除 `cypher-executor/package-lock.json` + `registry/package-lock.json`;workflow 優先 `pnpm install --frozen-lockfile`,若該目錄無 `pnpm-lock.yaml` 則 fallback 到 `--no-frozen-lockfile`(混合期容錯)
|
||||
- [x] 6.5 加 `max-parallel: 5` 控制 Workers API rate limit(tier1 和 tier2 各自)
|
||||
- [x] 6.6 驗證:`workflow_dispatch` + `force_all=true` 手動跑一次,24 個 Worker 全綠 — 2026-04-20 完成
|
||||
- 最終綠色 run 24668903627(28/28 jobs,含 discover + summary):tier1 24 個零件 Worker + tier2 2 個 orchestration Worker(cypher-executor / registry)全 success
|
||||
- 過程中修兩輪:先修 `setup-node` 的 `cache: 'pnpm'` 對 legacy `package-lock.json` 目錄失效(改為不用 cache);再修 tier2 三個 package.json(cypher-executor/registry/builtins)遺漏 `wrangler` devDependency + regen pnpm-lock.yaml
|
||||
- ENCRYPTION_KEY secret 已由 richblack 授權、CC 從 .env pipe 到三個 Worker:`arcrun-auth-static-key`、`arcrun-auth-service-account`、`arcrun-cypher-executor`(不顯示內容)
|
||||
- [x] 6.7 文件:在 `.claude/rules/` 加一份 `05-deploy-convention.md`(「新增 Worker = 新目錄 + wrangler.toml,不用改 CI」)
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- 方案 B 是唯一方案（方案 A 已廢棄，違反 CLAUDE.md §禁止行為）
|
||||
- Phase 0.6（host functions）+ 0.7（WASM runner）是 Phase 1-3 的硬前置，必須先做
|
||||
- 若 TinyGo `encoding/base64` 可用就直接用；若不可用則自行實作（見 gmail/main.go 的 `base64URLEncode`）
|
||||
- `auth_mtls` 的 TLS handshake 無法在 WASM 內做（WASI preview1 沒 socket），只能輸出 cert/key 讓 Worker 在 fetch 時用
|
||||
- **每個 auth primitive WASM 都是獨立部署的 Worker**（透過 `component-worker-template/`），不是從 R2 動態載入
|
||||
- Cypher binding = workflow YAML 裡的 URL 清單，不是 Cloudflare service binding
|
||||
@@ -0,0 +1,25 @@
|
||||
# CODING AGENTS: READ THIS FIRST
|
||||
|
||||
This is a **handoff bundle** from Claude Design (claude.ai/design).
|
||||
|
||||
A user mocked up designs in HTML/CSS/JS using an AI design tool, then exported this bundle so a coding agent can implement the designs for real.
|
||||
|
||||
## What you should do — IMPORTANT
|
||||
|
||||
**Read the chat transcripts first.** There are 1 chat transcript(s) in `arcrun/chats/`. The transcripts show the full back-and-forth between the user and the design assistant — they tell you **what the user actually wants** and **where they landed** after iterating. Don't skip them. The final HTML files are the output, but the chat is where the intent lives.
|
||||
|
||||
**Find the primary design file under `arcrun/project/` and read it top to bottom.** The chat transcripts will tell you which file the user was last iterating on. Then **follow its imports**: open every file it pulls in (shared components, CSS, scripts) so you understand how the pieces fit together before you start implementing.
|
||||
|
||||
**If anything is ambiguous, ask the user to confirm before you start implementing.** It's much cheaper to clarify scope up front than to build the wrong thing.
|
||||
|
||||
## About the design files
|
||||
|
||||
The design medium is **HTML/CSS/JS** — these are prototypes, not production code. Your job is to **recreate them pixel-perfectly** in whatever technology makes sense for the target codebase (React, Vue, native, whatever fits). Match the visual output; don't copy the prototype's internal structure unless it happens to fit.
|
||||
|
||||
**Don't render these files in a browser or take screenshots unless the user asks you to.** Everything you need — dimensions, colors, layout rules — is spelled out in the source. Read the HTML and CSS directly; a screenshot won't tell you anything they don't.
|
||||
|
||||
## Bundle contents
|
||||
|
||||
- `arcrun/README.md` — this file
|
||||
- `arcrun/chats/` — conversation transcripts (read these!)
|
||||
- `arcrun/project/` — the `arcrun` project files (HTML prototypes, assets, components)
|
||||
@@ -0,0 +1,56 @@
|
||||
// App root — screen switcher with persistent route
|
||||
const { useState, useEffect } = React;
|
||||
|
||||
const SCREENS = [
|
||||
{ id: 'landing', label: 'Landing' },
|
||||
{ id: 'auth', label: 'Auth' },
|
||||
{ id: 'dashboard', label: 'Dashboard' },
|
||||
{ id: 'keys', label: 'API Keys' },
|
||||
{ id: 'workflow', label: 'Workflow' },
|
||||
];
|
||||
|
||||
// Synonyms from sidebar ids
|
||||
const aliases = { apps: 'dashboard', workflows: 'dashboard', docs: 'landing', settings: 'keys' };
|
||||
|
||||
function App() {
|
||||
const [screen, setScreen] = useState(() => {
|
||||
const saved = localStorage.getItem('arcrun:screen');
|
||||
return saved && SCREENS.some(s => s.id === saved) ? saved : 'landing';
|
||||
});
|
||||
|
||||
useEffect(() => {
|
||||
localStorage.setItem('arcrun:screen', screen);
|
||||
window.scrollTo(0, 0);
|
||||
}, [screen]);
|
||||
|
||||
const nav = (id) => {
|
||||
const resolved = aliases[id] || id;
|
||||
if (SCREENS.some(s => s.id === resolved)) setScreen(resolved);
|
||||
};
|
||||
|
||||
const Current = {
|
||||
landing: Landing,
|
||||
auth: Auth,
|
||||
dashboard: Dashboard,
|
||||
keys: ApiKeys,
|
||||
workflow: WorkflowViewer,
|
||||
}[screen];
|
||||
|
||||
return (
|
||||
<div className="app">
|
||||
<Current onNav={nav} />
|
||||
|
||||
<div className="proto-switch" role="tablist" aria-label="Screen switcher">
|
||||
{SCREENS.map(s => (
|
||||
<button key={s.id}
|
||||
className={screen === s.id ? 'active' : ''}
|
||||
onClick={() => nav(s.id)}>
|
||||
{s.label}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
ReactDOM.createRoot(document.getElementById('root')).render(<App />);
|
||||
@@ -0,0 +1,92 @@
|
||||
// Top nav and sidebar
|
||||
|
||||
const TopNav = ({ onNav, current }) => {
|
||||
const [scrolled, setScrolled] = React.useState(false);
|
||||
React.useEffect(() => {
|
||||
const onScroll = () => setScrolled(window.scrollY > 8);
|
||||
window.addEventListener('scroll', onScroll);
|
||||
return () => window.removeEventListener('scroll', onScroll);
|
||||
}, []);
|
||||
return (
|
||||
<nav className={`topnav ${scrolled ? 'scrolled' : ''}`}>
|
||||
<div className="flex gap-12" style={{alignItems: 'center'}}>
|
||||
<Logo onClick={() => onNav('landing')} />
|
||||
<div className="nav-links" style={{marginLeft: 20}}>
|
||||
<a>Product</a>
|
||||
<a>Docs</a>
|
||||
<a>Pricing</a>
|
||||
<a>Changelog</a>
|
||||
</div>
|
||||
</div>
|
||||
<div className="flex gap-8" style={{alignItems: 'center'}}>
|
||||
<button className="btn btn-ghost" onClick={() => onNav('auth')}>Log in</button>
|
||||
<button className="btn btn-primary" onClick={() => onNav('auth')}>
|
||||
Get started <Icon name="arrow_right" size={14} />
|
||||
</button>
|
||||
</div>
|
||||
</nav>
|
||||
);
|
||||
};
|
||||
|
||||
const Footer = ({ onNav }) => (
|
||||
<footer className="footer">
|
||||
<div className="flex gap-12" style={{alignItems: 'center'}}>
|
||||
<Logo size="sm" />
|
||||
<span>© 2026 Arcrun Labs</span>
|
||||
</div>
|
||||
<div className="footer-links">
|
||||
<a>Docs</a>
|
||||
<a>Pricing</a>
|
||||
<a>Changelog</a>
|
||||
<a>Status</a>
|
||||
<a>Privacy</a>
|
||||
</div>
|
||||
</footer>
|
||||
);
|
||||
|
||||
// App shell with sidebar for logged-in screens
|
||||
const Sidebar = ({ current, onNav }) => {
|
||||
const items = [
|
||||
{ id: 'dashboard', label: 'Dashboard', icon: 'home' },
|
||||
{ id: 'apps', label: 'Apps', icon: 'grid', count: 6 },
|
||||
{ id: 'workflows', label: 'Workflows', icon: 'workflow', count: 12 },
|
||||
{ id: 'keys', label: 'API Keys', icon: 'key' },
|
||||
{ id: 'docs', label: 'Docs', icon: 'book' },
|
||||
];
|
||||
const bottom = [
|
||||
{ id: 'settings', label: 'Settings', icon: 'settings' },
|
||||
];
|
||||
return (
|
||||
<aside className="sidebar">
|
||||
<div className="sidebar-head">
|
||||
<Logo size="md" onClick={() => onNav('landing')} />
|
||||
</div>
|
||||
<div className="sidebar-section">Workspace</div>
|
||||
{items.map(it => (
|
||||
<div key={it.id}
|
||||
className={`sidebar-item ${current === it.id ? 'active' : ''}`}
|
||||
onClick={() => onNav(it.id)}>
|
||||
<span className="sb-ico"><Icon name={it.icon} size={15} /></span>
|
||||
<span>{it.label}</span>
|
||||
{it.count != null && <span className="sb-count">{it.count}</span>}
|
||||
</div>
|
||||
))}
|
||||
<div style={{flex: 1}} />
|
||||
{bottom.map(it => (
|
||||
<div key={it.id} className="sidebar-item" onClick={() => onNav(it.id)}>
|
||||
<span className="sb-ico"><Icon name={it.icon} size={15} /></span>
|
||||
<span>{it.label}</span>
|
||||
</div>
|
||||
))}
|
||||
<div className="sidebar-foot">
|
||||
<div className="avatar-circ">MR</div>
|
||||
<div className="meta">
|
||||
<div className="name">Maya Rivera</div>
|
||||
<div className="email">maya@northwind.co</div>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
);
|
||||
};
|
||||
|
||||
Object.assign(window, { TopNav, Footer, Sidebar });
|
||||
@@ -0,0 +1,86 @@
|
||||
// Shared primitives: icons, logo, etc.
|
||||
|
||||
const Icon = ({ name, size = 16, stroke = 1.7 }) => {
|
||||
const paths = {
|
||||
arrow_right: <path d="M5 12h14M13 6l6 6-6 6" />,
|
||||
arrow_left: <path d="M19 12H5M11 6l-6 6 6 6" />,
|
||||
plus: <path d="M12 5v14M5 12h14" />,
|
||||
copy: <><rect x="9" y="9" width="13" height="13" rx="2" /><path d="M5 15V5a2 2 0 0 1 2-2h10" /></>,
|
||||
check: <path d="M20 6L9 17l-5-5" />,
|
||||
close: <path d="M18 6L6 18M6 6l12 12" />,
|
||||
eye: <><path d="M1 12s4-8 11-8 11 8 11 8-4 8-11 8-11-8-11-8z" /><circle cx="12" cy="12" r="3" /></>,
|
||||
search: <><circle cx="11" cy="11" r="7" /><path d="M21 21l-4.35-4.35" /></>,
|
||||
warn: <><path d="M10.3 3.86L1.82 18a2 2 0 001.72 3h16.92a2 2 0 001.72-3L13.7 3.86a2 2 0 00-3.4 0z" /><line x1="12" y1="9" x2="12" y2="13" /><circle cx="12" cy="17" r="0.5" fill="currentColor" /></>,
|
||||
home: <><path d="M3 10l9-7 9 7v10a2 2 0 01-2 2h-4a2 2 0 01-2-2v-5h-2v5a2 2 0 01-2 2H5a2 2 0 01-2-2V10z" /></>,
|
||||
grid: <><rect x="3" y="3" width="7" height="7" rx="1" /><rect x="14" y="3" width="7" height="7" rx="1" /><rect x="3" y="14" width="7" height="7" rx="1" /><rect x="14" y="14" width="7" height="7" rx="1" /></>,
|
||||
workflow: <><circle cx="5" cy="6" r="2" /><circle cx="19" cy="12" r="2" /><circle cx="5" cy="18" r="2" /><path d="M7 6h4a4 4 0 014 4v0m0 4a4 4 0 01-4 4H7" /></>,
|
||||
key: <><circle cx="7.5" cy="15.5" r="4.5" /><path d="M10.68 12.32L21 2M17 6l3 3M15 8l3 3" /></>,
|
||||
book: <><path d="M2 3h6a4 4 0 014 4v14a3 3 0 00-3-3H2zM22 3h-6a4 4 0 00-4 4v14a3 3 0 013-3h7z" /></>,
|
||||
settings: <><circle cx="12" cy="12" r="3" /><path d="M19.4 15a1.65 1.65 0 00.33 1.82l.06.06a2 2 0 01-2.83 2.83l-.06-.06a1.65 1.65 0 00-1.82-.33 1.65 1.65 0 00-1 1.51V21a2 2 0 01-4 0v-.09A1.65 1.65 0 009 19.4a1.65 1.65 0 00-1.82.33l-.06.06a2 2 0 01-2.83-2.83l.06-.06a1.65 1.65 0 00.33-1.82 1.65 1.65 0 00-1.51-1H3a2 2 0 010-4h.09A1.65 1.65 0 004.6 9a1.65 1.65 0 00-.33-1.82l-.06-.06a2 2 0 012.83-2.83l.06.06A1.65 1.65 0 009 4.6a1.65 1.65 0 001-1.51V3a2 2 0 014 0v.09A1.65 1.65 0 0015 4.6a1.65 1.65 0 001.82-.33l.06-.06a2 2 0 012.83 2.83l-.06.06A1.65 1.65 0 0019.4 9v0a1.65 1.65 0 001.51 1H21a2 2 0 010 4h-.09a1.65 1.65 0 00-1.51 1z" /></>,
|
||||
chevron_right: <path d="M9 6l6 6-6 6" />,
|
||||
chevron_down: <path d="M6 9l6 6 6-6" />,
|
||||
external: <><path d="M18 13v6a2 2 0 01-2 2H5a2 2 0 01-2-2V8a2 2 0 012-2h6" /><path d="M15 3h6v6M10 14L21 3" /></>,
|
||||
trash: <><polyline points="3 6 5 6 21 6" /><path d="M19 6l-1 14a2 2 0 01-2 2H8a2 2 0 01-2-2L5 6M10 11v6M14 11v6" /></>,
|
||||
spark: <path d="M12 3l2.5 6.5L21 12l-6.5 2.5L12 21l-2.5-6.5L3 12l6.5-2.5L12 3z" />,
|
||||
bolt: <path d="M13 2L3 14h9l-1 8 10-12h-9l1-8z" />,
|
||||
github: <path d="M12 2C6.48 2 2 6.48 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.22.66-.48v-1.7c-2.78.6-3.36-1.34-3.36-1.34-.46-1.15-1.12-1.46-1.12-1.46-.92-.62.07-.6.07-.6 1.01.07 1.55 1.04 1.55 1.04.9 1.54 2.36 1.1 2.94.84.09-.65.35-1.1.64-1.35-2.22-.25-4.55-1.11-4.55-4.94 0-1.09.39-1.98 1.03-2.68-.1-.25-.45-1.27.1-2.65 0 0 .84-.27 2.75 1.02A9.5 9.5 0 0112 6.8c.85 0 1.7.11 2.5.33 1.9-1.3 2.75-1.02 2.75-1.02.55 1.38.2 2.4.1 2.65.64.7 1.03 1.6 1.03 2.68 0 3.84-2.34 4.69-4.57 4.93.36.31.68.92.68 1.85V21c0 .27.16.57.67.48A10 10 0 0022 12c0-5.52-4.48-10-10-10z" fill="currentColor" stroke="none" />,
|
||||
google: <><path d="M21.35 11.1h-9.17v2.73h5.24c-.23 1.41-1.69 4.13-5.24 4.13-3.15 0-5.73-2.62-5.73-5.86 0-3.24 2.58-5.86 5.73-5.86 1.8 0 3 .77 3.69 1.43l2.5-2.4C16.95 3.74 14.8 2.8 12.18 2.8c-5.26 0-9.53 4.25-9.53 9.5s4.27 9.5 9.53 9.5c5.51 0 9.15-3.87 9.15-9.32 0-.63-.07-1.1-.15-1.38z" fill="currentColor" stroke="none" /></>,
|
||||
share: <><circle cx="18" cy="5" r="3" /><circle cx="6" cy="12" r="3" /><circle cx="18" cy="19" r="3" /><path d="M8.59 13.51l6.83 3.98M15.41 6.51l-6.82 3.98" /></>,
|
||||
download: <><path d="M21 15v4a2 2 0 01-2 2H5a2 2 0 01-2-2v-4" /><polyline points="7 10 12 15 17 10" /><line x1="12" y1="15" x2="12" y2="3" /></>,
|
||||
zoom_in: <><circle cx="11" cy="11" r="7" /><line x1="21" y1="21" x2="16.65" y2="16.65" /><line x1="11" y1="8" x2="11" y2="14" /><line x1="8" y1="11" x2="14" y2="11" /></>,
|
||||
zoom_out: <><circle cx="11" cy="11" r="7" /><line x1="21" y1="21" x2="16.65" y2="16.65" /><line x1="8" y1="11" x2="14" y2="11" /></>,
|
||||
maximize: <><path d="M8 3H5a2 2 0 00-2 2v3M21 8V5a2 2 0 00-2-2h-3M3 16v3a2 2 0 002 2h3M16 21h3a2 2 0 002-2v-3" /></>,
|
||||
slack: <><rect x="13" y="2" width="3" height="8" rx="1.5" /><rect x="2" y="13" width="8" height="3" rx="1.5" /><rect x="14" y="14" width="8" height="3" rx="1.5" /><rect x="8" y="8" width="3" height="8" rx="1.5" /></>,
|
||||
database: <><ellipse cx="12" cy="5" rx="9" ry="3" /><path d="M3 5v7c0 1.66 4.03 3 9 3s9-1.34 9-3V5M3 12v7c0 1.66 4.03 3 9 3s9-1.34 9-3v-7" /></>,
|
||||
mail: <><rect x="2" y="4" width="20" height="16" rx="2" /><path d="M2 6l10 7 10-7" /></>,
|
||||
filter: <path d="M3 4h18l-7 9v6l-4-2v-4L3 4z" />,
|
||||
star: <polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2" />,
|
||||
linear: <><rect x="3" y="3" width="18" height="18" rx="4" /><path d="M7 11l5 5M7 15l3 3M7 7l10 10M11 7l6 6M15 7l2 2" /></>,
|
||||
clock: <><circle cx="12" cy="12" r="9" /><polyline points="12 7 12 12 16 14" /></>,
|
||||
send: <><path d="M22 2L11 13M22 2l-7 20-4-9-9-4 20-7z" /></>,
|
||||
terminal: <><path d="M4 17l6-6-6-6M12 19h8" /></>,
|
||||
logout: <><path d="M9 21H5a2 2 0 01-2-2V5a2 2 0 012-2h4M16 17l5-5-5-5M21 12H9" /></>,
|
||||
};
|
||||
|
||||
return (
|
||||
<svg width={size} height={size} viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={stroke} strokeLinecap="round" strokeLinejoin="round" style={{display: 'block', flexShrink: 0}}>
|
||||
{paths[name]}
|
||||
</svg>
|
||||
);
|
||||
};
|
||||
|
||||
// Arcrun wordmark — custom "arc" glyph made of an arc stroke + ascending dot/node
|
||||
const Logo = ({ size = 'md', onClick }) => {
|
||||
const dims = size === 'sm' ? { w: 18, h: 18, f: 10 } : size === 'lg' ? { w: 28, h: 28, f: 14 } : { w: 22, h: 22, f: 12 };
|
||||
return (
|
||||
<div className="logo" onClick={onClick}>
|
||||
<span className="logo-mark" style={{width: dims.w, height: dims.h}}>
|
||||
<svg width={dims.w} height={dims.h} viewBox="0 0 24 24" fill="none">
|
||||
<path d="M5 17 Q 12 4, 19 17" stroke="white" strokeWidth="2.4" strokeLinecap="round" fill="none" opacity="0.95" />
|
||||
<circle cx="19" cy="17" r="2.2" fill="white" />
|
||||
</svg>
|
||||
</span>
|
||||
<span>Arcrun</span>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
// App icon with gradient background
|
||||
const AppIcon = ({ tone = 'indigo', children, size = 38 }) => {
|
||||
const tones = {
|
||||
indigo: 'linear-gradient(135deg, #6366F1, #8B5CF6)',
|
||||
orange: 'linear-gradient(135deg, #F59E0B, #EF4444)',
|
||||
green: 'linear-gradient(135deg, #10B981, #22C55E)',
|
||||
pink: 'linear-gradient(135deg, #EC4899, #8B5CF6)',
|
||||
blue: 'linear-gradient(135deg, #3B82F6, #06B6D4)',
|
||||
slate: 'linear-gradient(135deg, #475569, #334155)',
|
||||
amber: 'linear-gradient(135deg, #F59E0B, #D97706)',
|
||||
};
|
||||
return (
|
||||
<div className="app-icon" style={{ background: tones[tone], width: size, height: size, color: 'white' }}>
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
Object.assign(window, { Icon, Logo, AppIcon });
|
||||
@@ -0,0 +1,95 @@
|
||||
# Chat
|
||||
|
||||
_Started 2026-04-23 04:37 UTC_
|
||||
|
||||
---
|
||||
|
||||
## User
|
||||
|
||||
|
||||
|
||||
## Assistant
|
||||
|
||||
I'll design Arcrun as a cohesive 5-screen system. Let me plan and build this as an interactive prototype with all screens navigable.
|
||||
|
||||
_[tool: update_todos]_
|
||||
|
||||
Let me plan the architecture. I'll build a single HTML file with React, using multiple JSX component files, with screen navigation via state.
|
||||
|
||||
Design system note: I'll use Inter, electric indigo #6366F1 primary, #0F0F0F bg, #1A1A1A cards, with subtle indigo→violet gradients on CTAs. Dark, minimal, developer-focused. "Arcrun" wordmark will be original — a stylized "↯" or arc mark paired with the name.
|
||||
|
||||
Let me start building.
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
Now the primitives and chrome components:
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: snip]_
|
||||
|
||||
Now the 5 screens. Let me write them concisely.
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: snip]_
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: snip]_
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: write_file]_
|
||||
|
||||
_[tool: snip]_
|
||||
|
||||
_[tool: update_todos]_
|
||||
|
||||
_[tool: register_assets]_
|
||||
|
||||
_[tool: done]_
|
||||
|
||||
_[tool: snip]_
|
||||
|
||||
_[tool: list_files]_
|
||||
|
||||
The file exists. The error may have been transient. Let me verify by checking the page loads.
|
||||
|
||||
_[tool: show_html]_
|
||||
|
||||
_[tool: snip]_
|
||||
|
||||
_[tool: done]_
|
||||
|
||||
The CSS exists but isn't loading through the preview path. Let me inline it to eliminate the dependency.
|
||||
|
||||
_[tool: read_file]_
|
||||
|
||||
_[tool: run_script]_
|
||||
|
||||
_[tool: snip]_
|
||||
|
||||
_[tool: done]_
|
||||
|
||||
_[tool: fork_verifier_agent]_
|
||||
|
||||
Built **Arcrun** as a cohesive 5-screen dark-mode prototype — Landing, Auth, API Keys, Dashboard, and Workflow Viewer — all navigable via the floating screen switcher at the bottom.
|
||||
|
||||
**Highlights**
|
||||
- **Landing** — hero with grid/glow bg, two-path split (developer terminal w/ npm·pip·bun tabs + Claude-style chat preview showing an Arcrun tool call)
|
||||
- **Auth** — centered card, Sign in / Sign up tabs, GitHub + Google OAuth, email + password
|
||||
- **API Keys** — first-time key callout with copy + hide-again warning, full keys table with live status toggles
|
||||
- **Dashboard** — sidebar shell, 3-col apps grid (+ empty-state card), workflows table below
|
||||
- **Workflow Viewer** — full-bleed dark canvas, 8 connected nodes with left-to-right bezier arrows, selectable with detail panel (I/O schema, editable triplet config for the AI node), minimap + zoom controls, prominent "Edit in Claude" CTA
|
||||
|
||||
Screen state persists in localStorage so reloads land you where you were.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,128 @@
|
||||
const ApiKeys = ({ onNav }) => {
|
||||
const [newKeyCopied, setNewKeyCopied] = React.useState(false);
|
||||
const [keys, setKeys] = React.useState([
|
||||
{ id: 'k_dev', name: 'Local Development', prefix: 'ar_dev_', created: 'Mar 12, 2026', lastUsed: '2 min ago', active: true },
|
||||
{ id: 'k_prod', name: 'Production — Northwind API', prefix: 'ar_live_', created: 'Feb 3, 2026', lastUsed: '12 sec ago', active: true },
|
||||
{ id: 'k_staging', name: 'Staging — Vercel', prefix: 'ar_test_', created: 'Jan 28, 2026', lastUsed: '4 hours ago', active: true },
|
||||
{ id: 'k_ci', name: 'CI/CD (GitHub Actions)', prefix: 'ar_live_', created: 'Jan 10, 2026', lastUsed: 'Yesterday', active: false },
|
||||
{ id: 'k_old', name: 'Legacy — Zapier import', prefix: 'ar_live_', created: 'Nov 4, 2025', lastUsed: '3 weeks ago', active: false, revoked: true },
|
||||
]);
|
||||
|
||||
const newKey = 'ar_live_sk_7x9Qf2vLm8nR4TpW6ZjKc3bEhN1aSyU5oP0dI';
|
||||
|
||||
const copyKey = () => {
|
||||
setNewKeyCopied(true);
|
||||
setTimeout(() => setNewKeyCopied(false), 1800);
|
||||
};
|
||||
|
||||
const toggleKey = (id) => {
|
||||
setKeys(keys.map(k => k.id === id ? { ...k, active: !k.active } : k));
|
||||
};
|
||||
|
||||
return (
|
||||
<div className="shell">
|
||||
<Sidebar current="keys" onNav={onNav} />
|
||||
<div className="main">
|
||||
<div className="main-head">
|
||||
<div>
|
||||
<div className="crumb">
|
||||
<span>Workspace</span>
|
||||
<span className="sep"><Icon name="chevron_right" size={11} /></span>
|
||||
<span>Settings</span>
|
||||
</div>
|
||||
<h1>API Keys</h1>
|
||||
<div className="sub">Scoped credentials for calling the Arcrun API from your code and CI.</div>
|
||||
</div>
|
||||
<div className="flex gap-8">
|
||||
<button className="btn btn-secondary"><Icon name="book" size={14} /> API docs</button>
|
||||
<button className="btn btn-primary"><Icon name="plus" size={14} /> Create new key</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="main-body" style={{maxWidth: 1080}}>
|
||||
<div className="new-key-box">
|
||||
<div className="warn-row">
|
||||
<span className="warn-icon"><Icon name="warn" size={12} /></span>
|
||||
<span><strong style={{color: '#FBBF24'}}>Save this key now.</strong> For security, we won't show it again — if you lose it, you'll need to create a new one.</span>
|
||||
</div>
|
||||
<h3>Your new API key</h3>
|
||||
<p className="desc">Key named <strong style={{color: 'var(--text)'}}>"Production — Northwind API"</strong> · created just now · all scopes</p>
|
||||
<div className="key-display">
|
||||
<span className="key-val">{newKey}</span>
|
||||
<button className={`copy-btn ${newKeyCopied ? 'copied' : ''}`} onClick={copyKey}>
|
||||
<Icon name={newKeyCopied ? 'check' : 'copy'} size={12} />
|
||||
{newKeyCopied ? 'Copied' : 'Copy'}
|
||||
</button>
|
||||
</div>
|
||||
<div style={{marginTop: 14, display: 'flex', gap: 16, fontSize: 12, color: 'var(--text-mute)', alignItems: 'center'}}>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="check" size={12} /> Full workspace access</span>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="clock" size={12} /> Never expires</span>
|
||||
<span style={{marginLeft: 'auto'}}><span className="link">Add expiry or restrict scopes →</span></span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="section-head">
|
||||
<div>
|
||||
<h2>All keys</h2>
|
||||
<div className="subtle" style={{marginTop: 2}}>{keys.filter(k => !k.revoked).length} active · {keys.filter(k => k.revoked).length} revoked</div>
|
||||
</div>
|
||||
<div className="flex gap-8">
|
||||
<button className="btn btn-secondary btn-sm"><Icon name="filter" size={12} /> Filter</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="table-wrap">
|
||||
<table className="table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style={{width: '32%'}}>Name</th>
|
||||
<th>Key</th>
|
||||
<th>Created</th>
|
||||
<th>Last used</th>
|
||||
<th>Status</th>
|
||||
<th style={{width: 60, textAlign: 'right'}}></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{keys.map(k => (
|
||||
<tr key={k.id}>
|
||||
<td>
|
||||
<div style={{fontWeight: 500, fontSize: 13.5}}>{k.name}</div>
|
||||
</td>
|
||||
<td className="mono">{k.prefix}••••{k.id.slice(-4)}</td>
|
||||
<td className="dim" style={{fontSize: 12.5}}>{k.created}</td>
|
||||
<td className="dim" style={{fontSize: 12.5}}>{k.lastUsed}</td>
|
||||
<td>
|
||||
{k.revoked ? (
|
||||
<span className="pill revoked"><span className="pdot" /> Revoked</span>
|
||||
) : (
|
||||
<div className="flex gap-8" style={{alignItems: 'center'}}>
|
||||
<span className={`toggle ${k.active ? 'on' : ''}`} onClick={() => toggleKey(k.id)} />
|
||||
<span className={`pill ${k.active ? 'active' : 'idle'}`}>
|
||||
<span className="pdot" /> {k.active ? 'Active' : 'Paused'}
|
||||
</span>
|
||||
</div>
|
||||
)}
|
||||
</td>
|
||||
<td style={{textAlign: 'right'}}>
|
||||
{!k.revoked && (
|
||||
<button className="btn btn-danger-ghost btn-sm"><Icon name="trash" size={12} /></button>
|
||||
)}
|
||||
</td>
|
||||
</tr>
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div style={{marginTop: 18, fontSize: 12, color: 'var(--text-mute)', display: 'flex', alignItems: 'center', gap: 8}}>
|
||||
<Icon name="warn" size={12} />
|
||||
<span>Revoking a key stops all in-flight requests within 60 seconds. This cannot be undone.</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
window.ApiKeys = ApiKeys;
|
||||
@@ -0,0 +1,90 @@
|
||||
const Auth = ({ onNav }) => {
|
||||
const [mode, setMode] = React.useState('signin');
|
||||
const [email, setEmail] = React.useState('');
|
||||
const [pw, setPw] = React.useState('');
|
||||
const [remember, setRemember] = React.useState(true);
|
||||
|
||||
const submit = (e) => { e.preventDefault(); onNav('dashboard'); };
|
||||
|
||||
return (
|
||||
<div className="auth-wrap">
|
||||
<div className="hero-bg" />
|
||||
<div className="hero-bg-grid" />
|
||||
|
||||
<div style={{position: 'absolute', top: 24, left: 24, zIndex: 2}}>
|
||||
<Logo onClick={() => onNav('landing')} />
|
||||
</div>
|
||||
|
||||
<div className="auth-card">
|
||||
<h2 className="auth-h1">{mode === 'signin' ? 'Welcome back' : 'Create your account'}</h2>
|
||||
<p className="auth-sub">{mode === 'signin' ? 'Sign in to your Arcrun workspace.' : 'Start building AI workflows in minutes.'}</p>
|
||||
|
||||
<div className="tabs">
|
||||
<button className={mode === 'signin' ? 'active' : ''} onClick={() => setMode('signin')}>Sign in</button>
|
||||
<button className={mode === 'signup' ? 'active' : ''} onClick={() => setMode('signup')}>Sign up</button>
|
||||
</div>
|
||||
|
||||
<div className="oauth-row">
|
||||
<button className="oauth-btn github" onClick={() => onNav('dashboard')}>
|
||||
<Icon name="github" size={17} stroke={0} /> Continue with GitHub
|
||||
</button>
|
||||
<button className="oauth-btn google" onClick={() => onNav('dashboard')}>
|
||||
<Icon name="google" size={15} stroke={0} /> Continue with Google
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div className="divider">or continue with email</div>
|
||||
|
||||
<form onSubmit={submit}>
|
||||
{mode === 'signup' && (
|
||||
<div className="field">
|
||||
<label>Full name</label>
|
||||
<input className="input" type="text" placeholder="Maya Rivera" />
|
||||
</div>
|
||||
)}
|
||||
<div className="field">
|
||||
<label>Work email</label>
|
||||
<input className="input" type="email" placeholder="you@company.com" value={email} onChange={e => setEmail(e.target.value)} />
|
||||
</div>
|
||||
<div className="field">
|
||||
<div className="field-row">
|
||||
<label>Password</label>
|
||||
{mode === 'signin' && <span className="link">Forgot password?</span>}
|
||||
</div>
|
||||
<input className="input" type="password" placeholder="••••••••••" value={pw} onChange={e => setPw(e.target.value)} />
|
||||
</div>
|
||||
|
||||
{mode === 'signin' && (
|
||||
<div style={{display: 'flex', alignItems: 'center', gap: 8, fontSize: 12.5, color: 'var(--text-dim)', marginBottom: 14}}>
|
||||
<div onClick={() => setRemember(!remember)}
|
||||
style={{width: 15, height: 15, borderRadius: 4, border: '1px solid var(--line-2)',
|
||||
background: remember ? 'var(--primary)' : 'transparent',
|
||||
display: 'flex', alignItems: 'center', justifyContent: 'center', cursor: 'pointer'}}>
|
||||
{remember && <Icon name="check" size={11} />}
|
||||
</div>
|
||||
<span onClick={() => setRemember(!remember)} style={{cursor: 'pointer'}}>Keep me signed in for 30 days</span>
|
||||
</div>
|
||||
)}
|
||||
|
||||
<button className="btn btn-primary auth-submit btn-lg" type="submit">
|
||||
{mode === 'signin' ? 'Sign in' : 'Create account'} <Icon name="arrow_right" size={14} />
|
||||
</button>
|
||||
</form>
|
||||
|
||||
{mode === 'signup' && (
|
||||
<p style={{fontSize: 11.5, color: 'var(--text-mute)', textAlign: 'center', marginTop: 14, lineHeight: 1.5}}>
|
||||
By signing up, you agree to our <span className="link" style={{fontSize: 11.5}}>Terms</span> and <span className="link" style={{fontSize: 11.5}}>Privacy Policy</span>.
|
||||
</p>
|
||||
)}
|
||||
|
||||
<div className="auth-foot">
|
||||
{mode === 'signin'
|
||||
? <>New to Arcrun? <span className="link" onClick={() => setMode('signup')}>Create an account</span></>
|
||||
: <>Already have an account? <span className="link" onClick={() => setMode('signin')}>Sign in</span></>}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
window.Auth = Auth;
|
||||
@@ -0,0 +1,126 @@
|
||||
const Dashboard = ({ onNav }) => {
|
||||
const apps = [
|
||||
{ id: 'digest', name: 'Weekly Digest', desc: 'Summarize customer activity into a Monday email for the revenue team.', icon: 'mail', tone: 'indigo' },
|
||||
{ id: 'triage', name: 'Support Triage', desc: 'Classify inbound tickets, attach context from the CRM, and route.', icon: 'filter', tone: 'orange' },
|
||||
{ id: 'seo', name: 'SEO Brief Generator', desc: 'Turn a keyword into a draft brief with outline, FAQs, and SERP notes.', icon: 'search', tone: 'green' },
|
||||
{ id: 'slack', name: 'Standup Bot', desc: 'Collect Linear updates and post a tidy engineering standup to Slack.', icon: 'slack', tone: 'pink' },
|
||||
{ id: 'doc', name: 'Docs Sync', desc: 'Keep Notion runbooks in sync with the production API surface.', icon: 'book', tone: 'blue' },
|
||||
];
|
||||
|
||||
const workflows = [
|
||||
{ id: 'digest_weekly', name: 'digest/weekly', nodes: 9, modified: '2 hours ago', runs: '147 runs', status: 'healthy' },
|
||||
{ id: 'triage_inbound', name: 'triage/inbound-email', nodes: 14, modified: 'Yesterday', runs: '2,318 runs', status: 'healthy' },
|
||||
{ id: 'seo_brief', name: 'seo/brief-from-keyword', nodes: 7, modified: '3 days ago', runs: '42 runs', status: 'healthy' },
|
||||
{ id: 'standup', name: 'slack/standup-collector', nodes: 6, modified: '1 week ago', runs: '24 runs', status: 'idle' },
|
||||
{ id: 'docs_sync', name: 'docs/sync-notion', nodes: 11, modified: '2 weeks ago', runs: '8 runs', status: 'failed' },
|
||||
];
|
||||
|
||||
return (
|
||||
<div className="shell">
|
||||
<Sidebar current="dashboard" onNav={onNav} />
|
||||
<div className="main">
|
||||
<div className="main-head">
|
||||
<div>
|
||||
<div className="crumb">
|
||||
<span>Northwind</span>
|
||||
<span className="sep"><Icon name="chevron_right" size={11} /></span>
|
||||
<span>Dashboard</span>
|
||||
</div>
|
||||
<h1>Welcome back, Maya</h1>
|
||||
<div className="sub">5 apps running · 12 workflows · 2,538 runs this week</div>
|
||||
</div>
|
||||
<div className="flex gap-8">
|
||||
<button className="btn btn-secondary"><Icon name="book" size={14} /> Templates</button>
|
||||
<button className="btn btn-primary"><Icon name="plus" size={14} /> New app</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="main-body">
|
||||
{/* Apps grid */}
|
||||
<div className="section-head">
|
||||
<div>
|
||||
<h2>My Apps</h2>
|
||||
<div className="subtle" style={{marginTop: 2}}>Packaged workflows your team can run from chat or code</div>
|
||||
</div>
|
||||
<span className="subtle">{apps.length} apps</span>
|
||||
</div>
|
||||
|
||||
<div className="apps-grid">
|
||||
{apps.map(a => (
|
||||
<div key={a.id} className="app-card">
|
||||
<AppIcon tone={a.tone}><Icon name={a.icon} size={17} /></AppIcon>
|
||||
<h4>{a.name}</h4>
|
||||
<p className="dsc">{a.desc}</p>
|
||||
<div className="row">
|
||||
<a className="open" onClick={() => onNav('workflow')}>Open app <Icon name="arrow_right" size={12} /></a>
|
||||
<button className="chip-btn">
|
||||
<Icon name="spark" size={11} /> Edit in Claude
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
<div className="app-card app-empty">
|
||||
<div className="plus"><Icon name="plus" size={16} /></div>
|
||||
<div style={{fontSize: 13, fontWeight: 500}}>Create new app</div>
|
||||
<div style={{fontSize: 12, opacity: 0.75}}>Start from scratch or template</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Workflows */}
|
||||
<div className="wf-table">
|
||||
<div className="section-head">
|
||||
<div>
|
||||
<h2>My Workflows</h2>
|
||||
<div className="subtle" style={{marginTop: 2}}>The graphs that power your apps</div>
|
||||
</div>
|
||||
<div className="flex gap-8">
|
||||
<button className="btn btn-secondary btn-sm"><Icon name="filter" size={12} /> All workflows</button>
|
||||
<button className="btn btn-secondary btn-sm" onClick={() => onNav('workflow')}><Icon name="plus" size={12} /> New</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="table-wrap">
|
||||
<table className="table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style={{width: '34%'}}>Workflow</th>
|
||||
<th>Nodes</th>
|
||||
<th>Last modified</th>
|
||||
<th>Activity</th>
|
||||
<th>Status</th>
|
||||
<th style={{width: 100, textAlign: 'right'}}></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{workflows.map(w => (
|
||||
<tr key={w.id}>
|
||||
<td>
|
||||
<div className="wf-row-name">
|
||||
<span className="dot" />
|
||||
<span className="mono" style={{fontSize: 13}}>{w.name}</span>
|
||||
</div>
|
||||
</td>
|
||||
<td className="dim">{w.nodes}</td>
|
||||
<td className="dim" style={{fontSize: 12.5}}>{w.modified}</td>
|
||||
<td className="dim" style={{fontSize: 12.5}}>{w.runs}</td>
|
||||
<td>
|
||||
<span className={`pill ${w.status === 'healthy' ? 'active' : w.status === 'failed' ? 'revoked' : 'idle'}`}>
|
||||
<span className="pdot" /> {w.status}
|
||||
</span>
|
||||
</td>
|
||||
<td style={{textAlign: 'right'}}>
|
||||
<button className="btn btn-secondary btn-sm" onClick={() => onNav('workflow')}>View</button>
|
||||
</td>
|
||||
</tr>
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
window.Dashboard = Dashboard;
|
||||
@@ -0,0 +1,168 @@
|
||||
const Landing = ({ onNav }) => {
|
||||
const [installer, setInstaller] = React.useState('npm');
|
||||
const installCmds = {
|
||||
npm: '$ npm install arcrun',
|
||||
pip: '$ pip install arcrun',
|
||||
bun: '$ bun add arcrun',
|
||||
};
|
||||
|
||||
return (
|
||||
<div>
|
||||
<TopNav onNav={onNav} current="landing" />
|
||||
|
||||
<div className="container">
|
||||
<section className="hero">
|
||||
<div className="hero-bg" />
|
||||
<div className="hero-bg-grid" />
|
||||
<div className="hero-eyebrow">
|
||||
<span className="dot" />
|
||||
<span>Now in public beta — MCP-native</span>
|
||||
</div>
|
||||
<h1>Build AI workflows<br/><span className="grad">without the glue code.</span></h1>
|
||||
<p className="sub">Connect your tools, automate your work. Orchestrate workflows from Claude.ai, your IDE, or a few lines of code — Arcrun handles auth, retries, and state.</p>
|
||||
<div className="hero-ctas">
|
||||
<button className="btn btn-primary btn-lg" onClick={() => onNav('auth')}>
|
||||
Start free <Icon name="arrow_right" size={15} />
|
||||
</button>
|
||||
<button className="btn btn-secondary btn-lg">
|
||||
<Icon name="book" size={14} /> Read the docs
|
||||
</button>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section className="paths">
|
||||
{/* Developer path */}
|
||||
<div className="path-card">
|
||||
<div className="path-label">
|
||||
<Icon name="terminal" size={13} /> For Developers
|
||||
</div>
|
||||
<h3>Three lines, any runtime.</h3>
|
||||
<p className="lede">Install once, call Arcrun from Node, Python, or your edge runtime. OAuth, rate limits, and retries are handled.</p>
|
||||
|
||||
<div className="install-tabs">
|
||||
{Object.keys(installCmds).map(k => (
|
||||
<button key={k} className={installer === k ? 'active' : ''} onClick={() => setInstaller(k)}>{k}</button>
|
||||
))}
|
||||
</div>
|
||||
|
||||
<div className="terminal" style={{marginBottom: 12}}>
|
||||
<div className="terminal-head">
|
||||
<div className="dots"><span/><span/><span/></div>
|
||||
<div className="title">terminal</div>
|
||||
</div>
|
||||
<div className="terminal-body">
|
||||
<div><span className="dim">{installCmds[installer]}</span></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="terminal">
|
||||
<div className="terminal-head">
|
||||
<div className="dots"><span/><span/><span/></div>
|
||||
<div className="title">{installer === 'pip' ? 'app.py' : 'app.ts'}</div>
|
||||
</div>
|
||||
<div className="terminal-body">
|
||||
{installer === 'pip' ? (
|
||||
<>
|
||||
<div><span className="c1">from</span> <span className="c2">arcrun</span> <span className="c1">import</span> <span className="c2">Arcrun</span></div>
|
||||
<div className="sp-4"/>
|
||||
<div><span className="c2">client</span> = <span className="c4">Arcrun</span>(<span className="c2">token</span>=<span className="c2">os</span>.<span className="c4">getenv</span>(<span className="c3">"ARCRUN_KEY"</span>))</div>
|
||||
<div><span className="c2">run</span> = <span className="c2">client</span>.<span className="c4">run</span>(<span className="c3">"digest/weekly"</span>, <span className="c2">inputs</span>={'{'}<span className="c3">"user"</span>: <span className="c3">"u_219"</span>{'}'})</div>
|
||||
</>
|
||||
) : (
|
||||
<>
|
||||
<div><span className="c1">import</span> {'{'} <span className="c2">Arcrun</span> {'}'} <span className="c1">from</span> <span className="c3">"arcrun"</span>;</div>
|
||||
<div className="sp-4"/>
|
||||
<div><span className="c1">const</span> <span className="c2">client</span> = <span className="c1">new</span> <span className="c4">Arcrun</span>({'{'} <span className="c2">token</span>: <span className="c2">process</span>.<span className="c2">env</span>.<span className="c2">ARCRUN_KEY</span> {'}'});</div>
|
||||
<div><span className="c1">const</span> <span className="c2">run</span> = <span className="c1">await</span> <span className="c2">client</span>.<span className="c4">run</span>(<span className="c3">"digest/weekly"</span>, {'{'} <span className="c2">user</span>: <span className="c3">"u_219"</span> {'}'});</div>
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="sp-16" />
|
||||
<div className="flex gap-12" style={{fontSize: 12.5, color: 'var(--text-mute)'}}>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="check" size={12} /> Typed SDKs</span>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="check" size={12} /> Idempotent runs</span>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="check" size={12} /> Self-host ready</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Everyone path */}
|
||||
<div className="path-card">
|
||||
<div className="path-label">
|
||||
<Icon name="spark" size={13} /> For Everyone
|
||||
</div>
|
||||
<h3>Talk to your workflows.</h3>
|
||||
<p className="lede">Install Arcrun inside your AI assistant and run your apps by asking. Trigger workflows, fetch data, or draft messages — in plain English.</p>
|
||||
|
||||
<div className="chat-preview">
|
||||
<div className="chat-head">
|
||||
<span className="brand-dot">AI</span>
|
||||
<span>Your assistant — Arcrun connected</span>
|
||||
<span style={{marginLeft: 'auto'}} className="pill active"><span className="pdot" />2 apps</span>
|
||||
</div>
|
||||
<div className="chat-body">
|
||||
<div className="chat-msg user">
|
||||
<div className="avatar">M</div>
|
||||
<div className="bubble">Send this week's customer digest to the revenue team.</div>
|
||||
</div>
|
||||
<div className="chat-msg ai">
|
||||
<div className="avatar">A</div>
|
||||
<div className="bubble">
|
||||
Running <span style={{color: 'var(--primary)', fontWeight: 500}}>digest/weekly</span> for 147 accounts, then posting to #revenue.
|
||||
<div className="tool-card">
|
||||
<div className="tool-icon">AR</div>
|
||||
<div className="tool-meta">
|
||||
<div className="tool-name">arcrun · digest/weekly</div>
|
||||
<div className="tool-sub">4 of 5 steps complete · 00:12 elapsed</div>
|
||||
</div>
|
||||
<span className="pill active"><span className="pdot" />running</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div className="chat-input">
|
||||
<span>Reply to your assistant…</span>
|
||||
<span className="caret" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="sp-16" />
|
||||
<div className="flex gap-12" style={{fontSize: 12.5, color: 'var(--text-mute)'}}>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="check" size={12} /> One-click connect</span>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="check" size={12} /> Works in your IDE</span>
|
||||
<span className="flex gap-6" style={{alignItems: 'center'}}><Icon name="check" size={12} /> Audit trail</span>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section className="strip">
|
||||
<div className="cell">
|
||||
<div className="ico"><Icon name="bolt" size={15} /></div>
|
||||
<h4>Run anywhere</h4>
|
||||
<p>Node, Python, Deno, Bun, Cloudflare Workers. One API, same semantics.</p>
|
||||
</div>
|
||||
<div className="cell">
|
||||
<div className="ico"><Icon name="workflow" size={15} /></div>
|
||||
<h4>Composable steps</h4>
|
||||
<p>Model calls, HTTP, database, branching — wire them visually or in code.</p>
|
||||
</div>
|
||||
<div className="cell">
|
||||
<div className="ico"><Icon name="key" size={15} /></div>
|
||||
<h4>Scoped keys</h4>
|
||||
<p>Per-workflow API keys with fine-grained scopes and live revocation.</p>
|
||||
</div>
|
||||
<div className="cell">
|
||||
<div className="ico"><Icon name="eye" size={15} /></div>
|
||||
<h4>Observable</h4>
|
||||
<p>Every run is replayable. Inspect inputs, outputs, and token usage.</p>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
|
||||
<Footer onNav={onNav} />
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
window.Landing = Landing;
|
||||
@@ -0,0 +1,255 @@
|
||||
const WorkflowViewer = ({ onNav }) => {
|
||||
const nodes = [
|
||||
{ id: 'trigger', x: 60, y: 260, title: 'Weekly Schedule', type: 'trigger', badge: 'CRON', icon: 'clock', tone: '#22C55E',
|
||||
inputs: [], outputs: [{k: 'timestamp', t: 'ISO8601'}, {k: 'runId', t: 'string'}] },
|
||||
{ id: 'fetch', x: 320, y: 140, title: 'Fetch Accounts', type: 'database.query', badge: 'DB', icon: 'database', tone: '#3B82F6',
|
||||
inputs: [{k: 'segment', t: 'string'}], outputs: [{k: 'accounts', t: 'Account[]'}, {k: 'count', t: 'number'}] },
|
||||
{ id: 'events', x: 320, y: 380, title: 'Pull Events', type: 'segment.events', badge: 'API', icon: 'bolt', tone: '#F59E0B',
|
||||
inputs: [{k: 'since', t: 'ISO8601'}], outputs: [{k: 'events', t: 'Event[]'}] },
|
||||
{ id: 'summarize', x: 600, y: 260, title: 'Summarize with Claude', type: 'ai.completion', badge: 'AI', icon: 'spark', tone: '#8B5CF6',
|
||||
inputs: [{k: 'accounts', t: 'Account[]'}, {k: 'events', t: 'Event[]'}, {k: 'prompt', t: 'string'}],
|
||||
outputs: [{k: 'digest', t: 'Digest'}, {k: 'tokens', t: 'number'}] },
|
||||
{ id: 'filter', x: 880, y: 160, title: 'Filter — priority ≥ 2', type: 'logic.filter', badge: 'IF', icon: 'filter', tone: '#64748B',
|
||||
inputs: [{k: 'digest', t: 'Digest'}], outputs: [{k: 'items', t: 'Item[]'}] },
|
||||
{ id: 'slack', x: 1140, y: 100, title: 'Post to #revenue', type: 'slack.message', badge: 'OUT', icon: 'slack', tone: '#EC4899',
|
||||
inputs: [{k: 'channel', t: 'string'}, {k: 'blocks', t: 'Block[]'}], outputs: [{k: 'ts', t: 'string'}] },
|
||||
{ id: 'mail', x: 1140, y: 260, title: 'Email Digest', type: 'mail.send', badge: 'OUT', icon: 'mail', tone: '#6366F1',
|
||||
inputs: [{k: 'to', t: 'string[]'}, {k: 'subject', t: 'string'}, {k: 'html', t: 'string'}], outputs: [{k: 'messageId', t: 'string'}] },
|
||||
{ id: 'log', x: 880, y: 400, title: 'Log run metadata', type: 'arcrun.log', badge: 'LOG', icon: 'terminal', tone: '#475569',
|
||||
inputs: [{k: 'runId', t: 'string'}, {k: 'stats', t: 'Stats'}], outputs: [] },
|
||||
];
|
||||
|
||||
const edges = [
|
||||
['trigger', 'fetch'],
|
||||
['trigger', 'events'],
|
||||
['fetch', 'summarize'],
|
||||
['events', 'summarize'],
|
||||
['summarize', 'filter'],
|
||||
['summarize', 'log'],
|
||||
['filter', 'slack'],
|
||||
['filter', 'mail'],
|
||||
];
|
||||
|
||||
const [selectedId, setSelectedId] = React.useState('summarize');
|
||||
const [title, setTitle] = React.useState('digest/weekly');
|
||||
const [zoom, setZoom] = React.useState(100);
|
||||
|
||||
const selected = nodes.find(n => n.id === selectedId);
|
||||
|
||||
// Edit triplet inline (for the summarize node's prompt config)
|
||||
const [triplet, setTriplet] = React.useState({
|
||||
model: 'claude-haiku-4-5',
|
||||
temperature: '0.3',
|
||||
prompt: 'Summarize this week\'s account activity for the revenue team.',
|
||||
});
|
||||
|
||||
// Measure node widths for edge endpoint accuracy
|
||||
const nodeRefs = React.useRef({});
|
||||
const [sizes, setSizes] = React.useState({});
|
||||
React.useEffect(() => {
|
||||
const ns = {};
|
||||
for (const n of nodes) {
|
||||
const el = nodeRefs.current[n.id];
|
||||
if (el) ns[n.id] = { w: el.offsetWidth, h: el.offsetHeight };
|
||||
}
|
||||
setSizes(ns);
|
||||
}, []);
|
||||
|
||||
const getPort = (id, side) => {
|
||||
const n = nodes.find(x => x.id === id);
|
||||
const sz = sizes[id] || { w: 200, h: 60 };
|
||||
return {
|
||||
x: side === 'out' ? n.x + sz.w : n.x,
|
||||
y: n.y + sz.h / 2,
|
||||
};
|
||||
};
|
||||
|
||||
return (
|
||||
<div className="wf-viewer">
|
||||
<div className="wf-topbar">
|
||||
<div className="back" onClick={() => onNav('dashboard')} title="Back to dashboard">
|
||||
<Icon name="arrow_left" size={16} />
|
||||
</div>
|
||||
<Logo size="sm" onClick={() => onNav('landing')} />
|
||||
<div className="sep" />
|
||||
<div className="wf-breadcrumb">
|
||||
<span className="cr" onClick={() => onNav('dashboard')}>Workflows</span>
|
||||
<Icon name="chevron_right" size={11} />
|
||||
<input
|
||||
className="wf-title mono"
|
||||
value={title}
|
||||
onChange={e => setTitle(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
<span className="wf-saved">
|
||||
<span style={{width: 6, height: 6, borderRadius: '50%', background: '#22C55E', boxShadow: '0 0 0 3px rgba(34,197,94,0.18)'}} />
|
||||
Saved · 2m ago
|
||||
</span>
|
||||
<div className="spacer" />
|
||||
<button className="btn btn-ghost btn-sm"><Icon name="share" size={13} /> Share</button>
|
||||
<button className="btn btn-secondary btn-sm"><Icon name="download" size={13} /> Export YAML</button>
|
||||
<button className="wf-edit-in-claude">
|
||||
<Icon name="spark" size={13} /> Edit in Claude <Icon name="external" size={12} />
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div className="wf-canvas">
|
||||
<svg className="wf-edges" width="100%" height="100%">
|
||||
<defs>
|
||||
<marker id="arrow" viewBox="0 0 10 10" refX="8" refY="5" markerWidth="6" markerHeight="6" orient="auto-start-reverse">
|
||||
<path d="M0,0 L10,5 L0,10 z" fill="#6366F1" />
|
||||
</marker>
|
||||
<marker id="arrow-dim" viewBox="0 0 10 10" refX="8" refY="5" markerWidth="6" markerHeight="6" orient="auto-start-reverse">
|
||||
<path d="M0,0 L10,5 L0,10 z" fill="#3a3a3a" />
|
||||
</marker>
|
||||
</defs>
|
||||
{edges.map(([a, b], i) => {
|
||||
const p1 = getPort(a, 'out');
|
||||
const p2 = getPort(b, 'in');
|
||||
const dx = Math.max(40, (p2.x - p1.x) * 0.5);
|
||||
const d = `M ${p1.x} ${p1.y} C ${p1.x + dx} ${p1.y}, ${p2.x - dx} ${p2.y}, ${p2.x - 2} ${p2.y}`;
|
||||
const highlight = a === selectedId || b === selectedId;
|
||||
return (
|
||||
<path key={i} d={d}
|
||||
stroke={highlight ? '#6366F1' : '#3a3a3a'}
|
||||
strokeWidth={highlight ? 2 : 1.5}
|
||||
fill="none"
|
||||
markerEnd={`url(#${highlight ? 'arrow' : 'arrow-dim'})`}
|
||||
opacity={highlight ? 0.95 : 0.6} />
|
||||
);
|
||||
})}
|
||||
</svg>
|
||||
|
||||
<div className="wf-nodes">
|
||||
{nodes.map(n => (
|
||||
<div key={n.id}
|
||||
ref={el => (nodeRefs.current[n.id] = el)}
|
||||
className={`wf-node ${selectedId === n.id ? 'selected' : ''}`}
|
||||
style={{left: n.x, top: n.y}}
|
||||
onClick={() => setSelectedId(n.id)}>
|
||||
{n.inputs.length > 0 && <span className="port in" />}
|
||||
{n.outputs.length > 0 && <span className="port out" />}
|
||||
<div className="node-row-top">
|
||||
<span className="node-icon" style={{background: n.tone}}>
|
||||
<Icon name={n.icon} size={12} />
|
||||
</span>
|
||||
<span className="node-title">{n.title}</span>
|
||||
<span className="node-badge">{n.badge}</span>
|
||||
</div>
|
||||
<div className="node-sub">{n.type}</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
|
||||
{/* Detail panel */}
|
||||
{selected && (
|
||||
<div className="wf-detail">
|
||||
<div className="dt-head">
|
||||
<span className="dt-icon" style={{background: selected.tone}}>
|
||||
<Icon name={selected.icon} size={15} />
|
||||
</span>
|
||||
<div className="dt-meta">
|
||||
<h3>{selected.title}</h3>
|
||||
<div className="dt-type">{selected.type}</div>
|
||||
</div>
|
||||
<button className="close-btn" onClick={() => setSelectedId(null)}>
|
||||
<Icon name="close" size={14} />
|
||||
</button>
|
||||
</div>
|
||||
<div className="dt-body">
|
||||
<div className="dt-section">
|
||||
<h4>Input schema</h4>
|
||||
{selected.inputs.length === 0 ? (
|
||||
<div style={{fontSize: 12, color: 'var(--text-mute)', fontStyle: 'italic'}}>No inputs — this is a trigger.</div>
|
||||
) : selected.inputs.map(f => (
|
||||
<div key={f.k} className="schema-field">
|
||||
<span className="k">{f.k}</span>
|
||||
<span className="t">{f.t}</span>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
|
||||
<div className="dt-section">
|
||||
<h4>Output schema</h4>
|
||||
{selected.outputs.length === 0 ? (
|
||||
<div style={{fontSize: 12, color: 'var(--text-mute)', fontStyle: 'italic'}}>No outputs — terminal node.</div>
|
||||
) : selected.outputs.map(f => (
|
||||
<div key={f.k} className="schema-field">
|
||||
<span className="k">{f.k}</span>
|
||||
<span className="t">{f.t}</span>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
|
||||
{selected.id === 'summarize' && (
|
||||
<div className="dt-section">
|
||||
<h4>Configuration</h4>
|
||||
<div className="triplet">
|
||||
<div className="trow">
|
||||
<div className="tkey">model</div>
|
||||
<input className="tval" value={triplet.model} onChange={e => setTriplet({...triplet, model: e.target.value})} />
|
||||
</div>
|
||||
<div className="trow">
|
||||
<div className="tkey">temp</div>
|
||||
<input className="tval" value={triplet.temperature} onChange={e => setTriplet({...triplet, temperature: e.target.value})} />
|
||||
</div>
|
||||
<div className="trow">
|
||||
<div className="tkey">prompt</div>
|
||||
<input className="tval" value={triplet.prompt} onChange={e => setTriplet({...triplet, prompt: e.target.value})} />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
<div className="dt-section">
|
||||
<h4>Last run</h4>
|
||||
<div style={{display: 'grid', gridTemplateColumns: '1fr 1fr', gap: 8, fontSize: 12}}>
|
||||
<div style={{background: 'rgba(255,255,255,0.02)', border: '1px solid var(--line)', borderRadius: 7, padding: '8px 10px'}}>
|
||||
<div style={{color: 'var(--text-mute)', fontSize: 10.5, textTransform: 'uppercase', letterSpacing: '0.06em'}}>Duration</div>
|
||||
<div style={{fontFamily: 'JetBrains Mono, monospace', marginTop: 3}}>2.4s</div>
|
||||
</div>
|
||||
<div style={{background: 'rgba(255,255,255,0.02)', border: '1px solid var(--line)', borderRadius: 7, padding: '8px 10px'}}>
|
||||
<div style={{color: 'var(--text-mute)', fontSize: 10.5, textTransform: 'uppercase', letterSpacing: '0.06em'}}>Status</div>
|
||||
<div style={{marginTop: 2}}><span className="pill active"><span className="pdot" />success</span></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<button className="btn btn-primary" style={{width: '100%', marginTop: 4}}>
|
||||
<Icon name="spark" size={13} /> Edit this node in Claude
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{/* Minimap */}
|
||||
<div className="wf-minimap">
|
||||
<div className="mini-label">Overview</div>
|
||||
{nodes.map(n => {
|
||||
const sz = sizes[n.id] || {w: 180, h: 60};
|
||||
return (
|
||||
<div key={n.id} className="mini-box" style={{
|
||||
left: 8 + (n.x / 1400) * 164,
|
||||
top: 18 + (n.y / 500) * 80,
|
||||
width: Math.max(6, (sz.w / 1400) * 164),
|
||||
height: Math.max(4, (sz.h / 500) * 80),
|
||||
opacity: selectedId === n.id ? 1 : 0.5,
|
||||
background: selectedId === n.id ? 'var(--primary)' : 'var(--primary-soft)',
|
||||
}} />
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
|
||||
{/* Zoom controls */}
|
||||
<div className="wf-controls">
|
||||
<button onClick={() => setZoom(Math.max(40, zoom - 10))}><Icon name="zoom_out" size={13} /></button>
|
||||
<div className="zoom-val">{zoom}%</div>
|
||||
<button onClick={() => setZoom(Math.min(200, zoom + 10))}><Icon name="zoom_in" size={13} /></button>
|
||||
<button><Icon name="maximize" size={13} /></button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
window.WorkflowViewer = WorkflowViewer;
|
||||
@@ -0,0 +1,300 @@
|
||||
# Frontend Redesign — Design
|
||||
|
||||
> 讀此檔前請先讀 `requirements.md` 和 `design-source/index.html`。
|
||||
> 視覺 spec 的 single source of truth 是 `design-source/`（Claude Design 匯出的 HTML/JSX prototype）。
|
||||
|
||||
---
|
||||
|
||||
## 1. 架構總覽
|
||||
|
||||
```
|
||||
landing/ (Next.js 15 App Router)
|
||||
├── app/
|
||||
│ ├── layout.tsx ← 全站 layout：next/font + design tokens + 全域 CSS 匯入
|
||||
│ ├── globals.css ← 匯入 design-tokens.css；Tailwind @import
|
||||
│ ├── design-tokens.css ← 新增：從 design-source 抽出的 CSS variables（:root {...}）
|
||||
│ ├── page.tsx ← Landing（RSC）
|
||||
│ ├── auth/
|
||||
│ │ └── page.tsx ← Auth（"use client"）
|
||||
│ ├── dashboard/
|
||||
│ │ └── page.tsx ← Dashboard（"use client"，仍靠 middleware 保護）
|
||||
│ ├── keys/
|
||||
│ │ └── page.tsx ← API Keys（"use client"）
|
||||
│ ├── workflows/
|
||||
│ │ ├── page.tsx ← Workflows 清單（redirect 到 dashboard 的 table，本身極簡）
|
||||
│ │ └── [name]/page.tsx ← Workflow Viewer（"use client"）
|
||||
│ ├── integrations/page.tsx ← 保留現有
|
||||
│ ├── api-docs/page.tsx ← 保留現有
|
||||
│ └── login/page.tsx ← 保留現有（redirect /auth 同義；見 §9 遷移策略）
|
||||
├── components/
|
||||
│ ├── shell/
|
||||
│ │ ├── Logo.tsx
|
||||
│ │ ├── Icon.tsx
|
||||
│ │ ├── TopNav.tsx
|
||||
│ │ ├── Footer.tsx
|
||||
│ │ └── Sidebar.tsx
|
||||
│ ├── primitives/
|
||||
│ │ ├── Button.tsx ← btn / btn-primary / btn-secondary / btn-ghost 對應 class
|
||||
│ │ ├── Pill.tsx
|
||||
│ │ ├── Toggle.tsx
|
||||
│ │ ├── Terminal.tsx ← landing hero 右卡用
|
||||
│ │ └── ChatPreview.tsx ← landing hero 右卡用
|
||||
│ └── workflow/
|
||||
│ ├── Canvas.tsx ← wf-viewer 本體（節點 + SVG edges）
|
||||
│ ├── NodeCard.tsx
|
||||
│ ├── DetailPanel.tsx
|
||||
│ ├── Minimap.tsx
|
||||
│ └── ZoomControls.tsx
|
||||
├── lib/
|
||||
│ ├── api.ts ← typed fetch wrapper（fetch ${API_BASE}${path}, credentials: 'include'）
|
||||
│ ├── workflows.ts ← listWorkflows / getWorkflow / getWorkflowYaml
|
||||
│ ├── apiKeys.ts ← listKeys / createKey / patchKey / deleteKey
|
||||
│ └── me.ts ← 已存在邏輯，集中到此
|
||||
├── middleware.ts ← 擴展 matcher（加 /keys, /workflows/*）
|
||||
└── ...（既有 package.json / wrangler.toml 不變）
|
||||
```
|
||||
|
||||
**路由對照設計稿的 5 screen**：
|
||||
|
||||
| Screen | Route |
|
||||
|---|---|
|
||||
| Landing | `/` |
|
||||
| Auth | `/auth`（新增；`/login` 保留並內部 `redirect('/auth')`） |
|
||||
| Dashboard | `/dashboard` |
|
||||
| API Keys | `/keys` |
|
||||
| Workflow Viewer | `/workflows/[name]` |
|
||||
|
||||
---
|
||||
|
||||
## 2. Design tokens 對應
|
||||
|
||||
設計稿所有 CSS 變數抄進 `app/design-tokens.css`，**不解析、不改名**：
|
||||
|
||||
```css
|
||||
:root {
|
||||
--bg: #0F0F0F;
|
||||
--bg-1: #141414;
|
||||
--card: #1A1A1A;
|
||||
--card-2: #222222;
|
||||
--line: #262626;
|
||||
--line-2: #303030;
|
||||
--text: #EDEDED;
|
||||
--text-dim: #A0A0A0;
|
||||
--text-mute: #6B6B6B;
|
||||
--primary: #6366F1;
|
||||
--primary-2: #8B5CF6;
|
||||
--primary-soft: rgba(99, 102, 241, 0.12);
|
||||
--primary-ring: rgba(99, 102, 241, 0.32);
|
||||
--success: #22C55E;
|
||||
--warn: #F59E0B;
|
||||
--danger: #EF4444;
|
||||
--gradient: linear-gradient(135deg, #6366F1 0%, #8B5CF6 100%);
|
||||
--gradient-soft: linear-gradient(135deg, rgba(99,102,241,0.16) 0%, rgba(139,92,246,0.16) 100%);
|
||||
}
|
||||
```
|
||||
|
||||
並在 Tailwind v4 的 `@theme inline` block 內對應出：
|
||||
|
||||
```css
|
||||
@theme inline {
|
||||
--color-bg: var(--bg);
|
||||
--color-card: var(--card);
|
||||
--color-card-2: var(--card-2);
|
||||
--color-line: var(--line);
|
||||
--color-line-2: var(--line-2);
|
||||
--color-text: var(--text);
|
||||
--color-text-dim: var(--text-dim);
|
||||
--color-text-mute: var(--text-mute);
|
||||
--color-primary: var(--primary);
|
||||
--color-primary-2: var(--primary-2);
|
||||
}
|
||||
```
|
||||
|
||||
這樣 JSX 裡可用 `bg-bg / text-text-dim / border-line`，又保留 CSS 變數語義。
|
||||
|
||||
**現有的 `--background: #0a0a0a` 要換成 `#0F0F0F`**（視覺 breaking change；受影響：所有沿用 `bg-[#0a0a0a]` 的 inline 值）。
|
||||
|
||||
---
|
||||
|
||||
## 3. 字型
|
||||
|
||||
```tsx
|
||||
// app/layout.tsx
|
||||
import { Inter, JetBrains_Mono } from 'next/font/google';
|
||||
|
||||
const inter = Inter({
|
||||
subsets: ['latin'],
|
||||
variable: '--font-inter',
|
||||
weight: ['300', '400', '500', '600', '700', '800'],
|
||||
});
|
||||
const mono = JetBrains_Mono({
|
||||
subsets: ['latin'],
|
||||
variable: '--font-mono',
|
||||
weight: ['400', '500', '600'],
|
||||
});
|
||||
|
||||
// body class = `${inter.variable} ${mono.variable}`
|
||||
```
|
||||
|
||||
`globals.css` 中的 `body { font-family: var(--font-inter), -apple-system, sans-serif; }`，`.mono` class 用 `font-family: var(--font-mono)`。
|
||||
|
||||
**移除**：
|
||||
- `design-source/index.html` 第 7-9 行的 `<link rel="preconnect"> / <link href="fonts.googleapis.com">`（不寫入 production）。
|
||||
- React / Babel standalone script 標籤（prototype 專用，不進 production）。
|
||||
|
||||
---
|
||||
|
||||
## 4. 元件 porting 規則
|
||||
|
||||
Claude Design 用了 `window.Icon / window.Logo / window.AppIcon / window.TopNav ...` 的 globals 風格 — 那是 prototype 專用。Port 到 Next.js 時：
|
||||
|
||||
1. 每個元件拆單檔、具名 export。
|
||||
2. 用 Tailwind + `className` 模板字串；共用 variant（如 btn）用 `cva`-style helper 即可（自己寫 5 行的 `clsx`-alike 函式），**不引入 class-variance-authority / clsx 套件**（避免新依賴）。
|
||||
3. Icon 的 `paths` 直接搬，但每個 icon 拆成自己的 functional component 或集中在一個 `<Icon name="..." />`（沿用 design source 的 pattern）。
|
||||
4. SVG arc wordmark 的 logo 直接 port。
|
||||
|
||||
---
|
||||
|
||||
## 5. 各 screen 實作細節
|
||||
|
||||
### 5.1 Landing — `app/page.tsx`
|
||||
|
||||
- 結構：`<TopNav />` + `<Hero />` + `<Paths />` + `<Strip />` + `<Footer />`。
|
||||
- Hero：heading、eyebrow、CTA、radial grid bg（純 CSS）。
|
||||
- Paths 左卡（Developer）：install tabs (`npm` / `pip` / `bun`) + 兩個 terminal block；**code 範例用 dogfooding 範例**（`acr` CLI），不留 `Arcrun` SDK 假 API。
|
||||
- Paths 右卡（Everyone）：chat preview 結構保留；assistant 對話中的 tool call 用「arcrun · digest/weekly」不動。
|
||||
- Strip：4 cell。
|
||||
- `LandingClientTabs` 因為有 tabs state，需標 `"use client"`；外層保持 RSC。
|
||||
|
||||
### 5.2 Auth — `app/auth/page.tsx`
|
||||
|
||||
- `"use client"`。state：`mode: 'signin' | 'signup'`, `email`, `pw`, `remember`。
|
||||
- Submit：`fetch(${API_BASE}/auth/password-login, { method: 'POST', credentials: 'include' })`（**若 cypher-executor 尚未支援 password auth，先顯示「Password 登入尚未開放，請用 OAuth」警示，不偽造成功流程**）。
|
||||
- OAuth 按鈕：直接 `<a href={API_BASE}/auth/google/start?redirect=/dashboard>`，和現行 `/login` 同樣機制。
|
||||
- 下標提示「By signing up, you agree to our Terms ...」保留 static 字串。
|
||||
- 保留 `/login` 路由向後相容（RSC 裡 `redirect('/auth')`）。
|
||||
|
||||
### 5.3 Dashboard — `app/dashboard/page.tsx`
|
||||
|
||||
- `"use client"` 或 split（外層 RSC 抓 /me，內層 Client）。
|
||||
- 由 `<Sidebar current="dashboard" />` + main。
|
||||
- 主要區塊：
|
||||
- Main head：breadcrumb「{email 的 domain} › Dashboard」、heading「Welcome back, {display_name}」、subtitle 顯示 app/workflow 總數（從 `/apps` + `/workflows` 計算；若 endpoint 404 → 顯示 `—`）。
|
||||
- Apps Grid：`/apps` 的結果渲染；每列永遠有一個 `app-empty` 卡（新建 CTA）。
|
||||
- Workflows Table：`/workflows` 的結果渲染；空時改為全寬「No workflows yet. Run `acr push` to add one.」內嵌指令框。
|
||||
- 「Open app」「View」按鈕導向 `/workflows/[name]`。
|
||||
- 「Edit in Claude」按鈕本次不做動作，僅保 UI（disabled + tooltip「Coming soon」）。
|
||||
|
||||
### 5.4 API Keys — `app/keys/page.tsx`
|
||||
|
||||
- `"use client"`。
|
||||
- Fetch `/api-keys`：若回傳為空陣列但 `/me` 有 api_key，fallback 顯示 `/me.api_key` 為唯一一列（單 key 相容模式）。
|
||||
- 頂部 new-key-box：只在「剛剛建立新 key」的一次性狀態顯示（`useState` + `sessionStorage` flag，reload 後消失）。
|
||||
- 表格、toggle、trash：對應 PATCH / DELETE。
|
||||
- 「Create new key」按鈕：呼叫 `POST /api-keys`，拿到後打 highlight box。
|
||||
- Revoke 警告文字維持設計稿「within 60 seconds」。
|
||||
|
||||
### 5.5 Workflow Viewer — `app/workflows/[name]/page.tsx`
|
||||
|
||||
- `"use client"`，param `name` 來自動態路由。
|
||||
- Mount 後呼叫 `GET /workflows/:name`：後端回傳 `{ name, nodes: Node[], edges: Edge[], yaml, last_run: {...} }`（若 endpoint 未實作 → 顯示「Workflow viewer 尚未啟用」empty state，不用假資料）。
|
||||
- `<Canvas>` 內：
|
||||
- SVG 的 `<marker>`, `<path>` 定義抄設計稿。
|
||||
- Node 用絕對定位（x/y 直接用 API 資料；資料沒有 coord 時做自動 layout — 階段性做簡單 dagre-free 的「column by depth」排版，避免新依賴）。
|
||||
- 點選節點 → 右側 detail panel 顯示 input/output schema；若 type 含 `ai.*`，顯示 triplet 編輯器（model / temp / prompt）— 編輯本次 **read-only**（disabled input + 「Edit via acr CLI」提示）。
|
||||
- 「Export YAML」按 `GET /workflows/:name/yaml` → `download` blob。
|
||||
- 「Edit in Claude」：本次只開新 tab 到 `https://claude.ai/new?q=...`（文案「coming soon」按鈕），避免偽裝已整合。
|
||||
- Zoom controls、minimap：純 UI，`zoom` state 實際不套 transform（或簡單 `style={{ transform: scale(zoom/100) }}` 套在 `.wf-nodes` + svg）。
|
||||
|
||||
---
|
||||
|
||||
## 6. API wrapper（`lib/api.ts`）
|
||||
|
||||
```ts
|
||||
export const API_BASE = process.env.NEXT_PUBLIC_API_BASE ?? 'https://cypher.arcrun.dev';
|
||||
|
||||
export async function arcrunFetch<T>(path: string, init: RequestInit = {}): Promise<T> {
|
||||
const res = await fetch(`${API_BASE}${path}`, {
|
||||
credentials: 'include',
|
||||
headers: { 'Accept': 'application/json', ...(init.headers ?? {}) },
|
||||
...init,
|
||||
});
|
||||
if (res.status === 401 && typeof window !== 'undefined') {
|
||||
window.location.href = `/auth?redirect=${encodeURIComponent(location.pathname)}`;
|
||||
throw new Error('unauthenticated');
|
||||
}
|
||||
if (!res.ok) throw new Error(`arcrun ${path}: ${res.status}`);
|
||||
return res.json() as Promise<T>;
|
||||
}
|
||||
```
|
||||
|
||||
所有頁面透過這個 wrapper。**禁止在 page.tsx 裡 hard-code `fetch('https://...')`**（測試可以 grep）。
|
||||
|
||||
---
|
||||
|
||||
## 7. Middleware
|
||||
|
||||
```ts
|
||||
export const config = {
|
||||
matcher: ['/dashboard/:path*', '/keys/:path*', '/workflows/:path*'],
|
||||
};
|
||||
```
|
||||
|
||||
現有邏輯（讀 `arcrun_session` cookie，沒有就 redirect `/login?redirect=...`）保留，`/login` 改為內部 redirect `/auth`。
|
||||
|
||||
---
|
||||
|
||||
## 8. 不做的設計稿功能
|
||||
|
||||
| 設計元素 | 取捨 |
|
||||
|---|---|
|
||||
| 底部的 `proto-switch`（5 個 screen 切換 pill） | **刪**。那是 prototype 用的 demo 切換器，不進 production。 |
|
||||
| Sidebar 的 `count` badge | 先保留；數字從 `/workflows` / `/apps` 的長度派生；無資料時藏起來。 |
|
||||
| Sidebar bottom 的 avatar + "Maya Rivera / maya@northwind.co" | 換成 `{display_name} / {email}`（真資料）。 |
|
||||
| Workflow Viewer 的 triplet 可編輯 | 本次 disabled，僅顯示。 |
|
||||
| 「Edit in Claude」整合 | 按鈕保留，點擊開新 tab 到 claude.ai，不串 MCP/API。 |
|
||||
| 多 workspace breadcrumb | 固定顯示用戶 email domain 或「Personal」。 |
|
||||
|
||||
---
|
||||
|
||||
## 9. 既有頁面遷移
|
||||
|
||||
| 既有 | 處理 |
|
||||
|---|---|
|
||||
| `/page.tsx` | **rewrite**：沿用設計稿結構，code demo 字串改為 `acr` 實際指令（現有的 `auth.bind(...)` 寫法可保留在 Python tab） |
|
||||
| `/login` | 改為 `redirect('/auth')`（Next.js RSC redirect），保留舊連結相容 |
|
||||
| `/dashboard` | **rewrite**：舊 dashboard 變成 API Keys 獨立頁 + 新 Dashboard 總覽。原本 dashboard 裡的 Key 卡片搬到 `/keys`。 |
|
||||
| `/api-docs` | 不動 |
|
||||
| `/integrations` | 不動；在 Dashboard Apps Grid 旁提供 link |
|
||||
|
||||
---
|
||||
|
||||
## 10. 開發順序（高度相依）
|
||||
|
||||
見 `tasks.md`。總則：
|
||||
|
||||
1. 先做 design tokens + shell（Logo / Icon / Button / Sidebar / TopNav / Footer） — 其他頁面都吃這些。
|
||||
2. 然後 Landing（可直接驗證視覺基準）。
|
||||
3. 然後 Auth（獨立）。
|
||||
4. 然後 API Keys（後端依賴少）。
|
||||
5. 然後 Dashboard（依賴 `/workflows` + `/apps`，若未實作先 empty state）。
|
||||
6. 最後 Workflow Viewer（依賴最重，多 endpoint）。
|
||||
|
||||
---
|
||||
|
||||
## 11. 風險與未解
|
||||
|
||||
| 風險 | 緩解 |
|
||||
|---|---|
|
||||
| cypher-executor 尚未有 `/workflows`, `/apps`, `/api-keys` CRUD | 前端先做，統一走 404 → empty state；另開 task 去 cypher-executor SDD 增補。本次 SDD 不負責後端實作。 |
|
||||
| Password auth 沒實作 | Auth 頁 email/password form 在 submit 時顯示「OAuth only」提示 |
|
||||
| `acr push` 未記錄 node 座標 | Canvas 自動排版（by topological depth），不強制 YAML 載入 layout |
|
||||
| `next-on-pages` 對 `"use client"` 大量頁面的 edge runtime 支援 | 本來就用 `next-on-pages`，問題不大；必要時 per-page `export const runtime = 'edge'` |
|
||||
| 舊 `/dashboard` 的 bookmark 使用者 | 現行 `/dashboard` 的 Key 管理被搬走；保留 Key 區塊 + 顯示提示「New page: /keys」引導 |
|
||||
|
||||
---
|
||||
|
||||
## 12. 與封測的關係
|
||||
|
||||
此 SDD 的實作**不解除封測阻擋**（封測阻擋在 Credential Primitives WASM）。此重設計與 Phase 0.6 / 0.7 / 1-3 是並行軌道。richblack 可決定先後順序，但本 SDD 獨立可 ship。
|
||||
|
||||
@@ -0,0 +1,159 @@
|
||||
# Frontend Redesign — Requirements
|
||||
|
||||
> 來源：Claude Design bundle `JAdpACs3cSyw_vN6Ketj1Q`（已歸檔於 `design-source/`）。
|
||||
> 此 SDD 擴展 `../landing-page.md` 的範圍：landing 從「單頁 + OAuth + Dashboard」升級為「5 screen app shell」。
|
||||
|
||||
---
|
||||
|
||||
## 1. 背景
|
||||
|
||||
`arcrun/landing/` 目前只提供：
|
||||
|
||||
- `/` — Landing hero + code demo
|
||||
- `/login` — Google / GitHub OAuth
|
||||
- `/dashboard` — API Key 管理
|
||||
- `/api-docs` — Swagger UI（外部）
|
||||
- `/integrations` — 20 個 recipe 靜態清單
|
||||
|
||||
Claude Design 交付一套完整 5 screen 設計（Landing / Auth / API Keys / Dashboard / Workflow Viewer），與現有前端相比多了：
|
||||
|
||||
- **Dashboard 的 Apps Grid 與 Workflows Table**（現在沒有應用/workflow 清單 UI）
|
||||
- **API Keys 獨立頁**（現在和 dashboard 混在一起）
|
||||
- **Workflow Viewer**：node-based canvas，對應 YAML workflow 的視覺化（目前 acr push YAML 後只有 CLI 輸出）
|
||||
|
||||
---
|
||||
|
||||
## 2. User Stories
|
||||
|
||||
### US-1：新訪客認識 arcrun
|
||||
- 作為沒用過 arcrun 的工程師，我要在 landing 看到兩條路（For Developers / For Everyone），5 秒內判斷這是否符合我要的用法。
|
||||
- 驗收：hero + 雙 path card + feature strip 在首屏呈現；CTA「Start free」可點擊到 `/auth`。
|
||||
|
||||
### US-2：取得 / 登入會員
|
||||
- 作為訪客，我要用 GitHub / Google / Email 登入建立帳號。
|
||||
- 驗收：`/auth` 支援 Sign in / Sign up tabs、GitHub + Google OAuth、Email + Password 表單。OAuth 成功後導向 `/dashboard`。
|
||||
|
||||
### US-3：看見應用全貌
|
||||
- 作為已登入用戶，我要在 Dashboard 看到我已部署的 App（packaged workflow）和 Workflow 清單。
|
||||
- 驗收：
|
||||
- Apps Grid：每個 app 卡片顯示名稱、描述、「Open app」「Edit in Claude」。
|
||||
- Workflows Table：顯示 workflow 名稱、節點數、最後修改、執行次數、狀態。
|
||||
- 若 app / workflow 為空，顯示新建 CTA（非硬編 mock）。
|
||||
|
||||
### US-4：管理 API Keys
|
||||
- 作為已登入用戶，我要建立、檢視、停用、刪除 API Key。
|
||||
- 驗收：
|
||||
- 剛產生的 Key 顯示在頂部高亮卡片（含警示文字「不會再顯示」）。
|
||||
- 全部 Keys 在下方表格顯示（名稱、遮蔽後 key、建立時間、最後使用、狀態、toggle、trash）。
|
||||
- Rotate / Revoke 立即生效（呼叫 cypher-executor）。
|
||||
|
||||
### US-5：檢視 Workflow graph
|
||||
- 作為已登入用戶，我要點 workflow 進到 viewer，看到節點 DAG 與每個節點的 I/O schema 與參數。
|
||||
- 驗收：
|
||||
- Canvas 顯示節點（含 icon / type badge），節點以 bezier 曲線相連。
|
||||
- 選中節點後右側面板顯示 input / output schema、configuration（針對 ai.completion 等節點顯示 triplet 編輯器）。
|
||||
- 工具列含 Share / Export YAML / Edit in Claude。
|
||||
- Minimap + zoom 控制顯示可用。
|
||||
- 「Export YAML」呼叫 cypher-executor 取得該 workflow 的原始 YAML。
|
||||
|
||||
### US-6：Dogfooding
|
||||
- 作為 arcrun 核心維護者，我要前端所有與服務打交道的動作都透過 arcrun 自家 API（cypher-executor）完成，不依賴第三方 OAuth / workflow / backend 服務。
|
||||
- 驗收（見 §6）。
|
||||
|
||||
---
|
||||
|
||||
## 3. 非功能需求
|
||||
|
||||
| 項目 | 規範 |
|
||||
|---|---|
|
||||
| 技術棧 | Next.js 15 App Router、React 19、Tailwind v4、TypeScript（沿用 `landing/` 現有堆疊） |
|
||||
| 部署 | Cloudflare Pages（`@cloudflare/next-on-pages`），沿用 `landing/wrangler.toml` |
|
||||
| 字型 | Inter、JetBrains Mono — 用 `next/font/google`，不拉 unpkg / fonts.googleapis.com `<link>` |
|
||||
| 依賴 | 僅 Next / React / Tailwind；禁止 tRPC、React Query、SWR、Auth.js/Clerk、ReactFlow/XYFlow、Radix、shadcn CLI install、animation library（framer-motion）等第三方 |
|
||||
| 狀態管理 | React 內建（useState / useReducer / Context）；持久化用 `localStorage` 或 server session cookie |
|
||||
| 國際化 | 延後；本次一律英文（與設計稿一致）。現有 `?lang=zh` 不擴展 |
|
||||
| 無障礙 | 按鈕 `aria-label`、Form 控件有 `<label>`；鍵盤可完成登入 / 複製 key 流程 |
|
||||
| 效能 | Landing 首屏無阻塞 JS（RSC）；Dashboard / Workflow Viewer 可為 Client Component |
|
||||
|
||||
---
|
||||
|
||||
## 4. 視覺基準
|
||||
|
||||
| 項目 | 值（source of truth：`design-source/index.html` 的 CSS 變數） |
|
||||
|---|---|
|
||||
| 主背景 | `#0F0F0F`（現有是 `#0a0a0a` — 本次改為 `#0F0F0F`） |
|
||||
| Card | `#1A1A1A` |
|
||||
| Line | `#262626` / `#303030` |
|
||||
| Primary | `#6366F1`（indigo） → `#8B5CF6`（violet）漸層 |
|
||||
| Text | `#EDEDED` / dim `#A0A0A0` / mute `#6B6B6B` |
|
||||
| 字型 | Inter 300/400/500/600/700/800；Mono 400/500/600 |
|
||||
|
||||
---
|
||||
|
||||
## 5. 範圍界線
|
||||
|
||||
### 納入
|
||||
- 5 screen（Landing、Auth、Dashboard、API Keys、Workflow Viewer）
|
||||
- Logo（SVG arc wordmark）、Icon set（inline SVG，從 primitives.jsx port）
|
||||
- TopNav / Footer / Sidebar 三個 shell 元件
|
||||
|
||||
### 不納入（本次 SDD）
|
||||
- **Multi-tenant workspace 切換**（設計稿有 "Northwind" breadcrumb，本次純顯示用戶 email）
|
||||
- **Multi-API-key CRUD 後端**（cypher-executor 現只支援每帳號一把 key，多 key table 先以「目前只支援一把」狀態呈現 — 見 §6.2）
|
||||
- **Workflow 編輯**（只做 read-only viewer；編輯仍走 acr CLI / YAML）
|
||||
- **即時執行狀態 stream**（minimap / zoom 僅 UI，不做真實 pan-zoom transform）
|
||||
- **i18n 中英切換**、**Hall of Fame**、**Donate**
|
||||
- **Swagger UI 頁（/api-docs）** — 保留現狀
|
||||
|
||||
---
|
||||
|
||||
## 6. API 依賴（全部打 `cypher.arcrun.dev`）
|
||||
|
||||
### 6.1 既有（已實作於 cypher-executor）
|
||||
- `GET /me` — 取得登入用戶 + api_key（driver：dashboard 側欄 avatar / API Keys 頁的單把 key）
|
||||
- `PUT /me/api-key/rotate`、`DELETE /me/api-key` — Rotate / Revoke
|
||||
- `GET /auth/google/start`、`GET /auth/github/start` — OAuth 起點
|
||||
- `POST /auth/logout`
|
||||
- `POST /webhooks/named/{name}/trigger` — 觸發（給 Landing 文案展示）
|
||||
|
||||
### 6.2 需新增的 endpoint（阻擋項；**本 SDD 只定義契約，cypher-executor 實作歸屬於另一個 task**）
|
||||
|
||||
| Method | Path | 說明 | 用途 |
|
||||
|---|---|---|---|
|
||||
| GET | `/workflows` | 列出當前 api_key 名下的 workflow（名稱、nodes、modified、run_count、status） | Dashboard / Workflows Table |
|
||||
| GET | `/workflows/:name` | 取得 workflow 詳細（含 graph 節點 + edges + YAML） | Workflow Viewer |
|
||||
| GET | `/workflows/:name/yaml` | 下載 raw YAML | Workflow Viewer Export |
|
||||
| GET | `/apps` | 列出 app（= workflow 標上 icon/tone/description metadata） | Dashboard / Apps Grid |
|
||||
| GET | `/api-keys` | 列出多把 key（若後端仍是單把，回傳單元素 array） | API Keys 頁 |
|
||||
| POST | `/api-keys` | 建立新 key | API Keys 頁「Create new key」 |
|
||||
| PATCH | `/api-keys/:id` | `{ active: boolean }` 切換 | API Keys 頁 toggle |
|
||||
| DELETE | `/api-keys/:id` | 刪除 | API Keys 頁 trash |
|
||||
|
||||
**在後端尚未實作前**：前端用型別化 fetch wrapper 封裝呼叫；遇到 404 顯示 empty state（而非假資料）。本 SDD 明確禁止 hard-code mock fixture。
|
||||
|
||||
### 6.3 登入前後可用的公開資訊
|
||||
- Integrations 清單（20 個 recipe）：現有 `/integrations` 頁已有靜態清單，繼續複用。
|
||||
|
||||
---
|
||||
|
||||
## 7. Dogfooding 紅線
|
||||
|
||||
| 禁止 | 用哪個 arcrun 內部替代 |
|
||||
|---|---|
|
||||
| Auth0 / Clerk / Supabase Auth | cypher-executor `/auth/*` + session cookie（現行 `arcrun_session`） |
|
||||
| Segment / PostHog | 不加，或用後續 arcrun `analytics` 零件 |
|
||||
| Vercel KV / Upstash | Cloudflare KV（經 cypher-executor） |
|
||||
| 直接寫第三方 API（Slack / Notion 等）作 dashboard demo | 透過 arcrun workflow + trigger 模擬 |
|
||||
| ReactFlow / XYFlow | 純 SVG 手刻（設計稿本來就是手刻） |
|
||||
|
||||
---
|
||||
|
||||
## 8. 驗收總清單
|
||||
|
||||
- [ ] 5 個 screen 全部在 `/`, `/auth`, `/dashboard`, `/keys`, `/workflows/[id]` 可達。
|
||||
- [ ] 設計稿的 spacing / color / border-radius 100% 對得上（以 `design-source/index.html` CSS 變數為準）。
|
||||
- [ ] middleware 保護 `/dashboard`, `/keys`, `/workflows/*`（未登入 → `/auth?redirect=...`）。
|
||||
- [ ] 只打 `cypher.arcrun.dev`（可透過 `NEXT_PUBLIC_API_BASE` override），grep 結果不含其他外部 API host。
|
||||
- [ ] `package.json` 新增依賴 = 0（本次不引入新 npm 套件）。
|
||||
- [ ] 無 mock 資料：若後端未實作，顯示 loading 或 empty state，不編假陣列給 UI。
|
||||
- [ ] `pnpm build` 通過，`next-on-pages` 輸出無 edge-runtime 錯誤。
|
||||
@@ -0,0 +1,140 @@
|
||||
# Frontend Redesign — Tasks
|
||||
|
||||
> 進度來源：本檔。完成一項立刻 `[x]`，不批次。
|
||||
> 本 SDD 建立於 2026-04-23；richblack 尚未下令動工，**所有 task 預設 `[ ]`**。
|
||||
|
||||
---
|
||||
|
||||
## Phase 0 — SDD 建立（本次）
|
||||
|
||||
- [x] 取得 Claude Design bundle，歸檔至 `design-source/`
|
||||
- [x] 撰寫 `requirements.md`
|
||||
- [x] 撰寫 `design.md`
|
||||
- [x] 撰寫 `tasks.md`（本檔）
|
||||
- [ ] richblack review + 認可 → 開 Phase 1
|
||||
|
||||
**等 richblack 明確說「開始動工」之前，不觸 `landing/` 任何檔案。**
|
||||
|
||||
---
|
||||
|
||||
## Phase 1 — Tokens + Shell（無外部 API 依賴）
|
||||
|
||||
- [ ] 1.1 建 `landing/app/design-tokens.css`，抄 design-source CSS :root 變數
|
||||
- [ ] 1.2 更新 `landing/app/globals.css`：`@import './design-tokens.css'`，`@theme inline` 對應 token → Tailwind color
|
||||
- [ ] 1.3 `layout.tsx` 引入 `next/font/google` 的 Inter + JetBrains Mono；body bg 改 `var(--bg)`
|
||||
- [ ] 1.4 建 `landing/components/shell/Icon.tsx`（港設計稿 primitives.jsx 的所有 icon）
|
||||
- [ ] 1.5 建 `landing/components/shell/Logo.tsx`（SVG arc wordmark）
|
||||
- [ ] 1.6 建 `landing/components/shell/TopNav.tsx`
|
||||
- [ ] 1.7 建 `landing/components/shell/Footer.tsx`
|
||||
- [ ] 1.8 建 `landing/components/shell/Sidebar.tsx`（含頭像、項目清單、登出按鈕）
|
||||
- [ ] 1.9 建 `landing/components/primitives/Button.tsx`（variants: primary / secondary / ghost / danger-ghost / sm / lg）
|
||||
- [ ] 1.10 建 `landing/components/primitives/Pill.tsx`、`Toggle.tsx`
|
||||
- [ ] 1.11 Lint + build pass
|
||||
|
||||
---
|
||||
|
||||
## Phase 2 — Landing（`/`）
|
||||
|
||||
- [ ] 2.1 Rewrite `app/page.tsx`，結構照 design-source/screens/Landing.jsx
|
||||
- [ ] 2.2 Hero：heading / eyebrow / CTA / radial-grid bg（CSS only）
|
||||
- [ ] 2.3 Paths 左卡：install tabs 元件（Client Component）+ terminal code blocks（字串改 `acr` 實際指令）
|
||||
- [ ] 2.4 Paths 右卡：chat preview（靜態）
|
||||
- [ ] 2.5 Feature strip（4 cell）
|
||||
- [ ] 2.6 TopNav / Footer 接上
|
||||
- [ ] 2.7 Responsive（≤ 768px: paths 單欄、hero h1 縮 1 級）
|
||||
- [ ] 2.8 視覺比對 design-source/index.html（截圖對比 / DOM spec 檢查）
|
||||
|
||||
---
|
||||
|
||||
## Phase 3 — Auth（`/auth`，`/login` redirect）
|
||||
|
||||
- [ ] 3.1 建 `app/auth/page.tsx`（Client）
|
||||
- [ ] 3.2 Sign in / Sign up tabs + OAuth buttons（Google / GitHub）接既有 `/auth/google/start` / `/auth/github/start`
|
||||
- [ ] 3.3 Email / Password form — submit 顯示「OAuth only」提示（待後端支援）
|
||||
- [ ] 3.4 `/login` 頁改為 `redirect('/auth')`
|
||||
- [ ] 3.5 視覺比對 design-source/screens/Auth.jsx
|
||||
|
||||
---
|
||||
|
||||
## Phase 4 — API Keys（`/keys`）
|
||||
|
||||
- [ ] 4.1 建 `lib/api.ts` fetch wrapper
|
||||
- [ ] 4.2 建 `lib/apiKeys.ts`（listKeys / createKey / patchKey / deleteKey）— 後端未實作時回 `[{ ...from /me }]` 的 fallback
|
||||
- [ ] 4.3 建 `app/keys/page.tsx`：頂部 new-key-box（sessionStorage flag）、全表格
|
||||
- [ ] 4.4 「Create new key」呼叫 `POST /api-keys`（後端未實作 → 顯示「coming soon」toast）
|
||||
- [ ] 4.5 Toggle active / trash 接 PATCH / DELETE
|
||||
- [ ] 4.6 middleware.ts matcher 加 `/keys/:path*`
|
||||
- [ ] 4.7 原 `/dashboard` 頁的 Key 卡區塊移除，放提示「API Keys 已搬到 /keys」
|
||||
|
||||
---
|
||||
|
||||
## Phase 5 — Dashboard（`/dashboard`）
|
||||
|
||||
- [ ] 5.1 建 `lib/workflows.ts`、`lib/apps.ts`
|
||||
- [ ] 5.2 Rewrite `app/dashboard/page.tsx`（保留 /me session 檢查）
|
||||
- [ ] 5.3 Main head：breadcrumb / greeting / summary counters
|
||||
- [ ] 5.4 Apps Grid + empty-state 卡（`/apps` 404 → 只顯示 empty-state）
|
||||
- [ ] 5.5 Workflows Table（`/workflows` 404 → 顯示「no workflows — acr push」CTA）
|
||||
- [ ] 5.6 Sidebar 接真實 user（email / display_name）、登出按鈕接 `/auth/logout`
|
||||
- [ ] 5.7 視覺比對 design-source/screens/Dashboard.jsx
|
||||
|
||||
---
|
||||
|
||||
## Phase 6 — Workflow Viewer（`/workflows/[name]`）
|
||||
|
||||
- [ ] 6.1 建 `app/workflows/[name]/page.tsx`（Client）
|
||||
- [ ] 6.2 Topbar：back / logo / breadcrumb / title / saved indicator / share / export / edit-in-claude
|
||||
- [ ] 6.3 `<Canvas>`：SVG defs + 節點定位 + bezier edges；資料從 `GET /workflows/:name`
|
||||
- [ ] 6.4 Auto-layout：topological depth → columns，同 depth 平均分配 y
|
||||
- [ ] 6.5 NodeCard 點擊 → DetailPanel
|
||||
- [ ] 6.6 DetailPanel：input / output schema、triplet（disabled）、last run stats（可選）
|
||||
- [ ] 6.7 Export YAML：`GET /workflows/:name/yaml` → blob download
|
||||
- [ ] 6.8 Minimap（純顯示）、ZoomControls（簡單 scale）
|
||||
- [ ] 6.9 middleware.ts matcher 加 `/workflows/:path*`
|
||||
|
||||
---
|
||||
|
||||
## Phase 7 — 清理 + 收尾
|
||||
|
||||
- [ ] 7.1 刪除舊 `/dashboard` 不再用的 code（rotate/revoke 若全搬到 /keys）
|
||||
- [ ] 7.2 Grep 檢查：除 `cypher.arcrun.dev` 外無任何第三方 API host
|
||||
- [ ] 7.3 Grep 檢查：無 `mock` / `fixture` / 硬編的假資料陣列（`app-empty` 的字串常數除外）
|
||||
- [ ] 7.4 Grep 檢查：無新增 npm 依賴（`git diff landing/package.json` 應只改版本，不加條目）
|
||||
- [ ] 7.5 `pnpm build` 通過；`next-on-pages` 通過
|
||||
- [ ] 7.6 local `pnpm dev` 手工巡覽 5 screen，每個截圖比對 design-source
|
||||
- [ ] 7.7 更新 `.agents/specs/arcrun/arcrun.md`，加一段「CLI 1.2.0 搭配新 landing」之類的進度註記
|
||||
- [ ] 7.8 richblack 認可 → 合併 / deploy
|
||||
|
||||
---
|
||||
|
||||
## 需要 cypher-executor 搭配的 endpoint（不屬於本 SDD）
|
||||
|
||||
若 richblack 決定新 endpoint 要和前端同 PR 做：
|
||||
|
||||
- [ ] 後端：`GET /workflows`
|
||||
- [ ] 後端：`GET /workflows/:name` + `/yaml`
|
||||
- [ ] 後端：`GET /apps`
|
||||
- [ ] 後端：`GET /api-keys`、`POST /api-keys`、`PATCH /api-keys/:id`、`DELETE /api-keys/:id`
|
||||
|
||||
否則：以 empty state 呈現，封測也能運作。
|
||||
|
||||
---
|
||||
|
||||
## KBDB 整合（配合 matrix/kbdb/.agents/specs/arcrun-key-auth/）
|
||||
|
||||
Arcrun 用戶的 `ak_xxx` Key 同時可用於 KBDB（捆綁服務，自動開通）。
|
||||
cypher-executor 需在以下時機呼叫 KBDB：
|
||||
|
||||
- [ ] 後端：OAuth callback 成功 → `POST /partners`（建立 KBDB partner 記錄）
|
||||
- [ ] 後端：`PUT /me/api-key/rotate` → 舊 partner revoke + 建新 partner 記錄
|
||||
- [ ] 後端：`DELETE /me/api-key` → KBDB partner revoke
|
||||
|
||||
詳細設計見 `matrix/kbdb/.agents/specs/arcrun-key-auth/design.md`。
|
||||
|
||||
---
|
||||
|
||||
## 目前狀態
|
||||
|
||||
- **進度**：Phase 0 已完成（4/5；最後一項等 richblack 認可）。
|
||||
- **阻擋**：richblack 認可 + 「開始動工」指令。
|
||||
- **未啟動**：Phase 1-7 全部 `[ ]`。
|
||||
@@ -0,0 +1,325 @@
|
||||
# arcrun.dev Landing Page — SDD
|
||||
|
||||
> **目標**：給工程師一個門面，可以取得 API Key、管理 Key、探索 API（Swagger），同時藉此獲得會員 Email。
|
||||
> **原則**：先快速可用，不追求功能完整。榮譽牆、Python Lib 是後期。
|
||||
|
||||
---
|
||||
|
||||
## 0. 範圍（這份 SDD 涵蓋）
|
||||
|
||||
| 功能 | 說明 |
|
||||
|---|---|
|
||||
| 首頁 Hero | 說明 arcrun 是什麼，CTA 取得 API Key |
|
||||
| OAuth 登入 | Google / GitHub（用自己的 auth recipe — dogfooding） |
|
||||
| API Key 管理 | 查看、Rotate、Revoke |
|
||||
| Swagger UI | 嵌入 `/api`，讓工程師直接試打 |
|
||||
| 榮譽牆 `/integrations` | 靜態骨架，先列 20 個 recipe，無動態數字 |
|
||||
| 中英切換 | `?lang=zh` |
|
||||
|
||||
**不在本次範圍**：Python lib、Donate 整合、Social Proof 即時數字、貢獻者排行。
|
||||
|
||||
---
|
||||
|
||||
## 1. 技術選型
|
||||
|
||||
### 1.1 框架：Next.js（App Router）
|
||||
|
||||
**選 Next.js 而非 Astro 的原因**：
|
||||
- `finally-click` 已有完整 Next.js + OAuth 回調實作，可直接複用模式
|
||||
- API Key 管理頁有登入態保護需求，Next.js 的 middleware 最直接
|
||||
- Cloudflare Pages 支援 Next.js（`@cloudflare/next-on-pages`）
|
||||
- Astro 在動態路由保護上摩擦較多
|
||||
|
||||
### 1.2 部署：Cloudflare Pages
|
||||
|
||||
```
|
||||
arcrun.dev → Cloudflare Pages（Next.js）
|
||||
API calls → cypher.arcrun.dev（現有 Worker）
|
||||
```
|
||||
|
||||
### 1.3 儲存：現有 cypher-executor CREDENTIALS_KV + 新增 USERS_KV
|
||||
|
||||
現有 cypher-executor Worker 已有：
|
||||
- `CREDENTIALS_KV`：`{api_key}:cred:{name}` 存 tenant credentials
|
||||
- `RECIPES`：auth recipes
|
||||
|
||||
新增需求：
|
||||
- **USERS_KV**：存 user 帳號，key = `user:{provider}:{provider_user_id}`
|
||||
- value: `{ email, display_name, api_key, created_at, provider }`
|
||||
- **SESSIONS_KV**：存 login session，key = `sess:{session_id}`
|
||||
- value: `{ api_key, email, expires_at }`
|
||||
- TTL = 7 天
|
||||
|
||||
兩個 KV 都加到 cypher-executor `wrangler.toml`。
|
||||
|
||||
### 1.4 OAuth — Dogfooding 自己的 Auth Recipe
|
||||
|
||||
登入用 arcrun 自己的 auth recipe：
|
||||
- 不是用 arcrun auth recipe 的 `http_request` runner 去打第三方
|
||||
- 而是 **直接複用 recipe YAML 裡定義的 OAuth App 設定（client_id/secret）**
|
||||
- Worker 端實作 standard OAuth2 authorization_code flow
|
||||
|
||||
**支援提供商（MVP）**：
|
||||
- Google（google_drive recipe 的 OAuth App，或另建 arcrun-login Google App）
|
||||
- GitHub（github recipe 的 OAuth App）
|
||||
|
||||
登入 OAuth App 與 auth recipe 的 OAuth App **可以是同一個**（只要 scopes 包含 `openid profile email`），但更乾淨的做法是登入用獨立的 Google/GitHub App（只要 email scope），auth recipe 用的是資源存取 App。
|
||||
|
||||
**決策：登入用獨立 OAuth App**
|
||||
- `GOOGLE_CLIENT_ID`、`GOOGLE_CLIENT_SECRET` — 只申請 `openid profile email`
|
||||
- `GITHUB_CLIENT_ID`、`GITHUB_CLIENT_SECRET` — 只申請 `read:user` + `user:email`
|
||||
- 以 Worker Secret 方式存入 cypher-executor
|
||||
|
||||
---
|
||||
|
||||
## 2. 頁面結構
|
||||
|
||||
```
|
||||
arcrun.dev/
|
||||
├── / 首頁（Hero + Code snippet + CTA）
|
||||
├── /login 登入頁（Google / GitHub 按鈕）
|
||||
├── /auth/callback OAuth callback（Pages Function）
|
||||
├── /dashboard API Key 管理（需登入）
|
||||
├── /api Swagger UI（嵌入 swagger.json）
|
||||
└── /integrations 服務目錄（靜態，20 個 recipe）
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 登入 / OAuth 流程
|
||||
|
||||
### 3.1 流程圖
|
||||
|
||||
```
|
||||
用戶點「Google 登入」
|
||||
→ GET /auth/google/start（Worker 端）
|
||||
→ redirect 到 Google OAuth（state = random, 存 SESSIONS_KV sess:state:{state} = {provider, redirect_back}）
|
||||
→ 用戶同意
|
||||
→ GET /auth/callback?code=...&state=...（Worker 端）
|
||||
→ 驗 state
|
||||
→ 用 code 換 access_token（POST google token endpoint）
|
||||
→ 用 token 取 userinfo（GET google userinfo）
|
||||
→ upsert USERS_KV user:{provider}:{provider_id} = {email, display_name, api_key, ...}
|
||||
→ 若新用戶：呼叫現有 /register?email=... 取得 arcrun API Key
|
||||
→ 建立 session：SESSIONS_KV sess:{session_id} = {api_key, email, ...}，TTL=7d
|
||||
→ Set-Cookie: arcrun_session={session_id}; HttpOnly; Secure; SameSite=Lax
|
||||
→ redirect 到 /dashboard
|
||||
```
|
||||
|
||||
### 3.2 「若新用戶取得 API Key」的邏輯
|
||||
|
||||
現有 `/register` endpoint 接受 `email` 回傳 `api_key`（HMAC 確定性）。
|
||||
但 landing page 需要的是**真正綁定到用戶帳號的 key**，且用戶可以 rotate/revoke。
|
||||
|
||||
**方案：延伸現有 register endpoint**
|
||||
|
||||
`/register` 目前：`HMAC(secret, email)` → 確定性 api_key，存 CREDENTIALS_KV
|
||||
|
||||
新增邏輯：
|
||||
1. 若 USERS_KV 已有此 user → 直接用記錄裡的 api_key
|
||||
2. 若新 user → 呼叫現有 `/register`（保持 HMAC 確定性邏輯）→ 拿到 api_key → 存入 USERS_KV
|
||||
|
||||
**好處**：不破壞現有 register 邏輯；登入後的 dashboard 顯示的 key = 現有 key = 封測用的 key。
|
||||
|
||||
### 3.3 Rotate / Revoke
|
||||
|
||||
- **Rotate**：產生新 UUID v4 key → 更新 USERS_KV 記錄 → 舊 key 失效（透過把新 key 加到 CREDENTIALS_KV，舊 key 的資料都跟著 API Key 命名空間走，所以 credentials 會留在舊 namespace）
|
||||
- 簡化版：Rotate 後顯示提示「您的 workflow credentials 已和舊 Key 分離，請重新設定」
|
||||
- **Revoke**：USERS_KV 記錄 `revoked: true` → Worker middleware 拒絕此 key
|
||||
|
||||
---
|
||||
|
||||
## 4. API 端點（新增到 cypher-executor）
|
||||
|
||||
```
|
||||
GET /auth/google/start → redirect 到 Google OAuth
|
||||
GET /auth/github/start → redirect 到 GitHub OAuth
|
||||
GET /auth/callback?code=&state= → 換 token、建立 session
|
||||
POST /auth/logout → 清 session cookie
|
||||
GET /me → 回傳當前登入用戶資訊（需 session cookie 或 API Key）
|
||||
PUT /me/api-key/rotate → 產生新 key
|
||||
DELETE /me/api-key → Revoke（標記撤銷）
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. 前端頁面設計
|
||||
|
||||
### 5.1 首頁（/）
|
||||
|
||||
```
|
||||
Hero:
|
||||
Stop fighting OAuth.
|
||||
One API key. Every service. Works anywhere.
|
||||
|
||||
[Get API Key — Free] [View on GitHub]
|
||||
|
||||
Before/After:
|
||||
40 行 OAuth 程式碼 → auth.bind("google_drive")
|
||||
|
||||
Code Demo（三個 tab）：
|
||||
Python / JavaScript / HTTP（n8n 用戶）
|
||||
|
||||
[Get Free API Key] 按鈕
|
||||
```
|
||||
|
||||
### 5.2 登入頁（/login）
|
||||
|
||||
```
|
||||
arcrun
|
||||
|
||||
登入或建立帳號
|
||||
|
||||
[Continue with Google]
|
||||
[Continue with GitHub]
|
||||
|
||||
不需要信用卡。API Key 立即可用。
|
||||
```
|
||||
|
||||
### 5.3 Dashboard（/dashboard）
|
||||
|
||||
```
|
||||
歡迎，{display_name}
|
||||
|
||||
您的 API Key
|
||||
┌────────────────────────────────┐
|
||||
│ ak_xxxxxxxxxxxxxxxxxxxx [複製] │
|
||||
└────────────────────────────────┘
|
||||
|
||||
[Rotate Key] [Revoke Key]
|
||||
|
||||
使用說明：
|
||||
Authorization: Bearer {key}
|
||||
或 X-Arcrun-API-Key: {key}
|
||||
|
||||
[登出]
|
||||
```
|
||||
|
||||
### 5.4 Swagger UI（/api）
|
||||
|
||||
- 嵌入 `<SwaggerUIBundle>` JS（CDN）
|
||||
- `url: 'https://cypher.arcrun.dev/swagger.json'`（現有 Worker 已有 `/docs` openapi endpoint）
|
||||
- 頂部說明：「這是 arcrun 的原始 API。Python / JS lib 是它的包裝，任何能發 HTTP request 的工具都能直接用。」
|
||||
|
||||
### 5.5 服務目錄（/integrations）
|
||||
|
||||
- 靜態列出 20 個 auth recipe（從 seed data 產生）
|
||||
- 每個 recipe：名稱、認證方式（static_key / service_account）、所需 credentials
|
||||
- 「找不到你要的服務？開 PR 貢獻 Recipe」CTA
|
||||
|
||||
---
|
||||
|
||||
## 6. 檔案結構
|
||||
|
||||
```
|
||||
arcrun/landing/ ← 新 Next.js 專案
|
||||
├── app/
|
||||
│ ├── layout.tsx
|
||||
│ ├── page.tsx 首頁
|
||||
│ ├── login/
|
||||
│ │ └── page.tsx
|
||||
│ ├── dashboard/
|
||||
│ │ ├── page.tsx
|
||||
│ │ └── middleware.ts （或 root middleware）
|
||||
│ ├── api-docs/
|
||||
│ │ └── page.tsx Swagger UI
|
||||
│ └── integrations/
|
||||
│ └── page.tsx
|
||||
├── middleware.ts 保護 /dashboard（讀 cookie）
|
||||
├── lib/
|
||||
│ └── auth.ts session helpers
|
||||
├── public/
|
||||
├── next.config.ts
|
||||
├── package.json
|
||||
└── wrangler.toml CF Pages 設定
|
||||
```
|
||||
|
||||
cypher-executor 新增：
|
||||
```
|
||||
arcrun/cypher-executor/src/routes/
|
||||
├── auth.ts ← 新增（OAuth start/callback/logout/me）
|
||||
```
|
||||
|
||||
cypher-executor wrangler.toml 新增：
|
||||
```toml
|
||||
[[kv_namespaces]]
|
||||
binding = "USERS_KV"
|
||||
id = "<to be created>"
|
||||
|
||||
[[kv_namespaces]]
|
||||
binding = "SESSIONS_KV"
|
||||
id = "455d0505c7534883a4d4985ab8295857"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. 環境變數 / Secrets
|
||||
|
||||
### cypher-executor（Worker Secrets）
|
||||
|
||||
```
|
||||
GOOGLE_CLIENT_ID Google OAuth App client_id（僅 openid profile email scope）
|
||||
GOOGLE_CLIENT_SECRET Google OAuth App client_secret
|
||||
GITHUB_CLIENT_ID GitHub OAuth App client_id（read:user + user:email scope）
|
||||
GITHUB_CLIENT_SECRET GitHub OAuth App client_secret
|
||||
SESSION_SECRET 隨機 32 bytes，用於 HMAC session ID（或直接用 UUID）
|
||||
```
|
||||
|
||||
### landing（Pages Environment Variables）
|
||||
|
||||
```
|
||||
NEXT_PUBLIC_API_BASE https://cypher.arcrun.dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 8. 實作步驟（Checklist）
|
||||
|
||||
### Phase 1：cypher-executor 後端擴充
|
||||
|
||||
- [x] `wrangler kv:namespace create USERS_KV` → 填入 wrangler.toml (id: 25bef01d079148919578894434d58c4d)
|
||||
- [x] `wrangler kv:namespace create SESSIONS_KV` → 填入 wrangler.toml (id: 455d0505c7534883a4d4985ab8295857)
|
||||
- [x] 建立 `arcrun/cypher-executor/src/routes/auth.ts`
|
||||
- [x] GET `/auth/google/start`
|
||||
- [x] GET `/auth/github/start`
|
||||
- [x] GET `/auth/callback`（換 token → userinfo → upsert USERS_KV → 建 session → Set-Cookie → redirect）
|
||||
- [x] POST `/auth/logout`
|
||||
- [x] GET `/me`（讀 session cookie 或 API Key header）
|
||||
- [x] PUT `/me/api-key/rotate`
|
||||
- [x] DELETE `/me/api-key`（revoke）
|
||||
- [x] 在 `src/index.ts` 掛載 `authRouter`
|
||||
- [ ] `wrangler secret put GOOGLE_CLIENT_ID` 等 4 個 secrets ← **用戶需自建 Google/GitHub OAuth App**
|
||||
- [x] `wrangler deploy` ← 已部署（Worker version 7877857b）
|
||||
|
||||
### Phase 2：Next.js Landing 專案
|
||||
|
||||
- [x] `npx create-next-app@latest arcrun/landing --typescript --tailwind --app`
|
||||
- [x] 設定 `@cloudflare/next-on-pages`（Next.js 15 + .npmrc legacy-peer-deps）
|
||||
- [ ] 建立 `middleware.ts`（保護 /dashboard，讀 `arcrun_session` cookie）← 待做
|
||||
- [x] 首頁（`app/page.tsx`）：Hero + Code Demo tab + CTA
|
||||
- [x] 登入頁（`app/login/page.tsx`）：Google / GitHub 按鈕（href 到 cypher.arcrun.dev/auth/google/start）
|
||||
- [x] Dashboard（`app/dashboard/page.tsx`）：顯示 API Key，Rotate / Revoke 按鈕
|
||||
- [x] Swagger UI（`app/api-docs/page.tsx`）：client component，動態 import swagger-ui CDN
|
||||
- [x] 服務目錄（`app/integrations/page.tsx`）：靜態，列 20 個 recipe
|
||||
- [ ] 中英切換 ← 低優先，可延後
|
||||
- [x] `wrangler pages deploy` → https://42a8d302.arcrun-landing.pages.dev
|
||||
- [ ] Cloudflare dashboard 設定 arcrun.dev custom domain → arcrun-landing Pages project
|
||||
|
||||
### Phase 3：驗收（待 OAuth Secrets 填入後）
|
||||
|
||||
- [ ] Google / GitHub OAuth 完整流程（登入 → dashboard → 看到 key）
|
||||
- [ ] Rotate：新 key 出現
|
||||
- [ ] Revoke：舊 key 的 API 呼叫回傳 401
|
||||
- [ ] Swagger UI 正常載入，可試打 `/health`
|
||||
- [x] `/integrations` 正確列出 20 個服務
|
||||
|
||||
---
|
||||
|
||||
## 9. 待決事項（開始實作前確認）
|
||||
|
||||
| 問題 | 預設決策 |
|
||||
|---|---|
|
||||
| Google OAuth App 是否要另建（只有 email scope）? | 是，另建；auth recipe 的 App 不動 |
|
||||
| Rotate 後舊 credentials 是否遷移？ | 不遷移，顯示提示 |
|
||||
| Domain arcrun.dev 是否已購入且在 Cloudflare？ | 假設是（wrangler.toml 有設 zone_name） |
|
||||
| 登入後 redirect 預設到 /dashboard | 是，可從 `?redirect=` 覆寫 |
|
||||
@@ -0,0 +1,281 @@
|
||||
# Design Document: arcrun SDK Libraries + Website
|
||||
|
||||
## Overview
|
||||
|
||||
本設計涵蓋 arcrun 的三個新增交付物：
|
||||
1. Python SDK lib（`pip install arcrun`）
|
||||
2. JS/TS SDK lib（`npm install arcrun` 或 `@arcrun/sdk`）
|
||||
3. arcrun.dev 網站完善（零件列表、recipe 列表、登入管理）
|
||||
|
||||
**設計原則：修改不重建。** SDK 是 `cypher.arcrun.dev` HTTP API 的 thin wrapper。不在 client 端重新實作任何 server 端已有的邏輯（workflow 執行、credential 注入、auth recipe 解析）。唯一在 client 做的是 AES-GCM 加密（因為 server 的 POST /credentials 期望收到加密後的 payload）。
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
### 系統關係圖
|
||||
|
||||
```
|
||||
使用者程式碼
|
||||
├── CLI（acr） → cypher.arcrun.dev（HTTP API）
|
||||
├── Python SDK（arcrun） → cypher.arcrun.dev（HTTP API）
|
||||
└── JS SDK（arcrun / @arcrun/sdk） → cypher.arcrun.dev（HTTP API）
|
||||
|
||||
arcrun.dev 網站（Next.js / Cloudflare Pages）
|
||||
├── /login → /auth/google/start, /auth/github/start（cypher.arcrun.dev）
|
||||
├── /dashboard → /me, /me/api-key/rotate（cypher.arcrun.dev）
|
||||
├── /integrations → /auth-recipes（cypher.arcrun.dev）
|
||||
└── /components → /recipes + 靜態零件清單（embedded）
|
||||
|
||||
cypher.arcrun.dev（Cloudflare Worker — cypher-executor，不改）
|
||||
├── POST /credentials ← 接收 { name, encrypted, iv }
|
||||
├── GET /credentials ← 列出 credential 名稱
|
||||
├── DELETE /credentials/:name ← 刪除 credential
|
||||
├── GET /auth-recipes ← 列出 20 個 auth recipe
|
||||
├── GET /auth-recipes/:service ← 單一 recipe 詳情
|
||||
├── POST /webhooks/named ← 部署 workflow
|
||||
├── POST /webhooks/named/:name/trigger ← 觸發 workflow
|
||||
├── GET /webhooks/named ← 列出 workflow
|
||||
├── POST /register ← 註冊取得 API Key
|
||||
├── GET /me ← 當前用戶資訊
|
||||
└── /auth/* ← OAuth 流程
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Python SDK（`arcrun/python-sdk/`）
|
||||
|
||||
### 目錄結構
|
||||
|
||||
```
|
||||
arcrun/python-sdk/
|
||||
├── pyproject.toml ← hatchling build, name="arcrun", deps=[httpx>=0.27, cryptography>=42]
|
||||
├── README.md
|
||||
└── arcrun/
|
||||
├── __init__.py ← from .client import Arcrun
|
||||
├── client.py ← Arcrun class（主入口）
|
||||
├── crypto.py ← AES-GCM 加密（client 端，用 cryptography 套件）
|
||||
├── creds.py ← CredentialsClient（push/list/delete）
|
||||
├── auth.py ← AuthClient（setup/bind/get_token/list_services）
|
||||
└── workflows.py ← WorkflowClient（run/push/list/delete）
|
||||
```
|
||||
|
||||
### API 設計
|
||||
|
||||
```python
|
||||
from arcrun import Arcrun
|
||||
|
||||
# 建構 — api_key 從參數 > 環境變數 > ~/.arcrun/config.yaml 自動取得
|
||||
client = Arcrun()
|
||||
# 或明確指定
|
||||
client = Arcrun(api_key="ak_xxx", encryption_key="hexstring")
|
||||
|
||||
# Auth：設定並綁定服務
|
||||
client.auth.setup("openai", api_key="sk-xxx") # 加密 + 上傳
|
||||
openai_client = client.auth.bind("openai") # 取回 pre-auth client
|
||||
response = openai_client.get("/models") # httpx.Client
|
||||
token = client.auth.get_token("openai") # raw token string
|
||||
services = client.auth.list_services() # [{ service, display_name, ... }]
|
||||
|
||||
# Credentials：低階操作
|
||||
client.creds.push("my_token", "value123")
|
||||
names = client.creds.list()
|
||||
client.creds.delete("my_token")
|
||||
|
||||
# Workflows
|
||||
result = client.workflows.run("my-flow", {"email": "user@example.com"})
|
||||
url = client.workflows.push("my-flow", graph_dict)
|
||||
workflows = client.workflows.list()
|
||||
```
|
||||
|
||||
### Credential 加密流程
|
||||
|
||||
```
|
||||
setup("openai", api_key="sk-xxx")
|
||||
1. GET /auth-recipes/openai → recipe（含 required_secrets, inject）
|
||||
2. 對應 required_secrets[0].key = "openai_api_key"
|
||||
3. crypto.py 用 encryption_key AES-GCM 加密 "sk-xxx"
|
||||
4. POST /credentials → { name: "openai_api_key", encrypted, iv }
|
||||
5. 本地 _cred_cache["openai_api_key"] = "sk-xxx"（供 bind() 用）
|
||||
|
||||
bind("openai")
|
||||
1. GET /auth-recipes/openai → recipe.inject.header = { Authorization: "Bearer {{secret.openai_api_key}}" }
|
||||
2. 用 _cred_cache["openai_api_key"] 替換 template → "Bearer sk-xxx"
|
||||
3. 回傳 AuthenticatedClient(base_url="https://api.openai.com/v1", headers={"Authorization": "Bearer sk-xxx"})
|
||||
```
|
||||
|
||||
**注意**：`bind()` 依賴 `setup()` 在同一 session 建立的 `_cred_cache`。跨 session 使用時（credential 已上傳但 cache 不存在），`bind()` 無法解析 template — 此時 `get_token()` 也無法返回值。**這是已知限制，封測期間先接受。** 長期解法是 server 提供 `/credentials/:name/secret` 解密端點（u6u-core/credentials 已有）。
|
||||
|
||||
### 關鍵差異：crypto.py 的定位
|
||||
|
||||
`crypto.py` 只做 **加密**（encrypt），不做解密。
|
||||
功能等同 `u6u-core/credentials/src/actions/crypto.ts` 的 `encrypt()` 函數。
|
||||
解密只在 server 端發生（cypher-executor 的 `credential-injector.ts` 或 `u6u-core/credentials/getCredentialSecret.ts`）。
|
||||
|
||||
---
|
||||
|
||||
## JS/TS SDK（`arcrun/js-sdk/`）
|
||||
|
||||
### 目錄結構
|
||||
|
||||
```
|
||||
arcrun/js-sdk/
|
||||
├── package.json ← name TBD（arcrun vs @arcrun/sdk），tsup build
|
||||
├── tsconfig.json ← ES2020, NodeNext
|
||||
└── src/
|
||||
├── index.ts ← export class Arcrun
|
||||
├── crypto.ts ← Web Crypto API AES-GCM encrypt（client 端）
|
||||
├── creds.ts ← CredentialsClient（push/list/delete）
|
||||
├── auth.ts ← AuthClient（setup/bind/getToken/listServices）
|
||||
└── workflows.ts ← WorkflowClient（run/push/list/delete）
|
||||
```
|
||||
|
||||
### API 與 Python SDK 對等
|
||||
|
||||
```typescript
|
||||
import { Arcrun } from 'arcrun' // or '@arcrun/sdk'
|
||||
|
||||
const client = new Arcrun() // reads ARCRUN_API_KEY from env
|
||||
|
||||
await client.auth.setup('openai', { api_key: 'sk-xxx' })
|
||||
const oai = await client.auth.bind('openai')
|
||||
const models = await (await oai.get('/models')).json()
|
||||
|
||||
const token = await client.auth.getToken('openai')
|
||||
const services = await client.auth.listServices()
|
||||
|
||||
await client.creds.push('my_token', 'value')
|
||||
const names = await client.creds.list()
|
||||
|
||||
const result = await client.workflows.run('my-flow', { email: 'user@example.com' })
|
||||
```
|
||||
|
||||
### Build 產物
|
||||
|
||||
```
|
||||
dist/
|
||||
├── index.js ← ESM
|
||||
├── index.cjs ← CJS
|
||||
├── index.d.ts ← TypeScript 型別
|
||||
└── index.d.cts
|
||||
```
|
||||
|
||||
### Crypto 實作
|
||||
|
||||
使用 Web Crypto API（`crypto.subtle`），相容 Node 18+ / browsers / CF Workers / Deno：
|
||||
|
||||
```typescript
|
||||
async function encrypt(plaintext: string, hexKey: string): Promise<{ encrypted: string; iv: string }> {
|
||||
const key = await crypto.subtle.importKey('raw', hexToBytes(hexKey), { name: 'AES-GCM' }, false, ['encrypt']);
|
||||
const iv = crypto.getRandomValues(new Uint8Array(12));
|
||||
const ciphertext = await crypto.subtle.encrypt({ name: 'AES-GCM', iv }, key, new TextEncoder().encode(plaintext));
|
||||
return { encrypted: toBase64(ciphertext), iv: toBase64(iv.buffer) };
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## arcrun.dev 網站
|
||||
|
||||
### 現有狀態（`arcrun/landing/`）
|
||||
|
||||
已完成：
|
||||
- [x] `/` — Hero + Code Demo（Python/JS/HTTP tabs）
|
||||
- [x] `/login` — Google + GitHub OAuth 按鈕（前端 OK，需設 OAuth secrets）
|
||||
- [x] `/dashboard` — API Key 查看/Copy/Rotate/Revoke（依賴 `/me` API）
|
||||
- [x] `/integrations` — 20 個 recipe 靜態卡片
|
||||
- [x] `/api-docs` — Swagger UI CDN 嵌入
|
||||
- [x] `middleware.ts` — 保護 `/dashboard`（未登入 → `/login`）
|
||||
- [x] Cloudflare Pages 部署
|
||||
|
||||
待完成：
|
||||
- [ ] OAuth secrets 設定（`GOOGLE_CLIENT_ID` / `GOOGLE_CLIENT_SECRET` / `GITHUB_CLIENT_ID` / `GITHUB_CLIENT_SECRET`）
|
||||
- [ ] `/components` 頁面（零件列表 — 21 個 WASM 零件的 input/output/config_example）
|
||||
- [ ] 首頁 code demo 更新為三種使用方式（CLI / Python / JS）
|
||||
- [ ] 登入流程真實驗證
|
||||
|
||||
### 新增頁面：`/components`
|
||||
|
||||
```
|
||||
/components
|
||||
├── 零件卡片（21 個）
|
||||
│ ├── canonical_id
|
||||
│ ├── display_name
|
||||
│ ├── description
|
||||
│ ├── input_schema（required / optional 欄位）
|
||||
│ ├── output_schema
|
||||
│ ├── credentials_required（if any）
|
||||
│ └── config_example（YAML code block）
|
||||
└── 分類篩選（邏輯 / API / 控制流）
|
||||
```
|
||||
|
||||
資料來源：靜態嵌入（從 `registry/components/*/component.contract.yaml` 在 build 時讀取），不依賴 runtime API。
|
||||
|
||||
### OAuth 設定（待 richblack 操作）
|
||||
|
||||
需要在 Cloudflare Worker 設定以下 secrets：
|
||||
|
||||
```bash
|
||||
wrangler secret put GOOGLE_CLIENT_ID --name arcrun-cypher-executor
|
||||
wrangler secret put GOOGLE_CLIENT_SECRET --name arcrun-cypher-executor
|
||||
wrangler secret put GITHUB_CLIENT_ID --name arcrun-cypher-executor
|
||||
wrangler secret put GITHUB_CLIENT_SECRET --name arcrun-cypher-executor
|
||||
wrangler secret put SESSION_SIGNING_SECRET --name arcrun-cypher-executor
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## server 端需要的修改
|
||||
|
||||
### cypher-executor 修改（最小化）
|
||||
|
||||
目前 `POST /credentials` 端點（`routes/credentials.ts`）接收 `{ name, encrypted, iv }` 後直接存 KV。
|
||||
|
||||
SDK 需要的改動：
|
||||
|
||||
1. **`GET /auth-recipes` 回應格式**：目前 list 端點回 `{ recipes: [...] }` 但 recipe 的 `service` 欄位是 key — SDK 已在 list_services() 正確處理 ✅
|
||||
|
||||
2. **`GET /auth-recipes/:service` 回應格式**：目前回 `{ success: true, recipe: {...} }` — SDK 需讀 `body.recipe` 而非 body 本身 ✅
|
||||
|
||||
3. **`POST /credentials` 不需改動** — SDK 自己做 AES-GCM 加密後送 `{ name, encrypted, iv }` ✅
|
||||
|
||||
4. **未來**：新增 `GET /credentials/:name/secret` 端點（解密返回 plaintext），讓跨 session 的 `bind()` 能工作。但此端點在 `u6u-core/credentials/src/actions/getCredentialSecret.ts` 已有實作 — 需要在 cypher-executor 整合或 Service Binding 到 u6u-credentials Worker。**封測後再做。**
|
||||
|
||||
---
|
||||
|
||||
## 不做的事（明確排除）
|
||||
|
||||
- ❌ 不在 SDK 裡做 workflow 解析或 YAML 處理 — 那是 CLI 的職責
|
||||
- ❌ 不在 SDK 裡做 server-side 解密 — 解密只在 server 端
|
||||
- ❌ 不建新的 credentials Worker — 用現有的
|
||||
- ❌ 不建新的 KV namespace — 用現有的 CREDENTIALS_KV
|
||||
- ❌ 不改 cypher-executor 的 credential-injector.ts — 那已經完成且測試通過
|
||||
|
||||
---
|
||||
|
||||
## 實作順序
|
||||
|
||||
```
|
||||
Phase 1：Python SDK 重建 + 測試
|
||||
1.1 重建 arcrun/python-sdk/（按本 SDD 的結構）
|
||||
1.2 修正上次的 bug：recipe 回應 wrapper、inject key "header" vs "headers"、secret key mapping
|
||||
1.3 對 cypher.arcrun.dev live 測試全部 API
|
||||
1.4 本地安裝測試（pip install -e .）
|
||||
|
||||
Phase 2：JS SDK 重建 + 測試
|
||||
2.1 重建 arcrun/js-sdk/（按本 SDD 的結構）
|
||||
2.2 同步修正 Python SDK 發現的所有 recipe 格式問題
|
||||
2.3 build（tsup）+ 本地測試
|
||||
|
||||
Phase 3：arcrun.dev 網站補完
|
||||
3.1 新增 /components 頁面
|
||||
3.2 更新首頁 code demo（三種使用方式）
|
||||
3.3 OAuth secrets 設定（需 richblack 操作 GCP / GitHub）
|
||||
3.4 登入流程驗證
|
||||
|
||||
Phase 4：GitHub README + 發布
|
||||
4.1 更新 arcrun/README.md — 三種 Quick Start
|
||||
4.2 pip publish（arcrun）
|
||||
4.3 npm publish（TBD 套件名）
|
||||
4.4 最終驗證：從零開始 pip install / npm install / 打 API
|
||||
```
|
||||
@@ -0,0 +1,131 @@
|
||||
# Requirements: arcrun SDK Libraries + Website
|
||||
|
||||
## Introduction
|
||||
|
||||
arcrun 目前有三個使用介面：
|
||||
1. **CLI**（`acr` 指令）— 已完成，用 YAML 定義 workflow 並推送執行
|
||||
2. **Python / JS SDK lib**（本次新增）— `pip install arcrun` / `npm install arcrun`，讓開發者在寫程式時直接用 arcrun 功能
|
||||
3. **arcrun.dev 網站**（本次完成）— 登入取得 API Key、管理 Key、瀏覽零件 / recipe 列表
|
||||
|
||||
**核心原則**：SDK lib 是 `cypher.arcrun.dev` HTTP API 的 thin wrapper。所有業務邏輯（加解密、credential 注入、workflow 執行）都在 server 端完成。Client 端不重做 server 已有的邏輯。
|
||||
|
||||
**現有基礎設施**（不重建，直接使用）：
|
||||
- `cypher.arcrun.dev`：cypher-executor Worker（workflow 執行、credential 管理、auth recipe、webhook）
|
||||
- `u6u-core/credentials`：credential Worker（AES-GCM 加解密）— arcrun/credentials 是其 cherry-pick
|
||||
- `arcrun/cli`：CLI 工具（已發布 npm `arcrun@1.1.0`）
|
||||
- `arcrun/landing`：Next.js 前端（已部署 Cloudflare Pages，有 hero/login/dashboard/integrations 骨架）
|
||||
|
||||
---
|
||||
|
||||
## Glossary
|
||||
|
||||
- **SDK lib**：Python / JS 套件，wrapping `cypher.arcrun.dev` HTTP API，安裝後可在程式碼中直接使用
|
||||
- **auth.setup()**：上傳一個服務的 credential（如 Notion token、OpenAI API Key）到 arcrun
|
||||
- **auth.bind()**：取回已設定服務的 pre-authenticated HTTP client
|
||||
- **auth.get_token()**：取回某服務的 raw token（escape hatch，給官方 SDK 用）
|
||||
- **workflows.run()**：觸發已部署的 workflow
|
||||
- **workflows.push()**：上傳 workflow 定義
|
||||
- **Recipe**：描述「如何對某服務認證」的 YAML 設定，存在 RECIPES KV
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement 1：Python SDK（`pip install arcrun`）
|
||||
|
||||
**User Story:** As a Python 開發者, I want `pip install arcrun` 後在程式碼中使用 arcrun, so that 不用離開寫程式環境就能串接 20+ 服務。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Python SDK SHALL 以 `arcrun` 套件名發布到 PyPI，支援 Python 3.10+。
|
||||
2. THE SDK SHALL 提供以下 API：
|
||||
- `Arcrun(api_key=, base_url=)` — 建構 client，api_key 支援從環境變數 `ARCRUN_API_KEY` 或 `~/.arcrun/config.yaml` 自動讀取
|
||||
- `client.health()` — 健康檢查
|
||||
- `client.auth.list_services()` — 列出可用 auth recipe 服務
|
||||
- `client.auth.setup(service, **kwargs)` — 上傳 credential
|
||||
- `client.auth.bind(service)` — 取得 pre-authenticated HTTP client
|
||||
- `client.auth.get_token(service)` — 取得 raw token
|
||||
- `client.creds.push(name, value)` — 上傳加密 credential
|
||||
- `client.creds.list()` — 列出 credential 名稱
|
||||
- `client.creds.delete(name)` — 刪除 credential
|
||||
- `client.workflows.run(name, input)` — 觸發 workflow
|
||||
- `client.workflows.push(name, graph)` — 上傳 workflow
|
||||
- `client.workflows.list()` — 列出已部署 workflow
|
||||
3. THE SDK 的 credential 加密 SHALL 在 client 端完成（使用 `cryptography` 套件 AES-GCM），然後以 `POST /credentials` 上傳加密後的 `{ name, encrypted, iv }` 到 server。
|
||||
4. THE `auth.bind()` SHALL 從 server 取得 auth recipe 的 inject template，在 client 端用 cache 的 plaintext 值填入，回傳 pre-configured `httpx.Client`。
|
||||
5. THE SDK SHALL 使用 `httpx` 做 HTTP client（async 版使用 `httpx.AsyncClient`）。
|
||||
6. THE SDK 位置 SHALL 為 `arcrun/python-sdk/`，build 系統用 `hatchling`（`pyproject.toml`）。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 2：JavaScript/TypeScript SDK（`npm install arcrun`）
|
||||
|
||||
**User Story:** As a JS/TS 開發者, I want `npm install arcrun` 後在程式碼中使用 arcrun, so that 可以嵌入現有 Node.js / Deno / Cloudflare Workers 專案。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE JS SDK SHALL 以 `arcrun` 套件名發布到 npm，提供 ESM + CJS 雙格式 + TypeScript 型別定義。
|
||||
2. THE SDK SHALL 提供與 Python SDK 對等的 API（camelCase 版）：
|
||||
- `new Arcrun({ apiKey?, baseUrl? })` — 讀 `process.env.ARCRUN_API_KEY`
|
||||
- `client.health()` — 回傳 `Promise<unknown>`
|
||||
- `client.auth.listServices()` / `setup()` / `bind()` / `getToken()`
|
||||
- `client.creds.push()` / `list()` / `delete()`
|
||||
- `client.workflows.run()` / `push()` / `list()` / `delete()`
|
||||
3. THE SDK 的 credential 加密 SHALL 使用 Web Crypto API（`crypto.subtle` AES-GCM），相容 Node 18+、browsers、Cloudflare Workers、Deno。
|
||||
4. THE `auth.bind()` SHALL 回傳一個有 `get/post/put/delete/patch` 方法的 `AuthenticatedClient`，base URL + auth headers 已配置。
|
||||
5. THE SDK SHALL 使用原生 `fetch()` API，不依賴外部 HTTP client 套件。
|
||||
6. THE SDK 位置 SHALL 為 `arcrun/js-sdk/`，build 用 `tsup`（ESM + CJS + DTS），`tsconfig.json` target ES2020 + NodeNext module。
|
||||
7. THE JS SDK 套件名與 CLI 套件名衝突（都叫 `arcrun`），SHALL 使用 `@arcrun/sdk` 或由 richblack 決定套件名。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 3：arcrun.dev 網站完成
|
||||
|
||||
**User Story:** As a 潛在用戶, I want 在 arcrun.dev 上登入取得 API Key、瀏覽零件和 recipe 列表, so that 我可以評估 arcrun 是否符合需求並立即開始使用。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE 網站 SHALL 在 `arcrun.dev` 提供以下頁面：
|
||||
- `/` — 首頁 Hero + 三種使用方式（CLI / Python / JS）
|
||||
- `/login` — Google + GitHub OAuth 登入
|
||||
- `/dashboard` — 登入後顯示 API Key（查看/Copy/Rotate/Revoke）
|
||||
- `/integrations` — 列出 20 個 auth recipe 服務，可按分類篩選
|
||||
- `/components` — 列出所有零件（21 個 WASM 零件），顯示 input/output schema、config_example
|
||||
- `/api-docs` — Swagger UI，可直接試打 API
|
||||
2. THE 登入 SHALL 使用 Google + GitHub OAuth，流程走 `cypher.arcrun.dev` 的 `/auth/*` 端點。
|
||||
3. THE 登入後 SHALL 自動對該 email 呼叫 `/register` 取得 API Key（若已有則取回現有 key）。
|
||||
4. THE `/dashboard` SHALL 允許 Rotate（生成新 key）、Revoke（標記失效）、Copy to clipboard。
|
||||
5. THE 網站 SHALL 部署在 Cloudflare Pages（現有 `arcrun/landing`），使用 Next.js App Router。
|
||||
6. THE 首頁 code demo 區 SHALL 包含三個 tab：Python、JavaScript、HTTP/curl，展示三種使用方式。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 4：GitHub README 更新
|
||||
|
||||
**User Story:** As a GitHub 訪客, I want README 清楚說明三種使用方式, so that 我能選擇最適合的方式開始用 arcrun。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE `arcrun/README.md` SHALL 包含三種 Quick Start：
|
||||
- **CLI**：`npm i -g arcrun && acr init && acr push workflow.yaml && acr run`
|
||||
- **Python**：`pip install arcrun && from arcrun import Arcrun && ...`
|
||||
- **JavaScript**：`npm install arcrun && import { Arcrun } from 'arcrun' && ...`
|
||||
2. THE README SHALL 包含完整零件列表（21 個）和 auth recipe 列表（20 個服務）。
|
||||
3. THE README SHALL 連結到 `arcrun.dev`（取得 API Key）和 Swagger UI（API 文件）。
|
||||
|
||||
---
|
||||
|
||||
### Requirement 5：SDK 發布
|
||||
|
||||
**User Story:** As a SDK 使用者, I want 公開安裝並直接使用, so that 不需要從原始碼 build。
|
||||
|
||||
#### Acceptance Criteria
|
||||
|
||||
1. THE Python SDK SHALL 發布到 PyPI，`pip install arcrun` 可安裝。
|
||||
2. THE JS SDK SHALL 發布到 npm，`npm install arcrun`（或 `@arcrun/sdk`）可安裝。
|
||||
3. THE 發布前 SHALL 完成以下測試（對 `cypher.arcrun.dev` live API）：
|
||||
- `health()` ✅
|
||||
- `auth.list_services()` ✅
|
||||
- `auth.setup()` + `auth.bind()` ✅（至少一個 static_key 服務如 openai）
|
||||
- `creds.push()` + `creds.list()` ✅
|
||||
- `workflows.list()` ✅
|
||||
@@ -0,0 +1,224 @@
|
||||
# Design 補充：`acr init --self-hosted` 一鍵自動化（installer 模式）
|
||||
|
||||
> 2026-06-01 初稿 → 2026-06-02 定案改寫（richblack 拍板 installer 形態）。
|
||||
> 本檔是 `sdk-and-website/design.md` 的單檔補充（規則 02 §4.3 允許）。
|
||||
> **狀態：design 已與 richblack 對齊；實作前讀 §6 前置依賴。**
|
||||
> 背景：戰法從 SaaS 轉 self-hosted 開源（docs/HANDOFF-self-host-harness.md §0）。
|
||||
|
||||
---
|
||||
|
||||
## 1. 定案形態（richblack 2026-06-02）
|
||||
|
||||
**arcrun CLI = installer / orchestrator**（類似 rustup / nvm：工具本身小，按需從遠端拉真正內容）。
|
||||
|
||||
### 用戶只做 4 件事，中間什麼都不用懂：
|
||||
1. 申請 CF 帳號
|
||||
2. 安裝 CF CLI（`wrangler`）
|
||||
3. 安裝 arcrun CLI（`npm i -g arcrun`）
|
||||
4. `acr init --self-hosted`（貼 CF Account ID + API Token）→ **完成，其餘看機器跑**
|
||||
|
||||
### CLI 自動做（用戶無感）：
|
||||
- 驗 CF token 權限
|
||||
- 建 7 個 KV namespace + 1 個 R2 bucket（冪等）
|
||||
- **從 GitHub release 下載預編譯部署物**（含 24 個 `.wasm` + 各 Worker 的 wrangler.toml + cypher-executor/registry）
|
||||
- 把建好的 KV namespace id 注入各 wrangler.toml + cypher-executor 的 `WORKER_SUBDOMAIN`
|
||||
- **`wrangler deploy` 部署全部 Worker**（用戶已裝 wrangler）
|
||||
- seed auth recipe + API recipe 進 RECIPES KV
|
||||
- 寫回 `~/.arcrun/config.yaml`
|
||||
- 印出「手動 `wrangler secret put ENCRYPTION_KEY` ×3」提示（secret 不自動化，rule 05）
|
||||
|
||||
### 關鍵技術決策（richblack 2026-06-02）
|
||||
| 決策 | 選擇 | 理由 |
|
||||
|---|---|---|
|
||||
| 零件部署物 | **預編譯 `.wasm`**（不在用戶端 build）| 用戶不懂 tinygo、也不該懂。下載即用。 |
|
||||
| 部署工具 | **wrangler**（shell out）| 用戶已裝 CF CLI；self-host 本來就有上傳能力。CLI 不自己重寫 CF Script Upload API。 |
|
||||
| 源碼來源 | **GitHub release tarball**（含預編譯 wasm）| 版本明確、不需用戶有 git、`acr update` 拉新 release 同一條路。 |
|
||||
| 為何不是 git clone | repo **沒 commit `.wasm`**（rule 05 build 產物不 commit）→ clone 拿不到 wasm | 必須走含 wasm 的 release artifact。 |
|
||||
|
||||
---
|
||||
|
||||
## 2. 為什麼是 installer 而非「repo 內掃 wrangler.toml」（推翻初稿）
|
||||
|
||||
初稿假設「用戶在 repo 內跑、CLI 掃 wrangler.toml」。**推翻**，因為：
|
||||
- npm 全域裝的 `acr` 手上**沒有** 24 個 Worker 源碼。
|
||||
- repo 沒 commit `.wasm`（已查證 `git ls-files .component-builds | grep .wasm` = 0）→ 連 clone 都拿不到可部署的 wasm。
|
||||
- 用戶不該需要懂 git / tinygo / repo 結構。
|
||||
|
||||
→ 正解：CLI 當 installer，從 **GitHub release（含預編譯 wasm）** 拉部署物到暫存目錄，在暫存目錄注入 KV id 後 `wrangler deploy`。
|
||||
|
||||
---
|
||||
|
||||
## 3. 流程設計（`initSelfHosted` 改寫）
|
||||
|
||||
```
|
||||
acr init --self-hosted
|
||||
│
|
||||
├─ 1. 問 2 輸入：CF Account ID + CF API Token
|
||||
│ （wrangler 是否已裝？which wrangler；沒裝 → 提示先裝 CF CLI 再來）
|
||||
│ 驗 token：CF API GET /accounts/{id}/tokens/verify + GET /accounts/{id}
|
||||
│ 缺權限（Workers Scripts Edit / KV Edit / R2 Edit）→ exit 1 指出缺哪個 scope
|
||||
│
|
||||
├─ 2. 建資源（冪等：先 list 已存在就重用）
|
||||
│ 7 KV：WEBHOOKS / CREDENTIALS_KV / RECIPES / USERS_KV /
|
||||
│ SESSIONS_KV / ANALYTICS_KV / EXEC_CONTEXT（rule 01 資料儲存表）
|
||||
│ 1 R2：WASM_BUCKET
|
||||
│
|
||||
├─ 3. 下載部署物：GitHub release tarball → 解壓到暫存目錄 (~/.arcrun/.deploy-<ver>/)
|
||||
│ 內含：cypher-executor/ + registry/ + .component-builds/*（每個含預編譯 component.wasm + wrangler.toml）
|
||||
│
|
||||
├─ 4. 注入設定到暫存目錄的 wrangler.toml（不改用戶 repo，改暫存副本）
|
||||
│ - 各 Worker 的 KV binding id ← step 2 建立的
|
||||
│ - cypher-executor [vars] WORKER_SUBDOMAIN ← CF API GET /accounts/{id}/workers/subdomain
|
||||
│
|
||||
├─ 5. 部署：對暫存目錄每個含 wrangler.toml 的 dir，shell out
|
||||
│ `wrangler deploy`（env CLOUDFLARE_API_TOKEN=<token>, CLOUDFLARE_ACCOUNT_ID=<id>）
|
||||
│ 分兩層：tier1 = .component-builds/*（先）→ tier2 = cypher-executor / registry（後）
|
||||
│ 每個 wrangler.toml 已含 workers_dev = true → workers.dev URL 自動啟用
|
||||
│
|
||||
├─ 6. seed recipe 進 RECIPES KV（部署後打新 cypher URL，或直接 CF KV API 寫）
|
||||
│ - auth recipe：重用 AUTH_RECIPE_SEEDS（cypher-executor/src/lib/auth-recipe-seeds.ts）
|
||||
│ - API recipe：新增 seed-api-recipes.ts（見 §5）
|
||||
│
|
||||
├─ 7. 寫回 config（mode: self-hosted + 所有 id + cypher_executor_url = 部署後 workers.dev URL）
|
||||
│
|
||||
└─ 8. 印手動 secret 提示：
|
||||
wrangler secret put ENCRYPTION_KEY --name arcrun-cypher-executor
|
||||
wrangler secret put ENCRYPTION_KEY --name arcrun-auth-static-key
|
||||
wrangler secret put ENCRYPTION_KEY --name arcrun-auth-service-account
|
||||
（三 Worker 共用同一把 key，見 memory: encryption-key-drift-trap）
|
||||
```
|
||||
|
||||
### `acr update`（同一條路，未來新零件）
|
||||
- 拉新 GitHub release → 解壓 → 注入既有 config 的 KV id → wrangler deploy 變動的 Worker。
|
||||
- 第一期至少做到「重跑等效 init 的部署步驟」；diff-only 部署可後續優化。
|
||||
|
||||
---
|
||||
|
||||
## 4. 動到的檔案
|
||||
|
||||
| 檔案 | 動作 |
|
||||
|---|---|
|
||||
| `cli/src/commands/init.ts` | 改寫 `initSelfHosted()`（line 105-131）為 installer 流程 |
|
||||
| `cli/src/lib/cf-api.ts` | 擴充：KV namespace 建立/list、R2 bucket 建立、subdomain 查詢、token verify |
|
||||
| 新增 `cli/src/lib/deploy.ts`（暫定）| 下載 release tarball + 解壓 + 注入 wrangler.toml + shell out wrangler deploy |
|
||||
| 新增 `cli/src/commands/update.ts`（暫定）| `acr update`：拉新 release 重部署 |
|
||||
| 新增 `cli/src/lib/api-recipe-seeds.ts` | API recipe **種子資料**（installer 用；放 CLI 端，**不放 cypher-executor/src**——rule 02 §2.2 hook 擋 cypher-executor TS hard-code endpoint，且 seed 資料本就屬 installer 職責）|
|
||||
| 新增 `cypher-executor/scripts/seed-api-recipes.ts` | seed **腳本**（給 prod 補灌用，import CLI 的種子資料；`scripts/` 不受 §2.2 hook 管）|
|
||||
| `cli/src/index.ts` | 註冊 `acr update` 指令 |
|
||||
|
||||
**不動**：cypher-executor 執行路徑、既有零件 wasm 源碼、config 讀取端（config.ts:52 已支援 self-hosted）。
|
||||
|
||||
---
|
||||
|
||||
## 5. API recipe seed（新增 seed-api-recipes.ts，richblack 2026-06-02 定）
|
||||
|
||||
codebase 只有 auth recipe seed。新增 `seed-api-recipes.ts`，把現役 API recipe hard-code 成種子。
|
||||
|
||||
### 現役 API recipe（從 prod KV 查得，2026-06-01）
|
||||
- `kbdb_get`（+ create_block / patch_block / delete / ingest）→ auth_service: kbdb
|
||||
- `gmail_send` → google_gmail_sa
|
||||
- `google_sheets_append` / `google_sheets_read` → google_sheets_sa
|
||||
- `telegram_send` → telegram
|
||||
- `line_notify_send` → line_notify
|
||||
|
||||
### KBDB recipe 採 Supabase 模式（richblack 2026-06-02）
|
||||
- **KBDB 是 richblack 提供的服務**（跟 arcrun 一樣），採「基礎免費、大量收費」。
|
||||
- KBDB recipe **進 seed**（展示能力 = 引子，Supabase 模式）。使用者要用 → 去 **arcrun 取統一 API Key**（已有 /register 入口），把 key 設成 credential。
|
||||
- ⚠️ **FOLLOW-UP（交 KBDB 端）**：現役 endpoint 是 `kbdb.finally.click{{_path}}`。richblack：這是 KBDB 端要改的問題——KBDB 該用統一對外網址提供大家用，不是 finally.click。**seed 先照現況進；KBDB 端改網址後同步更新 seed。** 此事不擋 init 實作。
|
||||
|
||||
---
|
||||
|
||||
## 6. 部署物產製：commit wasm 進 repo + codeload tarball（richblack 2026-06-02 定案）
|
||||
|
||||
> 此節**取代初稿的「GitHub release artifact」構想**。richblack 拍板更輕的做法：
|
||||
> 直接把預編譯 wasm commit 進 repo，CLI 從 GitHub codeload tarball 拿。不需 release.yml 機制。
|
||||
|
||||
### 6.1 策略
|
||||
|
||||
- **repo 自帶可部署的 wasm**：刪 `.gitignore` 的 `*.wasm` 排除，commit 預編譯 wasm 進 repo。
|
||||
→ repo 本身就是部署來源，CLI 直接拿、用戶用自己的 CF token deploy。
|
||||
- **CLI 走 codeload tarball**：`https://codeload.github.com/richblack/arcrun/tar.gz/{ref}`
|
||||
（ref = main 或 tag）。用戶不需 git、版本可控（tag）。`acr update` 拉新 ref。
|
||||
- **理由**（richblack）：「我在我的 CF 能用 = 我已擁有 wasm；用戶指向我的 GitHub 取得 wasm，
|
||||
用他自己的 CF credential deploy。開源，看不看源碼不重要，體驗好最重要。」
|
||||
|
||||
### 6.2 ⚠️ 推翻既有鐵律（rule 05）— 需同步改規則
|
||||
|
||||
`.claude/rules/05-deploy-convention.md` 明文「`.component-builds/{name}/component.wasm` **不 commit 進 repo**
|
||||
（build 產物）」「Phase 1-3 暫時 commit 過，**之後會加 .gitignore 清理**」。
|
||||
**本決策反向**：commit wasm 進 repo（self-host 需 repo 自帶可部署 wasm）。
|
||||
→ **實作時必須同步改 rule 05 + .gitignore**，否則 pre-write hook / 規則與實作打架。
|
||||
→ deploy.yml 的 CI rebuild 步驟仍保留（CI 部署 prod 時用最新 source rebuild，與 commit 的 wasm 不衝突；
|
||||
commit 的 wasm 是給「self-host 用戶 + acr init」用的部署來源）。
|
||||
|
||||
### 6.3 只 commit 部署所需的 wasm（省空間）
|
||||
|
||||
- 實況（2026-06-02 查）：`registry/components/*.wasm` 23 個（build 中間產物）+
|
||||
`.component-builds/*/component.wasm` 22 個（部署物），共 **~50MB**。
|
||||
- **部署只需 `.component-builds/*/component.wasm`**（wrangler deploy 認這個）。
|
||||
→ **只 commit `.component-builds/*/component.wasm`（22 個），不必 commit registry 那 23 個**（省一半）。
|
||||
`.gitignore` 改成：保留排除 `registry/components/**/*.wasm`（中間產物），只放行 `.component-builds/**/component.wasm`。
|
||||
- ⚠️ **誠實 trade-off**（mindset §7）：commit wasm 進 repo → 每次 wasm rebuild 都在 git 歷史累積二進位，
|
||||
**repo 長期會膨脹**。可接受（self-host 體驗優先），但記錄此代價；未來若膨脹過劇，再考慮 release artifact / git-lfs。
|
||||
|
||||
### 6.3.1 「錯做成零件」的 3 個不 commit（richblack 2026-06-02）
|
||||
|
||||
實際 commit 的是 **19 個正當零件**，不是 22。排除的 3 個：`claude_api` / `km_writer` / `kbdb_upsert_block`。
|
||||
- **原因（richblack 修正「待刪」說法）**：它們**不是 endpoint 薄殼，是把工作流硬塞進零件**（違反 DECISIONS §1）。
|
||||
例：`kbdb_upsert_block` 的 upsert 邏輯應在 KBDB API 那邊（API 提供 upsert endpoint），零件只該驅動它；
|
||||
現在卻把「GET 找→有則 PATCH 無則 POST」整段工作流塞進零件。本質是工作流/recipe，被錯做成零件。
|
||||
- **為何「現在就不 commit」而非「先 commit 之後刪」**：commit 二進位進 git 歷史後，即使日後 `git rm`，
|
||||
歷史裡仍永久殘留（repo 體積已被佔），除非 rewrite history（很麻煩）。**錯誤的東西不灌進永久歷史。**
|
||||
- **落地**：`.gitignore` 放行 22 個後**再排除這 3 個**（後出現規則勝出）；`deploy.ts discoverWorkerDirs`
|
||||
只部署「同時有 wrangler.toml + component.wasm」的目錄 → self-host 用戶 codeload 拿到的目錄缺這 3 個 wasm → 自然跳過。
|
||||
- **後續**：這 3 個的降級（變回工作流/recipe）是 BACKLOG 既有待辦，本次不處理，但確保它們不進 self-host 部署來源。
|
||||
|
||||
### 6.4 CLI deploy 流程（deploy.ts downloadAndDeploy 補實作）
|
||||
|
||||
```
|
||||
1. 下載 codeload tarball（ref 預設 main，acr update 可帶 tag）→ 解壓 ~/.arcrun/.deploy-<ref>/
|
||||
2. 讀解壓出的 .component-builds/* + cypher-executor/ + registry/
|
||||
3. 各 wrangler.toml 注入 ctx.kvNamespaceIds + cypher-executor WORKER_SUBDOMAIN
|
||||
4. tier1=.component-builds/*（先）→ tier2=cypher-executor/registry（後）
|
||||
每個 dir：pnpm install（若有 lock）→ CLOUDFLARE_API_TOKEN=<用戶> wrangler deploy
|
||||
5. 回 cypherExecutorUrl = https://arcrun-cypher-executor.<subdomain>.workers.dev
|
||||
```
|
||||
|
||||
注意：tier2（cypher-executor/registry）是 TS，wrangler deploy 會在用戶端用內建 esbuild bundle
|
||||
（不需額外工具，richblack 確認源碼可見不重要、體驗優先 → artifact 含 TS 源碼即可）。
|
||||
|
||||
### 6.5 實作順序
|
||||
|
||||
1. 改 `.gitignore`（放行 `.component-builds/**/component.wasm`）+ commit 22 個 wasm。
|
||||
2. 同步改 rule 05（記錄此決策推翻原慣例）。
|
||||
3. 補實 `deploy.ts downloadAndDeploy`（codeload 下載 + 注入 + wrangler deploy）。
|
||||
4. **在 1-2 完成前，downloadAndDeploy 維持誠實 unimplemented，不假裝（mindset §7）。**
|
||||
|
||||
### 6.6 未來方向：零件按需安裝（richblack 2026-06-02，現在不做）
|
||||
|
||||
- 現在 `acr init --self-hosted` **全裝基礎零件**（22 個一次部署）。簡單、夠用。
|
||||
- **未來若零件數量真的變很多**，再思考「按需安裝」（只裝 workflow 實際用到的零件 / 用戶選裝）。
|
||||
- **現在不做的理由**（DECISIONS 附錄「會不會累積成債」）：零件目前少且未來絕大多數是 recipe
|
||||
（不需 deploy）→ 為「零件爆量」做按需安裝基建 = 為不存在的規模做自動化 = 過度工程。
|
||||
零件真的爆量再回頭做，屆時是「未來一次性處理的設計點」，現在不必焦慮。
|
||||
|
||||
---
|
||||
|
||||
## 7. 驗收標準（客觀證據，mindset §7）
|
||||
|
||||
1. richblack 用**全新 CF 帳號** + wrangler 已裝 + 一個 CF API Token 跑 `acr init --self-hosted`
|
||||
→ 全程無手動建 KV / 無手動 clone / 無 tinygo / 無手動填 namespace id。
|
||||
2. 跑完印 secret 提示，richblack 手動 `wrangler secret put ENCRYPTION_KEY` ×3。
|
||||
3. `acr push` 一個含 http_request + 自建 recipe 的 workflow → trigger → **HTTP 2xx + execution trace**。
|
||||
4. 冪等：重跑 init 不重建已存在 KV / 不報錯。
|
||||
5. `acr update` 拉新 codeload tarball（tag）→ 重部署成功。
|
||||
|
||||
---
|
||||
|
||||
## 8. 為何不違反鐵律
|
||||
|
||||
- 只動 `cli/` + 新增 `cypher-executor/scripts/`（seed 腳本，非執行路徑業務邏輯）。
|
||||
- 不在 `registry/components/` 寫 TS；不在 cypher-executor TS 實作 credential/auth/JWT。
|
||||
- 不新增 Service Binding。
|
||||
- secret 不進自動化（§3 step 8 手動）。
|
||||
- 不重寫部署輪子（用 wrangler，不自寫 CF Script Upload）。
|
||||
@@ -0,0 +1,138 @@
|
||||
# Implementation Plan: arcrun SDK Libraries + Website
|
||||
|
||||
## Overview
|
||||
|
||||
按 Design 的四個 Phase 實作。原則：修改不重建，SDK 是 HTTP API thin wrapper，加密只在 client 做 encrypt（不做 decrypt）。
|
||||
|
||||
**前置依賴**：必須先完成 `credential-primitives-wasm/tasks.md` 的 Phase 0-3（核心合併 + WASM primitives），確認核心穩定後才開始建三個介面。
|
||||
|
||||
---
|
||||
|
||||
## Phase 0（前置）：核心合併 + WASM 改寫
|
||||
|
||||
> 詳見 `.agents/specs/arcrun/credential-primitives-wasm/tasks.md`
|
||||
>
|
||||
> 摘要：
|
||||
> - 合併 u6u-core → arcrun（搬 builtins、刪重複 credentials）
|
||||
> - credential-injector TS → auth_static_key / auth_service_account WASM
|
||||
> - 刪除 component-loader 內建 API recipes TS
|
||||
> - 驗證 20 個 auth recipe 正常運作
|
||||
|
||||
---
|
||||
|
||||
## Phase 1：Python SDK
|
||||
|
||||
- [ ] 1. 建立 `arcrun/python-sdk/` 目錄
|
||||
- [ ] 1.1 `pyproject.toml`：name=arcrun, deps=[httpx>=0.27, cryptography>=42], build-system=hatchling
|
||||
- [ ] 1.2 `arcrun/__init__.py`：`from .client import Arcrun`
|
||||
- [ ] 1.3 `arcrun/crypto.py`：AES-GCM encrypt only（使用 `cryptography` 套件）
|
||||
- [ ] 1.4 `arcrun/creds.py`：CredentialsClient — push（加密 + POST /credentials）、list（GET /credentials）、delete
|
||||
- [ ] 1.5 `arcrun/auth.py`：AuthClient — setup（fetch recipe → match secrets → encrypt → push）、bind（fetch recipe → resolve headers from cache → return AuthenticatedClient）、get_token、list_services
|
||||
- [ ] 1.6 `arcrun/workflows.py`：WorkflowClient — run（POST /webhooks/named/{name}/trigger）、push（POST /webhooks/named）、list（GET /webhooks/named）、delete
|
||||
- [ ] 1.7 `arcrun/client.py`：Arcrun class — 讀 api_key / encryption_key 從 param > env > config.yaml
|
||||
|
||||
- [ ] 2. 修正上次已知的 bug
|
||||
- [ ] 2.1 `_fetch_recipe()` 回應是 `{ success: true, recipe: {...} }`，需讀 `.recipe` 欄位
|
||||
- [ ] 2.2 `inject` 下的 key 是 `header`（singular），不是 `headers`
|
||||
- [ ] 2.3 `required_secrets[].key` 是 prefixed（如 `openai_api_key`），setup() 的 kwargs alias 要能對應
|
||||
- [ ] 2.4 `list_services()` 回應的 recipe 用 `service` 欄位（不是 `service_id`）
|
||||
|
||||
- [ ] 3. 測試（對 cypher.arcrun.dev live API）
|
||||
- [ ] 3.1 `health()` → `{"ok": true}`
|
||||
- [ ] 3.2 `auth.list_services()` → 20 個服務
|
||||
- [ ] 3.3 `auth.setup("openai", api_key="sk-test-dummy")` → 成功
|
||||
- [ ] 3.4 `auth.bind("openai")` → AuthenticatedClient with Authorization header
|
||||
- [ ] 3.5 `auth.get_token("openai")` → "sk-test-dummy"
|
||||
- [ ] 3.6 `creds.push("test_token", "value123")` → 成功
|
||||
- [ ] 3.7 `creds.list()` → 含 "test_token"（注意 KV eventual consistency）
|
||||
- [ ] 3.8 `workflows.list()` → []
|
||||
- [ ] 3.9 cleanup: `creds.delete("test_token")`
|
||||
|
||||
---
|
||||
|
||||
## Phase 2：JS/TS SDK
|
||||
|
||||
- [ ] 4. 建立 `arcrun/js-sdk/` 目錄
|
||||
- [ ] 4.1 `package.json`：name TBD（arcrun vs @arcrun/sdk），deps=devDeps only（tsup, typescript, @types/node）
|
||||
- [ ] 4.2 `tsconfig.json`：ES2020, NodeNext
|
||||
- [ ] 4.3 `src/crypto.ts`：Web Crypto API AES-GCM encrypt only
|
||||
- [ ] 4.4 `src/creds.ts`：CredentialsClient — push/list/delete via fetch
|
||||
- [ ] 4.5 `src/auth.ts`：AuthClient — setup/bind/getToken/listServices
|
||||
- [ ] 4.6 `src/workflows.ts`：WorkflowClient — run/push/list/delete
|
||||
- [ ] 4.7 `src/index.ts`：export class Arcrun + re-exports
|
||||
|
||||
- [ ] 5. 同步修正（與 Python SDK 同樣的 recipe 格式問題）
|
||||
- [ ] 5.1 `_fetchRecipe()` 讀 `body.recipe`
|
||||
- [ ] 5.2 inject key: `header` not `headers`
|
||||
- [ ] 5.3 setup() secret key alias matching
|
||||
- [ ] 5.4 listServices() 用 `service` 欄位
|
||||
|
||||
- [ ] 6. Build + 測試
|
||||
- [ ] 6.1 `tsup` build → dist/index.js + dist/index.cjs + dist/index.d.ts
|
||||
- [ ] 6.2 Node.js 腳本對 live API 測試（同 Python 測試項目）
|
||||
|
||||
---
|
||||
|
||||
## Phase 3：arcrun.dev 網站
|
||||
|
||||
- [ ] 7. 新增 `/components` 頁面
|
||||
- [ ] 7.1 從 `registry/components/*/component.contract.yaml` 讀取 21 個零件資料
|
||||
- [ ] 7.2 卡片顯示：canonical_id, display_name, description, input required/optional, credentials_required, config_example
|
||||
- [ ] 7.3 分類篩選：邏輯類 / API 類 / 控制流類
|
||||
|
||||
- [ ] 8. 更新首頁
|
||||
- [ ] 8.1 Code demo tabs 改為 CLI / Python / JS 三個
|
||||
- [ ] 8.2 CLI tab 展示 `acr init → acr push → acr run`
|
||||
- [ ] 8.3 Python tab 展示 `pip install arcrun → Arcrun() → auth.setup → auth.bind`
|
||||
- [ ] 8.4 JS tab 展示 `npm install arcrun → new Arcrun() → auth.setup → auth.bind`
|
||||
|
||||
- [ ] 9. OAuth 流程補完
|
||||
- [ ] 9.1 確認 cypher-executor 的 `/auth/google/start`、`/auth/github/start`、`/auth/callback` 路由正確
|
||||
- [ ] 9.2 提供 richblack OAuth secrets 設定指令清單
|
||||
- [ ] 9.3 richblack 設定 secrets 後驗證登入流程
|
||||
|
||||
- [ ] 10. 部署
|
||||
- [ ] 10.1 Cloudflare Pages build + deploy
|
||||
- [ ] 10.2 驗證所有頁面可存取
|
||||
|
||||
---
|
||||
|
||||
## Phase 4：README + 發布
|
||||
|
||||
- [ ] 11. 更新 `arcrun/README.md`
|
||||
- [ ] 11.1 三種 Quick Start（CLI / Python / JS）
|
||||
- [ ] 11.2 零件列表（21 個）
|
||||
- [ ] 11.3 Auth Recipe 列表（20 個服務）
|
||||
- [ ] 11.4 連結到 arcrun.dev 和 Swagger UI
|
||||
|
||||
- [ ] 12. 發布
|
||||
- [ ] 12.1 Python SDK：`pip install build && python -m build && twine upload dist/*`
|
||||
- [ ] 12.2 JS SDK：`npm run build && npm publish`
|
||||
- [ ] 12.3 驗證：從零開始 `pip install arcrun` / `npm install arcrun` + hello world
|
||||
|
||||
---
|
||||
|
||||
## Phase 5：acr init --self-hosted installer（2026-06-02 新增）
|
||||
|
||||
> 定稿 design：`self-hosted-init.md`。CLI = installer：建 KV/R2 + 拉預編譯 wasm + wrangler deploy + seed。
|
||||
> 用戶只做：申請 CF 帳號 → 裝 wrangler → 裝 acr → acr init --self-hosted。其餘自動。
|
||||
> 背景：戰法轉 self-hosted 開源（docs/HANDOFF-self-host-harness.md）。
|
||||
|
||||
- [x] 13.1 API recipe 種子 — **位置修正**：種子資料放 `cli/src/lib/api-recipe-seeds.ts`（installer 用，避開 cypher §2.2 hook），seed 腳本 `cypher-executor/scripts/seed-api-recipes.ts`（import 種子，給 prod 補灌）。10 個現役 recipe（kbdb_*/gmail_send/google_sheets_*/telegram_send/line_notify_send）。KBDB Supabase 模式進 seed（finally.click 是 KBDB 端 follow-up，已註於 api-recipe-seeds.ts）
|
||||
- [x] 13.2 `cli/src/lib/cf-api.ts` 新增 `CfAccountClient`：verifyAccess / listKvNamespaces / ensureKvNamespace（冪等）/ ensureR2Bucket（冪等）/ getWorkersSubdomain
|
||||
- [x] 13.3 `cli/src/commands/init.ts` `initSelfHosted()` 改寫：驗 token → 建 7 KV + R2 → 查 subdomain → downloadAndDeploy → 寫 config → seed（部署完成時）→ 印 secret 提示。誠實：部署未自動化時明說，不假綠
|
||||
- [x] 13.4 `cli/src/lib/deploy.ts`：REQUIRED_KV/R2/SECRET 常數 + wranglerAvailable() + **downloadAndDeploy 已補實**（codeload tarball 下載 + 解壓 + discoverWorkerDirs 分 tier + injectWranglerConfig 注入 KV id/subdomain + runWranglerDeploy；部分失敗誠實收集回報，不假綠）
|
||||
- [x] 13.5 `cli/src/commands/update.ts` + index.ts 註冊 `acr update`（self-hosted 重部署，同走 downloadAndDeploy）
|
||||
- [x] 13.6 部署物產製：**改用 commit wasm 進 repo + codeload**（取代 release artifact，richblack 2026-06-02，§6）
|
||||
- `.gitignore` 否定規則放行 `.component-builds/**/component.wasm`（registry 中間產物仍排除）→ 已驗 git check-ignore
|
||||
- rule 05 同步改（記錄推翻「wasm 不 commit」+ trade-off）
|
||||
- commit 22 個 `.component-builds/*/component.wasm` 進 repo
|
||||
- [ ] 13.7 驗收：全新 CF 帳號跑 acr init --self-hosted 全自動；acr push workflow → trigger 2xx + trace（**待 richblack 用第二帳號實測** + push 含 wasm 的 commit 到 GitHub 後 codeload 才拿得到）
|
||||
- [x] 13.8 typecheck：cli `tsc --noEmit` exit 0
|
||||
|
||||
## Notes
|
||||
|
||||
- JS SDK 套件名需 richblack 決定（`arcrun` 已被 CLI 佔用 → 可能用 `@arcrun/sdk`）
|
||||
- OAuth secrets 設定需 richblack 手動操作（GCP Console + GitHub Settings）
|
||||
- `bind()` 跨 session 限制是已知的，封測期間先接受
|
||||
- credential 加密用的 `encryption_key` 目前由 `/register` 回傳，`acr init` 自動存入 config
|
||||
@@ -0,0 +1,218 @@
|
||||
# Design: Component Gatekeeping（零件投稿真把關）
|
||||
|
||||
> 2026-05-29。實作 requirements.md 的 R1-R6。
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ 方向修正（richblack 2026-05-30）：投稿走 GitHub PR，廢 registry self-service
|
||||
|
||||
**零件投稿管道 = GitHub PR，不是 registry submit API。** 理由與影響見下；以下 §0-§9 的 registry submit 設計，
|
||||
凡屬「self-service 投稿管道」者**作廢**，凡屬「把關邏輯」者**搬到 CI（PR check）跑**。
|
||||
|
||||
**為何改：** primitive 極少、未來絕大部分是 recipe → 新增零件是稀有低頻事件，不需 self-service 自動化管道。
|
||||
PR 天然滿足每道閘門：
|
||||
|
||||
| 設計的閘門 | PR 怎麼天然滿足 |
|
||||
|---|---|
|
||||
| G0 人類閘門 | PR 必須有人 merge（richblack approve）；AI 偽造不了 GitHub approve |
|
||||
| 舉證「為何不是工作流」 | PR description，review 時看 |
|
||||
| G1 假零件 / G3 純WASI / G4 Gherkin / 覆蓋檢查 / 黃金向量 | **CI（PR check）跑** —— CI 有 tinygo + 能 runtime 跑 wasm，**繞開 CF Workers 不能 runtime 編譯 wasm 的 venue 牆** |
|
||||
|
||||
**§8 衝突釐清：** DECISIONS §8「不依賴 GitHub Actions」指**執行鏈路**（init/push/run/recipe，常態高頻，
|
||||
用戶機器+CF）。**零件投稿是稀有低頻、該由 PR 治理**，用 PR/CI 不違反 §8——反而更對（CI 能跑 wasm，
|
||||
registry Worker 不能）。需在 DECISIONS 補這個區別（待 richblack 確認改穩定文件）。
|
||||
|
||||
**哪些作廢 / 哪些保留：**
|
||||
- ❌ 作廢：registry submit API 當主投稿管道、四路（CLI/MCP/py/js）self-service 投稿、平台端 sandbox 重跑、`acr parts publish` 加人類閘門（投稿不走 CLI 了）。
|
||||
- ✅ 保留並搬 CI：G1 假零件偵測邏輯（detectFakeComponent.ts）、G3 純WASI（wasmImports.ts）、G4 Gherkin 真跑（CI 能跑 wasm）、B 覆蓋檢查、黃金向量人工核對。
|
||||
- ✅ 已 commit 的 registry G0/G1/G3 程式碼**保留不刪**（無害，且 G1/G3 邏輯被 CI 複用），但 registry submit 不再是主管道。
|
||||
- ✅ R5 本機 hook（擋 CC 直接造零件目錄）仍要 —— 它擋的是「繞過 PR 直接改 repo」，與 PR 管道互補。
|
||||
|
||||
**以下 §0-§9 為原 design，閱讀時套用上述修正。**
|
||||
|
||||
---
|
||||
|
||||
## 0. 架構總覽
|
||||
|
||||
### 0.0 範圍：把關跨公共庫 + self-hosted 私人庫（richblack 2026-05-29）
|
||||
|
||||
把關**不是公共庫專屬**。每個 self-hosted 部署有自己的零件庫（自己的 registry Worker）。
|
||||
**加入公共庫或任何 self-hosted 私人庫，都跑同一套把關鏈（G0-G6 + 本機 hook）。**
|
||||
- 實作上天然成立：把關邏輯在 registry Worker code 裡，self-hosted 跑同一份 registry → 把關跟著走，不需公私庫分兩套。
|
||||
- G0 人類閘門在 self-hosted 下，「人類」= 部署擁有者本人（防的是「他的 AI 自作主張把東西做成零件」，不是防他本人；他自己確認 + 舉證即可過）。
|
||||
- 理由：self-hosted 一樣有「自用服務沒驗證就變零件」的風險，且私人庫零件之後可能貢獻回公共。
|
||||
|
||||
### 0.1 把關鏈
|
||||
|
||||
投稿零件的唯一入口是 registry Worker 的 submit。把關鏈（依序，任一失敗即退稿）：
|
||||
|
||||
```
|
||||
submit 請求（帶 wasm + contract + 人類確認憑證 + 舉證）
|
||||
│
|
||||
├─ G0 人類閘門（R4） ← 最先擋：沒人類確認 + 舉證 → 403
|
||||
├─ G1 假零件偵測（R2） ← contract/原碼有外部 URL 或 http 子集 → 退稿指回正路
|
||||
├─ G2 size_check（已有）
|
||||
├─ G3 syscall_scan + 純WASI（R3）← 擴充：只准 WASI preview1 + u6u host func 白名單
|
||||
├─ G4 gherkin_tests（R1） ← 真跑 WASM，given→stdin→比對 then_contains
|
||||
├─ G5 cold_start（mock，標未實作）
|
||||
└─ G6 runtime_compat（mock，標未實作）
|
||||
→ 全過 → 派 hash → 寫 KV
|
||||
```
|
||||
|
||||
另一道獨立防線：**本機 hook**（R5），擋 CC 繞過 API 直接在 repo 造零件目錄。
|
||||
|
||||
---
|
||||
|
||||
## 1. G0 人類閘門（R4）— registry submit endpoint
|
||||
|
||||
### 1.1 請求格式增欄
|
||||
submit 請求 body 增兩個欄位：
|
||||
```ts
|
||||
interface SubmitRequest {
|
||||
wasm_base64: string;
|
||||
contract: ComponentContract;
|
||||
human_confirmation?: {
|
||||
confirmed_by_human: true; // 必須為 literal true
|
||||
reason_why_not_workflow: string; // 非空，AI 舉證
|
||||
confirmed_at: string; // ISO timestamp
|
||||
};
|
||||
skip_acceptance?: boolean; // 既有：backfill 用（仍保留）
|
||||
}
|
||||
```
|
||||
|
||||
### 1.2 閘門邏輯
|
||||
```
|
||||
若 skip_acceptance（backfill 既有零件）→ 跳過 G0（這些是已驗、已部署的存量，不是新投稿）
|
||||
否則（新投稿）：
|
||||
若無 human_confirmation 或 reason_why_not_workflow 空 → 403：
|
||||
"建零件需人類確認。請用 `acr parts publish`（會互動式問你），
|
||||
並說明為何工作流做不到。預設假設工作流能做——先試工作流 / recipe。"
|
||||
記錄 reason_why_not_workflow 進 KV metadata（軌跡可審）
|
||||
```
|
||||
|
||||
### 1.3 四路收斂（CLI / MCP / Python / JS）
|
||||
- 它們建零件都呼叫 registry submit endpoint → G0 在 endpoint，自動四路通管。
|
||||
- **CLI `acr parts publish`**：強制互動式 prompt 問人類「(1) 工作流為何做不到？(2) 確認要建零件？」，把答案組成 `human_confirmation` 送出。非互動環境（AI 直跑）`acr` 偵測 stdin 非 TTY → 拒絕並提示「需人類互動」。
|
||||
- MCP / Python / JS lib：傳 `human_confirmation` 才能成功；它們的 SDK 文件註明此欄位需人類提供。
|
||||
- **誠實限制**（寫進 mindset + 文件）：AI 技術上能偽造 `confirmed_by_human:true`。靠 reason 留記錄 + mindset 明示「絕不代替人類確認建零件」+ 軌跡可審，讓偽造成明確越界，不聲稱不可能繞過。
|
||||
|
||||
## 2. G1 假零件偵測（R2）
|
||||
|
||||
新增 `detectFakeComponent(contract, wasmBytes): string | null`：
|
||||
- (a) **外部 URL/domain**：掃 contract 的 description / input_schema / output_schema 文字，及 wasm binary 文字，比對 URL pattern（`https?://`、常見 domain）。命中 → 退稿。
|
||||
- (b) **http_request 子集**：若 contract 宣告只做「打固定 endpoint」（heuristic：description 含「打/呼叫 ... API/endpoint」且 input 有 url-like 欄位且無實質邏輯運算），標記疑似。
|
||||
- 退稿訊息：「偵測到疑似假零件（寫死 endpoint / http 子集）。這該是 API recipe（http_request + 固定設定）或工作流，不是零件。見 DECISIONS §1。」
|
||||
- 排除：`auth_*` primitive（credential 後端，DECISIONS §3b 不適用假零件判準）、`http_request` 自己。
|
||||
|
||||
## 3. G3 純 WASI 把關（R3）
|
||||
|
||||
擴充現有 `scanSyscalls`：
|
||||
- 現況：掃 `FORBIDDEN_SYSCALLS` 黑名單。
|
||||
- 擴充：改為「import 白名單」——解析 wasm import section，確認所有 import module 只屬 `wasi_snapshot_preview1` + `u6u`（host functions）。出現其他 module → 退稿（runtime 鎖定風險）。
|
||||
- 實作：簡易 wasm import section 解析（不需完整 wasm parser，掃 import 段的 module name 字串）。
|
||||
|
||||
## 4. G4 Gherkin 真實作（R1）— **修訂（2026-05-29，richblack review）**
|
||||
|
||||
### 4.0 為何不能在 registry Worker 跑（原設計作廢）
|
||||
原設計假設 registry Worker instantiate 投稿 wasm 跑 Gherkin。**此假設錯誤**：
|
||||
- **Cloudflare Workers 禁止 request-time 編譯 WASM**（`new WebAssembly.Module(bytes)` / `WebAssembly.compile()` 只能 startup 用 bundle 的 module；workers-types 把 `Module` 標 abstract 正反映此限制）。registry 收到的是 runtime 投稿 bytes → 跑不了。
|
||||
- DECISIONS §8：第一期**不依賴 GitHub Actions** → 也不能靠 CI 跑 Gherkin。
|
||||
- 剩下唯一一致 venue = **投稿者本地機器**（有 tinygo + 能跑 wasm，與現有 build 流程同環境）。
|
||||
|
||||
### 4.1 正確設計：Gherkin 在投稿指令本地跑
|
||||
零件投稿走一個**獨立 CLI 指令**（既有指令；「本地或公共都是投稿」）：
|
||||
1. 本地 `tinygo build`（或讀已 build 的 .wasm）。
|
||||
2. **本地跑 Gherkin**：對每個 `gherkin_tests[]`，用 Node 的 WebAssembly + 同一份 wasi-shim instantiate wasm，given→stdin→run→比對 then_contains。Node 環境能 runtime 編譯 wasm（不像 CF Workers）。
|
||||
3. 任一 scenario 失敗 → 投稿指令本地就擋下，不送出。
|
||||
4. 通過 → 把**測試結果隨投稿上傳**（見 4.2）。
|
||||
|
||||
`runGherkin.ts`（已寫，用 createWasiShim）邏輯正確，只是**執行 venue 從 registry Worker 改成 CLI（Node）**。registry 端不再跑 Gherkin。
|
||||
|
||||
### 4.2 「平台看得到測試結果」（呼應 §3c：執行者不能驗證自己）
|
||||
投稿 payload 帶 `gherkin_evidence`：每個 scenario 的 `{scenario, given, actual_stdout, passed}`。
|
||||
- registry 存進 KV metadata（軌跡可審）。
|
||||
- 平台看得到**原始 stdout**，不是只看投稿者宣稱的「passed」。
|
||||
- **誠實限制**（同人類閘門）：本地跑 + 自報結果，AI 技術上能偽造 actual_stdout。靠軌跡可審 + mindset 明示 + 未來 §3c 的 test/relay（投稿走 relay 讓平台當下親跑，第一期後）補強。第一期是「本地跑 + 上傳證據 + 可審」，不聲稱不可繞過。
|
||||
|
||||
### 4.3 公私庫分流（投稿指令旗標）
|
||||
- 預設投稿 → **私人庫**（self-hosted 自己的 registry）。
|
||||
- `-p` / `--public` → 推**公共庫**。
|
||||
- 兩者都跑同一套把關（§0.0：跨公私庫同一套）。差別只在目標 registry。
|
||||
|
||||
### 4.4 registry 端對應
|
||||
- registry submit 仍跑 G1（假零件）、G3（純WASI）——這兩個是**靜態掃描，不需執行 wasm，CF Worker 可跑**。
|
||||
- G4 Gherkin 的執行移到 CLI；registry 收 `gherkin_evidence` 存證、可選做輕量一致性檢查（evidence 的 scenario 數與 contract.gherkin_tests 對得上、每個 passed=true），但**不重跑**（跑不了）。
|
||||
- G5/G6（cold_start/runtime_compat）維持 unimplemented_steps 標記。
|
||||
|
||||
## 4.5 信任模型與發佈風險（richblack 2026-05-29 定，重要——勿誤讀為零風險）
|
||||
|
||||
**Gherkin 全綠 ≠ 零件安全可發佈。** 把關能驗到什麼、不能驗到什麼，要說清楚：
|
||||
|
||||
### 把關各層各防什麼
|
||||
| 層 | 防得了 | 防不了 |
|
||||
|---|---|---|
|
||||
| G4 Gherkin | 「零件對宣稱的 given 不 work」 | 「Gherkin 寫得避重就輕、只測會過的 case」——投稿者可寫不完整的測試，沒測到的 input 仍可能出錯/惡意 |
|
||||
| G1 假零件 / G3 純WASI | 連外 / 非 WASI / 寫死 endpoint | 沙箱內的邏輯錯誤 |
|
||||
| **純 WASI 沙箱（真正的發佈底氣）** | **框死零件能做的事**：只能 stdin→stdout，無網路 syscall、無檔案系統、無 host 能力（除白名單 host func）→ 就算邏輯有問題或惡意，傷害被沙箱框死 | 沙箱允許範圍內的錯誤輸出 |
|
||||
| 市場機制（§1） | 長尾：別人用了發現不對 → 回報 → 修 | 投稿當下測不到的 |
|
||||
|
||||
**結論：發佈非零風險，是風險可控。** 主要安全保證是**純 WASI 沙箱框死能力**（不是 Gherkin）。Gherkin 驗行為契約、沙箱框死破壞力、市場補長尾，三者合起來讓「發佈陌生人的零件」風險可控到能接受。
|
||||
|
||||
### 信任層級（誰跑 Gherkin 決定可信度，§3c：執行者不能驗證自己）
|
||||
- **第一期**：投稿者**本地跑 + evidence 上傳可審**。AI 技術上能偽造 actual_stdout（它控制本地環境）。**誠實標明：第一期 evidence 可造假**，靠純 WASI 沙箱 + 軌跡可審 + mindset 撐著。
|
||||
- **未來**：平台**自己重編源碼 + 重跑 Gherkin**（投稿者無法造假「跑的結果」）。需要能 runtime 跑 wasm 的 venue——**非 CF Worker（不能 runtime 編譯）、非 CI（§8 不依賴）**——可能是公共庫專屬的 sandbox 服務。列未來，可能擋公共庫「完全可信發佈」。
|
||||
- 再往後：§3c 的 test/relay（投稿走 relay 讓平台當下親跑）。
|
||||
|
||||
## 5. G5/G6 mock 標未實作（R3 誠實）
|
||||
|
||||
- cold_start / runtime_compat 保留 mock，但 **SandboxResult 增 `unimplemented_steps: string[]`**，回傳時明列 `["cold_start","runtime_compat"]`，submit 回應與文件明示「這兩步未實作、未真正驗證」。不回 `success:true` 假裝全綠——回 success 但附 unimplemented 清單。
|
||||
|
||||
## 5.5 黃金向量：人工核對 + B 覆蓋檢查（richblack 2026-05-30 定）
|
||||
|
||||
Claude.ai 建議用「黃金向量 + 把關自己重跑」自動驗收，防放水的 Gherkin。**價值保留，實作降級**，理由：
|
||||
|
||||
- **primitive 極少、未來絕大部分是 recipe**（人類閘門 + 工作流優先把零件擋在源頭）。現役 17 白名單 + cron/platform_crypto，未來極少新增。
|
||||
- 「把關自動重跑向量」是為「零件大量增加」做的規模化基建——但零件不會大量增加 → 為不存在的規模做自動化 = 過度工程（DECISIONS 附錄「會不會累積成債」判準）。
|
||||
- 且「把關自己重跑 wasm」撞 venue 牆（CF 不能 runtime 編譯 wasm，同 §4.0）→ 需平台端 sandbox（第一期沒有）。
|
||||
|
||||
**降級後做法：**
|
||||
- **A 黃金向量 conformance → 人工核對**：黃金向量當「人類閘門時用 CC 核對 primitive 的對照表」。新增 primitive（極稀有）時，人類閘門已要你親自確認，那一刻用 CC 本地跑向量核對（本地有 tinygo + 能跑 wasm，繞開 venue 牆）、人工凍結。**不做機器自動重跑。**
|
||||
- **B 覆蓋檢查 hook → 現在做（純靜態、不可造假、成本低、價值與零件數無關）**：靜態 parse contract：`input_schema` 每個 required 欄位至少出現在一個 Gherkin given、`output_schema` 每個欄位至少被一個 then_contains 斷言。缺 → exit 2 指出漏哪個欄位。擋「只測 happy path、不碰宣告過的行為面」。
|
||||
- **初始向量來源（信任根：寫向量≠寫實作）**：另起 session 從 contract 語義寫、不看實作原碼（primitive 語義客觀如 add(2,2)=4）。人工核對用，不急、新增 primitive 時逐個補，不必 21 個一次到位。
|
||||
- 殘留（誠實）：向量/覆蓋檢查擋不住「列出的 case 全對、沒列到的 case 錯」。交給「用」——出 bug 補進向量，永不 regress。是會長大的網，非設一次完美。
|
||||
|
||||
## 6. R5 白名單 + 本機 hook
|
||||
|
||||
- `registry/MVP_COMPONENTS.txt`：一行一個白名單 canonical_id（現役 22 個）。
|
||||
- `pre-write-guard.sh` 增規則：寫入 `registry/components/{name}/...` 且 `{name}` 不在 MVP_COMPONENTS.txt → exit 2，訊息「新增零件需走 submit API 人類閘門，不可直接造 repo 目錄」。
|
||||
- `pre-bash-guard.sh` 增規則：`mkdir .../registry/components/{白名單外}` → exit 2。
|
||||
- `.ts` 偵測現有 hook 已做（rule 1.1）。
|
||||
- **B 覆蓋檢查**（5.5）：可放 registry submit 的靜態驗收（不需跑 wasm，CF 可跑）或 pre-write hook，擋宣告過的欄位沒被 Gherkin 測到。
|
||||
|
||||
## 7. 範圍邊界
|
||||
|
||||
- **動 registry TS**（sandboxAcceptance / submitComponent / routes / types）+ **CLI**（acr parts publish，既有指令）+ **hook**。
|
||||
- 不動 cypher-executor 執行路徑、不動既有零件 wasm。
|
||||
- backfill 路徑（skip_acceptance）保持可用，不被新閘門擋（存量零件不需人類閘門）。
|
||||
- CLI/MCP/Python/JS 四路：本期至少做 CLI `acr parts publish` + registry endpoint 強制；MCP/Python/JS 補 `human_confirmation` 欄位支援（薄）。
|
||||
|
||||
## 8. 驗收標準
|
||||
|
||||
- 投一個寫死 endpoint 的假零件 → G1 退稿（終端輸出）。
|
||||
- 投一個 `.ts` 進 registry/components → hook exit 2。
|
||||
- 投一個白名單外的新零件目錄（本機造）→ hook exit 2。
|
||||
- 無 human_confirmation 的 submit → 403。
|
||||
- 帶 human_confirmation + 過 Gherkin 的真零件 → 通過、寫 KV、reason 留 metadata。
|
||||
- Gherkin given/then 對真零件跑綠；故意改壞 then_contains → 退稿。
|
||||
- cold_start/runtime_compat 在回應裡列入 unimplemented_steps（不假綠）。
|
||||
|
||||
## 9. 決議（richblack 2026-05-29 design review 定）
|
||||
|
||||
- **Q1 → 消解**：Gherkin 測的零件**永遠是封閉邏輯（框架），不連外**。任何要加外部 URL 的東西按定義就是 recipe，不是零件——這種「連外零件」根本不該存在（會被 G1 假零件偵測擋下、降成 recipe）。所以 G4 Gherkin 只跑不需 host function 的封閉邏輯零件，**不需要 mock host func、不需要 skip 機制**。零件用 `u6u.http_request` 連外 = G1 直接退稿。
|
||||
- **Q2 → 兩者都硬擋**：(a) contract/原碼有具體外部 URL/domain → 硬退稿；(b) 宣告能力是 http_request 子集 → 也硬退稿。理由：與 Q1 一致——零件不該連外，這兩個 pattern 都是「該是 recipe 的東西偽裝成零件」，硬擋無誤殺顧慮（真的要連外就去做 recipe）。
|
||||
- **Q3 → submit 過閘門後自動 append**：人類閘門通過 + 驗收綠的零件，submit 成功時自動把 canonical_id append 進 `MVP_COMPONENTS.txt`。白名單反映「已正當投稿的零件」，不需手動維護。本機 hook 讀此檔擋「白名單外的直接造目錄」。
|
||||
|
||||
### Q1 連帶結論（強化 G1）
|
||||
既然「零件不連外、連外即 recipe」是硬規則，G1 假零件偵測 = G4 Gherkin 的前置守門：
|
||||
G1 擋掉所有連外/http 子集的投稿 → 能進到 G4 的必然是封閉邏輯零件 → Gherkin 必然不需 host func。
|
||||
兩道閘門邏輯自洽。
|
||||
@@ -0,0 +1,105 @@
|
||||
# Design 補充：recipe 入庫把關（push 那一刻）
|
||||
|
||||
> 2026-06-01。本檔是 `component-gatekeeping/design.md` 的單檔補充（規則 02 §4.3 允許）。
|
||||
> **狀態：待 richblack review 才動 code（這是 change）。**
|
||||
> 背景：richblack 2026-06-01 方向修正（見下「方向定調」）+ docs/HANDOFF-self-host-harness.md。
|
||||
|
||||
---
|
||||
|
||||
## 0. 方向定調（richblack 2026-06-01）
|
||||
|
||||
把關的對象與位置整個移位了，先講清楚才不會做歪：
|
||||
|
||||
### 0.1 零件這條路 = 封鎖，且「不再有假零件這件事」
|
||||
- 零件由維護者（richblack）管理，**CC 不能自製/修改零件**。
|
||||
- 封鎖機制 = **零件投稿走 GitHub PR + 人 merge**（DECISIONS §8 / design 頂部方向修正）。
|
||||
AI 偽造不了 GitHub approve，這是天然人類閘門。CC 在本機產不出能進庫的零件。
|
||||
- → 因此「擋假零件」（原 W1）這件事**不存在了**：CC 根本造不出零件，workflow 引用 recipe
|
||||
（如 `component: kbdb_get`）是**合法且未來唯一的擴充方式**，不該被當假零件擋。
|
||||
|
||||
### 0.2 零件 PR 把關 = 人工，不自動化（除非未來爆量）
|
||||
- richblack 2026-06-01 澄清 BACKLOG 步驟5「不做 hook/自動化」的真意：
|
||||
**零件真實數量很少、絕大多數是 recipe** → 原本想做的「驗證零件 PR 的自動化機制」
|
||||
（CI 跑 Gherkin/沙箱/向量）**不需要**，量少 → **有 PR 進來就人工檢查**。
|
||||
**只有零件開發量變很大時**才回頭想自動化。
|
||||
- → component-gatekeeping 的 G4/覆蓋檢查/黃金向量自動化 = **不做**（人工取代），與既有 tasks 收尾一致。
|
||||
|
||||
### 0.3 真正的 harness 把關 = recipe 入庫（push）那一刻
|
||||
CC 唯一能擴充的是 recipe。recipe 一律用「**推（push）**」，**自有庫與公共庫同一套指令**。
|
||||
把關依庫別分強度：
|
||||
|
||||
| 庫別 | 能做到的把關 | 機制 |
|
||||
|---|---|---|
|
||||
| **自有庫（self-hosted）** | 只能**提醒**（無法在別人機器強制） | (1) 資料外流提醒 (2) 打通檢查 |
|
||||
| **公共庫** | 維護者機制**檢核實際打通、真收到成功回傳** | PR/CI relay（DECISIONS §3c，第一期後）|
|
||||
|
||||
---
|
||||
|
||||
## 1. 自有庫 push 把關（self-hosted，第一期做）
|
||||
|
||||
`acr recipe push` 的兩個提醒。**提醒級 = 告知 + 需人類明示同意，不硬擋**（self-hosted 是用戶自己的庫，
|
||||
他同意後就是他的責任 — mindset §6 / data-exfil-warning 既有原則）。
|
||||
|
||||
### 1.1 資料外流提醒（W2.2）
|
||||
- **觸發**：push 的 recipe / 或部署的 workflow 會讓「資料對外可見」——主要是產生**對外可被呼叫的 webhook**
|
||||
（`POST /webhooks/named/...` 對外 trigger URL），或 recipe 把本地資料 POST 到外部服務。
|
||||
- **行為**：CLI 印明確警示「這個動作會讓 X 對外界可見/可呼叫，確認要繼續嗎？」→ 需人類明示同意（y/N）。
|
||||
非 TTY（AI 直跑）→ 拒絕，提示「需人類確認」（mindset §7：絕不代替人類做暴露確認）。
|
||||
- **與既有 data-exfil-warning 的關係**：已有 API 層 + pre-bash hook（commit 51d40ee 等）。
|
||||
本項確認**涵蓋 recipe push 這條路徑**；若已涵蓋則只補文件，若沒涵蓋則補上 push 路徑的提醒。
|
||||
- **誠實限制**：AI 技術上能偽造 exposure_consent。價值是法律歸責 + 軌跡可審，不聲稱不可繞過（mindset §7）。
|
||||
|
||||
### 1.2 打通檢查（W2.3）
|
||||
- **目的**：recipe 是「指向外部 API 的指針」，正確性一半在「打不打得通」（DECISIONS §1 recipe 驗收標準 = 2xx）。
|
||||
- **行為**：push 時（或 push 後）對 recipe 的 endpoint **實打一次**，回報 HTTP status。
|
||||
- 2xx → 「✓ recipe 打通（HTTP 200）」
|
||||
- 4xx/5xx → 「⚠️ recipe 未打通（HTTP 401/404/...）」+ 誠實標原因（如「缺 credential → 先 acr creds push」）
|
||||
- 連不上 → 「⚠️ 無法連線」
|
||||
- **self-hosted 是提醒級**：打不通**不硬擋 push**（用戶可能就是要先 push 再設 credential），只如實回報。
|
||||
- **誠實**（mindset §7）：缺 credential 打不到 2xx 就誠實標「未驗收：缺 X」，不 mock 充綠燈。
|
||||
|
||||
### 1.3 動到的檔案（待 review 後）
|
||||
| 檔案 | 動作 |
|
||||
|---|---|
|
||||
| `cli/src/commands/recipe.ts` | push 流程加 (1) 資料外流提醒 prompt (2) 打通檢查（實打 endpoint 回報 status） |
|
||||
| `.claude/hooks/*`（如需）| 確認 data-exfil pre-bash hook 涵蓋 recipe push；缺則補 |
|
||||
|
||||
**不動**：cypher-executor 執行路徑、零件、credential 解密邏輯。
|
||||
|
||||
---
|
||||
|
||||
## 2. 公共庫 push 把關（第一期後）
|
||||
|
||||
- recipe 進公共庫 = 別人會用 → 需維護者機制檢核「**實際打通、真收到成功回傳**」（不是投稿者自報）。
|
||||
- 機制：DECISIONS §3c 的 **test/relay**——push 公共庫走 relay，維護者當下親見真實打通記錄
|
||||
（執行者不能驗證自己，§7 閉環）。
|
||||
- **範圍**：依賴公共庫 + relay 基建，**第一期不做**（第一期是 self-hosted + 提醒級）。
|
||||
- 本檔只記框架，第一期不實作。
|
||||
|
||||
---
|
||||
|
||||
## 3. 同一套指令、不同把關強度的切分（W2.4）
|
||||
|
||||
- `acr recipe push`（自有庫，預設）→ §1 提醒級。
|
||||
- `acr recipe push --public`（公共庫，未來）→ §2 relay 檢核級。
|
||||
- 同一指令、旗標分流（呼應 design §4.3 公私庫分流：`-p`/`--public`）。
|
||||
- 第一期只實作預設（自有庫）路徑。
|
||||
|
||||
---
|
||||
|
||||
## 4. 驗收標準（客觀證據，mindset §7）
|
||||
|
||||
第一期（自有庫提醒級）：
|
||||
1. `acr recipe push` 一個會產對外 webhook 的東西 → CLI 印資料外流警示 + 要人類同意；非 TTY → 拒絕。
|
||||
2. `acr recipe push` 一個 endpoint 可達的 recipe → 打通檢查回報「✓ HTTP 2xx」。
|
||||
3. `acr recipe push` 一個缺 credential 的 recipe → 回報「⚠️ 未打通：缺 credential」（誠實，不假綠），但仍允許 push。
|
||||
4. 確認 workflow 引用 recipe（`component: kbdb_get`）**不再被任何 validate 步驟當假零件擋**（W1 已作廢）。
|
||||
|
||||
---
|
||||
|
||||
## 5. 與既有 SDD 的一致性確認（無新矛盾）
|
||||
|
||||
- 不動「零件投稿走 PR + 人工檢查」（§0.1/0.2，與 design 頂部方向修正、DECISIONS §8 一致）。
|
||||
- 不重啟「零件 PR 自動化把關」（§0.2，與 BACKLOG 步驟5 真意一致）。
|
||||
- 資料外流提醒延續既有 data-exfil-warning 原則（mindset §6），只確認涵蓋 recipe push 路徑。
|
||||
- 打通檢查 = recipe 驗收標準 2xx 的落地（DECISIONS §1）。
|
||||
@@ -0,0 +1,53 @@
|
||||
# Requirements: Component Gatekeeping（零件投稿真把關）
|
||||
|
||||
> 2026-05-29 建立（richblack 確認）。對應第一期 BACKLOG 步驟 4（補零件庫真把關）+ 步驟 5（人類閘門 + 白名單 hook）。
|
||||
> 判準源：DECISIONS.md §1（工作流是 default / 建零件人類閘門 / ABC 三管齊下）、§7（讓 AI 不做歪三層機制 + 閉環）、§3c/§7（禁假綠）。
|
||||
|
||||
---
|
||||
|
||||
## 背景
|
||||
|
||||
第一期要把「零件投稿」從「無審核」變成「真的會擋」的把關。現況：
|
||||
- `registry/src/actions/sandboxAcceptance.ts`：size_check / syscall_scan 已實作；cold_start / gherkin_tests / runtime_compat 是 `return null` mock。
|
||||
- `submitComponent.ts`：跑 sandboxAcceptance → 派 hash → 寫 KV。無假零件偵測、無人類閘門。
|
||||
- 風險（DECISIONS）：CC 把自用服務（通訊錄/帳本）做成零件進公共庫 → 全生態能打 → 機密外洩。
|
||||
|
||||
## 需求
|
||||
|
||||
### R1 — Gherkin 驗收真實作（取代 mock）
|
||||
- `runGherkinTests` 要真的跑零件 WASM：對每個 `gherkin_tests[]` 的 given → 餵 stdin → 比對 stdout 是否 `then_contains`。
|
||||
- 失敗 → 退稿，回明確 reason + guide anchor。
|
||||
- recipe 不適用 Gherkin（DECISIONS §1：recipe 驗收 = 2xx）；本需求只針對 WASM 零件投稿。
|
||||
|
||||
### R2 — 假零件偵測（退稿並指回正路）
|
||||
依 DECISIONS §1 判準，投稿零件若滿足任一，退稿：
|
||||
- (a) contract 或（可得的）原碼出現具體外部服務 URL / domain
|
||||
- (b) 宣告能力是 http_request 子集（打某固定 endpoint）
|
||||
退稿訊息要指回正路：「這該是 recipe / 工作流，不是零件」。
|
||||
|
||||
### R3 — 純 WASI preview1 / 零宿主依賴把關
|
||||
- 擴充 syscall 掃描：確認零件只依賴 WASI preview1 + u6u host functions 白名單，無其他宿主特定依賴（避免 runtime 鎖定債，DECISIONS §4）。
|
||||
- 冷啟動 / runtime 相容兩步可暫留 mock，但**明確標「未實作」**，不可假裝通過（§3c/§7 禁假綠）。
|
||||
|
||||
### R4 — 建零件的人類閘門（核心，BACKLOG 步驟 5 強化規格）
|
||||
- **把關點 = 建立零件的 API 本身**（registry submit endpoint），不是寫檔案。CLI / MCP / Python lib / JS lib 四路全收斂到這關。
|
||||
- submit 預設**拒絕**，除非請求帶：
|
||||
- (a) 人類已確認憑證（CLI `acr component create` 強制互動式問人類，AI 非互動環境生不出）
|
||||
- (b) 舉證 `reason_why_not_workflow`（AI 須證明工作流為何做不到；舉證責任在 AI，預設假設工作流能做）
|
||||
- 缺 → 403 + 指回正路（先試工作流）。
|
||||
- 誠實限制：沒技術能 100% 防 AI 假冒人類確認；靠閘門 + 舉證留記錄 + mindset 明示「絕不代替人類確認」+ 軌跡可審計，讓假冒成明確越界。
|
||||
|
||||
### R5 — 白名單 + 本機 hook 兜底
|
||||
- `MVP_COMPONENTS.txt` 白名單檔。
|
||||
- pre-write / pre-bash hook：CC 直接在 `registry/components/{白名單外新名}/` 造目錄或 mkdir → exit 2（擋繞過 API 直接改 repo 等 CI 部署的旁門）。
|
||||
- pre-write hook：`registry/components/` 下出現 `.ts`（非 AssemblyScript）→ exit 2（現有 hook 已部分做）。
|
||||
|
||||
### R6 — 不限制自由
|
||||
- 不做「audience 宣告 / 禁止自用進公共庫」式的限制（DECISIONS：別人要建零件是他的自由）。
|
||||
- 唯一硬約束：零件 = 只打一個 endpoint 的薄殼。閘門是「要建得先說服人 + 舉證」的摩擦，非禁止。
|
||||
- arcrun 不做授權判斷（能否打通由發 key 的服務裁決）——把關針對「是否該是零件」，不針對「誰能打哪個 API」。
|
||||
|
||||
## 非目標
|
||||
- Phase 5 用戶自製零件 R2 上傳（未啟用）。
|
||||
- registry KV schema 大改（用既有結構）。
|
||||
- 完整的 audit trail 系統（DECISIONS §7 事後機制第一層，另議）。
|
||||
@@ -0,0 +1,102 @@
|
||||
# Tasks: Component Gatekeeping
|
||||
|
||||
> 對應 design.md。每完成一個 task 立刻標 [x]，不批次。
|
||||
> Design 已 richblack 確認（2026-05-29，含 Q1-Q3 決議）。
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ 收尾狀態（2026-05-30，方向修正後）
|
||||
|
||||
投稿改走 **GitHub PR**（廢 registry self-service，見 design 頂部「方向修正」）。本 SDD 收尾於：
|
||||
- **已完成且 commit**：G1（detectFakeComponent）、G3（wasmImports）、G5/G6（unimplemented_steps）、
|
||||
G0 registry 人類閘門（保留不刪）。測試 15 綠。
|
||||
- **改去向**：G4 Gherkin / 覆蓋檢查 → 未來接 CI PR check（CI 能跑 wasm）。G1/G3 邏輯可複用。
|
||||
- **不做**：CI PR check（richblack：人工 review 就夠，primitive 極少）、R5 本機 hook
|
||||
（PR/merge + G1 + 沙箱已防「未經同意變公共零件」，hook 過度工程）、registry self-service、
|
||||
acr parts publish 加閘門、平台 sandbox 重跑。
|
||||
- **黃金向量**：人工核對（另起 session 從語義寫），不急、不機器自動化。
|
||||
- **轉出範圍**：真正的裸奔風險在「資料外流」（recipe/webhook 把資料送出去），不分公私庫
|
||||
→ 另開新 SDD「資料外流警示」（API 層警示 + AI 動手前 hook）。用戶 API 保護（入站認證）
|
||||
+ recipe/part/function 架構釐清 → 記 BACKLOG 待決策。
|
||||
|
||||
---
|
||||
|
||||
## G1 假零件偵測（R2，Q2=兩者硬擋）
|
||||
- [x] 1.1 `registry/src/actions/detectFakeComponent.ts`：(a) 外部 URL/domain 偵測（掃 contract 文字 + wasm binary 文字）硬擋；(b) http_request 子集偵測硬擋
|
||||
- [x] 1.2 排除 `auth_*` primitive 與 `http_request` 自己
|
||||
- [x] 1.3 接進 sandboxAcceptance 步驟鏈（fake_component_scan 為第一步）
|
||||
- [x] 1.4 退稿訊息指回正路（「這該是 recipe/工作流」）
|
||||
|
||||
## G3 純 WASI 把關（R3）
|
||||
- [x] 3.1 `wasmImports.ts` 解析 wasm import section，取出所有 import module name（已對真實零件驗證）
|
||||
- [x] 3.2 白名單：只准 `wasi_snapshot_preview1` + `u6u`；其他 module → 退稿
|
||||
- [x] 3.3 接進 scanSyscalls（白名單為主，黑名單為次）
|
||||
|
||||
## G4 Gherkin 真實作（R1）— venue 修訂：CLI 本地跑，非 registry（design §4 修訂）
|
||||
> CF Worker 不能 runtime 編譯 wasm + §8 不依賴 CI → Gherkin 在投稿指令本地（Node）跑。
|
||||
> 在第一段（tinygo build→wasm 之後）測，跟 worker 無關。registry 只存 evidence 不重跑。
|
||||
- [x] 4.1 `runGherkin.ts`（createWasiShim 跑 wasm，邏輯正確）—— 但 venue 要從 registry 改 CLI
|
||||
- [ ] 4.2 回退 sandboxAcceptance：registry 不跑 Gherkin（移除 await runGherkin），改回靜態步驟
|
||||
- [ ] 4.3 Gherkin 邏輯搬到 CLI 投稿指令（Node 環境 instantiate wasm）
|
||||
- [ ] 4.4 投稿 payload 帶 gherkin_evidence（scenario/given/actual_stdout/passed），registry 存 metadata 可審
|
||||
- [ ] 4.5 誠實標明第一期 evidence 可造假（mindset + 文件）；平台重跑列未來
|
||||
- [ ] 4.6 投稿指令（暫名 acr component submit）+ 公私庫分流（-p 公共）— 新 CLI 工程
|
||||
|
||||
## G5/G6 誠實標未實作（R3 禁假綠）
|
||||
- [x] 5.1 SandboxResult 增 `unimplemented_steps: string[]`
|
||||
- [x] 5.2 cold_start / runtime_compat 列入 unimplemented_steps，submit 回應明示
|
||||
|
||||
## G0 人類閘門（R4，核心）
|
||||
- [x] 0.1 submit 請求增 `human_confirmation`（SubmitOptions in submitComponent.ts）+ route 解析（multipart/JSON 皆支援）
|
||||
- [x] 0.2 submit 邏輯：非 skip_acceptance 的新投稿，無 human_confirmation/空 reason → gateError（指回正路）
|
||||
- [x] 0.3 human_confirmation + gherkin_evidence 寫進 KV metadata（軌跡可審）
|
||||
- [ ] 0.4 CLI `acr parts publish`（既有指令）：互動式問人類（工作流為何做不到 + 確認），非 TTY 拒絕
|
||||
- [ ] 0.5 MCP / Python lib / JS lib 補 human_confirmation 欄位支援（薄）
|
||||
- [ ] 0.6 誠實限制寫進 mindset Skill（步驟 7）+ SDK 文件
|
||||
|
||||
> 命名修正（2026-05-29）：投稿走**既有** `acr parts publish`（cli/src/commands/parts.ts），
|
||||
> 非另建 acr component create（符合「修改現有不重建」）。G0-CLI（0.4）與 G4-CLI 合併在此指令做。
|
||||
|
||||
## R5 白名單 + 本機 hook
|
||||
- [ ] 5.3 `registry/MVP_COMPONENTS.txt`（現役 22 個 canonical_id）
|
||||
- [ ] 5.4 submit 過閘門成功 → 自動 append canonical_id 進白名單（Q3）
|
||||
- [ ] 5.5 pre-write-guard.sh：寫 `registry/components/{白名單外}/` → exit 2
|
||||
- [ ] 5.6 pre-bash-guard.sh：mkdir `registry/components/{白名單外}` → exit 2
|
||||
|
||||
## W1 ~~CLI workflow validate 擋假零件式 component 名~~（2026-06-01 作廢，方向修正）
|
||||
|
||||
> **作廢原因（richblack 2026-06-01）**：「擋假零件」這件事不再存在——因為**自製/修改零件的路
|
||||
> 已被封鎖**（CC 根本造不出零件），workflow 引用 recipe（如 component: kbdb_get）是**合法且
|
||||
> 未來唯一的擴充方式**，不該被當「假零件」擋。把關點從「workflow validate」**移到 recipe 入庫
|
||||
> （push）那一刻**。已動的 yaml-parser.ts `LEGAL_PRIMITIVES`/`findSuspectComponents` 已回退。
|
||||
> 取而代之 → 見 W2。
|
||||
|
||||
## W2 封鎖自製零件 + recipe 入庫把關（2026-06-01 新方向）
|
||||
|
||||
> richblack 2026-06-01 定調：
|
||||
> - 零件由維護者管理，**CC 不能自製/修改零件**（hook + CLI 拒絕）→ 不再有「假零件」。
|
||||
> - CC 唯一能擴充的是 **recipe**。recipe 一律用「推（push）」，**自有庫與公共庫同一套指令**。
|
||||
> - 把關依庫別分強度：
|
||||
> - **自有庫（self-hosted）**：只能**提醒**（無法在別人機器強制）。兩個提醒：
|
||||
> (1) 資料外流提醒——某動作會讓外界看到你的東西（如 workflow 產對外 webhook），同意後是他的責任；
|
||||
> (2) 打通檢查——查他要打的 API 是否打得通（2xx）。
|
||||
> - **公共庫**：由維護者機制檢核「實際打通、真收到成功回傳」（PR/CI relay，DECISIONS §3c，第一期後）。
|
||||
> 屬 change，需先寫 design 給 richblack review 才動 code。本節先記框架。
|
||||
|
||||
- [x] W2.1 封鎖自製零件 — **釐清完成（richblack 2026-06-02）**：靠「零件投稿走 GitHub PR + 人 merge」
|
||||
天然閘門（DECISIONS §8）。BACKLOG 步驟5「不做 hook」真意 = 零件少、不為零件 PR 蓋自動化把關
|
||||
（量少人工檢查；爆量才回頭想），**不是**不阻止自製。無矛盾，不需新做 hook。
|
||||
- [x] W2.2 `acr recipe push` 資料外流提醒 — **既有實作已涵蓋**：recipe.ts:70-79 `obtainExposureConsent`
|
||||
（exposure-warning.ts：互動打資源名確認、非 TTY 拒絕、首次問記住）。data-exfil-warning SDD 已做，確認涵蓋 recipe push 路徑。
|
||||
- [x] W2.3 `acr recipe push` 打通檢查 — **新增** `probeRecipeEndpoint`（recipe.ts）：push 成功後實打 endpoint，
|
||||
回報 2xx/⚠。提醒級不硬擋；endpoint 含 {{模板}} → 誠實說明待 run 才知；401/403 → 標「多半缺 credential，非 recipe bug」（不假綠，mindset §7）
|
||||
- [ ] W2.4 公共庫 push（--public）= 維護者 relay 檢核（DECISIONS §3c）— 第一期後，本期只做自有庫提醒級
|
||||
|
||||
## 驗收（design §8）
|
||||
- [ ] V1 投寫死 endpoint 假零件 → G1 退稿（終端輸出）
|
||||
- [ ] V2 投 `.ts` 進 registry/components → hook exit 2
|
||||
- [ ] V3 本機造白名單外零件目錄 → hook exit 2
|
||||
- [ ] V4 無 human_confirmation 的 submit → 403
|
||||
- [ ] V5 帶 human_confirmation + 過 Gherkin 真零件 → 通過 + reason 留 metadata + 白名單 append
|
||||
- [ ] V6 故意改壞 then_contains → Gherkin 退稿
|
||||
- [ ] V7 回應含 unimplemented_steps（cold_start/runtime_compat 不假綠）
|
||||
@@ -0,0 +1,162 @@
|
||||
# SDD: arcrun Component Registry 正典化（Component Registry Canon）
|
||||
|
||||
> 2026-05-07 建立。狗糧發現的根本問題：registry 活著但 index 空的，AI 找不到零件就會繞回 Python。
|
||||
> 範圍：**讓 registry 成為零件 metadata 的 SSOT**，含 u6u → arcrun rebrand。
|
||||
|
||||
---
|
||||
|
||||
## 1. 問題
|
||||
|
||||
### 1.1 表象
|
||||
- `registry.arcrun.dev/components/search?q=*` 永遠回 0 結果
|
||||
- MCP `u6u_search_components` 找不到任何零件
|
||||
- `acr parts list` 同樣空
|
||||
|
||||
### 1.2 根因
|
||||
`matrix/arcrun/registry/components/` 下 30+ 個零件已經部署成獨立 Worker（kbdb_ingest, claude_api, kbdb_create_block, kbdb_patch_block, http_request, string_ops, ⋯），但**它們的 contract.yaml 沒有透過 `POST /components/submit` 進 registry index**。
|
||||
|
||||
部署路徑：
|
||||
```
|
||||
registry/components/{name}/main.go ← TinyGo 寫的零件
|
||||
↓ tinygo build
|
||||
.component-builds/{name}/component.wasm
|
||||
↓ wrangler deploy
|
||||
{name}.arcrun.dev (Worker) ← 零件可被 HTTP 呼叫了
|
||||
|
||||
registry index? ← 這步從來沒做
|
||||
```
|
||||
|
||||
### 1.3 影響（吃狗糧的觀察）
|
||||
- 新 AI（Claude / Gemini / Codex）進來不知道有什麼零件 → 自己寫 Python 直打 API
|
||||
- arcrun 想推「AI-first 自服務」整個破功
|
||||
- 文件寫得再好都救不了 — 因為 README 只能寫概念，零件清單必須是 API 動態查
|
||||
|
||||
---
|
||||
|
||||
## 2. 目標
|
||||
|
||||
**Registry 是零件 metadata 的 SSOT**：
|
||||
|
||||
- 零件 Worker 在跑 ⇔ registry 有對應 entry（雙向綁定）
|
||||
- AI 透過 MCP `search_components` 永遠找得到所有現役零件
|
||||
- README 不寫死數量，動態 badge 即時反映
|
||||
- 第三方裝完 MCP 30 秒內能找到第一個可用零件
|
||||
|
||||
---
|
||||
|
||||
## 3. 三層設計
|
||||
|
||||
### Layer 1: 一次性 backfill（Phase 1）
|
||||
|
||||
掃 `matrix/arcrun/registry/components/*/component.contract.yaml`，把每個 contract POST 進 registry index。
|
||||
|
||||
工具：`matrix/arcrun/registry/scripts/backfill-index.ts`
|
||||
- 讀檔 → 解析 YAML → 呼叫 registry submit endpoint
|
||||
- idempotent：已存在不重複寫（registry 端要支援 upsert）
|
||||
- 跳過沙盒驗收（這些零件已驗過、已部署，不用重跑 gherkin tests）
|
||||
|
||||
### Layer 2: 部署即註冊（Phase 2）
|
||||
|
||||
改 `.github/workflows/deploy.yml`：
|
||||
- 通用掃描掃到 `.component-builds/{name}/wrangler.toml` 部署成功後
|
||||
- post-deploy step 自動呼叫 registry submit（contract 從 `registry/components/{name}/component.contract.yaml` 讀）
|
||||
|
||||
零件 Worker 部署 ⇒ registry 自動更新。沒有「零件部署了但 registry 不知道」的可能。
|
||||
|
||||
### Layer 3: Discoverability（Phase 3）
|
||||
|
||||
- README 移除「21 個零件」這種寫死數字，改「跑 search 看當前清單」
|
||||
- 加 badge endpoint `registry.arcrun.dev/badge/components.svg` 即時顯示數量
|
||||
- MCP `get_component_guide` 開頭加鐵律：「動工前必須先 search，不是猜」
|
||||
- onboarding kit GitHub template：CLAUDE.md / .cursor/rules / AGENTS.md 三件套，all 強制 search 優先
|
||||
|
||||
### Layer 4: u6u → arcrun Rebrand（Phase 4）
|
||||
|
||||
把 `matrix/u6u-mcp/` 跟所有 `u6u_*` tool 名搬到 arcrun 命名空間。
|
||||
|
||||
理由：
|
||||
- u6u 是申請 arcrun.dev 之前的暫名，現在已過時
|
||||
- 命名混亂阻礙推廣（「為什麼 arcrun 文件叫 u6u_*?」）
|
||||
- 第三方看到 u6u 不知道是同一個產品
|
||||
|
||||
範圍：
|
||||
1. 目錄：`matrix/u6u-mcp/` → `matrix/arcrun-mcp/`
|
||||
2. Worker name：`u6u-mcp` → `arcrun-mcp`
|
||||
3. Tool 前綴：`u6u_search_components` → `arcrun_search_components`（14 個 tool）
|
||||
4. Hostname：`mcp.finally.click` → `mcp.arcrun.dev`（finally.click 保留 redirect 到 arcrun.dev 過渡期）
|
||||
5. Repo / Worker 內部 ID：u6u-mcp-server → arcrun-mcp-server
|
||||
6. README 全文：u6u → arcrun
|
||||
7. user memory（CLAUDE.md / MEMORY.md）相關提及一併更新
|
||||
8. inkstone-component-registry（舊 worker）廢止 → arcrun-registry 為唯一現役
|
||||
|
||||
**Rebrand 原則：**
|
||||
- 用戶端 config（claude_desktop_config.json 等）給過渡期：兩個 URL 都活，舊的回 deprecation header 提示換新
|
||||
- Tool 前綴 `u6u_*` → `arcrun_*` 沒有過渡期（一刀切，因為前綴是 AI 看的，不是用戶記憶肌肉）
|
||||
- 文件 / repo 內所有 reference 立即改
|
||||
|
||||
---
|
||||
|
||||
## 4. 範圍邊界
|
||||
|
||||
**在本 SDD 範圍內：**
|
||||
- ✅ Phase 1: backfill index
|
||||
- ✅ Phase 2: 部署即註冊 hook
|
||||
- ✅ Phase 3: README + badge + onboarding kit
|
||||
- ✅ Phase 4: u6u → arcrun rebrand（含目錄 / worker / hostname / tool 前綴 / 文件）
|
||||
|
||||
**不在範圍內：**
|
||||
- 新零件開發（這是 polaris 業務範圍）
|
||||
- registry KV schema 改動（用既有結構）
|
||||
- u6u-gui 的 rebrand（u6u-mcp 同 monorepo 但獨立 SDD）
|
||||
- Phase 5（用戶自製零件 R2 上傳）— 等 Phase 4 完成後另開 SDD
|
||||
|
||||
**前置依賴（已完成）：**
|
||||
- ✅ u6u-mcp Zod 4 → Zod 3 修復（2026-05-07）
|
||||
- ✅ u6u-mcp service binding 改指 arcrun-registry（2026-05-07）
|
||||
- ✅ arcrun-registry Worker 部署在 registry.arcrun.dev
|
||||
|
||||
---
|
||||
|
||||
## 5. 驗收標準
|
||||
|
||||
### Phase 1 驗收
|
||||
- `u6u_search_components("kbdb")` 回非空結果，含 `kbdb_ingest` / `kbdb_create_block` / `kbdb_patch_block`
|
||||
- `acr parts list` CLI 端對端能列出
|
||||
- registry KV 內至少 30 entries
|
||||
|
||||
### Phase 2 驗收
|
||||
- 部署任一既有零件後，registry 30 秒內 reflect 更新
|
||||
- 部署一個全新零件，無需手動 publish，registry 自動有
|
||||
- CI workflow 不會因 registry 寫入失敗就擋部署（degraded mode：寫入失敗 log warning 但不 fail）
|
||||
|
||||
### Phase 3 驗收
|
||||
- README 沒有「21 個零件」「30 個零件」這種寫死數字
|
||||
- badge SVG 渲染正確、數字跟 KV 一致
|
||||
- onboarding kit clone 下來，照 README 跑能 30 秒內 list 到零件
|
||||
|
||||
### Phase 4 驗收
|
||||
- `mcp.arcrun.dev/mcp/mcp` 通，回的 tool 名都是 `arcrun_*`
|
||||
- 舊 `mcp.finally.click/mcp/mcp` 仍可用但回 deprecation header
|
||||
- README / docs / GUIDE 全部 u6u 字樣消除
|
||||
- `matrix/u6u-mcp/` 目錄不存在，改為 `matrix/arcrun-mcp/`
|
||||
- 用戶記憶（`~/.claude/.../MEMORY.md`）arcrun MCP 設定範例已更新
|
||||
|
||||
---
|
||||
|
||||
## 6. 風險與緩解
|
||||
|
||||
| 風險 | 緩解 |
|
||||
|---|---|
|
||||
| backfill 把 contract 灌進去後，沙盒驗收覆蓋既有資料 | registry submit 加 `skip_acceptance=true` flag，僅 backfill 用 |
|
||||
| 部署 hook 寫入失敗擋掉部署 | hook degraded mode：失敗只 warning，不 fail 部署 |
|
||||
| Rebrand 把現役 client 弄壞 | 過渡期：舊 hostname 跟 worker 並存 1 個月 |
|
||||
| Tool 前綴改名 AI 適應期 | 不過渡，一刀切（前綴是 system instruction 範圍，AI 一個 prompt 就學會）|
|
||||
| 既有用戶 config 寫死 finally.click | 提前公告 + 過渡期 + 舊 endpoint 自動 redirect / proxy |
|
||||
|
||||
---
|
||||
|
||||
## 7. 變更紀錄
|
||||
|
||||
| 版本 | 日期 | 內容 |
|
||||
|---|---|---|
|
||||
| v1.0 | 2026-05-07 | 初版。吃狗糧發現 registry 空的，三層設計（backfill / auto-register / discoverability）+ u6u → arcrun rebrand 一併納入。 |
|
||||
@@ -0,0 +1,159 @@
|
||||
# Tasks — Component Registry Canon
|
||||
|
||||
> 對應 SDD：[design.md](design.md)
|
||||
> 上次更新：2026-05-07
|
||||
|
||||
**狀態 legend**：`[ ]` 待辦 / `[🔄]` 進行中 / `[x]` 完成
|
||||
|
||||
---
|
||||
|
||||
## Phase 0：前置（已完成）
|
||||
|
||||
- [x] 0.1 u6u-mcp Zod 4 → Zod 3 降版修 tools/list `_zod undefined` bug（2026-05-07）
|
||||
- [x] 0.2 u6u-mcp service binding `inkstone-component-registry` → `arcrun-registry`（2026-05-07）
|
||||
- [x] 0.3 確認 `mcp.finally.click/mcp/mcp` 端對端通，tools/list 回 14 個 tool（2026-05-07）
|
||||
|
||||
---
|
||||
|
||||
## Phase 1：Backfill Index（半天，立即見效）
|
||||
|
||||
- [x] 1.1 探查 registry 既有 endpoint：發現
|
||||
- 既有 `POST /components` 強制要 wasm bytes（multipart 或 base64），跑沙盒驗收 + 寫 R2 + 寫 KV
|
||||
- cypher-executor 已不從 R2 動態載 wasm（line 32 標 R2 路徑作廢，零件用獨立 Worker URL）
|
||||
- 結論：R2 是 legacy，registry 真正用途是 metadata 索引給 AI 搜尋
|
||||
- 決策：**加新 endpoint `POST /components/index-only`** 接 contract（無 wasm、無沙盒），專供 backfill 跟「已部署但未索引」零件用
|
||||
- [x] 1.1.1 加 `src/actions/indexOnlyComponent.ts`（metadata-only 寫 KV，冪等）
|
||||
- [x] 1.1.2 加 `src/routes/components.ts` 的 `POST /index-only` route
|
||||
- [x] 1.1.3 部署 + smoke test（contract 驗證 + 錯誤處理通過）
|
||||
- [x] 1.2 寫 `matrix/arcrun/registry/scripts/backfill-index.mjs`（zero-build node script，用 js-yaml）
|
||||
- [x] 1.3 dry-run 確認 30 個 component 全 parse 通
|
||||
- [x] 1.4 跑真 backfill（過程中發現並修了兩個 schema 問題）：
|
||||
- schema enum `category` 補 `auth` / `ai` / `platform`（types.ts）
|
||||
- `max_cold_start_ms` 上限放寬 50 → 500（auth/ai 含 crypto 需要）
|
||||
- `no_network_syscall` / `no_filesystem_syscall` 改 optional
|
||||
- `max_size_kb` 上限放寬 2048 → 8192
|
||||
- index-only route 對缺 gherkin/description/tags 的零件補 placeholder（不擋索引）
|
||||
- [x] 1.5 驗證：MCP `u6u_search_components("kbdb")` 回 3 個零件（kbdb_ingest / kbdb_create_block / kbdb_patch_block）
|
||||
- [ ] 1.6 驗證：`acr parts list` CLI 端對端能列
|
||||
- [x] 1.7 驗證：registry KV 30 entries（30 created + 30 idx 共 60 keys）
|
||||
|
||||
---
|
||||
|
||||
## Phase 1.5：砍 R2 dead storage（先於 Phase 2，清架構斷層）
|
||||
|
||||
> 2026-05-07 加入。R2 wasm 路徑早已 dead（cypher-executor 不從 R2 讀），保留只會誤導 AI。
|
||||
> SDD design.md 的「Phase 5 用戶自製零件 R2 上傳」一併廢止。
|
||||
|
||||
- [x] 1.5.1 改 `submitComponent.ts`：移除 R2 寫入段落，保留 KV 寫入
|
||||
- [x] 1.5.2 移除 `wrangler.toml` 的 `[[r2_buckets]] WASM_BUCKET` binding
|
||||
- [x] 1.5.3 移除 `types.ts` Bindings 的 `WASM_BUCKET: R2Bucket`
|
||||
- [x] 1.5.4 既有 `wasm_r2_key` 欄位保留為 deprecated（queryComponents 仍會讀 legacy record）
|
||||
- [ ] 1.5.5 廢止 `arcrun-wasm` R2 bucket（30 天觀察期後 → 2026-06-07 之後 `wrangler r2 bucket delete`）
|
||||
- [x] 1.5.6 部署 + smoke test：search 端對端通過（kbdb 找到 3 個零件）
|
||||
|
||||
## Phase 2：部署即註冊（1-2 天）
|
||||
|
||||
- [x] 2.1 選擇方案：CI step（github actions）— 在 wrangler deploy 之後 curl `/index-only`
|
||||
- [x] 2.2 寫 `registry/scripts/register-component.sh`（本地 + CI 共用 SSOT，python3 + pyyaml 解 YAML，curl POST registry）
|
||||
- [x] 2.3 改 `.github/workflows/deploy.yml` tier1 deploy step 後加 "Register component in registry" step（degraded mode：失敗只 warning）
|
||||
- [x] 2.4 本地驗 `bash scripts/register-component.sh kbdb_ingest` → 200 + already_indexed
|
||||
- [ ] 2.5 真正 push 一個新零件驗 CI hook 端對端（需要等下次新增零件時驗）
|
||||
- [ ] 2.6 文件化：`docs/contributing-components.md`「新增零件的標準流程」
|
||||
- [ ] 2.7 廢止 `u6u_publish_component` tool 的「需手動 publish」假設（rebrand 一起做）
|
||||
|
||||
---
|
||||
|
||||
## Phase 3：Discoverability（半天）
|
||||
|
||||
- [ ] 3.1 改 GitHub `richblack/arcrun` README
|
||||
- 移除「21 個零件」這種寫死數字
|
||||
- 加「跑 `acr parts list` 或 MCP search 看當前清單」
|
||||
- 加 badge：``
|
||||
- [ ] 3.2 加 `matrix/arcrun/registry/src/routes/badge.ts`
|
||||
- GET `/badge/components.svg` 回 shields.io 格式 SVG
|
||||
- count 從 KV 即時 query
|
||||
- cache 1 分鐘（`Cache-Control: max-age=60`）
|
||||
- [ ] 3.3 改 MCP `u6u_get_component_guide` tool（之後改名 `arcrun_*`）
|
||||
- 開頭加「鐵律：動工前必須先 search_components，找不到才 publish」
|
||||
- [ ] 3.4 onboarding kit GitHub template repo（建議名 `arcrun-quickstart`）
|
||||
- 三件套：CLAUDE.md / `.cursor/rules/arcrun.mdc` / AGENTS.md
|
||||
- 強制：「呼叫 Claude/任何 AI 前，先 list MCP tools；arcrun MCP 已連線時，**禁止用 Python 直打 HTTP API**」
|
||||
- 內附範例 hello workflow 跟 component
|
||||
- [ ] 3.5 寫 onboarding doc：`docs/onboarding-third-party-engineer.md`
|
||||
- 第三方工程師如何 30 秒內讓 AI 學會用 arcrun
|
||||
|
||||
---
|
||||
|
||||
## Phase 4：u6u → arcrun Rebrand（1 天，最後做）
|
||||
|
||||
> 規劃做完 Phase 1-3 驗證 OK 才動 rebrand，避免邊改邊驗。
|
||||
|
||||
### 4.1 Repo & Worker
|
||||
- [ ] 4.1.1 `git mv matrix/u6u-mcp matrix/arcrun-mcp`（或 cp + rm，視 git history 偏好）
|
||||
- [ ] 4.1.2 改 `matrix/arcrun-mcp/wrangler.toml`：
|
||||
- `name = "u6u-mcp"` → `name = "arcrun-mcp"`
|
||||
- 加 route `mcp.arcrun.dev/*`，舊 `studio.finally.click/mcp*` 保留 1 個月
|
||||
- [ ] 4.1.3 改 `package.json`：`@inkstone/u6u-mcp-worker` → `@arcrun/mcp-worker`
|
||||
|
||||
### 4.2 Tool 前綴改名
|
||||
- [ ] 4.2.1 14 個 tool 檔案 rename：`u6u_*.ts` → `arcrun_*.ts`
|
||||
- [ ] 4.2.2 每個 tool 內部 `server.tool("u6u_xxx", ...)` 改 `server.tool("arcrun_xxx", ...)`
|
||||
- [ ] 4.2.3 `src/tools/registry.ts` import 路徑全改
|
||||
- [ ] 4.2.4 `src/index.ts` `serverInfo.name` 從 `u6u-mcp-server` 改 `arcrun-mcp-server`
|
||||
|
||||
### 4.3 文件
|
||||
- [ ] 4.3.1 README.md 全文 u6u → arcrun
|
||||
- [ ] 4.3.2 GUIDE.md 同上
|
||||
- [ ] 4.3.3 GitHub `richblack/arcrun` README 補 MCP 段落（之前沒提）
|
||||
- [ ] 4.3.4 任何提到 `u6u-mcp` / `mcp.finally.click` 的 docs 更新
|
||||
|
||||
### 4.4 用戶記憶
|
||||
- [ ] 4.4.1 `~/.claude/projects/.../memory/MEMORY.md` 加 arcrun MCP entry
|
||||
- URL: `https://mcp.arcrun.dev/mcp/mcp`
|
||||
- tool 前綴: `arcrun_*`
|
||||
- finally.click 過渡期到何時
|
||||
- [ ] 4.4.2 polaris/mira/CLAUDE.md 提到 daemon / arcrun / MCP 的部分對齊新命名
|
||||
|
||||
### 4.5 過渡期（舊 endpoint 不立刻砍）
|
||||
- [ ] 4.5.1 舊 `mcp.finally.click/mcp/mcp` 加回應 header `Deprecation: true` + `Link: <https://mcp.arcrun.dev/mcp/mcp>; rel="successor-version"`
|
||||
- [ ] 4.5.2 舊 worker 繼續服務 30 天（2026-06-07 為止）
|
||||
- [ ] 4.5.3 廢止排程：2026-06-07 後舊 worker 改回 410 Gone + 提示換新 URL
|
||||
|
||||
### 4.6 驗證
|
||||
- [ ] 4.6.1 `mcp.arcrun.dev/mcp/mcp` initialize + tools/list + 一個 tool call 全通
|
||||
- [ ] 4.6.2 我的 Claude Code config 切到新 URL，用 `mcp__arcrun__search_components` 端對端測
|
||||
- [ ] 4.6.3 grep `u6u` 在 `matrix/arcrun-mcp/` 結果為 0（除了 changelog 紀錄）
|
||||
|
||||
---
|
||||
|
||||
## 風險追蹤
|
||||
|
||||
- 風險 1：backfill 跑進去發現某些 contract.yaml 格式跟 registry 期望不一樣 → 緩解：dry-run 先看，必要時補 contract 欄位
|
||||
- 風險 2：Phase 4 rebrand 期間用戶 client 設定亂 → 緩解：過渡期 + Deprecation header
|
||||
- 風險 3：自動註冊 hook 失敗導致部署被擋 → 緩解：degraded mode（warning 不 fail）
|
||||
|
||||
---
|
||||
|
||||
## Known Issues（吃狗糧發現的，先記錄）
|
||||
|
||||
### KI-1：u6u-mcp README URL 寫錯
|
||||
- README 寫 `mcp.finally.click/mcp`，實際是 `mcp.finally.click/mcp/mcp`（basePath + route）
|
||||
- 影響：用戶照 README 裝完試打不通
|
||||
- 解法：rebrand 時順便修
|
||||
|
||||
### KI-2：inkstone-component-registry 跟 arcrun-registry 並存
|
||||
- 兩個 worker 都活著，u6u-mcp 之前指錯
|
||||
- inkstone-component-registry 是舊版（2026-03-24）、arcrun-registry 是現役（2026-04-16）
|
||||
- 解法：Phase 1 backfill 完成後，inkstone-component-registry worker 廢止
|
||||
|
||||
### KI-3：search 對自然語言不夠靈敏（吃狗糧第一個發現）
|
||||
- 現象：
|
||||
- `search("從 KBDB 讀取或查詢 block")` → 0 結果
|
||||
- `search("kbdb")` → 3 結果（kbdb_ingest / kbdb_patch_block / kbdb_create_block）
|
||||
- 根因：搜尋走 embedding（bge-m3）相似度，但既有零件清單少（30 個）+ description 寫得正式，自然語言整句的 embedding 跟 description 距離太遠
|
||||
- 影響：**致命** — AI 第一句永遠是自然語言整句，回 0 就會放棄 search 改寫 Python
|
||||
- 解法（Phase 3 處理）：
|
||||
1. embedding search 之外加 keyword fallback（split query → 對 canonical_id / display_name / tags 做 ILIKE）
|
||||
2. 或 lower threshold（目前 SCORE_THRESHOLD = 0.5，可能過高）
|
||||
3. MCP get_component_guide 教 AI 「找不到時拆關鍵字再 search」
|
||||
- 優先級：P1（會擋推廣）
|
||||
@@ -0,0 +1,117 @@
|
||||
# Design: 資料外流警示（Data Exfiltration Warning）
|
||||
|
||||
> 2026-05-30。實作 requirements.md。**本 design 需 richblack review 後才動 code。**
|
||||
> 觸發策略（richblack 定）：**只在「資料變成可被外部呼叫」時問**（暴露面），不管「我去打別人 API」（出站，高頻低風險）。
|
||||
|
||||
---
|
||||
|
||||
## 0. 核心定義：什麼是「資料變成可被外部呼叫」
|
||||
|
||||
警示的觸發點 = 一個動作**讓某份資料 / 能力變成「別人能呼叫得到」**。這是真正的裸奔動作。
|
||||
**不觸發**：「我自己的 workflow 去打別人的 API」（出站）——那是我主動用別人服務，不是把我的東西開放出去。
|
||||
|
||||
### 哪些動作屬於「變成可被外部呼叫」（要警示）
|
||||
| 動作 | 為何是暴露 |
|
||||
|---|---|
|
||||
| 部署 webhook trigger（`acr push` workflow → 可被 POST 觸發） | workflow 變成一個對外可呼叫的 endpoint。誰打它就能跑它、拿它的輸出 |
|
||||
| recipe 貢獻到公共庫（未來飛輪項） | recipe（含 endpoint 設定）變成全生態可見可用 |
|
||||
| 把 workflow / recipe 的可見性改為 public（若未來有此欄位） | 同上 |
|
||||
|
||||
### 哪些動作**不**觸發（避免盲目按 yes）
|
||||
- `acr run`（本機跑，不暴露）
|
||||
- `acr recipe push`（存私人 KV，綁 api_key，只有自己 + 自己的 workflow 用——**不是**對外暴露）
|
||||
- ⚠️ 待 design review 確認：recipe push 現況是私人的，**不暴露**。除非未來加「公共」旗標才觸發。
|
||||
- workflow 裡「打別人 API」的 http 節點（出站，不暴露我的資料給別人呼叫）
|
||||
- 查詢類、creds push（上傳加密 credential 是保護不是暴露）
|
||||
|
||||
### 灰色地帶（design review 要定）
|
||||
- **webhook trigger 現況**：要 `X-Arcrun-API-Key`（owner 的 key）才能打 → 嚴格說「只有我能打」，不算對全世界暴露。
|
||||
但：(a) key 一旦外流就全開；(b) 用戶可能不知道「部署 webhook = 開了一個 endpoint」。
|
||||
→ **是否警示 webhook 部署？** 傾向「是」，因為用戶可能不知情它變成 endpoint，且這是「把 workflow 變 API」的那一步（richblack 最早的風險點）。
|
||||
|
||||
## 1. 兩道防線
|
||||
|
||||
### 1a. hook（防在前，AI 動手當下）
|
||||
AI 在本機寫「會變成可被外部呼叫的東西」前，hook 警告 + 要人類確認。可偵測的訊號：
|
||||
- 寫 workflow YAML 含 webhook trigger / 對外觸發設定。
|
||||
- 跑 `acr push`（部署 webhook）、未來的 recipe 公共貢獻指令。
|
||||
- pre-bash / pre-write hook 偵測這些 → 輸出警示「這會把 X 變成可被外部呼叫，需人類確認」。
|
||||
- **誠實限制**：hook 偵測的是「動作形態」（部署 webhook），不是「資料是否敏感」（機器判不準）。
|
||||
|
||||
### 1b. API 層（防在後，真的暴露前）
|
||||
暴露動作打到 server（webhook 部署 endpoint / 未來公共貢獻 endpoint）時，server 要求帶
|
||||
「人類已確認暴露」的明示旗標，沒帶 → 拒絕 + 提示。與 component-gatekeeping 的 human_confirmation 同模式：
|
||||
```ts
|
||||
exposure_confirmation?: {
|
||||
confirmed_by_human: true;
|
||||
understood_exposure: string; // 人類說明「我知道這會把什麼開放給誰」
|
||||
confirmed_at: string;
|
||||
}
|
||||
```
|
||||
缺 → 拒絕，訊息：「部署 webhook = 開一個對外可呼叫的 endpoint。確認你知道這會暴露 [workflow 名]
|
||||
的能力/輸出？用 `acr push --confirm-exposure` 並說明。」
|
||||
|
||||
### 為何兩道都要
|
||||
- 只有 hook：AI 可繞過 CLI 直接打 server API → API 層補。
|
||||
- 只有 API 層：AI 已經寫好暴露的東西才在送出時被擋，浪費 + 用戶較晚看到 → hook 提前。
|
||||
- 同 component-gatekeeping 的雙層精神。
|
||||
|
||||
## 2. 警示要讓人看得懂（R1）
|
||||
|
||||
不是「確認嗎 Y/N」，是說清楚風險：
|
||||
```
|
||||
⚠️ 這個動作會把 workflow "contacts_lookup" 變成可被外部呼叫的 endpoint：
|
||||
https://cypher.arcrun.dev/webhooks/named/contacts_lookup/trigger
|
||||
|
||||
任何持有觸發憑證的人都能呼叫它、取得它的輸出。
|
||||
這個 workflow 讀取：[盤出 workflow 用到的資料源，若可得]
|
||||
需要保護（要求呼叫者認證）嗎？目前的觸發認證是：[現況]
|
||||
|
||||
確認部署？(需人類明示)
|
||||
```
|
||||
- 「workflow 讀取什麼資料源」：盡力從 workflow 定義盤（用了哪些 recipe / endpoint），盤不出就標「無法自動判斷，請自行確認」。誠實。
|
||||
|
||||
## 3. known-destinations / 不重複問（R4 避免盲目按 yes）
|
||||
|
||||
觸發策略已經很窄（只暴露動作），但同一個 workflow 重複部署不該每次問。
|
||||
- 首次部署某 workflow 為 webhook → 問。人類確認後記住（該 workflow 標記 exposure-confirmed）。
|
||||
- 之後同 workflow 更新 → 不重問（除非暴露面變大，如新增對外觸發）。
|
||||
- 記在哪：workflow metadata（WEBHOOKS KV 的 record 加 `exposure_confirmed_at`）。
|
||||
|
||||
## 4. 與既有一致（R5）
|
||||
- 同 component-gatekeeping：AI 不可替人類決定有外洩風險的動作；誠實限制（AI 能偽造 confirmed_by_human，靠軌跡可審 + mindset）。
|
||||
- 同「arcrun 不做授權判斷」：不判斷「該不該暴露」，只「攔下來讓人類明示同意」。不禁止暴露，要明示同意。
|
||||
|
||||
## 5. 範圍邊界
|
||||
- **動**：webhook 部署路徑（webhooks-named.ts）的 exposure_confirmation + CLI `acr push --confirm-exposure` 互動 + hook。
|
||||
- **不動**：用戶 API 入站保護機制（發 key/權限/限流，另列 BACKLOG）；recipe 私人 push（不暴露，不擋）；出站 http 節點（不擋）。
|
||||
- recipe 公共貢獻路徑未實作 → 本系統只要求它**未來**內建 exposure 閘門（記進那條 BACKLOG 項）。
|
||||
|
||||
## 6. 決議（richblack 2026-05-30 design review）
|
||||
|
||||
- **Q1 → recipe push 也警示，公私一視同仁。** 不是因為 recipe 本身暴露，而是統一原則「凡有資料去向/暴露面的動作都警示」。用戶可選「以後不要警示」（記偏好）。理由見 §7 同意 log。
|
||||
- **Q2 → webhook 部署要警示，但角度是「提醒 + 提供保護」不是「擋」。** 用不用認證是用戶決定（如美國氣象 API 本就無 key 公開）。我們警示時**順便提醒「可用 arcrun 提供的保護措施」**（接「用戶 API 保護機制」資安優勢，BACKLOG 待決策）。首次問、記住（§3）。
|
||||
- **Q3 → hook 偵測 `acr push` 指令**（簡單版，pre-bash 攔指令）。
|
||||
|
||||
## 7. 同意 = 法律憑證（richblack 2026-05-30，重要）
|
||||
|
||||
每次人類同意「暴露/送資料」的動作，**留 log（誰、何時、同意了什麼）**。這不只是「軌跡可審」，是**法律保護**：
|
||||
|
||||
- 真發生資料外洩 / 糾紛時，有「用戶在 [時間] 明示知情同意把 [什麼] 暴露給 [誰]」的證據 → 避免訴訟風險（責任在明示同意的用戶，不在 arcrun）。
|
||||
- 「以後不要警示」這個選擇**本身也要 log**（用戶在 [時間] 選擇了不再對 [X] 警示 = 他知道風險並接受）。
|
||||
- 同意 log 存放：與動作關聯（webhook record / recipe record 的 `exposure_consent: { confirmed_by, understood, confirmed_at, suppress_future }`）。
|
||||
- 誠實限制同前：AI 能偽造 confirmed_by_human。但**法律意義上，憑證存在 + 可審 = 用戶有機會知情**，這道防線的價值是法律歸責不是技術防偽。
|
||||
|
||||
→ 這把 §1b 的 `exposure_confirmation` 升級為**帶法律意義的同意憑證**，所有暴露/送資料動作（recipe push / webhook 部署）共用此機制。
|
||||
|
||||
## 8. 警示是「保護措施的入口」（不只是攔）
|
||||
|
||||
警示訊息除了說明風險，**主動提供 arcrun 的保護措施**（產品價值，非只防呆）：
|
||||
```
|
||||
⚠️ 這個動作會把 [X] 開放/送出。
|
||||
arcrun 可以幫你保護它：
|
||||
- 要求呼叫者帶 API Key（你發給特定對象）
|
||||
- 設定權限 / 限流
|
||||
一個動作就能加上。要加保護嗎？還是確認公開（如公開資料 API）？
|
||||
```
|
||||
（具體保護機制是 BACKLOG「用戶 API 保護機制」待決策項——本系統先在警示處**提示它存在**，實作後接上。）
|
||||
@@ -0,0 +1,56 @@
|
||||
# Requirements: 資料外流警示（Data Exfiltration Warning）
|
||||
|
||||
> 2026-05-30 建立（richblack 確認）。資安優先、及早做。
|
||||
> 判準源：DECISIONS §7（讓 AI 不做歪 + 閉環）、§0（減少不可控依賴 / 風險）；BACKLOG 步驟 5b。
|
||||
|
||||
---
|
||||
|
||||
## 背景與風險
|
||||
|
||||
arcrun 讓「產生 API / 把資料送出去」變很簡單（一堆資料 + webhook trigger = API；recipe = 打某 endpoint）。
|
||||
**這個「簡單」本身是風險**：簡單到 AI 可能在用戶不知情下，把含個資的東西變成可被呼叫的 endpoint，或把
|
||||
敏感資料送到非預期對象。
|
||||
|
||||
**richblack 的核心情境**：用戶有個 Google Sheets 存所有朋友的個資。正確用法是「call 它查詢」（自用）。
|
||||
但若 AI 把它變成一個 recipe / workflow，**送資料到非預期對象**（公開 webhook、公司群、外部 endpoint），
|
||||
且**沒做認證** → 所有資料裸奔。
|
||||
|
||||
**關鍵原則（richblack 2026-05-30）：**
|
||||
1. **不分公私庫都要警示**。私人庫（公司用）一樣會出事（不小心把個資 POST 到公司群）。觸發點不是「推公共」，
|
||||
是「這動作會讓資料流向某處」。
|
||||
2. **不禁止**用戶公開 / 送資料（他要放什麼給誰是他的自由）——**但要確定他自己明示同意了**，不是 AI 替他決定。
|
||||
3. **兩道防線**：(a) hook 在 AI 動手前警告（防在前）；(b) API 層在資料真送出前攔（防在後）。不論哪條路都攔。
|
||||
|
||||
## 需求
|
||||
|
||||
### R1 — API 層警示（資料送出前需人類同意，不分公私庫）
|
||||
任何「把資料送往某目的地」的 API 動作，在執行/儲存前需人類明示同意。涵蓋（待 design 盤準）：
|
||||
- `acr recipe push`：recipe 定義一個 endpoint（資料去向）。
|
||||
- `acr push`（workflow）：workflow 可能含「讀敏感源 → 送往某 endpoint」的節點。
|
||||
- webhook trigger 部署：把 workflow 變成可被呼叫的 API。
|
||||
- 未來「recipe 貢獻公共庫」路徑（BACKLOG 飛輪項）。
|
||||
|
||||
同意內容要讓人看得懂風險：**這個動作會把 [什麼資料] 送到 [哪個目的地]，需不需要 credential 保護？確認？**
|
||||
|
||||
### R2 — hook 在 AI 動手前警告
|
||||
AI 要做這類動作（寫含外部 endpoint 的 recipe/workflow、跑會送資料的指令）前，hook 先警告 + 要人類確認。
|
||||
這是「防在前」——在 AI 本機動手當下就提醒，不等到 API 層才攔（省一趟、且更早讓人看到）。
|
||||
|
||||
### R3 — 誠實的偵測範圍（不假裝能全防）
|
||||
「敏感資料送到非預期對象」機械上難完整偵測。本系統做**可機械判斷的部分**，誠實標明擋不住的：
|
||||
- 能偵測：動作含「外部 endpoint」（recipe endpoint / workflow http 節點 / webhook 對外）。
|
||||
- 難偵測：「這份資料是否敏感」「這個目的地是否非預期」——這需要語境，機器判不準。
|
||||
- 做法：偵測到「資料 → 外部目的地」的動作就警示，由**人類**判斷該資料/目的地是否該放行（人類同意是判斷點，機器只負責「攔下來問」）。
|
||||
|
||||
### R4 — 不擋自用、不製造過度摩擦
|
||||
- 純自用、不送資料出去的動作（acr run 本機、查詢類）不該被警示淹沒。
|
||||
- 警示要精準在「資料外流」動作，不是每個動作都問（否則用戶會盲目按 yes，警示失效）。
|
||||
|
||||
### R5 — 與既有閘門一致
|
||||
- 與「建零件人類閘門」（component-gatekeeping）同精神：AI 不可替人類決定有外洩風險的動作。
|
||||
- 與「arcrun 不做授權判斷」一致：不判斷「該不該送」，只「攔下來讓人類明示同意」。
|
||||
|
||||
## 非目標
|
||||
- 用戶自己的 API 保護機制（入站認證：發 key 給別人 / 權限 / 限流）—— 另列 BACKLOG 待決策。
|
||||
- 完整 DLP（資料外洩防護）系統 / 內容掃描判斷敏感度 —— 機器判不準，不做。
|
||||
- recipe 公共貢獻路徑本身 —— 未實作（飛輪項），本系統只要求它未來內建同意閘門。
|
||||
@@ -0,0 +1,40 @@
|
||||
# Tasks: 資料外流警示
|
||||
|
||||
> 對應 design.md（richblack 已 review，Q1-Q3 + 法律憑證 + 保護入口決議）。
|
||||
> 每完成一個 task 立刻標 [x]，不批次。
|
||||
|
||||
---
|
||||
|
||||
## 共用：同意憑證機制（§7 法律憑證）
|
||||
- [x] C1 定義 `exposure_consent { confirmed_by, understood, confirmed_at, suppress_future }` 型別
|
||||
- [x] C2 同意 log 寫入動作關聯的 record（webhook record / recipe record），可審
|
||||
- [x] C3 「以後不要警示」（suppress_future）本身也 log（用戶知風險並接受）
|
||||
|
||||
## API 層警示（R1，防在後）
|
||||
- [x] A1 webhook 部署（webhooks-named.ts POST）要 exposure_consent，缺且未 suppress → 拒絕 + 提示
|
||||
- [x] A2 recipe push（/recipes POST）同上（公私一視同仁）
|
||||
- [x] A3 首次暴露某資源問、記住（exposure_confirmed / suppress_future）→ 之後不重問（§3）
|
||||
- [x] A4 警示訊息說明風險 + 盤資料源（盡力，盤不出標「請自行確認」）+ **提示 arcrun 保護措施**（§8）
|
||||
|
||||
## CLI 警示（互動 + 旗標）
|
||||
- [x] B1 `acr push`：部署前互動式警示（首次某 workflow），人類確認組 exposure_consent 送出；`--confirm-exposure` 跳過互動（CI/非 TTY）；`--suppress-warning` 記偏好
|
||||
- [x] B2 `acr recipe push`：同上
|
||||
- [x] B3 非 TTY（AI 直跑）無 --confirm-exposure → 拒絕並提示「需人類確認暴露」
|
||||
|
||||
## hook（R2，防在前，Q3=偵測指令）
|
||||
- [x] H1 pre-bash-guard：偵測 `acr push` / `acr recipe push` → 警示「這會把 X 變可被外部呼叫，需人類確認」
|
||||
|
||||
## mindset / 文件
|
||||
- [x] M1 誠實限制（AI 能偽造 confirmed_by_human，靠憑證可審 + 法律歸責）寫進 mindset Skill（步驟 7）+ 文件
|
||||
|
||||
## 驗收
|
||||
- [ ] V1 acr push 部署 webhook（首次）→ 互動警示 + 說明暴露 + 提示保護 的終端輸出
|
||||
- [x] V2 非 TTY 跑 acr push 無 --confirm-exposure → 拒絕的輸出
|
||||
- [x] V3 webhook 部署 API 無 exposure_consent → 拒絕的輸出
|
||||
- [x] V4 同一 workflow 二次部署 → 不重問（已記住）
|
||||
- [ ] V5 --suppress-warning 後 → 不再警示，但 suppress 選擇有 log
|
||||
- [x] V6 同意後 → exposure_consent 寫進 record 可查（法律憑證）
|
||||
|
||||
## 範圍邊界
|
||||
- 不動用戶 API 入站保護機制（發 key/權限/限流）—— BACKLOG 待決策，本系統只在警示處「提示它存在」。
|
||||
- 不擋出站 http 節點（不暴露我的資料）、不擋 acr run（本機）。
|
||||
@@ -0,0 +1,642 @@
|
||||
# Design: LI (LLM Interface) for arcrun
|
||||
|
||||
> v0.1 — 2026-05-16
|
||||
> 對應 requirements.md（同目錄）
|
||||
|
||||
---
|
||||
|
||||
## 1. 設計哲學
|
||||
|
||||
| 過去 (UI 時代) | 現在 (LI 時代) |
|
||||
|---|---|
|
||||
| 使用者是人，要學軟體 | 使用者是 AI，要被軟體 onboard |
|
||||
| 操作靠視覺、滑鼠 | 操作靠 MCP tool call |
|
||||
| 錯誤訊息是技術 stack trace | 錯誤訊息是「下一步該做什麼」 |
|
||||
| 文件是 long-form 教學 | 文件是結構化 schema + 可程式查 |
|
||||
| 用戶教學是 onboarding 課程 | 「教學」是 MCP 工具自己會回 hint |
|
||||
| 回饋靠 helpdesk 工單 | 回饋是 MCP tool（AI 直接 call） |
|
||||
|
||||
**原則**：
|
||||
1. **discoverable** — AI 不靠 grep / 不靠人就能知道有什麼
|
||||
2. **idempotent** — 同樣輸入兩次結果一樣，可預測
|
||||
3. **dry-run by default** — preview 是預設、commit 是 explicit
|
||||
4. **structured errors** — error 是 JSON 含 next_actions，不是字串
|
||||
5. **closed loop** — AI 卡住的 data 自動回流，平台 self-improving
|
||||
|
||||
---
|
||||
|
||||
## 2. 系統架構
|
||||
|
||||
```
|
||||
┌────────────────────────────────────────────────────────────────┐
|
||||
│ AI agent (Claude / Cursor / ...) │
|
||||
└──────────────────┬──────────────────────────────┬───────────────┘
|
||||
│ │
|
||||
│ ① Read AGENTS.md │ ② MCP tool calls
|
||||
▼ ▼
|
||||
┌────────────────────────┐ ┌──────────────────────────────────┐
|
||||
│ AGENTS.md │ │ arcrun-mcp (擴張 arcrun-mcp) │
|
||||
│ (repo + KBDB block) │ │ 25 tools, 5 categories │
|
||||
└────────────────────────┘ └──────────────┬───────────────────┘
|
||||
│
|
||||
┌────────┬─────────┬────────┴────────┬──────────┐
|
||||
▼ ▼ ▼ ▼ ▼
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌──────────┐
|
||||
│ cypher- │ │registry │ │ kbdb │ │ Skills │ │ Examples │
|
||||
│executor │ │ │ │ │ │ (KBDB) │ │ (git+KV) │
|
||||
│ 31 路由 │ │ │ │ 50 路由 │ │ │ │ │
|
||||
└─────────┘ └─────────┘ └─────────┘ └─────────┘ └──────────┘
|
||||
▲
|
||||
│ ③ AI 部署完 / 卡住 call feedback
|
||||
│
|
||||
┌─────────────┴──────────────┐
|
||||
│ report_feedback / agent-telemetry │
|
||||
│ (寫進 KBDB) │
|
||||
└─────────────┬──────────────┘
|
||||
│ ④ 每週聚合
|
||||
▼
|
||||
┌──────────────────────────────┐
|
||||
│ agent_feedback_weekly_review │
|
||||
│ (arcrun workflow, dogfood) │
|
||||
│ → arcrun-roadmap KBDB block │
|
||||
└──────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 五層 LI 模型
|
||||
|
||||
### Layer 0：Onboarding（AGENTS.md）
|
||||
|
||||
**位置**：
|
||||
- `arcrun/AGENTS.md`（repo 根，git 可讀）
|
||||
- KBDB `type=agent-onboarding` block（MCP `get_onboarding_doc()` 拉）
|
||||
|
||||
**結構（控 5-8K tokens）**：
|
||||
1. **30 字 What** — 「arcrun 是用 YAML 把零件串成 workflow 的平台」
|
||||
2. **5 個核心概念** — component / cypher binding YAML / FOREACH / paused-resume / api_key
|
||||
3. **連線**：「在你的 MCP config 加 `https://mcp.arcrun.dev/mcp`，bearer `ak_xxx`」
|
||||
4. **第一個 workflow（minimal example）** — 10 行 YAML，含部署 + 觸發
|
||||
5. **5 個 URL 慣例與為什麼**（workers.dev vs arcrun.dev / KBDB endpoints）
|
||||
6. **常見錯誤 5 個 + 怎麼讀**
|
||||
7. **不確定的時候**：明確列「先 call list_X 再下手」
|
||||
8. **回報機制**：完成任何 workflow deploy / 卡住，**必須** call `report_feedback`
|
||||
|
||||
**部署機制**：
|
||||
- repo `arcrun/AGENTS.md` 是 source of truth
|
||||
- GH Actions 監聽該檔變動 → 自動 PATCH KBDB onboarding block
|
||||
- MCP `get_onboarding_doc()` 從 KBDB 讀（最新）
|
||||
|
||||
---
|
||||
|
||||
### Layer 1：arcrun-mcp（主戰場）
|
||||
|
||||
#### 1.1 命名與部署
|
||||
|
||||
- **Server URL**: `https://mcp.arcrun.dev/mcp`（唯一 URL）
|
||||
- **舊 URL**：`mcp.finally.click` 直接退場（leo 2026-05-16 拍板，理由：「finally.click 是還沒申請新網址的暫用，那是一個服務，arcrun 是底層」）
|
||||
- **Worker rename**：`u6u-mcp` → `arcrun-mcp`（wrangler name 改），repo 路徑 `matrix/u6u-mcp/` → `matrix/arcrun-mcp/`
|
||||
- **Tool prefix**: 統一 `arcrun_*`（單一 rename，**不保留 `u6u_*` alias**，不留 deprecation 期。用戶量還很少，一次切換可接受。切換前在 mira / telegram 公告）
|
||||
|
||||
#### 1.2 Tool 完整清單（25 個，5 類）
|
||||
|
||||
##### A. Onboarding & Discovery（5 tools）
|
||||
|
||||
| Tool | 對應 HTTP | 用途 |
|
||||
|---|---|---|
|
||||
| `arcrun_get_onboarding` | KBDB GET `/blocks?type=agent-onboarding` | 拉 AGENTS.md 內容 |
|
||||
| `arcrun_list_components` | registry GET `/components` | 所有可用零件 + 1 行 desc |
|
||||
| `arcrun_get_component_contract` | registry GET `/components/:id` | input/output schema + gherkin tests |
|
||||
| `arcrun_list_recipes` | cypher GET `/recipes` + `/auth-recipes` | API recipe 一覽 |
|
||||
| `arcrun_search_examples` | KBDB POST `/search`（type=workflow-example）| 用 use case 搜範例 |
|
||||
|
||||
##### B. Workflow CRUD（7 tools）
|
||||
|
||||
| Tool | 對應 HTTP | 用途 |
|
||||
|---|---|---|
|
||||
| `arcrun_list_workflows` | cypher GET `/webhooks/named` | 用戶現有 workflow |
|
||||
| `arcrun_get_workflow` | cypher GET `/webhooks/named/:name` | 拿 YAML / graph |
|
||||
| `arcrun_validate_yaml` | cypher POST `/validate` | dry-run 校驗，不部署 |
|
||||
| `arcrun_push_workflow` | cypher POST `/webhooks/named` | 部署（也含 validate） |
|
||||
| `arcrun_delete_workflow` | cypher DELETE `/webhooks/named/:name` | 刪 |
|
||||
| `arcrun_preview_workflow` | **新增** POST `/preview` | 不寫 KV、模擬 execute |
|
||||
| `arcrun_diff_workflow` | **新增** POST `/webhooks/named/:name/diff` | 既有 vs 新 YAML 差異 |
|
||||
|
||||
##### C. Execution & Trace（5 tools）
|
||||
|
||||
| Tool | 對應 HTTP | 用途 |
|
||||
|---|---|---|
|
||||
| `arcrun_run_workflow` | cypher POST `/webhooks/named/:name/trigger` | 觸發 + 回 execution_id |
|
||||
| `arcrun_get_execution_trace` | **新增** GET `/executions/:id` | 結構化 trace（per-node status） |
|
||||
| `arcrun_list_recent_executions` | **新增** GET `/workflows/:name/executions?limit=10` | 最近 N 次 |
|
||||
| `arcrun_list_paused_executions` | **新增** GET `/executions/paused` | 卡 callback 的 |
|
||||
| `arcrun_resume_execution` | cypher POST `/workflows/resume` | 手動 resume |
|
||||
|
||||
##### D. Component & Recipe Management（4 tools）
|
||||
|
||||
| Tool | 對應 HTTP | 用途 |
|
||||
|---|---|---|
|
||||
| `arcrun_search_components` | registry POST search | 語意搜尋 |
|
||||
| `arcrun_publish_component` | registry POST publish | 上 WASM |
|
||||
| `arcrun_create_recipe` | cypher POST `/recipes` | 建 API recipe |
|
||||
| `arcrun_create_auth_recipe` | cypher POST `/auth-recipes` | 建 auth recipe |
|
||||
|
||||
##### E. Feedback & Skills（4 tools）
|
||||
|
||||
| Tool | 對應 HTTP | 用途 |
|
||||
|---|---|---|
|
||||
| `arcrun_report_feedback` | KBDB POST `/blocks`（type=agent-feedback）| AI 主動回報 |
|
||||
| `arcrun_list_skills` | KBDB GET `/blocks?type=agent-skill` | 列可用 playbook |
|
||||
| `arcrun_get_skill` | KBDB GET `/blocks/:id` | 拿 skill 內容 |
|
||||
| `arcrun_publish_skill` | KBDB POST `/blocks`（type=agent-skill）| AI 把學到的存回去 |
|
||||
|
||||
#### 1.3 Tool contract 統一規範
|
||||
|
||||
每個 tool 都遵守：
|
||||
|
||||
**Input**：
|
||||
- Zod schema declarative
|
||||
- 每個參數有 `.describe('...')`（給 AI 看的）
|
||||
- optional 標 default
|
||||
|
||||
**Output（成功）**：
|
||||
```typescript
|
||||
{
|
||||
ok: true,
|
||||
data: T,
|
||||
hints?: string[], // optional next-step suggestion，e.g.「你剛部署了，可 call run_workflow 測試」
|
||||
}
|
||||
```
|
||||
|
||||
**Output（失敗）**：
|
||||
```typescript
|
||||
{
|
||||
ok: false,
|
||||
error_code: 'enum_value',
|
||||
human_message: string,
|
||||
next_actions: string[], // 可程式化的下一步
|
||||
detail?: unknown, // 原始錯誤（debug）
|
||||
}
|
||||
```
|
||||
|
||||
#### 1.4 error_code enum（v1，可加不可刪）
|
||||
|
||||
| error_code | 對應狀況 |
|
||||
|---|---|
|
||||
| `auth_missing` | api_key 沒帶 |
|
||||
| `auth_invalid` | api_key 無效 |
|
||||
| `not_found` | workflow / block 不存在 |
|
||||
| `validation_failed` | YAML / schema 不過 |
|
||||
| `component_not_found` | 零件 ID 沒對應 |
|
||||
| `component_not_in_whitelist` | 零件存在但 cypher-executor 不認 |
|
||||
| `paused_awaiting_resume` | workflow 在等 callback |
|
||||
| `rate_limited` | 太頻繁 |
|
||||
| `internal_error` | 平台 bug（含 detail） |
|
||||
| `dependency_unavailable` | 下游服務（claude / mira daemon / KBDB）掛 |
|
||||
|
||||
---
|
||||
|
||||
### Layer 2：Skill blocks（KBDB-native playbook）
|
||||
|
||||
#### 2.1 Schema
|
||||
|
||||
```typescript
|
||||
type AgentSkill = {
|
||||
id: string;
|
||||
type: 'agent-skill';
|
||||
page_name: `skill-${slug}`;
|
||||
content: string; // markdown playbook
|
||||
tags_json: string[]; // ['watcher', 'debug', 'rag', ...]
|
||||
source: 'manual' | 'auto-extracted';
|
||||
metadata_json: {
|
||||
when_to_use: string;
|
||||
example_use_case: string;
|
||||
contributed_by?: string; // agent user_agent
|
||||
success_count?: number;
|
||||
};
|
||||
};
|
||||
```
|
||||
|
||||
#### 2.2 種子 skill（先建 5 個，以 mira 經驗為本）
|
||||
|
||||
| skill page_name | 用途 |
|
||||
|---|---|
|
||||
| `skill-build_watcher_workflow` | cron 掃資料 → 觸發處理（mira_feed_watcher pattern） |
|
||||
| `skill-debug_paused_workflow` | claude_api / 任何 async callback paused 怎麼追 |
|
||||
| `skill-migrate_http_to_trigger_workflow` | self-fetch 換 trigger_workflow（剛踩過的） |
|
||||
| `skill-rag_with_arcrun` | 用 KBDB + claude_api 做 RAG |
|
||||
| `skill-add_new_wasm_component` | 從 TinyGo 寫到 deploy 全流程 |
|
||||
|
||||
#### 2.3 自動萃取機制（後期）
|
||||
|
||||
`agent_feedback_weekly_review` 跑出來的 Top patterns，LLM 包成 skill draft，leo review 後 publish。
|
||||
|
||||
---
|
||||
|
||||
### Layer 3：Examples（可搜尋的範例庫）
|
||||
|
||||
#### 3.1 存放
|
||||
|
||||
- `arcrun/registry/examples/{slug}/`
|
||||
- `workflow.yaml`
|
||||
- `description.md`（解決什麼問題、怎麼 trigger、預期結果）
|
||||
- `tags.json`（`["webhook", "llm", "cron", ...]`）
|
||||
- CI build 出 `examples-index.json` 推 KBDB（type=workflow-example，內容是 YAML + tags）
|
||||
|
||||
#### 3.2 搜尋
|
||||
|
||||
- `arcrun_search_examples(use_case)` 走 KBDB `/search`（既有 semantic）
|
||||
- 命中 → 回 YAML + description + 「你可以基於這個改 X」hint
|
||||
|
||||
#### 3.3 第一批範例（10 個）
|
||||
|
||||
| slug | 用途 |
|
||||
|---|---|
|
||||
| `webhook-to-slack` | 簡單轉發 |
|
||||
| `cron-watcher` | mira_feed_watcher 簡化版 |
|
||||
| `llm-classify` | claude_api 分類 |
|
||||
| `rag-search-answer` | 從 KBDB 找 context → 回答 |
|
||||
| `email-summary` | gmail → claude → telegram |
|
||||
| `pdf-to-blocks` | convert → ingest |
|
||||
| `github-issue-bot` | webhook → claude → 留 comment |
|
||||
| `daily-digest` | cron → 多源聚合 → 推送 |
|
||||
| `parallel-fanout` | 一份輸入分發多 workflow |
|
||||
| `error-retry` | try_catch + wait + retry |
|
||||
|
||||
---
|
||||
|
||||
### Layer 4：Telemetry & Feedback Loop
|
||||
|
||||
#### 4.1 兩條線
|
||||
|
||||
```
|
||||
explicit feedback (AI call) implicit telemetry (platform auto-log)
|
||||
│ │
|
||||
▼ ▼
|
||||
KBDB block type= KBDB block type=
|
||||
agent-feedback agent-telemetry
|
||||
│ │
|
||||
└──────────────┬───────────────────────┘
|
||||
▼
|
||||
agent_feedback_weekly_review
|
||||
(arcrun workflow, 週一 9am cron)
|
||||
▼
|
||||
LLM 聚合 + 分類
|
||||
▼
|
||||
KBDB block type=arcrun-roadmap
|
||||
（leo 收到 + 寫進 mira 河道）
|
||||
```
|
||||
|
||||
#### 4.2 agent-feedback schema
|
||||
|
||||
```typescript
|
||||
type AgentFeedback = {
|
||||
type: 'agent-feedback';
|
||||
content: string; // description 原文
|
||||
source: 'mcp-tool-call';
|
||||
user_id: string; // 用戶 namespace
|
||||
metadata_json: {
|
||||
workflow_name?: string;
|
||||
issue_type: 'doc_unclear' | 'tool_missing' | 'error_unhelpful'
|
||||
| 'unexpected_behavior' | 'feature_request' | 'success_story';
|
||||
retry_count?: number;
|
||||
blocked: boolean;
|
||||
suggested_fix?: string;
|
||||
agent_user_agent: string; // 'claude-code/1.x' etc
|
||||
};
|
||||
tags_json: ['agent-feedback', `issue:${issue_type}`];
|
||||
};
|
||||
```
|
||||
|
||||
#### 4.3 agent-telemetry schema
|
||||
|
||||
```typescript
|
||||
type AgentTelemetry = {
|
||||
type: 'agent-telemetry';
|
||||
source: 'cypher-executor';
|
||||
metadata_json: {
|
||||
event_type: 'deploy_success' | 'deploy_fail' | 'run_success'
|
||||
| 'run_fail' | 'validation_error' | 'mcp_tool_call';
|
||||
workflow_name?: string;
|
||||
component_id?: string;
|
||||
error_code?: string;
|
||||
duration_ms: number;
|
||||
api_key_hash: string; // 雜湊，不存原值
|
||||
agent_user_agent: string;
|
||||
};
|
||||
};
|
||||
```
|
||||
|
||||
寫入點：
|
||||
- `webhook-handlers.executeWebhookGraph` 完成（成功 / 失敗都記）
|
||||
- `routes/webhooks-named.ts` push（deploy 記）
|
||||
- `routes/cypher.ts` validate 失敗（validation_error 記）
|
||||
- arcrun-mcp 每個 tool call wrap 記（mcp_tool_call）
|
||||
|
||||
#### 4.4 隱私
|
||||
|
||||
- api_key 一律 SHA-256 截前 16 字元（不可逆，可聚合）
|
||||
- workflow content 不 log（只記 name）
|
||||
- 用戶看自己的 telemetry：MCP `arcrun_my_telemetry(limit)`，只回自己 hash
|
||||
|
||||
#### 4.5 weekly review workflow
|
||||
|
||||
```yaml
|
||||
name: agent_feedback_weekly_review
|
||||
description: 每週一聚合 AI 回饋 + telemetry，產出 Top 痛點
|
||||
|
||||
flow:
|
||||
- "weekly_cron >> ON_SUCCESS >> fetch_feedback"
|
||||
- "fetch_feedback >> ON_SUCCESS >> fetch_telemetry"
|
||||
- "fetch_telemetry >> ON_SUCCESS >> aggregate"
|
||||
- "aggregate >> ON_SUCCESS >> llm_summarize"
|
||||
- "llm_summarize >> ON_SUCCESS >> publish_roadmap_block"
|
||||
- "publish_roadmap_block >> ON_SUCCESS >> notify_telegram"
|
||||
|
||||
config:
|
||||
weekly_cron:
|
||||
component: cron
|
||||
cron_expr: "0 9 * * 1" # 週一 9 am UTC
|
||||
fetch_feedback:
|
||||
component: kbdb_get
|
||||
type: 'agent-feedback'
|
||||
created_after: "{{ now - 7d }}"
|
||||
limit: 500
|
||||
fetch_telemetry:
|
||||
component: kbdb_get
|
||||
type: 'agent-telemetry'
|
||||
created_after: "{{ now - 7d }}"
|
||||
limit: 5000
|
||||
aggregate:
|
||||
component: filter # 或寫個 `group_by` 邏輯零件
|
||||
items: "{{fetch_feedback.blocks}}"
|
||||
group_by: 'metadata_json.issue_type'
|
||||
llm_summarize:
|
||||
component: claude_api
|
||||
prompt: |
|
||||
你是 arcrun 平台的回饋分析師。下面是這週 AI agent 的所有回饋 +
|
||||
telemetry 失敗事件。請：
|
||||
1. 列 Top 5 痛點（含證據引用）
|
||||
2. 為每個痛點建議具體改動（文件 / MCP tool / 錯誤訊息）
|
||||
3. 評估嚴重程度（blocked AI vs 略不便）
|
||||
|
||||
Feedback：{{aggregate}}
|
||||
Telemetry 失敗事件：{{fetch_telemetry.blocks}}
|
||||
publish_roadmap_block:
|
||||
component: kbdb_create_block
|
||||
type: 'arcrun-roadmap'
|
||||
page_name: 'roadmap-week-{{date.iso_week}}'
|
||||
content: "{{llm_summarize.data.text}}"
|
||||
notify_telegram:
|
||||
component: telegram
|
||||
chat_id: "{{ leo_chat_id }}"
|
||||
text: "Arcrun 週報出爐：{{publish_roadmap_block.data.id}}"
|
||||
```
|
||||
|
||||
**這個 workflow 是 dogfood inception**：arcrun 自己跑分析 arcrun 自己。
|
||||
|
||||
---
|
||||
|
||||
## 4. Coverage Matrix（人類 vs AI）
|
||||
|
||||
> 這份表是 NFR-5「覆蓋率可量化」的具體實踐。每個 release 重新檢視。
|
||||
|
||||
### 4.1 人類 GUI 能做的事 × LI 對應
|
||||
|
||||
| 人類在 arcrun-gui 做的 | LI MCP 工具 | 對等？ |
|
||||
|---|---|---|
|
||||
| 看現有 workflow 列表 | `arcrun_list_workflows` | ✅ |
|
||||
| 點開 workflow 看 YAML | `arcrun_get_workflow` | ✅ |
|
||||
| 編輯 workflow YAML | `arcrun_push_workflow`（含 update） | ✅ |
|
||||
| 執行 workflow | `arcrun_run_workflow` | ✅ |
|
||||
| 看執行結果 | `arcrun_get_execution_trace` | ✅（新增） |
|
||||
| 翻零件庫 | `arcrun_list_components` + search | ✅ |
|
||||
| 看零件 contract | `arcrun_get_component_contract` | ✅ |
|
||||
| 上傳 WASM 零件 | `arcrun_publish_component` | ✅ |
|
||||
| 設 credential | `arcrun_create_recipe` + （手動 push credential） | ⚠️ 部分（credential 提交需安全考量，AI 不全自動） |
|
||||
| 翻歷史執行 | `arcrun_list_recent_executions` | ✅（新增） |
|
||||
| 看 paused 工作流 | `arcrun_list_paused_executions` | ✅（新增） |
|
||||
| 手動 resume | `arcrun_resume_execution` | ✅ |
|
||||
| 視覺化 canvas 拖拉 | — | ❌（純視覺，LI 不複製） |
|
||||
| 看排版 prototype | — | ❌（同上） |
|
||||
| Flip UI/Logic view | — | ❌（同上） |
|
||||
| Action log（操作軌跡） | `arcrun_my_telemetry` | ✅（含更多資料）|
|
||||
|
||||
**Gap**：3 個視覺類動作 LI 不需要對等；其他全等。
|
||||
|
||||
### 4.2 cypher-executor 31 路由 × LI 暴露
|
||||
|
||||
| 路由 | LI 暴露？ | 工具 |
|
||||
|---|---|---|
|
||||
| `/health`、`/docs`、`/openapi.json` | ❌ infra | — |
|
||||
| `/execute` | ✅ | `arcrun_run_workflow`（內部） |
|
||||
| `/cypher/search`、`/cypher/execute` | ✅ | discovery 內部用 |
|
||||
| `/workflows/resume` | ✅ | `arcrun_resume_execution` |
|
||||
| `/webhooks/named*` | ✅ | CRUD 對應 5 個 tools |
|
||||
| `/webhooks/*` (anonymous) | ❌ deprecated | — |
|
||||
| `/credentials*` | ⚠️ | 只 list + delete，POST 走人類流程（安全考量） |
|
||||
| `/recipes*`、`/auth-recipes*` | ✅ | 4 個 tools |
|
||||
| `/validate` | ✅ | `arcrun_validate_yaml` |
|
||||
| `/auth/*`、`/register`、`/me*` | ❌ admin | — |
|
||||
|
||||
**新增需建路由**：`/preview`、`/executions/:id`、`/workflows/:name/executions`、`/executions/paused`、`/webhooks/named/:name/diff`、`/my-telemetry`（共 6 個）
|
||||
|
||||
### 4.3 KBDB 50 路由 × LI 暴露
|
||||
|
||||
LI **不直接 expose KBDB 50 個路由**。AI 透過 arcrun-mcp 的 abstracted tool（`get_skill` / `list_skills` / `report_feedback` 等）間接用 KBDB。
|
||||
|
||||
例外（值得直接 expose 的）：
|
||||
- `arcrun_kbdb_search(query)` — 走 `/search` semantic
|
||||
- `arcrun_kbdb_get_block(id)` — 看 block 內容（debug 用）
|
||||
|
||||
KBDB schema 設計 / triplets / records 這些屬於另一個 SDD（KBDB MCP），不在本 LI 範圍。
|
||||
|
||||
---
|
||||
|
||||
## 5. AGENTS.md 模板
|
||||
|
||||
```markdown
|
||||
# Arcrun for AI Agents
|
||||
|
||||
## What is Arcrun (30 sec)
|
||||
Arcrun lets you compose Cloudflare Workers (WASM components) into workflows via YAML.
|
||||
You write YAML, push to KV, trigger via webhook or cron. Each component is a
|
||||
TinyGo/AssemblyScript WASM with stdin/stdout JSON I/O.
|
||||
|
||||
## Connect (one step)
|
||||
Add to your MCP config:
|
||||
\`\`\`json
|
||||
{
|
||||
"mcpServers": {
|
||||
"arcrun": {
|
||||
"url": "https://mcp.arcrun.dev/mcp",
|
||||
"headers": {"Authorization": "Bearer $ARCRUN_API_KEY"}
|
||||
}
|
||||
}
|
||||
}
|
||||
\`\`\`
|
||||
Get your ak_ key at https://arcrun.dev/me.
|
||||
|
||||
## Your first workflow (5 min)
|
||||
1. `arcrun_list_components()` → see what's available
|
||||
2. Write 3-line YAML in chat (assistant does this)
|
||||
3. `arcrun_validate_yaml(yaml)` → confirm
|
||||
4. `arcrun_push_workflow(yaml)` → deploy
|
||||
5. `arcrun_run_workflow(name, input)` → test
|
||||
6. `arcrun_get_execution_trace(id)` → see results
|
||||
|
||||
## Core concepts (5 things)
|
||||
- **Component**: WASM Worker. Use existing or `arcrun_publish_component`.
|
||||
- **Cypher binding YAML**: triplets `A >> relation >> B` define graph.
|
||||
- **FOREACH**: `>> 對每個 X >> next_node` iterates lists.
|
||||
- **Paused-resume**: claude_api etc pause workflow; resumes via callback.
|
||||
- **api_key**: ak_xxx, all calls need this in MCP auth.
|
||||
|
||||
## URL conventions (why this matters)
|
||||
- `cypher.arcrun.dev` = orchestration API (you push here)
|
||||
- `arcrun-{kebab}.{user}.workers.dev` = component workers (workers.dev avoids CF self-fetch)
|
||||
- `kbdb-*.arcrun.dev` = KBDB component workers (your data lives here)
|
||||
|
||||
## Common errors
|
||||
| error_code | What to do |
|
||||
|---|---|
|
||||
| `component_not_found` | call `list_components`, check spelling |
|
||||
| `validation_failed` | read `next_actions` field, fix YAML |
|
||||
| `paused_awaiting_resume` | normal for claude_api; wait or `get_execution_trace` |
|
||||
| `auth_invalid` | ak_ wrong, re-fetch from /me |
|
||||
|
||||
## Unsure? Do this:
|
||||
- Don't know what's available → `list_components` / `list_workflows` / `search_examples`
|
||||
- Don't know syntax → `get_skill('skill-build_X')` for playbooks
|
||||
- Hit weird behavior → **MUST** call `report_feedback(issue_type='unexpected_behavior', ...)`
|
||||
|
||||
## Feedback (required)
|
||||
After every workflow deploy or debug session, call:
|
||||
\`\`\`
|
||||
arcrun_report_feedback({
|
||||
workflow_name: '...',
|
||||
issue_type: 'success_story' | 'doc_unclear' | 'tool_missing' | 'error_unhelpful' | 'feature_request',
|
||||
description: '...',
|
||||
blocked: false,
|
||||
retry_count: N,
|
||||
suggested_fix: '...' // optional
|
||||
})
|
||||
\`\`\`
|
||||
|
||||
Even "success" stories help — they tell us what's working.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. Migration plan（u6u-mcp → arcrun-mcp 一次切換）
|
||||
|
||||
### 6.1 切換方式
|
||||
|
||||
leo 2026-05-16 拍板：u6u branding 整體退場，**單一 rename，不留 alias 也不留 deprecation 期**。
|
||||
|
||||
- Worker 部署 name 改：`u6u-mcp` → `arcrun-mcp`（wrangler.toml）
|
||||
- 路由改：`mcp.finally.click/*` → `mcp.arcrun.dev/*`（DNS + worker route 同步切）
|
||||
- 舊 URL 退場：`mcp.finally.click` 不保留（要嘛 410 Gone，要嘛 301 redirect 到 arcrun.dev landing 一個說明頁）
|
||||
- Tool 名一次改：所有 `u6u_*` rename 成 `arcrun_*`，**舊名直接消失**
|
||||
- repo 路徑改：`matrix/u6u-mcp/` → `matrix/arcrun-mcp/`
|
||||
|
||||
### 6.2 切換前須做
|
||||
|
||||
- [ ] 全 monorepo `grep u6u_` 確認所有 client（mira / 自家腳本 / leo 自己的 IDE 配置）
|
||||
- [ ] 公告：在 mira 河道 + telegram 通知「ak_xxx 用戶請更新 MCP 配置：URL → mcp.arcrun.dev」
|
||||
- [ ] 切換當天 worker 部署兩個 name（過渡 1 天可回滾），確認流量切完才把舊 worker disable
|
||||
|
||||
### 6.3 為什麼不做 deprecation
|
||||
|
||||
- 用戶量極少（dogfood 階段，主要是 leo 自己）
|
||||
- 留 alias 會讓新 AI agent 學到舊名，違背「LI 一致性」原則
|
||||
- 90 天監控成本 > 一次切換 + 公告
|
||||
|
||||
### 6.2 新增 tools（按 phase）
|
||||
|
||||
Phase 1（gap-fill）：
|
||||
- `arcrun_validate_yaml`（既有 `/validate` 已存，包 MCP 即可）
|
||||
- `arcrun_get_execution_trace`（需 cypher-executor 新加 `/executions/:id`）
|
||||
- `arcrun_list_recent_executions`（新 endpoint）
|
||||
- `arcrun_list_paused_executions`（新 endpoint）
|
||||
- `arcrun_report_feedback`（新 tool）
|
||||
- `arcrun_get_onboarding`（KBDB read）
|
||||
|
||||
Phase 2（advanced）：
|
||||
- `arcrun_preview_workflow`（新 endpoint，沒 KV side-effect）
|
||||
- `arcrun_diff_workflow`
|
||||
- `arcrun_my_telemetry`
|
||||
- `arcrun_search_examples`（KBDB write + search 已存）
|
||||
- `arcrun_list_skills` / `arcrun_get_skill` / `arcrun_publish_skill`
|
||||
|
||||
Phase 3（auto-loop）：
|
||||
- `agent_feedback_weekly_review` workflow
|
||||
- `arcrun-roadmap` block 生成
|
||||
- LLM extract skill 自動化
|
||||
|
||||
---
|
||||
|
||||
## 7. 開發順序與里程碑
|
||||
|
||||
### Milestone 1：可量測（1 週）
|
||||
- 寫 AGENTS.md v1
|
||||
- 加 implicit telemetry 寫入點（cypher-executor）
|
||||
- 加 `arcrun_report_feedback` MCP tool
|
||||
- 建 `agent-feedback` / `agent-telemetry` KBDB template
|
||||
- 開始收 data
|
||||
|
||||
### Milestone 2：gap-fill（1 週）
|
||||
- arcrun-mcp 補上 6 個 Phase 1 tools
|
||||
- 新 endpoints 在 cypher-executor 加
|
||||
- 每個 tool 結構化 error contract
|
||||
|
||||
### Milestone 3：skill + example（1 週）
|
||||
- 種子 5 個 skill blocks
|
||||
- 種子 10 個 example workflows
|
||||
- `search_examples` 跑通
|
||||
|
||||
### Milestone 4：closed loop（半週）
|
||||
- weekly_review workflow 部署
|
||||
- 第一份 arcrun-roadmap block 產出
|
||||
- leo 收到第一份週報
|
||||
|
||||
### Milestone 5：rename + cleanup（1 週）
|
||||
- arcrun-mcp → arcrun-mcp 公開
|
||||
- 舊 tool 加 deprecation warning
|
||||
- AGENTS.md 同步 KBDB
|
||||
|
||||
---
|
||||
|
||||
## 8. 決策紀錄
|
||||
|
||||
### 8.1 已拍板（2026-05-16 leo）
|
||||
|
||||
| 決策 | 結果 | 理由 |
|
||||
|---|---|---|
|
||||
| MCP server URL | `mcp.arcrun.dev` 單一 URL，舊 `mcp.finally.click` 直接退場 | finally.click 是還沒申請新網址的暫用，那是一個服務，arcrun 是底層 |
|
||||
| u6u branding | 整體退場改 arcrun（repo / worker / tool 命名一次 rename） | u6u 不存在了 |
|
||||
| Deprecation 期 | 不留（一次切換 + 公告） | 用戶量極少，留 alias 反而讓新 AI 學到舊名 |
|
||||
| 擴張 vs 建新 | 擴張既有 u6u-mcp（rename 成 arcrun-mcp） | 不 fork，零移轉痛 |
|
||||
| AGENTS.md 位置 | repo `arcrun/AGENTS.md` + 自動同步 KBDB block | 兩面都拿到（git-access 也 OK，純 MCP 也 OK） |
|
||||
| feedback 寫入 auth | 要（驗 ak_ 存在即可，不查餘額） | 防 spam |
|
||||
|
||||
### 8.2 仍可商議（小議題）
|
||||
|
||||
| 議題 | 建議 |
|
||||
|---|---|
|
||||
| LI 是否包含 KBDB MCP | 部分（abstracted），KBDB MCP 另立 SDD `kbdb-llm-interface` |
|
||||
| Telemetry 保留多久 | 90 天 hot + 1 年 cold archive |
|
||||
| AGENTS.md 第一版用中文還是英文 | 中文（leo 自家 + mira 一致），英文版 v2 開源時補 |
|
||||
|
||||
---
|
||||
|
||||
## 9. 跨 SDD 連動
|
||||
|
||||
| 其他 SDD | 連動點 |
|
||||
|---|---|
|
||||
| `credential-primitives-wasm` | LI 不重做 auth，只用 `auth_static_key` 等既有零件 |
|
||||
| `recipe-system` | LI 暴露 recipe CRUD tool 對應 |
|
||||
| `component-registry-canon` | LI `list_components` / `get_contract` 走 registry |
|
||||
| `resumable-workflow` | LI `list_paused_executions` / `resume` 用 |
|
||||
| `arcrun-platform-evolution` | LI 是 evolution 之一，未來分 user-tier 時要考慮 |
|
||||
| **mira-app** (polaris/mira) | LI 是 mira dogfood 痛點轉化的產物，roadmap 含對 mira 的回饋 |
|
||||
@@ -0,0 +1,246 @@
|
||||
# Requirements: LI (LLM Interface) for arcrun
|
||||
|
||||
> 把 arcrun 平台對「AI 操盤手」的完整使用面，當成 first-class product 設計。
|
||||
> 對比：以前做網站要 user-friendly（UI），現在 AI 是主要用戶（LI）。
|
||||
|
||||
---
|
||||
|
||||
## 背景
|
||||
|
||||
arcrun 是 n8n-like workflow 平台，平台本身的 end-user 有兩類：
|
||||
- **人類**：透過 arcrun-gui canvas / arcrun.dev landing 操作
|
||||
- **AI agent**：透過 MCP / API 操作（Claude Code、Cursor、Codex、自製 agent 等）
|
||||
|
||||
過去設計集中在「人」（UI / docs）。AI 對 arcrun 的「可用性」沒被當第一公民。
|
||||
|
||||
### 證據：3 天 mira dogfood 累積的 14 個痛點（baseline）
|
||||
|
||||
| 編號 | 痛點 | 性質 |
|
||||
|---|---|---|
|
||||
| 1 | 新零件 deploy 要手動 dashboard 點 workers.dev | platform DX |
|
||||
| 2 | CF 同 zone self-fetch 死鎖 | platform infra |
|
||||
| 3 | `http_request` 4xx 回 success=true cascade | error semantics |
|
||||
| 4 | interpolateString array stringified | dev experience |
|
||||
| 5 | `kbdb_upsert_block` 沒在 `WASM_HTTP_RUNNER_IDS` 白名單 | discovery |
|
||||
| 6 | `resumeFromPaused` paused_node_id 沒 namespace | implicit behavior |
|
||||
| 7 | `acr validate` 不認「對每個 X」 | validator stale |
|
||||
| 8 | cron 從零寫起 | feature gap |
|
||||
| 9 | CF Pages 沒接 auto-deploy | infra setup |
|
||||
| 10 | watcher self-fetch 死鎖（剛解） | architecture |
|
||||
| 11 | skill 改要寫 python script | tooling gap |
|
||||
| 12 | 不知道有什麼零件可用 | **LI gap** |
|
||||
| 13 | 不知道現有 workflow 怎麼長 | **LI gap** |
|
||||
| 14 | trace / log 看不到結構化的 | **LI gap** |
|
||||
|
||||
**14 個裡有 7 個（編號 3-7, 12-14）純粹是 LI 缺失**。如果 LI 完整，等於把 50% 的踩坑時間還給開發者。
|
||||
|
||||
---
|
||||
|
||||
## 目標用戶（personas）
|
||||
|
||||
### P1：Claude Code / Cursor 等 IDE-embedded AI（主力）
|
||||
|
||||
特徵：
|
||||
- 跟 leo 一起 pair programming
|
||||
- 有 file access、shell 能力
|
||||
- 透過 MCP / curl / SDK 跟 arcrun 對話
|
||||
|
||||
需求：
|
||||
- 知道 arcrun 全貌（不靠人類解釋）
|
||||
- 知道目前用戶有什麼資產（workflow / component / template / credential）
|
||||
- 寫 YAML 不靠猜
|
||||
- 部署前能 dry-run
|
||||
- 部署後能看執行結果
|
||||
- 卡住能 introspect + ask
|
||||
|
||||
### P2：用戶私人 agent（次要，未來）
|
||||
|
||||
特徵：
|
||||
- 在 mira / 用戶 app 內跑
|
||||
- 透過 MCP 對 arcrun
|
||||
- 沒有檔案系統，只有 HTTP
|
||||
|
||||
需求：基本同 P1，但**完全靠 MCP**（沒 grep / file read fallback）
|
||||
|
||||
### P3：自製腳本 / SDK 使用者
|
||||
|
||||
不在本 SDD 範圍。SDK 既有規格走 `.agents/specs/arcrun/sdk-and-website/`。
|
||||
|
||||
---
|
||||
|
||||
## 範圍（系統涵蓋）
|
||||
|
||||
LI 不是「新建一個 service」，是**跨 5 個既有系統的橫向 layer**：
|
||||
|
||||
| 系統 | 既有狀態 | LI 涵蓋的部分 |
|
||||
|---|---|---|
|
||||
| **arcrun cypher-executor** | 31 HTTP 路由 | 哪些對外、哪些 AI 該看得到 |
|
||||
| **arcrun registry** | component 管理 Worker | discovery layer |
|
||||
| **arcrun-mcp**（目前 `matrix/u6u-mcp/`，本 SDD M5 改名） | 15 MCP tools（HTTP→MCP 薄包裝） | 主擴張面（gap-fill） |
|
||||
| **arcrun-gui**（目前 `matrix/u6u-gui/`，本 SDD M5 改名） | 人類 canvas IDE | 取其 endpoint 觀念，不取其 UI 元素 |
|
||||
| **kbdb** | 50 個 HTTP 路由 | KBDB 該不該直接給 AI、用什麼姿勢 |
|
||||
| **arcrun CLI (acr)** | Node CLI | LI 不依賴 CLI（CLI 是人的工具） |
|
||||
|
||||
---
|
||||
|
||||
## 非範圍（這個 SDD 不處理）
|
||||
|
||||
- 不處理 GUI 設計 / 視覺
|
||||
- 不處理 SDK（Python/JS）API 設計
|
||||
- 不處理 user OAuth flow
|
||||
- 不重新設計 KBDB schema（只決定 LI 該包什麼 API）
|
||||
- 不重新設計 cypher binding 語法
|
||||
|
||||
---
|
||||
|
||||
## 功能需求（FR）
|
||||
|
||||
### FR-1：AI 一條指令就能上手 arcrun
|
||||
|
||||
- 提供 `AGENTS.md`（onboarding doc），AI 載入就能用
|
||||
- MCP server URL 寫進 doc，「直接 connect」一步搞定
|
||||
- 不需讀 SDD / 不需 grep codebase / 不需問人
|
||||
|
||||
### FR-2：完整 CRUD + Discovery 對等
|
||||
|
||||
人類在 arcrun-gui 能做的 8 個動作（list_workflows / get / update / execute / search_components / get_component / list_templates / list_credentials），**MCP 至少同等覆蓋**，不能有「人類能做但 AI 不能做」的 gap。
|
||||
|
||||
### FR-3：Dry-run 是預設行為
|
||||
|
||||
- `validate_workflow(yaml)` MCP tool（取既有 `/validate` 路由）
|
||||
- `preview_workflow(yaml, input)` 不寫入 KV，模擬執行
|
||||
- AI 養成習慣「先 dry-run 再 push」
|
||||
|
||||
### FR-4：可診斷的 trace
|
||||
|
||||
- `get_execution_trace(execution_id)` 回結構化 JSON：每個 node 的 status / input / output / error / duration
|
||||
- `list_paused_executions()` 列卡住的執行（callback 沒回時 debug 用）
|
||||
- 不靠 `wrangler tail` 純文字
|
||||
|
||||
### FR-5：錯誤訊息是「給 AI 看的下一步」
|
||||
|
||||
所有 MCP tool error response 必須含：
|
||||
- `error_code`（穩定字串 enum，可程式化 catch）
|
||||
- `human_message`（描述）
|
||||
- `next_actions`（陣列，可選：「call X」/「執行 Y」/「修改 Z」）
|
||||
|
||||
範例：
|
||||
```json
|
||||
{
|
||||
"error_code": "component_not_in_whitelist",
|
||||
"human_message": "零件 'filter' 不在用戶可用清單",
|
||||
"next_actions": [
|
||||
"call list_components() 看完整可用清單",
|
||||
"若該零件需平台啟用，告訴用戶執行 `acr enable filter`",
|
||||
"若是自製零件，先 push 零件再 push workflow"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### FR-6：AI 可以回報問題
|
||||
|
||||
- `report_feedback(workflow_name, issue_type, description, ...)` MCP tool
|
||||
- 結構化 enum issue_type（防自由文字難聚合）
|
||||
- 寫進 KBDB 成 `agent-feedback` block，可被定期 review
|
||||
- AI 規範「順利 / 卡住 / 不確定 都該 call」（透過 AGENTS.md 強制）
|
||||
|
||||
### FR-7：Implicit telemetry 不依賴 AI 自覺
|
||||
|
||||
- cypher-executor 每次 deploy / execute / fail 自動寫 `agent-telemetry` block
|
||||
- 含 client_user_agent（哪個 AI 用的）、error_message、duration
|
||||
- 不依賴 AI 主動 call，平台自己收
|
||||
|
||||
### FR-8：Skill blocks 可重用
|
||||
|
||||
- 「pattern / playbook」存 KBDB type=`agent-skill`
|
||||
- MCP `list_skills(tag)` / `get_skill(id)` 給 AI 查
|
||||
- 範例：`build_watcher_workflow` / `debug_paused_workflow` / `migrate_http_to_trigger_workflow`
|
||||
|
||||
### FR-9：範例庫可搜尋
|
||||
|
||||
- `search_examples(use_case)` 給 use case → 回相似 workflow YAML
|
||||
- 範例存 `registry/examples/` git + 一份 index 在 KV
|
||||
- 進階：semantic search（既有 KBDB `/search/embed`）
|
||||
|
||||
### FR-10：定期 review 機制（自動化）
|
||||
|
||||
- `agent_feedback_weekly_review` workflow（**arcrun 自己跑**）
|
||||
- 每週一聚合 feedback + telemetry，產出 Top N 痛點 + 建議
|
||||
- 寫進 `arcrun-roadmap` KBDB block
|
||||
|
||||
---
|
||||
|
||||
## 非功能需求（NFR）
|
||||
|
||||
### NFR-1：向下相容
|
||||
|
||||
LI 在「擴張」階段（M1-M4）不破壞既有：
|
||||
- M1-M4 階段：arcrun-mcp 既有 15 tool 保留，新增 13 個 tool（pre-rename）
|
||||
- arcrun-gui 不動
|
||||
- cypher-executor 既有路由不改 contract（只加新 endpoint）
|
||||
|
||||
M5（rename）階段是 breaking change（leo 拍板），需事前公告。
|
||||
|
||||
### NFR-2：transport 不鎖死
|
||||
|
||||
MCP 主，但 HTTP 同等可用（讓沒 MCP 客戶端的 agent 也可用）。每個 MCP tool 都對應一個 HTTP endpoint。
|
||||
|
||||
### NFR-3：error contract 穩定
|
||||
|
||||
`error_code` enum 是 public API，加新值是 minor，移除值是 major。版本化。
|
||||
|
||||
### NFR-4：feedback 數據可外部 export
|
||||
|
||||
`agent-feedback` / `agent-telemetry` 走 KBDB `/blocks` 標準 API，任何 AI / 人都能拉。不鎖死在 dashboard。
|
||||
|
||||
### NFR-5：覆蓋率可量化
|
||||
|
||||
- 「人類在 arcrun-gui 能做但 MCP 不能做」清單必須能列出
|
||||
- 每次 LI 改動後，這份清單往 0 收斂
|
||||
|
||||
---
|
||||
|
||||
## 成功指標
|
||||
|
||||
| 指標 | 量測 | 目標 |
|
||||
|---|---|---|
|
||||
| 新 AI agent 上手時間（從 zero 到第一個 workflow 部署） | 手動實驗 | < 10 min |
|
||||
| 一次 workflow 部署需要的 MCP call 次數 | telemetry | < 5 calls |
|
||||
| AI 回報「文件不清楚」週次數 | feedback aggregation | 持續下降 |
|
||||
| 「MCP 缺工具」issue 類型佔比 | feedback type ratio | < 10% |
|
||||
| Implicit telemetry 與 explicit feedback 比例 | 計數 | 9:1 不算問題（implicit 量大正常） |
|
||||
| Coverage gap（人類能做 vs AI 能做） | 手動審查 | 0 |
|
||||
|
||||
---
|
||||
|
||||
## 風險與假設
|
||||
|
||||
### 假設
|
||||
- MCP 是主要 AI 接觸點（不是 SDK / CLI）
|
||||
- AI 願意按 AGENTS.md 規範 call feedback tool
|
||||
- KBDB 能承載 telemetry 量級（短期：< 1000 events / day）
|
||||
|
||||
### 風險
|
||||
|
||||
| 風險 | 應對 |
|
||||
|---|---|
|
||||
| AI 不照 AGENTS.md 規範用 | implicit telemetry 不依賴自覺，仍能收 data |
|
||||
| MCP tool 設計錯誤越改越亂 | 每個 tool 有 contract test，error_code enum 版本化 |
|
||||
| feedback 雜訊太多無法 review | review workflow 用 LLM 聚合，不靠人讀原始 |
|
||||
| arcrun-mcp 重構搞壞既有用戶 | 用戶量還很少（dogfood 階段），一次切換可接受；切換前公告 |
|
||||
| KBDB telemetry 量爆掉 | sample rate / 老資料自動 archive |
|
||||
|
||||
---
|
||||
|
||||
## 決策（2026-05-16 leo 拍板）
|
||||
|
||||
1. **deployment 名稱**：✅ `mcp.arcrun.dev` 單一 URL
|
||||
- `mcp.finally.click` 直接退場，不並存
|
||||
- 理由（leo）：「finally.click 是還沒申請新網址的暫用，那是一個服務，arcrun 是底層」
|
||||
2. **u6u branding 整體退場**：✅ u6u 命名全部改 arcrun
|
||||
- `u6u-mcp` repo → `arcrun-mcp`
|
||||
- `u6u-gui` repo → `arcrun-gui`
|
||||
- 工具命名 `u6u_*` → `arcrun_*`（**單一 rename，不留 alias 也不留 deprecation 期**）
|
||||
- 理由：「u6u 不存在，改成 Arcrun」
|
||||
3. **AGENTS.md 位置**：✅ repo `arcrun/AGENTS.md` + 自動同步 KBDB block（兩面都拿到）
|
||||
4. **feedback 寫入需 auth**：✅ 驗 ak_ 存在即可（防 spam，tier 低不查餘額）
|
||||
@@ -0,0 +1,272 @@
|
||||
# Tasks: LI (LLM Interface) for arcrun
|
||||
|
||||
> SDD: design.md + requirements.md（同目錄）
|
||||
> 進度標記：`[ ]` pending / `[🔄]` doing / `[x]` done / `[⏸]` blocked
|
||||
|
||||
## 進度速覽（2026-05-16）
|
||||
|
||||
- **M1 完成**：AGENTS.md / telemetry helper / report_feedback tool 全部 deploy + e2e 驗證 ✅
|
||||
- **M2.1 完成**：3 個 introspection endpoints + index 強 consistent 修補 ✅
|
||||
- **M2.2 部分**：4 個 introspection + 5 個 CRUD = 9/13 tools，剩下 preview/diff/auth-recipes
|
||||
- **M3.1/M3.3 完成**：5 個 skill blocks + 10 個 example workflows ✅
|
||||
- **M3.4 完成**：sync-registry-to-kbdb.py 跑通，15 blocks 進 KBDB ✅
|
||||
- **M4 完成**：weekly_review workflow 跑通，產出第一份 arcrun-roadmap block ✅
|
||||
- **M5 大 rename**：repo / dir / SDD 已 rename，Worker name 待後段 DNS 遷移
|
||||
|
||||
阻擋項：GH Actions 用戶層被 disable（leo 申訴中）→ 改用本機 wrangler deploy + scripts/local-deploy.sh fallback。
|
||||
|
||||
---
|
||||
|
||||
## Milestone 1：可量測（先收 data）✅
|
||||
|
||||
### M1.1 AGENTS.md v1
|
||||
- [x] 寫 `arcrun/AGENTS.md`（5697355 + 3892dc3，263 行）
|
||||
- [ ] CI hook：repo `AGENTS.md` 變動 → 自動同步 KBDB block
|
||||
- [ ] `arcrun_get_onboarding` MCP tool（讀 KBDB block）
|
||||
|
||||
### M1.2 Implicit telemetry 收集 ✅
|
||||
- [x] 建 KBDB block type=`agent-telemetry`（slots 直接 metadata_json 不走 template）
|
||||
- [x] `webhook-handlers.executeWebhookGraph` 末尾加 telemetry（成功 / 失敗 / paused 都記）
|
||||
- [x] `routes/webhooks-named.ts` push deploy 事件（deploy_success）
|
||||
- [x] `routes/validate.ts` validation 失敗事件（schema_failed / edge_node_missing）
|
||||
- [x] `hashApiKey` SHA-256 截 16 字元 helper
|
||||
- [x] 隱私：只記 workflow name 不記 content
|
||||
- [x] 實測：KBDB block `68635dcb-62e5-49ca-9c67-33f4ca82b7a0` event=run_success, paused_awaiting_resume
|
||||
|
||||
### M1.3 Explicit feedback tool ✅
|
||||
- [x] KBDB block type=`agent-feedback`
|
||||
- [x] arcrun-mcp tool `arcrun_report_feedback` (commit e637c3e)
|
||||
- [x] Zod enum 鎖死 issue_type
|
||||
- [x] user_id 從 partnerAuth 取
|
||||
- [x] tags_json auto: ['agent-feedback', 'issue:{type}', 'blocked'?, 'wf:{name}'?]
|
||||
- [x] schema 實測：KBDB block `80f1d2d1-c95a-4dfe-a889-d23b2e9b247d`
|
||||
|
||||
### M1.4 驗收 ✅
|
||||
- [x] 觸發 mira watcher → KBDB agent-telemetry 即時出現
|
||||
- [x] curl + python verify 8 個 telemetry blocks（event=run_success, workflow_name 對, duration_ms 對）
|
||||
- [x] feedback block 寫入測 schema 通
|
||||
|
||||
---
|
||||
|
||||
## Milestone 2：gap-fill（補 MCP 工具）
|
||||
|
||||
目標：人類 GUI 能做的，AI 透過 MCP 都能做。
|
||||
|
||||
### M2.1 新增 cypher-executor 路由 ✅
|
||||
|
||||
- [x] `GET /executions/:task_id` — 回結構化 paused state (989fbeb)
|
||||
- [x] `GET /workflows/:name/executions?limit=10` — 走 ANALYTICS_KV stats:* prefix (989fbeb)
|
||||
- [x] `GET /executions/paused` — 改 per-user index 強 consistent (4e7880c)
|
||||
- [ ] `POST /preview` — dry-run，不寫 KV（暫緩）
|
||||
- [ ] `POST /webhooks/named/:name/diff` — 新舊 YAML diff（暫緩）
|
||||
- [ ] `GET /my-telemetry?limit=N` — 用戶自己看 telemetry（暫緩）
|
||||
|
||||
### M2.2 MCP tools ✅ (9/13)
|
||||
|
||||
完成（commit faf75cd + f91b1fd）：
|
||||
- [x] `arcrun_validate_yaml` — wrap /validate
|
||||
- [x] `arcrun_get_execution_trace`
|
||||
- [x] `arcrun_list_recent_executions`
|
||||
- [x] `arcrun_list_paused_executions`
|
||||
- [x] `arcrun_push_workflow` — wrap /webhooks/named POST（取代壞掉的 u6u_deploy_workflow）
|
||||
- [x] `arcrun_list_workflows`
|
||||
- [x] `arcrun_get_workflow`
|
||||
- [x] `arcrun_delete_workflow` (require confirm:true literal)
|
||||
- [x] `arcrun_run_workflow` (paused 視為 success)
|
||||
|
||||
暫緩（等 endpoint 完成）：
|
||||
- [ ] `arcrun_resume_execution` — 包既有 /workflows/resume
|
||||
- [ ] `arcrun_preview_workflow` — 待 M2.1 /preview
|
||||
- [ ] `arcrun_diff_workflow` — 待 M2.1 diff
|
||||
- [ ] `arcrun_list_recipes` / `create_recipe`
|
||||
- [ ] `arcrun_list_auth_recipes` / `create_auth_recipe`
|
||||
- [ ] `arcrun_my_telemetry`
|
||||
|
||||
### M2.3 Error contract 統一 ✅
|
||||
|
||||
- [x] `error_code` enum v1 定義在 design.md §1.4 + cypher-executor /executions/* 路由都用
|
||||
- [x] arcrun-mcp `lib/cypher-client.ts` errorResponse() / successResponse() 統一 helper
|
||||
- [x] 所有新 MCP tool（10 個）都用統一 contract（ok, data?, error_code?, human_message?, next_actions?, hints?）
|
||||
- [ ] cypher-executor 既有 route（非 /executions/*）改成統一格式（暫緩）
|
||||
- [ ] 每個 error_code 對應 unit test（暫緩）
|
||||
|
||||
### M2.4 驗收（部分）
|
||||
|
||||
- [ ] 模擬 zero-knowledge AI 跑 hello workflow（待 leo 提供 pk_live）
|
||||
- [ ] 量測：from list_components 到 run_workflow 成功 MCP call < 5
|
||||
- [ ] 比較人類 GUI 路徑，clickwise 對等
|
||||
|
||||
---
|
||||
|
||||
## Milestone 3：skill blocks + examples ✅
|
||||
|
||||
目標：AI 寫第一個 workflow 不靠猜，有範本和 playbook。
|
||||
|
||||
### M3.1 種子 skill blocks ✅ (commit 388c193)
|
||||
|
||||
- [x] `skill-build_watcher_workflow` — cron + 過濾 + trigger 模式
|
||||
- [x] `skill-debug_paused_workflow` — claude_api callback 流程 + 怎麼追
|
||||
- [x] `skill-migrate_http_to_trigger_workflow` — 從 self-fetch 換 trigger_workflow
|
||||
- [x] `skill-rag_with_arcrun` — KBDB search + claude_api 組裝
|
||||
- [x] `skill-add_new_wasm_component` — TinyGo 寫 + push + 註冊白名單
|
||||
|
||||
### M3.2 MCP tools（暫緩，待 M5）
|
||||
|
||||
- [ ] `arcrun_list_skills(tag?)`
|
||||
- [ ] `arcrun_get_skill(id)`
|
||||
- [ ] `arcrun_publish_skill` — AI 把學到的回存
|
||||
|
||||
### M3.3 種子 examples ✅ (commit 388c193)
|
||||
|
||||
10 個範例都建立（webhook-to-http / cron-watcher / llm-classify /
|
||||
rag-search-answer / email-summary / pdf-to-blocks / github-issue-bot /
|
||||
daily-digest / parallel-fanout / error-retry），每個含 workflow.yaml +
|
||||
description.md + tags.json。
|
||||
|
||||
### M3.4 examples 索引 + 搜尋 ✅ (commit 37379b7)
|
||||
|
||||
- [x] scripts/sync-registry-to-kbdb.py — 把 registry/examples + skills 同步進 KBDB
|
||||
- 走 kbdb-upsert-block.arcrun.dev (idempotent，page_name 為 key)
|
||||
- examples → type=workflow-example, page_name=example-{slug}
|
||||
- skills → type=agent-skill, page_name=skill-{slug}
|
||||
- 實測 15 blocks created → 第二次 sync 全 PATCH 成功 (idempotent)
|
||||
- [ ] `arcrun_search_examples(use_case)` MCP tool（待 M2.x 補）
|
||||
|
||||
---
|
||||
|
||||
## Milestone 4：closed loop ✅
|
||||
|
||||
目標：data 收得到 → 平台自己消化產出 roadmap。
|
||||
|
||||
### M4.1 Weekly review workflow ✅ (mira commit de11625)
|
||||
|
||||
- [x] 寫 `polaris/mira/arcrun/agent_feedback_weekly_review.yaml`
|
||||
- [x] cron `0 9 * * 1` （台灣 17:00 週一）
|
||||
- [x] `acr push` 部署
|
||||
- [x] 手動觸發測試一次（5/6 nodes success，唯一 fail 是 notify_leo 缺 credential）
|
||||
|
||||
### M4.2 LLM 聚合 prompt ✅
|
||||
|
||||
- [x] prompt 結構化：數字 / Top 5 痛點（含證據 / 嚴重度）/ 成功 pattern / 下週優先 3 件
|
||||
- [x] 一律繁體中文 + 引用 block_id 為證據
|
||||
- [x] 存 KBDB type=`arcrun-roadmap`, page_name=roadmap-latest（每週覆蓋）
|
||||
- [x] 實測產出真有用：抓到「paused_awaiting_resume 語意不清」「data 量太少」「自動建議包 skill」三個真實 LI 改進建議
|
||||
|
||||
### M4.3 通知
|
||||
|
||||
- [x] notify_leo 節點：telegram chat_id from secret
|
||||
- [ ] leo 補 telegram_bot_token credential 後生效
|
||||
- [ ] 同時寫進 mira 河道（讓 leo 在熟悉介面看）— 暫緩
|
||||
|
||||
### M4.4 驗收
|
||||
|
||||
- [x] 第一次手動觸發 → 收到第一份 roadmap (KBDB block id e924c231-cf5e-4541-89d8-da550ecae2f3)
|
||||
- [ ] cron 自動跑首次（下週一驗證）
|
||||
- [ ] leo review 後挑 1-2 個 issue 修補
|
||||
- [ ] 跑第二週 → 確認該 issue 從 top list 消失
|
||||
|
||||
---
|
||||
|
||||
## Milestone 5：rename + cleanup（u6u → arcrun 一次切換）
|
||||
|
||||
目標：完成 LI 品牌化，u6u branding 整體退場。**leo 2026-05-16 拍板：單一 rename，不留 alias 也不留 deprecation 期**。
|
||||
|
||||
### M5.1 切換前準備
|
||||
|
||||
- [ ] 全 monorepo `grep -rn "u6u_\|mcp\.finally\.click"` 列出所有受影響檔案 + 用戶配置
|
||||
- [ ] mira 河道 + telegram 公告：「ak_xxx 用戶請更新 MCP 配置 URL → mcp.arcrun.dev」（**至少切換前 24h**）
|
||||
- [ ] 列 leo 自己的 IDE（Claude Code / Cursor）配置位置，準備同步更新
|
||||
|
||||
### M5.2 Repo / Worker rename
|
||||
|
||||
- [ ] `matrix/u6u-mcp/` → `matrix/arcrun-mcp/` (git mv)
|
||||
- [ ] `matrix/u6u-gui/` → `matrix/arcrun-gui/` (git mv)
|
||||
- [ ] `arcrun-mcp/wrangler.toml`: name = `arcrun-mcp`
|
||||
- [ ] `arcrun-gui/wrangler.toml`: name = `arcrun-gui`
|
||||
- [ ] DNS：`mcp.arcrun.dev` route 接到 arcrun-mcp worker
|
||||
- [ ] CI（deploy.yml）若有寫死 path 同步改
|
||||
|
||||
### M5.3 Tool rename（一次切換）
|
||||
|
||||
- [ ] 所有 `u6u_*` MCP tool 改 `arcrun_*`（不留 alias）
|
||||
- [ ] AGENTS.md 全用新名
|
||||
- [ ] `arcrun-mcp/README.md` / `GUIDE.md` 全部用新名
|
||||
|
||||
### M5.4 舊 URL 退場
|
||||
|
||||
- [ ] `mcp.finally.click` 接 410 Gone + 訊息「請改用 mcp.arcrun.dev」
|
||||
- 或 301 redirect 到 arcrun.dev landing 一個說明頁
|
||||
- [ ] DNS 紀錄保留 30 天（防意外 client 還沒切）後刪除
|
||||
|
||||
### M5.5 文件最終化
|
||||
|
||||
- [ ] `arcrun/AGENTS.md` 最終版發布
|
||||
- [ ] `matrix/arcrun/.agents/specs/llm-interface/design.md` 加「實際部署狀態」附錄
|
||||
- [ ] 寫一篇 retrospective：LI 做完前後 AI 使用 arcrun 的 time-to-first-workflow 對比
|
||||
|
||||
### M5.6 連動（不在本 SDD 範圍但要追蹤）
|
||||
|
||||
- [ ] `matrix/arcrun/.agents/specs/arcrun-core-mvp/` SDD 改名（另立 task，跨 SDD rename）
|
||||
- [ ] `matrix/arcrun/.agents/specs/arcrun-platform-evolution/` 同上
|
||||
- [ ] 兩個 SDD 重命名屬「u6u 品牌退場」系列，需要單獨追蹤 task
|
||||
|
||||
---
|
||||
|
||||
## Backlog（暫不排）
|
||||
|
||||
### B.1 KBDB MCP 獨立 SDD
|
||||
- LI 範圍只包 KBDB 的 `agent-*` template
|
||||
- 完整 KBDB AI 介面（type=note/page/triplet/template/record 等）另立 SDD `kbdb-llm-interface`
|
||||
- 跟 mira KM 系統互動最密
|
||||
|
||||
### B.2 多 agent 隔離
|
||||
- 多 AI 共用同 ak_xxx 時，telemetry 區隔 agent_user_agent
|
||||
- 進階：每個 AI 子 namespace（mira / cursor / 自製 agent）
|
||||
|
||||
### B.3 AGENTS.md i18n
|
||||
- v1 純中文（leo + 自家用）
|
||||
- v2 英文版（給開源用戶）
|
||||
|
||||
### B.4 自動 skill 萃取
|
||||
- weekly_review 產出的 pattern 自動包成 skill draft
|
||||
- leo review approve → publish
|
||||
|
||||
### B.5 SDK 對等（python-sdk / js-sdk）
|
||||
- SDK 提供和 MCP 同樣的 25 個 method
|
||||
- 給「不想用 MCP 的人」也能 AI-friendly
|
||||
- 走 sdk-and-website SDD 範圍
|
||||
|
||||
### B.6 GUI side 補 LI 看板
|
||||
- arcrun-gui 加 `/li-dashboard` 顯示用戶自己的 telemetry / feedback
|
||||
- 不阻擋 LI 推出（leo 先看 KBDB 原始 block 即可）
|
||||
|
||||
---
|
||||
|
||||
## 依賴關係
|
||||
|
||||
```
|
||||
M1 (data 收集)
|
||||
↓
|
||||
M2 (MCP gap-fill)
|
||||
↓
|
||||
M3 (skill + examples) ← 可與 M2 並行後段
|
||||
↓
|
||||
M4 (closed loop) ←─── 需 M1 data 累積 1-2 週
|
||||
↓
|
||||
M5 (rename)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 工估算
|
||||
|
||||
| Milestone | 工 | 阻擋項 |
|
||||
|---|---|---|
|
||||
| M1 | 5 個工作日 | 無 |
|
||||
| M2 | 5 個工作日 | M1 完（telemetry 先就位才好驗證 M2 改動） |
|
||||
| M3 | 5 個工作日 | M2 完（tool 介面定型才寫 skill） |
|
||||
| M4 | 3 個工作日 | M1 data 累積 1 週 |
|
||||
| M5 | 5 個工作日 | M2-M4 完 |
|
||||
| **總** | **23 個工作日 (~5 週)** | |
|
||||
|
||||
實際視 leo 排程，可邊用邊改、不必一氣呵成。**M1 是硬前置**——資料不收，改了也不知道改對沒。
|
||||
@@ -0,0 +1,240 @@
|
||||
# SDD: arcrun Recipe System（容器 + Recipe 模式）
|
||||
|
||||
> 2026-05-07 建立。吃狗糧寫 wiki 合成 workflow 時撞牆發現的平台缺口。
|
||||
> 核心原則：**一個 WASM 零件 = 容器，內容（recipe）存資料庫**。
|
||||
> n8n 為每種 API 寫獨立 node，arcrun 走「容器 + recipe」減少零件數量。
|
||||
|
||||
---
|
||||
|
||||
## 1. 問題
|
||||
|
||||
### 1.1 撞牆現場
|
||||
|
||||
寫 mira wiki 合成 workflow（7-B）時：
|
||||
- 流程：`kbdb_get(stale)` → foreach → `kbdb_get(drafts)` → `claude_api(合成 prompt)` → `kbdb_ingest`
|
||||
- 第三步要組 prompt：`schema 內容 + skill 模板 + drafts array + existing_entities`
|
||||
- cypher binding 內建 `{{var}}` 模板太弱（只支援 top-level，不支援嵌套 / array → string）
|
||||
- 沒有 `string_template` 零件、沒有 `array_to_markdown` 零件
|
||||
- 寫專用 `wiki_prompt_builder` 零件 = 走 n8n 老路，每個 AI workflow 都要寫一個
|
||||
|
||||
### 1.2 根因
|
||||
|
||||
**arcrun recipe 系統只覆蓋 HTTP / auth 兩層**：
|
||||
|
||||
| Recipe 種類 | 存哪 | 容器 | 狀態 |
|
||||
|---|---|---|---|
|
||||
| auth_recipe | RECIPES KV (`auth_recipe:{service}`) | auth_static_key / auth_oauth2 / ... | ✅ 已有 |
|
||||
| api_recipe | RECIPES KV (`rec_{hash}`) | http_request | ✅ 已有（hard-code 在 cypher-executor 待清，Phase 1-3 處理）|
|
||||
| **prompt_recipe** | ❌ 不存在 | claude_api（容器） | **缺** |
|
||||
|
||||
`claude_api` 零件目前吃 `prompt: string`（已組好的字串），沒有「recipe 模式」可以讓 AI 用「組合配方」的方式呼叫。
|
||||
|
||||
### 1.3 影響
|
||||
|
||||
- **致命**：寫不出第一個 wiki 合成 workflow（7-B 卡關）
|
||||
- **推廣破功**：arcrun 對外 prop 是「容器 + recipe，AI 不用寫 code」，但 prompt 這層做不到
|
||||
- **未來所有 AI workflow 都會撞同樣問題**：rss-tech-news 評語、河道 AI 副駕、ai-comment、文章摘要⋯ 全部需要組 prompt
|
||||
|
||||
---
|
||||
|
||||
## 2. 設計
|
||||
|
||||
### 2.1 核心：prompt_recipe 平行於 auth_recipe / api_recipe
|
||||
|
||||
**儲存**：`RECIPES` KV，key 格式 `prompt_recipe:{name}`
|
||||
|
||||
**結構**：
|
||||
```yaml
|
||||
id: prompt_recipe:wiki_synthesis
|
||||
version: v1
|
||||
description: "Mira wiki 合成（抽 triplet + 寫 wiki paragraph）"
|
||||
model: sonnet # haiku / sonnet / opus（claude_api 沿用既有 routing）
|
||||
|
||||
# 從 KBDB / 其他來源取的 fragment（在 prompt 組合時抓並插入）
|
||||
fragments:
|
||||
- var: schema
|
||||
source: kbdb_block
|
||||
block_id: "7a4e456e-1b0f-406a-8842-5e01d1cf1eef" # mira-wiki-schema
|
||||
field: content
|
||||
- var: skill_template
|
||||
source: kbdb_block
|
||||
block_id: "85e3b81e-dca8-4131-bcdc-990bd0d3a16f" # source-skill-wiki-synthesis
|
||||
field: content
|
||||
|
||||
# 從 workflow context 取（input/前置節點輸出）
|
||||
inputs:
|
||||
- var: drafts # 草稿 array
|
||||
from: "ctx.read_drafts.blocks"
|
||||
transform: "json_array" # 轉成 JSON array string
|
||||
- var: existing_entities
|
||||
from: "ctx.read_entities.blocks"
|
||||
transform: "extract_field:page_name" # 抽 array 的 page_name 欄位 join 成 list
|
||||
- var: entity_name
|
||||
from: "ctx.loop.item" # foreach 迴圈當前元素
|
||||
|
||||
# 最終 prompt 由 fragments + inputs 套進 skill_template 組成
|
||||
prompt_assembly:
|
||||
system: "{{schema}}" # 直接用 schema 當 system prompt
|
||||
user: "{{skill_template}}" # skill template 內含 {{drafts}} {{existing_entities}} {{entity_name}} 變數
|
||||
|
||||
# 期待輸出
|
||||
output:
|
||||
format: json # claude_api 自動 parse 為 object
|
||||
schema: # zod-style，parse 失敗回 success:false
|
||||
type: object
|
||||
required: [triplets, entities, paragraphs, source_summary]
|
||||
```
|
||||
|
||||
### 2.2 Recipe 解析在 cypher-executor（架構選擇 B）
|
||||
|
||||
**設計決策**（2026-05-07）：recipe 解析跟 prompt 組裝**在 cypher-executor TS**，不改既有 claude_api WASM。
|
||||
|
||||
理由：
|
||||
1. recipe 解析是 cypher-executor 既有 `api_recipe / auth_recipe` 同性質工作
|
||||
2. 既有 claude_api 已部署 + 已測試，不動影響面最小
|
||||
3. transform 邏輯（json_array / extract_field 等）TS 寫起來比 TinyGo 簡單 10 倍
|
||||
4. 不違反 §1.6 — skill 還是 KBDB block，cypher-executor 只是組合者，不寫死 prompt
|
||||
|
||||
**流程：**
|
||||
|
||||
```
|
||||
workflow YAML 節點 config 出現 `recipe: prompt_recipe:xxx`
|
||||
│
|
||||
▼
|
||||
cypher-executor graph-executor.ts
|
||||
在執行該節點前 → 偵測 recipe 欄位 → 走 recipe expander
|
||||
│
|
||||
▼
|
||||
recipe expander（新 module）
|
||||
1. 從 RECIPES KV 抓 `prompt_recipe:xxx` 定義
|
||||
2. 按 fragments 規則 → 用既有 KBDB client 抓 block content
|
||||
3. 按 inputs 規則 → 從 context 取值 + 跑 transform
|
||||
4. 組 system prompt + user prompt
|
||||
5. 把 {prompt, model, mira_token, ...} 當作節點實際 input
|
||||
│
|
||||
▼
|
||||
loader 呼叫 claude_api 容器（不知道 recipe 存在，仍吃舊介面）
|
||||
│
|
||||
▼
|
||||
claude_api 容器 → Mira daemon → 回 LLM 結果
|
||||
│
|
||||
▼
|
||||
graph-executor 取結果 → 按 recipe.output 規則 parse JSON / 驗 schema
|
||||
```
|
||||
|
||||
**對 claude_api 容器的影響**：完全沒有。它仍吃 `{mira_token, prompt, model}`。
|
||||
|
||||
**對 workflow 作者的體驗**：
|
||||
```yaml
|
||||
config:
|
||||
synthesize:
|
||||
component: claude_api
|
||||
recipe: "prompt_recipe:wiki_synthesis" # ← cypher-executor 偵測到這欄位，自動解析
|
||||
mira_token: "{{secret.mira_token}}"
|
||||
```
|
||||
|
||||
不寫 recipe 走舊路：
|
||||
```yaml
|
||||
config:
|
||||
reply:
|
||||
component: claude_api
|
||||
prompt: "{{ctx.user_message}}" # ← 沒 recipe，cypher-executor 直接透傳
|
||||
mira_token: "{{secret.mira_token}}"
|
||||
```
|
||||
|
||||
### 2.3 Workflow YAML 體驗
|
||||
|
||||
```yaml
|
||||
name: wiki_synthesis
|
||||
flow:
|
||||
- "input >> 完成後 >> read_stale"
|
||||
- "read_stale >> 對每個 >> read_drafts"
|
||||
- "read_drafts >> 完成後 >> synthesize"
|
||||
- "synthesize >> 完成後 >> write_wiki"
|
||||
config:
|
||||
read_stale:
|
||||
component: kbdb_get
|
||||
page_name: "mira-wiki-index-stale"
|
||||
read_drafts:
|
||||
component: kbdb_get
|
||||
page_name: "{{loop.item}}" # entity name
|
||||
synthesize:
|
||||
component: claude_api
|
||||
recipe: "prompt_recipe:wiki_synthesis" # ← 重點：指 recipe，不寫 prompt
|
||||
mira_token: "{{secret.mira_token}}"
|
||||
write_wiki:
|
||||
component: kbdb_ingest
|
||||
text: "{{prev.paragraphs}}"
|
||||
```
|
||||
|
||||
**AI 寫這 workflow 只需要：**
|
||||
1. 知道有 `kbdb_get / claude_api / kbdb_ingest` 三個容器（MCP search 找得到）
|
||||
2. 知道有 `prompt_recipe:wiki_synthesis` 這個配方（MCP search 找得到）
|
||||
3. 不需要懂 prompt 怎麼組、不需要看 wiki schema 文字
|
||||
|
||||
### 2.4 Recipe 是 KBDB block 還是 KV？
|
||||
|
||||
**選 KV**（`RECIPES` namespace），跟既有 auth_recipe / api_recipe 一致：
|
||||
- key: `prompt_recipe:{name}`
|
||||
- value: YAML/JSON
|
||||
- CLI 跟 MCP 用既有 `recipe push` / `recipe list` 工具管理（不需新工具）
|
||||
|
||||
**不選 KBDB block**：
|
||||
- 雖然 polaris/mira/CLAUDE.md §1.6 說「source-skill 存 KBDB block」
|
||||
- 但 §1.6 講的是 mira 業務的 skill template（schema / skill 模板）
|
||||
- recipe 是「組合配方」（指向哪些 block + 怎麼組），是 platform 層
|
||||
- recipe **裡面** 引用 KBDB block id（fragments.source: kbdb_block）— 兩層關係清楚
|
||||
|
||||
---
|
||||
|
||||
## 3. 範圍邊界
|
||||
|
||||
**在本 SDD 範圍內：**
|
||||
- ✅ Phase 1: prompt_recipe schema + RECIPES KV 規範
|
||||
- ✅ Phase 2: claude_api 改吃 recipe（向後相容舊 prompt 參數）
|
||||
- ✅ Phase 3: 寫第一個 recipe `prompt_recipe:wiki_synthesis`
|
||||
- ✅ Phase 4: 用此 recipe 完成 mira 7-B workflow
|
||||
- ✅ Phase 5: MCP 加 recipe 管理 tool（list / get / push / delete prompt_recipe）
|
||||
|
||||
**不在範圍內：**
|
||||
- HTTP api_recipe / auth_recipe 改造（已有，不動）
|
||||
- 多模態 prompt（image input）— 等 P2
|
||||
- recipe 沙盒驗收（recipe 是資料不是 code，不需要）
|
||||
|
||||
**前置依賴（已完成）：**
|
||||
- ✅ kbdb_get 零件（5.3）
|
||||
- ✅ component-registry MCP backfill（component-registry-canon Phase 1）
|
||||
|
||||
---
|
||||
|
||||
## 4. 為什麼這個設計重要
|
||||
|
||||
| n8n | arcrun |
|
||||
|---|---|
|
||||
| Gmail node、Slack node、OpenAI node、Anthropic node、各 LLM node ⋯（每種 API 一個 node）| `http_request` 容器 + 各 service 的 api_recipe |
|
||||
| 每個 LLM 用法新 node（chat / completion / embedding）| `claude_api` 容器 + 各用途的 prompt_recipe |
|
||||
| AI 要學「Gmail node 怎麼用」「Slack node 怎麼用」⋯ | AI 要學「容器 + 配方」一次學會 |
|
||||
| 零件數爆炸（500+） | 容器固定（< 30），配方無限擴充 |
|
||||
| 配方藏在程式碼 | 配方在 KV，AI 直接 CRUD |
|
||||
|
||||
**對 AI 推廣**：第三方 AI 看到「30 個容器 + 100 個配方」遠比「500 個 node」好理解，且配方是文字資料不是 code，AI 寫配方比寫 node 簡單。
|
||||
|
||||
---
|
||||
|
||||
## 5. 風險與緩解
|
||||
|
||||
| 風險 | 緩解 |
|
||||
|---|---|
|
||||
| recipe 結構過度複雜，AI 寫不出來 | Phase 3 寫第一個 recipe（wiki_synthesis）作為範本，未來 AI 抄 |
|
||||
| 向後相容讓 claude_api 變兩條路 | 內部統一用 recipe path，舊 prompt 參數 → 自動轉成 inline recipe |
|
||||
| recipe 引用 KBDB block id 寫死，block 改 id 就壞 | KBDB block 用 `page_name` 識別比 id 穩定，recipe 支援 `block_page_name` 欄位 |
|
||||
| KV 寫入頻繁的 transform 邏輯（json_array, extract_field:x）→ 變 mini DSL | 限制 transform 種類（10 個內），列白名單，超過就請寫零件 |
|
||||
|
||||
---
|
||||
|
||||
## 6. 變更紀錄
|
||||
|
||||
| 版本 | 日期 | 內容 |
|
||||
|---|---|---|
|
||||
| v1.0 | 2026-05-07 | 初版。吃狗糧寫 wiki 合成 workflow 撞到「prompt 組裝缺口」，補 prompt_recipe 層平行於既有 auth_recipe / api_recipe。 |
|
||||
| v1.1 | 2026-05-07 | 架構選擇 B：recipe 解析在 cypher-executor TS（不改 claude_api WASM）。減少改動面、可單元測試、跟既有 api_recipe 同層次。 |
|
||||
@@ -0,0 +1,110 @@
|
||||
# Tasks — Recipe System (容器 + Recipe 模式)
|
||||
|
||||
> 對應 SDD：[design.md](design.md)
|
||||
> 上次更新：2026-05-07
|
||||
|
||||
**狀態 legend**：`[ ]` 待辦 / `[🔄]` 進行中 / `[x]` 完成
|
||||
|
||||
---
|
||||
|
||||
## Phase 1：prompt_recipe Schema + KV 規範
|
||||
|
||||
- [x] 1.1 寫 `cypher-executor/src/lib/prompt-recipe-schema.ts`（85 行 Zod schema：fragments / inputs / prompt_assembly / output + transform 白名單 7 個）
|
||||
- [x] 1.2 確認 cypher-executor wrangler.toml 已有 RECIPES KV binding
|
||||
- [x] 1.3 寫 recipe loader (`recipe-loader.ts` 50 行) + transforms (`recipe-transforms.ts` 58 行) + expander (`recipe-expander.ts` 127 行)
|
||||
- transform 7 個：json_array / to_string / join / markdown_list / extract_field / first / pluck_content
|
||||
- expander：fragments(KBDB) + inputs(context+transform) → 套 {{var}} 模板 → {prompt, model, output_*}
|
||||
- type-check 全通過
|
||||
|
||||
## Phase 2：cypher-executor recipe expander（架構選擇 B，不改 claude_api）
|
||||
|
||||
- [x] 2.1 寫 `recipe-expander.ts`（127 行：load → fragments → inputs+transform → 套模板 → 回傳 prompt+model+output_*）
|
||||
- [x] 2.2 寫 `recipe-transforms.ts`（58 行：7 個 transform）
|
||||
- [x] 2.3 改 `graph-executor.ts` Component case：偵測 `node.data.recipe` → 呼叫 expandPromptRecipe → merge 進 mergedContext
|
||||
- [x] 2.4 output parser hook：執行完若 `_recipe_output_format === 'json'` 自動 parse + required_fields 驗證
|
||||
- [x] 2.5 部署 cypher-executor v426b099e
|
||||
- [x] 2.6 端對端驗證：用 curl 打 `/cypher/execute` 帶 recipe，trace 顯示 recipe 展開正確 + claude_api 拿到組好 prompt（Mira daemon 端 522 timeout 是 daemon 問題，不是 recipe 系統）
|
||||
- [x] 2.7 [紅利修復] cypher-executor `WASM_HTTP_RUNNER_IDS` 加 5 個 mira 零件（claude_api / kbdb_*）— 短期解，根本修法見 KI-13
|
||||
|
||||
## Phase 3：第一個 recipe — wiki_synthesis
|
||||
|
||||
- [x] 3.1 寫 `polaris/mira/recipes/wiki_synthesis.json`（4 fragments + 4 inputs + system/user template + json output）
|
||||
- [x] 3.2 用 `wrangler kv key put --remote` 推進 RECIPES KV (key: `prompt_recipe:wiki_synthesis`)
|
||||
- [x] 3.3 確認 KV 寫入成功（wrangler kv get 驗證）
|
||||
- [ ] 3.4 不適用（架構選擇 B 不改 claude_api，recipe 在 cypher-executor 解析）
|
||||
- [x] 3.5 端對端測試：用 MCP `u6u_execute_workflow` 跑 wiki_synthesis 成功
|
||||
- input：1 句草稿（黃仁勳 GTC 2026 物理 AI）
|
||||
- output：3 triplets + 3 entities + 1 wiki paragraph + source_summary
|
||||
- 過程修了 KI-14 (service binding 指錯)、KI-15 (token 沒轉發)、KI-16 (Claude markdown fence 沒剝)
|
||||
|
||||
## Phase 4：mira 7-B 用 recipe 完成 wiki workflow
|
||||
|
||||
- [🔄] 4.1 寫 `polaris/mira/workflows/wiki_synthesis.yaml`（cypher binding YAML）
|
||||
- 用 `recipe: prompt_recipe:wiki_synthesis` 指 recipe
|
||||
- 4-5 個節點：read_stale → foreach → read_drafts → synthesize → write_wiki + log
|
||||
- [ ] 4.2 用 MCP `u6u_execute_workflow` sandbox 跑（試一個 entity 不真寫 KBDB）
|
||||
- [ ] 4.3 用 MCP `u6u_deploy_workflow` 部署到 cypher-executor
|
||||
- [ ] 4.4 手動觸發 cron，驗 wiki page 真的出現
|
||||
- [ ] 4.5 在 mira/wiki/ 前端看到第一張 AI 合成 wiki page
|
||||
|
||||
## Phase 5：MCP recipe 管理 tools
|
||||
|
||||
- [ ] 5.1 加 MCP tool `arcrun_list_recipes(prefix?)`：列所有 prompt_recipe
|
||||
- [ ] 5.2 加 MCP tool `arcrun_get_recipe(name)`：取單一 recipe 內容
|
||||
- [ ] 5.3 加 MCP tool `arcrun_push_recipe(name, yaml_content)`：upsert recipe
|
||||
- [ ] 5.4 加 MCP tool `arcrun_delete_recipe(name)`
|
||||
- [ ] 5.5 既有 auth_recipe / api_recipe 也通用同套 tool（不只 prompt_recipe）
|
||||
|
||||
---
|
||||
|
||||
## 風險追蹤
|
||||
|
||||
- 風險 1：claude_api 改造跟 mira-app 同時動，可能影響河道 AI 副駕
|
||||
- 緩解：向後相容，舊 input 仍可用，mira 河道先不切 recipe
|
||||
- 風險 2：recipe transform 白名單漏了某種需求
|
||||
- 緩解：發現缺什麼再加，第一版優先支援 wiki 用到的（json_array, extract_field, join）
|
||||
- 風險 3：KV 跟 KBDB 都存配置，AI 困惑「該存哪邊」
|
||||
- 緩解：清楚分層 — recipe（容器組合方式） KV，data（schema 文字、skill 模板） KBDB
|
||||
|
||||
---
|
||||
|
||||
## Known Issues（吃狗糧發現，記錄）
|
||||
|
||||
### KI-11：MCP `u6u_execute_workflow` 不暴露 config 欄位 ✅ 修復（2026-05-07）
|
||||
- 已修：tool schema 加 optional `config: Record<string, Record<string, any>>`
|
||||
- 部署：u6u-mcp v11d7e366
|
||||
- 用戶要重啟 client session 才能看到新 schema
|
||||
|
||||
### KI-12：MCP execute 路由打 `/execute` 而非 `/cypher/execute` ✅ 修復（2026-05-07）
|
||||
- 已修：service binding fetch URL 改成 `http://cypher-executor/cypher/execute`
|
||||
- 部署：u6u-mcp v11d7e366
|
||||
|
||||
### KI-14：u6u-mcp service binding 指向已廢棄的 inkstone-cypher-executor ✅ 修復
|
||||
- 現象：MCP 路徑跑 workflow trace 顯示 synth 變 Output、config 被忽略
|
||||
- 根因：`u6u-mcp/wrangler.toml` services binding 是舊 worker `inkstone-cypher-executor`，不是現役 `arcrun-cypher-executor`
|
||||
- 解法：改 service name + redeploy
|
||||
|
||||
### KI-15：u6u-mcp 沒把 partner token 轉發給 cypher-executor ✅ 修復
|
||||
- 現象：recipe expander 抓 KBDB block 401（沒 auth）
|
||||
- 根因：partnerAuthMiddleware 驗完 token 但只 set org_namespace，沒留 token；execute_workflow tool fetch 沒帶 X-Arcrun-API-Key
|
||||
- 解法：middleware 也 set partner_token、handleMcpRequest + registerAllTools + execute_workflow 多一個 partnerToken 參數、fetch header 加 X-Arcrun-API-Key
|
||||
|
||||
### KI-16：Recipe JSON output 被 Claude 包在 ```json``` markdown fence ✅ 修復
|
||||
- 現象：JSON.parse 失敗 "Unexpected token \`"
|
||||
- 根因：Claude 預設輸出 ```json\n{...}\n``` 包裝
|
||||
- 解法：cypher-executor 解析前 regex 剝 fence
|
||||
|
||||
### KI-13：cypher-executor `WASM_HTTP_RUNNER_IDS` 寫死白名單
|
||||
- 現象：每加新零件要回 cypher-executor 改白名單 + 重部署
|
||||
- 影響：違反 arcrun「容器+ recipe，新零件無需改 platform」承諾
|
||||
- 短期解：手動加進白名單（claude_api / kbdb_* 已加）
|
||||
- 根本解：改成從 component-registry KV 動態查 canonical_id
|
||||
- 優先級：P1（推廣破口），需新 SDD `cypher-executor-dynamic-component-discovery`
|
||||
|
||||
---
|
||||
|
||||
## 對外推廣（Phase 6+，本 SDD 不執行，記錄）
|
||||
|
||||
- README 示範「容器 + recipe = 一個 service」(Gmail / Slack / Claude)
|
||||
- onboarding kit GitHub template 內含 5 個經典 recipe 當範例
|
||||
- 「recipe market」想法：用戶分享 recipe 幫他人少寫 prompt
|
||||
@@ -0,0 +1,285 @@
|
||||
# SDD: Resumable Workflow（webhook callback 喚醒）
|
||||
|
||||
> 2026-05-07 建立。狗糧寫 wiki 合成 workflow 時，Mira daemon 對長草稿（>2KB）切非同步模式回 `{pending, task_id, poll_url}`，cypher-executor 沒處理就直接傳下游。
|
||||
> 本 SDD 解這層：**workflow 跑到一半遇到 pending 任務 → 暫停 + 持久化狀態 → 外部 callback 進來時喚醒繼續**。
|
||||
> 範圍：兩家自家服務之間（Mira daemon ↔ cypher-executor）走 webhook 推。對外服務無 webhook 的場景留 wishlist 用 poll 解。
|
||||
|
||||
---
|
||||
|
||||
## 1. 問題
|
||||
|
||||
### 1.1 撞牆現場
|
||||
|
||||
wiki 合成 workflow 第一節點 `claude_api(recipe:wiki_synthesis)`：
|
||||
- 短草稿（< 2KB）→ daemon 同步回 `{success, data: {text}}`，recipe output parser 解 JSON 成功
|
||||
- 長草稿（> 2KB）→ daemon 估 75s，切非同步模式回：
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"pending": true,
|
||||
"task_id": "task_14_1778133152480",
|
||||
"poll_url": "https://mira.uncle6.me/mira/execute/task_14_1778133152480",
|
||||
"estimated_seconds": 75
|
||||
}
|
||||
```
|
||||
|
||||
cypher-executor 拿到這個物件就當 result，但裡面沒 `data.text`，下游 recipe output parser 找不到要 parse 的東西，整個 workflow 算「success」但實際上 wiki 還沒生出來。
|
||||
|
||||
### 1.2 現有 toolkit 不夠
|
||||
|
||||
- `wait` 零件：固定 sleep N ms，沒 retry / 條件判斷
|
||||
- `http_request` 零件：通用 HTTP，不認 daemon 的 polling 協議
|
||||
- cypher-executor `visited` Set：擋住節點重訪，沒辦法做迴圈式 poll
|
||||
- Worker CPU 30s 限制：同步 poll 75s 任務不可能
|
||||
|
||||
### 1.3 Push vs Pull 抉擇（2026-05-07 拍板）
|
||||
|
||||
| | Webhook 推 | Poll 拉 |
|
||||
|---|---|---|
|
||||
| 適用 | 雙方都自家 | 對方無 callback 能力 |
|
||||
| Worker 時間消耗 | 趨近 0 | 全程占用 |
|
||||
| 時長限制 | 無 | Worker CPU 30s |
|
||||
| 工程位置 | runtime 能力（cypher-executor）| 零件（poll_task） |
|
||||
|
||||
**走 Webhook 推**（自家服務優先，poll_task 進 wishlist）。
|
||||
|
||||
---
|
||||
|
||||
## 2. 設計
|
||||
|
||||
### 2.1 三層改動
|
||||
|
||||
**A. Mira daemon 端（infra/cloud-cto）**
|
||||
- `/mira/execute` 接受新欄位 `callback_url: string`（optional）
|
||||
- task 完成時 POST 到 `callback_url`，body：
|
||||
```json
|
||||
{
|
||||
"task_id": "task_14_xxx",
|
||||
"success": true,
|
||||
"data": { "text": "..." }
|
||||
}
|
||||
```
|
||||
- 失敗也要 callback，body 含 `error` 欄位
|
||||
- 重試策略：3 次 backoff（1s / 5s / 30s），最後失敗就放棄（task 狀態存進 daemon 自己 KV）
|
||||
|
||||
**B. cypher-executor 端（resumable runtime）**
|
||||
|
||||
新概念：**workflow run 可以暫停**。
|
||||
|
||||
設計：
|
||||
1. 新 KV namespace（或用既有 `EXEC_CONTEXT`）存暫停的 run state：
|
||||
- key: `paused_run:{task_id}` 或 `paused_run:{run_id}`
|
||||
- value: `{ run_id, graph, paused_node_id, paused_node_pending_result, context, trace_so_far, kv_store_ref, expires_at }`
|
||||
2. graph-executor 偵測節點 result 含 `pending: true` + `task_id` → 暫停 + 寫 KV + 回 `{paused: true, task_id, run_id}`
|
||||
3. 新 endpoint `POST /workflows/resume`：
|
||||
- body: `{ task_id, result }`（result 是 daemon callback 給的完整資料）
|
||||
- 從 KV 拿 paused state → merge result 進 paused_node 的 output → 從下個節點繼續執行
|
||||
4. claude_api 容器呼叫 daemon 時自動帶 `callback_url`：
|
||||
- `https://cypher.arcrun.dev/workflows/resume?task_id={預先派發的 task_id}`
|
||||
- 但 task_id 是 daemon 自己派的，cypher-executor 不知道。需先 daemon 派完 task_id 才能組 URL
|
||||
- 解：daemon 改成「先回 task_id，再啟動實際工作 + 完成時 callback」— 兩階段 hand-shake
|
||||
|
||||
實際流程（兩階段）：
|
||||
|
||||
```
|
||||
cypher-executor Mira daemon
|
||||
│ │
|
||||
│ POST /mira/execute │
|
||||
│ { prompt, │
|
||||
│ callback_url: "?run_id=R1" }
|
||||
├─────────────────────────────>│
|
||||
│ │ 立即回 task_id（決定走非同步）
|
||||
│<─────────────────────────────┤ { pending, task_id: T9 }
|
||||
│ │
|
||||
├─ 看到 pending → 寫 KV │ 啟動實際 LLM 任務
|
||||
│ paused_run:T9 = {run R1, │
|
||||
│ paused_node, ctx, ...} │
|
||||
│ │
|
||||
│ 立即回 client (MCP)： │
|
||||
│ { paused, task_id: T9 } │
|
||||
│ │
|
||||
⋯⋯⋯⋯⋯ 75s 後 ⋯⋯⋯⋯⋯⋯⋯⋯⋯⋯⋯⋯⋯⋯⋯⋯
|
||||
│ │ task done
|
||||
│ POST /workflows/resume │
|
||||
│ { task_id: T9, result: {...} }
|
||||
│<─────────────────────────────┤
|
||||
│ │
|
||||
│ 從 KV 取 paused_run:T9 │
|
||||
│ → merge result 進 paused 節點 │
|
||||
│ → 從下個節點繼續 │
|
||||
│ │
|
||||
│ run 跑完 → 寫 trace │
|
||||
│ → 通知 client (?) │
|
||||
│ │
|
||||
```
|
||||
|
||||
### 2.2 範圍邊界
|
||||
|
||||
**第一版（v1）做：**
|
||||
- ✅ 單節點 pending → resume（最常見：claude_api 拿到 daemon pending）
|
||||
- ✅ daemon 加 callback_url 支援
|
||||
- ✅ cypher-executor `/workflows/resume` endpoint
|
||||
- ✅ run state 寫 EXEC_CONTEXT KV，含 24h TTL（避免 KV 累積）
|
||||
- ✅ 整合測：用 wiki 合成跑長草稿，驗 callback 進來能繼續
|
||||
|
||||
**第一版不做：**
|
||||
- ❌ 多節點都 pending 的 nested 場景（例如 claude_api → 又一個 claude_api）— v2
|
||||
- ❌ foreach 內 pending（item-level resume）— v2
|
||||
- ❌ pending 期間用戶看到「進度」的前端 UI — 走 trace 有 paused 標記，前端 polling 自己做即可
|
||||
- ❌ pending callback 失敗時的 retry / DLQ — v2，先記 log
|
||||
|
||||
**前置依賴：**
|
||||
- ✅ recipe-system 已部署（cypher-executor 已會解 recipe）
|
||||
- ✅ Mira daemon 在 Hetzner，可改 code
|
||||
|
||||
### 2.3 為什麼不用 Cloudflare Queues / Durable Objects
|
||||
|
||||
- **CF Queues**：適合大量 fan-out，這裡是點對點 callback，KV 已夠
|
||||
- **Durable Objects**：long-lived state 比 KV 強，但成本高 + 複雜
|
||||
- **EXEC_CONTEXT KV**：既有 binding，工程量最小
|
||||
|
||||
未來真撞到 KV 限制（每 partner 寫入頻率上限）再升級。
|
||||
|
||||
---
|
||||
|
||||
## 3. 詳細設計
|
||||
|
||||
### 3.1 daemon 端 callback 機制
|
||||
|
||||
`infra/cloud-cto/index.js`（Mira daemon）：
|
||||
|
||||
```js
|
||||
// /mira/execute handler
|
||||
{
|
||||
// 既有 input + 新加：
|
||||
callback_url: string // optional
|
||||
}
|
||||
|
||||
// 處理邏輯：
|
||||
// 1. 啟動 task（既有邏輯）
|
||||
// 2. 預估時間 > 30s → 切非同步：
|
||||
// - 立即回 { success: true, pending: true, task_id, poll_url, estimated_seconds }
|
||||
// - 背景 task 完成時：
|
||||
// if (callback_url) POST callback_url with { task_id, success, data, error? }
|
||||
// （不論用戶有沒有 poll，callback 一定會送）
|
||||
```
|
||||
|
||||
callback 失敗策略：
|
||||
- 3 次重試（1s / 5s / 30s）
|
||||
- 全失敗：task 狀態維持完成，等 client 主動 poll（poll_url 仍有效）
|
||||
- 超過 24h 沒被消化的 task：daemon GC
|
||||
|
||||
### 3.2 cypher-executor 端 resumable runtime
|
||||
|
||||
#### 3.2.1 偵測 pending（graph-executor）
|
||||
|
||||
在 Component case，runner 回傳後：
|
||||
|
||||
```ts
|
||||
result = await runner(mergedContext);
|
||||
|
||||
// 偵測 pending pattern（daemon 約定的回應結構）
|
||||
if (isResumablePending(result)) {
|
||||
await persistPausedRun(this.env.EXEC_CONTEXT, taskIdFromResult(result), {
|
||||
run_id, graph, paused_node_id: node.id, paused_context: context,
|
||||
paused_result: result, trace_so_far: trace, expires_at: Date.now() + 24*60*60*1000
|
||||
});
|
||||
// 提早結束此 run，回 paused 狀態
|
||||
return { paused: true, task_id, run_id };
|
||||
}
|
||||
|
||||
// ... 既有的 recipe output parsing / kvSetNodeOutput / 等
|
||||
```
|
||||
|
||||
`isResumablePending(result)` = `result?.pending === true && typeof result?.task_id === 'string'`
|
||||
|
||||
#### 3.2.2 callback URL 注入（claude_api 之前的 layer）
|
||||
|
||||
問題：claude_api 容器發 daemon 請求時，要帶 `callback_url`。但 task_id 是 daemon 派的，URL 裡只能放 run_id，daemon 收到 callback 時填 task_id：
|
||||
|
||||
`callback_url = https://cypher.arcrun.dev/workflows/resume?run_id={current_run_id}`
|
||||
|
||||
但 cypher-executor 端用 task_id 找 paused state（一個 run 可能多個 pending），所以 callback URL 應該是：
|
||||
|
||||
`callback_url = https://cypher.arcrun.dev/workflows/resume`（不帶 query，task_id 在 body）
|
||||
|
||||
**實作位置**：在 graph-executor 呼叫 claude_api 前，自動注入 `callback_url` 到 mergedContext：
|
||||
|
||||
```ts
|
||||
if (node.componentId === 'claude_api' && this.env?.PUBLIC_BASE_URL) {
|
||||
mergedContext.callback_url = `${this.env.PUBLIC_BASE_URL}/workflows/resume`;
|
||||
}
|
||||
```
|
||||
|
||||
> 暫先用「componentId 寫死匹配」是 hacky，未來 component contract 加 `supports_async_callback: true` 標記就 generic 了。
|
||||
|
||||
#### 3.2.3 resume endpoint
|
||||
|
||||
`POST /workflows/resume`：
|
||||
|
||||
```ts
|
||||
{
|
||||
task_id: string, // daemon 給的
|
||||
success: boolean,
|
||||
data?: { text: string }, // 跟同步呼叫一樣的結構
|
||||
error?: string
|
||||
}
|
||||
```
|
||||
|
||||
處理：
|
||||
1. 從 EXEC_CONTEXT KV `paused_run:{task_id}` 拿 state
|
||||
2. 沒拿到（過期 / 重複 callback）→ 回 200 + log
|
||||
3. 把 callback 給的 result 當作 paused_node 的 output
|
||||
4. 重建 GraphExecutor，從下個節點繼續執行
|
||||
5. 跑完寫完整 trace
|
||||
|
||||
**問題：resume 後沒辦法再回給原 client。** 用戶最初打 `/cypher/execute`（同步），拿到 `{paused, task_id}` 之後就斷了；resume 跑完 result 沒地方送。
|
||||
|
||||
**v1 解法**：resume 完寫進 `analytics_kv` 或 D1，**用戶要主動 query**。簡單但 UX 差。
|
||||
**v2 想法**：resume 完發另一個 webhook 給原 client（client 在 trigger 時帶 final_callback_url）。
|
||||
|
||||
---
|
||||
|
||||
## 4. 範圍
|
||||
|
||||
**在本 SDD 範圍內：**
|
||||
- 4.1 daemon `/mira/execute` 加 callback_url 支援
|
||||
- 4.2 cypher-executor 偵測 pending + 持久化 paused state
|
||||
- 4.3 cypher-executor `/workflows/resume` endpoint
|
||||
- 4.4 callback_url 自動注入（claude_api 場景）
|
||||
- 4.5 wiki 合成 workflow 用長草稿端對端測試
|
||||
|
||||
**不在本 SDD 範圍：**
|
||||
- nested pending（v2）
|
||||
- foreach 內 pending（v2）
|
||||
- final_callback 給原 client（v2）
|
||||
- poll_task 零件（wishlist）
|
||||
|
||||
---
|
||||
|
||||
## 5. 驗收標準
|
||||
|
||||
1. wiki 合成 workflow 餵 5KB+ 草稿，跑完後 wiki page 有寫進 KBDB（不再 trace `pending` 假成功）
|
||||
2. trace 有 `paused` 紀錄，能看到 task_id
|
||||
3. 從 daemon 觸發 callback 後 < 5s 內 cypher-executor 把 paused state 撿起來繼續
|
||||
4. 24h 沒 callback 的 paused state KV 自動 expire（看 KV TTL 列表）
|
||||
|
||||
---
|
||||
|
||||
## 6. 風險
|
||||
|
||||
| 風險 | 緩解 |
|
||||
|---|---|
|
||||
| daemon callback 進來時 cypher-executor 重啟 → state 還在 KV，OK | KV 持久化 |
|
||||
| 同 task_id 重複 callback（網路重試）→ 重複執行下游 | resume endpoint idempotent：拿到 state 後立刻刪 KV，重複 callback 找不到 state |
|
||||
| daemon callback 失敗（網路）| daemon 端 3 retry + 24h GC，超過就需手動干預（v1 接受） |
|
||||
| paused state 含敏感資料（partner key）| KV 有 24h TTL；不寫 plaintext secrets（既有 credential injection 在執行前才解，paused state 存的是執行前的 context，secret 還沒解）|
|
||||
|
||||
---
|
||||
|
||||
## 7. 變更紀錄
|
||||
|
||||
| 版本 | 日期 | 內容 |
|
||||
|---|---|---|
|
||||
| v1.0 | 2026-05-07 | 初版。狗糧 wiki 合成撞 daemon 非同步 → 補 resumable workflow runtime。第一版只做單節點 pending + claude_api callback 注入。|
|
||||
@@ -0,0 +1,61 @@
|
||||
# Tasks — Resumable Workflow
|
||||
|
||||
> 對應 SDD：[design.md](design.md)
|
||||
> 上次更新：2026-05-07
|
||||
|
||||
**狀態 legend**：`[ ]` 待辦 / `[🔄]` 進行中 / `[x]` 完成
|
||||
|
||||
---
|
||||
|
||||
## Phase 1：Mira daemon 端 callback 支援
|
||||
|
||||
- [x] 1.1 改 `/opt/mira/mira-daemon.js`（Hetzner mira container）`/execute` 接受 `params.callback_url`
|
||||
- [x] 1.2 fireCallback function：task done/failed 時 POST callback_url，body = `{task_id, success, data?, error?}`
|
||||
- [x] 1.3 callback retry：4 次（立即 + 1s/5s/30s backoff），全失敗 log
|
||||
- [x] 1.4 patch script 寫好 `/tmp/patch-mira-daemon.py`，docker cp 進 container（注意：rebuild image 會丟失，需重 patch 或正式 commit 進 Dockerfile/git repo）
|
||||
- [x] 1.5 真實端對端驗證：daemon log 顯示 `[Mira callback] task=task_2_... POST https://cypher.arcrun.dev/workflows/resume OK 200`（2026-05-07 07:24:04 + task_3 短測試）
|
||||
|
||||
## Phase 2：cypher-executor resumable runtime
|
||||
|
||||
- [x] 2.1 寫 `paused-runs.ts`（81 行）：persistPausedRun / loadPausedRun / consumePausedRun + isResumablePending 偵測器，24h TTL
|
||||
- [x] 2.2 改 `graph-executor.ts` Component case：偵測 pending → 寫 KV + throw WorkflowPaused
|
||||
- [x] 2.3 改 `cypher-handlers.ts`：catch WorkflowPaused → 回 `{success:true, paused:true, task_id, run_id, paused_node_id, trace, graph}`
|
||||
- [x] 2.4 callback_url 自動注入：componentId==='claude_api' 時 mergedContext.callback_url = PUBLIC_BASE_URL 或預設 cypher.arcrun.dev/workflows/resume
|
||||
|
||||
## Phase 3：resume endpoint
|
||||
|
||||
- [x] 3.1 寫 `routes/resume.ts`：POST /workflows/resume，consumePausedRun → resumeFromPaused
|
||||
- [x] 3.2 graph-executor 加 `resumeFromPaused()` 方法：把 callback_result 當 paused_node 輸出 + spread 進 ctx + 從下游節點繼續
|
||||
- [x] 3.3 idempotent 驗證：第二次 callback 回 `{noop:true, reason:"state 不存在或過期"}`
|
||||
- [x] 3.4 cypher-executor 部署 v0580980b
|
||||
- [x] 3.5 mount /workflows/resume 進 index.ts
|
||||
|
||||
## Phase 4：claude_api 容器透傳 callback_url
|
||||
|
||||
- [x] 4.1 改 `claude_api/main.go`：Input 加 CallbackURL；timeout 預設改 120s
|
||||
- [x] 4.2 重 build wasm + redeploy claude-api.arcrun.dev (v f926e3dd)
|
||||
- [x] 4.3 真實端對端驗證：daemon 收到 callback_url → task done 後 POST cypher-executor/workflows/resume → 200 OK
|
||||
|
||||
## Phase 5：端對端整合測試
|
||||
|
||||
- [ ] 5.1 用 MCP `u6u_execute_workflow` 跑 wiki 合成 + 5KB+ 草稿
|
||||
- [ ] 5.2 第一次回應應為 `{paused, task_id, run_id}`
|
||||
- [ ] 5.3 等 daemon callback 進來（log 看到 /workflows/resume 命中）
|
||||
- [ ] 5.4 觀察 wiki page 真的寫進 KBDB（即使原 MCP call 已斷線）
|
||||
- [ ] 5.5 trace 含完整節點紀錄（paused → resumed）
|
||||
|
||||
---
|
||||
|
||||
## 風險追蹤
|
||||
|
||||
- 風險 1：daemon callback 進來時，cypher.arcrun.dev 還沒醒（CF Worker cold start）→ 第一次 retry 接住（daemon retry policy 涵蓋）
|
||||
- 風險 2：v1 沒 final_callback 給原 client → 用戶要主動查狀態
|
||||
- 接受：mira 河道 UI 可定期 refetch wiki page，或用既有 KBDB 觸發機制
|
||||
- v2 加 final_callback 統一處理
|
||||
|
||||
## v2 已記錄
|
||||
|
||||
- nested pending（一個 run 多個 paused 節點）
|
||||
- foreach 內 pending（item-level resume）
|
||||
- final_callback 給原 client（trigger 時帶 final_callback_url）
|
||||
- poll_task 零件（外部 API 沒 webhook 時用）
|
||||
Reference in New Issue
Block a user