move prompt file parser usages to IPromptsService (microsoft#251298)

Author: aeschli

src/vs/workbench/contrib/chat/browser/chatAttachmentModel.ts

@@ -10,7 +10,7 @@ import { IRange } from '../../../../editor/common/core/range.js';
 import { Disposable } from '../../../../base/common/lifecycle.js';
 import { IChatRequestFileEntry, IChatRequestVariableEntry, isPromptFileVariableEntry, toPromptFileVariableEntry } from '../common/chatVariableEntries.js';
 import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js';
-import { ChatPromptAttachmentsCollection } from './chatAttachmentModel/chatPromptAttachmentsCollection.js';
+import { ChatPromptAttachmentsCollection } from './chatAttachmentModel/chatPromptAttachments.js';
 import { IFileService } from '../../../../platform/files/common/files.js';
 import { IDialogService } from '../../../../platform/dialogs/common/dialogs.js';
 import { ISharedWebContentExtractorService } from '../../../../platform/webContentExtractor/common/webContentExtractor.js';

src/vs/workbench/contrib/chat/browser/chatAttachmentModel/chatPromptAttachmentModel.ts

@@ -3,19 +3,19 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { CancelablePromise, createCancelablePromise } from '../../../../../base/common/async.js';
 import { Emitter } from '../../../../../base/common/event.js';
 import { Disposable } from '../../../../../base/common/lifecycle.js';
 import { ResourceMap } from '../../../../../base/common/map.js';
+import { URI } from '../../../../../base/common/uri.js';
 import { ILanguageService } from '../../../../../editor/common/languages/language.js';
 import { IModelService } from '../../../../../editor/common/services/model.js';
-import { IInstantiationService } from '../../../../../platform/instantiation/common/instantiation.js';
 import { IChatRequestVariableEntry, IPromptFileVariableEntry, toPromptFileVariableEntry } from '../../common/chatVariableEntries.js';
-
-import { ChatPromptAttachmentModel } from './chatPromptAttachmentModel.js';
+import { IPromptParserResult, IPromptsService } from '../../common/promptSyntax/service/promptsService.js';
 
 /**
  * Model for a collection of prompt instruction attachments.
- * See {@linkcode ChatPromptAttachmentModel} for individual attachment.
+ * Starts
  */
 export class ChatPromptAttachmentsCollection extends Disposable {
 	/**
@@ -24,29 +24,38 @@ export class ChatPromptAttachmentsCollection extends Disposable {
 	 * See {@linkcode onUpdate}.
 	 */
 	protected _onUpdate = this._register(new Emitter<IPromptFileVariableEntry>());
+
 	/**
 	 * Subscribe to the `onUpdate` event.
 	 */
 	public onUpdate = this._onUpdate.event;
 
-
 	/**
 	 * List of all prompt instruction attachments.
 	 */
-	private _attachments: ResourceMap<ChatPromptAttachmentModel> = new ResourceMap<ChatPromptAttachmentModel>();
+	private _attachments = new ResourceMap<CancelablePromise<IPromptParserResult>>();
+
+
+	constructor(
+		@ILanguageService private readonly languageService: ILanguageService,
+		@IModelService private readonly modelService: IModelService,
+		@IPromptsService private readonly promptsService: IPromptsService,
+	) {
+		super();
+	}
 
 	/**
 	 * Check if any of the attachments is a prompt file.
 	 */
 	public hasPromptFiles(promptFileLanguageId: string): boolean {
-		const hasLanguage = ({ uri }: ChatPromptAttachmentModel) => {
+		const hasLanguage = (uri: URI) => {
 			const model = this.modelService.getModel(uri);
 			const languageId = model ? model.getLanguageId() : this.languageService.guessLanguageIdByFilepathOrFirstLine(uri);
 			return languageId === promptFileLanguageId;
 		};
 
-		for (const child of this._attachments.values()) {
-			if (hasLanguage(child)) {
+		for (const uri of this._attachments.keys()) {
+			if (hasLanguage(uri)) {
 				return true;
 			}
 		}
@@ -58,51 +67,25 @@ export class ChatPromptAttachmentsCollection extends Disposable {
 	 * nested child references of each attachment explicitly attached by user.
 	 */
 	public async getAttachments(): Promise<readonly IChatRequestVariableEntry[]> {
-		await this.allSettled();
-
 		const result = [];
 		const attachments = [...this._attachments.values()];
 
-		for (const attachment of attachments) {
-			const { reference } = attachment;
+		for (const parseResultPromise of attachments) {
+			const parseResult = await parseResultPromise;
 
 			// the usual URIs list of prompt instructions is `bottom-up`, therefore
 			// we do the same here - first add all child references of the model
-			result.push(
-				...reference.allValidReferences.map((link) => {
-					return toPromptFileVariableEntry(link.uri, false);
-				}),
-			);
+			for (const uri of parseResult.allValidReferences) {
+				result.push(toPromptFileVariableEntry(uri, false));
+			}
 
 			// then add the root reference of the model itself
-			result.push(toPromptFileVariableEntry(reference.uri, true));
+			result.push(toPromptFileVariableEntry(parseResult.uri, true));
 		}
 
 		return result;
 	}
 
-	/**
-	 * Promise that resolves when parsing of all attached prompt instruction
-	 * files completes, including parsing of all its possible child references.
-	 */
-	async allSettled(): Promise<void> {
-		const attachments = [...this._attachments.values()];
-
-		await Promise.allSettled(
-			attachments.map((attachment) => {
-				return attachment.allSettled;
-			}),
-		);
-	}
-
-	constructor(
-		@IInstantiationService private readonly instantiationService: IInstantiationService,
-		@ILanguageService private readonly languageService: ILanguageService,
-		@IModelService private readonly modelService: IModelService,
-	) {
-		super();
-	}
-
 	/**
 	 * Add prompt instruction attachment instances
 	 */
@@ -115,8 +98,15 @@ export class ChatPromptAttachmentsCollection extends Disposable {
 				continue;
 			}
 
-			const instruction = this.instantiationService.createInstance(ChatPromptAttachmentModel, uri, () => this._onUpdate.fire(entry));
-			this._attachments.set(uri, instruction);
+			const parseResult = createCancelablePromise(token => this.promptsService.parse(uri, token));
+			parseResult.then(() => {
+				this._onUpdate.fire(entry);
+			}).catch((error) => {
+				// if parsing fails, we still create an attachment model
+				// to allow the user to see the error and fix it
+				console.error(`Failed to parse prompt file ${uri.toString()}:`, error);
+			});
+			this._attachments.set(uri, parseResult);
 		}
 	}
 
@@ -129,7 +119,7 @@ export class ChatPromptAttachmentsCollection extends Disposable {
 		const attachment = this._attachments.get(uri);
 		if (attachment) {
 			this._attachments.delete(uri);
-			attachment.dispose();
+			attachment.cancel();
 		}
 
 		return this;
@@ -140,7 +130,7 @@ export class ChatPromptAttachmentsCollection extends Disposable {
 	 */
 	public clear(): this {
 		for (const attachment of this._attachments.values()) {
-			attachment.dispose();
+			attachment.cancel();
 		}
 		this._attachments.clear();
 

src/vs/workbench/contrib/chat/browser/chatAttachmentModel/chatPromptAttachmentsCollection.ts renamed to src/vs/workbench/contrib/chat/browser/chatAttachmentModel/chatPromptAttachments.ts

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

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

@@ -3,6 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { CancellationToken } from '../../../../base/common/cancellation.js';
 import { Emitter, Event } from '../../../../base/common/event.js';
 import { Disposable } from '../../../../base/common/lifecycle.js';
 import { localize } from '../../../../nls.js';
@@ -49,7 +50,7 @@ export class ChatModeService extends Disposable implements IChatModeService {
 
 	private async refreshCustomPromptModes(fireChangeEvent?: boolean): Promise<void> {
 		try {
-			const modes = await this.promptsService.getCustomChatModes();
+			const modes = await this.promptsService.getCustomChatModes(CancellationToken.None);
 			this.latestCustomPromptModes = modes.map(customMode => new CustomChatMode(customMode));
 			this.hasCustomModes.set(modes.length > 0);
 			if (fireChangeEvent) {

src/vs/workbench/contrib/chat/common/chatModes.ts

@@ -179,14 +179,14 @@ export abstract class PromptContentsProviderBase<
 	/**
 	 * Start producing the prompt contents data.
 	 */
-	public start(): this {
+	public start(token?: CancellationToken): this {
 		assert(
 			!this.isDisposed,
 			'Cannot start contents provider that was already disposed.',
 		);
 
 		// `'full'` means "everything has changed"
-		this.onContentsChanged('full');
+		this.onContentsChanged('full', token);
 
 		// subscribe to the change event emitted by a child class
 		this._register(this.onChangeEmitter.event(this.onContentsChanged, this));

src/vs/workbench/contrib/chat/common/promptSyntax/contentProviders/promptContentsProviderBase.ts

@@ -9,6 +9,7 @@ import { ResolveError } from '../../promptFileReferenceErrors.js';
 import { IDisposable } from '../../../../../../base/common/lifecycle.js';
 import { VSBufferReadableStream } from '../../../../../../base/common/buffer.js';
 import { PromptsType } from '../promptTypes.js';
+import { CancellationToken } from '../../../../../../base/common/cancellation.js';
 
 /**
  * Interface for a prompt contents provider. Prompt contents providers are
@@ -56,7 +57,7 @@ export interface IPromptContentsProvider extends IDisposable {
 	/**
 	 * Start the contents provider to produce the underlying contents.
 	 */
-	start(): this;
+	start(token?: CancellationToken): this;
 
 	/**
 	 * Create a new instance of prompt contents provider.

src/vs/workbench/contrib/chat/common/promptSyntax/contentProviders/types.ts

@@ -42,7 +42,7 @@ 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()
+			.start(token)
 			.settled();
 
 		// validate that the cancellation was not yet requested

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

@@ -138,7 +138,7 @@ 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()
+			.start(token)
 			.settled();
 
 		// validate that the cancellation was not yet requested

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

@@ -39,6 +39,7 @@ import { isPromptOrInstructionsFile } from '../config/promptFileLocations.js';
 import { FrontMatterHeader } from '../codecs/base/markdownExtensionsCodec/tokens/frontMatterHeader.js';
 import { OpenFailed, NotPromptFile, RecursiveReference, FolderReference, ResolveError } from '../../promptFileReferenceErrors.js';
 import { type IPromptContentsProviderOptions, DEFAULT_OPTIONS as CONTENTS_PROVIDER_DEFAULT_OPTIONS } from '../contentProviders/promptContentsProviderBase.js';
+import { CancellationToken } from '../../../../../../base/common/cancellation.js';
 
 /**
  * Options of the {@link BasePromptParser} class.
@@ -511,7 +512,7 @@ export class BasePromptParser<TContentsProvider extends IPromptContentsProvider>
 	/**
 	 * Start the prompt parser.
 	 */
-	public start(): this {
+	public start(token?: CancellationToken): this {
 		// if already started, nothing to do
 		if (this.started) {
 			return this;
@@ -525,7 +526,7 @@ export class BasePromptParser<TContentsProvider extends IPromptContentsProvider>
 			return this;
 		}
 
-		this.promptContentsProvider.start();
+		this.promptContentsProvider.start(token);
 		return this;
 	}