Optimize attach/detach log stream

Author: justinwilaby

src/extension/commands/git/watch-config.spec.ts

@@ -17,7 +17,9 @@ suite('WatchConfig', () => {
   setup(() => {
     watcher = (async function* () {
       const result = await new Promise<GitRemoteAppsDiff>((resolve) => {
-        watcherEmitter.once('change', resolve);
+        watcherEmitter.once('change', () => {
+          resolve({ added: new Set(), removed: new Set() });
+        });
       });
       yield result;
     })();
@@ -59,47 +61,26 @@ suite('WatchConfig', () => {
     const watchConfig = new WatchConfig();
     const abortController = new AbortController();
 
-    const generator = await watchConfig.run(abortController, true);
+    const generator = await watchConfig.run(abortController);
 
     // Simulate initial state
     getHerokuAppNamesStub.onFirstCall().resolves(['app1', 'app2']);
 
     // Start the generator
-    const promise = generator.next();
-
-    // Simulate a change event with no actual changes
-    watcherEmitter.emit('change', { eventType: 'change' });
+    const result1 = await generator.next();
 
     // Simulate a change event
     getHerokuAppNamesStub.onSecondCall().resolves(['app1', 'app3']);
 
-    const result = await promise;
-    assert.deepStrictEqual(result.value, { added: new Set(['app3']), removed: new Set(['app2']) });
-
-    // Verify that context was updated
-    assert(vscodeStub.commands.executeCommand.calledWith('setContext', 'heroku.app-found', true));
-
-    abortController.abort();
-  });
-
-  test('should not yield when there are no changes', async () => {
-    const watchConfig = new WatchConfig();
-    const abortController = new AbortController();
-
-    const generator = await watchConfig.run(abortController, false);
-
-    // Simulate no changes
-    getHerokuAppNamesStub.resolves(['app1', 'app2']);
-
-    // Start the generator
     const promise = generator.next();
-
     // Simulate a change event with no actual changes
     watcherEmitter.emit('change', { eventType: 'change' });
-    abortController.abort();
-    const result = await promise;
 
-    assert.strictEqual(result.value, undefined);
+    const result2 = await promise;
+
+    assert.deepStrictEqual(result2.value, { added: new Set(['app3']), removed: new Set(['app2']) });
+
+    abortController.abort();
   });
 
   test('should handle errors gracefully', async () => {

src/extension/commands/git/watch-config.ts

@@ -1,5 +1,4 @@
 import { watch } from 'node:fs/promises';
-import * as vscode from 'vscode';
 import { herokuCommand } from '../../meta/command';
 import { HerokuCommand } from '../heroku-command';
 import { findGitConfigFileLocation, getHerokuAppNames } from '../../utils/git-utils';
@@ -17,20 +16,20 @@ export class WatchConfig extends HerokuCommand<AsyncGenerator<GitRemoteAppsDiff>
    * Runs the command.
    *
    * @param abortController AbortController
-   * @param updateContext boolean
    *
    * @returns AsyncGenerator<AppNameDiff>
    */
-  public async run(abortController: AbortController, updateContext = true): Promise<AsyncGenerator<GitRemoteAppsDiff>> {
+  public async run(abortController: AbortController): Promise<AsyncGenerator<GitRemoteAppsDiff>> {
     const configPath = await findGitConfigFileLocation();
-    let apps = new Set(await this.getUpdatedAppNames(updateContext));
+    let apps = new Set(await getHerokuAppNames());
 
     return async function* (this: WatchConfig): AsyncGenerator<GitRemoteAppsDiff> {
+      yield { added: apps, removed: new Set() };
       while (!abortController.signal.aborted) {
         const watcher = watch(configPath, { signal: abortController.signal });
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         for await (const event of watcher) {
-          const maybeUpdatedApps = new Set(await this.getUpdatedAppNames(updateContext));
+          const maybeUpdatedApps = new Set(await getHerokuAppNames());
           const added = maybeUpdatedApps.difference(apps);
           const removed = apps.difference(maybeUpdatedApps);
           if (added.size || removed.size) {
@@ -43,18 +42,4 @@ export class WatchConfig extends HerokuCommand<AsyncGenerator<GitRemoteAppsDiff>
       }
     }.bind(this)();
   }
-
-  /**
-   * Gets the updated app names and optionally updates the 'heroku.app-found' context.
-   *
-   * @param updateContext boolean indicatig whether to update the 'heroku.app-found' context.
-   * @returns Promise<Set<string>>
-   */
-  private async getUpdatedAppNames(updateContext: boolean): Promise<Set<string>> {
-    const apps = new Set(await getHerokuAppNames());
-    if (updateContext) {
-      void vscode.commands.executeCommand('setContext', 'heroku.app-found', !!apps.size);
-    }
-    return apps;
-  }
 }

src/extension/providers/resource-explorer/heroku-resource-explorer-provider.spec.ts

@@ -5,19 +5,19 @@ import { HerokuResourceExplorerProvider } from './heroku-resource-explorer-provi
 import { App, Dyno, Formation, AddOn } from '@heroku-cli/schema';
 import { randomUUID } from 'node:crypto';
 import * as gitUtils from '../../utils/git-utils';
-import { LogStreamClient, LogStreamEvents } from './log-stream-client';
 import { Readable, Writable } from 'node:stream';
+import { WatchConfig } from '../../commands/git/watch-config';
 
 suite('HerokuResourceExplorerProvider', () => {
   let provider: HerokuResourceExplorerProvider;
   let mockContext: vscode.ExtensionContext;
   let getSessionStub: sinon.SinonStub;
+  let vsCodeExecCommandStub: sinon.SinonStub;
   let fetchStub: sinon.SinonStub;
   let elementTypeMap: Map<unknown, unknown>;
   let childParentMap: Map<unknown, unknown>;
   let appToResourceMap: Map<unknown, unknown>;
   let getHerokuAppNamesStub: sinon.SinonStub;
-  let logStreamClientStub: LogStreamClient;
   let stream: Writable;
 
   const mockApp = { id: 'app1', name: 'test-app', organization: { name: 'test-org' } } as App;
@@ -47,12 +47,19 @@ suite('HerokuResourceExplorerProvider', () => {
       }
     } as any;
 
-    getSessionStub = sinon.stub(vscode.authentication, 'getSession').callsFake(async (providerId: string) => {
-      if (providerId === 'heroku:auth:login') {
-        return sessionObject;
-      }
-      return undefined;
-    });
+    getSessionStub = sinon
+      .stub(vscode.authentication, 'getSession')
+      .withArgs('heroku:auth:login')
+      .resolves(sessionObject);
+
+    vsCodeExecCommandStub = sinon.stub(vscode.commands, 'executeCommand');
+    vsCodeExecCommandStub.withArgs(WatchConfig.COMMAND_ID, sinon.match.any).resolves(
+      (function* () {
+        yield { added: new Set([mockApp.name]), removed: new Set() };
+      })()
+    );
+
+    vsCodeExecCommandStub.callThrough();
 
     // LogStream stub
     stream = new Writable();
@@ -71,6 +78,7 @@ suite('HerokuResourceExplorerProvider', () => {
     );
 
     fetchStub = sinon.stub(global, 'fetch');
+    fetchStub.withArgs('https://api.heroku.com/apps/test-app').resolves(new Response(JSON.stringify(mockApp)));
     fetchStub.withArgs('https://api.heroku.com/apps/app1').resolves(new Response(JSON.stringify(mockApp)));
     fetchStub.withArgs('https://api.heroku.com/apps/app1/dynos').resolves(new Response(JSON.stringify([mockDyno])));
     fetchStub.withArgs('https://api.heroku.com/apps/app1/addons').resolves(new Response(JSON.stringify([mockAddOn])));
@@ -95,8 +103,6 @@ suite('HerokuResourceExplorerProvider', () => {
     getHerokuAppNamesStub = sinon.stub(gitUtils, 'getHerokuAppNames').resolves(['app1']);
 
     provider = new HerokuResourceExplorerProvider(mockContext);
-    logStreamClientStub = new LogStreamClient();
-    Reflect.set(provider, 'logStreamClient', logStreamClientStub);
 
     elementTypeMap = Reflect.get(provider, 'elementTypeMap') as Map<unknown, unknown>;
     childParentMap = Reflect.get(provider, 'childParentMap') as Map<unknown, unknown>;
@@ -108,12 +114,14 @@ suite('HerokuResourceExplorerProvider', () => {
   });
 
   test('getChildren should return apps when no element is provided', async () => {
+    await new Promise((resolve) => provider.event(resolve));
     const children = await provider.getChildren();
     assert.strictEqual(children.length, 1);
     assert.deepStrictEqual(children[0], mockApp);
   });
 
   test('getChildren should return app categories when an app is provided', async () => {
+    await new Promise((resolve) => provider.event(resolve));
     const [app] = await provider.getChildren(); // Populate appToResourceMap
     const children = (await provider.getChildren(app)) as vscode.TreeItem[];
     assert.strictEqual(children.length, 4);
@@ -124,6 +132,7 @@ suite('HerokuResourceExplorerProvider', () => {
   });
 
   test('getChildren should return formations when FORMATIONS category is provided', async () => {
+    await new Promise((resolve) => provider.event(resolve));
     const [app] = await provider.getChildren(); // Populate appToResourceMap
     const categories = (await provider.getChildren(app)) as vscode.TreeItem[];
     const formationsCategory = categories.find((c) => c.label === 'FORMATIONS');
@@ -151,6 +160,7 @@ suite('HerokuResourceExplorerProvider', () => {
   });
 
   test('onFormationScaledTo should update formation quantity and fire event', async () => {
+    await new Promise((resolve) => provider.event(resolve));
     const [app] = await provider.getChildren(); // Populate appToResourceMap
     const categories = (await provider.getChildren(app)) as vscode.TreeItem[]; // gets the categories
 
@@ -167,6 +177,7 @@ suite('HerokuResourceExplorerProvider', () => {
   });
 
   test('onDynoStateChanged should update dyno state and fire event', async () => {
+    await new Promise((resolve) => provider.event(resolve));
     const [app] = await provider.getChildren(); // Populate appToResourceMap
     const categories = (await provider.getChildren(app)) as vscode.TreeItem[]; // gets the categories
 
@@ -184,6 +195,7 @@ suite('HerokuResourceExplorerProvider', () => {
   });
 
   test('onDynoStateChanged should add the new dyno when startup occurs', async () => {
+    await new Promise((resolve) => provider.event(resolve));
     const [app] = await provider.getChildren(); // Populate appToResourceMap
     const categories = (await provider.getChildren(app)) as vscode.TreeItem[]; // gets the categories