add id to Inspection and migrate to stable vscode.llm api. (#1332)

wangmingliang-ms · web-flow · commit d6f749c90f58 · 2024-05-21T11:18:28.000+08:00
* add `id` to `Inspection`

* migrate to stable APIs
diff --git a/package.json b/package.json
@@ -38,9 +38,6 @@
   "capabilities": {
     "virtualWorkspaces": false
   },
-  "enabledApiProposals": [
-    "languageModels"
-  ],
   "activationEvents": [
     "onLanguage:java",
     "workspaceContains:pom.xml",
diff --git a/src/copilot/Copilot.ts b/src/copilot/Copilot.ts
@@ -1,16 +1,16 @@
-import { LanguageModelChatMessage, LanguageModelChatUserMessage, LanguageModelChatAssistantMessage, lm, Disposable, CancellationToken, LanguageModelChatRequestOptions } from "vscode";
+import { LanguageModelChatMessage, lm, Disposable, CancellationToken, LanguageModelChatRequestOptions, LanguageModelChatMessageRole, LanguageModelChatSelector } from "vscode";
 import { instrumentSimpleOperation, sendInfo } from "vscode-extension-telemetry-wrapper";
 import { logger } from "./utils";
 
 export default class Copilot {
     public static readonly DEFAULT_END_MARK = '<|endofresponse|>';
     public static readonly DEFAULT_MAX_ROUNDS = 10;
-    public static readonly DEFAULT_MODEL = 'copilot-gpt-4';
+    public static readonly DEFAULT_MODEL = { family: 'gpt-4' };
     public static readonly DEFAULT_MODEL_OPTIONS: LanguageModelChatRequestOptions = { modelOptions: {} };
     public static readonly NOT_CANCELLABEL: CancellationToken = { isCancellationRequested: false, onCancellationRequested: () => Disposable.from() };
 
     public constructor(
-        private readonly model: string = Copilot.DEFAULT_MODEL,
+        private readonly modelSelector: LanguageModelChatSelector = Copilot.DEFAULT_MODEL,
         private readonly modelOptions: LanguageModelChatRequestOptions = Copilot.DEFAULT_MODEL_OPTIONS,
         private readonly maxRounds: number = Copilot.DEFAULT_MAX_ROUNDS,
         private readonly endMark: string = Copilot.DEFAULT_END_MARK
@@ -29,20 +29,24 @@ export default class Copilot {
         const _send = async (message: string): Promise<boolean> => {
             rounds++;
             logger.info(`User: \n`, message);
-            messages.push(new LanguageModelChatUserMessage(message));
+            messages.push(new LanguageModelChatMessage(LanguageModelChatMessageRole.User, message));
             logger.info('Copilot: thinking...');
 
             let rawAnswer: string = '';
             try {
-                const response = await lm.sendChatRequest(this.model, messages, modelOptions ?? this.modelOptions, cancellationToken);
-                for await (const item of response.stream) {
+                const model = (await lm.selectChatModels(this.modelSelector))?.[0];
+                if (!model) {
+                    throw new Error('No model selected');
+                }
+                const response = await model.sendRequest(messages, modelOptions ?? this.modelOptions, cancellationToken);
+                for await (const item of response.text) {
                     rawAnswer += item;
                 }
             } catch (e) {
                 logger.error(`Failed to send request to copilot`, e);
                 throw new Error(`Failed to send request to copilot: ${e}`);
             }
-            messages.push(new LanguageModelChatAssistantMessage(rawAnswer));
+            messages.push(new LanguageModelChatMessage(LanguageModelChatMessageRole.Assistant, rawAnswer));
             logger.info(`Copilot: \n`, rawAnswer);
             answer += rawAnswer;
             return answer.trim().endsWith(this.endMark);
diff --git a/src/copilot/inspect/DocumentRenderer.ts b/src/copilot/inspect/DocumentRenderer.ts
@@ -13,7 +13,7 @@ import InspectionCache from "./InspectionCache";
 
 /**
  * `DocumentRenderer` is responsible for 
- * - managing `Rewrite with new syntax` code lenses renderer
+ * - managing `Rewrite with new Java syntax` code lenses renderer
  * - managing inspection renderers based on settings
  * - rendering inspections for a document
  */
diff --git a/src/copilot/inspect/InspectActionCodeLensProvider.ts b/src/copilot/inspect/InspectActionCodeLensProvider.ts
@@ -22,7 +22,7 @@ export class InspectActionCodeLensProvider implements CodeLensProvider {
         const topLevelCodeLenses: CodeLens[] = [];
         const classes = await getTopLevelClassesOfDocument(document);
         classes.map(clazz => new CodeLens(clazz.range, {
-            title: "Rewrite with new syntax",
+            title: "Rewrite with new Java syntax",
             command: COMMAND_INSPECT_CLASS,
             arguments: [document, clazz]
         })).forEach(codeLens => topLevelCodeLenses.push(codeLens));
diff --git a/src/copilot/inspect/Inspection.ts b/src/copilot/inspect/Inspection.ts
@@ -27,6 +27,7 @@ export interface InspectionProblem {
 }
 
 export interface Inspection {
+    id: string;
     document?: TextDocument;
     symbol?: SymbolNode;
     problem: InspectionProblem;
diff --git a/src/copilot/inspect/InspectionCopilot.ts b/src/copilot/inspect/InspectionCopilot.ts
@@ -3,10 +3,11 @@ import Copilot from "../Copilot";
 import { getClassesContainedInRange, getInnermostClassContainsRange, getIntersectionMethodsOfRange, getProjectJavaVersion, getUnionRange, logger } from "../utils";
 import { Inspection } from "./Inspection";
 import path from "path";
-import { TextDocument, SymbolKind, ProgressLocation, commands, Position, Range, Selection, window, LanguageModelChatSystemMessage, LanguageModelChatMessage, LanguageModelChatUserMessage, LanguageModelChatAssistantMessage } from "vscode";
+import { TextDocument, SymbolKind, ProgressLocation, commands, Position, Range, Selection, window, LanguageModelChatMessage, LanguageModelChatMessageRole } from "vscode";
 import { COMMAND_FIX_INSPECTION } from "./commands";
 import InspectionCache from "./InspectionCache";
 import { SymbolNode } from "./SymbolNode";
+import { randomUUID } from "crypto";
 
 export default class InspectionCopilot extends Copilot {
 
@@ -242,9 +243,9 @@ export default class InspectionCopilot extends Copilot {
         }
 
         const messages: LanguageModelChatMessage[] = [
-            new LanguageModelChatSystemMessage(InspectionCopilot.SYSTEM_MESSAGE(context)),
-            new LanguageModelChatUserMessage(InspectionCopilot.EXAMPLE_USER_MESSAGE),
-            new LanguageModelChatAssistantMessage(InspectionCopilot.EXAMPLE_ASSISTANT_MESSAGE),
+            LanguageModelChatMessage.User(InspectionCopilot.SYSTEM_MESSAGE(context)),
+            LanguageModelChatMessage.User(InspectionCopilot.EXAMPLE_USER_MESSAGE),
+            LanguageModelChatMessage.Assistant(InspectionCopilot.EXAMPLE_ASSISTANT_MESSAGE),
         ];
         const codeWithInspectionComments = await this.send(messages, codeLinesContent);
         const inspections = this.extractInspections(codeWithInspectionComments, codeLines);
@@ -254,7 +255,10 @@ export default class InspectionCopilot extends Copilot {
             codeLength: code.length,
             codeLines: codeLines.length,
             insectionsCount: inspections.length,
-            problems: inspections.map(i => i.problem.description).join(',')
+            inspections: `[${inspections.map(i => JSON.stringify({
+                problem: i.problem.description,
+                solution: i.solution,
+            })).join(',')}]`,
         });
         return inspections;
     }
@@ -296,6 +300,7 @@ export default class InspectionCopilot extends Copilot {
      */
     private extractInspection(index: number, lines: string[]): Inspection {
         const inspection: Inspection = {
+            id: randomUUID().toString(),
             problem: {
                 description: '',
                 position: { line: -1, relativeLine: -1, code: '' },
diff --git a/src/copilot/inspect/index.ts b/src/copilot/inspect/index.ts
@@ -35,7 +35,7 @@ export function doActivate(context: ExtensionContext): void {
 
 async function rewrite(document: TextDocument, range: Range | Selection, _context: CodeActionContext, _token: CancellationToken): Promise<CodeAction[]> {
     const action: CodeAction = {
-        title: "Rewrite with new syntax",
+        title: "Rewrite with new Java syntax",
         kind: CodeActionKind.RefactorRewrite,
         command: {
             title: "Rewrite selected code",
diff --git a/src/copilot/inspect/render/CodeLensRenderer.ts b/src/copilot/inspect/render/CodeLensRenderer.ts
@@ -1,13 +1,14 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-import { CodeLens, CodeLensProvider, Disposable, Event, EventEmitter, ExtensionContext, TextDocument, Uri, languages } from "vscode";
+import { CodeLens, CodeLensProvider, Command, Range, Disposable, Event, EventEmitter, ExtensionContext, TextDocument, Uri, languages } from "vscode";
 import { Inspection } from "../Inspection";
 import { InspectionRenderer } from "./InspectionRenderer";
 import { logger, uncapitalize } from "../../../copilot/utils";
 import { COMMAND_IGNORE_INSPECTIONS, COMMAND_FIX_INSPECTION } from "../commands";
 import { capitalize } from "lodash";
+import _ from "lodash";
 
 export class CodeLensRenderer implements InspectionRenderer {
-    private readonly codeLenses: Map<Uri, CodeLens[]> = new Map();
+    private readonly codeLenses: Map<Uri, InspectionCodeLens[]> = new Map();
     private readonly provider = new InspectionCodeLensProvider(this.codeLenses);
     private disposableRegistry: Disposable | undefined;
 
@@ -41,27 +42,28 @@ export class CodeLensRenderer implements InspectionRenderer {
         if (inspections.length < 1 || !this.codeLenses) {
             return;
         }
-        const newCodeLenses: CodeLens[] = inspections.flatMap(s => CodeLensRenderer.toCodeLenses(document, s));
-        const newCodeLensesMessages = newCodeLenses.map(c => c.command?.title.trim());
-        const existingCodeLenses = this.codeLenses.get(document.uri) ?? [];
-        const leftCodeLenses = existingCodeLenses.filter(c => !newCodeLensesMessages.includes(c.command?.title.trim()));
-        newCodeLenses.push(...leftCodeLenses);
-        this.codeLenses.set(document.uri, newCodeLenses);
+        const oldItems = this.codeLenses.get(document.uri) ?? [];
+        const oldIds: string[] = _.uniq(oldItems).map(c => c.inspection.id);
+        const newIds: string[] = inspections.map(i => i.id);
+        const toKeep: InspectionCodeLens[] = _.intersection(oldIds, newIds).map(id => oldItems.find(c => c.inspection.id === id)!) ?? [];
+        const toAdd: InspectionCodeLens[] = _.difference(newIds, oldIds).map(id => inspections.find(i => i.id === id)!)
+            .flatMap(i => CodeLensRenderer.toCodeLenses(document, i));
+        this.codeLenses.set(document.uri, [...toKeep, ...toAdd]);
         this.provider.refresh();
     }
 
-    private static toCodeLenses(document: TextDocument, inspection: Inspection): CodeLens[] {
+    private static toCodeLenses(document: TextDocument, inspection: Inspection): InspectionCodeLens[] {
         const codeLenses = [];
         const range = Inspection.getIndicatorRangeOfInspection(inspection.problem);
-        const inspectionCodeLens = new CodeLens(range, {
+        const inspectionCodeLens = new InspectionCodeLens(inspection, range, {
             title: capitalize(inspection.solution),
             tooltip: inspection.problem.description,
             command: COMMAND_FIX_INSPECTION,
             arguments: [inspection.problem, inspection.solution, 'codelenses']
         });
         codeLenses.push(inspectionCodeLens);
 
-        const ignoreCodeLens = new CodeLens(range, {
+        const ignoreCodeLens = new InspectionCodeLens(inspection, range, {
             title: 'Ignore',
             tooltip: `Ignore "${uncapitalize(inspection.problem.description)}"`,
             command: COMMAND_IGNORE_INSPECTIONS,
@@ -72,6 +74,12 @@ export class CodeLensRenderer implements InspectionRenderer {
     }
 }
 
+class InspectionCodeLens extends CodeLens {
+    public constructor(public readonly inspection: Inspection, range: Range, command?: Command) {
+        super(range, command);
+    }
+}
+
 class InspectionCodeLensProvider implements CodeLensProvider {
     private readonly emitter: EventEmitter<void> = new EventEmitter<void>();
     public readonly onDidChangeCodeLenses: Event<void> = this.emitter.event;
diff --git a/src/copilot/inspect/render/DiagnosticRenderer.ts b/src/copilot/inspect/render/DiagnosticRenderer.ts
@@ -4,6 +4,7 @@ import { Inspection } from "../Inspection";
 import { InspectionRenderer } from "./InspectionRenderer";
 import { logger, uncapitalize } from "../../../copilot/utils";
 import { COMMAND_IGNORE_INSPECTIONS, COMMAND_FIX_INSPECTION } from "../commands";
+import _ from "lodash";
 
 const DIAGNOSTICS_GROUP = 'java.copilot.inspection.diagnostics';
 
@@ -38,22 +39,21 @@ export class DiagnosticRenderer implements InspectionRenderer {
         if (inspections.length < 1 || !this.diagnostics) {
             return;
         }
-        const newDiagnostics: Diagnostic[] = inspections.map(s => DiagnosticRenderer.toDiagnostic(s));
-        const newDiagnosticsMessages = newDiagnostics.map(d => d.message.trim());
-        const existingDiagnostics = this.diagnostics.get(document.uri) ?? [];
-        const leftDiagnostics = existingDiagnostics.filter(d => !newDiagnosticsMessages.includes(d.message.trim()));
-        newDiagnostics.push(...leftDiagnostics);
-        this.diagnostics.set(document.uri, newDiagnostics);
+        const oldItems: readonly InspectionDiagnostic[] = (this.diagnostics.get(document.uri) ?? []) as InspectionDiagnostic[];
+        const oldIds: string[] = _.uniq(oldItems).map(c => c.inspection.id);
+        const newIds: string[] = inspections.map(i => i.id);
+        const toKeep: InspectionDiagnostic[] = _.intersection(oldIds, newIds).map(id => oldItems.find(c => c.inspection.id === id)!) ?? [];
+        const toAdd: InspectionDiagnostic[] = _.difference(newIds, oldIds).map(id => inspections.find(i => i.id === id)!).map(i => new InspectionDiagnostic(i));
+        this.diagnostics.set(document.uri, [...toKeep, ...toAdd]);
     }
+}
 
-    private static toDiagnostic(inspection: Inspection): Diagnostic {
+class InspectionDiagnostic extends Diagnostic {
+    public constructor(public readonly inspection: Inspection) {
         const range = Inspection.getIndicatorRangeOfInspection(inspection.problem);
         const severiy = inspection.severity.toUpperCase() === 'HIGH' ? DiagnosticSeverity.Information : DiagnosticSeverity.Hint;
-        const diagnostic = new Diagnostic(range, inspection.problem.description, severiy);
-        diagnostic.source = DIAGNOSTICS_GROUP;
-        //@ts-ignore
-        diagnostic.additional = inspection;
-        return diagnostic;
+        super(range, inspection.problem.description, severiy);
+        this.source = DIAGNOSTICS_GROUP;
     }
 }
 
@@ -66,9 +66,7 @@ export async function fixDiagnostic(document: TextDocument, _range: Range | Sele
         if (diagnostic.source !== DIAGNOSTICS_GROUP) {
             continue;
         }
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        const inspection: Inspection = diagnostic.additional as Inspection;
+        const inspection: Inspection = (diagnostic as InspectionDiagnostic).inspection as Inspection;
         const fixAction: CodeAction = {
             title: inspection.solution,
             diagnostics: [diagnostic],
diff --git a/src/copilot/inspect/render/GutterIconRenderer.ts b/src/copilot/inspect/render/GutterIconRenderer.ts
@@ -5,9 +5,10 @@ import { InspectionRenderer } from "./InspectionRenderer";
 import { logger } from "../../../copilot/utils";
 import path = require("path");
 import { COMMAND_FIX_INSPECTION } from "../commands";
+import _ from "lodash";
 
 export class GutterIconRenderer implements InspectionRenderer {
-    private readonly gutterIcons: Map<Uri, GutterIcon[]> = new Map();
+    private readonly gutterIcons: Map<Uri, InspectionGutterIcon[]> = new Map();
     private gutterIconDecorationType: TextEditorDecorationType | undefined;
 
     public install(context: ExtensionContext): InspectionRenderer {
@@ -46,17 +47,19 @@ export class GutterIconRenderer implements InspectionRenderer {
         if (inspections.length < 1 || !editor || !this.gutterIconDecorationType) {
             return;
         }
-        const newGutterIcons: GutterIcon[] = inspections.map(s => GutterIconRenderer.toGutterIcon(s));
-        const newGutterIconsMessages = newGutterIcons.map(d => d.inspection.solution.trim());
-        const existingGutterIcons = this.gutterIcons.get(document.uri) ?? [];
-        const leftGutterIcons = existingGutterIcons.filter(d => !newGutterIconsMessages.includes(d.inspection.solution.trim()));
-        newGutterIcons.push(...leftGutterIcons);
+
+        const oldItems: readonly InspectionGutterIcon[] = this.gutterIcons.get(document.uri) ?? [];
+        const oldIds: string[] = _.uniq(oldItems).map(c => c.inspection.id);
+        const newIds: string[] = inspections.map(i => i.id);
+        const toKeep: InspectionGutterIcon[] = _.intersection(oldIds, newIds).map(id => oldItems.find(c => c.inspection.id === id)!) ?? [];
+        const toAdd: InspectionGutterIcon[] = _.difference(newIds, oldIds).map(id => inspections.find(i => i.id === id)!).map(i => GutterIconRenderer.toGutterIcon(i));
+        const newGutterIcons: InspectionGutterIcon[] = [...toKeep, ...toAdd];
         this.gutterIcons.set(document.uri, newGutterIcons);
 
         editor.setDecorations(this.gutterIconDecorationType, newGutterIcons);
     }
 
-    private static toGutterIcon(inspection: Inspection): GutterIcon {
+    private static toGutterIcon(inspection: Inspection): InspectionGutterIcon {
         const range = Inspection.getIndicatorRangeOfInspection(inspection.problem);
         const args = [inspection.problem, inspection.solution, 'guttericons'];
         const commandUri = Uri.parse(`command:${COMMAND_FIX_INSPECTION}?${encodeURIComponent(JSON.stringify(args))}`);
@@ -66,6 +69,6 @@ export class GutterIconRenderer implements InspectionRenderer {
     }
 }
 
-interface GutterIcon extends DecorationOptions {
+interface InspectionGutterIcon extends DecorationOptions {
     inspection: Inspection;
 }
diff --git a/src/copilot/inspect/render/RulerHighlightRenderer.ts b/src/copilot/inspect/render/RulerHighlightRenderer.ts
@@ -3,9 +3,10 @@ import { DecorationOptions, ExtensionContext, OverviewRulerLane, TextDocument, T
 import { Inspection } from "../Inspection";
 import { InspectionRenderer } from "./InspectionRenderer";
 import { logger } from "../../../copilot/utils";
+import _ from "lodash";
 
 export class RulerHighlightRenderer implements InspectionRenderer {
-    private readonly rulerHighlights: Map<Uri, RulerHighlight[]> = new Map();
+    private readonly rulerHighlights: Map<Uri, InspectionRulerHighlight[]> = new Map();
     private rulerDecorationType: TextEditorDecorationType | undefined;
 
     public install(_context: ExtensionContext): InspectionRenderer {
@@ -44,22 +45,23 @@ export class RulerHighlightRenderer implements InspectionRenderer {
         if (inspections.length < 1 || !editor || !this.rulerDecorationType) {
             return;
         }
-        const newRulerHightlights: RulerHighlight[] = inspections.map(s => RulerHighlightRenderer.toRulerHighlight(s));
-        const newRulerHighlightsMessages = newRulerHightlights.map(d => d.inspection.solution.trim());
-        const existingRulerHighlights = this.rulerHighlights.get(document.uri) ?? [];
-        const leftRulerHighlights = existingRulerHighlights.filter(d => !newRulerHighlightsMessages.includes(d.inspection.solution.trim()));
-        newRulerHightlights.push(...leftRulerHighlights);
+        const oldItems: readonly InspectionRulerHighlight[] = this.rulerHighlights.get(document.uri) ?? [];
+        const oldIds: string[] = _.uniq(oldItems).map(c => c.inspection.id);
+        const newIds: string[] = inspections.map(i => i.id);
+        const toKeep: InspectionRulerHighlight[] = _.intersection(oldIds, newIds).map(id => oldItems.find(c => c.inspection.id === id)!) ?? [];
+        const toAdd: InspectionRulerHighlight[] = _.difference(newIds, oldIds).map(id => inspections.find(i => i.id === id)!).map(i => RulerHighlightRenderer.toRulerHighlight(i));
+        const newRulerHightlights: InspectionRulerHighlight[] = [...toKeep, ...toAdd];
         this.rulerHighlights.set(document.uri, newRulerHightlights);
 
         editor.setDecorations(this.rulerDecorationType, newRulerHightlights);
     }
 
-    private static toRulerHighlight(inspection: Inspection): RulerHighlight {
+    private static toRulerHighlight(inspection: Inspection): InspectionRulerHighlight {
         const range = Inspection.getIndicatorRangeOfInspection(inspection.problem);
         return { range, inspection };
     }
 }
 
-interface RulerHighlight extends DecorationOptions {
+interface InspectionRulerHighlight extends DecorationOptions {
     inspection: Inspection;
 }
diff --git a/vscode.d.ts b/vscode.d.ts
diff --git a/vscode.proposed.languageModels.d.ts b/vscode.proposed.languageModels.d.ts

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ export interface InspectionProblem {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`export interface Inspection {`
	`30`	`+ id: string;`
`30`	`31`	`document?: TextDocument;`
`31`	`32`	`symbol?: SymbolNode;`
`32`	`33`	`problem: InspectionProblem;`