Add more logging to all procedures

Author: JustinGrote

src/api/conditionalRequests.ts

@@ -41,7 +41,7 @@ async function returnIfChanged<TResponse, TParams>(
       : TParams & {headers: Record<string, string>};
 
     const cacheKey = cacheId ?? JSON.stringify(options);
-    logDebug("Performing conditional request for cache key:", cacheKey);
+    logTrace("Performing conditional request for cache key:", cacheKey);
 
     // Add If-None-Match header if we have an ETag for this key
     const cacheMatch = timestamp ? timestampMap.get(cacheKey) : etagMap.get(cacheKey);

src/pinnedWorkflows/pinnedWorkflows.ts

@@ -56,14 +56,17 @@ export async function initPinnedWorkflows(store: RunStore) {
 }
 
 async function _init(): Promise<void> {
+  logDebug("Initializing pinned workflows watcher");
   await updatePinnedWorkflows();
 
   if (refreshTimer) {
+    logDebug("Existing pinned workflows refresh timer found, clearing it");
     clearInterval(refreshTimer);
     refreshTimer = undefined;
   }
 
   if (isPinnedWorkflowsRefreshEnabled()) {
+    logDebug("Pinned workflows refresh enabled, checking every", pinnedWorkflowsRefreshInterval(), "seconds");
     refreshTimer = setInterval(() => void refreshPinnedWorkflows(), pinnedWorkflowsRefreshInterval() * 1000);
   }
 }
@@ -116,15 +119,17 @@ async function updatePinnedWorkflows() {
     const workflowByPath: {[id: string]: Workflow} = {};
     workflows.forEach(w => (workflowByPath[w.path] = w));
 
-    for (const pinnedWorkflow of workflowsByWorkspace.get(workspaceName) || []) {
-      if (!workflowByPath[pinnedWorkflow]) {
-        log(`Unable to find pinned workflow ${pinnedWorkflow} in ${workspaceName}, ignoring`);
-        continue;
-      }
+    await Promise.all(
+      (workflowsByWorkspace.get(workspaceName) || []).map(async pinnedWorkflow => {
+        if (!workflowByPath[pinnedWorkflow]) {
+          log(`Unable to find pinned workflow ${pinnedWorkflow} in ${workspaceName}, ignoring`);
+          return;
+        }
 
-      const pW = createPinnedWorkflow(gitHubRepoContext, workflowByPath[pinnedWorkflow]);
-      await refreshPinnedWorkflow(pW);
-    }
+        const pW = createPinnedWorkflow(gitHubRepoContext, workflowByPath[pinnedWorkflow]);
+        return refreshPinnedWorkflow(pW);
+      })
+    );
   }
 }
 

src/store/store.ts

@@ -16,6 +16,13 @@ type Updater = {
   handle: NodeJS.Timeout | undefined;
 };
 
+/**
+ * Serves as the central cache store for Workflow run status in Github Actions.
+ *
+ * This is basically a local mirror of what is fetched from the GitHub API.
+ *
+ * Views should subscribe to this store's event to get updates
+ */
 export class RunStore extends EventEmitter<RunStoreEvent> {
   private runs = new Map<number, WorkflowRun>();
   private updaters = new Map<number, Updater>();

src/treeViews/currentBranch.ts

@@ -5,7 +5,7 @@ import {getCurrentBranch, getGitHubContext, GitHubRepoContext} from "../git/repo
 import {CurrentBranchRepoNode} from "./current-branch/currentBranchRepoNode";
 
 import {NoRunForBranchNode} from "./current-branch/noRunForBranchNode";
-import {log, logDebug} from "../log";
+import {log, logDebug, logTrace} from "../log";
 import {RunStore} from "../store/store";
 import {AttemptNode} from "./shared/attemptNode";
 import {GitHubAPIUnreachableNode} from "./shared/gitHubApiUnreachableNode";
@@ -39,6 +39,7 @@ export class CurrentBranchTreeProvider
   }
 
   protected _updateNode(node: WorkflowRunNode): void {
+    logTrace(`Node updated: ${node.id} ${node.label}`);
     this._onDidChangeTreeData.fire(node);
   }
 

src/treeViews/workflows.ts

@@ -2,7 +2,7 @@ import * as vscode from "vscode";
 
 import {canReachGitHubAPI} from "../api/canReachGitHubAPI";
 import {getGitHubContext} from "../git/repository";
-import {log, logDebug, logError} from "../log";
+import {log, logDebug, logError, logTrace} from "../log";
 import {RunStore} from "../store/store";
 import {AttemptNode} from "./shared/attemptNode";
 import {AuthenticationNode} from "./shared/authenticationNode";
@@ -42,6 +42,7 @@ export class WorkflowsTreeProvider
   }
 
   protected _updateNode(node: WorkflowRunNode): void {
+    logTrace(`Workflow Tree Node updated: ${node.description} ${node.label}`);
     this._onDidChangeTreeData.fire(node);
   }