Add UI to disable Sentry

Signed-off-by: Hung-Han (Henry) Chen <chenhungh@gmail.com>

src/common/user-store/preferences-helpers.ts

@@ -106,6 +106,19 @@ const allowTelemetry: PreferenceDescription<boolean> = {
   },
 };
 
+const allowErrorReporting: PreferenceDescription<boolean> = {
+  fromStore(val) {
+    return val ?? true;
+  },
+  toStore(val) {
+    if (val === true) {
+      return undefined;
+    }
+
+    return val;
+  },
+};
+
 const downloadMirror: PreferenceDescription<string> = {
   fromStore(val) {
     return val ?? "default";
@@ -227,6 +240,7 @@ export const DESCRIPTORS = {
   localeTimezone,
   allowUntrustedCAs,
   allowTelemetry,
+  allowErrorReporting,
   downloadMirror,
   downloadKubectlBinaries,
   downloadBinariesPath,

src/common/user-store/user-store.ts

@@ -59,6 +59,7 @@ export class UserStore extends BaseStore<UserStoreModel> /* implements UserStore
   @observable seenContexts = observable.set<string>();
   @observable newContexts = observable.set<string>();
   @observable allowTelemetry: boolean;
+  @observable allowErrorReporting: boolean;
   @observable allowUntrustedCAs: boolean;
   @observable colorTheme: string;
   @observable localeTimezone: string;
@@ -169,6 +170,7 @@ export class UserStore extends BaseStore<UserStoreModel> /* implements UserStore
     this.localeTimezone = DESCRIPTORS.localeTimezone.fromStore(preferences?.localeTimezone);
     this.allowUntrustedCAs = DESCRIPTORS.allowUntrustedCAs.fromStore(preferences?.allowUntrustedCAs);
     this.allowTelemetry = DESCRIPTORS.allowTelemetry.fromStore(preferences?.allowTelemetry);
+    this.allowErrorReporting = DESCRIPTORS.allowErrorReporting.fromStore(preferences?.allowErrorReporting);
     this.downloadMirror = DESCRIPTORS.downloadMirror.fromStore(preferences?.downloadMirror);
     this.downloadKubectlBinaries = DESCRIPTORS.downloadKubectlBinaries.fromStore(preferences?.downloadKubectlBinaries);
     this.downloadBinariesPath = DESCRIPTORS.downloadBinariesPath.fromStore(preferences?.downloadBinariesPath);
@@ -188,6 +190,7 @@ export class UserStore extends BaseStore<UserStoreModel> /* implements UserStore
         localeTimezone: DESCRIPTORS.localeTimezone.toStore(this.localeTimezone),
         allowUntrustedCAs: DESCRIPTORS.allowUntrustedCAs.toStore(this.allowUntrustedCAs),
         allowTelemetry: DESCRIPTORS.allowTelemetry.toStore(this.allowTelemetry),
+        allowErrorReporting: DESCRIPTORS.allowErrorReporting.toStore(this.allowErrorReporting),
         downloadMirror: DESCRIPTORS.downloadMirror.toStore(this.downloadMirror),
         downloadKubectlBinaries: DESCRIPTORS.downloadKubectlBinaries.toStore(this.downloadKubectlBinaries),
         downloadBinariesPath: DESCRIPTORS.downloadBinariesPath.toStore(this.downloadBinariesPath),

src/main/index.ts

@@ -63,6 +63,13 @@ import { CaptureConsole, Dedupe, Offline } from "@sentry/integrations";
 import * as Sentry from "@sentry/electron/dist/main";
 
 Sentry.init({
+  beforeSend(event) {
+    const allow = UserStore.getInstance().allowErrorReporting;
+
+    if (allow) return event;
+
+    return null;
+  },
   dsn,
   integrations: [
     new CaptureConsole({ levels: ["error"] }),

src/renderer/components/+preferences/preferences.tsx

@@ -40,6 +40,7 @@ import { Tab, Tabs } from "../tabs";
 import { FormSwitch, Switcher } from "../switch";
 import { KubeconfigSyncs } from "./kubeconfig-syncs";
 import { SettingLayout } from "../layout/setting-layout";
+import { Checkbox } from "../checkbox";
 
 enum Pages {
   Application = "application",
@@ -257,6 +258,25 @@ export class Preferences extends React.Component {
           <section id="telemetry">
             <h2 data-testid="telemetry-header">Telemetry</h2>
             {telemetryExtensions.map(this.renderExtension)}
+            <React.Fragment key='sentry'>
+              <section id='sentry' className="small">
+                <SubTitle title='Automatic Error Reporting' />
+                <Checkbox
+                  label="Allow automatic error reporting"
+                  value={UserStore.getInstance().allowErrorReporting}
+                  onChange={value => {
+                    UserStore.getInstance().allowErrorReporting = value;
+                  }}
+                />
+                <div className="hint">
+                  <span>
+                    Automatic error reports provide vital information about issues and application crashes.
+                    It is highly recommended to keep this feature enabled to ensure fast turnaround for issues you might encounter.
+                  </span>
+                </div>
+              </section>
+              <hr className="small" />
+            </React.Fragment>
           </section>
         )}
         {this.activeTab == Pages.Extensions && (

src/renderer/lens-app.tsx

@@ -39,8 +39,16 @@ import { catalogEntityRegistry } from "./api/catalog-entity-registry";
 import { dsn, isProduction } from "../common/vars";
 import { CaptureConsole, Dedupe, Offline } from "@sentry/integrations";
 import * as Sentry from "@sentry/electron/dist/renderer";
+import { UserStore } from "../common/user-store";
 
 Sentry.init({
+  beforeSend(event) {
+    const allow = UserStore.getInstance().allowErrorReporting;
+
+    if (allow) return event;
+
+    return null;
+  },
   dsn,
   integrations: [
     new CaptureConsole({ levels: ["error"] }),