WD-8308 - feat: Add comments to errors that should continue to only b…

…e logged to the console (#1688)

src/hooks/useLocalStorage.ts

@@ -11,6 +11,7 @@ function useLocalStorage<V>(
       const item = window.localStorage.getItem(key);
       return item ? JSON.parse(item) : initialValue;
     } catch (error) {
+      // Not shown in UI. Logged for debugging purposes.
       console.error("Unable to parse local storage:", error);
       return initialValue;
     }
@@ -24,6 +25,7 @@ function useLocalStorage<V>(
       setStoredValue(value);
       window.localStorage.setItem(key, stringified);
     } catch (error) {
+      // Not shown in UI. Logged for debugging purposes.
       console.error(error);
     }
   };

src/juju/api.ts

@@ -123,6 +123,7 @@ function startPingerLoop(conn: ConnectionWithFacades) {
   const intervalId = window.setInterval(() => {
     conn.facades.pinger?.ping(null).catch((e) => {
       // If the pinger fails for whatever reason then cancel the ping.
+      // Not shown in UI. Logged for debugging purposes.
       console.error("pinger stopped,", e);
       stopPingerLoop(intervalId);
     });
@@ -379,6 +380,7 @@ export async function fetchAllModelStatuses(
             dispatch(
               addControllerCloudRegion({ wsControllerURL, modelInfo }),
             ).catch((error) =>
+              // Not shown in UI. Logged for debugging purposes.
               console.error(
                 "Error when trying to add controller cloud and region data.",
                 error,

src/pages/EntityDetails/Model/Logs/ActionLogs/ActionLogs.tsx

@@ -160,6 +160,7 @@ const generateApplicationRow = (
   const parts = actionData.action.receiver.match(/unit-(.+)-\d+/);
   const appName = parts && parts[1];
   if (!appName) {
+    // Not shown in UI. Logged for debugging purposes.
     console.error(
       "Unable to parse action receiver",
       actionData.action.receiver,

src/pages/ModelDetails/ModelDetails.tsx

@@ -70,7 +70,11 @@ export default function ModelDetails() {
           conn,
           watcherHandle["watcher-id"],
           pingerIntervalId,
-        ).catch((error) => console.error(Label.MODEL_WATCHER_ERROR, error));
+        ).catch((error) =>
+          // Error doesn’t interfere with the user’s interaction with the
+          // dashboard. Not shown in UI. Logged for debugging purposes.
+          console.error(Label.MODEL_WATCHER_ERROR, error),
+        );
       }
     };
     // Skipped as we need appState due to the call to `connectAndLoginToModel`

src/store/middleware/check-auth.ts

@@ -14,6 +14,7 @@ import type { RootState, Store } from "store/store";
 import { isPayloadAction } from "types";
 
 function error(name: string, wsControllerURL?: string | null) {
+  // Not shown in UI. Logged for debugging purposes.
   console.error(
     "Unable to perform action: ",
     name,
@@ -28,6 +29,7 @@ function error(name: string, wsControllerURL?: string | null) {
 
 export const checkLoggedIn = (state: RootState, wsControllerURL: string) => {
   if (!wsControllerURL) {
+    // Not shown in UI. Logged for debugging purposes.
     console.error(
       "Unable to determine logged in status. " +
         "'wsControllerURL' was not provided in the action that was dispatched.",