Exposed `preserveFocus` on `OutputChannel#show`. #8243

kittaakos · 2020-07-27T13:31:13Z

What it does

Exposed preserveFocus on OutputChannel#show. From now on, calling show with preserveFocus true will ensure that the Output widget is revealed but not activated. The default behavior remains preserveFocus false which will reveal and activate the widget.
Removed OutputWidget#setInput; it is automatically wired into show.

How to test

Reset the workbench layout.
Run Show channel (command, explicit, preserve-focus) -> Output view is revealed but not active.
Reset the workbench layout.
Run Show channel (API, explicit, preserve-focus) -> Output view is revealed but not active.
Run Hide Output Channel..., select the API Sample: my test channel -> The Output is active but the input is not the API Sample: my test channel.
Run Show Output Channel..., select the API Sample: my test channel -> The Output is active and the input is the API Sample: my test channel.
Reset the workbench layout.
Run Show channel (command, implicit, no preserve-focus) -> Output is active.
Reset the workbench layout.
Run Show channel (command, explicit, no preserve focus) -> Output is active.
Reset the workbench layout.
Run Show channel (API, implicit, no preserve-focus) -> Output is active.
Reset the workbench layout.
Run Show channel (API, explicit, no preserve-focus) -> Output is active.

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 · 2020-07-28T07:22:36Z

We usually use activate?: boolean to indicate whether focus should be given or not. Is there a reason to use other naming?

nvm it seems to be before like that too

akosyakov · 2020-07-28T07:24:37Z

packages/output/src/common/output-channel.ts

 import { Emitter, Event, Disposable, DisposableCollection } from '@theia/core';
 import { QuickPickItem } from '@theia/core/lib/common/quick-pick-service';
 import { MonacoEditorModel } from '@theia/monaco/lib/browser/monaco-editor-model';
 import { MonacoTextModelService, IReference } from '@theia/monaco/lib/browser/monaco-text-model-service';
 import { OutputUri } from './output-uri';
-import { OutputCommands } from '../browser/output-contribution';
+import { OutputCommands, OutputContribution } from '../browser/output-contribution';


dependency to browser code from common

Thanks for keeping an eye on everything ;) It's a known issue: #4306

Do you want me to move the modules from common to browser? I do not mind moving them now, but it's a breaking change. This PR most likely won't make it to the next release anyways.

As you want.

akosyakov · 2020-07-28T07:27:35Z

packages/output/src/common/output-channel.ts

    @inject(QuickPickService)
    protected readonly quickPickService: QuickPickService;

    @inject(MonacoTextModelService)
    protected readonly textModelService: MonacoTextModelService;

+    @inject(OutputContribution)
+    protected readonly outputContribution: OutputContribution;


I don't think that channel should know anything about contribution managing it

Could you give some pointers besides saying you do not like this approach? Thanks!

sorry, I commented here: #8243 (comment)

akosyakov · 2020-07-28T07:28:26Z

packages/output/src/common/output-channel.ts

-                    this.channelWasShownEmitter.fire({ name });
+                    const reveal = true;
+                    const activate = !preserveFocus;
+                    await this.outputContribution.openView({ reveal, activate });


i think the original idea was that channel represents the state which the contribution should listen to and react. The channel should NOT depend on concrete views.

OK, this makes sense. 👍

akosyakov · 2020-07-28T07:32:52Z

packages/output/src/browser/output-widget.tsx

            if (model && model.uri.toString() === selectedChannel.uri.toString()) {
+                if (!preserveFocus) {
+                    MessageLoop.sendMessage(editorWidget, Widget.Msg.ActivateRequest);


usually activation is done via ApplicationShell.activate. It makes sure to activate all widgets in parent-child order.

It is strange that the widget itself reacts and try to update visibility/focus without knowing visibility/activation state of its parents.

activate all widgets in parent-child order.

Hmm, that's interesting. We use the MessageLoop.sendMessage(myWidget, Widget.Msg.ActivateRequest); construct overalll the application:

view container,

terminal,

scm,

siw,

editor preview.

What's wrong with this one?

I see; you're right. Let me check why it was needed. Thanks for the heads-up.

Are you sure? I think it is the only place where we use it.

Yes, you're right.

Widget should implement how it is activated in onActivateRequest, but activation is done via ApplicationShell.activate. It will analyze what are parents (areas, tabs, composite widgets) of widgets and reveal/activate them first after that it will ask the widget to activate.

It does not seem to be caused by your changes though, so probably out of the scope to refactor it. I guess it works because there is another path running in parallel making sure that the output view is visible and activated.

kittaakos · 2020-07-28T09:31:42Z

Thanks for the feedback, @akosyakov. I updated the PR.
@amiramw, do you happen to have time helping us out with the Output verification?

amiramw · 2020-07-28T10:07:57Z

examples/api-samples/src/browser/output/sample-output-channel-with-severity.ts

@@ -16,26 +16,83 @@
 import { FrontendApplicationContribution } from '@theia/core/lib/browser';
 import { inject, injectable, interfaces } from 'inversify';
 import { OutputChannelManager, OutputChannelSeverity } from '@theia/output/lib/common/output-channel';
+import { CommandContribution, CommandRegistry } from '@theia/core/lib/common/command';


the name of this file should be changed now since it does not only test the severities, right?

Good point, but the corresponding commit will be dropped from the PR.

amiramw · 2020-07-28T10:16:06Z

packages/output/src/browser/output-widget.tsx

@@ -93,13 +94,16 @@ export class OutputWidget extends BaseWidget implements StatefulWidget {
        this.onStateChangedEmitter.fire(this._state);
    }

-    protected async refreshEditorWidget(): Promise<void> {
+    protected async refreshEditorWidget({ preserveFocus }: { preserveFocus: boolean } = { preserveFocus: false }): Promise<void> {


why not have boolean argument instead of object with single boolean property?

We can easily extend it without breaking the API in the future; it's pretty common that we use an object instead of a single property. I can make the change, though. I am OK with both.

i'm ok with both if we think it might expand in the future. consider having a named interface so it is more readable.

amiramw · 2020-07-28T10:25:47Z

Thanks for the feedback, @akosyakov. I updated the PR.
@amiramw, do you happen to have time helping us out with the Output verification?

Tested new functionality and it work. Recent severity changes also seems to work.

kittaakos · 2020-07-28T10:27:32Z

Tested new functionality and it work. Recent severity changes also seems to work.

Thanks a lot for your help, @amiramw 🙏

akosyakov · 2020-07-28T11:13:22Z

CHANGELOG.md

@@ -20,6 +20,7 @@ Breaking Changes:
 <a name="1_4_0_deprecate_languages"></a>
 - [[languages]](#1_4_0_deprecate_languages) `@theia/languages` extension is deprecated, use VS Code extensions to provide language smartness:
  https://code.visualstudio.com/api/language-extensions/language-server-extension-guide [#8112](https://github.com/eclipse-theia/theia/pull/8112)
+- [output] `OutputWidget#setInput` has been removed. The _Output_ view automatically shows the channel when calling `OutputChannel#show`. Moved the `OutputCommands` namespace from the `output-contribution` to its dedicated `output-commands` module to overcome a DI cycle. [#8243](https://github.com/eclipse-theia/theia/pull/8243)


we could simple reference a command by string? commands' ids are apis and cannot be changed easily anyway

akosyakov

code changes look to me

kittaakos · 2020-07-28T11:15:57Z

This PR is on hold until the next release; 30.7.

Edit: I am going to drop the API-sample commit after the release: #8243 (comment)

akosyakov · 2020-07-28T11:21:40Z

This PR is on hold until the next release; 30.7.

We should not forget to move changes to 1.5.0 in CHANGELOG for such PRs.

kittaakos · 2020-07-28T11:34:46Z

We should not forget to move changes to 1.5.0 in CHANGELOG for such PRs.

Sure. It will be a conflict after the release.

From now on, calling `show` with `preserveFocus` `true` will ensure that the Output widget is revealed but not activated. The default behavior remains `preserveFocus` `false` which will reveal and activate the widget. Removed `OutputWidget#setInput`; it is automatically wired into `show`. Signed-off-by: Akos Kitta <kittaakos@typefox.io>

kittaakos requested review from akosyakov and amiramw July 27, 2020 13:31

akosyakov added the output issues related to the output label Jul 28, 2020

akosyakov reviewed Jul 28, 2020

View reviewed changes

kittaakos force-pushed the output--fix-preserve-focus branch 2 times, most recently from f26e217 to b2bf7b1 Compare July 28, 2020 09:26

amiramw reviewed Jul 28, 2020

View reviewed changes

akosyakov reviewed Jul 28, 2020

View reviewed changes

akosyakov approved these changes Jul 28, 2020

View reviewed changes

kittaakos force-pushed the output--fix-preserve-focus branch from b2bf7b1 to 003113f Compare July 30, 2020 16:38

kittaakos merged commit e99e386 into master Jul 30, 2020

kittaakos deleted the output--fix-preserve-focus branch August 18, 2020 10:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exposed `preserveFocus` on `OutputChannel#show`. #8243

Exposed `preserveFocus` on `OutputChannel#show`. #8243

kittaakos commented Jul 27, 2020 •

edited

Loading

akosyakov commented Jul 28, 2020 •

edited

Loading

akosyakov Jul 28, 2020

kittaakos Jul 28, 2020

kittaakos Jul 28, 2020

akosyakov Jul 28, 2020

akosyakov Jul 28, 2020

kittaakos Jul 28, 2020

akosyakov Jul 28, 2020

akosyakov Jul 28, 2020 •

edited

Loading

kittaakos Jul 28, 2020

akosyakov Jul 28, 2020

kittaakos Jul 28, 2020

kittaakos Jul 28, 2020

akosyakov Jul 28, 2020

kittaakos Jul 28, 2020

akosyakov Jul 28, 2020

akosyakov Jul 28, 2020

kittaakos commented Jul 28, 2020

amiramw Jul 28, 2020

kittaakos Jul 28, 2020

amiramw Jul 28, 2020

kittaakos Jul 28, 2020

amiramw Jul 28, 2020

amiramw commented Jul 28, 2020

kittaakos commented Jul 28, 2020

akosyakov Jul 28, 2020 •

edited

Loading

akosyakov left a comment

kittaakos commented Jul 28, 2020 •

edited

Loading

akosyakov commented Jul 28, 2020

kittaakos commented Jul 28, 2020

Exposed preserveFocus on OutputChannel#show. #8243

Exposed preserveFocus on OutputChannel#show. #8243

Conversation

kittaakos commented Jul 27, 2020 • edited Loading

What it does

How to test

Review checklist

Reminder for reviewers

akosyakov commented Jul 28, 2020 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akosyakov Jul 28, 2020 • edited Loading

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

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

kittaakos commented Jul 28, 2020

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

amiramw commented Jul 28, 2020

kittaakos commented Jul 28, 2020

akosyakov Jul 28, 2020 • edited Loading

Choose a reason for hiding this comment

akosyakov left a comment

Choose a reason for hiding this comment

kittaakos commented Jul 28, 2020 • edited Loading

akosyakov commented Jul 28, 2020

kittaakos commented Jul 28, 2020

Exposed `preserveFocus` on `OutputChannel#show`. #8243

Exposed `preserveFocus` on `OutputChannel#show`. #8243

kittaakos commented Jul 27, 2020 •

edited

Loading

akosyakov commented Jul 28, 2020 •

edited

Loading

akosyakov Jul 28, 2020 •

edited

Loading

akosyakov Jul 28, 2020 •

edited

Loading

kittaakos commented Jul 28, 2020 •

edited

Loading