change(debug): Allow keyed runtime issues to reduce clutter

notea-org · Nov 11, 2022 · b038f16 · b038f16
1 parent cf5e666
commit b038f16
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 5 deletions.
diff --git a/libs/server/debugging.ts b/libs/server/debugging.ts
@@ -8,12 +8,30 @@ import Logger = pino.Logger;
 
 export * from 'libs/shared/debugging'; // here's a lil' lesson in trickery
 
-const runtimeIssues: Array<Issue> = [];
+const serialRuntimeIssues: Array<Issue> = [];
+const keyedRuntimeIssues: Record<keyof any, Issue | undefined> = {};
 export function reportRuntimeIssue(issue: Issue) {
-    runtimeIssues.push({
+    const complete = {
         ...issue,
         isRuntime: true
+    };
+    serialRuntimeIssues.push(complete);
+}
+export function setKeyedRuntimeIssue(key: keyof typeof keyedRuntimeIssues, issue: Issue | null) {
+    if (issue === null) {
+        delete keyedRuntimeIssues[key];
+    } else {
+        keyedRuntimeIssues[key] = issue;
+    }
+}
+function getAllKeyedRuntimeIssues(): Array<Issue> {
+    const values: Array<Issue> = [];
+    Object.values(keyedRuntimeIssues).forEach((v) => {
+        if (v != undefined) { // non-strict equality because that's better for null checks
+            values.push(v);
+        }
     });
+    return values;
 }
 
 export function findIssues(): Array<Issue> {
@@ -32,7 +50,7 @@ export function findIssues(): Array<Issue> {
         });
     }
 
-    issues.push(...runtimeIssues);
+    issues.push(...serialRuntimeIssues, ...getAllKeyedRuntimeIssues());
 
     return issues;
 }

diff --git a/pages/api/settings.ts b/pages/api/settings.ts
@@ -11,9 +11,10 @@ import {
     IssueCategory,
     IssueFixRecommendation,
     IssueSeverity,
-    reportRuntimeIssue
+    setKeyedRuntimeIssue
 } from 'libs/server/debugging';
 
+const SYM_ISSUE_CANNOT_GET_SETTINGS = Symbol();
 export async function getSettings(store: StoreProvider): Promise<Settings> {
     const settingsPath = getPathSettings();
     let settings;
@@ -24,7 +25,7 @@ export async function getSettings(store: StoreProvider): Promise<Settings> {
             );
         }
     } catch (e) {
-        reportRuntimeIssue({
+        setKeyedRuntimeIssue(SYM_ISSUE_CANNOT_GET_SETTINGS, {
             category: IssueCategory.STORE,
             severity: IssueSeverity.FATAL_ERROR,
             name: "Could not get settings",
@@ -38,6 +39,7 @@ export async function getSettings(store: StoreProvider): Promise<Settings> {
         });
         throw e;
     }
+    setKeyedRuntimeIssue(SYM_ISSUE_CANNOT_GET_SETTINGS, null); // if no issue is there, it removes the issue
     const formatted = formatSettings(settings || {});
 
     if (!settings || !isEqual(settings, formatted)) {