Files
EasyFlow/easyflow-ui-admin/app/src/api/request.ts
陈子默 c7c301d3b9 fix: 统一工作流三个出口的错误反馈
- 关联 EASY-2,补齐安全错误、节点展示与执行标识

- 保留历史可读摘要并验证接口、SSE 与界面兼容
2026-09-08 10:49:02 +08:00

322 lines
8.7 KiB
TypeScript

import type { ServerSentEventMessage } from 'fetch-event-stream';
/**
* 该文件可自行根据业务逻辑进行调整
*/
import type { RequestClientOptions } from '@easyflow/request';
import { useAppConfig } from '@easyflow/hooks';
import { preferences } from '@easyflow/preferences';
import {
authenticateResponseInterceptor,
defaultResponseInterceptor,
errorMessageResponseInterceptor,
RequestClient,
} from '@easyflow/request';
import { useAccessStore } from '@easyflow/stores';
import { ElMessage } from 'element-plus';
import { events } from 'fetch-event-stream';
import { useAuthStore } from '#/store';
import {
isWorkflowShareRequest,
withWorkflowShareHeaders,
} from '#/utils/workflow-share-context';
import { refreshTokenApi } from './core';
import {
isInactiveSseRequest,
readSseRequestError,
SseRequestError,
} from './sseRequestLifecycle';
const { apiURL } = useAppConfig(import.meta.env, import.meta.env.PROD);
const ERROR_MESSAGE_DEDUP_WINDOW = 800;
const SILENT_ERROR_MESSAGES = new Set([
'当前连接不可用,请检查连接配置后重试',
'连接不存在',
]);
let lastErrorMessage = '';
let lastErrorTimestamp = 0;
function showErrorOnce(message?: string) {
const nextMessage = String(message || '').trim();
if (!nextMessage) return;
if (SILENT_ERROR_MESSAGES.has(nextMessage)) {
return;
}
const now = Date.now();
if (
nextMessage === lastErrorMessage &&
now - lastErrorTimestamp < ERROR_MESSAGE_DEDUP_WINDOW
) {
return;
}
lastErrorMessage = nextMessage;
lastErrorTimestamp = now;
ElMessage.error(nextMessage);
}
function createRequestClient(baseURL: string, options?: RequestClientOptions) {
const client = new RequestClient({
...options,
baseURL,
});
/**
* 重新认证逻辑
*/
async function doReAuthenticate() {
console.warn('Access token or refresh token is invalid or expired. ');
const accessStore = useAccessStore();
const authStore = useAuthStore();
accessStore.setAccessToken(null);
if (
preferences.app.loginExpiredMode === 'modal' &&
accessStore.isAccessChecked
) {
accessStore.setLoginExpired(true);
} else {
await authStore.logout();
}
}
/**
* 刷新token逻辑
*/
async function doRefreshToken() {
const accessStore = useAccessStore();
const resp = await refreshTokenApi();
const newToken = resp.data;
accessStore.setAccessToken(newToken);
return newToken;
}
function formatToken(token: null | string) {
return token ? `${token}` : null;
}
// 请求头处理
client.addRequestInterceptor({
fulfilled: async (config) => {
const accessStore = useAccessStore();
config.headers['easyflow-token'] = formatToken(accessStore.accessToken);
config.headers['Accept-Language'] = preferences.app.locale;
const workflowShareHeaders = withWorkflowShareHeaders(
{},
{
requestMethod: config.method,
requestUrl: config.url,
},
);
for (const [name, value] of Object.entries(workflowShareHeaders)) {
config.headers[name] = value;
}
return config;
},
});
// 处理返回的响应数据格式
client.addResponseInterceptor(
defaultResponseInterceptor({
codeField: 'errorCode',
dataField: 'data',
showErrorMessage: (message) => {
showErrorOnce(message);
},
successCode: 0,
}),
);
// token过期的处理
client.addResponseInterceptor(
authenticateResponseInterceptor({
client,
doReAuthenticate,
doRefreshToken,
enableRefreshToken: preferences.app.enableRefreshToken ?? false,
formatToken,
shouldHandleUnauthorized: (config) =>
!isWorkflowShareRequest(config?.url, config?.method),
}),
);
// 通用的错误处理,如果没有进入上面的错误处理逻辑,就会进入这里
client.addResponseInterceptor(
errorMessageResponseInterceptor((msg: string, error) => {
// 这里可以根据业务进行定制,你可以拿到 error 内的信息进行定制化处理,根据不同的 code 做不同的提示,而不是直接使用 message.error 提示 msg
// 当前mock接口返回的错误字段是 error 或者 message
const responseData = error?.response?.data ?? {};
const errorMessage = responseData?.error ?? responseData?.message ?? '';
// 如果没有错误信息,则会根据状态码进行提示
showErrorOnce(errorMessage || msg);
}),
);
return client;
}
export const requestClient = createRequestClient(apiURL, {
responseReturn: 'data',
});
export const api = createRequestClient(apiURL, {
responseReturn: 'body',
});
export const baseRequestClient = new RequestClient({ baseURL: apiURL });
export interface SseOptions {
headers?: HeadersInit;
onMessage?: (message: ServerSentEventMessage) => void;
onError?: (err: any) => void;
onFinished?: () => void;
}
export function resolveApiUrl(url: string) {
return apiURL + url;
}
export function createEventStreamHeaders(
requestUrl: string,
extraHeaders?: HeadersInit,
) {
const accessStore = useAccessStore();
const headers: Record<string, string> = {
Accept: 'text/event-stream',
'Content-Type': 'application/json',
'easyflow-token': accessStore.accessToken || '',
};
if (extraHeaders) {
new Headers(extraHeaders).forEach((value, key) => {
headers[key] = value;
});
}
return withWorkflowShareHeaders(headers, {
requestMethod: 'POST',
requestUrl,
});
}
export class SseClient {
private controller: AbortController | null = null;
private currentRequestId = 0;
abort(): void {
if (this.controller) {
this.controller.abort();
this.controller = null;
}
}
isActive(): boolean {
return this.controller !== null;
}
async post(url: string, data?: any, options?: SseOptions): Promise<void> {
// 生成唯一的请求ID
const requestId = ++this.currentRequestId;
const currentRequestId = requestId;
// 如果已有请求,先取消
this.abort();
// 创建新的控制器
const controller = new AbortController();
this.controller = controller;
// 保存信号的引用到局部变量
const signal = controller.signal;
try {
const res = await fetch(apiURL + url, {
method: 'POST',
signal, // 使用局部变量 signal
headers: this.getHeaders(url, options?.headers),
body: JSON.stringify(data),
});
if (!res.ok) {
const error = await readSseRequestError(res);
options?.onError?.(error);
return;
}
const contentType = res.headers.get('content-type') || '';
if (!contentType.includes('text/event-stream')) {
let errorMessage = '请求失败,请稍后再试';
try {
const body = await res.json();
errorMessage =
body?.error ?? body?.message ?? body?.data?.message ?? errorMessage;
} catch {
try {
const text = await res.text();
if (text.trim()) {
errorMessage = text.trim();
}
} catch {
// ignore body parse failures and keep fallback message
}
}
showErrorOnce(errorMessage);
options?.onError?.(new SseRequestError(res.status, errorMessage));
return;
}
// 在开始事件流之前检查是否还是同一个请求
if (this.currentRequestId !== currentRequestId) {
return;
}
const msgEvents = events(res, signal);
try {
for await (const event of msgEvents) {
// 每次迭代都检查是否还是同一个请求
if (this.currentRequestId !== currentRequestId) {
break;
}
options?.onMessage?.(event);
}
} catch (innerError) {
if (
isInactiveSseRequest(signal, this.currentRequestId, currentRequestId)
) {
return;
}
options?.onError?.(innerError);
return;
}
// 只有在还是同一个请求的情况下才调用 onFinished
if (
!isInactiveSseRequest(signal, this.currentRequestId, currentRequestId)
) {
options?.onFinished?.();
}
} catch (error) {
if (
isInactiveSseRequest(signal, this.currentRequestId, currentRequestId)
) {
return;
}
console.error('SSE错误:', error);
options?.onError?.(error);
} finally {
// 只有当还是当前请求时才清除 controller
if (this.currentRequestId === currentRequestId) {
this.controller = null;
}
}
}
private getHeaders(requestUrl: string, extraHeaders?: HeadersInit) {
return createEventStreamHeaders(requestUrl, extraHeaders);
}
}
export const sseClient = new SseClient();