Hide problems for the hidden doc in interactive window (#6778)

* Hide problems for the hidden doc in interactive window

* Change algorithm for exit

Author: rchiodo

news/2 Fixes/6748.md

@@ -0,0 +1 @@
+Eliminate 'History_\<guid\>' from the problems list when using the interactive panel.

package-lock.json

@@ -1,16 +1,43 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-
 'use strict';
-
 import { inject, injectable, named } from 'inversify';
 import * as path from 'path';
-import { CancellationToken, CompletionContext, ConfigurationChangeEvent, Disposable, Event, EventEmitter, OutputChannel, Position, TextDocument, WorkspaceFolder } from 'vscode';
-import { DocumentFilter, DocumentSelector, LanguageClientOptions, ProvideCompletionItemsSignature, RevealOutputChannelOn } from 'vscode-languageclient';
+import {
+    CancellationToken,
+    CompletionContext,
+    ConfigurationChangeEvent,
+    Diagnostic,
+    Disposable,
+    Event,
+    EventEmitter,
+    OutputChannel,
+    Position,
+    TextDocument,
+    Uri,
+    WorkspaceFolder
+} from 'vscode';
+import {
+    DocumentFilter,
+    DocumentSelector,
+    HandleDiagnosticsSignature,
+    LanguageClientOptions,
+    ProvideCompletionItemsSignature,
+    RevealOutputChannelOn
+} from 'vscode-languageclient';
+
 import { IWorkspaceService } from '../../common/application/types';
-import { isTestExecution, PYTHON_LANGUAGE, STANDARD_OUTPUT_CHANNEL } from '../../common/constants';
+import { HiddenFilePrefix, isTestExecution, PYTHON_LANGUAGE, STANDARD_OUTPUT_CHANNEL } from '../../common/constants';
 import { traceDecorators, traceError } from '../../common/logger';
-import { BANNER_NAME_LS_SURVEY, IConfigurationService, IExtensionContext, IOutputChannel, IPathUtils, IPythonExtensionBanner, Resource } from '../../common/types';
+import {
+    BANNER_NAME_LS_SURVEY,
+    IConfigurationService,
+    IExtensionContext,
+    IOutputChannel,
+    IPathUtils,
+    IPythonExtensionBanner,
+    Resource
+} from '../../common/types';
 import { debounceSync } from '../../common/utils/decorators';
 import { IEnvironmentVariablesProvider } from '../../common/variables/types';
 import { IInterpreterService } from '../../interpreter/contracts';
@@ -88,6 +115,7 @@ export class LanguageServerAnalysisOptions implements ILanguageServerAnalysisOpt
             }
         }
 
+        // tslint:disable-next-line: no-suspicious-comment
         // TODO: remove this setting since LS 0.2.92+ is not using it.
         // tslint:disable-next-line:no-string-literal
         properties['DatabasePath'] = path.join(this.context.extensionPath, this.languageServerFolder);
@@ -139,6 +167,14 @@ export class LanguageServerAnalysisOptions implements ILanguageServerAnalysisOpt
                 provideCompletionItem: (document: TextDocument, position: Position, context: CompletionContext, token: CancellationToken, next: ProvideCompletionItemsSignature) => {
                     this.surveyBanner.showBanner().ignoreErrors();
                     return next(document, position, context, token);
+                },
+                handleDiagnostics: (uri: Uri, diagnostics: Diagnostic[], next: HandleDiagnosticsSignature) => {
+                    // Skip sending if this is a special file.
+                    const filePath = uri.fsPath;
+                    const baseName = filePath ? path.basename(filePath) : undefined;
+                    if (!baseName || !baseName.startsWith(HiddenFilePrefix)) {
+                        next(uri, diagnostics);
+                    }
                 }
             }
         };

src/client/activation/languageServer/analysisOptions.ts

@@ -9,3 +9,6 @@ import * as path from 'path';
 // When bundling, the bundle file for the debug adapter ends up elsewhere.
 const folderName = path.basename(__dirname);
 export const EXTENSION_ROOT_DIR = folderName === 'client' ? path.join(__dirname, '..', '..') : path.join(__dirname, '..', '..', '..', '..');
+
+export const HiddenFileFormatString = '_HiddenFile_{0}.py';
+export const HiddenFilePrefix = '_HiddenFile_';

src/client/constants.ts

@@ -16,6 +16,7 @@ import {
     Uri
 } from 'vscode';
 
+import { HiddenFileFormatString } from '../../../../client/constants';
 import { IWorkspaceService } from '../../../common/application/types';
 import { CancellationError } from '../../../common/cancellation';
 import { traceWarning } from '../../../common/logger';
@@ -123,7 +124,7 @@ export abstract class BaseIntellisenseProvider implements IInteractiveWindowList
             // Create our dummy document. Compute a file path for it.
             if (this.workspaceService.rootPath || resource) {
                 const dir = resource ? path.dirname(resource.fsPath) : this.workspaceService.rootPath!;
-                const dummyFilePath = path.join(dir, `History_${uuid().replace(/-/g, '')}.py`);
+                const dummyFilePath = path.join(dir, HiddenFileFormatString.format(uuid().replace(/-/g, '')));
                 this.documentPromise.resolve(new IntellisenseDocument(dummyFilePath));
             } else {
                 this.fileSystem.createTemporaryFile('.py')

src/client/datascience/interactive-window/intellisense/baseIntellisenseProvider.ts

@@ -23,8 +23,8 @@ import { IntellisenseDocument } from './intellisenseDocument';
 @injectable()
 export class DotNetIntellisenseProvider extends BaseIntellisenseProvider implements IInteractiveWindowListener {
 
-    private languageClientPromise : Deferred<vscodeLanguageClient.LanguageClient> | undefined;
-    private sentOpenDocument : boolean = false;
+    private languageClientPromise: Deferred<vscodeLanguageClient.LanguageClient> | undefined;
+    private sentOpenDocument: boolean = false;
     private active: boolean = false;
 
     constructor(
@@ -47,11 +47,11 @@ export class DotNetIntellisenseProvider extends BaseIntellisenseProvider impleme
         this.configService.getSettings().onDidChange(() => this.active = !this.configService.getSettings().jediEnabled);
     }
 
-    protected get isActive() : boolean {
+    protected get isActive(): boolean {
         return this.active;
     }
 
-    protected async provideCompletionItems(position: monacoEditor.Position, context: monacoEditor.languages.CompletionContext, cellId: string, token: CancellationToken) : Promise<monacoEditor.languages.CompletionList> {
+    protected async provideCompletionItems(position: monacoEditor.Position, context: monacoEditor.languages.CompletionContext, cellId: string, token: CancellationToken): Promise<monacoEditor.languages.CompletionList> {
         const languageClient = await this.getLanguageClient();
         const document = await this.getDocument();
         if (languageClient && document) {
@@ -68,7 +68,7 @@ export class DotNetIntellisenseProvider extends BaseIntellisenseProvider impleme
             incomplete: false
         };
     }
-    protected async provideHover(position: monacoEditor.Position, cellId: string, token: CancellationToken) : Promise<monacoEditor.languages.Hover> {
+    protected async provideHover(position: monacoEditor.Position, cellId: string, token: CancellationToken): Promise<monacoEditor.languages.Hover> {
         const languageClient = await this.getLanguageClient();
         const document = await this.getDocument();
         if (languageClient && document) {
@@ -84,7 +84,7 @@ export class DotNetIntellisenseProvider extends BaseIntellisenseProvider impleme
             contents: []
         };
     }
-    protected async provideSignatureHelp(position: monacoEditor.Position, _context: monacoEditor.languages.SignatureHelpContext, cellId: string, token: CancellationToken) : Promise<monacoEditor.languages.SignatureHelp> {
+    protected async provideSignatureHelp(position: monacoEditor.Position, _context: monacoEditor.languages.SignatureHelpContext, cellId: string, token: CancellationToken): Promise<monacoEditor.languages.SignatureHelp> {
         const languageClient = await this.getLanguageClient();
         const document = await this.getDocument();
         if (languageClient && document) {
@@ -103,7 +103,7 @@ export class DotNetIntellisenseProvider extends BaseIntellisenseProvider impleme
         };
     }
 
-    protected async handleChanges(originalFile: string | undefined, document: IntellisenseDocument, changes: TextDocumentContentChangeEvent[]) : Promise<void> {
+    protected async handleChanges(originalFile: string | undefined, document: IntellisenseDocument, changes: TextDocumentContentChangeEvent[]): Promise<void> {
         // Then see if we can talk to our language client
         if (this.active && document) {
 
@@ -124,7 +124,7 @@ export class DotNetIntellisenseProvider extends BaseIntellisenseProvider impleme
         }
     }
 
-    private getLanguageClient(file?: Uri) : Promise<vscodeLanguageClient.LanguageClient> {
+    private getLanguageClient(file?: Uri): Promise<vscodeLanguageClient.LanguageClient> {
         if (!this.languageClientPromise) {
             this.languageClientPromise = createDeferred<vscodeLanguageClient.LanguageClient>();
             this.startup(file)
@@ -138,7 +138,7 @@ export class DotNetIntellisenseProvider extends BaseIntellisenseProvider impleme
         return this.languageClientPromise.promise;
     }
 
-    private async startup(resource?: Uri) : Promise<void> {
+    private async startup(resource?: Uri): Promise<void> {
         // Start up the language server. We'll use this to talk to the language server
         const options = await this.analysisOptions!.getAnalysisOptions();
         await this.languageServer.start(resource, options);