Use 'viewId' as progress location

[RomanNikitenko]

What it does

Fixes #8703

At the moment it's possible to use ProgressLocation enum only as a location at which progress should show.
The PR is aligning location field to the corresponding field of VS Code to provide an opportunity to use viewId as progress location.

How to test

I created a test plugin, it contains commands for testing

1. Please clone the plugin and build it using yarn.
2. Copy the plugin to theia/plugins folder.
3. Use the following commands from Command Palette (F1) for testing:

• Start progress for Explorer view
• Start progress for Search view
• Start progress for Debug view
• Start progress for SCM view

First 3 commands use viewId (new behavior) to show progress while running the given callback, the last command uses ProgressLocation enum to show progress for SCM view (existed behavior).

4. Use case for a custom view is described here Use 'viewId' as progress location #8700 (comment) - thanks a lot @kittaakos for the case and the extension for testing

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

Signed-off-by: Roman Nikitenko rnikiten@redhat.com

[benoitf]

Tested 4 commands with the provided plug-ins
I see progress as expected on 4 examples

More compliance with VS Code 🎉

[kittaakos]

I also give it a try...

[kittaakos]

I also give it a try...

This does not seem to work with a custom view inside a custom view container. I will try to come up with a public, stripped-down example later today. Is this urgent to merge, @RomanNikitenko?

[RomanNikitenko]

This does not seem to work with a custom view inside a custom view container. I will try to come up with a public, stripped-down example later today. Is this urgent to merge, @RomanNikitenko?

I tested the solution for explorer, debug, search and scm views only, so I didn't face the problem related to a custom view inside a custom view container. Please provide steps to reproduce or an example for testing.

About

Is this urgent to merge

I provided these changes within another issue. If it works for main views and doesn't work for some specific case - I think we could merge the PR and create a separate issue for the specific case to have an ability investigate this area more deeply.
WDYT?

Anyway I'm open for discussion - if there is the opinion that we can not merge the PR as is - then the solution should be improved before merge.

[kittaakos]

I tested the solution for explorer, debug, search and scm views only, so I didn't face the problem related to a custom view inside a custom view container. Please provide steps to reproduce or an example for testing.

Sure, I will. All cases should work after merging this PR.

I provided these changes within another issue. If it works for main views and doesn't work for some specific case - I think we could merge the PR and create a separate issue for the specific case to have an ability investigate this area more deeply.
WDYT?

No, I don't see it this way. Although nobody asked me for a review here, I spent my time investigating the VS Code source and proposed a reasonable code change. I tried your modification in-action; it did not work. Now I am creating a VS Code example for you. I do not want to come back for another follow-up PR review. This should be solved with this PR. Thank you for your understanding, and I am hoping to see this change in Theia ASAP. 👍

[kittaakos]

Please provide steps to reproduce or an example for testing.

Here is the repo with the example, you can build one and try it.

In VS Code, you open the new view container, it has one view (it shows your user home) and you execute the Do Something command. It should show progress for two seconds:

[RomanNikitenko]

No, I don't see it this way.

OK, As I mentioned above:

Anyway I'm open for discussion - if there is the opinion that we can not merge the PR as is - then the solution should be improved before merge.

===================================

Although nobody asked me for a review here

But it's not true :-)

I spent my time investigating the VS Code source and proposed a reasonable code change.

Now I am creating a VS Code example for you.

thanks a lot!

[kittaakos]

But it's not true :-)

I did not see the review request, sorry 😊. I just wanted to try the new feature.

[RomanNikitenko]

@kittaakos
I tried your example - cloned and built it, then copied to the theia/plugins folder.
Unfortunately I got the error related to an activation the extension.

Could you take a look what's wrong in my steps?

[kittaakos]

Could you take a look what's wrong in my steps?

I made some changes and verified it, it should work now. Thanks, @RomanNikitenko 🙏

[RomanNikitenko]

@kittaakos
could you review when you have a chance

[kittaakos]

I have verified with a custom view, it works. Thank you, @RomanNikitenko 👍