feat: error boundary (#109)

* feat: error boundary work in progress, requires graasp/graasp-ui#756 * chore(deps): graasp-ui to 4.10.0
graasp · Mar 15, 2024 · 9459809 · 9459809
1 parent 73dcd87
commit 9459809
Show file tree

Hide file tree

Showing 6 changed files with 206 additions and 165 deletions.
diff --git a/package.json b/package.json
@@ -4,7 +4,8 @@
   "license": "AGPL-3.0-only",
   "author": "Graasp",
   "contributors": [
-    "Basile Spaenlehauer"
+    "Basile Spaenlehauer",
+    "Jérémy La Scala"
   ],
   "homepage": ".",
   "type": "module",
@@ -13,7 +14,7 @@
     "@emotion/styled": "11.11.0",
     "@graasp/apps-query-client": "3.4.8",
     "@graasp/sdk": "4.1.0",
-    "@graasp/ui": "4.9.3",
+    "@graasp/ui": "4.10.0",
     "@mui/icons-material": "5.15.12",
     "@mui/lab": "5.0.0-alpha.167",
     "@mui/material": "5.15.12",

diff --git a/src/langs/en.json b/src/langs/en.json
@@ -1,5 +1,20 @@
 {
   "translations": {
-    "Welcome to the Graasp App Starter Kit": "Welcome to the Graasp App Starter Kit"
+    "Welcome to the Graasp App Starter Kit": "Welcome to the Graasp App Starter Kit",
+    "ERROR_BOUNDARY": {
+      "FALLBACK": {
+        "MESSAGE_TITLE": "Sorry, something went wrong with this application",
+        "MESSAGE_FEEDBACK": "Our team has been notified. If you would like to help, please, tell us what happened below.",
+        "ERROR_DETAILS": "Details of the error",
+        "NAME_LABEL": "Name",
+        "NAME_HELPER": "Provide your name (optional)",
+        "EMAIL_LABEL": "Email",
+        "EMAIL_HELPER": "Provide your email (optional)",
+        "COMMENT_LABEL": "Comment",
+        "COMMENT_HELPER": "Tell us what happened (optional)",
+        "THANKS_FOR_FEEDBACK": "Thank you for your feedback!",
+        "SEND": "Send your feedback"
+      }
+    }
   }
 }
diff --git a/src/modules/ErrorBoundary.tsx b/src/modules/ErrorBoundary.tsx
@@ -0,0 +1,40 @@
+import { FC, ReactNode } from 'react';
+import { useTranslation } from 'react-i18next';
+
+import { ErrorFallback } from '@graasp/ui/apps';
+
+import * as Sentry from '@sentry/react';
+
+const ErrorBoundary: FC<{ children?: ReactNode }> = ({ children }) => {
+  const { t: tFallback } = useTranslation('translations', {
+    keyPrefix: 'ERROR_BOUNDARY.FALLBACK',
+  });
+  return (
+    <Sentry.ErrorBoundary
+      // eslint-disable-next-line react/no-unstable-nested-components
+      fallback={({ error, componentStack, eventId }) => (
+        <ErrorFallback
+          error={error}
+          componentStack={componentStack}
+          eventId={eventId}
+          captureUserFeedback={Sentry.captureUserFeedback}
+          title={tFallback('MESSAGE_TITLE')}
+          formTitle={tFallback('MESSAGE_FEEDBACK')}
+          nameLabel={tFallback('NAME_LABEL')}
+          nameHelper={tFallback('NAME_HELPER')}
+          emailLabel={tFallback('EMAIL_LABEL')}
+          emailHelper={tFallback('EMAIL_HELPER')}
+          commentLabel={tFallback('COMMENT_LABEL')}
+          commentHelper={tFallback('COMMENT_HELPER')}
+          thanksMessage={tFallback('THANKS_FOR_FEEDBACK')}
+          sendButtonLabel={tFallback('SEND')}
+          errorDetailsLabel={tFallback('ERROR_DETAILS')}
+        />
+      )}
+    >
+      {children}
+    </Sentry.ErrorBoundary>
+  );
+};
+
+export default ErrorBoundary;
diff --git a/src/modules/Root.tsx b/src/modules/Root.tsx
@@ -24,6 +24,7 @@ import { defaultMockContext, mockMembers } from '@/mocks/db';
 import Loader from '@/modules/common/Loader';
 import { useObjectState } from '@/utils/hooks';
 
+import ErrorBoundary from './ErrorBoundary';
 import App from './main/App';
 
 // declare the module to enable theme modification
@@ -80,42 +81,46 @@ const Root: FC = () => {
         <ThemeProvider theme={theme}>
           <CssBaseline enableColorScheme />
           <I18nextProvider i18n={i18nConfig}>
-            <QueryClientProvider client={queryClient}>
-              <ToastContainer />
-              <WithLocalContext
-                defaultValue={window.Cypress ? window.appContext : mockContext}
-                LoadingComponent={<Loader />}
-                useGetLocalContext={hooks.useGetLocalContext}
-                useAutoResize={hooks.useAutoResize}
-                onError={() => {
-                  console.error(
-                    'An error occurred while fetching the context.',
-                  );
-                }}
-              >
-                <WithTokenContext
+            <ErrorBoundary>
+              <QueryClientProvider client={queryClient}>
+                <ToastContainer />
+                <WithLocalContext
+                  defaultValue={
+                    window.Cypress ? window.appContext : mockContext
+                  }
                   LoadingComponent={<Loader />}
-                  useAuthToken={hooks.useAuthToken}
+                  useGetLocalContext={hooks.useGetLocalContext}
+                  useAutoResize={hooks.useAutoResize}
                   onError={() => {
                     console.error(
-                      'An error occurred while requesting the token.',
+                      'An error occurred while fetching the context.',
                     );
                   }}
                 >
-                  <App />
-                  {import.meta.env.DEV && (
-                    <GraaspContextDevTool
-                      members={mockMembers}
-                      context={mockContext}
-                      setContext={setMockContext}
-                    />
-                  )}
-                </WithTokenContext>
-              </WithLocalContext>
-              {import.meta.env.DEV && (
-                <ReactQueryDevtools position="bottom-left" />
-              )}
-            </QueryClientProvider>
+                  <WithTokenContext
+                    LoadingComponent={<Loader />}
+                    useAuthToken={hooks.useAuthToken}
+                    onError={() => {
+                      console.error(
+                        'An error occurred while requesting the token.',
+                      );
+                    }}
+                  >
+                    <App />
+                    {import.meta.env.DEV && (
+                      <GraaspContextDevTool
+                        members={mockMembers}
+                        context={mockContext}
+                        setContext={setMockContext}
+                      />
+                    )}
+                  </WithTokenContext>
+                </WithLocalContext>
+                {import.meta.env.DEV && (
+                  <ReactQueryDevtools position="bottom-left" />
+                )}
+              </QueryClientProvider>
+            </ErrorBoundary>
           </I18nextProvider>
         </ThemeProvider>
       </StyledEngineProvider>

diff --git a/tsconfig.json b/tsconfig.json
@@ -10,7 +10,7 @@
     "strict": true,
     "forceConsistentCasingInFileNames": true,
     "module": "ESNext",
-    "moduleResolution": "Node",
+    "moduleResolution": "Bundler",
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,