Skip to content

The open alternative to Salesforce, designed for AI.

Show the app error fallback for errors React Router catches (#28747)

Charles Bochetc3645223830a
diff --git a/packages/twenty-front/src/modules/app/components/RootApp.tsx b/packages/twenty-front/src/modules/app/components/RootApp.tsx
index af893e9a66d..721f1ca482d 100644
--- a/packages/twenty-front/src/modules/app/components/RootApp.tsx
+++ b/packages/twenty-front/src/modules/app/components/RootApp.tsx
@@ -2,13 +2,18 @@ import { RouterProvider } from 'react-router-dom';
import { AppNavigatorProvider } from '@/app/components/AppNavigatorProvider';
import { useCreateRootAppRouter } from '@/app/hooks/useCreateRootAppRouter';
+import { handleRouterError } from '@/error-handler/utils/handleRouterError';
export const RootApp = () => {
const router = useCreateRootAppRouter();
return (
<AppNavigatorProvider router={router}>
- <RouterProvider router={router} useTransitions={false} />
+ <RouterProvider
+ router={router}
+ useTransitions={false}
+ onError={handleRouterError}
+ />
</AppNavigatorProvider>
);
};
diff --git a/packages/twenty-front/src/modules/app/components/WorkspaceApp.tsx b/packages/twenty-front/src/modules/app/components/WorkspaceApp.tsx
index c1b53d8126d..781199751cb 100644
--- a/packages/twenty-front/src/modules/app/components/WorkspaceApp.tsx
+++ b/packages/twenty-front/src/modules/app/components/WorkspaceApp.tsx
@@ -4,6 +4,7 @@ import { AppNavigatorProvider } from '@/app/components/AppNavigatorProvider';
import { useCreateWorkspaceAppRouter } from '@/app/hooks/useCreateWorkspaceAppRouter';
import { currentUserState } from '@/auth/states/currentUserState';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { handleRouterError } from '@/error-handler/utils/handleRouterError';
export const WorkspaceApp = () => {
const currentUser = useAtomStateValue(currentUserState);
@@ -16,7 +17,11 @@ export const WorkspaceApp = () => {
return (
<AppNavigatorProvider router={router}>
- <RouterProvider useTransitions={false} router={router} />
+ <RouterProvider
+ useTransitions={false}
+ router={router}
+ onError={handleRouterError}
+ />
</AppNavigatorProvider>
);
};
diff --git a/packages/twenty-front/src/modules/app/hooks/useCreateRootAppRouter.tsx b/packages/twenty-front/src/modules/app/hooks/useCreateRootAppRouter.tsx
index 72d81f922b2..549a4bca9ef 100644
--- a/packages/twenty-front/src/modules/app/hooks/useCreateRootAppRouter.tsx
+++ b/packages/twenty-front/src/modules/app/hooks/useCreateRootAppRouter.tsx
@@ -10,6 +10,7 @@ import { LazyRoute } from '@/app/components/LazyRoute';
import { RootAppProviders } from '@/app/components/RootAppProviders';
import { RootDeepLinkRedirect } from '@/app/components/RootDeepLinkRedirect';
import { VerifyEmail } from '@/auth/components/VerifyEmail';
+import { AppRouteErrorFallback } from '@/error-handler/components/AppRouteErrorFallback';
import { OnboardingPageLoader } from '@/onboarding/components/OnboardingPageLoader';
import { OnboardingTransitionOutlet } from '@/onboarding/components/OnboardingTransitionOutlet';
import { AuthFlowLayout } from '@/ui/layout/page/components/AuthFlowLayout';
@@ -30,7 +31,11 @@ const PasswordReset = lazy(() =>
const createRootAppRouter = () =>
createBrowserRouter(
createRoutesFromElements(
- <Route element={<RootAppProviders />} loader={async () => null}>
+ <Route
+ element={<RootAppProviders />}
+ errorElement={<AppRouteErrorFallback />}
+ loader={async () => null}
+ >
<Route element={<BlankLayout />}>
<Route element={<OnboardingTransitionOutlet />}>
<Route
diff --git a/packages/twenty-front/src/modules/app/hooks/useCreateWorkspaceAppRouter.tsx b/packages/twenty-front/src/modules/app/hooks/useCreateWorkspaceAppRouter.tsx
index cf6ec4c97e0..304dbc8223d 100644
--- a/packages/twenty-front/src/modules/app/hooks/useCreateWorkspaceAppRouter.tsx
+++ b/packages/twenty-front/src/modules/app/hooks/useCreateWorkspaceAppRouter.tsx
@@ -9,6 +9,7 @@ import { WorkspaceRouteObjectsProvider } from '@/app/routing/components/Workspac
import { createWorkspaceRouteObjects } from '@/app/routing/utils/createWorkspaceRouteObjects';
import { getWorkspaceRouteObjectsForSurface } from '@/app/routing/utils/getWorkspaceRouteObjectsForSurface';
import { VerifyEmail } from '@/auth/components/VerifyEmail';
+import { AppRouteErrorFallback } from '@/error-handler/components/AppRouteErrorFallback';
import { MinimalMetadataGate } from '@/metadata-store/components/MinimalMetadataGate';
import { OnboardingActivationOutlet } from '@/onboarding/components/OnboardingActivationOutlet';
import { OnboardingPageLoader } from '@/onboarding/components/OnboardingPageLoader';
@@ -109,6 +110,7 @@ const createWorkspaceAppRouter = ({
element: (
<WorkspaceRouteObjectsProvider routeObjects={workspaceRouteObjects} />
),
+ errorElement: <AppRouteErrorFallback />,
children: [
{
element: <WorkspaceAppProviders />,
diff --git a/packages/twenty-front/src/modules/error-handler/components/AppErrorBoundary.tsx b/packages/twenty-front/src/modules/error-handler/components/AppErrorBoundary.tsx
index 3c0295ebce5..aa03db0793a 100644
--- a/packages/twenty-front/src/modules/error-handler/components/AppErrorBoundary.tsx
+++ b/packages/twenty-front/src/modules/error-handler/components/AppErrorBoundary.tsx
@@ -1,111 +1,20 @@
-import type * as SentryReact from '@sentry/react';
-
import { AppErrorBoundaryEffect } from '@/error-handler/components/internal/AppErrorBoundaryEffect';
-import { checkIfItsAViteStaleChunkLazyLoadingError } from '@/error-handler/utils/checkIfItsAViteStaleChunkLazyLoadingError';
-import { isStaleChunkReloadCooldownActive } from '@/error-handler/utils/isStaleChunkReloadCooldownActive';
-import { storeStaleChunkReloadTimestamp } from '@/error-handler/utils/storeStaleChunkReloadTimestamp';
-import { type ErrorInfo, type ReactNode } from 'react';
+import { handleAppError } from '@/error-handler/utils/handleAppError';
+import { type ReactNode } from 'react';
import { ErrorBoundary, type FallbackProps } from 'react-error-boundary';
-import { type CustomError, isDefined } from 'twenty-shared/utils';
import { reloadWindow } from '~/utils/reloadWindow';
-const SENTRY_IMPORT_TIMEOUT_BEFORE_RELOAD_MS = 2_000;
-const SENTRY_FLUSH_TIMEOUT_BEFORE_RELOAD_MS = 2_000;
-
type AppErrorBoundaryProps = {
children: ReactNode;
FallbackComponent: React.ComponentType<FallbackProps>;
resetOnLocationChange?: boolean;
};
-const hasErrorCode = (
- error: Error | CustomError,
-): error is CustomError & { code: string } => {
- return 'code' in error && isDefined(error.code);
-};
-
-const captureAppError = (
- sentryImportPromise: Promise<typeof SentryReact>,
- error: Error | CustomError,
- info: ErrorInfo,
-) =>
- sentryImportPromise
- .then(({ captureException, flush }) => {
- captureException(error, (scope) => {
- scope.setExtras({ info });
-
- const fingerprint = hasErrorCode(error) ? error.code : error.message;
- scope.setFingerprint([fingerprint]);
- error.name = error.message;
- return scope;
- });
-
- return flush(SENTRY_FLUSH_TIMEOUT_BEFORE_RELOAD_MS);
- })
- .catch((sentryError) => {
- // oxlint-disable-next-line no-console
- console.error('Failed to capture exception with Sentry:', sentryError);
- });
-
export const AppErrorBoundary = ({
children,
FallbackComponent,
resetOnLocationChange = true,
}: AppErrorBoundaryProps) => {
- const handleError = (error: Error | CustomError, info: ErrorInfo) => {
- const sentryImportPromise = import('@sentry/react');
- const captureAppErrorPromise = captureAppError(
- sentryImportPromise,
- error,
- info,
- );
-
- const isViteStaleChunkLazyLoadingError =
- checkIfItsAViteStaleChunkLazyLoadingError(error);
-
- const shouldAttemptStaleChunkReload =
- isViteStaleChunkLazyLoadingError && !isStaleChunkReloadCooldownActive();
-
- if (!shouldAttemptStaleChunkReload) {
- return;
- }
-
- const isReloadTimestampStored = storeStaleChunkReloadTimestamp();
-
- if (!isReloadTimestampStored) {
- return;
- }
-
- const reloadAfterSentryCapture = async () => {
- const sentryImportTimeoutPromise = new Promise<boolean>((resolve) =>
- setTimeout(
- () => resolve(false),
- SENTRY_IMPORT_TIMEOUT_BEFORE_RELOAD_MS,
- ),
- );
-
- const isSentryImportSettled = await Promise.race([
- sentryImportPromise.then(
- () => true,
- () => true,
- ),
- sentryImportTimeoutPromise,
- ]);
-
- if (isSentryImportSettled) {
- const sentryFlushTimeoutPromise = new Promise<void>((resolve) =>
- setTimeout(resolve, SENTRY_FLUSH_TIMEOUT_BEFORE_RELOAD_MS),
- );
-
- await Promise.race([captureAppErrorPromise, sentryFlushTimeoutPromise]);
- }
-
- reloadWindow();
- };
-
- void reloadAfterSentryCapture();
- };
-
const handleReset = () => {
reloadWindow();
};
@@ -123,7 +32,7 @@ export const AppErrorBoundary = ({
/>
</>
)}
- onError={handleError}
+ onError={(error, errorInfo) => handleAppError({ error, errorInfo })}
onReset={handleReset}
>
{children}
diff --git a/packages/twenty-front/src/modules/error-handler/components/AppRouteErrorFallback.tsx b/packages/twenty-front/src/modules/error-handler/components/AppRouteErrorFallback.tsx
new file mode 100644
index 00000000000..82bf612fd42
--- /dev/null
+++ b/packages/twenty-front/src/modules/error-handler/components/AppRouteErrorFallback.tsx
@@ -0,0 +1,16 @@
+import { useRouteError } from 'react-router-dom';
+
+import { AppRootErrorFallback } from '@/error-handler/components/AppRootErrorFallback';
+import { convertUnknownToError } from '@/error-handler/utils/convertUnknownToError';
+import { reloadWindow } from '~/utils/reloadWindow';
+
+export const AppRouteErrorFallback = () => {
+ const routeError = useRouteError();
+
+ return (
+ <AppRootErrorFallback
+ error={convertUnknownToError(routeError)}
+ resetErrorBoundary={reloadWindow}
+ />
+ );
+};
diff --git a/packages/twenty-front/src/modules/error-handler/components/__stories__/AppRouteErrorFallback.stories.tsx b/packages/twenty-front/src/modules/error-handler/components/__stories__/AppRouteErrorFallback.stories.tsx
new file mode 100644
index 00000000000..995a3cdba6b
--- /dev/null
+++ b/packages/twenty-front/src/modules/error-handler/components/__stories__/AppRouteErrorFallback.stories.tsx
@@ -0,0 +1,46 @@
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import { useState } from 'react';
+import { createMemoryRouter, RouterProvider } from 'react-router-dom';
+import { expect, within } from 'storybook/test';
+
+import { AppRouteErrorFallback } from '@/error-handler/components/AppRouteErrorFallback';
+
+const ThrowingRoute = (): never => {
+ throw new Error('Target object metadata item not found');
+};
+
+const RouterWithThrowingRoute = () => {
+ const [router] = useState(() =>
+ createMemoryRouter([
+ {
+ path: '/',
+ element: <ThrowingRoute />,
+ errorElement: <AppRouteErrorFallback />,
+ },
+ ]),
+ );
+
+ return <RouterProvider router={router} />;
+};
+
+const meta: Meta<typeof RouterWithThrowingRoute> = {
+ title: 'Modules/ErrorHandler/AppRouteErrorFallback',
+ component: RouterWithThrowingRoute,
+};
+
+export default meta;
+
+type Story = StoryObj<typeof RouterWithThrowingRoute>;
+
+export const RouteRenderError: Story = {
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement);
+
+ await expect(
+ await canvas.findByText('Sorry, something went wrong'),
+ ).toBeVisible();
+ await expect(
+ canvas.queryByText('Unexpected Application Error!'),
+ ).not.toBeInTheDocument();
+ },
+};
diff --git a/packages/twenty-front/src/modules/error-handler/utils/convertUnknownToError.ts b/packages/twenty-front/src/modules/error-handler/utils/convertUnknownToError.ts
new file mode 100644
index 00000000000..ed0e0ebd67d
--- /dev/null
+++ b/packages/twenty-front/src/modules/error-handler/utils/convertUnknownToError.ts
@@ -0,0 +1,2 @@
+export const convertUnknownToError = (value: unknown): Error =>
+ value instanceof Error ? value : new Error(String(value));
diff --git a/packages/twenty-front/src/modules/error-handler/utils/handleAppError.ts b/packages/twenty-front/src/modules/error-handler/utils/handleAppError.ts
new file mode 100644
index 00000000000..31be390ccb1
--- /dev/null
+++ b/packages/twenty-front/src/modules/error-handler/utils/handleAppError.ts
@@ -0,0 +1,101 @@
+import type * as SentryReact from '@sentry/react';
+
+import { checkIfItsAViteStaleChunkLazyLoadingError } from '@/error-handler/utils/checkIfItsAViteStaleChunkLazyLoadingError';
+import { isStaleChunkReloadCooldownActive } from '@/error-handler/utils/isStaleChunkReloadCooldownActive';
+import { storeStaleChunkReloadTimestamp } from '@/error-handler/utils/storeStaleChunkReloadTimestamp';
+import { type ErrorInfo } from 'react';
+import { type CustomError, isDefined } from 'twenty-shared/utils';
+import { reloadWindow } from '~/utils/reloadWindow';
+
+const SENTRY_IMPORT_TIMEOUT_BEFORE_RELOAD_MS = 2_000;
+const SENTRY_FLUSH_TIMEOUT_BEFORE_RELOAD_MS = 2_000;
+
+const hasErrorCode = (
+ error: Error | CustomError,
+): error is CustomError & { code: string } => {
+ return 'code' in error && isDefined(error.code);
+};
+
+const captureAppError = ({
+ sentryImportPromise,
+ error,
+ errorInfo,
+}: {
+ sentryImportPromise: Promise<typeof SentryReact>;
+ error: Error | CustomError;
+ errorInfo?: ErrorInfo;
+}) =>
+ sentryImportPromise
+ .then(({ captureException, flush }) => {
+ captureException(error, (scope) => {
+ scope.setExtras({ info: errorInfo });
+
+ const fingerprint = hasErrorCode(error) ? error.code : error.message;
+ scope.setFingerprint([fingerprint]);
+ error.name = error.message;
+ return scope;
+ });
+
+ return flush(SENTRY_FLUSH_TIMEOUT_BEFORE_RELOAD_MS);
+ })
+ .catch((sentryError) => {
+ // oxlint-disable-next-line no-console
+ console.error('Failed to capture exception with Sentry:', sentryError);
+ });
+
+export const handleAppError = ({
+ error,
+ errorInfo,
+}: {
+ error: Error | CustomError;
+ errorInfo?: ErrorInfo;
+}) => {
+ const sentryImportPromise = import('@sentry/react');
+ const captureAppErrorPromise = captureAppError({
+ sentryImportPromise,
+ error,
+ errorInfo,
+ });
+
+ const isViteStaleChunkLazyLoadingError =
+ checkIfItsAViteStaleChunkLazyLoadingError(error);
+
+ const shouldAttemptStaleChunkReload =
+ isViteStaleChunkLazyLoadingError && !isStaleChunkReloadCooldownActive();
+
+ if (!shouldAttemptStaleChunkReload) {
+ return;
+ }
+
+ const isReloadTimestampStored = storeStaleChunkReloadTimestamp();
+
+ if (!isReloadTimestampStored) {
+ return;
+ }
+
+ const reloadAfterSentryCapture = async () => {
+ const sentryImportTimeoutPromise = new Promise<boolean>((resolve) =>
+ setTimeout(() => resolve(false), SENTRY_IMPORT_TIMEOUT_BEFORE_RELOAD_MS),
+ );
+
+ const isSentryImportSettled = await Promise.race([
+ sentryImportPromise.then(
+ () => true,
+ () => true,
+ ),
+ sentryImportTimeoutPromise,
+ ]);
+
+ if (isSentryImportSettled) {
+ const sentryFlushTimeoutPromise = new Promise<void>((resolve) =>
+ setTimeout(resolve, SENTRY_FLUSH_TIMEOUT_BEFORE_RELOAD_MS),
+ );
+
+ await Promise.race([captureAppErrorPromise, sentryFlushTimeoutPromise]);
+ }
+
+ reloadWindow();
+ };
+
+ void reloadAfterSentryCapture();
+};
diff --git a/packages/twenty-front/src/modules/error-handler/utils/handleRouterError.ts b/packages/twenty-front/src/modules/error-handler/utils/handleRouterError.ts
new file mode 100644
index 00000000000..b175362f5e6
--- /dev/null
+++ b/packages/twenty-front/src/modules/error-handler/utils/handleRouterError.ts
@@ -0,0 +1,11 @@
+import { type ClientOnErrorFunction } from 'react-router-dom';
+
+import { convertUnknownToError } from '@/error-handler/utils/convertUnknownToError';
+import { handleAppError } from '@/error-handler/utils/handleAppError';
+
+export const handleRouterError: ClientOnErrorFunction = (
+ error,
+ { errorInfo },
+) => {
+ handleAppError({ error: convertUnknownToError(error), errorInfo });
+};