Updates explain branch

- improves markdown format
- moves prepareCompareDataForAIRequest out of AIProviderService

Author: d13

src/commands/explainBranch.ts

@@ -5,6 +5,7 @@ import { GitUri } from '../git/gitUri';
 import type { GitBranch } from '../git/models/branch';
 import { showGenericErrorMessage } from '../messages';
 import type { AIExplainSource } from '../plus/ai/aiProviderService';
+import { prepareCompareDataForAIRequest } from '../plus/ai/aiProviderService';
 import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
 import { command } from '../system/-webview/command';
@@ -59,7 +60,7 @@ export class ExplainBranchCommand extends GlCommandBase {
 		if (repository == null) return;
 
 		try {
-			//// Clarifying the head branch
+			// Clarifying the head branch
 			if (args.ref == null) {
 				// If no ref is provided, show a picker to select a branch
 				const pick = await showReferencePicker(
@@ -82,27 +83,20 @@ export class ExplainBranchCommand extends GlCommandBase {
 				return;
 			}
 
-			//// Clarifying the base branch
+			// Clarifying the base branch
 			const baseBranchName = await getMergeTarget(this.container, branch);
 			const baseBranch = await repository.git.branches().getBranch(baseBranchName);
 			if (!baseBranch) {
-				void showGenericErrorMessage(
-					'Unable to find the base branch for the specified branch. Probably it is undefined. Set it up and try again.',
-				);
+				void showGenericErrorMessage(`Unable to find the base branch for ${branch.name}.`);
 				return;
 			}
 
 			// Get the diff between the branch and its upstream or base
-			const compareData = await this.container.ai.prepareCompareDataForAIRequest(
-				repository,
-				branch.ref,
-				baseBranch.ref,
-				{
-					reportNoDiffService: () => void showGenericErrorMessage('Unable to get diff service'),
-					reportNoCommitsService: () => void showGenericErrorMessage('Unable to get commits service'),
-					reportNoChanges: () => void showGenericErrorMessage('No changes found to explain'),
-				},
-			);
+			const compareData = await prepareCompareDataForAIRequest(repository, branch.ref, baseBranch.ref, {
+				reportNoDiffService: () => void showGenericErrorMessage('Unable to get diff service'),
+				reportNoCommitsService: () => void showGenericErrorMessage('Unable to get commits service'),
+				reportNoChanges: () => void showGenericErrorMessage('No changes found to explain'),
+			});
 
 			if (compareData == null) {
 				return;
@@ -129,16 +123,14 @@ export class ExplainBranchCommand extends GlCommandBase {
 				},
 			);
 
-			// Display the result
-			let content = `# Branch: ${branch.name}\n`;
-			if (result != null) {
-				content += `> Generated by ${result.model.name}\n\n----\n\n${result?.parsed.summary}\n\n${result?.parsed.body}`;
-			} else {
-				content += `> No changes found to explain.`;
+			if (result == null) {
+				void showGenericErrorMessage(`Unable to explain branch ${branch.name}`);
+				return;
 			}
-			// Add changes temporarily for debug purposes, so it's easier to review what content has been explained
-			const changesMd = `${changes.message}\n\n${changes.diff}`;
-			void showMarkdownPreview(`${content}\n\n\`\`\`\n${changesMd.replaceAll('`', '')}\n\`\`\`\n`);
+
+			const content = `# Branch Summary\n\n> Generated by ${result.model.name}\n\n## ${branch.name}\n\n${result?.parsed.summary}\n\n${result?.parsed.body}`;
+
+			void showMarkdownPreview(content);
 		} catch (ex) {
 			Logger.error(ex, 'ExplainBranchCommand', 'execute');
 			void showGenericErrorMessage('Unable to explain branch');

src/plus/ai/aiProviderService.ts

@@ -626,63 +626,6 @@ export class AIProviderService implements Disposable {
 		return result != null ? { ...result, parsed: parseSummarizeResult(result.content) } : undefined;
 	}
 
-	async prepareCompareDataForAIRequest(
-		repo: Repository,
-		headRef: string,
-		baseRef: string,
-		options?: {
-			cancellation?: CancellationToken;
-			reportNoDiffService?: () => void;
-			reportNoCommitsService?: () => void;
-			reportNoChanges?: () => void;
-		},
-	): Promise<{ diff: string; logMessages: string } | undefined> {
-		const { cancellation, reportNoDiffService, reportNoCommitsService, reportNoChanges } = options ?? {};
-		const diffService = repo.git.diff();
-		if (diffService?.getDiff === undefined) {
-			if (reportNoDiffService) {
-				reportNoDiffService();
-				return;
-			}
-		}
-
-		const commitsService = repo.git.commits();
-		if (commitsService?.getLog === undefined) {
-			if (reportNoCommitsService) {
-				reportNoCommitsService();
-				return;
-			}
-		}
-
-		const [diffResult, logResult] = await Promise.allSettled([
-			diffService.getDiff?.(headRef, baseRef, { notation: '...' }),
-			commitsService.getLog(`${baseRef}..${headRef}`),
-		]);
-		const diff = getSettledValue(diffResult);
-		const log = getSettledValue(logResult);
-
-		if (!diff?.contents || !log?.commits?.size) {
-			reportNoChanges?.();
-			return undefined;
-		}
-
-		if (cancellation?.isCancellationRequested) throw new CancellationError();
-
-		const commitMessages: string[] = [];
-		for (const commit of [...log.commits.values()].sort((a, b) => a.date.getTime() - b.date.getTime())) {
-			const message = commit.message ?? commit.summary;
-			if (message) {
-				commitMessages.push(
-					`<commit-message ${commit.date.toISOString()}>\n${
-						commit.message ?? commit.summary
-					}\n<end-of-commit-message>`,
-				);
-			}
-		}
-
-		return { diff: diff.contents, logMessages: commitMessages.join('\n\n') };
-	}
-
 	async generateCreatePullRequest(
 		repo: Repository,
 		baseRef: string,
@@ -698,7 +641,7 @@ export class AIProviderService implements Disposable {
 		const result = await this.sendRequest(
 			'generate-create-pullRequest',
 			async (model, reporting, cancellation, maxInputTokens, retries) => {
-				const compareData = await this.prepareCompareDataForAIRequest(repo, headRef, baseRef, {
+				const compareData = await prepareCompareDataForAIRequest(repo, headRef, baseRef, {
 					cancellation: cancellation,
 				});
 
@@ -1452,3 +1395,60 @@ function isPrimaryAIProvider(provider: AIProviders): provider is AIPrimaryProvid
 function isPrimaryAIProviderModel(model: AIModel): model is AIModel<AIPrimaryProviders, AIProviderAndModel> {
 	return isPrimaryAIProvider(model.provider.id);
 }
+
+export async function prepareCompareDataForAIRequest(
+	repo: Repository,
+	headRef: string,
+	baseRef: string,
+	options?: {
+		cancellation?: CancellationToken;
+		reportNoDiffService?: () => void;
+		reportNoCommitsService?: () => void;
+		reportNoChanges?: () => void;
+	},
+): Promise<{ diff: string; logMessages: string } | undefined> {
+	const { cancellation, reportNoDiffService, reportNoCommitsService, reportNoChanges } = options ?? {};
+	const diffService = repo.git.diff();
+	if (diffService?.getDiff === undefined) {
+		if (reportNoDiffService) {
+			reportNoDiffService();
+			return;
+		}
+	}
+
+	const commitsService = repo.git.commits();
+	if (commitsService?.getLog === undefined) {
+		if (reportNoCommitsService) {
+			reportNoCommitsService();
+			return;
+		}
+	}
+
+	const [diffResult, logResult] = await Promise.allSettled([
+		diffService.getDiff?.(headRef, baseRef, { notation: '...' }),
+		commitsService.getLog(`${baseRef}..${headRef}`),
+	]);
+	const diff = getSettledValue(diffResult);
+	const log = getSettledValue(logResult);
+
+	if (!diff?.contents || !log?.commits?.size) {
+		reportNoChanges?.();
+		return undefined;
+	}
+
+	if (cancellation?.isCancellationRequested) throw new CancellationError();
+
+	const commitMessages: string[] = [];
+	for (const commit of [...log.commits.values()].sort((a, b) => a.date.getTime() - b.date.getTime())) {
+		const message = commit.message ?? commit.summary;
+		if (message) {
+			commitMessages.push(
+				`<commit-message ${commit.date.toISOString()}>\n${
+					commit.message ?? commit.summary
+				}\n<end-of-commit-message>`,
+			);
+		}
+	}
+
+	return { diff: diff.contents, logMessages: commitMessages.join('\n\n') };
+}