Only resolve the code lens when then opened file is on test source path (microsoft#997)

Author: jdneo

extension.bundle.ts

@@ -3,7 +3,9 @@
 
 export { activate, deactivate } from './src/extension';
 export * from './src/codelens/TestCodeLensProvider';
+export * from './src/codelens/TestCodeLensController';
 export * from './src/runners/models';
 export * from './src/testResultManager';
 export * from './src/protocols';
 export * from './src/utils/commandUtils';
+export * from './src/testFileWatcher';

java-extension/com.microsoft.java.test.plugin/src/main/java/com/microsoft/java/test/plugin/util/TestSearchUtils.java

@@ -88,7 +88,8 @@ public static List<TestItem> searchCodeLens(List<Object> arguments, IProgressMon
         Job.getJobManager().join(DocumentLifeCycleHandler.DOCUMENT_LIFE_CYCLE_JOBS, monitor);
 
         final ICompilationUnit unit = JDTUtils.resolveCompilationUnit(uri);
-        if (!isJavaElementExist(unit) || !isInTestScope(unit) || monitor.isCanceled()) {
+        // whether the file is on test path or not is guarded at client side cache
+        if (!isJavaElementExist(unit) || monitor.isCanceled()) {
             return resultList;
         }
 

package-lock.json

@@ -358,6 +358,7 @@
         "@types/mocha": "^2.2.48",
         "@types/node": "^6.14.10",
         "@types/pug": "^2.0.4",
+        "@types/sinon": "^9.0.3",
         "@types/vscode": "1.44.0",
         "bootstrap": "^4.4.1",
         "filemanager-webpack-plugin": "^2.0.5",
@@ -367,6 +368,7 @@
         "gulp-tslint": "^8.1.4",
         "mocha": "^7.1.2",
         "pug-loader": "^2.4.0",
+        "sinon": "^9.0.2",
         "ts-loader": "^5.4.5",
         "tslint": "^5.20.1",
         "typescript": "^2.8.3",
@@ -384,4 +386,4 @@
         "winston": "^3.2.1",
         "winston-transport": "^4.3.0"
     }
-}
+}

package.json

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-import { ConfigurationChangeEvent, Disposable, languages, workspace } from 'vscode';
+import { ConfigurationChangeEvent, Disposable, DocumentSelector, languages, RelativePattern, workspace } from 'vscode';
 import { ENABLE_EDITOR_SHORTCUTS_KEY } from '../constants/configs';
 import { TestCodeLensProvider } from './TestCodeLensProvider';
 
@@ -22,6 +22,22 @@ class TestCodeLensController implements Disposable {
         this.setCodeLensVisibility();
     }
 
+    public registerCodeLensProvider(patterns: RelativePattern[]): void {
+        if (this.registeredProvider) {
+            this.registeredProvider.dispose();
+        }
+
+        const documentSelector: DocumentSelector = patterns.map((p: RelativePattern) => {
+            return {
+                language: 'java',
+                scheme: 'file',
+                pattern: p,
+            };
+        });
+
+        this.registeredProvider = languages.registerCodeLensProvider(documentSelector, this.internalProvider);
+    }
+
     public refresh(): void {
         this.internalProvider.refresh();
     }
@@ -35,12 +51,7 @@ class TestCodeLensController implements Disposable {
     }
 
     private setCodeLensVisibility(): void {
-        if (this.isCodeLensEnabled() && !this.registeredProvider) {
-            this.registeredProvider = languages.registerCodeLensProvider({ scheme: 'file', language: 'java' }, this.internalProvider);
-        } else if (!this.isCodeLensEnabled() && this.registeredProvider) {
-            this.registeredProvider.dispose();
-            this.registeredProvider = undefined;
-        }
+        this.internalProvider.setIsActivated(this.isCodeLensEnabled());
     }
 
     private isCodeLensEnabled(): boolean {

src/codelens/TestCodeLensController.ts

@@ -11,16 +11,26 @@ import { testResultManager } from '../testResultManager';
 
 export class TestCodeLensProvider implements CodeLensProvider, Disposable {
     private onDidChangeCodeLensesEmitter: EventEmitter<void> = new EventEmitter<void>();
+    private isActivated: boolean = true;
 
     get onDidChangeCodeLenses(): Event<void> {
         return this.onDidChangeCodeLensesEmitter.event;
     }
 
+    public setIsActivated(isActivated: boolean): void {
+        this.isActivated = isActivated;
+        this.refresh();
+    }
+
     public refresh(): void {
         this.onDidChangeCodeLensesEmitter.fire();
     }
 
     public async provideCodeLenses(document: TextDocument, _token: CancellationToken): Promise<CodeLens[]> {
+        if (!this.isActivated) {
+            return [];
+        }
+
         try {
             const items: ITestItem[] = await testItemModel.getItemsForCodeLens(document.uri);
             return this.getCodeLenses(items);

src/codelens/TestCodeLensProvider.ts

@@ -6,6 +6,7 @@ import { Command, Disposable, Event, EventEmitter, ExtensionContext, Range, Them
 import { JavaTestRunnerCommands } from '../constants/commands';
 import { ITestItem, TestKind, TestLevel } from '../protocols';
 import { ITestResult, TestStatus } from '../runners/models';
+import { testFileWatcher } from '../testFileWatcher';
 import { testItemModel } from '../testItemModel';
 import { testResultManager } from '../testResultManager';
 
@@ -44,6 +45,9 @@ export class TestExplorer implements TreeDataProvider<ITestItem>, Disposable {
 
     public refresh(element?: ITestItem): void {
         this.onDidChangeTreeDataEventEmitter.fire(element);
+        if (!element) {
+            testFileWatcher.registerListeners();
+        }
     }
 
     public dispose(): void {

src/explorer/testExplorer.ts

@@ -4,7 +4,7 @@
 import * as fse from 'fs-extra';
 import * as os from 'os';
 import * as path from 'path';
-import { DebugConfiguration, ExtensionContext, Range, Uri, window } from 'vscode';
+import { DebugConfiguration, Event, Extension, ExtensionContext, extensions, Range, Uri, window } from 'vscode';
 import { dispose as disposeTelemetryWrapper, initializeFromJsonFile, instrumentOperation, instrumentOperationAsVsCodeCommand } from 'vscode-extension-telemetry-wrapper';
 import { testCodeLensController } from './codelens/TestCodeLensController';
 import { debugTestsFromExplorer, openTextDocument, runTestsFromExplorer } from './commands/explorerCommands';
@@ -34,7 +34,7 @@ export async function deactivate(): Promise<void> {
 }
 
 async function doActivate(_operationId: string, context: ExtensionContext): Promise<void> {
-    testFileWatcher.registerListeners();
+    await testFileWatcher.registerListeners();
     testExplorer.initialize(context);
     runnerScheduler.initialize(context);
     testReportProvider.initialize(context);
@@ -67,4 +67,16 @@ async function doActivate(_operationId: string, context: ExtensionContext): Prom
         instrumentOperationAsVsCodeCommand(JavaTestRunnerCommands.JAVA_TEST_CANCEL, async () => await runnerScheduler.cleanUp(true /* isCancel */)),
         instrumentOperationAsVsCodeCommand(JavaTestRunnerCommands.JAVA_CONFIG_MIGRATE, async () => await migrateTestConfig()),
     );
+
+    // refetch the test source path on projectss classpath updated.
+    const extension: Extension<any> | undefined = extensions.getExtension('redhat.java');
+    if (extension && extension.isActive) {
+        const extensionApi: any = extension.exports;
+        if (extensionApi && extensionApi.onDidClasspathUpdate) {
+            const onDidClasspathUpdate: Event<Uri> = extensionApi.onDidClasspathUpdate;
+            context.subscriptions.push(onDidClasspathUpdate(async () => {
+                await testFileWatcher.registerListeners(true /*enableDebounce*/);
+            }));
+        }
+    }
 }