Merge pull request #142 from augustocdias/unique_taskid

Enforce unique task ids

Author: MarcelRobitaille

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [Unreleased] xxxx-xx-xx
 
 - Make input history persistent (#140)
+- Enforce unique taskId (#131)
 
 ## [1.16.0] 2025-02-04
 

src/lib/CommandHandler.test.ts

@@ -190,6 +190,30 @@ test("Command variable interop", async () => {
     );
 });
 
+test("It should detect duplicate taskIds", async () => {
+    const testDataPath = path.join(__dirname, "../test/testData/duplicateTaskid");
+
+    const tasksJson = await import(path.join(testDataPath, ".vscode/tasks.json"));
+    const mockData = (await import(path.join(testDataPath, "mockData.ts"))).default;
+
+    mockVscode.setMockData(mockData);
+    const input = tasksJson.inputs[0].args;
+    const context = mockExtensionContext as unknown as vscode.ExtensionContext;
+    const handler = new CommandHandler(
+        {...input, useFirstResult: true},
+        new UserInputContext(context),
+        context,
+        child_process,
+    );
+
+    await handler.handle();
+
+    expect(execFileSpy).toHaveBeenCalledTimes(0);
+    expect(execSpy).toHaveBeenCalledTimes(1);
+    expect(mockVscode.window.getShowWarningMessageCalls().length).toBe(1);
+    expect(mockVscode.window.getShowWarningMessageCalls()[0]).toBe("Found duplicate 'taskIds'. This field must be unique. Expect strange behaviour. If you are trying to share a remembered value between tasks, please use 'rememberAs'. Duplicate taskIds: inputTest");
+});
+
 test("commandArgs", async () => {
     const testDataPath = path.join(__dirname, "../test/testData/commandArgs");
     const filePath = `${testDataPath}/.vscode/tasks.json`;

src/lib/CommandHandler.ts

@@ -425,13 +425,62 @@ export class CommandHandler {
             yield* getSectionInputs("tasks");
         }
 
+        const allInputs = [...getAllInputs()].map(
+            ({ args: { command, ...args }, ...rest }) => ({
+                args: {
+                    command: CommandHandler.resolveCommand(command),
+                    ...args,
+                },
+                ...rest,
+            }));
+
+        let result: Input | undefined = undefined;
+        const taskIdMap: Record<string, Input> = {};
+        const duplicateTaskIds = new Set<string>();
+
+        function isTaskIdUnique(input: Input) {
+            const taskId = input.args.taskId;
+
+            if (undefined === taskId) {
+                return true;
+            }
+
+            const other = taskIdMap[taskId];
+            taskIdMap[taskId] = input;
+
+            if (undefined === other) {
+                return true;
+            }
+
+            // Inputs are not marked as duplicate if they have the same command
+            // and command args. It can happen that we see the same input twice
+            // because of workspaceFolders. We cannot detect this.
+            return input.args.command === other.args.command &&
+                CommandHandler.compareCommandArgs(input.args.commandArgs,
+                                                   other.args.commandArgs);
+        }
+
         // Go through the generator and return the first match
-        for (const input of getAllInputs()) {
-            const command = CommandHandler.resolveCommand(input?.args?.command);
-            if (command === this.command && input?.args?.taskId === taskId &&
-                CommandHandler.compareCommandArgs(this.commandArgs, input?.args?.commandArgs)) {
-                return input;
+        for (const input of allInputs) {
+            if (false === isTaskIdUnique(input)) {
+                duplicateTaskIds.add(input.args.taskId);
             }
+
+            if (input.args.command === this.command &&
+                input?.args?.taskId === taskId &&
+                CommandHandler.compareCommandArgs(this.commandArgs,
+                                                  input?.args?.commandArgs)) {
+                  result = input;
+            }
+        }
+
+        if (0 < duplicateTaskIds.size) {
+            vscode.window.showWarningMessage(
+                `Found duplicate 'taskIds'. This field must be unique. Expect strange behaviour. If you are trying to share a remembered value between tasks, please use 'rememberAs'. Duplicate taskIds: ${[...duplicateTaskIds].join(", ")}`);
+        }
+
+        if (undefined !== result) {
+            return result;
         }
 
         throw new ShellCommandException(`Could not find input with command '${this.command}' and taskId '${taskId}'.`);

src/test/testData/duplicateTaskid/.vscode/tasks.json

@@ -0,0 +1,46 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Echo Project File",
+      "type": "shell",
+      "command": "echo ${input:inputTest}",
+      "problemMatcher": []
+    }
+  ],
+  "inputs": [
+    {
+      "id": "inputTest2",
+      "type": "command",
+      "command": "shellCommand.execute",
+      "args": {
+        "taskId": "inputTest",
+        "command": "echo inputTest2",
+        "multiselect": true,
+        "cwd": "${workspaceFolder}",
+        "env": {
+          "WORKSPACE": "${workspaceFolder[0]}",
+          "FILE": "${file}",
+          "PROJECT": "${workspaceFolderBasename}"
+        }
+      }
+    },
+    {
+      "id": "inputTest",
+      "type": "command",
+      "command": "shellCommand.execute",
+      "args": {
+        "taskId": "inputTest",
+        "rememberAs": "inputTest",
+        "rememberPrevious": true,
+        "command": "echo inputTest",
+        "cwd": "${workspaceFolder}",
+        "env": {
+          "WORKSPACE": "${workspaceFolder[0]}",
+          "FILE": "${file}",
+          "PROJECT": "${workspaceFolderBasename}"
+        }
+      }
+    }
+  ]
+}

src/test/testData/duplicateTaskid/mockData.ts

@@ -0,0 +1,71 @@
+export default {
+  "staticData": {
+    "workspace.workspaceFolders": [
+      {
+        "uri": {
+          "$mid": 1,
+          "fsPath": __dirname,
+          "external": `file://${__dirname}`,
+          "path": __dirname,
+          "scheme": "file"
+        },
+        "name": "duplicateTaskid",
+        "index": 0
+      }
+    ],
+    "window.activeTextEditor.document.fileName": `${__dirname}/.vscode/tasks.json`,
+    "window.activeTextEditor.document.uri.fsPath": `${__dirname}/.vscode/tasks.json`,
+    "window.activeTextEditor.selection.active.line": 7
+  },
+  "calls": {
+    "workspace.getConfiguration().inspect()": {
+      "[\"launch\",null,\"options\"]": {
+        "key": "launch.options"
+      },
+      "[\"launch\",null,\"inputs\"]": {
+        "key": "launch.inputs"
+      },
+      "[\"tasks\",null,\"options\"]": {
+        "key": "tasks.options"
+      },
+      "[\"tasks\",null,\"inputs\"]": {
+        "key": "tasks.inputs",
+        "workspaceValue": [
+          {
+            "id": "inputTest2",
+            "type": "command",
+            "command": "shellCommand.execute",
+            "args": {
+              "taskId": "inputTest",
+              "command": "echo inputTest2",
+              "multiselect": true,
+              "cwd": "${workspaceFolder}",
+              "env": {
+                "WORKSPACE": "${workspaceFolder[0]}",
+                "FILE": "${file}",
+                "PROJECT": "${workspaceFolderBasename}"
+              }
+            }
+          },
+          {
+            "id": "inputTest",
+            "type": "command",
+            "command": "shellCommand.execute",
+            "args": {
+              "taskId": "inputTest",
+              "rememberAs": "inputTest",
+              "rememberPrevious": true,
+              "command": "echo inputTest",
+              "cwd": "${workspaceFolder}",
+              "env": {
+                "WORKSPACE": "${workspaceFolder[0]}",
+                "FILE": "${file}",
+                "PROJECT": "${workspaceFolderBasename}"
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+};