98 lines
2.6 KiB
TypeScript
98 lines
2.6 KiB
TypeScript
/*
|
|
* Copyright 2025 coze-dev Authors
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { AxiosError, type AxiosResponse } from 'axios';
|
|
import { logger } from '@coze-arch/logger';
|
|
|
|
// Enumeration of reported events
|
|
export enum ReportEventNames {
|
|
NetworkError = 'flow-infra-network-error',
|
|
ApiError = 'flow-infra-api-error',
|
|
}
|
|
interface ApiErrorOptions {
|
|
hasShowedError?: boolean;
|
|
}
|
|
|
|
export class ApiError extends AxiosError {
|
|
hasShowedError: boolean;
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
public raw?: any;
|
|
type: string;
|
|
|
|
// eslint-disable-next-line max-params
|
|
constructor(
|
|
public code: string,
|
|
public msg: string | undefined,
|
|
response: AxiosResponse,
|
|
options: ApiErrorOptions = {},
|
|
) {
|
|
const { hasShowedError = false } = options;
|
|
|
|
super(msg, code, response.config, response.request, response);
|
|
this.name = 'ApiError';
|
|
this.type = 'Api Response Error';
|
|
this.hasShowedError = hasShowedError;
|
|
this.raw = response.data;
|
|
}
|
|
}
|
|
|
|
export const isApiError = (error: unknown): error is ApiError =>
|
|
error instanceof ApiError;
|
|
|
|
// Report http errors, apiError & axiosError
|
|
export const reportHttpError = (
|
|
eventName: ReportEventNames,
|
|
error: AxiosError,
|
|
) => {
|
|
try {
|
|
const { response, config } = error;
|
|
const {
|
|
code = '',
|
|
msg = '',
|
|
message,
|
|
} = response?.data as {
|
|
code?: string;
|
|
msg?: string;
|
|
message?: string;
|
|
};
|
|
const { status: httpStatusCode, headers } = response || {};
|
|
const { method: httpMethod, url: urlPath } = config || {};
|
|
const logId = headers?.['x-tt-logid'];
|
|
const customErrorCode = String(code);
|
|
const customErrorMsg = message ?? msg;
|
|
|
|
logger.persist.error({
|
|
eventName,
|
|
error,
|
|
meta: {
|
|
message: error.message,
|
|
name: error.name,
|
|
httpStatusCode: String(httpStatusCode),
|
|
httpMethod,
|
|
urlPath,
|
|
logId,
|
|
customErrorCode,
|
|
customErrorMsg,
|
|
},
|
|
});
|
|
} catch (e) {
|
|
logger.persist.error({
|
|
error: e as Error,
|
|
message: error.message,
|
|
});
|
|
}
|
|
};
|