add fetchTasks() and executeTask() to tasks API #6058

elaihau · 2019-08-28T11:32:38Z

This pull request adds the support of executing a vscode.Task, and fetching tasks by type and schema version to the plugins API.
resolved [plug-in][tasks] Add ability to fetch all tasks #5342

Signed-off-by: Liang Huang [email protected]

How to test

This pull request can be tested with adding a vscode extension to Theia:

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {

	console.log('Congratulations, your extension "fetchtest" is now active!');

	let disposable = vscode.commands.registerCommand('extension.helloWorld', () => {
		// The code you place here will be executed every time your command is executed

		// Display a message box to the user
		vscode.window.showInformationMessage('Test Fetch Task and Execute Task!');

		// vscode.tasks.fetchTasks({ type: 'shell' }).then((value) => {
		// 	console.log('shell fulfilled', value);
		// }, (reason) => {
		// 	console.log('rejected', reason);
		// });

		vscode.tasks.fetchTasks({ type: 'npm' }).then((fetchedTasks) => {
			console.log('npm tasks found: ', fetchedTasks.length);
			for (const task of fetchedTasks) {
				console.log('\n\nlooking at ', task.name, '\n\n');
				vscode.tasks.executeTask(task);
			}
		}, (reason) => {
			console.log('fetch task was rejected', reason);
		});

		// const myTask = new vscode.Task(
		// 	{ type: 'shell' }, // task definition
		// 	vscode.TaskScope.Workspace,
		// 	'test',
		// 	'testExtension',
		// 	new vscode.ShellExecution('ls -alR', { cwd: '/home/elaihau/dev' })
		// );
		// vscode.tasks.executeTask(myTask);
	});

	context.subscriptions.push(disposable);
}

export function deactivate() { }

the extension can be locally packaged by vsce https://code.visualstudio.com/api/working-with-extensions/publishing-extension
the extension, when added as a plugin, should add a command Test Fetch Task and Execute Task to Theia
by running the command contributed by the extension, we are able to test if the tasks can be fetched by the new API, also, if the fetched tasks can be run.

For reviewer's convenience I uploaded the source code of my extension to https://github.com/elaihau/fetchtest

Review checklist

as an author, I have thoroughly tested my changes and carefully followed the review guidelines

elaihau · 2019-08-28T11:35:30Z

packages/plugin-ext/src/plugin/tasks/tasks.ts

+                return taskExecution;
+            }
+        }
+        return Promise.reject(new Error(reason));


resolved Roman's feedback #5357 (comment)

vince-fugnitto · 2019-08-29T18:33:51Z

CHANGELOG.md

@@ -10,6 +10,7 @@
 - [task] displayed the customized tasks as "configured tasks" in the task quick open [#5777](https://github.com/theia-ide/theia/pull/5777)
 - [task] allowed users to override any task properties other than the ones used in the task definition [#5777](https://github.com/theia-ide/theia/pull/5777)
 - [task] notified clients of TaskDefinitionRegistry on change [#5915](https://github.com/theia-ide/theia/pull/5915)
+- [task] added `tasks.fetchTasks()` and `tasks.executeTask()` to plugins API [#???](https://github.com/theia-ide/theia/pull/???)


I believe you can add the number now :) #6058

vince-fugnitto · 2019-08-29T18:36:52Z

packages/plugin/src/theia.d.ts

+        version?: string;
+
+        /**
+     * The task type to return;


Can we adjust the formatting?

vince-fugnitto · 2019-08-29T18:37:20Z

packages/plugin/src/theia.d.ts

+        version?: string;
+
+        /**
+     * The task type to return;


The task type to return. instead of The task type to return;

i changed it to the type of tasks to return.

packages/task/src/browser/task-service.ts

packages/plugin-ext/src/plugin/tasks/tasks.ts

RomanNikitenko · 2019-09-02T06:00:32Z

@elaihau @akosyakov
I'm on vacation and going to be offline next 2 weeks.
thank you for understanding!

elaihau · 2019-09-02T15:20:36Z

@RomanNikitenko thank you for the heads up ! Have fun :)

@vince-fugnitto maybe i can walk you through the code and explain how to test it this Friday (Sep 6) ?

mmorhun

I looked though the code, looks ok to me.
Will test this PR a bit later.

mmorhun · 2019-09-03T06:24:23Z

packages/plugin-ext/src/main/browser/tasks-main.ts

+        }
+
+        const filtered: TaskConfiguration[] = [];
+        found.forEach((taskConfig, ind) => {


Please use taskIndex, index or i.

mmorhun · 2019-09-03T06:44:54Z

packages/plugin-ext/src/plugin/tasks/tasks.ts

+            if (executionDto) {
+                const taskExecution = this.getTaskExecution(executionDto);
+                return taskExecution;
+            }


Up to you, but I'd prefer not to introduce another variable for error message.
This way we'll avoid usually unneded variable, (small plus to performance and memory usage) and it will be easier to read:

const x = getX(...); if (x) { const y = getY(...); if (y) { ... return; } throw new Error('Y not found'); } throw new Error ('X not found')

(And it is clear after which if it failed and exited).

mmorhun · 2019-09-03T08:49:17Z

packages/plugin/src/theia.d.ts

+         *
+         * @param filter a filter to filter the return tasks.
+         */
+        export function fetchTasks(filter?: TaskFilter): Thenable<Task[]>;


Please use PromiseLike insted of Thenable

vince-fugnitto · 2019-09-03T11:23:34Z

@vince-fugnitto maybe i can walk you through the code and explain how to test it this Friday (Sep 6) ?

Yes, that sounds fine with me :)

mmorhun · 2019-09-03T13:29:29Z

I've tested the changes for the following cases:

Fetch tasks:
- Fetch tasks from tasks.json inside .theia folder of specific type
- Fetch tasks of specific type which are provided by a TaskProvider contributed by plugin.
- Mix of two previous cases: fetch tasks of specific type when they are provided by tasks.json and some by a TaskProvider from within a plugin.
Run tasks:
- Fetch tasks of specific type, found the task with specifi label, change its configuration and run altered task.

All described above cases worked for me.

Resource used for testing of this PR:

Source code of the test plugin

import * as theia from '@theia/plugin';

export function start(context: theia.PluginContext) {
    const listTAsksTestCommand = {
        id: 'list-tasks-test-command',
        label: "Test list tasks of type"
    };
    context.subscriptions.push(theia.commands.registerCommand(listTAsksTestCommand, (...args: any[]) => {
        theia.window.showInformationMessage('On list tasks');

        theia.tasks.fetchTasks({ type: 'ctask' }).then((tasks: theia.Task[]) => {
            console.log('IN CALLBACK:', tasks);
            for (const task of tasks) {
                console.log('TASK:', task.name);
            }
        });
    }));

    const runTaskTestCommand = {
        id: 'run-task-test-command',
        label: "Test alter task"
    };
    context.subscriptions.push(theia.commands.registerCommand(runTaskTestCommand, (...args: any[]) => {
        theia.window.showInformationMessage('On run altered task');

        theia.tasks.fetchTasks({ type: 'ctask' }).then((tasks: theia.Task[]) => {
            console.log('IN RUN TASK:', tasks);
            for (const task of tasks) {
                if (task.name.startsWith('Echo hello world')) {
                    if (!task.execution) {
                        task.execution = {};
                    }
                    if (!task.execution.options) {
                        task.execution.options = {};
                    }

                    (task.execution as theia.ShellExecution).commandLine = 'sleep 1 && ls -la';
                    task.execution.options.cwd = "/tmp";

                    theia.tasks.executeTask(task);

                    return;
                }
            }
        });
    }));

    theia.tasks.registerTaskProvider('ctask', new CTaskProvider());
}

class CTaskProvider {
    async provideTasks(): Promise<theia.Task[]> {
        const task1 = new theia.Task({ type: 'ctask' }, theia.TaskScope.Global, 'first task', 'the-extension');
        const task2 = new theia.Task({ type: 'ctask' }, theia.TaskScope.Workspace, 'second task', 'ctask');
        return [task1, task2];
    }

    async resolveTask(task: theia.Task): Promise<theia.Task> {
        return task;
    }
}

export function stop() { }

tasks.json

{
    "tasks": [
        {
            "type": "abcd",
            "label": "rnodejs-hello-world:run",
            "command": "yarn",
            "target": {
                "workingDir": "/projects/theia"
            },
            "previewUrl": "${server.3000/tcp}"
        },
        {
            "type": "ctask",
            "label": "Echo hello world",
            "command": "echo \"hello world\"",
            "target": {
                "workingDir": "/projects",
                "containerName": "theia-dev"
            }
        }
    ]
}

mmorhun

I've tested changes (see comment above) and it works as expected.
@elaihau please take a look at my previous comments at least about PromiseLike and Thenable.

- This pull request adds the support of executing a vscode.Task, and fetching tasks by type and schema version to the plugins API. - resolved #5342 Signed-off-by: Liang Huang <[email protected]>

elaihau · 2019-09-05T01:21:55Z

Thank you for the review @mmorhun !

I updated the code to address your review comments.

elaihau requested review from RomanNikitenko and mmorhun August 28, 2019 11:32

elaihau requested a review from a team as a code owner August 28, 2019 11:32

This was referenced Aug 28, 2019

[DRAFT] fetch tasks by type and schema version #5348

Closed

add execute task to plug-in API #5357

Closed

elaihau commented Aug 28, 2019

View reviewed changes

akosyakov added the tasks issues related to the task system label Aug 28, 2019

vince-fugnitto reviewed Aug 29, 2019

View reviewed changes

elaihau force-pushed the Liang/redo_fetch branch 2 times, most recently from 3223cfc to 3cb394c Compare August 30, 2019 00:41

akosyakov reviewed Aug 30, 2019

View reviewed changes

packages/plugin-ext/src/plugin/tasks/tasks.ts Outdated Show resolved Hide resolved

elaihau force-pushed the Liang/redo_fetch branch from 3cb394c to d1cb3d9 Compare August 30, 2019 11:25

mmorhun reviewed Sep 3, 2019

View reviewed changes

mmorhun approved these changes Sep 3, 2019

View reviewed changes

add fetchTasks() and executeTask() to tasks API

2b58503

- This pull request adds the support of executing a vscode.Task, and fetching tasks by type and schema version to the plugins API. - resolved #5342 Signed-off-by: Liang Huang <[email protected]>

elaihau force-pushed the Liang/redo_fetch branch from d1cb3d9 to 2b58503 Compare September 5, 2019 01:21

elaihau merged commit 8054da5 into master Sep 5, 2019

elaihau deleted the Liang/redo_fetch branch September 5, 2019 01:48

mmorhun mentioned this pull request Sep 10, 2019

Allow not persistent changes for task before run #5312

Closed

elaihau mentioned this pull request Nov 21, 2019

[vscode] tasks.executeTask is missing #4758

Closed

akosyakov mentioned this pull request Apr 28, 2020

defer plugin contributions (preferences and tasks) #7676

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add fetchTasks() and executeTask() to tasks API #6058

add fetchTasks() and executeTask() to tasks API #6058

elaihau commented Aug 28, 2019 •

edited

Loading

elaihau Aug 28, 2019

vince-fugnitto Aug 29, 2019

vince-fugnitto Aug 29, 2019

vince-fugnitto Aug 29, 2019

elaihau Aug 30, 2019

RomanNikitenko commented Sep 2, 2019

elaihau commented Sep 2, 2019

mmorhun left a comment

mmorhun Sep 3, 2019

mmorhun Sep 3, 2019

mmorhun Sep 3, 2019

vince-fugnitto commented Sep 3, 2019

mmorhun commented Sep 3, 2019

mmorhun left a comment

elaihau commented Sep 5, 2019

add fetchTasks() and executeTask() to tasks API #6058

add fetchTasks() and executeTask() to tasks API #6058

Conversation

elaihau commented Aug 28, 2019 • edited Loading

How to test

Review checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RomanNikitenko commented Sep 2, 2019

elaihau commented Sep 2, 2019

mmorhun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vince-fugnitto commented Sep 3, 2019

mmorhun commented Sep 3, 2019

mmorhun left a comment

Choose a reason for hiding this comment

elaihau commented Sep 5, 2019

elaihau commented Aug 28, 2019 •

edited

Loading