Skip to content
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

Double-check for interpreters when running diagnostics #12158

Merged
merged 5 commits into from
Jun 8, 2020
Merged

Double-check for interpreters when running diagnostics #12158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
48b6ff2
Get interpreters if hasInterpreters returns false
kimadeline Jun 4, 2020
0b8f44c
Undo ignoreErrors()
kimadeline Jun 5, 2020
6351948
Add unit tests
kimadeline Jun 5, 2020
899c50c
Fixed tests
kimadeline Jun 5, 2020
3c46646
Newline
kimadeline Jun 5, 2020
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
1 change: 1 addition & 0 deletions news/2 Fixes/11870.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Double-check for interpreters when running diagnostics before displaying the "Python is not installed" message.
9 changes: 8 additions & 1 deletion src/client/application/diagnostics/checks/pythonInterpreter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,14 @@ export class InvalidPythonInterpreterService extends BaseDiagnosticsService {
}

const interpreterService = this.serviceContainer.get<IInterpreterService>(IInterpreterService);
const hasInterpreters = await interpreterService.hasInterpreters;
// hasInterpreters being false can mean one of 2 things:
// 1. getInterpreters hasn't returned any interpreters;
// 2. getInterpreters hasn't run yet.
// We want to make sure that false comes from 1, so we're adding this fix until we refactor interpreter discovery.
// Also see https://github.com/microsoft/vscode-python/issues/3023.
const hasInterpreters =
(await interpreterService.hasInterpreters) ||
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second part of this operation is short-circuited if await interpreterService.hasInterpreters) returns true, it's not executed all the time, see the MDN documentation on short-circuiting.

(await interpreterService.getInterpreters(resource)).length > 0;

if (!hasInterpreters) {
return [new InvalidPythonInterpreterDiagnostic(DiagnosticCodes.NoPythonInterpretersDiagnostic, resource)];
Expand Down
36 changes: 34 additions & 2 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 @@ -31,7 +31,7 @@ import { IConfigurationService, IDisposableRegistry, IPythonSettings } from '../
import { noop } from '../../../../client/common/utils/misc';
import { IInterpreterHelper, IInterpreterService } from '../../../../client/interpreter/contracts';
import { IServiceContainer } from '../../../../client/ioc/types';
import { InterpreterType } from '../../../../client/pythonEnvironments/discovery/types';
import { InterpreterType, PythonInterpreter } from '../../../../client/pythonEnvironments/discovery/types';

suite('Application Diagnostics - Checks Python Interpreter', () => {
let diagnosticService: IDiagnosticsService;
Expand Down Expand Up @@ -130,7 +130,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
expect(diagnostics).to.be.deep.equal([]);
settings.verifyAll();
});
test('Should return diagnostics if there are no interpreters', async () => {
test('Should return diagnostics if there are no interpreters after double-checking', async () => {
settings
.setup((s) => s.disableInstallationChecks)
.returns(() => false)
Expand All @@ -139,6 +139,10 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
.setup((i) => i.hasInterpreters)
.returns(() => Promise.resolve(false))
.verifiable(typemoq.Times.once());
interpreterService
.setup((i) => i.getInterpreters(undefined))
.returns(() => Promise.resolve([]))
.verifiable(typemoq.Times.once());

const diagnostics = await diagnosticService.diagnose(undefined);
expect(diagnostics).to.be.deep.equal(
Expand All @@ -148,6 +152,34 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
settings.verifyAll();
interpreterService.verifyAll();
});
test('Should return empty diagnostics if there are interpreters after double-checking', async () => {
const interpreter: PythonInterpreter = { type: InterpreterType.Unknown } as any;

settings
.setup((s) => s.disableInstallationChecks)
.returns(() => false)
.verifiable(typemoq.Times.once());
interpreterService
.setup((i) => i.hasInterpreters)
.returns(() => Promise.resolve(false))
.verifiable(typemoq.Times.once());
interpreterService
.setup((i) => i.getInterpreters(undefined))
.returns(() => Promise.resolve([interpreter]))
.verifiable(typemoq.Times.once());
interpreterService
.setup((i) => i.getActiveInterpreter(typemoq.It.isAny()))
.returns(() => {
return Promise.resolve(interpreter);
})
.verifiable(typemoq.Times.once());

const diagnostics = await diagnosticService.diagnose(undefined);

expect(diagnostics).to.be.deep.equal([], 'not the same');
settings.verifyAll();
interpreterService.verifyAll();
});
test('Should return invalid diagnostics if there are interpreters but no current interpreter', async () => {
settings
.setup((s) => s.disableInstallationChecks)
Expand Down