feat: provide public API to subscribe to test results.

CHANGELOG.md

@@ -5,6 +5,7 @@ Bug-fixes within the same version aren't needed
 
 ## Master
 
+* add public api to expose interface for other vscode extensions to subscribe to test results updates.
 
 -->
 

src/JestExt.ts

@@ -77,7 +77,8 @@ export class JestExt {
     debugConfigurationProvider: DebugConfigurationProvider,
     failDiagnostics: vscode.DiagnosticCollection,
     instanceSettings: InstanceSettings,
-    coverageCodeLensProvider: CoverageCodeLensProvider
+    coverageCodeLensProvider: CoverageCodeLensProvider,
+    private onTestResultsChanged: (results: JestTotalResults) => void
   ) {
     this.workspaceFolder = workspaceFolder;
     this.jestWorkspace = jestWorkspace;
@@ -515,6 +516,10 @@ export class JestExt {
   private updateWithData(data: JestTotalResults): void {
     const noAnsiData = resultsWithoutAnsiEscapeSequence(data);
     const normalizedData = resultsWithLowerCaseWindowsDriveLetters(noAnsiData);
+
+    // notify that there are new test results.
+    this.onTestResultsChanged(normalizedData);
+
     this._updateCoverageMap(normalizedData.coverageMap);
 
     const statusList = this.testResultProvider.updateTestResults(normalizedData);

src/extension.ts

@@ -7,7 +7,9 @@ import { registerSnapshotCodeLens, registerSnapshotPreview } from './SnapshotCod
 
 let extensionManager: ExtensionManager;
 
-export function activate(context: vscode.ExtensionContext): void {
+export function activate(
+  context: vscode.ExtensionContext
+): ReturnType<typeof ExtensionManager.prototype.getPublicApi> {
   extensionManager = new ExtensionManager(context);
 
   const languages = [
@@ -82,6 +84,8 @@ export function activate(context: vscode.ExtensionContext): void {
       extensionManager
     )
   );
+
+  return extensionManager.getPublicApi();
 }
 
 export function deactivate(): void {

src/extensionManager.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import * as path from 'path';
-import { ProjectWorkspace } from 'jest-editor-support';
+import { JestTotalResults, ProjectWorkspace } from 'jest-editor-support';
 import { pathToJest, pathToConfig } from './helpers';
 import { JestExt } from './JestExt';
 import { DebugCodeLensProvider, TestState } from './DebugCodeLens';
@@ -48,6 +48,8 @@ export class ExtensionManager {
   private extByWorkspace: Map<string, JestExt> = new Map();
   private context: vscode.ExtensionContext;
   private commonPluginSettings: PluginWindowSettings;
+  // keep track of any subscribers that want to be notified when there are new test results.
+  private subscribers: Array<(results: JestTotalResults) => void> = [];
 
   constructor(context: vscode.ExtensionContext) {
     this.context = context;
@@ -97,21 +99,21 @@ export class ExtensionManager {
       `Jest (${workspaceFolder.name})`
     );
 
-    this.extByWorkspace.set(
-      workspaceFolder.name,
-      new JestExt(
-        this.context,
-        workspaceFolder,
-        jestWorkspace,
-        channel,
-        pluginSettings,
-        this.debugCodeLensProvider,
-        this.debugConfigurationProvider,
-        failDiagnostics,
-        instanceSettings,
-        this.coverageCodeLensProvider
-      )
+    const jestExt = new JestExt(
+      this.context,
+      workspaceFolder,
+      jestWorkspace,
+      channel,
+      pluginSettings,
+      this.debugCodeLensProvider,
+      this.debugConfigurationProvider,
+      failDiagnostics,
+      instanceSettings,
+      this.coverageCodeLensProvider,
+      this.onTestResultsChanged.bind(this)
     );
+
+    this.extByWorkspace.set(workspaceFolder.name, jestExt);
   }
   registerAll(): void {
     vscode.workspace.workspaceFolders.forEach(this.register, this);
@@ -131,6 +133,8 @@ export class ExtensionManager {
     for (const key of keys) {
       this.unregisterByName(key);
     }
+
+    this.subscribers = [];
   }
   shouldStart(workspaceFolderName: string): boolean {
     const {
@@ -166,6 +170,30 @@ export class ExtensionManager {
       throw new Error(`No Jest instance in ${workspace.name} workspace`);
     }
   }
+
+  /**
+   * Provides the public API for this extension.
+   */
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+  public getPublicApi() {
+    return {
+      /**
+       * Provides a means to subscribe to test results events.
+       *
+       * @param callback method to be called when there are new test results.
+       */
+      subscribeToTestResults: (callback: (results: JestTotalResults) => void): (() => void) => {
+        this.subscribers.push(callback);
+
+        // return an unsubscribe function.
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        return () => {
+          this.subscribers = this.subscribers.filter((s) => s !== callback);
+        };
+      },
+    };
+  }
+
   registerCommand(
     command: string,
     callback: (extension: JestExt, ...args: unknown[]) => unknown,
@@ -216,4 +244,18 @@ export class ExtensionManager {
       ext.onDidChangeTextDocument(event);
     }
   }
+
+  /**
+   * A handler for when there are new test results from one of the JestExt instances.
+   * @param results the new test results
+   */
+  private onTestResultsChanged(results: JestTotalResults): void {
+    this.subscribers.forEach((subscriber) => {
+      try {
+        subscriber(results);
+      } catch (error) {
+        // swallow the error as we are not responsible for it.
+      }
+    });
+  }
 }

tests/JestExt.test.ts

@@ -79,7 +79,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
 
       sut.canUpdateActiveEditor = jest.fn().mockReturnValueOnce(true);
@@ -145,7 +146,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
       const editor: any = {
         document: { fileName: 'file.js' },
@@ -196,7 +198,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
       ((sut.debugConfigurationProvider
         .provideDebugConfigurations as unknown) as jest.Mock<{}>).mockReturnValue([
@@ -230,7 +233,8 @@ describe('JestExt', () => {
       debugConfigurationProvider,
       null,
       null,
-      null
+      null,
+      () => {}
     );
     const document = {} as any;
     sut.removeCachedTestResults = jest.fn();
@@ -259,7 +263,8 @@ describe('JestExt', () => {
       debugConfigurationProvider,
       null,
       null,
-      null
+      null,
+      () => {}
     );
     sut.testResultProvider.removeCachedResults = jest.fn();
 
@@ -295,7 +300,8 @@ describe('JestExt', () => {
       debugConfigurationProvider,
       null,
       null,
-      null
+      null,
+      () => {}
     );
 
     beforeEach(() => {
@@ -331,7 +337,8 @@ describe('JestExt', () => {
       debugConfigurationProvider,
       null,
       null,
-      null
+      null,
+      () => {}
     );
     sut.triggerUpdateActiveEditor = jest.fn();
 
@@ -369,7 +376,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
     });
 
@@ -447,7 +455,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
       sut.triggerUpdateSettings = jest.fn();
       sut.toggleCoverageOverlay();
@@ -467,7 +476,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
       expect(projectWorkspace.collectCoverage).toBe(true);
 
@@ -496,7 +506,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
       sut.triggerUpdateActiveEditor(editor);
 
@@ -513,7 +524,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
       sut.updateDecorators = jest.fn();
       const mockEditor: any = {
@@ -554,7 +566,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
     });
     it('will skip if there is no document in editor', () => {
@@ -613,7 +626,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
 
       mockEditor.setDecorations = jest.fn();
@@ -685,7 +699,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
 
       mockEditor.setDecorations = jest.fn();
@@ -725,7 +740,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         instanceSettings,
-        null
+        null,
+        () => {}
       );
       const mockProcessManager: any = (JestProcessManager as jest.Mock).mock.instances[0];
       mockProcessManager.startJestProcess.mockReturnValue(mockProcess);
@@ -809,7 +825,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        null
+        null,
+        () => {}
       );
     });
 
@@ -851,7 +868,8 @@ describe('JestExt', () => {
         debugConfigurationProvider,
         null,
         null,
-        coverageCodeLensProvider
+        coverageCodeLensProvider,
+        () => {}
       );
       await sut._updateCoverageMap({});
       expect(coverageCodeLensProvider.coverageChanged).toBeCalled();