Support preLaunchTask and postDebugTask

[tolusha]

Signed-off-by: Anatoliy Bazko abazko@redhat.com

What it does

It adds support for preLaunchTask and postDebugTask
https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes

• If task is configured the label of the task is used to identify and to display.

Reference issue

#3409

How to test

1. Add any debug configuration
2. Add preLaunchTask and postDebugTask

            "preLaunchTask": "taskStart",
            "postDebugTask": "taskEnd"

3. Configure tasks, for instance:

{
    "tasks": [
        {
            "type": "shell",
            "label": "taskStart",
            "command": "sleep 1s && echo Start"

        },
        {
            "type": "shell",
            "label": "taskEnd",
            "command": "sleep 1s && echo End"
        }
    ]
}

Review checklist

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

Reminder for reviewers

• as a reviewer, I agree to behave in accordance with the review guidelines

[akosyakov]

@tolusha ready for review?

[tolusha]

@akosyakov
Thank you for review.
The PR isn't completed yet. I have to handle one more case when preLaunchTask failed I shouldn't start a debug session. The problem is that there isn't easy way to check an exit code of the task.
I am considering adding a dedicated method into TaskServer [1] but in this case I shouldn't remove tasks from the TaskManager [2] immediately but keep them for a while.
WDYT?

[1] https://github.com/theia-ide/theia/blob/ab/debugtasks/packages/task/src/node/task-server.ts#L35
[2] https://github.com/eclipse-theia/theia/blob/ab/debugtasks/packages/task/src/node/task-server.ts#L90

[tolusha]

/cc @RomanNikitenko

[akosyakov]

cc @eclipse-theia/task-extension please see #6247 (comment)

[RomanNikitenko]

@tolusha
What about adding deferred exit code to runtime info . Will it help you for your goals?

@akosyakov
does that make sense?

[tolusha]

I am about to submit changes

[tolusha]

@akosyakov @RomanNikitenko
I've updated PR. Have a look at proposed changes regarding task.
If they look good in general I will continue fixing remarks.

[akosyakov]

@tolusha please rely on review from @elaihau and @RomanNikitenko for the task extension

[RomanNikitenko]

I think we should avoid using timeout for deletion of tasks.
Otherwise it leads to the bug: after completion of a task, the task is considered as running during timeout. You can check it using Terminal => Show Running Tasks.

[tolusha]

@elaihau @RomanNikitenko
It is ready to review again

[elaihau]

@elaihau @RomanNikitenko
It is ready to review again

@tolusha
i don't think this comment is resolved. if you don't think it is within the scope of your pull request please create a github issue. Thank you !

[tolusha]

@elaihau
I don't use runBylabel anymore.
Instead of that I invoke runTaskInWorkspace [1] which scans all task [2] related to current root and run a needed one.

[1] https://github.com/eclipse-theia/theia/blob/ab/debugtasks/packages/debug/src/browser/debug-session-manager.ts#L410
[2] https://github.com/eclipse-theia/theia/blob/ab/debugtasks/packages/task/src/browser/task-service.ts#L432

[ShimonBenYair]

@tolusha
thanks a lot for this improvement , i also need it.
Do you have any estimation when you will merge your PR ?

[tolusha]

@ShimonBenYair
I will merge it once it get approved by @elaihau and @RomanNikitenko
It would be nice if you try it also and check if it works as expected.

[elaihau]

I tested the following scenarios in my local env:

• single root workspace, configured task
• multi root workspace, configured task
• single root workspace, detected task
• multi root workspace, detected task

All worked except for one thing. Please see GIF below (kingly ignore the error message - it was caused by my settings):

As shown, the task "npm: lintAAA" was successfully started, however the problem matcher was not resolved and therefore the warning in task output was not parsed, and no markers were created in the problems view.

When I ran the task "npm: lintAAA" alone I was getting:

Also, I didn't see the prompt that asked users for problem matcher definitions, if the task was started from the launch config:

[elaihau]

I revisited task-service.ts and thought the problems (that I found above) were likely caused by my earlier bad design decisions :)
Please feel free to file separate follow-up issues in github. They don't have to be resolved in this pull request.
@tolusha

[tolusha]

@elaihau Thank you for review. It was very helpful
I will provide update soon.

[tolusha]

@elaihau
PR is updated to use problem matchers

[tolusha]

@elaihau Here is some clarification

As shown, the task "npm: lintAAA" was successfully started, however the problem matcher was not resolved and therefore the warning in task output was not parsed, and no markers were created in the problems view.

Fixed: If problem matcher is configured then it will be used.

Also, I didn't see the prompt that asked users for problem matcher definitions, if the task was started from the launch config:

Won't fix: If problem matcher isn't configured and task is run from a launch config then menu to select problem matcher won't be shown. Like in VS Code.

[RomanNikitenko]

I tested the following:

• running custom configured task
• running detected tsc task
• running configured tsc task
• running debug configuration with preLaunchTask: the task is started, prompt that asked users for problem matcher definitions is not displayed. I checked - VS Code behavior is the same.

The PR changes approach of displaying labels for TaskRunQuickOpenItem and TaskConfigureQuickOpenItems for configured tasks - I checked - VS Code behavior is the same

[akosyakov]

changes to the debug and plugin extensions look good to me

not sure when @elaihau has a chance to have a look, from comments above it looks like happy too now

[elaihau]

I tested one more time and confirm the problems it used to have are fixed. Thank you for your work !

[tolusha]

I am going to squash commits and merge.

[ShimonBenYair]

@tolusha

Hi, will this change be released on version 12 of Theia ?

[marcdumais-work]

Hi, will this change be released on version 12 of Theia ?

Yes, this change will be part of Theia release 0.12.0, tentatively scheduled for October 31st.