Remove try-catch for Sentry.init (exception should be caught by lens-ide tests, not in runtime), remove isValidSentryDsn/isValidSentryDsn(), use sentryDsn string to determine if preference UI should show

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

src/common/sentry.ts

@@ -21,7 +21,7 @@
 
 import { CaptureConsole, Dedupe, Offline } from "@sentry/integrations";
 import * as Sentry from "@sentry/electron";
-import { sentryDsn, sentryDsnIsValid, isProduction } from "./vars";
+import { sentryDsn, isProduction } from "./vars";
 import { UserStore } from "./user-store";
 import logger from "../main/logger";
 
@@ -40,55 +40,44 @@ function mapProcessName(processType: string) {
  * Initialize Sentry for the current process so to send errors for debugging.
  */
 export function SentryInit() {
-  try {
+  const processName = mapProcessName(process.type);
-    const processName = mapProcessName(process.type);
 
-    Sentry.init({
+  Sentry.init({
-      beforeSend: (event) => {
+    beforeSend: (event) => {
-        // default to false, in case instance of UserStore is not created (yet)
+      // default to false, in case instance of UserStore is not created (yet)
-        let allowErrorReporting = false;
+      let allowErrorReporting = false;
 
-        try {
+      try {
-          allowErrorReporting = UserStore.getInstance()?.allowErrorReporting;
+        allowErrorReporting = UserStore.getInstance()?.allowErrorReporting;
-        } catch {
+      } catch {
-          // ignore the TypeError throw by UserStore.getInstance()
+        // ignore the TypeError throw by UserStore.getInstance()
-        }
+      }
 
-        if (allowErrorReporting) {
+      if (allowErrorReporting) {
-          return event;
+        return event;
-        }
+      }
 
-        logger.info(`🔒  [SENTRY-BEFORE-SEND-HOOK]: allowErrorReporting: ${allowErrorReporting}. Sentry event is caught but not sent to server.`);
+      logger.info(`🔒  [SENTRY-BEFORE-SEND-HOOK]: allowErrorReporting: ${allowErrorReporting}. Sentry event is caught but not sent to server.`);
-        logger.info("🔒  [SENTRY-BEFORE-SEND-HOOK]: === START OF SENTRY EVENT ===");
+      logger.info("🔒  [SENTRY-BEFORE-SEND-HOOK]: === START OF SENTRY EVENT ===");
-        logger.info(event);
+      logger.info(event);
-        logger.info("🔒  [SENTRY-BEFORE-SEND-HOOK]: ===  END OF SENTRY EVENT  ===");
+      logger.info("🔒  [SENTRY-BEFORE-SEND-HOOK]: ===  END OF SENTRY EVENT  ===");
 
-        // if return null, the event won't be sent
+      // if return null, the event won't be sent
-        // ref https://github.com/getsentry/sentry-javascript/issues/2039
+      // ref https://github.com/getsentry/sentry-javascript/issues/2039
-        return null;
+      return null;
-      },
+    },
-      dsn: sentryDsn,
+    dsn: sentryDsn,
-      integrations: [
+    integrations: [
-        new CaptureConsole({ levels: ["error"] }),
+      new CaptureConsole({ levels: ["error"] }),
-        new Dedupe(),
+      new Dedupe(),
-        new Offline()
+      new Offline()
-      ],
+    ],
-      initialScope: {
+    initialScope: {
-        tags: {
+      tags: {
 
-          "process": processName
+        "process": processName
-        }
+      }
-      },
+    },
-      environment: isProduction ? "production" : "development",
+    environment: isProduction ? "production" : "development",
-    });
+  });
-
-    if (sentryDsnIsValid) {
-      logger.info(`✔️  [SENTRY-INIT]: Sentry for ${processName} is initialized.`);
-    } else {
-      logger.info(`⚠️  [SENTRY-INIT]: Sentry for ${processName} is initialized but cant transport exceptions because dsn is not valid`);
-    }
-
-  } catch (error) {
-    logger.warn(`⚠️  [SENTRY-INIT]: Sentry.init() error: ${error?.message ?? error}.`);
-  }
 }

src/common/utils/index.ts

@@ -51,7 +51,6 @@ export * from "./tar";
 export * from "./toggle-set";
 export * from "./toJS";
 export * from "./type-narrowing";
-export * from "./isValidSentryDsn";
 
 import * as iter from "./iter";
 

src/common/utils/isValidSentryDsn.ts

@@ -1,38 +0,0 @@
-/**
- * Copyright (c) 2021 OpenLens Authors
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-
-// Regular expression used to parse a Sentry Dsn.
-// from https://github.com/getsentry/sentry-javascript/blob/f624f442fd76bf655de6def9fa4d7631735ebba0/packages/utils/src/dsn.ts#L6
-const DSN_REGEX = /^(?:(\w+):)\/\/(?:(\w+)(?::(\w+))?@)([\w.-]+)(?::(\d+))?\/(.+)/;
-
-/**
- * check if string is a valid Sentry dsn
- *
- * @param {(string | undefined | null)} string
- * @return {boolean} 
- */
-export const isValidSentryDsn = (string: string | undefined | null) => {
-
-  const valid = DSN_REGEX.exec(string);
-
-  return valid;
-};

src/common/vars.ts

@@ -24,7 +24,6 @@ import path from "path";
 import { SemVer } from "semver";
 import packageInfo from "../../package.json";
 import { defineGlobal } from "./utils/defineGlobal";
-import { isValidSentryDsn } from "./utils/isValidSentryDsn";
 
 export const isMac = process.platform === "darwin";
 export const isWindows = process.platform === "win32";
@@ -73,4 +72,3 @@ export const appSemVer = new SemVer(packageInfo.version);
 export const docsUrl = "https://docs.k8slens.dev/main/" as string;
 
 export const sentryDsn = packageInfo.config?.sentryDsn ?? "";
-export const sentryDsnIsValid = isValidSentryDsn(sentryDsn);

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

@@ -41,7 +41,7 @@ import { FormSwitch, Switcher } from "../switch";
 import { KubeconfigSyncs } from "./kubeconfig-syncs";
 import { SettingLayout } from "../layout/setting-layout";
 import { Checkbox } from "../checkbox";
-import { sentryDsnIsValid } from "../../../common/vars";
+import { sentryDsn } from "../../../common/vars";
 
 enum Pages {
   Application = "application",
@@ -259,7 +259,7 @@ export class Preferences extends React.Component {
           <section id="telemetry">
             <h2 data-testid="telemetry-header">Telemetry</h2>
             {telemetryExtensions.map(this.renderExtension)}
-            {sentryDsnIsValid ? (
+            {sentryDsn ? (
               <React.Fragment key='sentry'>
                 <section id='sentry' className="small">
                   <SubTitle title='Automatic Error Reporting' />