On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed #638

rkeithhill · 2018-11-01T06:04:45Z

On PS Core, do not set the console mode at all.
PS Core, since the release of 6.0.0 has handled setting/resetting the
console mode, so no need for posh-git to do this. See:
PowerShell/PowerShell#2991

This speeds up module import by ~.5 to .7 seconds on PSCore and by
~150-200 msecs on Windows PowerShell.

Fix #637 and maybe #635

…, do not set the console mode at all.PS Core, since the release of 6.0.0 has handled setting/resetting theconsole mode, so no need for posh-git to do this.This speeds up module import by ~.5 to .7 seconds on PSCore and by~150-200 msecs on Windows PowerShell.Fix #637

Keep this PR simple in scope - just the deferred Add-Type. After a chat w/lzybkr we may want to convert some of this to a binary to help import/prompt processing time.

rkeithhill · 2018-11-03T05:20:03Z

Here's some profiling data.

Current perf (without this PR):

WARNING: CheckRequirements.ps1 load time: 89
WARNING: ConsoleMode.ps1 load time: 930 <<< ~1 second here!!!
WARNING: Utils.ps1 load time: 136
WARNING: AnsiUtils.ps1 load time: 34
WARNING: WindowTitle.ps1 load time: 8
WARNING: PoshGitTypes.ps1 load time: 28
WARNING: GitUtils.ps1 load time: 37
WARNING: GitPrompt.ps1 load time: 90
WARNING: GitParamTabExpansion.ps1 load time: 35
WARNING: GitTabExpansion.ps1 load time: 140
WARNING: TortoiseGit.ps1 load time: 10
WARNING: Process through configuring prompt func: 27
WARNING: Process through end: 5
WARNING: Total pms1 import time: 1592
Loading personal and system profiles took 2672ms.
C:\Users\Keith
11-02 23:08:00 232ms 1> << note that prompt processing time is pretty short

Now with just deferring the Add-Type until first use - which happens to be in the first call to Write-VcsStatus which happens the first time the prompt function is called:

WARNING: CheckRequirements.ps1 load time: 90
WARNING: ConsoleMode.ps1 load time: 32  <<< Wow! this is much better
WARNING: Utils.ps1 load time: 154
WARNING: AnsiUtils.ps1 load time: 33
WARNING: WindowTitle.ps1 load time: 8
WARNING: PoshGitTypes.ps1 load time: 29
WARNING: GitUtils.ps1 load time: 38
WARNING: GitPrompt.ps1 load time: 102
WARNING: GitParamTabExpansion.ps1 load time: 33
WARNING: GitTabExpansion.ps1 load time: 150
WARNING: TortoiseGit.ps1 load time: 18
WARNING: Process through configuring prompt func: 30
WARNING: Process through end: 5
WARNING: Total pms1 import time: 745
Loading personal and system profiles took 1817ms.  <<< Profile load time looks better
C:\Users\Keith
11-02 23:11:08 1044ms 1>   <<< But we played a shell game and move the time here  232 > 1044 ms

Now with not using Set-ConsoleMode on PS Core on Windows in a standard ConsoleHost (here we come out pretty good all around):

WARNING: CheckRequirements.ps1 load time: 90
WARNING: ConsoleMode.ps1 load time: 25  <<< Good!
WARNING: Utils.ps1 load time: 147
WARNING: AnsiUtils.ps1 load time: 31
WARNING: WindowTitle.ps1 load time: 8
WARNING: PoshGitTypes.ps1 load time: 34
WARNING: GitUtils.ps1 load time: 41
WARNING: GitPrompt.ps1 load time: 104
WARNING: GitParamTabExpansion.ps1 load time: 30
WARNING: GitTabExpansion.ps1 load time: 136
WARNING: TortoiseGit.ps1 load time: 11
WARNING: Process through configuring prompt func: 30
WARNING: Process through end: 6
WARNING: Total pms1 import time: 714
Loading personal and system profiles took 1840ms.
C:\Users\Keith
11-02 23:14:13 221ms 1>  <<< Good!

One thing I've noted is there is a significant stddev in the GitTabExpansion processing time. I've seen it range from 136 up to 499 ms. That might be good place to look next for module import perf improvements.

I've seen that not using set-consolemode within VSCode/s PS integrated console causes problems after executing git log --graph --decorate.

dahlbyk · 2018-11-11T20:03:11Z

src/ConsoleMode.ps1

+# On Windows, *if* we are running in PowerShell Core *and* the host is the "ConsoleHost",
+# rely on PS Core to manage the console mode.  This speeds up module import on standard
+# PowerShell Core on Windows.
+if (($IsWindows -eq $false) -or (($PSVersionTable.PSVersion.Major -ge 6) -and ($host.Name -eq 'ConsoleHost'))) {


This seems like a future extensibility point for other hosts that don't need Set-ConsoleMode, but this is good for now.

musm · 2018-11-13T01:25:29Z

when will this be available in the beta?

dahlbyk · 2018-11-13T14:54:28Z

I still have a few lingering PRs to catch up with, but I'll try to ship a new beta in the next week or so.

dahlbyk · 2019-03-11T19:43:11Z

I'll try to ship a new beta in the next week or so.

So, uh. Beta 3 shipped yesterday. 🙄

dahlbyk · 2019-09-19T23:42:45Z

src/ConsoleMode.ps1

-    {
-        $outputMode = [NativeConsoleMethods]::GetConsoleMode($false)
-        $null = [NativeConsoleMethods]::SetConsoleMode($false, $outputMode -bor [ConsoleModeOutputFlags]::ENABLE_VIRTUAL_TERMINAL_PROCESSING)
+    begin {


@rkeithhill What's the advantage of splitting this into begin/end?

In this particular case, there is no advantage. Then again, there is no harm either. But I can simplify this if you'd like.

No change necessary unless you find the alternative easier to read. Just curious if I was missing something.

rkeithhill requested review from dahlbyk and lzybkr November 1, 2018 06:04

rkeithhill force-pushed the rkeithhill/defer-add-type branch from 4de0624 to 3a27e74 Compare November 2, 2018 01:31

rkeithhill added 2 commits November 2, 2018 22:09

We can't entirely skip PS Core on Windows, may run in diff host

7fc0c92

Keep this PR simple in scope - just the deferred Add-Type. After a chat w/lzybkr we may want to convert some of this to a binary to help import/prompt processing time.

rkeithhill changed the title ~~On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed~~ WIP: On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed Nov 3, 2018

Try skipping set-consolemode on PSCore on Windows only for ConsoleHost

78ad465

I've seen that not using set-consolemode within VSCode/s PS integrated console causes problems after executing git log --graph --decorate.

rkeithhill force-pushed the rkeithhill/defer-add-type branch from 0a48392 to 78ad465 Compare November 3, 2018 05:23

rkeithhill changed the title ~~WIP: On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed~~ On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed Nov 5, 2018

dahlbyk approved these changes Nov 11, 2018

View reviewed changes

dahlbyk merged commit ce6381b into master Nov 11, 2018

dahlbyk deleted the rkeithhill/defer-add-type branch November 11, 2018 20:03

dahlbyk reviewed Sep 19, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed #638

On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed #638

rkeithhill commented Nov 1, 2018 •

edited

Loading

rkeithhill commented Nov 3, 2018

dahlbyk Nov 11, 2018

musm commented Nov 13, 2018

dahlbyk commented Nov 13, 2018

dahlbyk commented Mar 11, 2019

dahlbyk Sep 19, 2019

rkeithhill Sep 21, 2019

dahlbyk Sep 23, 2019

On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed #638

On Windows PowerShell, defer Add-Type until Set-ConsoleMode executed #638

Conversation

rkeithhill commented Nov 1, 2018 • edited Loading

rkeithhill commented Nov 3, 2018

dahlbyk Nov 11, 2018

Choose a reason for hiding this comment

musm commented Nov 13, 2018

dahlbyk commented Nov 13, 2018

dahlbyk commented Mar 11, 2019

dahlbyk Sep 19, 2019

Choose a reason for hiding this comment

rkeithhill Sep 21, 2019

Choose a reason for hiding this comment

dahlbyk Sep 23, 2019

Choose a reason for hiding this comment

rkeithhill commented Nov 1, 2018 •

edited

Loading