From 7272c2da4daa883b93b2ad482b2965ffe00342be Mon Sep 17 00:00:00 2001
From: Piotr Gawron <p.gawron@atcomp.pl>
Date: Wed, 15 May 2024 12:33:13 +0200
Subject: [PATCH] stub of new error report data
---
src/utils/error-report/ErrorData.ts | 11 +++++++
src/utils/error-report/errorReporting.ts | 33 +++++++++++++++++++
src/utils/error-report/getError.ts | 26 +++++++++++++++
src/utils/error-report/getErrorCode.ts | 13 ++++++++
src/utils/error-report/getErrorName.ts | 12 +++++++
src/utils/error-report/getErrorStack.ts | 14 ++++++++
src/utils/error-report/getErrorUrl.ts | 12 +++++++
.../getErrorMessage.constants.ts | 1 +
8 files changed, 122 insertions(+)
create mode 100644 src/utils/error-report/ErrorData.ts
create mode 100644 src/utils/error-report/errorReporting.ts
create mode 100644 src/utils/error-report/getError.ts
create mode 100644 src/utils/error-report/getErrorCode.ts
create mode 100644 src/utils/error-report/getErrorName.ts
create mode 100644 src/utils/error-report/getErrorStack.ts
create mode 100644 src/utils/error-report/getErrorUrl.ts
diff --git a/src/utils/error-report/ErrorData.ts b/src/utils/error-report/ErrorData.ts
new file mode 100644
index 00000000..ba1abdde
--- /dev/null
+++ b/src/utils/error-report/ErrorData.ts
@@ -0,0 +1,11 @@
+export type ErrorData = {
+ url: string | null;
+ login: string | null;
+ email: string | null;
+ browser: string | null;
+ timestamp: string | null;
+ version: string | null;
+ comment: string | null;
+ stacktrace: string;
+ javaStacktrace: string | null;
+};
diff --git a/src/utils/error-report/errorReporting.ts b/src/utils/error-report/errorReporting.ts
new file mode 100644
index 00000000..909c0ba2
--- /dev/null
+++ b/src/utils/error-report/errorReporting.ts
@@ -0,0 +1,33 @@
+/* eslint-disable no-console */
+import { ErrorData } from '@/utils/error-report/ErrorData';
+import { SerializedError } from '@reduxjs/toolkit';
+
+export const handleError = (error: Error | SerializedError | undefined): void => {
+ let stacktrace = '';
+ if (error !== undefined) {
+ stacktrace = error.stack !== undefined ? error.stack : '';
+ }
+
+ const errorData: ErrorData = {
+ url: null, // TODO
+ login: null, // TODO provide user login
+ browser: null, // TODO
+ comment: null,
+ email: null, // TODO
+ javaStacktrace: null, // TODO
+ stacktrace,
+ timestamp: null, // TODO
+ version: null, // TODO
+ };
+ // eslint-disable-next-line no-console
+ console.log(errorData);
+};
+
+export const initializeErrorReporting = (): void => {
+ if (typeof window !== 'undefined') {
+ window.onerror = (msg, url, lineNo, columnNo, error): boolean => {
+ handleError(error);
+ return true;
+ };
+ }
+};
diff --git a/src/utils/error-report/getError.ts b/src/utils/error-report/getError.ts
new file mode 100644
index 00000000..b1da4181
--- /dev/null
+++ b/src/utils/error-report/getError.ts
@@ -0,0 +1,26 @@
+import { getErrorMessage } from '@/utils/getErrorMessage';
+import { SerializedError } from '@reduxjs/toolkit';
+import { getErrorName } from '@/utils/error-report/getErrorName';
+import { getErrorCode } from '@/utils/error-report/getErrorCode';
+import { getErrorStack } from '@/utils/error-report/getErrorStack';
+
+type GetErrorMessageConfig = {
+ error: unknown;
+ message?: string;
+ prefix?: string;
+};
+
+export const getError = ({ error, message, prefix }: GetErrorMessageConfig): SerializedError => {
+ const errorMessage = getErrorMessage({ error, message, prefix });
+
+ const name = getErrorName(error);
+ const stack = getErrorStack(error);
+ const code = getErrorCode(error);
+
+ return {
+ name,
+ message: errorMessage,
+ stack,
+ code,
+ };
+};
diff --git a/src/utils/error-report/getErrorCode.ts b/src/utils/error-report/getErrorCode.ts
new file mode 100644
index 00000000..30f63f62
--- /dev/null
+++ b/src/utils/error-report/getErrorCode.ts
@@ -0,0 +1,13 @@
+import axios from 'axios';
+import {
+ UNKNOWN_AXIOS_ERROR_CODE,
+ UNKNOWN_ERROR,
+} from '../getErrorMessage/getErrorMessage.constants';
+
+export const getErrorCode = (error: unknown): string => {
+ if (axios.isAxiosError(error)) {
+ const { code } = error;
+ return code || UNKNOWN_AXIOS_ERROR_CODE;
+ }
+ return UNKNOWN_ERROR;
+};
diff --git a/src/utils/error-report/getErrorName.ts b/src/utils/error-report/getErrorName.ts
new file mode 100644
index 00000000..163a0d86
--- /dev/null
+++ b/src/utils/error-report/getErrorName.ts
@@ -0,0 +1,12 @@
+import axios from 'axios';
+import { UNKNOWN_ERROR } from '../getErrorMessage/getErrorMessage.constants';
+
+export const getErrorName = (error: unknown): string => {
+ if (axios.isAxiosError(error)) {
+ return error.name;
+ }
+ if (error instanceof Error) {
+ return error.name;
+ }
+ return UNKNOWN_ERROR;
+};
diff --git a/src/utils/error-report/getErrorStack.ts b/src/utils/error-report/getErrorStack.ts
new file mode 100644
index 00000000..e148696f
--- /dev/null
+++ b/src/utils/error-report/getErrorStack.ts
@@ -0,0 +1,14 @@
+import axios from 'axios';
+import { getErrorUrl } from '@/utils/error-report/getErrorUrl';
+
+export const getErrorStack = (error: unknown): string => {
+ let stack = null;
+ if (axios.isAxiosError(error)) {
+ const url = getErrorUrl(error);
+
+ stack = (url ? `(Request URL: ${url}) ` : '') + error.stack;
+ } else if (error instanceof Error) {
+ stack = error.stack;
+ }
+ return stack || 'No stack provided';
+};
diff --git a/src/utils/error-report/getErrorUrl.ts b/src/utils/error-report/getErrorUrl.ts
new file mode 100644
index 00000000..53ef46e9
--- /dev/null
+++ b/src/utils/error-report/getErrorUrl.ts
@@ -0,0 +1,12 @@
+import axios from 'axios';
+
+export const getErrorUrl = (error: unknown): string | null => {
+ if (axios.isAxiosError(error)) {
+ if (error.request) {
+ if (error.request.responseURL) {
+ return error.request.responseURL;
+ }
+ }
+ }
+ return null;
+};
diff --git a/src/utils/getErrorMessage/getErrorMessage.constants.ts b/src/utils/getErrorMessage/getErrorMessage.constants.ts
index 00b84d70..d3cba2ab 100644
--- a/src/utils/getErrorMessage/getErrorMessage.constants.ts
+++ b/src/utils/getErrorMessage/getErrorMessage.constants.ts
@@ -1,4 +1,5 @@
export const UNKNOWN_ERROR = 'An unknown error occurred. Please try again later.';
+export const UNKNOWN_AXIOS_ERROR_CODE = 'UNKNOWN_AXIOS_ERROR';
export const HTTP_ERROR_MESSAGES = {
400: "The server couldn't understand your request. Please check your input and try again.",
--
GitLab