Skip to content

Commit

Permalink
Fixes #1013: Document diagnostics report not used when text document …
Browse files Browse the repository at this point in the history 
…closed (#1020)
  • Loading branch information
@dbaeumer
dbaeumer authored Jul 4, 2022
1 parent ae18fa7 commit 8c4ccaf
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 43 deletions.
152 changes: 118 additions & 34 deletions client/src/common/diagnostic.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ import * as minimatch from 'minimatch';

import {
Disposable, languages as Languages, window as Window, workspace as Workspace, CancellationToken, ProviderResult, Diagnostic as VDiagnostic,
CancellationTokenSource, TextDocument, CancellationError, Event as VEvent, EventEmitter, DiagnosticCollection, Uri, TabInputText, TabInputTextDiff
CancellationTokenSource, TextDocument, CancellationError, Event as VEvent, EventEmitter, DiagnosticCollection, Uri, TabInputText, TabInputTextDiff,
TabChangeEvent, Event
} from 'vscode';

import {
Expand Down Expand Up @@ -174,27 +175,57 @@ type RequestState = {
document: TextDocument | Uri;
};


/**
* Manages the open tabs. We don't directly use the tab API since for
* diagnostics we need to de-dupe tabs that show the same resources since
* we pull on the model not the UI.
*/
class Tabs {

private readonly open: Set<string>;
private open: Set<string>;
private readonly _onOpen: EventEmitter<Set<Uri>>;
private readonly _onClose: EventEmitter<Set<Uri>>;
private readonly disposable: Disposable;

constructor() {
this.open = new Set();
const openTabsHandler = () => {
this.open.clear();
for (const group of Window.tabGroups.all) {
for (const tab of group.tabs) {
const input = tab.input;
if (input instanceof TabInputText) {
this.open.add(input.uri.toString());
} else if (input instanceof TabInputTextDiff) {
this.open.add(input.modified.toString());
}
this._onOpen = new EventEmitter();
this._onClose = new EventEmitter();
Tabs.fillTabResources(this.open);
const openTabsHandler = (event: TabChangeEvent) => {
if (event.closed.length === 0 && event.opened.length === 0) {
return;
}
const oldTabs = this.open;
const currentTabs: Set<string> = new Set();
Tabs.fillTabResources(currentTabs);

const closed: Set<string> = new Set();
const opened: Set<string> = new Set(currentTabs);
for (const tab of oldTabs.values()) {
if (currentTabs.has(tab)) {
opened.delete(tab);
} else {
closed.add(tab);
}
}
this.open = currentTabs;
if (closed.size > 0) {
const toFire: Set<Uri> = new Set();
for (const item of closed) {
toFire.add(Uri.parse(item));
}
this._onClose.fire(toFire);
}
if (opened.size > 0) {
const toFire: Set<Uri> = new Set();
for (const item of opened) {
toFire.add(Uri.parse(item));
}
this._onOpen.fire(toFire);
}
};
openTabsHandler();

if (Window.tabGroups.onDidChangeTabs !== undefined) {
this.disposable = Window.tabGroups.onDidChangeTabs(openTabsHandler);
Expand All @@ -203,6 +234,14 @@ class Tabs {
}
}

public get onClose(): Event<Set<Uri>> {
return this._onClose.event;
}

public get onOpen(): Event<Set<Uri>> {
return this._onOpen.event;
}

public dispose(): void {
this.disposable.dispose();
}
Expand All @@ -218,19 +257,29 @@ class Tabs {
return this.open.has(uri.toString());
}

public getTabResources(): Uri[] {
const result: Uri[] = [];
public getTabResources(): Set<Uri> {
const result: Set<Uri> = new Set();
Tabs.fillTabResources(new Set(), result);
return result;
}

private static fillTabResources(strings: Set<string> | undefined, uris?: Set<Uri>): void {
const seen = strings ?? new Set();
for (const group of Window.tabGroups.all) {
for (const tab of group.tabs) {
const input = tab.input;
let uri: Uri | undefined;
if (input instanceof TabInputText) {
result.push(input.uri);
uri = input.uri;
} else if (input instanceof TabInputTextDiff) {
result.push(input.modified);
uri = input.modified;
}
if (uri !== undefined && !seen.has(uri.toString())) {
seen.add(uri.toString());
uris !== undefined && uris.add(uri);
}
}
}
return result;
}
}

Expand Down Expand Up @@ -294,16 +343,12 @@ class DocumentPullStateTracker {
states.delete(key);
}

public tracks(kind: PullState, textDocument: TextDocument): boolean;
public tracks(kind: PullState, uri: Uri): boolean;
public tracks(kind: PullState, document: TextDocument | Uri): boolean {
const key = document instanceof Uri ? document.toString() : document.uri.toString();
const states = kind === PullState.document ? this.documentPullStates : this.workspacePullStates;
return states.has(key);
}

public getResultId(kind: PullState, document: TextDocument): string | undefined;
public getResultId(kind: PullState, document: Uri): string | undefined;
public getResultId(kind: PullState, document: TextDocument | Uri): string | undefined {
const key = document instanceof Uri ? document.toString() : document.uri.toString();
const states = kind === PullState.document ? this.documentPullStates : this.workspacePullStates;
Expand Down Expand Up @@ -356,8 +401,12 @@ class DiagnosticRequestor implements Disposable {
this.workspaceErrorCounter = 0;
}

public knows(kind: PullState, textDocument: TextDocument): boolean {
return this.documentStates.tracks(kind, textDocument);
public knows(kind: PullState, document: TextDocument | Uri): boolean {
return this.documentStates.tracks(kind, document);
}

public forget(kind: PullState, document: TextDocument | Uri): void {
this.documentStates.unTrack(kind, document);
}

public pull(document: TextDocument | Uri, cb?: () => void): void {
Expand Down Expand Up @@ -440,24 +489,32 @@ class DiagnosticRequestor implements Disposable {
}
}

public cleanupPull(document: TextDocument | Uri): void {
public forgetDocument(document: TextDocument | Uri): void {
const uri = document instanceof Uri ? document : document.uri;
const key = uri.toString();
const request = this.openRequests.get(key);
if (this.options.workspaceDiagnostics || this.options.interFileDependencies) {
if (this.options.workspaceDiagnostics) {
// If we run workspace diagnostic pull a last time for the diagnostics
// and the rely on getting them from the workspace result.
if (request !== undefined) {
this.openRequests.set(key, { state: RequestStateKind.reschedule, document: document });
} else {
this.pull(document);
this.pull(document, () => {
this.forget(PullState.document, document);
});
}
} else {
// We have normal pull or inter file dependencies. In this case we
// clear the diagnostics (to have the same start as after startup).
// We also cancel outstanding requests.
if (request !== undefined) {
if (request.state === RequestStateKind.active) {
request.tokenSource.cancel();
}
this.openRequests.set(key, { state: RequestStateKind.outDated, document: document });
}
this.diagnostics.delete(uri);
this.forget(PullState.document, document);
}
}

Expand Down Expand Up @@ -814,6 +871,13 @@ class DiagnosticFeatureProviderImpl implements DiagnosticProviderShape {
}
});

// For pull model diagnostics we pull for documents visible in the UI.
// From an eventing point of view we still rely on open document events
// and filter the documents that are not visible in the UI instead of
// listening to Tab events. Major reason is event timing since we need
// to ensure that the pull is send after the document open has reached
// the server.

// We always pull on open.
const openFeature = client.getFeature(DidOpenTextDocumentNotification.method);
disposables.push(openFeature.onNotificationSent((event) => {
Expand All @@ -824,23 +888,31 @@ class DiagnosticFeatureProviderImpl implements DiagnosticProviderShape {
}));

// Pull all diagnostics for documents that are already open
const pullTextDocuments: Set<string> = new Set();
const pulledTextDocuments: Set<string> = new Set();
for (const textDocument of Workspace.textDocuments) {
if (matches(textDocument)) {
this.diagnosticRequestor.pull(textDocument, () => { addToBackgroundIfNeeded(textDocument); });
pullTextDocuments.add(textDocument.uri.toString());
pulledTextDocuments.add(textDocument.uri.toString());
}
}

// Pull all tabs if not already pull as text document
// Pull all tabs if not already pulled as text document
if (diagnosticPullOptions.onTabs === true) {
for (const resource of tabs.getTabResources()) {
if (!pullTextDocuments.has(resource.toString()) && matches(resource)) {
if (!pulledTextDocuments.has(resource.toString()) && matches(resource)) {
this.diagnosticRequestor.pull(resource, () => { addToBackgroundIfNeeded(resource); });
}
}
}

tabs.onOpen((opened) => {
for (const document of opened) {
if (matches(document) && !this.diagnosticRequestor.knows(PullState.document, document)) {
this.diagnosticRequestor.pull(document, () => { addToBackgroundIfNeeded(document); });
}
}
});

if (diagnosticPullOptions.onChange === true) {
const changeFeature = client.getFeature(DidChangeTextDocumentNotification.method);
disposables.push(changeFeature.onNotificationSent(async (event) => {
Expand All @@ -864,11 +936,16 @@ class DiagnosticFeatureProviderImpl implements DiagnosticProviderShape {
// When the document closes clear things up
const closeFeature = client.getFeature(DidCloseTextDocumentNotification.method);
disposables.push(closeFeature.onNotificationSent((event) => {
const textDocument = event.original;
this.diagnosticRequestor.cleanupPull(textDocument);
this.backgroundScheduler.remove(textDocument);
this.cleanUpDocument(event.original);
}));

// Same when a tabs closes.
tabs.onClose((closed) => {
for (const document of closed) {
this.cleanUpDocument(document);
}
});

// We received a did change from the server.
this.diagnosticRequestor.onDidChangeDiagnosticsEmitter.event(() => {
for (const textDocument of Workspace.textDocuments) {
Expand All @@ -893,6 +970,13 @@ class DiagnosticFeatureProviderImpl implements DiagnosticProviderShape {
public get diagnostics(): vsdiag.DiagnosticProvider {
return this.diagnosticRequestor.provider;
}

private cleanUpDocument(document: TextDocument | Uri): void {
if (this.diagnosticRequestor.knows(PullState.document, document)) {
this.diagnosticRequestor.forgetDocument(document);
this.backgroundScheduler.remove(document);
}
}
}

export class DiagnosticFeature extends TextDocumentLanguageFeature<DiagnosticOptions, DiagnosticRegistrationOptions, DiagnosticProviderShape, DiagnosticProviderMiddleware, $DiagnosticPullOptions> {
Expand Down
19 changes: 10 additions & 9 deletions testbed/server/src/server.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,15 +259,16 @@ function validate(document: TextDocument): Diagnostic[] {
// clearInterval(interval);
// });
// });
connection.console.log('Validating document ' + document.uri);
return [ {
range: Range.create(0, 0, 0, 10),
message: 'An error message',
tags: [
DiagnosticTag.Unnecessary
],
data: '11316630-392c-4227-a2c7-3b26cd68f241'
}];
// connection.console.log('Validating document ' + document.uri);
// return [ {
// range: Range.create(0, 0, 0, 10),
// message: 'An error message',
// tags: [
// DiagnosticTag.Unnecessary
// ],
// data: '11316630-392c-4227-a2c7-3b26cd68f241'
// }];
return [];
}

connection.onHover((textPosition): Hover => {
Expand Down

0 comments on commit 8c4ccaf

Please sign in to comment.