Introduce Task API #2086

azatsarynnyy · 2018-06-11T01:40:24Z

This PR closes #1698 by introducing the Task API.
One of the interesting advantages of the Task API is that it allows Theia to consume VSCode's tasks.json.

The main concepts are:

Task Type

A Task Type is used to define which Task Resolver, Task Provider or Task Runner should be used with a particular Task Configuration.

Task Resolver (frontend contribution point)

Resolves a Task Configuration before sending it for execution to the Task Server. For example, this makes it possible to hide the actual complex command line from the user.

Task Provider (frontend contribution point)

It allows an extension to contribute the Tasks programmatically to the system.

Task Runner (backend contribution point)

A Task Runner knows how to run and kill a Task of a particular type. If contribution provides a Task Runner then it will be used to run a Task of a particular type otherwise, the default Task Runner is used.
That contribution point won't be so widely used as a Task Resolver and a Task Provider. But it's necessary for the extensions like Che, whose Tasks aren't running as the processes on Theia backend.
The Task extension provides ProcessTaskRunner implementation that can run a Task as a process or a command inside a shell (Tasks of type process or shell). It also serves as a default runner.

Here are some demos of using the Task API

Running a Task from the VSCode sources:
1/ Just open VSCode repo as Theia workspace and copy the tasks.json from .vscode into .theia folder.
2/ Now you can run, for example, Run tests task.

Theia npm extension (not a part of this PR) that contributes:

npm Task Resolver to allow its own format of a Task for describing npm script;
npm Task Provider to provide the scripts detected in a package.json as the Theia Tasks.

Che Task extensions (not a part of this PR) that contributes:

Che Task Resolver to allow its own format of a Task;
Che Task Runner to execute a command in any machine (docker container) of a Che Workspace;
Che Task Provider to provide the known Che Workspace's commands as the Theia Tasks.

azatsarynnyy · 2018-06-11T01:42:47Z

@marcdumais-work
Marc, could you please review that PR. I remember you also were interested in these changes )

marcdumais-work · 2018-06-11T11:58:36Z

@azatsarynnyy Sounds awesome! I will have to juggle this review and a few other things, but I am interested for sure.

marcdumais-work

Hi Artem,

I have started reviewing. Looks very good so far. A few minor comments. I will continue the review tomorrow.

marcdumais-work · 2018-06-18T11:52:39Z

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Change Log

 ## v0.3.12
+- Task API. Note, the format of tasks.json has been changed. For details, see the Task extension's README.md.


+1 : definitely worthy of mention; thanks for remembering to update this!

marcdumais-work · 2018-06-18T12:00:45Z

packages/task/README.md


-*cwd*: The current working directory, in which the task's command will execute. This is the equivalent of doing a "cd" to that directory, on the command-line, before running the command. This can contain the variable *${workspaceFolder}*, which will be replaced at execution time by the path of the current workspace. If left undefined, will by default be set to workspace root. 
+*type*: determines what type of process will be used to execute the task. Can be "process" or "shell". Terminal processes can be shown in Theia's frontend, in a terminal widget. Raw processes are run without their output being shown.


In the third and fourth sentences, probably at least update "Terminal" and "Raw" to "shell" and "process".

marcdumais-work · 2018-06-18T15:21:37Z

packages/task/src/node/test-resources/.theia/tasks.json

@@ -41,16 +37,14 @@
        },
        {
            "label": "list all files",
-            "processType": "terminal",
+            "type": "terminal",


"shell" instead of "terminal"?

azatsarynnyy · 2018-06-19T15:20:34Z

I've corrected the docs and changed a visibility of all properties of the TerminalWidget to protected for better extendibility.

marcdumais-work

Very nice, clean code and it works nicely on Linux. Have you had the chance to try it on Windows? The unit tests pass in any case.

Just a couple of minor comments for your consideration.

marcdumais-work · 2018-06-21T14:51:49Z

packages/task/src/node/process/process-task-runner.ts

@@ -0,0 +1,179 @@
+/*
+ * Copyright (C) 2018 Red Hat, Inc. and others.


It seems that the bulk of the code in this new file was copied from task-server.ts. Maybe the original (Ericsson) copyright header should be preserved? I have seen a couple of other cases in this PR, where I had the same question, but it was not so clear-cut (i.e. some code copied, but good amount of original code added).

Yes, you're right. Those files you mentioned were actually reworked. I've changed the copyright headers to Ericsson. Thanks for noticing that.

marcdumais-work · 2018-06-22T10:36:43Z

packages/task/src/node/task-server.ts

+        const taskType = taskConfiguration.type;
+        const runner = this.runnerRegistry.getRunner(taskType);
+        if (!runner) {
+            return Promise.reject(new Error(`No corresponding Runner found for the Task type ${taskType}`));


It might be nice to have a unit test that covers this case here, where a task runner is not found

Actually, this is a leftover from the previous version when there wasn't a default runner. I removed that code and added a test to check that a default runner is used.

marcdumais-work · 2018-06-22T11:01:58Z

@azatsarynnyy is it your intention to submit the npm task resolver and provider, show in the video above, for review next? Looks lt will be awesome for JS/TS development in Theia.

Signed-off-by: Artem Zatsarynnyi <[email protected]>

azatsarynnyy · 2018-06-25T13:05:02Z

@marcdumais-work I've addressed your last comments: updated the license headers and added a test. Also merged with the latest changes from the master branch.

Have you had the chance to try it on Windows?

Unfortunately, I don't have a chance to try it on Windows.
Regarding my npm extension - yes, I'd like to improve it a bit and propose a PR.

azatsarynnyy · 2018-06-25T13:10:54Z

Marc, thank you for taking the time to try that changes and reviewing my PR.

azatsarynnyy requested a review from marcdumais-work June 11, 2018 01:40

azatsarynnyy mentioned this pull request Jun 14, 2018

Support commands macro in Theia tasks eclipse-che/che#8974

Closed

5 tasks

marcdumais-work reviewed Jun 18, 2018

View reviewed changes

marcdumais-work approved these changes Jun 22, 2018

View reviewed changes

azatsarynnyy force-pushed the artem/task-api branch from 6b1617d to d550794 Compare June 25, 2018 12:09

Task API

c2f6835

Signed-off-by: Artem Zatsarynnyi <[email protected]>

azatsarynnyy force-pushed the artem/task-api branch from d550794 to c2f6835 Compare June 25, 2018 12:35

azatsarynnyy merged commit 422a328 into master Jun 25, 2018

azatsarynnyy deleted the artem/task-api branch June 27, 2018 20:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Task API #2086

Introduce Task API #2086

azatsarynnyy commented Jun 11, 2018 •

edited

Loading

azatsarynnyy commented Jun 11, 2018

marcdumais-work commented Jun 11, 2018

marcdumais-work left a comment

marcdumais-work Jun 18, 2018

marcdumais-work Jun 18, 2018

marcdumais-work Jun 18, 2018

azatsarynnyy commented Jun 19, 2018

marcdumais-work left a comment

marcdumais-work Jun 21, 2018

azatsarynnyy Jun 25, 2018

marcdumais-work Jun 22, 2018

azatsarynnyy Jun 25, 2018

marcdumais-work commented Jun 22, 2018

azatsarynnyy commented Jun 25, 2018

azatsarynnyy commented Jun 25, 2018


		cwd: The current working directory, in which the task's command will execute. This is the equivalent of doing a "cd" to that directory, on the command-line, before running the command. This can contain the variable ${workspaceFolder}, which will be replaced at execution time by the path of the current workspace. If left undefined, will by default be set to workspace root.
		type: determines what type of process will be used to execute the task. Can be "process" or "shell". Terminal processes can be shown in Theia's frontend, in a terminal widget. Raw processes are run without their output being shown.

		@@ -0,0 +1,179 @@
		/*
		* Copyright (C) 2018 Red Hat, Inc. and others.

Introduce Task API #2086

Introduce Task API #2086

Conversation

azatsarynnyy commented Jun 11, 2018 • edited Loading

Task Type

Task Resolver (frontend contribution point)

Task Provider (frontend contribution point)

Task Runner (backend contribution point)

Here are some demos of using the Task API

azatsarynnyy commented Jun 11, 2018

marcdumais-work commented Jun 11, 2018

marcdumais-work left a comment

Choose a reason for hiding this comment

marcdumais-work Jun 18, 2018

Choose a reason for hiding this comment

marcdumais-work Jun 18, 2018

Choose a reason for hiding this comment

marcdumais-work Jun 18, 2018

Choose a reason for hiding this comment

azatsarynnyy commented Jun 19, 2018

marcdumais-work left a comment

Choose a reason for hiding this comment

marcdumais-work Jun 21, 2018

Choose a reason for hiding this comment

azatsarynnyy Jun 25, 2018

Choose a reason for hiding this comment

marcdumais-work Jun 22, 2018

Choose a reason for hiding this comment

azatsarynnyy Jun 25, 2018

Choose a reason for hiding this comment

marcdumais-work commented Jun 22, 2018

azatsarynnyy commented Jun 25, 2018

azatsarynnyy commented Jun 25, 2018

azatsarynnyy commented Jun 11, 2018 •

edited

Loading