feat: enable customizable Sentry feedback integration (#18)

* feat: enable customizable Sentry feedback integration * merge feedbackIntegration into sentry option
jaenjs · Jan 6, 2025 · 23e9027 · 23e9027
1 parent 8f3c4ef
commit 23e9027
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 14 deletions.
diff --git a/packages/gatsby-plugin-jaen/gatsby/gatsby-node.ts b/packages/gatsby-plugin-jaen/gatsby/gatsby-node.ts
@@ -47,7 +47,8 @@ export const pluginOptionsSchema: GatsbyNode['pluginOptionsSchema'] = ({
     sentry: Joi.object({
       org: Joi.string().required(),
       project: Joi.string().required(),
-      dsn: Joi.string().required()
+      dsn: Joi.string().required(),
+      feedbackIntegration: Joi.object()
     })
   })
 }

diff --git a/packages/gatsby-plugin-jaen/src/gatsby/on-client-entry.ts b/packages/gatsby-plugin-jaen/src/gatsby/on-client-entry.ts
@@ -35,17 +35,18 @@ export const onClientEntry: GatsbyBrowser['onClientEntry'] = async (
   Sentry.addIntegration(Sentry.browserProfilingIntegration())
   Sentry.addIntegration(Sentry.replayIntegration())
 
-  // Temporary disable Sentry feedback integration
-  // A lot of websites build using Jaen are targeted at non-engish speaking
-  // users and the feedback form is in english. This can be confusing for users.
-  // Sentry.addIntegration(
-  //   Sentry.feedbackIntegration({
-  //     colorScheme: 'light',
-  //     showBranding: false,
-  //     formTitle: 'Give Feedback',
-  //     buttonLabel: 'Feedback',
-  //     submitButtonLabel: 'Send Feedback',
-  //     messagePlaceholder: 'Report an issue or share your ideas.'
-  //   })
-  // )
+  if (pluginOptions.sentry?.feedbackIntegration) {
+    Sentry.addIntegration(
+      Sentry.feedbackIntegration({
+        colorScheme: 'light',
+        showBranding: false,
+        formTitle: 'Give Feedback',
+        buttonLabel: 'Feedback',
+        submitButtonLabel: 'Send Feedback',
+        messagePlaceholder: 'Report an issue or share your ideas.',
+        // Allows for customizing the feedback form
+        ...pluginOptions.sentry.feedbackIntegration
+      })
+    )
+  }
 }
diff --git a/packages/gatsby-plugin-jaen/src/gatsby/types.ts b/packages/gatsby-plugin-jaen/src/gatsby/types.ts
@@ -1,4 +1,5 @@
 import {PluginOptions} from 'gatsby'
+import type {feedbackIntegration} from '@sentry/gatsby'
 
 export interface JaenPluginOptions extends PluginOptions {
   zitadel: {
@@ -11,4 +12,11 @@ export interface JaenPluginOptions extends PluginOptions {
   googleAnalytics?: {
     trackingIds?: string[]
   }
+
+  sentry?: {
+    org: string
+    project: string
+    dsn: string
+    feedbackIntegration?: Parameters<typeof feedbackIntegration>[0]
+  }
 }