feat: 接通后台渲染异常上报与响应契约校验
This commit is contained in:
1 parent
330d67adc1
commit
adcaa12970
22 files changed
+845
-33
No files matched your search
@@ -1,6 +1,14 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { test } from "node:test";
|
||||
import { ApiClient, ApiClientError, type FetchResponse } from "../src/index.js";
|
||||
import {
|
||||
ApiClient,
|
||||
ApiClientContractError,
|
||||
ApiClientError,
|
||||
assertResponseContract,
|
||||
type FetchResponse,
|
||||
} from "../src/index.js";
|
||||
import { adminTrustContentListSchema } from "../src/schemas/admin-collections.js";
|
||||
import { z } from "zod";
|
||||
|
||||
function response(body: unknown, status = 200): FetchResponse {
|
||||
return { status, ok: status >= 200 && status < 300, json: async () => body };
|
||||
@@ -14,7 +22,7 @@ test("客户端发送认证头、查询参数和 JSON 请求体", async () => {
|
||||
token: "token-1",
|
||||
fetcher: async (url, init) => {
|
||||
calls.push({ url, init });
|
||||
return response({ count: 2 });
|
||||
return response(url.includes("/admin/bookings?") ? [] : { count: 2 });
|
||||
},
|
||||
});
|
||||
await client.listAdminBookings({ status: "received", unreadOnly: true, tagId: "tag/1" });
|
||||
@@ -303,3 +311,112 @@ test("模板运营失败指标客户端发送查询窗口", async () => {
|
||||
{ url: "http://api.test/admin/template-operations/failures?days=14", method: "GET" },
|
||||
]);
|
||||
});
|
||||
|
||||
test("响应契约通过时保留原始数据,包含 schema 未声明的字段", async () => {
|
||||
const body = [
|
||||
{
|
||||
id: "trust-1",
|
||||
type: "credential",
|
||||
title: "从业十年",
|
||||
content: "长期服务本地客户",
|
||||
sortOrder: 0,
|
||||
isPublished: true,
|
||||
summary: null,
|
||||
coverUrl: null,
|
||||
config: { sections: [] },
|
||||
futureField: "保留",
|
||||
},
|
||||
];
|
||||
const client = new ApiClient({
|
||||
baseUrl: "http://api.test",
|
||||
fetcher: async () => response(body),
|
||||
});
|
||||
const result = await client.listAdminTrustContent();
|
||||
assert.deepEqual(result, body);
|
||||
});
|
||||
|
||||
test("响应契约不匹配时抛出带接口路径的 ApiClientContractError", async () => {
|
||||
const client = new ApiClient({
|
||||
baseUrl: "http://api.test",
|
||||
fetcher: async () => response([null]),
|
||||
});
|
||||
await assert.rejects(
|
||||
() => client.listAdminTrustContent(),
|
||||
(error: unknown) => {
|
||||
assert.ok(error instanceof ApiClientContractError);
|
||||
assert.equal(error.path, "/admin/config/trust-content");
|
||||
assert.match(error.message, /\/admin\/config\/trust-content/);
|
||||
assert.ok(error.issues.length > 0);
|
||||
return true;
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
test("契约校验只接受对象数组且拒绝缺少关键字段的记录", () => {
|
||||
assert.throws(
|
||||
() =>
|
||||
assertResponseContract(
|
||||
z.array(z.object({ id: z.string() })),
|
||||
[{ id: "ok" }, { id: 1 }],
|
||||
"/admin/example",
|
||||
),
|
||||
(error: unknown) => {
|
||||
assert.ok(error instanceof ApiClientContractError);
|
||||
assert.match(error.issues[0] ?? "", /^1\.id:/);
|
||||
return true;
|
||||
},
|
||||
);
|
||||
assert.doesNotThrow(() =>
|
||||
assertResponseContract(adminTrustContentListSchema, [], "/admin/config/trust-content"),
|
||||
);
|
||||
});
|
||||
|
||||
test("错误响应仍抛 ApiClientError,而不是契约错误", async () => {
|
||||
const client = new ApiClient({
|
||||
baseUrl: "http://api.test",
|
||||
fetcher: async () =>
|
||||
response(
|
||||
{ data: null, error: { code: "HTTP_500", message: "服务异常" }, requestId: "req-2" },
|
||||
500,
|
||||
),
|
||||
});
|
||||
await assert.rejects(
|
||||
() => client.listAdminTrustContent(),
|
||||
(error: unknown) => {
|
||||
assert.ok(error instanceof ApiClientError);
|
||||
assert.equal(error instanceof ApiClientContractError, false);
|
||||
return true;
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
test("后台渲染异常上报提交白名单字段", async () => {
|
||||
const calls: Array<{ url: string; method?: string; body?: string }> = [];
|
||||
const client = new ApiClient({
|
||||
baseUrl: "http://api.test",
|
||||
token: "brand-token",
|
||||
fetcher: async (url, init) => {
|
||||
calls.push({ url, method: init?.method, body: init?.body });
|
||||
return response({ received: true, duplicate: false });
|
||||
},
|
||||
});
|
||||
const receipt = await client.reportAdminClientError({
|
||||
errorId: "admin-abc-123",
|
||||
message: "boom",
|
||||
route: "/admin/trust?tab=1",
|
||||
componentStack: "at TrustContentPage",
|
||||
});
|
||||
assert.deepEqual(receipt, { received: true, duplicate: false });
|
||||
assert.deepEqual(calls, [
|
||||
{
|
||||
url: "http://api.test/admin/client-errors",
|
||||
method: "POST",
|
||||
body: JSON.stringify({
|
||||
errorId: "admin-abc-123",
|
||||
message: "boom",
|
||||
route: "/admin/trust?tab=1",
|
||||
componentStack: "at TrustContentPage",
|
||||
}),
|
||||
},
|
||||
]);
|
||||
});
|
||||
Reference in new issue
Block a user