UX: Change export task type to java (buildArtifact) (#667)

CsCherrYY · web-flow · commit 88f7d0ffb3fe · 2022-07-25T10:46:14.000+08:00
diff --git a/package.json b/package.json
@@ -508,7 +508,7 @@
         {
           "command": "java.project.build.workspace",
           "when": "view == javaProjectExplorer && viewItem =~ /java:project(?=.*?\\b\\+java\\b)(?=.*?\\b\\+uri\\b)/",
-          "group":"8_execution@5"
+          "group": "8_execution@5"
         },
         {
           "command": "java.project.rebuild",
@@ -635,7 +635,7 @@
     ],
     "taskDefinitions": [
       {
-        "type": "java",
+        "type": "java (buildArtifact)",
         "properties": {
           "label": {
             "type": "string",
@@ -724,6 +724,64 @@
             "description": "%taskDefinitions.java.project.build.isFullBuild%"
           }
         }
+      },
+      {
+        "type": "java",
+        "when": "java:showDeprecatedTasks",
+        "properties": {
+          "label": {
+            "type": "string",
+            "description": "%taskDefinitions.java.project.exportJar.label%"
+          },
+          "mainClass": {
+            "type": "string",
+            "description": "%taskDefinitions.java.project.exportJar.mainClass%"
+          },
+          "targetPath": {
+            "type": "string",
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "enum": [
+                  "${workspaceFolder}/${workspaceFolderBasename}.jar",
+                  ""
+                ],
+                "enumDescriptions": [
+                  "%configuration.java.project.exportJar.targetPath.workspaceFolder%",
+                  "%configuration.java.project.exportJar.targetPath.select%"
+                ]
+              }
+            ],
+            "description": "%configuration.java.project.exportJar.targetPath.customization%"
+          },
+          "elements": {
+            "type": "array",
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "enum": [
+                    "${compileOutput}",
+                    "${testCompileOutput}",
+                    "${dependencies}",
+                    "${testDependencies}"
+                  ],
+                  "enumDescriptions": [
+                    "%taskDefinitions.java.project.exportJar.compileOutput%",
+                    "%taskDefinitions.java.project.exportJar.testCompileOutput%",
+                    "%taskDefinitions.java.project.exportJar.dependencies%",
+                    "%taskDefinitions.java.project.exportJar.testDependencies%"
+                  ]
+                }
+              ]
+            },
+            "description": "%taskDefinitions.java.project.exportJar.elements%"
+          }
+        }
       }
     ]
   },
diff --git a/src/commands.ts b/src/commands.ts
@@ -94,6 +94,8 @@ export namespace Commands {
 
     export const INSTALL_EXTENSION = "java.project.installExtension";
 
+    export const JAVA_UPDATE_DEPRECATED_TASK = "java.updateDeprecatedTask";
+
     /**
      * Commands from Visual Studio Code
      */
diff --git a/src/constants.ts b/src/constants.ts
@@ -7,6 +7,7 @@ export namespace Context {
     export const NO_JAVA_PROJECT: string = "java:noJavaProjects";
     export const WORKSPACE_CONTAINS_BUILD_FILES: string = "java:workspaceContainsBuildFiles";
     export const RELOAD_PROJECT_ACTIVE: string = "java:reloadProjectActive";
+    export const SHOW_DEPRECATED_TASKS: string = "java:showDeprecatedTasks";
 }
 
 export namespace Explorer {
diff --git a/src/exportJarSteps/ExportJarTaskProvider.ts b/src/exportJarSteps/ExportJarTaskProvider.ts
@@ -7,9 +7,11 @@ import * as _ from "lodash";
 import { platform } from "os";
 import { dirname, extname, isAbsolute, join, relative } from "path";
 import {
-    CustomExecution, Event, EventEmitter, Pseudoterminal, Task, TaskDefinition,
+    CancellationToken,
+    CustomExecution, Event, EventEmitter, ProviderResult, Pseudoterminal, Task, TaskDefinition,
     TaskProvider, TaskRevealKind, tasks, TerminalDimensions, Uri, workspace, WorkspaceFolder,
 } from "vscode";
+import { sendInfo } from "vscode-extension-telemetry-wrapper";
 import { buildWorkspace } from "../build";
 import { Jdtls } from "../java/jdtls";
 import { INodeData } from "../java/nodeData";
@@ -46,7 +48,7 @@ export async function executeExportJarTask(node?: INodeData): Promise<void> {
     isExportingJar = true;
     const stepMetadata: IStepMetadata = {
         entry: node,
-        taskLabel: "exportjar:default",
+        taskLabel: "default",
         steps: [],
         projectList: [],
         elements: [],
@@ -69,20 +71,20 @@ export async function executeExportJarTask(node?: INodeData): Promise<void> {
 }
 export class ExportJarTaskProvider implements TaskProvider {
 
-    public static exportJarType: string = "java";
+    public static exportJarType: string = "java (buildArtifact)";
 
     public static getDefaultTask(stepMetadata: IStepMetadata): Task {
         if (!stepMetadata.workspaceFolder) {
             throw new Error(ExportJarMessages.fieldUndefinedMessage(ExportJarMessages.Field.WORKSPACEFOLDER, ExportJarStep.ResolveTask));
         }
         const defaultDefinition: IExportJarTaskDefinition = {
             type: ExportJarTaskProvider.exportJarType,
-            label: "exportjar:default",
+            label: "default",
             targetPath: Settings.getExportJarTargetPath(),
             elements: [],
             mainClass: undefined,
         };
-        const task: Task = new Task(defaultDefinition, stepMetadata.workspaceFolder, "exportjar:default", ExportJarTaskProvider.exportJarType,
+        const task: Task = new Task(defaultDefinition, stepMetadata.workspaceFolder, "default", ExportJarTaskProvider.exportJarType,
             new CustomExecution(async (resolvedDefinition: TaskDefinition): Promise<Pseudoterminal> => {
                 return new ExportJarTaskTerminal(resolvedDefinition, stepMetadata);
             }));
@@ -93,13 +95,17 @@ export class ExportJarTaskProvider implements TaskProvider {
     private tasks: Task[] | undefined;
 
     public async resolveTask(task: Task): Promise<Task> {
+        return ExportJarTaskProvider.resolveExportTask(task, ExportJarTaskProvider.exportJarType);
+    }
+
+    public static async resolveExportTask(task: Task, type: string): Promise<Task> {
         const definition: IExportJarTaskDefinition = <IExportJarTaskDefinition>task.definition;
         const folder: WorkspaceFolder = <WorkspaceFolder>task.scope;
-        const resolvedTask: Task = new Task(definition, folder, task.name, ExportJarTaskProvider.exportJarType,
+        const resolvedTask: Task = new Task(definition, folder, task.name, type,
             new CustomExecution(async (resolvedDefinition: IExportJarTaskDefinition): Promise<Pseudoterminal> => {
                 const stepMetadata: IStepMetadata = {
                     entry: undefined,
-                    taskLabel: resolvedDefinition.label || `exportjar:${folder.name}`,
+                    taskLabel: resolvedDefinition.label || folder.name,
                     workspaceFolder: folder,
                     projectList: await Jdtls.getProjects(folder.uri.toString()),
                     steps: [],
@@ -142,11 +148,11 @@ export class ExportJarTaskProvider implements TaskProvider {
                 targetPath: Settings.getExportJarTargetPath(),
                 elements: elementList,
             };
-            const defaultTask: Task = new Task(defaultDefinition, folder, `exportjar:${folder.name}`, ExportJarTaskProvider.exportJarType,
+            const defaultTask: Task = new Task(defaultDefinition, folder, folder.name, ExportJarTaskProvider.exportJarType,
                 new CustomExecution(async (resolvedDefinition: IExportJarTaskDefinition): Promise<Pseudoterminal> => {
                     const stepMetadata: IStepMetadata = {
                         entry: undefined,
-                        taskLabel: resolvedDefinition.label || `exportjar:${folder.name}`,
+                        taskLabel: resolvedDefinition.label || folder.name,
                         workspaceFolder: folder,
                         projectList: await Jdtls.getProjects(folder.uri.toString()),
                         steps: [],
@@ -162,6 +168,21 @@ export class ExportJarTaskProvider implements TaskProvider {
     }
 }
 
+export class DeprecatedExportJarTaskProvider implements TaskProvider {
+
+    public static type: string = "java";
+
+    provideTasks(_token: CancellationToken): ProviderResult<Task[]> {
+        return [];
+    }
+
+    resolveTask(task: Task, _token: CancellationToken): ProviderResult<Task> {
+        sendInfo("", { name: "resolve-deprecated-export-task" });
+        return ExportJarTaskProvider.resolveExportTask(task, DeprecatedExportJarTaskProvider.type);
+    }
+
+}
+
 class ExportJarTaskTerminal implements Pseudoterminal {
 
     public writeEmitter = new EventEmitter<string>();
diff --git a/src/extension.ts b/src/extension.ts
@@ -1,21 +1,24 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-
 import * as path from "path";
-import { commands, Diagnostic, Extension, ExtensionContext, extensions, languages, tasks, TextDocument, TextEditor, Uri, window, workspace } from "vscode";
+import { commands, Diagnostic, Extension, ExtensionContext, extensions, languages,
+    Range, tasks, TextDocument, TextEditor, Uri, window, workspace } from "vscode";
 import { dispose as disposeTelemetryWrapper, initializeFromJsonFile, instrumentOperation, instrumentOperationAsVsCodeCommand, sendInfo } from "vscode-extension-telemetry-wrapper";
 import { Commands, contextManager } from "../extension.bundle";
 import { BuildTaskProvider } from "./tasks/build/buildTaskProvider";
 import { buildFiles, Context, ExtensionName } from "./constants";
 import { LibraryController } from "./controllers/libraryController";
 import { ProjectController } from "./controllers/projectController";
 import { init as initExpService } from "./ExperimentationService";
-import { ExportJarTaskProvider } from "./exportJarSteps/ExportJarTaskProvider";
+import { DeprecatedExportJarTaskProvider, ExportJarTaskProvider } from "./exportJarSteps/ExportJarTaskProvider";
 import { Settings } from "./settings";
 import { syncHandler } from "./syncHandler";
 import { EventCounter } from "./utility";
 import { DependencyExplorer } from "./views/dependencyExplorer";
+import { DiagnosticProvider } from "./tasks/migration/DiagnosticProvider";
+import { setContextForDeprecatedTasks, updateExportTaskType } from "./tasks/migration/utils";
+import { CodeActionProvider } from "./tasks/migration/CodeActionProvider";
 
 export async function activate(context: ExtensionContext): Promise<void> {
     contextManager.initialize(context);
@@ -40,6 +43,7 @@ async function activateExtension(_operationId: string, context: ExtensionContext
     context.subscriptions.push(DependencyExplorer.getInstance(context));
     context.subscriptions.push(contextManager);
     context.subscriptions.push(syncHandler);
+    context.subscriptions.push(tasks.registerTaskProvider(DeprecatedExportJarTaskProvider.type, new DeprecatedExportJarTaskProvider()));
     context.subscriptions.push(tasks.registerTaskProvider(ExportJarTaskProvider.exportJarType, new ExportJarTaskProvider()));
     context.subscriptions.push(tasks.registerTaskProvider(BuildTaskProvider.type, new BuildTaskProvider()));
 
@@ -64,6 +68,18 @@ async function activateExtension(_operationId: string, context: ExtensionContext
 
         commands.executeCommand(Commands.JAVA_PROJECT_CONFIGURATION_UPDATE, uri);
     });
+    // handle deprecated tasks
+    context.subscriptions.push(new DiagnosticProvider());
+    context.subscriptions.push(languages.registerCodeActionsProvider([{
+        scheme: "file",
+        pattern: "**/.vscode/tasks.json"
+    }], new CodeActionProvider()));
+    context.subscriptions.push(instrumentOperationAsVsCodeCommand(
+        Commands.JAVA_UPDATE_DEPRECATED_TASK, async (document: TextDocument, range: Range) => {
+            await updateExportTaskType(document, range);
+        }
+    ));
+    setContextForDeprecatedTasks();
 }
 
 // this method is called when your extension is deactivated
diff --git a/src/tasks/migration/CodeActionProvider.ts b/src/tasks/migration/CodeActionProvider.ts
@@ -0,0 +1,41 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+import * as vscode from "vscode";
+import { Commands } from "../../commands";
+import { ExportJarTaskProvider } from "../../exportJarSteps/ExportJarTaskProvider";
+import { DiagnosticProvider } from "./DiagnosticProvider";
+
+export class CodeActionProvider implements vscode.CodeActionProvider {
+
+    public static JAVA_UPDATE_DEPRECATED_TASK_TITLE = "Update deprecated task";
+    public static JAVA_BUILD_ARTIFACT_TYPE = `"type": "${ExportJarTaskProvider.exportJarType}"`;
+
+    public provideCodeActions(document: vscode.TextDocument, range: vscode.Range | vscode.Selection,
+                              _context: vscode.CodeActionContext, _token: vscode.CancellationToken): vscode.CodeAction[] | undefined {
+        const diagnostics = vscode.languages.getDiagnostics(document.uri);
+        if (diagnostics?.length) {
+            for (const diagnostic of diagnostics) {
+                if (diagnostic.source !== DiagnosticProvider.DIAGNOSTIC_SOURCE) {
+                    continue;
+                }
+                if (diagnostic.range.contains(range)) {
+                    const updateTaskCommand: vscode.Command = {
+                        command: Commands.JAVA_UPDATE_DEPRECATED_TASK,
+                        title: CodeActionProvider.JAVA_UPDATE_DEPRECATED_TASK_TITLE,
+                        arguments: [
+                            document,
+                            diagnostic.range
+                        ]
+                    };
+                    return [{
+                        title: CodeActionProvider.JAVA_UPDATE_DEPRECATED_TASK_TITLE,
+                        kind: vscode.CodeActionKind.QuickFix,
+                        command: updateTaskCommand
+                    }];
+                }
+            }
+        }
+        return [];
+    }
+}
diff --git a/src/tasks/migration/DiagnosticProvider.ts b/src/tasks/migration/DiagnosticProvider.ts
@@ -0,0 +1,82 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+import * as _ from "lodash";
+import * as fs from "fs";
+import * as path from "path";
+import * as readline from "readline";
+import * as vscode from "vscode";
+import { getTasksJsonPaths } from "./utils";
+import { DeprecatedExportJarTaskProvider, ExportJarTaskProvider } from "../../exportJarSteps/ExportJarTaskProvider";
+
+export class DiagnosticProvider implements vscode.Disposable {
+    public static DIAGNOSTIC_SOURCE = "Project Manager for Java";
+    public static DEPRECATED_TASK_TYPE_DECLARATION = `\"type\": \"${DeprecatedExportJarTaskProvider.type}\"`;
+    public static DEPRECATED_TASK_TYPE_MESSAGE = `Tasks with type \"${DeprecatedExportJarTaskProvider.type}\" are deprecated and will not be supported in the future, please use \"${ExportJarTaskProvider.exportJarType}\" instead.`;
+    private diagnosticCollection: vscode.DiagnosticCollection;
+    private disposables: vscode.Disposable[] = [];
+    private refreshDiagnosticsTrigger: any;
+
+    constructor() {
+        this.refreshDiagnosticsTrigger = _.debounce(this.refreshDiagnostics, 500 /** ms */);
+        this.diagnosticCollection = vscode.languages.createDiagnosticCollection("migrateExportTask");
+        this.disposables.push(this.diagnosticCollection);
+        this.disposables.push(vscode.workspace.onDidChangeTextDocument(async (e) => {
+            if (path.basename(e.document.fileName) === "tasks.json") {
+                this.refreshDiagnosticsTrigger(e.document.uri);
+            }
+        }));
+        this.initializeDiagnostics();
+    }
+
+    public dispose() {
+        for (const d of this.disposables) {
+            d.dispose();
+        }
+    }
+
+    private async initializeDiagnostics(): Promise<void> {
+        const tasksJsonPaths = await getTasksJsonPaths();
+        for (const tasksJsonPath of tasksJsonPaths) {
+            const diagnostics: vscode.Diagnostic[] = await DiagnosticProvider.getDiagnosticsFromTasksJsonPath(tasksJsonPath);
+            this.diagnosticCollection.set(vscode.Uri.file(tasksJsonPath), diagnostics);
+        }
+    }
+
+    private async refreshDiagnostics(uri: vscode.Uri): Promise<void> {
+        const diagnostics: vscode.Diagnostic[] = await DiagnosticProvider.getDiagnosticsFromTasksJsonPath(uri.fsPath);
+        this.diagnosticCollection.set(uri, diagnostics);
+    }
+
+    private static async getDiagnosticsFromTasksJsonPath(tasksJsonPath: string): Promise<vscode.Diagnostic[]> {
+        const diagnostics: vscode.Diagnostic[] = [];
+        const fileStream = fs.createReadStream(tasksJsonPath);
+        let lineNumber = 0;
+        const rl = readline.createInterface({
+            input: fileStream,
+            crlfDelay: Infinity
+        });
+        for await (const line of rl) {
+            const regExp: RegExp = /\"type\":\s*\"java\"/g;
+            const result: RegExpMatchArray | null = line.match(regExp);
+            if (result?.length === 1) {
+                const matchString = result[0];
+                const columnNumber = line.indexOf(matchString);
+                if (columnNumber > -1) {
+                    const diagnostic = new vscode.Diagnostic(
+                        new vscode.Range(
+                            new vscode.Position(lineNumber, columnNumber),
+                            new vscode.Position(lineNumber, columnNumber + matchString.length)
+                        ),
+                        DiagnosticProvider.DEPRECATED_TASK_TYPE_MESSAGE,
+                        vscode.DiagnosticSeverity.Warning
+                    );
+                    diagnostic.source = DiagnosticProvider.DIAGNOSTIC_SOURCE;
+                    diagnostics.push(diagnostic);
+                }
+            }
+            lineNumber++;
+        }
+        return diagnostics;
+    }
+}
diff --git a/src/tasks/migration/utils.ts b/src/tasks/migration/utils.ts
diff --git a/test/maven-suite/exportJar.test.ts b/test/maven-suite/exportJar.test.ts
diff --git a/test/maven/.vscode/tasks.json b/test/maven/.vscode/tasks.json

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ export namespace Context {`
`7`	`7`	`export const NO_JAVA_PROJECT: string = "java:noJavaProjects";`
`8`	`8`	`export const WORKSPACE_CONTAINS_BUILD_FILES: string = "java:workspaceContainsBuildFiles";`
`9`	`9`	`export const RELOAD_PROJECT_ACTIVE: string = "java:reloadProjectActive";`
	`10`	`+ export const SHOW_DEPRECATED_TASKS: string = "java:showDeprecatedTasks";`
`10`	`11`	`}`
`11`	`12`
`12`	`13`	`export namespace Explorer {`