Prevent refreshing in parallel

code-asher · code-asher · commit 91428b2ebc45 · 2024-01-31T19:58:56.000-09:00
While adding an automatic refresh I discovered it was easy to
accidentally cause two refreshes to go off at the same time which causes
some races.
diff --git a/src/workspacesProvider.ts b/src/workspacesProvider.ts
@@ -14,6 +14,7 @@ export enum WorkspaceQuery {
 export class WorkspaceProvider implements vscode.TreeDataProvider<vscode.TreeItem> {
   private workspaces: WorkspaceTreeItem[] = []
   private agentWatchers: Record<WorkspaceAgent["id"], { dispose: () => void; metadata?: AgentMetadataEvent[] }> = {}
+  private fetching = false
 
   constructor(
     private readonly getWorkspacesQuery: WorkspaceQuery,
@@ -22,26 +23,47 @@ export class WorkspaceProvider implements vscode.TreeDataProvider<vscode.TreeIte
     this.fetchAndRefresh()
   }
 
-  // fetchAndRefrehsh fetches new workspaces then re-renders the entire tree.
+  // fetchAndRefresh fetches new workspaces then re-renders the entire tree.
+  // Trying to call this while already refreshing is a no-op and will return
+  // immediately.
   async fetchAndRefresh() {
+    if (this.fetching) {
+      return
+    }
+    this.fetching = true
+
+    const dispose = () => {
+      Object.values(this.agentWatchers).forEach((watcher) => watcher.dispose())
+      this.workspaces = []
+      this.fetching = false
+    }
+
+    // Assume that no URL or no token means we are not logged in.
+    const url = this.storage.getURL()
     const token = await this.storage.getSessionToken()
-    const workspacesTreeItem: WorkspaceTreeItem[] = []
-    Object.values(this.agentWatchers).forEach((watcher) => watcher.dispose())
-    // If the URL is set then we are logged in.
-    if (this.storage.getURL()) {
-      const resp = await getWorkspaces({ q: this.getWorkspacesQuery })
-      resp.workspaces.forEach((workspace) => {
-        const showMetadata = this.getWorkspacesQuery === WorkspaceQuery.Mine
-        if (showMetadata && token) {
-          const agents = extractAgents(workspace)
-          agents.forEach((agent) => this.monitorMetadata(agent.id, token)) // monitor metadata for all agents
-        }
-        const treeItem = new WorkspaceTreeItem(workspace, this.getWorkspacesQuery === WorkspaceQuery.All, showMetadata)
-        workspacesTreeItem.push(treeItem)
-      })
+    if (!url || !token) {
+      return dispose()
     }
-    this.workspaces = workspacesTreeItem
+
+    const resp = await getWorkspaces({ q: this.getWorkspacesQuery })
+
+    // We could have logged out while waiting for the query.
+    if (!url || !token) {
+      return dispose()
+    }
+
+    this.workspaces = resp.workspaces.map((workspace) => {
+      const showMetadata = this.getWorkspacesQuery === WorkspaceQuery.Mine
+      if (showMetadata && token) {
+        const agents = extractAgents(workspace)
+        agents.forEach((agent) => this.monitorMetadata(agent.id, token)) // monitor metadata for all agents
+      }
+      return new WorkspaceTreeItem(workspace, this.getWorkspacesQuery === WorkspaceQuery.All, showMetadata)
+    })
+
     this.refresh()
+
+    this.fetching = false
   }
 
   private _onDidChangeTreeData: vscode.EventEmitter<vscode.TreeItem | undefined | null | void> =
