shishengliang/lingniu-vehicle-ingest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(platform-web): include trace id in api errors

Browse Source
This commit is contained in:
lingniu
2026-07-04 00:52:42 +08:00
parent bbbf589d60
commit 081f8b5099
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
vehicle-data-platform/apps/web/src/api/client.test.ts
View File

@@ -38,7 +38,7 @@ test('rawFramesQuery posts structured JSON instead of URL query strings', async
}); });
}); });
test('api errors include backend message and detail', async () => { test('api errors include backend message, detail, and trace id', async () => {
vi.spyOn(globalThis, 'fetch').mockResolvedValue({ vi.spyOn(globalThis, 'fetch').mockResolvedValue({
ok: false, ok: false,
status: 500, status: 500,
@@ -53,5 +53,5 @@ test('api errors include backend message and detail', async () => {
}) })
} as Response); } as Response);
await expect(api.opsHealth()).rejects.toThrow('服务处理失败: TDengine timeout'); await expect(api.opsHealth()).rejects.toThrow('服务处理失败: TDengine timeout (traceId: trace-error)');
}); });

10
vehicle-data-platform/apps/web/src/api/client.ts
View File

@@ -34,6 +34,7 @@ type ApiErrorEnvelope = {
message?: string; message?: string;
detail?: string; detail?: string;
}; };
traceId?: string;
}; };
async function request<T>(path: string, init?: RequestInit): Promise<T> { async function request<T>(path: string, init?: RequestInit): Promise<T> {
@@ -50,11 +51,12 @@ async function responseErrorMessage(response: Response) {
const envelope = (await response.json()) as ApiErrorEnvelope; const envelope = (await response.json()) as ApiErrorEnvelope;
const message = envelope.error?.message?.trim(); const message = envelope.error?.message?.trim();
const detail = envelope.error?.detail?.trim(); const detail = envelope.error?.detail?.trim();
const traceID = envelope.traceId?.trim();
if (message && detail) { if (message && detail) {
return `${message}: ${detail}`; return withTraceID(`${message}: ${detail}`, traceID);
} }
if (message) { if (message) {
return message; return withTraceID(message, traceID);
} }
} catch { } catch {
// Fall back to status when the server does not return the platform envelope. // Fall back to status when the server does not return the platform envelope.
@@ -62,6 +64,10 @@ async function responseErrorMessage(response: Response) {
return `request failed ${response.status}`; return `request failed ${response.status}`;
} }
function withTraceID(message: string, traceID?: string) {
return traceID ? `${message} (traceId: ${traceID})` : message;
}
export const api = { export const api = {
dashboardSummary: () => request<DashboardSummary>('/api/dashboard/summary'), dashboardSummary: () => request<DashboardSummary>('/api/dashboard/summary'),
vehicles: (params = new URLSearchParams()) => request<Page<VehicleRow>>(`/api/vehicles?${params.toString()}`), vehicles: (params = new URLSearchParams()) => request<Page<VehicleRow>>(`/api/vehicles?${params.toString()}`),