w-dispatch-ai 1.0.21 → 1.0.22

package/test/tools/fakeServerForApiTest.mjs

@@ -7,7 +7,11 @@ import http from 'http'
 // 故起一個本機http伺服器, 依請求之model與Authorization決定回應行為,
 // 即可對成功/401/429/500/逾時/畸形回應逐條斷言, 而無須真的呼叫外部API。
 //
-// 【行為路由(依body.model)】
+// 【路由】POST /v1/chat/completions 與 POST /v1/responses 兩種端點,
+//   回應形狀依端點而異(Responses API無choices, 改為output陣列且usage欄位名不同),
+//   對應dispatchApiOpenaiCompat與dispatchApiOpenaiResponses。
+//
+// 【chat/completions之行為路由(依body.model)】
 //   echo           — 200, content為JSON字串{ auth, body }, 供斷言請求組成
 //   empty-content  — 200, content為空字串(驗證路徑用)
 //   slow           — 延遲10秒才回應(逾時路徑用)
@@ -17,6 +21,17 @@ import http from 'http'
 //   not-json       — 200但本體非JSON(畸形回應路徑用)
 //   tool-calls     — 200但finish_reason為tool_calls(工具不支援路徑用)
 //   其他           — 404
+// 【responses之行為路由(依body.model)】
+//   echo           — 200, message之output_text為JSON字串{ auth, body }
+//   multi-message  — 200, 多個message元素(驗證依序串接、reasoning項被略過)
+//   empty-content  — 200但output_text為空字串
+//   incomplete     — 200但status為incomplete(reason: max_output_tokens, output為空)
+//   failed         — 200但status為failed(帶error.message)
+//   reasoning-only — 200且completed但output僅reasoning無message(結構不合規)
+//   tool-calls     — 200但output含function_call元素
+//   no-output      — 200但缺output陣列
+//   not-json/slow/err-500/flaky-429 — 同chat/completions之對應行為
+//   其他           — 401(同Zen實測: 未知model回401非404)
 // 【金鑰規則】Authorization含'sk-bad'一律401(優先於model路由), 模擬無效金鑰。
 
 
@@ -35,8 +50,9 @@ async function fakeServerForApiTest() {
 
     let server = http.createServer((req, res) => {
 
-        //僅受理POST /v1/chat/completions
-        if (req.method !== 'POST' || !req.url.endsWith('/chat/completions')) {
+        //僅受理POST /v1/chat/completions與POST /v1/responses
+        let isResponses = req.url.endsWith('/responses')
+        if (req.method !== 'POST' || (!req.url.endsWith('/chat/completions') && !isResponses)) {
             res.writeHead(404, { 'Content-Type': 'application/json' })
             res.end(JSON.stringify({ error: { message: 'not found' } }))
             return
@@ -67,6 +83,95 @@ async function fakeServerForApiTest() {
             }
 
             let model = body.model || ''
+
+            //Responses API路由(/responses): 形狀與chat/completions完全不同, 見dispatchApiOpenaiResponses檔頭
+            if (isResponses) {
+                let send = (code, obj) => {
+                    res.writeHead(code, { 'Content-Type': 'application/json' })
+                    res.end(JSON.stringify(obj))
+                }
+                //usage欄位名為input_tokens/output_tokens(與chat/completions不同), 供斷言原樣透傳
+                let usage = { input_tokens: 5, output_tokens: 11, total_tokens: 16 }
+                let okResp = (text) => send(200, {
+                    id: 'resp_x',
+                    object: 'response',
+                    status: 'completed',
+                    model,
+                    error: null,
+                    incomplete_details: null,
+                    output: [
+                        { id: 'rs_1', type: 'reasoning', status: 'completed', content: [] }, //思考項應被略過
+                        { id: 'msg_1', type: 'message', status: 'completed', content: [{ type: 'output_text', text }] },
+                    ],
+                    usage,
+                })
+                if (model === 'echo') {
+                    okResp(JSON.stringify({ auth, body }))
+                }
+                else if (model === 'multi-message') { //多個message元素應依序串接
+                    send(200, {
+                        status: 'completed',
+                        model,
+                        error: null,
+                        incomplete_details: null,
+                        output: [
+                            { type: 'message', content: [{ type: 'output_text', text: 'AA' }] },
+                            { type: 'reasoning', content: [] },
+                            { type: 'message', content: [{ type: 'output_text', text: 'BB' }] },
+                        ],
+                        usage,
+                    })
+                }
+                else if (model === 'empty-content') {
+                    okResp('')
+                }
+                else if (model === 'incomplete') { //max_output_tokens耗盡, output為空
+                    send(200, { status: 'incomplete', model, error: null, incomplete_details: { reason: 'max_output_tokens' }, output: [], usage })
+                }
+                else if (model === 'failed') {
+                    send(200, { status: 'failed', model, error: { code: 'server_error', message: 'upstream blew up' }, incomplete_details: null, output: [], usage })
+                }
+                else if (model === 'reasoning-only') { //僅思考無message, 屬結構不合規
+                    send(200, { status: 'completed', model, error: null, incomplete_details: null, output: [{ type: 'reasoning', content: [] }], usage })
+                }
+                else if (model === 'tool-calls') {
+                    send(200, {
+                        status: 'completed',
+                        model,
+                        error: null,
+                        incomplete_details: null,
+                        output: [{ type: 'function_call', name: 'get_weather', arguments: '{"city":"台北"}', call_id: 'call-1' }],
+                        usage,
+                    })
+                }
+                else if (model === 'no-output') { //缺output陣列
+                    send(200, { status: 'completed', model, id: 'resp_y' })
+                }
+                else if (model === 'not-json') {
+                    res.writeHead(200, { 'Content-Type': 'text/plain' })
+                    res.end('plain text body')
+                }
+                else if (model === 'slow') {
+                    setTimeout(() => okResp('too late'), 10000)
+                }
+                else if (model === 'err-500') {
+                    send(500, { error: { message: 'internal error' } })
+                }
+                else if (model === 'flaky-429') {
+                    flakyCount[auth] = (flakyCount[auth] || 0) + 1
+                    if (flakyCount[auth] === 1) {
+                        send(429, { error: { message: 'rate limited' } })
+                    }
+                    else {
+                        okResp(JSON.stringify({ attempt: flakyCount[auth] }))
+                    }
+                }
+                else {
+                    send(401, { type: 'error', error: { type: 'ModelError', message: `Model ${model} is not supported` } }) //同Zen實測: 未知model回401非404
+                }
+                return
+            }
+
             let ok = (content) => {
                 res.writeHead(200, { 'Content-Type': 'application/json' })
                 res.end(JSON.stringify({

package/test/unit-WDispatchAi.test.mjs

@@ -10,6 +10,7 @@ import dispatchClaude from '../src/dispatchClaude.mjs'
 import dispatchCodex from '../src/dispatchCodex.mjs'
 import dispatchAntigravity from '../src/dispatchAntigravity.mjs'
 import dispatchApiOpenaiCompat from '../src/dispatchApiOpenaiCompat.mjs'
+import dispatchApiOpenaiResponses from '../src/dispatchApiOpenaiResponses.mjs'
 import providers from '../src/providers.mjs'
 import resolveProviders from '../src/resolveProviders.mjs'
 
@@ -29,6 +30,7 @@ describe('WDispatchAi', function() {
             'dispatchCodex',
             'dispatchAntigravity',
             'dispatchApiOpenaiCompat',
+            'dispatchApiOpenaiResponses',
             'providers',
             'resolveProviders',
             'readEnvFile',
@@ -42,13 +44,13 @@ describe('WDispatchAi', function() {
 
     it('KINDS為可用之供應商種類字串陣列', function() {
         let r = wi.KINDS
-        let rr = ['opencode', 'claude', 'codex', 'antigravity', 'api-openai-compat']
+        let rr = ['opencode', 'claude', 'codex', 'antigravity', 'api-openai-compat', 'api-openai-responses']
         assert.strict.deepEqual(r, rr)
     })
 
     it('各鍵值型別正確(KINDS與providers為物件, NO_SIDE_EFFECT為字串, 其餘為函數)', function() {
         let r = map(keys(wi), (k) => typeof wi[k])
-        let rr = ['object', 'string', 'function', 'function', 'function', 'function', 'function', 'function', 'function', 'function', 'object', 'function', 'function', 'function', 'function', 'function', 'function']
+        let rr = ['object', 'string', 'function', 'function', 'function', 'function', 'function', 'function', 'function', 'function', 'function', 'object', 'function', 'function', 'function', 'function', 'function', 'function']
         assert.strict.deepEqual(r, rr)
     })
 
@@ -62,10 +64,11 @@ describe('WDispatchAi', function() {
             wi.dispatchCodex === dispatchCodex,
             wi.dispatchAntigravity === dispatchAntigravity,
             wi.dispatchApiOpenaiCompat === dispatchApiOpenaiCompat,
+            wi.dispatchApiOpenaiResponses === dispatchApiOpenaiResponses,
             wi.providers === providers,
             wi.resolveProviders === resolveProviders,
         ]
-        let rr = [true, true, true, true, true, true, true, true, true, true]
+        let rr = [true, true, true, true, true, true, true, true, true, true, true]
         assert.strict.deepEqual(r, rr)
     })
 
@@ -75,20 +78,20 @@ describe('WDispatchAi', function() {
             let t = await wi.dispatchAi(kind, '')
             r.push(t.error)
         }
-        let rr = ['prompt must be a non-empty string', 'prompt must be a non-empty string', 'prompt must be a non-empty string', 'prompt must be a non-empty string', 'prompt must be a non-empty string']
+        let rr = ['prompt must be a non-empty string', 'prompt must be a non-empty string', 'prompt must be a non-empty string', 'prompt must be a non-empty string', 'prompt must be a non-empty string', 'prompt must be a non-empty string']
         assert.strict.deepEqual(r, rr)
     })
 
     it('可由WDispatchAi呼叫dispatchAi', async function() {
         let t = await wi.dispatchAi('gemini', 'abc')
         let r = [t.ok, t.error]
-        let rr = [false, 'unknown ai kind: "gemini" (available: opencode, claude, codex, antigravity, api-openai-compat)']
+        let rr = [false, 'unknown ai kind: "gemini" (available: opencode, claude, codex, antigravity, api-openai-compat, api-openai-responses)']
         assert.strict.deepEqual(r, rr)
     })
 
     it('可由WDispatchAi呼叫各轉接器', async function() {
         let r = []
-        for (let fn of [wi.dispatchOpencode, wi.dispatchClaude, wi.dispatchCodex, wi.dispatchAntigravity, wi.dispatchApiOpenaiCompat]) {
+        for (let fn of [wi.dispatchOpencode, wi.dispatchClaude, wi.dispatchCodex, wi.dispatchAntigravity, wi.dispatchApiOpenaiCompat, wi.dispatchApiOpenaiResponses]) {
             let t = await fn('')
             r.push([t.ok, t.error])
         }
@@ -98,6 +101,7 @@ describe('WDispatchAi', function() {
             [false, 'prompt must be a non-empty string'],
             [false, 'prompt must be a non-empty string'],
             [false, 'prompt must be a non-empty string'],
+            [false, 'prompt must be a non-empty string'],
         ]
         assert.strict.deepEqual(r, rr)
     })

package/test/unit-adapters.test.mjs

@@ -7,19 +7,20 @@ import dispatchClaude from '../src/dispatchClaude.mjs'
 import dispatchCodex from '../src/dispatchCodex.mjs'
 import dispatchAntigravity from '../src/dispatchAntigravity.mjs'
 import dispatchApiOpenaiCompat from '../src/dispatchApiOpenaiCompat.mjs'
+import dispatchApiOpenaiResponses from '../src/dispatchApiOpenaiResponses.mjs'
 
 
 describe('adapters', function() {
 
     it('對照表鍵名即為可用之供應商種類', function() {
         let r = keys(adapters)
-        let rr = ['opencode', 'claude', 'codex', 'antigravity', 'api-openai-compat']
+        let rr = ['opencode', 'claude', 'codex', 'antigravity', 'api-openai-compat', 'api-openai-responses']
         assert.strict.deepEqual(r, rr)
     })
 
     it('各鍵值皆為函數', function() {
         let r = map(keys(adapters), (k) => typeof adapters[k])
-        let rr = ['function', 'function', 'function', 'function', 'function']
+        let rr = ['function', 'function', 'function', 'function', 'function', 'function']
         assert.strict.deepEqual(r, rr)
     })
 
@@ -30,8 +31,9 @@ describe('adapters', function() {
             adapters.codex === dispatchCodex,
             adapters.antigravity === dispatchAntigravity,
             adapters['api-openai-compat'] === dispatchApiOpenaiCompat,
+            adapters['api-openai-responses'] === dispatchApiOpenaiResponses,
         ]
-        let rr = [true, true, true, true, true]
+        let rr = [true, true, true, true, true, true]
         assert.strict.deepEqual(r, rr)
     })
 

package/test/unit-dispatchAi.test.mjs

@@ -20,7 +20,7 @@ describe('dispatchAi', function() {
     it('未知kind時回傳錯誤結果物件且不reject', async function() {
         let t = await dispatchAi('gemini', 'abc')
         let r = [t.ok, t.error, t.attempts]
-        let rr = [false, 'unknown ai kind: "gemini" (available: opencode, claude, codex, antigravity, api-openai-compat)', 0]
+        let rr = [false, 'unknown ai kind: "gemini" (available: opencode, claude, codex, antigravity, api-openai-compat, api-openai-responses)', 0]
         assert.strict.deepEqual(r, rr)
     })
 

package/test/unit-dispatchApiOpenaiResponses.test.mjs

@@ -0,0 +1,198 @@
+import assert from 'assert'
+import dispatchApiOpenaiResponses, { extractOutputText } from '../src/dispatchApiOpenaiResponses.mjs'
+import dispatchAi from '../src/dispatchAi.mjs'
+import dispatchAiFallback from '../src/dispatchAiFallback.mjs'
+import dispatchAiWkf from '../src/dispatchAiWkf.mjs'
+import fakeServerForApiTest from './tools/fakeServerForApiTest.mjs'
+
+
+describe('dispatchApiOpenaiResponses', function() {
+
+    let svr = null
+
+    before(async function() {
+        svr = await fakeServerForApiTest()
+    })
+
+    after(async function() {
+        if (svr) {
+            await svr.close()
+        }
+    })
+
+    it('extractOutputText只取message型之output_text, 略過reasoning且多段依序串接', function() {
+        let r = [
+            extractOutputText([
+                { type: 'reasoning', content: [] },
+                { type: 'message', content: [{ type: 'output_text', text: '完成' }] },
+            ]),
+            extractOutputText([
+                { type: 'message', content: [{ type: 'output_text', text: 'AA' }] },
+                { type: 'reasoning', content: [] },
+                { type: 'message', content: [{ type: 'output_text', text: 'BB' }] },
+            ]),
+            extractOutputText([{ type: 'reasoning', content: [] }]), //僅思考
+            extractOutputText(null),
+            extractOutputText([]),
+        ]
+        let rr = ['完成', 'AABB', '', '', '']
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('prompt/baseURL/model之必填檢核, 回傳錯誤結果物件且不reject', async function() {
+        let t1 = await dispatchApiOpenaiResponses('')
+        let t2 = await dispatchApiOpenaiResponses('abc', { model: 'echo' })
+        let t3 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url })
+        let r = [[t1.ok, t1.error], [t2.ok, t2.error], [t3.ok, t3.error, t3.errorType]]
+        let rr = [
+            [false, 'prompt must be a non-empty string'],
+            [false, 'baseURL must be a non-empty string'],
+            [false, 'model must be a non-empty string', 'params'],
+        ]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('請求打/responses端點, prompt置於input、system置於instructions', async function() {
+        let t = await dispatchApiOpenaiResponses('中文prompt\n第二行', {
+            baseURL: svr.url, key: 'sk-good-1', model: 'echo', system: '你是審計者', body: { max_output_tokens: 2048 },
+        })
+        let o = JSON.parse(t.stdout)
+        let r = [t.ok, t.code, t.attempts, o.auth, o.body.model, o.body.input, o.body.instructions, o.body.max_output_tokens, o.body.messages]
+        let rr = [true, 200, 1, 'Bearer sk-good-1', 'echo', '中文prompt\n第二行', '你是審計者', 2048, undefined]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('baseURL尾端斜線正規化, 未給key時不帶Authorization標頭', async function() {
+        let t = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url + '///', model: 'echo' })
+        let o = JSON.parse(t.stdout)
+        let r = [t.ok, t.code, o.auth]
+        let rr = [true, 200, '']
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('多個message元素依序串接為stdout', async function() {
+        let t = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'multi-message' })
+        let r = [t.ok, t.stdout]
+        let rr = [true, 'AABB']
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('status非completed一律失敗不回半截內容: incomplete與failed', async function() {
+        let t1 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'incomplete' })
+        let t2 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'failed' })
+        let r = [
+            [t1.ok, t1.errorType, t1.error],
+            [t2.ok, t2.errorType, t2.error],
+        ]
+        let rr = [
+            [false, 'incomplete', 'INCOMPLETE_RESPONSE: status=incomplete (max_output_tokens)'],
+            [false, 'incomplete', 'INCOMPLETE_RESPONSE: status=failed (upstream blew up)'],
+        ]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('結構不合規之回應: 缺output陣列、非JSON、僅reasoning無message', async function() {
+        let t1 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'no-output' })
+        let t2 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'not-json' })
+        let t3 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'reasoning-only' })
+        let r = [
+            [t1.ok, t1.errorType, t1.error],
+            [t2.ok, t2.errorType],
+            [t3.ok, t3.errorType, t3.error],
+        ]
+        let rr = [
+            [false, 'invalid-response', 'INVALID_RESPONSE: missing output array'],
+            [false, 'invalid-response'],
+            [false, 'invalid-response', 'INVALID_RESPONSE: no output_text in output messages'],
+        ]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('output含function_call時以TOOL_CALLS_UNSUPPORTED回報而不假裝成功', async function() {
+        let t = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'tool-calls' })
+        let r = [t.ok, t.errorType, t.error.indexOf('TOOL_CALLS_UNSUPPORTED') === 0, t.stdout]
+        let rr = [false, 'tool-unsupported', true, '']
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('validate未過為OUTPUT_VALIDATION_FAILED(令遞補層可統一分流)', async function() {
+        let t1 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'echo', validate: 'min:100000' })
+        let t2 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'empty-content', validate: 'nonempty' })
+        let r = [
+            [t1.ok, t1.error, t1.errorType, t1.stdout.length > 0],
+            [t2.ok, t2.errorType], //空內容於取值階段即判invalid-response
+        ]
+        let rr = [
+            [false, 'OUTPUT_VALIDATION_FAILED', 'validation', true],
+            [false, 'invalid-response'],
+        ]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('壞金鑰與未知model皆401(同Zen實測), 4xx不重試', async function() {
+        let t1 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-bad', model: 'echo', maxRetries: 3 })
+        let t2 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'no-such-model', maxRetries: 3 })
+        let r = [
+            [t1.ok, t1.code, t1.errorType, t1.attempts, t1.stderr.includes('AuthError')],
+            [t2.ok, t2.code, t2.attempts, t2.stderr.includes('is not supported')],
+        ]
+        let rr = [
+            [false, 401, 'http', 1, true],
+            [false, 401, 1, true],
+        ]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('429與5xx依maxRetries重試, 逾時error以TIMEOUT開頭', async function() {
+        let t1 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-retry', model: 'flaky-429', maxRetries: 2, retryDelayMs: 10 })
+        let t2 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'slow', timeoutMs: 500 })
+        let r = [
+            [t1.ok, t1.attempts, JSON.parse(t1.stdout).attempt],
+            [t2.ok, t2.code, t2.errorType, t2.error.indexOf('TIMEOUT') === 0],
+        ]
+        let rr = [
+            [true, 2, 2],
+            [false, null, 'timeout', true],
+        ]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('usage原樣透傳(欄位名為input_tokens/output_tokens, 與chat/completions不同)', async function() {
+        let t1 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'echo' })
+        let t2 = await dispatchApiOpenaiResponses('abc', { baseURL: svr.url, key: 'sk-good-1', model: 'incomplete' })
+        let r = [t1.usage, t2.usage] //失敗結果亦帶出已耗token
+        let rr = [
+            { input_tokens: 5, output_tokens: 11, total_tokens: 16 },
+            { input_tokens: 5, output_tokens: 11, total_tokens: 16 },
+        ]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('可作為dispatchAi之kind與dispatchAiFallback之條目', async function() {
+        let t1 = await dispatchAi('api-openai-responses', 'abc', { baseURL: svr.url, key: 'sk-good-1', model: 'echo' })
+        //遞補: responses型條目失敗(未知model→401)後換chat/completions型條目成功, 兩kind混用於同一鏈
+        let t2 = await dispatchAiFallback('abc', {
+            providers: [
+                { id: 'r-bad', kind: 'api-openai-responses', baseURL: svr.url, model: 'no-such-model', keys: ['sk-good-a'] },
+                { id: 'c-ok', kind: 'api-openai-compat', baseURL: svr.url, model: 'echo', keys: ['sk-good-b'] },
+            ],
+        })
+        let r = [t1.ok, JSON.parse(t1.stdout).body.model, t2.ok, t2.providerId, t2.tried.map((x) => [x.providerId, x.outcome])]
+        let rr = [true, 'echo', true, 'c-ok', [['r-bad', 'next-key'], ['c-ok', 'ok']]]
+        assert.strict.deepEqual(r, rr)
+    })
+
+    it('可作為工作流provider, 回覆經解析與檢核', async function() {
+        let wkf = dispatchAiWkf({
+            providers: {
+                'resp-echo': { kind: 'api-openai-responses', baseURL: svr.url, model: 'echo', keys: ['sk-good-w'] },
+            },
+            defaults: { promptPrefix: '' },
+        })
+        let t = await wkf.callAi('abc', { spec: { use: 'resp-echo' }, check: (j) => j.body.model === 'echo' })
+        let r = [t.ok, t.providerId, t.keyId, t.json.auth, t.json.body.input, t.usage.total_tokens]
+        let rr = [true, 'resp-echo', 'resp-echo#0', 'Bearer sk-good-w', 'abc', 16]
+        assert.strict.deepEqual(r, rr)
+    })
+
+})