Skip to content

Trigger select environment prompt if an invalid interpreter is selected #19473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 14, 2022
Merged

Trigger select environment prompt if an invalid interpreter is selected #19473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc88292
Trigger select environment prompt if an invalid interpreter is selected
Jul 14, 2022
90e270a
Add test
Jul 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/client/application/diagnostics/checks/pythonInterpreter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ import { ICommandManager, IWorkspaceService } from '../../../common/application/
import { sendTelemetryEvent } from '../../../telemetry';
import { EventName } from '../../../telemetry/constants';
import { IExtensionSingleActivationService } from '../../../activation/types';
import { cache } from '../../../common/utils/decorators';
import { noop } from '../../../common/utils/misc';

const localize: nls.LocalizeFunc = nls.loadMessageBundle();

Expand Down Expand Up @@ -90,6 +92,12 @@ export class InvalidPythonInterpreterService extends BaseDiagnosticsService
this.triggerEnvSelectionIfNecessary(resource),
),
);
const interpreterService = this.serviceContainer.get<IInterpreterService>(IInterpreterService);
this.disposableRegistry.push(
interpreterService.onDidChangeInterpreterConfiguration((e) =>
commandManager.executeCommand(Commands.TriggerEnvironmentSelection, e).then(noop, noop),
),
);
}

public async diagnose(resource: Resource): Promise<IDiagnostic[]> {
Expand Down Expand Up @@ -130,6 +138,7 @@ export class InvalidPythonInterpreterService extends BaseDiagnosticsService
return false;
}

@cache(1000, true) // This is to handle throttling of multiple events.
protected async onHandle(diagnostics: IDiagnostic[]): Promise<void> {
if (diagnostics.length === 0) {
return;
Expand Down
23 changes: 23 additions & 0 deletions src/test/application/diagnostics/checks/pythonInterpreter.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import { expect } from 'chai';
import * as typemoq from 'typemoq';
import { EventEmitter, Uri } from 'vscode';
import { IExtensionSingleActivationService } from '../../../../client/activation/types';
import { BaseDiagnosticsService } from '../../../../client/application/diagnostics/base';
import { InvalidLaunchJsonDebuggerDiagnostic } from '../../../../client/application/diagnostics/checks/invalidLaunchJsonDebugger';
Expand Down Expand Up @@ -35,6 +36,7 @@ import { noop } from '../../../../client/common/utils/misc';
import { IInterpreterHelper, IInterpreterService } from '../../../../client/interpreter/contracts';
import { IServiceContainer } from '../../../../client/ioc/types';
import { EnvironmentType, PythonEnvironment } from '../../../../client/pythonEnvironments/info';
import { sleep } from '../../../core';

suite('Application Diagnostics - Checks Python Interpreter', () => {
let diagnosticService: IDiagnosticsService & IExtensionSingleActivationService;
Expand Down Expand Up @@ -117,6 +119,27 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
expect(result2).to.equal(true);
});

test('Changes to interpreter configuration triggers environment prompts', async () => {
commandManager
.setup((c) => c.registerCommand(Commands.TriggerEnvironmentSelection, typemoq.It.isAny()))
.returns(() => typemoq.Mock.ofType<IDisposable>().object);
const interpreterEvent = new EventEmitter<Uri | undefined>();
interpreterService
.setup((i) => i.onDidChangeInterpreterConfiguration)
.returns(() => interpreterEvent.event);
await diagnosticService.activate();

commandManager
.setup((c) => c.executeCommand(Commands.TriggerEnvironmentSelection, undefined))
.returns(() => Promise.resolve())
.verifiable(typemoq.Times.once());

interpreterEvent.fire(undefined);
await sleep(1);

commandManager.verifyAll();
});

test('Can handle InvalidPythonPathInterpreter diagnostics', async () => {
for (const code of [
DiagnosticCodes.NoPythonInterpretersDiagnostic,
Expand Down