Fix focus and configuration handling of the integrated terminal #15958

kaiwood · 2016-11-23T13:26:30Z

This PR fixes 2 problems with the focus handling of the integrated terminal (see #15103 and #14969) .

Although they result in a same usability/keybinding problem I initially described in #15103, my description was a little fuzzy because I didn't understand the cause fully.

There are currently 2 problems:

Problem Nr. 1

Whenever a second (or third, …) terminal instance gets exited via the shell command exit or by pressing ctrl-d (which basically is "exit" because it sends EOF), the terminal panel loses focus and the editor gets focus.

This hinders the workflow when working with multiple terminals, because you can't close a second one without refocusing the panel again, worst case scenario would be that a user write exit into an editor window without being aware of it.

The only case where focus has to change is if there is only 1 instance left, in this case the panel closes itself so the user has a visual clue about whats going on.

Just in case anyone asks, the reasoning I used focus(true) in setActiveInstanceByIndex() instead of inside _removeInstance() just in case there are some edge cases I didn't stumble upon yet. I'd guess you always want to focus your active instances, but correct me if I'm wrong.

Problem Nr. 2

To make the terminal work with various keyboard shortcuts, the setting terminal.integrated.commandsToSkipShell was introduced. The first part of my Issue I described in #15103 and I later found out to be described in #14969 as well is caused by the following:

Currently, the settings are only handled in the panel itself when _updateCommandsToSkipShell() is called (whenever the panel gets opened). If you create a new instance with either the +-Button in the GUI or via a shortcut, a new terminal instance get's created, gets attached – but _skipTerminalKeybindings is empty.

Calling the function to skip the commands from inside TerminalService#createInstance() made most sense to me because it's already aware of the settings, but correct me again if I'm wrong with this assumption.

Fixes microsoft#15103

Fixes microsoft#14969

mention-bot · 2016-11-23T13:26:32Z

@kaiwood, thanks for your PR! By analyzing the history of the files in this pull request, we identified @Tyriar, @octref and @chrmarti to be potential reviewers.

Tyriar

Thanks a lot for looking into this @kaiwood! I left a couple of comments.

Tyriar · 2016-11-24T21:09:19Z

src/vs/workbench/parts/terminal/electron-browser/terminalService.ts

@@ -80,6 +80,7 @@ export class TerminalService implements ITerminalService {
 			this.setActiveInstanceByIndex(0);
 		}
 		this._onInstancesChanged.fire();
+		terminalInstance.setCommandsToSkipShell(this.configHelper.getCommandsToSkipShell());


You've actually stumbled upon a bug bigger than this in that no settings values are updated correctly, including scrollback and cursorBlinking as well. Having a brief look at the code, I think the best way to fix this might be to move TerminalPanel._updateConfig to TerminalService.updateConfig and then call into that after creating the new instance.

Ok, after taking a closer look, there is quite some refactoring involved to do this right. _updateCursorBlink, _updateCommandsToSkipShell and _updateScrollback have to move too, makes no sense to leave them in the panel. But _updateFont has to move out of the old config update and stay on its own, its basically the same "class" of responsibility as _updateTheme. That means the event listeners need to be modified too… I'll figure it out, will take a little while until complete…

Tyriar · 2016-11-24T21:50:49Z

src/vs/workbench/parts/terminal/electron-browser/terminalService.ts

@@ -127,6 +128,7 @@ export class TerminalService implements ITerminalService {
 			terminalInstance.setVisible(i === terminalIndex);
 		});
 		this._onActiveInstanceChanged.fire();
+		this.getActiveInstance().focus(true);


I believe the reason focus is not run in setActiveInstanceByIndex is because on launch we do not want the terminal to be focused when the workbench is restored, instead the editor needs to be focused.

Could we isolate this particular case? When a terminal exits AND it is not the last terminal AND the terminal was focused previously. The last case prevents the terminal hijacking focus from the editor if the shell process dies for example.

@Tyriar Ok, I moved it into the block I had previously in mind, the first two isolation conditions are already met there. The third one was a little trickier because the last focus state had to be remembered, therefor c46e284 to cover this case.

kaiwood · 2016-11-27T19:44:48Z

@Tyriar Done. All configurations update when changed and on instance creation, focus is kept when the terminal receives EOF via ctrl-d and it doesn't hijack it when I kill -9 the shell from another terminal emulator.

Feel free to review again.

Tyriar

This is shaping up nicely! A few more comments 😄

Tyriar · 2016-11-28T18:57:22Z

src/vs/workbench/parts/terminal/electron-browser/terminalService.ts

+	}
+
+	private _updateCursorBlink(terminalInstance): void {
+		terminalInstance.setCursorBlink(this.configHelper.getCursorBlink());


I think it would make sense to just roll these 3 single line functions into updateConfig now.

Tyriar · 2016-11-28T19:02:15Z

src/vs/workbench/parts/terminal/electron-browser/terminalPanel.ts

 				this._updateTheme();
 			} else {
 				return super.setVisible(visible).then(() => {
 					this._terminalService.createInstance();
-					this._updateConfig();
+					this._terminalService.updateConfig();


This shouldn't be needed anymore as it's called within ITerminalService.createInstance

Tyriar · 2016-11-28T19:09:11Z

src/vs/workbench/parts/terminal/electron-browser/terminalService.ts

@@ -80,6 +83,9 @@ export class TerminalService implements ITerminalService {
 			this.setActiveInstanceByIndex(0);
 		}
 		this._onInstancesChanged.fire();
+		this._updateCursorBlink(terminalInstance);


These calls would be more at home inside TerminalInstance.constructor. Thinking about this further we may be able to get rid of both calls in TerminalPanel.setVisible as well by updating the config at the end of TerminalInstance.attachToElement. I believe that covers the cases we need to worry about for updating the config:

When the terminal is created and the panel exists (attachToElement will trigger immediately)

When the terminal is created via the API and the panel does not exist (attachToElement call will be deferred)

When the config is updated (TerminalService now listens to IConfigurationservice.onDidUpdateConfiguration)

Absolutely correct, piggybacking on TerminalInstance.attachToElement makes a lot of sense. That part of the config is now no longer a concern of TerminalPanel, the TerminalInstance is only responsible for itself and TerminalService handles the global updates when settings change. Seems reasonable 👍

Tyriar · 2016-11-28T19:09:43Z

src/vs/workbench/parts/terminal/electron-browser/terminalService.ts

@@ -96,6 +102,9 @@ export class TerminalService implements ITerminalService {
 		if (wasActiveInstance && this.terminalInstances.length > 0) {
 			let newIndex = index < this.terminalInstances.length ? index : this.terminalInstances.length - 1;
 			this.setActiveInstanceByIndex(newIndex);
+			if (terminalInstance.hadFocusOnExit) {


Love it! 👍

Tyriar · 2016-11-28T19:11:06Z

src/vs/workbench/parts/terminal/electron-browser/terminalPanel.ts

 		this._updateTheme();
-		this._updateConfig();
+		this._terminalService.updateConfig();


I think this can safely be removed.

Tyriar · 2016-11-29T19:54:25Z

@kaiwood let me know when this is ready for another review, I'd love to land it for this release (ideally merge this week) 😄

kaiwood · 2016-11-29T19:57:02Z

I was just about to comment above, hehe 👍

The latest commit should address everything that you mentioned, ready for the next round.

Tyriar · 2016-11-29T22:47:57Z

Changes look good, I re-queued the Travis build to make sure 😃

kaiwood · 2016-11-30T14:05:21Z

Just noticed while checking for the cause of another issue that I included TerminalService here just to use configHelper. Didn't notice that _configHelper was already available, so I removed the dependency.

Last commit doesn't change any behaviour, just a cleanup. Travis was green before this, Appveyor timed out, maybe we are lucky and they get both green this time around 😆

Tyriar · 2016-11-30T19:49:58Z

Looks good, thanks again 😄

Kai Wood added 2 commits November 23, 2016 13:07

Ensure focus for active terminal instances

9a3a1f6

Fixes microsoft#15103

Use commandsToSkipShell on instance creation

19f8652

Fixes microsoft#14969

msftclas added the cla-already-signed label Nov 23, 2016

jrieken assigned Tyriar Nov 23, 2016

Tyriar added this to the November 2016 milestone Nov 24, 2016

Tyriar requested changes Nov 24, 2016

View reviewed changes

Kai Wood added 5 commits November 27, 2016 10:48

Remember terminals focus state on exit

c46e284

Isolate focus behaviour of terminal

2c5f26d

Move instance configuration to terminalService

a66ae90

Avoid looping multiple times

71a0974

Update all configs on terminal instance creation

bdf6a17

kaiwood changed the title ~~Fix focus handling of the integrated terminal~~ Fix focus and configuration handling of the integrated terminal Nov 27, 2016

Merge remote-tracking branch 'upstream/master' into terminal-focus

529a0cd

Tyriar requested changes Nov 28, 2016

View reviewed changes

Refactor terminals configuration concerns

aeaec81

Merge remote-tracking branch 'upstream/master' into terminal-focus

78a5761

Remove dependency on TerminalService

03ecd71

Tyriar merged commit d6807fc into microsoft:master Nov 30, 2016

kaiwood deleted the terminal-focus branch December 1, 2016 07:32

github-actions bot locked and limited conversation to collaborators Mar 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix focus and configuration handling of the integrated terminal #15958

Fix focus and configuration handling of the integrated terminal #15958

kaiwood commented Nov 23, 2016

mention-bot commented Nov 23, 2016

Tyriar left a comment

Tyriar Nov 24, 2016

kaiwood Nov 27, 2016

Tyriar Nov 24, 2016

kaiwood Nov 27, 2016

kaiwood commented Nov 27, 2016

Tyriar left a comment

Tyriar Nov 28, 2016

Tyriar Nov 28, 2016

Tyriar Nov 28, 2016

kaiwood Nov 29, 2016

Tyriar Nov 28, 2016

Tyriar Nov 28, 2016

Tyriar commented Nov 29, 2016

kaiwood commented Nov 29, 2016

Tyriar commented Nov 29, 2016

kaiwood commented Nov 30, 2016 •

edited

Loading

Tyriar commented Nov 30, 2016

Fix focus and configuration handling of the integrated terminal #15958

Fix focus and configuration handling of the integrated terminal #15958

Conversation

kaiwood commented Nov 23, 2016

mention-bot commented Nov 23, 2016

Tyriar 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

Choose a reason for hiding this comment

kaiwood commented Nov 27, 2016

Tyriar 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tyriar commented Nov 29, 2016

kaiwood commented Nov 29, 2016

Tyriar commented Nov 29, 2016

kaiwood commented Nov 30, 2016 • edited Loading

Tyriar commented Nov 30, 2016

kaiwood commented Nov 30, 2016 •

edited

Loading