WMS_MAIN/app/controller/openapiCallback.js
liufumingren d725e7e457 feat(openapi): 出站回调命名与报文改奇门同层级
- 回调 method 由 snake_case 事件名改为 模块.动作:entryorder.confirm / entryorder.match / deliveryorder.confirm / stockout.confirm / deliveryorder.cancel(原 order.cancel 与入站方法同名,改名避免 callback_url 误指向 /openapi 时被路由到取消单据接口)。

- 时间戳统一为秒级(String(Math.floor(Date.now()/1000))),与 /openapi 入站 ±600 秒时效校验及回调调试页一致。

- 报文体由 { event, data, metadata } 改为奇门同层级 { request: {...} }(移除 metadata,事件标识只靠 query 的 method);入库类回调与奇门侧共用同一份报文组装。

- deliveryorder.confirm 改为逐单发送(仅同步成功的订单);stockout.confirm 直接复用 buildStockoutConfirmDataInternal 结果。

- 修复 entryorder.match 死代码:绑定成功且本次新建绑定时回传,重复触发不重复通知,回传失败不影响绑定。

- 调试页 /docs/api/openapi/callback-test 按真实报文预填;新增出站回调文档页 /docs/api/openapi_callback 及入口链接。

- script/update-api-doc.cjs 支持 spec.newDoc 新建文档与 docMeta.description(附单测)。

- 文档:methods/openapi_callback.json、AI_METHOD_ROUTING.md 5.6 节、docs/openapi-callback-events.md、docs/api-doc-update-workflow.md 等。
2026-09-13 02:24:37 +08:00

283 lines
13 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
const { Controller } = require('egg');
const { CALLBACK_EVENTS } = require('../service/openapi/callbackRegistry');
/**
* OpenAPI 回调测试控制器。
* 提供独立的回调调试页面,用于模拟回调推送并查看响应结果。
*/
class OpenapiCallbackController extends Controller {
/**
* 渲染回调测试页面。
* 页面支持选择已注册的回调事件,选中后自动填充与真实回调完全一致的
* 完整报文体 { request: {...} }(奇门同层级,可编辑)、填入测试 URL 和密钥,
* 前端计算 MD5 签名后 POST 到目标 URL 并展示完整请求/响应。
*/
async testPage() {
const { ctx } = this;
const eventsJson = JSON.stringify(CALLBACK_EVENTS);
ctx.type = 'text/html; charset=utf-8';
ctx.body = `<!doctype html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>OpenAPI 回调测试</title>
<style>
* { box-sizing: border-box; }
body { font-family: "Segoe UI","PingFang SC","Microsoft YaHei",sans-serif; background: #f4f6fb; color: #1f2a44; margin: 0; padding: 24px; }
.container { max-width: 720px; margin: 0 auto; }
h1 { font-size: 22px; margin: 0 0 8px; }
.card { background: #fff; border: 1px solid #dbe1ee; border-radius: 12px; padding: 20px; margin-bottom: 16px; box-shadow: 0 4px 16px rgba(18,48,102,0.06); }
label { display: block; font-weight: 600; margin: 12px 0 4px; color: #254974; font-size: 13px; }
select, input, textarea { width: 100%; border: 1px solid #b5ccec; border-radius: 8px; padding: 8px 10px; font-size: 13px; font-family: inherit; }
textarea { font-family: ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace; resize: vertical; }
.row { display: grid; grid-template-columns: 1fr 1fr; gap: 12px; }
.send-btn { border: 1px solid #0f5cb2; background: #1565c0; color: #fff; border-radius: 8px; padding: 10px 20px; cursor: pointer; font-size: 14px; margin-top: 12px; }
.send-btn:disabled { opacity: 0.6; cursor: not-allowed; }
pre { background: #0d1d33; color: #d8e7ff; border-radius: 8px; padding: 12px; font-size: 12px; overflow: auto; max-height: 400px; white-space: pre-wrap; word-break: break-all; margin: 12px 0 0; }
.muted { color: #62708a; font-size: 12px; }
.desc { color: #62708a; font-size: 13px; }
</style>
</head>
<body>
<div class="container">
<div class="card">
<h1>OpenAPI 回调测试</h1>
<p class="desc">选择已注册的回调事件,自动填充与真实回调完全一致的完整报文体(奇门同层级 { request },可编辑),填入测试 URL 模拟推送。</p>
<p style="margin-top:6px;font-size:13px;">
<a href="/docs/api/openapi" style="color:#1565c0;">← 返回 API 文档</a>
&nbsp;|&nbsp;
<a href="/docs/api/openapi_callback" style="color:#1565c0;">→ 出站回调文档</a>
</p>
</div>
<div class="card">
<label>回调事件</label>
<select id="eventSelect">
<option value="">请选择事件</option>
</select>
<p id="eventDesc" class="muted"></p>
<div class="row">
<div>
<label>app_key</label>
<input id="appKeyInput" type="text" placeholder="APP2024011514301234" />
</div>
<div>
<label>self_app_secret</label>
<input id="secretInput" type="password" placeholder="密钥" />
</div>
</div>
<label>测试回调 URL</label>
<input id="callbackUrlInput" type="text" placeholder="https://your-system.com/api/callback" />
<label>完整报文体(奇门同层级 { request },与真实回调一致,可编辑)</label>
<textarea id="dataInput" rows="8" placeholder='{"request":{}}'></textarea>
<button id="sendBtn" class="send-btn" onclick="sendTest()">发送测试回调</button>
<pre id="resultBox">点击发送后显示响应</pre>
</div>
</div>
<script>
var EVENTS = ${eventsJson};
var eventSelect = document.getElementById('eventSelect');
var eventDesc = document.getElementById('eventDesc');
var dataInput = document.getElementById('dataInput');
var resultBox = document.getElementById('resultBox');
// 填充下拉列表
EVENTS.forEach(function(ev) {
var opt = document.createElement('option');
opt.value = ev.name;
opt.textContent = ev.label + ' (' + ev.name + ')';
eventSelect.appendChild(opt);
});
eventSelect.addEventListener('change', function() {
var name = eventSelect.value;
var found = EVENTS.find(function(e) { return e.name === name; });
if (found) {
eventDesc.textContent = found.description;
dataInput.value = JSON.stringify({
request: found.request || {},
}, null, 2);
} else {
eventDesc.textContent = '';
dataInput.value = '{}';
}
});
function nowTimestamp() { return Math.floor(Date.now() / 1000); }
function md5(value) {
// 使用与 docs.js 一致的 md5 实现(修复后版本)
function add32(a,b){return(a+b)&0xFFFFFFFF}
function cmn(q,a,b,x,s,t){a=add32(add32(a,q),add32(x,t));return add32((a<<s)|(a>>>32-s),b)}
function ff(a,b,c,d,x,s,t){return cmn((b&c)|((~b)&d),a,b,x,s,t)}
function gg(a,b,c,d,x,s,t){return cmn((b&d)|(c&(~d)),a,b,x,s,t)}
function hh(a,b,c,d,x,s,t){return cmn(b^c^d,a,b,x,s,t)}
function ii(a,b,c,d,x,s,t){return cmn(c^(b|(~d)),a,b,x,s,t)}
var originalLength = value.length;
var str = value;
var m = [];
var i = 0;
while (str.length >= 64) {
m = [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0];
for (var j = 0; j < 64; j++) m[j>>2] |= str.charCodeAt(j) << ((j%4)*8);
var block = m;
var a0=1732584193,b0=-271733879,c0=-1732584194,d0=271733878;
var a=a0,b=b0,c=c0,d=d0;
a=ff(a,b,c,d,block[0],7,-680876936);d=ff(d,a,b,c,block[1],12,-389564586);
c=ff(c,d,a,b,block[2],17,606105819);b=ff(b,c,d,a,block[3],22,-1044525330);
a=ff(a,b,c,d,block[4],7,-176418897);d=ff(d,a,b,c,block[5],12,1200080426);
c=ff(c,d,a,b,block[6],17,-1473231341);b=ff(b,c,d,a,block[7],22,-45705983);
a=ff(a,b,c,d,block[8],7,1770035416);d=ff(d,a,b,c,block[9],12,-1958414417);
c=ff(c,d,a,b,block[10],17,-42063);b=ff(b,c,d,a,block[11],22,-1990404162);
a=ff(a,b,c,d,block[12],7,1804603682);d=ff(d,a,b,c,block[13],12,-40341101);
c=ff(c,d,a,b,block[14],17,-1502002290);b=ff(b,c,d,a,block[15],22,1236535329);
a=gg(a,b,c,d,block[1],5,-165796510);d=gg(d,a,b,c,block[6],9,-1069501632);
c=gg(c,d,a,b,block[11],14,643717713);b=gg(b,c,d,a,block[0],20,-373897302);
a=gg(a,b,c,d,block[5],5,-701558691);d=gg(d,a,b,c,block[10],9,38016083);
c=gg(c,d,a,b,block[15],14,-660478335);b=gg(b,c,d,a,block[4],20,-405537848);
a=gg(a,b,c,d,block[9],5,568446438);d=gg(d,a,b,c,block[14],9,-1019803690);
c=gg(c,d,a,b,block[3],14,-187363961);b=gg(b,c,d,a,block[8],20,1163531501);
a=gg(a,b,c,d,block[13],5,-1444681467);d=gg(d,a,b,c,block[2],9,-51403784);
c=gg(c,d,a,b,block[7],14,1735328473);b=gg(b,c,d,a,block[12],20,-1926607734);
a=hh(a,b,c,d,block[5],4,-378558);d=hh(d,a,b,c,block[8],11,-2022574463);
c=hh(c,d,a,b,block[11],16,1839030562);b=hh(b,c,d,a,block[14],23,-35309556);
a=hh(a,b,c,d,block[1],4,-1530992060);d=hh(d,a,b,c,block[4],11,1272893353);
c=hh(c,d,a,b,block[7],16,-155497632);b=hh(b,c,d,a,block[10],23,-1094730640);
a=hh(a,b,c,d,block[13],4,681279174);d=hh(d,a,b,c,block[0],11,-358537222);
c=hh(c,d,a,b,block[3],16,-722521979);b=hh(b,c,d,a,block[6],23,76029189);
a=hh(a,b,c,d,block[9],4,-640364487);d=hh(d,a,b,c,block[12],11,-421815835);
c=hh(c,d,a,b,block[15],16,530742520);b=hh(b,c,d,a,block[2],23,-995338651);
a=ii(a,b,c,d,block[0],6,-198630844);d=ii(d,a,b,c,block[7],10,1126891415);
c=ii(c,d,a,b,block[14],15,-1416354905);b=ii(b,c,d,a,block[5],21,-57434055);
a=ii(a,b,c,d,block[12],6,1700485571);d=ii(d,a,b,c,block[3],10,-1894986606);
c=ii(c,d,a,b,block[10],15,-1051523);b=ii(b,c,d,a,block[1],21,-2054922799);
a=ii(a,b,c,d,block[8],6,1873313359);d=ii(d,a,b,c,block[15],10,-30611744);
c=ii(c,d,a,b,block[6],15,-1560198380);b=ii(b,c,d,a,block[13],21,1309151649);
a=ii(a,b,c,d,block[4],6,-145523070);d=ii(d,a,b,c,block[11],10,-1120210379);
c=ii(c,d,a,b,block[2],15,718787259);b=ii(b,c,d,a,block[9],21,-343485551);
a0=add32(a0,a);b0=add32(b0,b);c0=add32(c0,c);d0=add32(d0,d);
str = str.substring(64);
}
var tail = [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0];
for (i = 0; i < str.length; i++) tail[i>>2] |= str.charCodeAt(i) << ((i%4)*8);
tail[i>>2] |= 0x80 << ((i%4)*8);
tail[14] = originalLength * 8; // 修复:使用原始长度
a0=ff(a0,b0,c0,d0,tail[0],7,-680876936);d0=ff(d0,a0,b0,c0,tail[1],12,-389564586);
c0=ff(c0,d0,a0,b0,tail[2],17,606105819);b0=ff(b0,c0,d0,a0,tail[3],22,-1044525330);
a0=ff(a0,b0,c0,d0,tail[4],7,-176418897);d0=ff(d0,a0,b0,c0,tail[5],12,1200080426);
c0=ff(c0,d0,a0,b0,tail[6],17,-1473231341);b0=ff(b0,c0,d0,a0,tail[7],22,-45705983);
a0=ff(a0,b0,c0,d0,tail[8],7,1770035416);d0=ff(d0,a0,b0,c0,tail[9],12,-1958414417);
c0=ff(c0,d0,a0,b0,tail[10],17,-42063);b0=ff(b0,c0,d0,a0,tail[11],22,-1990404162);
a0=ff(a0,b0,c0,d0,tail[12],7,1804603682);d0=ff(d0,a0,b0,c0,tail[13],12,-40341101);
c0=ff(c0,d0,a0,b0,tail[14],17,-1502002290);b0=ff(b0,c0,d0,a0,tail[15],22,1236535329);
function toHex(num) {
var s = ''; for (var k = 0; k < 4; k++) s += ('0' + ((num>>>(k*8))&0xFF).toString(16)).slice(-2);
return s;
}
return (toHex(a0)+toHex(b0)+toHex(c0)+toHex(d0)).toLowerCase();
}
function stableStringify(value) {
if (value === undefined) return '';
if (value === null || typeof value !== 'object') return JSON.stringify(value);
if (Array.isArray(value)) {
var items = value.map(function(v) { return stableStringify(v); });
return '[' + items.join(',') + ']';
}
if (Object.prototype.toString.call(value) !== '[object Object]') return JSON.stringify(value);
var keys = Object.keys(value).sort();
var fields = keys.map(function(k) { return JSON.stringify(k) + ':' + stableStringify(value[k]); });
return '{' + fields.join(',') + '}';
}
function computeSign(query, body, secret) {
// 排除 sign/signature,按 key 字母序排序
var ignoreKeys = ['sign', 'signature'];
var sortedKeys = Object.keys(query).filter(function(k) {
return ignoreKeys.indexOf(k.toLowerCase()) === -1 && query[k] !== undefined;
}).sort();
var canonicalQuery = sortedKeys.map(function(k) {
return k + '=' + String(query[k] == null ? '' : typeof query[k] === 'object' ? stableStringify(query[k]) : query[k]);
}).join('&');
var bodySign = md5(stableStringify(body));
var signText = canonicalQuery + secret + bodySign;
return md5(signText);
}
async function sendTest() {
var appKey = document.getElementById('appKeyInput').value.trim();
var secret = document.getElementById('secretInput').value.trim();
var callbackUrl = document.getElementById('callbackUrlInput').value.trim();
var eventName = eventSelect.value;
var dataText = dataInput.value.trim();
var sendBtn = document.getElementById('sendBtn');
if (!eventName) { resultBox.textContent = '请选择回调事件'; return; }
if (!appKey) { resultBox.textContent = '请输入 app_key'; return; }
if (!secret) { resultBox.textContent = '请输入 self_app_secret'; return; }
if (!callbackUrl) { resultBox.textContent = '请输入测试回调 URL'; return; }
sendBtn.disabled = true;
sendBtn.textContent = '发送中...';
resultBox.textContent = '请求中...';
try {
var body = JSON.parse(dataText);
var ts = nowTimestamp();
var query = { method: eventName, v: '1.0', timestamp: ts, app_key: appKey };
var sign = computeSign(query, body, secret);
var reqUrl = callbackUrl + (callbackUrl.indexOf('?') >= 0 ? '&' : '?') +
'method=' + encodeURIComponent(eventName) +
'&v=1.0' +
'&timestamp=' + ts +
'&app_key=' + encodeURIComponent(appKey) +
'&sign=' + sign;
resultBox.textContent = \`POST \${reqUrl}\n\n\${JSON.stringify(body, null, 2)}\n\n请求中...\`;
var resp = await fetch(reqUrl, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(body),
});
var respText = await resp.text();
var respInfo = \`HTTP \${resp.status} \${resp.statusText}\n\n\`;
try {
var respJson = JSON.parse(respText);
respInfo += JSON.stringify(respJson, null, 2);
} catch(e) {
respInfo += respText;
}
resultBox.textContent = \`POST \${reqUrl}\n\n\${JSON.stringify(body, null, 2)}\n\n--- 响应 ---\n\${respInfo}\`;
} catch(e) {
resultBox.textContent = '请求失败: ' + e.message;
} finally {
sendBtn.disabled = false;
sendBtn.textContent = '发送测试回调';
}
}
</script>
</body>
</html>`;
}
}
module.exports = OpenapiCallbackController;