Merge branch 'topic/obsolete-tasks' into 'master'

eliericha · eliericha · commit 5a7bb698bfd3 · 2023-11-21T09:29:52.000Z
Display a warning when obsolete tasks get executed

Closes eng/spark/spark2014#432

See merge request eng/ide/ada_language_server!1443
diff --git a/integration/vscode/ada/src/ExtensionState.ts b/integration/vscode/ada/src/ExtensionState.ts
@@ -1,8 +1,8 @@
 import * as vscode from 'vscode';
 import { Disposable, LanguageClient } from 'vscode-languageclient/node';
 import { createClient } from './clients';
-import GnatTaskProvider from './gnatTaskProvider';
-import GprTaskProvider from './gprTaskProvider';
+import { GnatTaskProvider } from './gnatTaskProvider';
+import { GprTaskProvider } from './gprTaskProvider';
 import { registerTaskProviders } from './taskProviders';
 import { getCustomEnvSettingName } from './helpers';
 
diff --git a/integration/vscode/ada/src/gnatTaskProvider.ts b/integration/vscode/ada/src/gnatTaskProvider.ts
@@ -19,6 +19,7 @@ import * as vscode from 'vscode';
 import {
     AllTaskKinds,
     DEFAULT_PROBLEM_MATCHER,
+    WarningMessageExecution,
     TaskProperties,
     alire,
     allTaskProperties,
@@ -45,7 +46,7 @@ interface GnatTaskDefinition extends vscode.TaskDefinition {
  * order to preserve support for 'gnat' task types that still exist in User
  * workspaces.
  */
-export default class GnatTaskProvider implements vscode.TaskProvider<vscode.Task> {
+export class GnatTaskProvider implements vscode.TaskProvider<vscode.Task> {
     /**
      * This flag is used to restore the proposal of 'gnat' tasks for debugging
      * purposes.
@@ -55,6 +56,11 @@ export default class GnatTaskProvider implements vscode.TaskProvider<vscode.Task
     public static gnatType = 'gnat' as const; // Task provider name
     gnatTasks: vscode.Task[] | undefined; // Known tasks
 
+    private readonly obsoletionMsg =
+        "Tasks of type 'gnat' are obsolete. Please use tasks of type 'ada' or 'spark'.";
+
+    private readonly obsoleteWarningExecution = new WarningMessageExecution(this.obsoletionMsg);
+
     constructor() {
         this.gnatTasks = undefined; //  Do we really need this???
     }
@@ -63,7 +69,7 @@ export default class GnatTaskProvider implements vscode.TaskProvider<vscode.Task
     provideTasks(_token: vscode.CancellationToken): vscode.ProviderResult<vscode.Task[]> {
         if (GnatTaskProvider.DEPRECATED) {
             // We return a single dummy task to convey an obsoletion message to Users.
-            const msg = 'The "gnat" task type is obsolete. Use "ada" tasks instead.';
+            const msg = this.obsoletionMsg;
             return [
                 new vscode.Task(
                     {
@@ -74,7 +80,7 @@ export default class GnatTaskProvider implements vscode.TaskProvider<vscode.Task
                     vscode.TaskScope.Workspace,
                     msg,
                     GnatTaskProvider.gnatType,
-                    new vscode.ShellExecution(`echo ${msg}`),
+                    this.obsoleteWarningExecution,
                     DEFAULT_PROBLEM_MATCHER
                 ),
             ];
@@ -95,42 +101,19 @@ export default class GnatTaskProvider implements vscode.TaskProvider<vscode.Task
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         _token: vscode.CancellationToken
     ): vscode.ProviderResult<vscode.Task> {
-        // We keep the previous task resolution code so that tasks in User
-        // workspaces still work like before. Such tasks are also flagged as
-        // obsolete in the tasks.json file to encourage Users to migrate to the
-        // 'ada' task type.
-        const definition = task.definition as GnatTaskDefinition;
-
-        // Check if the task in our known task
-        if (definition.taskKind in allTaskProperties) {
-            const taskKind = definition.taskKind as AllTaskKinds;
-            const item: TaskProperties = allTaskProperties[taskKind];
-            const extraArgsFromUser: string[] = Array.isArray(definition.args)
-                ? definition.args.map((x) => String(x))
-                : [];
-            const extraArgsFromTask = item.extra ? item.extra() : [];
-            return alire().then(async (alr) => {
-                const cmd = alr.concat(
-                    item.command,
-                    await getProjectArgs(),
-                    getScenarioArgs(),
-                    extraArgsFromUser,
-                    await extraArgsFromTask,
-                    getDiagnosticArgs()
-                );
-                const shell = new vscode.ShellExecution(cmd[0], cmd.slice(1));
-                return new vscode.Task(
-                    definition,
-                    task.scope ?? vscode.TaskScope.Workspace,
-                    task.name,
-                    'ada',
-                    shell,
-                    DEFAULT_PROBLEM_MATCHER // problemMatchers
-                );
-            });
-        } else {
-            return task;
-        }
+        /**
+         * Here we resolve 'gnat' tasks still defined in User workspaces. We
+         * handle them by displaying an obsoletion warning if the task gets
+         * executed.
+         */
+        return new vscode.Task(
+            task.definition,
+            task.scope ?? vscode.TaskScope.Workspace,
+            task.name,
+            GnatTaskProvider.gnatType,
+            this.obsoleteWarningExecution,
+            DEFAULT_PROBLEM_MATCHER
+        );
     }
 }
 
diff --git a/integration/vscode/ada/src/gprTaskProvider.ts b/integration/vscode/ada/src/gprTaskProvider.ts
@@ -18,7 +18,7 @@
 import * as vscode from 'vscode';
 import { LanguageClient } from 'vscode-languageclient/node';
 import { getMains, getExecutables, getProjectFile } from './helpers';
-import { DEFAULT_PROBLEM_MATCHER } from './taskProviders';
+import { DEFAULT_PROBLEM_MATCHER, WarningMessageExecution } from './taskProviders';
 
 /**
  *
@@ -27,7 +27,7 @@ import { DEFAULT_PROBLEM_MATCHER } from './taskProviders';
  * workspaces.
  */
 
-export default class GprTaskProvider implements vscode.TaskProvider<vscode.Task> {
+export class GprTaskProvider implements vscode.TaskProvider<vscode.Task> {
     /**
      * This flag is used to restore the proposal of 'gpr' tasks for debugging
      * purposes.
@@ -37,6 +37,11 @@ export default class GprTaskProvider implements vscode.TaskProvider<vscode.Task>
     public static gprTaskType = 'gpr';
     glsTasks: vscode.Task[] | undefined;
 
+    private readonly obsoletionMsg =
+        "The 'gpr' task type is obsolete. Please use 'ada' tasks instead.";
+
+    private readonly obsoleteWarningExecution = new WarningMessageExecution(this.obsoletionMsg);
+
     constructor(client: LanguageClient) {
         this.glsTasks = undefined;
         this.client = client;
@@ -46,7 +51,7 @@ export default class GprTaskProvider implements vscode.TaskProvider<vscode.Task>
     async provideTasks(): Promise<vscode.Task[] | undefined> {
         if (GprTaskProvider.DEPRECATED) {
             // We return a single dummy task to convey an obsoletion message to Users.
-            const msg = 'The "gpr" task type is obsolete. Use "ada" tasks instead.';
+            const msg = this.obsoletionMsg;
             return [
                 new vscode.Task(
                     {
@@ -57,7 +62,7 @@ export default class GprTaskProvider implements vscode.TaskProvider<vscode.Task>
                     vscode.TaskScope.Workspace,
                     msg,
                     GprTaskProvider.gprTaskType,
-                    new vscode.ShellExecution(`echo ${msg}`),
+                    this.obsoleteWarningExecution,
                     DEFAULT_PROBLEM_MATCHER
                 ),
             ];
@@ -75,42 +80,20 @@ export default class GprTaskProvider implements vscode.TaskProvider<vscode.Task>
         return this.glsTasks;
     }
 
-    async resolveTask(task: vscode.Task): Promise<vscode.Task | undefined> {
-        const definition = task.definition;
-        // Make sure that this looks like a execute task by checking that there is a projectFile.
-        if (definition.type == GprTaskProvider.gprTaskType) {
-            //  Refresh gprbuild command line
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            const projectFile: string =
-                definition.projectFile != undefined
-                    ? definition.projectFile
-                    : await getProjectFile(this.client);
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-            const args = getMainBuildArgs(projectFile, definition.main);
-            let shell: vscode.ShellExecution;
-            let title: string;
-            if (definition.executable != undefined) {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-                args.push('&&', 'clear', '&&', definition.executable);
-                shell = new vscode.ShellExecution(fullCommand('gprbuild', args));
-                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                title = `Build And Run Main: ${definition.main}`;
-            } else {
-                shell = new vscode.ShellExecution(fullCommand('gprbuild', args));
-                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                title = `Build Main: ${definition.main}`;
-            }
-            // resolveTask requires that the same definition object be used.
-            return new vscode.Task(
-                definition,
-                vscode.TaskScope.Workspace,
-                title,
-                'gpr',
-                shell,
-                '$gpr'
-            );
-        }
-        return undefined;
+    resolveTask(task: vscode.Task) {
+        /**
+         * Here we resolve 'gpr' tasks still defined in User workspaces. We
+         * handle them by displaying an obsoletion warning if the task gets
+         * executed.
+         */
+        return new vscode.Task(
+            task.definition,
+            task.scope ?? vscode.TaskScope.Workspace,
+            task.name,
+            GprTaskProvider.gprTaskType,
+            this.obsoleteWarningExecution,
+            DEFAULT_PROBLEM_MATCHER
+        );
     }
 }
 
diff --git a/integration/vscode/ada/src/taskProviders.ts b/integration/vscode/ada/src/taskProviders.ts
@@ -22,6 +22,7 @@ import * as vscode from 'vscode';
 import { SymbolKind } from 'vscode';
 import { adaExtState } from './extension';
 import { getAdaMains, getProjectFile } from './helpers';
+import { task } from 'fp-ts';
 
 /**
  * Callback to provide an extra argument for a tool
@@ -641,7 +642,7 @@ async function buildFullCommandLine(
                     // field must be specified.
                     const msg =
                         `Task '${name}': ` +
-                        `The project file specied in this task is different than the workspace ` +
+                        `The project file specified in this task is different than the workspace ` +
                         `project. It is not possible to automatically compute the path to the ` +
                         `executable to run. Please specify the 'executable' attribute in the ` +
                         `task definition.`;
@@ -661,3 +662,57 @@ async function buildFullCommandLine(
         return alr.concat(cmd);
     });
 }
+
+/**
+ * This class is a {@link vscode.CustomExecution} that displays a warning
+ * message as a popup message and in the terminal associated with the task
+ * execution. In particular, it is useful for displaying a warning when the User
+ * tries to execute an obsolete or malformed task.
+ */
+export class WarningMessageExecution extends vscode.CustomExecution {
+    warningMsg: string;
+
+    constructor(warningMsg: string) {
+        super(() => {
+            return this.callback();
+        });
+        this.warningMsg = warningMsg;
+    }
+
+    /**
+     * This callback is called when the task is executed.
+     *
+     * @returns a Pseudoterminal object that controls a Terminal in the VS Code UI.
+     */
+    callback(): Thenable<vscode.Pseudoterminal> {
+        return new Promise((resolve) => {
+            const writeEmitter = new vscode.EventEmitter<string>();
+            const closeEmitter = new vscode.EventEmitter<number>();
+            const msg = this.warningMsg;
+            const pseudoTerminal: vscode.Pseudoterminal = {
+                onDidWrite: writeEmitter.event,
+                onDidClose: closeEmitter.event,
+                open() {
+                    /**
+                     * Printing to the terminal is done by firing the onDidWrite event.
+                     */
+                    writeEmitter.fire(msg + '\r\n\r\n');
+
+                    /**
+                     * Display the warning in a popup without awaiting the dismissal of the popup.
+                     */
+                    void vscode.window.showWarningMessage(msg);
+
+                    /**
+                     * Firing the onDidClose event causes the Terminal to end.
+                     */
+                    closeEmitter.fire(0);
+                },
+                close() {
+                    //
+                },
+            };
+            resolve(pseudoTerminal);
+        });
+    }
+}
