Constant flickering when typing in mode file (microsoft#253941)

Co-authored-by: Josh Spicer <[email protected]>

Author: aeschli

src/vs/workbench/contrib/chat/browser/promptSyntax/promptFileRewriter.ts

@@ -27,12 +27,17 @@ export class PromptFileRewriter {
 		const model = editor.getModel();
 
 		const parser = this._promptsService.getSyntaxParserFor(model);
-		const { header } = await parser.start(token).settled();
-
-		if ((header === undefined) || token.isCancellationRequested) {
+		await parser.start(token).settled();
+		const { header } = parser;
+		if (header === undefined) {
 			return undefined;
 		}
 
+		const completed = await header.settled;
+		if (!completed || token.isCancellationRequested) {
+			return;
+		}
+
 		if (('tools' in header.metadataUtility) === false) {
 			return undefined;
 		}

src/vs/workbench/contrib/chat/browser/promptSyntax/promptToolsCodeLensProvider.ts

@@ -48,11 +48,14 @@ class PromptToolsCodeLensProvider extends Disposable implements CodeLensProvider
 
 		const parser = this.promptsService.getSyntaxParserFor(model);
 
-		const { header } = await parser
-			.start(token)
-			.settled();
+		await parser.start(token).settled();
+		const { header } = parser;
+		if (!header) {
+			return undefined;
+		}
 
-		if ((header === undefined) || token.isCancellationRequested) {
+		const completed = await header.settled;
+		if (!completed || token.isCancellationRequested) {
 			return undefined;
 		}
 

src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/baseDecoder.ts

@@ -67,18 +67,22 @@ export abstract class BaseDecoder<
 	 * Promise that resolves when the stream has ended, either by
 	 * receiving the `end` event or by a disposal, but not when
 	 * the `error` event is received alone.
+	 * The promise is true if the stream has ended, and false
+	 * if the stream has been disposed without ending.
 	 */
-	private settledPromise = new DeferredPromise<void>();
+	private settledPromise = new DeferredPromise<boolean>();
 
 	/**
 	 * Promise that resolves when the stream has ended, either by
 	 * receiving the `end` event or by a disposal, but not when
 	 * the `error` event is received alone.
+	 * The promise is true if the stream has ended, and false
+	 * if the stream has been disposed without ending.
 	 *
 	 * @throws If the stream was not yet started to prevent this
 	 * 		   promise to block the consumer calls indefinitely.
 	 */
-	public get settled(): Promise<void> {
+	public get settled(): Promise<boolean> {
 		// if the stream has not started yet, the promise might
 		// block the consumer calls indefinitely if they forget
 		// to call the `start()` method, or if the call happens
@@ -296,7 +300,7 @@ export abstract class BaseDecoder<
 
 		this._ended = true;
 		this._onEnd.fire();
-		this.settledPromise.complete();
+		this.settledPromise.complete(this._ended);
 	}
 
 	/**
@@ -347,7 +351,7 @@ export abstract class BaseDecoder<
 	}
 
 	public override dispose(): void {
-		this.settledPromise.complete();
+		this.settledPromise.complete(this.ended);
 
 		this._listeners.clearAndDisposeAll();
 		this.stream.destroy();

src/vs/workbench/contrib/chat/common/promptSyntax/languageProviders/promptHeaderAutocompletion.ts

@@ -71,7 +71,10 @@ export class PromptHeaderAutocompletion extends Disposable implements Completion
 			return undefined;
 		}
 
-		await header.settled;
+		const completed = await header.settled;
+		if (!completed || token.isCancellationRequested) {
+			return undefined;
+		}
 
 		const fullHeaderRange = parser.header.range;
 		const headerRange = new Range(fullHeaderRange.startLineNumber + 1, 0, fullHeaderRange.endLineNumber - 1, model.getLineMaxColumn(fullHeaderRange.endLineNumber - 1),);

src/vs/workbench/contrib/chat/common/promptSyntax/languageProviders/promptHeaderDiagnosticsProvider.ts

@@ -53,22 +53,20 @@ class PromptHeaderDiagnosticsProvider extends ProviderInstanceBase {
 		_error: Error | undefined,
 		token: CancellationToken,
 	): Promise<void> {
-		// clean up all previously added markers
-		this.markerService.remove(MARKERS_OWNER_ID, [this.model.uri]);
 
 		const { header } = this.parser;
 		if (header === undefined) {
+			this.markerService.remove(MARKERS_OWNER_ID, [this.model.uri]);
 			return;
 		}
 
 		// header parsing process is separate from the prompt parsing one, hence
 		// apply markers only after the header is settled and so has diagnostics
-		await header.settled;
-		// by the time the promise finishes, the token might have been cancelled
-		// already due to a new 'onSettle' event, hence don't apply outdated markers
-		if (token.isCancellationRequested) {
+		const completed = await header.settled;
+		if (!completed || token.isCancellationRequested) {
 			return;
 		}
+		console.log(`Prompt header diagnostics for ${this.model.uri.toString()}:`);
 
 		const markers: IMarkerData[] = [];
 		for (const diagnostic of header.diagnostics) {
@@ -84,6 +82,12 @@ class PromptHeaderDiagnosticsProvider extends ProviderInstanceBase {
 
 		}
 
+		if (markers.length === 0) {
+			console.warn(`No markers for ${this.model.uri.toString()}`);
+			this.markerService.remove(MARKERS_OWNER_ID, [this.model.uri]);
+			return;
+		}
+
 		this.markerService.changeOne(
 			MARKERS_OWNER_ID,
 			this.model.uri,

src/vs/workbench/contrib/chat/common/promptSyntax/languageProviders/promptHeaderHovers.ts

@@ -70,7 +70,10 @@ export class PromptHeaderHoverProvider extends Disposable implements HoverProvid
 			return undefined;
 		}
 
-		await header.settled;
+		const completed = await header.settled;
+		if (!completed || token.isCancellationRequested) {
+			return undefined;
+		}
 
 		if (header instanceof InstructionsHeader) {
 			const descriptionRange = header.metadataUtility.description?.range;

src/vs/workbench/contrib/chat/common/promptSyntax/languageProviders/promptLinkProvider.ts

@@ -26,7 +26,7 @@ export class PromptLinkProvider implements LinkProvider {
 	public async provideLinks(
 		model: ITextModel,
 		token: CancellationToken,
-	): Promise<ILinksList> {
+	): Promise<ILinksList | undefined> {
 		assert(
 			!token.isCancellationRequested,
 			new CancellationError(),
@@ -40,15 +40,11 @@ export class PromptLinkProvider implements LinkProvider {
 
 		// start the parser in case it was not started yet,
 		// and wait for it to settle to a final result
-		const { references } = await parser
-			.start(token)
-			.settled();
-
-		// validate that the cancellation was not yet requested
-		assert(
-			!token.isCancellationRequested,
-			new CancellationError(),
-		);
+		const completed = await parser.start(token).settled();
+		if (!completed || token.isCancellationRequested) {
+			return undefined;
+		}
+		const { references } = parser;
 
 		// filter out references that are not valid links
 		const links: ILink[] = references

src/vs/workbench/contrib/chat/common/promptSyntax/languageProviders/promptPathAutocompletion.ts

@@ -137,15 +137,11 @@ export class PromptPathAutocompletion extends Disposable implements CompletionIt
 
 		// start the parser in case it was not started yet,
 		// and wait for it to settle to a final result
-		const { references } = await parser
-			.start(token)
-			.settled();
-
-		// validate that the cancellation was not yet requested
-		assert(
-			!token.isCancellationRequested,
-			new CancellationError(),
-		);
+		const completed = await parser.start(token).settled();
+		if (!completed || token.isCancellationRequested) {
+			return undefined;
+		}
+		const { references } = parser;
 
 		const fileReference = findFileReference(references, position);
 		if (!fileReference) {

src/vs/workbench/contrib/chat/common/promptSyntax/parsers/basePromptParser.ts

@@ -191,7 +191,7 @@ export class BasePromptParser<TContentsProvider extends IPromptContentsProvider>
 	 * block until the latest prompt contents parsing logic is settled
 	 * (e.g., for every `onContentChanged` event of the prompt source).
 	 */
-	public async settled(): Promise<this> {
+	public async settled(): Promise<boolean> {
 		assert(
 			this.started,
 			'Cannot wait on the parser that did not start yet.',
@@ -200,38 +200,31 @@ export class BasePromptParser<TContentsProvider extends IPromptContentsProvider>
 		await this.firstParseResult.promise;
 
 		if (this.errorCondition) {
-			return this;
+			return false;
 		}
 
 		// by the time when the `firstParseResult` promise is resolved,
 		// this object may have been already disposed, hence noop
 		if (this.isDisposed) {
-			return this;
+			return false;
 		}
 
 		assertDefined(
 			this.stream,
 			'No stream reference found.',
 		);
 
-		await this.stream.settled;
+		const completed = await this.stream.settled;
 
 		// if prompt header exists, also wait for it to be settled
 		if (this.promptHeader) {
-			await this.promptHeader.settled;
+			const headerCompleted = await this.promptHeader.settled;
+			if (!headerCompleted) {
+				return false;
+			}
 		}
 
-		return this;
-	}
-
-	/**
-	 * Same as {@link settled} but also waits for all possible
-	 * nested child prompt references and their children to be settled.
-	 */
-	public async allSettled(): Promise<this> {
-		await this.settled();
-
-		return this;
+		return completed;
 	}
 
 	constructor(

src/vs/workbench/contrib/chat/common/promptSyntax/parsers/promptHeader/headerBase.ts

@@ -249,7 +249,7 @@ export abstract class HeaderBase<
 	 * Promise that resolves when parsing process of
 	 * the prompt header completes.
 	 */
-	public get settled(): Promise<void> {
+	public get settled(): Promise<boolean> {
 		return this.stream.settled;
 	}