added option to add the folder to the ignored ones in the popup (jest…

…-community#896)

* added option to add the folder to the ignored ones in the popup

* fixed formatting

* fixed tests on windows

* use direct reference for workspace folder

* add ignore action for multiple workspace folders

* added test for addFolderToDisabledWorkspaceFolders

* test for exit event flow

* reverted formatting

src/JestExt/core.ts

@@ -32,6 +32,8 @@ import { startWizard, WizardTaskId } from '../setup-wizard';
 import { JestExtExplorerContext } from '../test-provider/types';
 import { JestTestProvider } from '../test-provider';
 import { JestProcessInfo } from '../JestProcessManagement';
+import { addFolderToDisabledWorkspaceFolders } from '../extensionManager';
+import { MessageAction } from '../messaging';
 
 interface RunTestPickItem extends vscode.QuickPickItem {
   id: DebugTestIdentifier;
@@ -144,6 +146,14 @@ export class JestExt {
     };
   }
 
+  private setupIgnoreAction(): messaging.MessageAction {
+    return {
+      title: 'Ignore Folder',
+      action: (): void => {
+        addFolderToDisabledWorkspaceFolders(this.extContext.workspace.name);
+      },
+    };
+  }
   private setupRunEvents(events: JestSessionEvents): void {
     events.onRunEvent.event((event: JestRunEvent) => {
       switch (event.type) {
@@ -173,11 +183,15 @@ export class JestExt {
             const msg = `${event.error}\n see troubleshooting: ${messaging.TROUBLESHOOTING_URL}`;
             this.channel.appendLine(msg);
             this.channel.show();
-            messaging.systemErrorMessage(
-              event.error,
+
+            const messageActions: Array<MessageAction> = [
               messaging.showTroubleshootingAction,
-              this.setupWizardAction('cmdLine')
-            );
+              this.setupWizardAction('cmdLine'),
+            ];
+            if (vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders.length > 1) {
+              messageActions.push(this.setupIgnoreAction());
+            }
+            messaging.systemErrorMessage(event.error, ...messageActions);
           } else {
             this.updateStatusBar({ state: 'done' });
           }

src/extensionManager.ts

@@ -25,6 +25,13 @@ export function getExtensionWindowSettings(): PluginWindowSettings {
   };
 }
 
+export function addFolderToDisabledWorkspaceFolders(folder: string): void {
+  const config = vscode.workspace.getConfiguration('jest');
+  const disabledWorkspaceFolders = new Set(config.get<string[]>('disabledWorkspaceFolders') ?? []);
+  disabledWorkspaceFolders.add(folder);
+  config.update('disabledWorkspaceFolders', [...disabledWorkspaceFolders]);
+}
+
 export type RegisterCommand =
   | {
       type: 'all-workspaces';

tests/JestExt/core.test.ts

@@ -7,7 +7,10 @@ jest.unmock('../test-helper');
 jest.mock('../../src/DebugCodeLens', () => ({
   DebugCodeLensProvider: class MockCodeLensProvider {},
 }));
-jest.mock('os');
+const mockPlatform = jest.fn();
+const mockRelease = jest.fn();
+mockRelease.mockReturnValue('');
+jest.mock('os', () => ({ platform: mockPlatform, release: mockRelease }));
 jest.mock('../../src/decorations/test-status', () => ({
   TestStatus: jest.fn(),
 }));
@@ -36,6 +39,8 @@ import { workspaceLogging } from '../../src/logging';
 import { ProjectWorkspace } from 'jest-editor-support';
 import { mockProjectWorkspace, mockWworkspaceLogging } from '../test-helper';
 import { JestTestProvider } from '../../src/test-provider';
+import { MessageAction } from '../../src/messaging';
+import { addFolderToDisabledWorkspaceFolders } from '../../src/extensionManager';
 
 /* eslint jest/expect-expect: ["error", { "assertFunctionNames": ["expect", "expectItTakesNoAction"] }] */
 const mockHelpers = helper as jest.Mocked<any>;
@@ -1158,7 +1163,30 @@ describe('JestExt', () => {
         it('if error: status bar stopped and show error', () => {
           onRunEvent({ type: 'exit', error: 'something is wrong', process });
           expect(sbUpdateMock).toBeCalledWith({ state: 'stopped' });
-          expect(messaging.systemErrorMessage).toHaveBeenCalled();
+          expect(messaging.systemErrorMessage).toHaveBeenCalledWith(
+            'something is wrong',
+            { action: expect.any(Function), title: 'Help' },
+            { action: expect.any(Function), title: 'Run Setup Wizard' }
+          );
+        });
+        it('if error: status bar stopped and show error with ignore folder button', () => {
+          (vscode.workspace.workspaceFolders as any) = ['testfolder1', 'testfolder2'];
+
+          onRunEvent({ type: 'exit', error: 'something is wrong', process });
+          expect(sbUpdateMock).toBeCalledWith({ state: 'stopped' });
+          expect(messaging.systemErrorMessage).toHaveBeenCalledWith(
+            'something is wrong',
+            { action: expect.any(Function), title: 'Help' },
+            { action: expect.any(Function), title: 'Run Setup Wizard' },
+            { action: expect.any(Function), title: 'Ignore Folder' }
+          );
+
+          const ignoreAction: MessageAction = (messaging.systemErrorMessage as jest.Mocked<any>)
+            .mock.calls[0][3];
+
+          ignoreAction.action();
+
+          expect(addFolderToDisabledWorkspaceFolders).toHaveBeenCalledWith('test-folder');
         });
       });
     });

tests/JestProcessManagement/JestProcess.test.ts

@@ -4,7 +4,9 @@ jest.unmock('../../src/JestProcessManagement/helper');
 jest.unmock('../../src/helpers');
 
 const mockPlatform = jest.fn();
-jest.mock('os', () => ({ platform: mockPlatform }));
+const mockRelease = jest.fn();
+mockRelease.mockReturnValue('');
+jest.mock('os', () => ({ platform: mockPlatform, release: mockRelease }));
 
 import { Runner } from 'jest-editor-support';
 import { JestProcess, RunnerEvents } from '../../src/JestProcessManagement/JestProcess';

tests/extensionManager.test.ts

@@ -2,7 +2,11 @@ jest.unmock('../src/extensionManager');
 jest.unmock('../src/appGlobals');
 
 import * as vscode from 'vscode';
-import { ExtensionManager, getExtensionWindowSettings } from '../src/extensionManager';
+import {
+  addFolderToDisabledWorkspaceFolders,
+  ExtensionManager,
+  getExtensionWindowSettings,
+} from '../src/extensionManager';
 import { DebugCodeLensProvider, TestState } from '../src/DebugCodeLens';
 import { readFileSync } from 'fs';
 import { PluginWindowSettings } from '../src/Settings';
@@ -11,6 +15,8 @@ import { JestExt } from '../src/JestExt';
 import { DebugConfigurationProvider } from '../src/DebugConfigurationProvider';
 import { CoverageCodeLensProvider } from '../src/Coverage';
 
+const updateConfigurationMock = jest.fn();
+
 vscode.workspace.getConfiguration = jest.fn().mockImplementation((section) => {
   const data = readFileSync('./package.json');
   const config = JSON.parse(data.toString()).contributes.configuration.properties;
@@ -24,6 +30,7 @@ vscode.workspace.getConfiguration = jest.fn().mockImplementation((section) => {
 
   return {
     get: jest.fn().mockImplementation((key) => defaults[`${section}.${key}`]),
+    update: updateConfigurationMock,
   };
 });
 
@@ -520,6 +527,16 @@ describe('ExtensionManager', () => {
       });
     });
   });
+
+  describe('addFolderToDisabledWorkspaceFolders()', () => {
+    it('should add the folder to the disabledWorkspaceFolders in the configuration', async () => {
+      addFolderToDisabledWorkspaceFolders('some-workspace-folder');
+      expect(updateConfigurationMock).toHaveBeenCalledWith('disabledWorkspaceFolders', [
+        'some-workspace-folder',
+      ]);
+    });
+  });
+
   describe.each`
     files                       | ext1Call | ext2Call
     ${['ws-3']}                 | ${0}     | ${0}