Powershell Prompt Double Execution #468

lzybkr · 2016-11-09T20:43:44Z

From @whatevergeek on August 18, 2016 18:44

Version: powershell_6.0.0-alpha.9-1ubuntu1.14.04.1_amd64.deb
Platform: Ubuntu 14.04

Steps to reproduce

Modify $profile file and add the following function inside
function prompt
{
Write-Host ("This>")
return " "
}
Exit and re-enter powershell
Check the commandline prompt

Expected behavior

It should only print "This>" once.

Actual behavior

It prints "This>" twice.

Environment data

> $PSVersionTable
Name                           Value                                                                 
----                           -----                                                                 
PSVersion                      6.0.0-alpha                                                           
PSEdition                      Core                                                                  
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}                                               
BuildVersion                   3.0.0.0                                                               
GitCommitId                    v6.0.0-alpha.9                                                        
CLRVersion                                                                                           
WSManStackVersion              3.0                                                                   
PSRemotingProtocolVersion      2.3                                                                   
SerializationVersion           1.1.0.1

Copied from original issue: PowerShell/PowerShell#1897

lzybkr · 2016-11-09T20:43:44Z

From @lukemgriffith on August 18, 2016 23:11

I'm also seeing the same on MacOS 10.11.6


PS /Users/luke/Downloads> $IsOSX                                                                                                                                                   
True
PS /Users/luke/Downloads> $PSVersionTable                                                                                                                                          

Name                           Value                                                                                                                                              
----                           -----                                                                                                                                              
PSVersion                      6.0.0-alpha                                                                                                                                        
PSEdition                      Core                                                                                                                                               
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}                                                                                                                            
BuildVersion                   3.0.0.0                                                                                                                                            
GitCommitId                    v6.0.0-alpha.9                                                                                                                                     
CLRVersion                                                                                                                                                                        
WSManStackVersion              3.0                                                                                                                                                
PSRemotingProtocolVersion      2.3                                                                                                                                                
SerializationVersion           1.1.0.1  


$VerbosePreference = "Continue"

function prompt {

  Write-Verbose "Test"

}

I see the verbose "Test" twice.

lzybkr · 2016-11-09T20:43:45Z

From @Jaykul on August 18, 2016 23:38

Ditto for Ubuntu 16.04

I had to stop using Write-Host ... now using escape sequences for color ;-)

lzybkr · 2016-11-09T20:43:45Z

From @myyc on August 20, 2016 10:50

@Jaykul can you share details? it seems ANSI escape sequences aren't supported out of the box

lzybkr · 2016-11-09T20:43:45Z

From @whatevergeek on August 20, 2016 11:21

@myyc which details you need?
my hunch is that whatever posted by write-host
gets posted twice

i'm still in the process of getting the source built on my machine... will try to help also once i get the setup done :-)

lzybkr · 2016-11-09T20:43:45Z

From @myyc on August 20, 2016 11:26

@whatevergeek details on how to use escape sequences instead of write-host ...

lzybkr · 2016-11-09T20:43:46Z

From @theaquamarine on August 22, 2016 22:45

@myyc there's a bit of an example here dahlbyk/posh-git#282 (comment)

lzybkr · 2016-11-09T20:43:46Z

From @Jaykul on August 23, 2016 0:5

Oh, I'm sorry, I didn't mean to leave you hanging. Here's what I have so far, it works on Windows 10 and Linux, even in VS Code ... but obviously not anywhere that ANSI escape sequences don't work (e.g. ISE): http://poshcode.org/6485

rspaulino · 2016-12-29T18:03:45Z

@lzybkr
I try to follow your demo to get color on my prompt and when I login it work I see my color prompt but the moment I type something the escape character break.

any ideas?

function prompt {
return "$([char]0x1b)[91m >_ $([char]0x1b)[0m"
}

PowerShell
Copyright (C) 2016 Microsoft Corporation. All rights reserved.

_

PowerShell
Copyright (C) 2016 Microsoft Corporation. All rights reserved.

[91clear

rkeithhill · 2017-01-27T19:00:22Z

You probably already know this but avoiding Write-Host doesn't prevent double execution of the prompt function. It just makes it a bit less obvious:

In fact, what I notice with the prompt function is that the first two or three characters from the first line of my prompt get redisplayed on the second line as soon as I type any character:

eamodio · 2017-01-27T20:27:04Z

Yeah, I see the same thing -- I originally reported that here PowerShell/PowerShell#2770 (comment)

lzybkr · 2017-01-27T20:58:08Z

The double invocation shouldn't be there (I pointed out the problem before it got merged originally) - but it was put there to support making the prompt red on error. When that goes, we will need a new way to indicate errors.

rkeithhill · 2017-01-28T07:31:04Z

I wonder if you could change the color of the cursor to the error colors?

rkeithhill · 2017-02-08T19:20:05Z

Could we get an option to disable the error indicator until this issue is fixed? Or if this isn't an option you want long term, perhaps an env var we can use to "backdoor" disable it? Say PSREADLINE_DISABLE_ERROR_INDICATOR or some such env var.

branneman · 2017-05-19T14:35:43Z

Any idea when this will be fixed? The issue still persists in:

PS> $IsOSX
True

PS> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      6.0.0-alpha
PSEdition                      Core
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   3.0.0.0
GitCommitId                    v6.0.0-alpha.18
CLRVersion
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

PowerSchill · 2017-05-26T14:48:06Z

Still in beta-1

Name                           Value
----                           -----
PSVersion                      6.0.0-beta
PSEdition                      Core
BuildVersion                   3.0.0.0
CLRVersion
GitCommitId                    v6.0.0-beta.1
OS                             Darwin 16.6.0 Darwin Kernel Version 16.6.0: Fri Apr 14 16:21:16 PDT 2017; root:xnu-3789.60.24~6/RELEASE_X86_64
Platform                       Unix
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

daxian-dbw · 2017-05-26T18:29:39Z

I try to follow your demo to get color on my prompt and when I login it work I see my color prompt but the moment I type something the escape character break.

A fix was made in the powershell repository to address this, though not fully. See PowerShell/PowerShell#3867

lzybkr · 2017-09-28T04:57:20Z

This branch has a fix (and supports escape sequences) but isn't quite ready - I think just one big thing left for Linux - custom key bindings. It's very usable on Windows right now.

drvink · 2017-10-05T09:08:37Z

@lzybkr Great! Should this branch "just work" if we compile the module and make sure it will be loaded first in $env:PSModulePath?

lzybkr · 2017-10-05T15:12:37Z

@drvink - Not quite. In Windows PowerShell, yes, but you probably don't care about Windows PowerShell.

PowerShell Core lists PSReadline in it's trust platform assemblies, so you can't actually update it via the module path. There are 2 options:

Replace the module (I think it's just the psd1 and dll) where PowerShell Core is installed
Drop the current source into a build of PowerShell and build that

I've done both, 1. on Windows and 2. on Linux. I've done minimal testing in PowerShell Core, definitely more on Windows, and I think it mostly works on Windows.

On Linux you won't get custom key binding support yet. There is also one serious bug that crashes PowerShell (as in, it exits). I believe it's a .Net bug but haven't thoroughly investigated. The bug happens when you use Shift+arrows to select. It also depends on something else that I haven't tracked down, but if you repeatedly hit Shift+arrow, you might not hit it, but if you don't release the arrow key, you will probably hit it.

gwojan · 2017-10-05T15:54:03Z

@lzybkr I just dropped the updated module into my profile path:

PS C:\Users\wojang> (Get-Module PSReadLine).ModuleBase
C:\Users\wojang\Documents\PowerShell\Modules\PSReadLine\2.0
PS C:\Users\wojang> Get-Module psreadline -ListAvailable


    Directory: C:\Users\wojang\Documents\PowerShell\Modules


ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     2.0        PSReadLine                          {Get-PSReadlineKeyHandler, Set-PSReadlineKeyHandler, Remov...


    Directory: C:\program files\powershell\6.0.0-beta.7\Modules


ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     1.2        PSReadLine                          {Get-PSReadlineKeyHandler,

lzybkr · 2017-10-05T16:04:33Z

But did it load it? You can check with [Microsoft.PowerShell.PSConsoleReadLine].Assembly.Location

gwojan · 2017-10-05T16:12:49Z

@lzybkr Well... Crap... No... ☹️

I guess that explains some differences I've noticed in PSReadline handling between PowerShell 5.1 and PowerShell 6... < le sigh />

No I just have to find that list again...

rkeithhill · 2017-10-15T05:50:48Z

I managed to get PSReadLine to compile in my WSL shell using the .NET Core 2.0 SDK. I had to generate a new csproj file and ifdef out some code in PSReadLine.cs that was accessing some Runspace debugger properties that don't exist in PowerShellStandard.Library v3. But it compiles and sort of runs:

But as you can see, the chars appear not where the cursor is and with extra spaces. Haven't had a chance to debug this yet but was just wondering if this is a futile exercise or not?

It would be nice to be able to build PSReadLine on non-Windows systems.

FWIW here's the CSPROJ file I'm using:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.CSharp" Version="4.4.0" />
    <PackageReference Include="PowerShellStandard.Library" Version="3.0.0-preview-01" />
  </ItemGroup>
  <ItemGroup>
    <Compile Update="PSReadLineResources.Designer.cs">
      <DesignTime>True</DesignTime>
      <AutoGen>True</AutoGen>
      <DependentUpon>PSReadLineResources.resx</DependentUpon>
    </Compile>
  </ItemGroup>
  <ItemGroup>
    <EmbeddedResource Update="PSReadLine.Resources.resx">
      <Generator>ResXFileCodeGenerator</Generator>
      <LastGenOutput>PSReadLineResources.Designer.cs</LastGenOutput>
    </EmbeddedResource>
  </ItemGroup>
</Project>

lzybkr · 2017-10-15T15:37:54Z

I haven't tried in WSL yet, but @SteveL-MSFT said it worked for him. Debugging would be great - the rendering code no longer uses Win32 console apis - it's pure .Net, so it should work anywhere.

I have copied the sources into the PowerShell repo and built from there on Linux.

It would also be nice to get the tests running on Linux.

I'm avoiding the move to netstandard2.0 until the PowerShell team figures out how to deploy the type forwarding dlls because no module should be doing that.

rkeithhill · 2017-10-16T05:24:28Z

The PSReadLine assembly didn't have the resources defined in the right namespace. I added the RootNamespace directive to the project file and that cleared one of the issues I was seeing with rendering. No extra spaces now and the cursor tracks typing.

I did manage to get the unit tests to compile but only about 5 out of 150 pass. The vast majority fail because of a null ref exception on rs.Open() in the UnitTest static constructor:

            var iss = InitialSessionState.CreateDefault2();
            var rs = RunspaceFactory.CreateRunspace(iss);
            rs.Open();

In fact, iss comes back as null as well. I'm not sure exactly what is going on here. This is the error I see:

Failed   UnitTestPSReadLine.UnitTest.ViTestCharDelete
Error Message:
 Unable to create instance of class UnitTestPSReadLine.UnitTest. Error: System.NullReferenceException: Object reference not set to an instance of an object..
Stack Trace:
    at UnitTestPSReadLine.UnitTest..cctor() in C:\Users\Keith\GitHub\lzybkr\PSReadLine\UnitTestPSReadLine\UnitTestReadLine.cs:line 365

Oh yeah, I had to comment out a fair bit of test code that was testing the clipboard. You can see the changes I've made so far in my repo - rkeithhill@e3beb6f

BTW when I debug this from VSCode, I see a lot of DLLs loaded but I don't see SMA.dll.

lzybkr · 2017-10-17T01:46:37Z

I believe this is fixed in #561.

I'll publish a pre-release version to the PowerShell Gallery as soon as they support pre-releases.

If you'd like to try a fix before that, you can build the lastest yourself from the master branch, or
grab a build from AppVeyor like this one.

Note the version number is now 2.0, so be sure to copy the contents to \PSReadLine\2.0.

drvink · 2017-10-20T12:26:19Z

With some small changes I was able to drop the PSReadLine master branch into the PowerShell git repo (using tag v6.0.0-beta.8) and build it on Linux. It's mostly working! Looks fine in a bare xterm, but try running powershell under screen--you should get some junk at the prompt as soon as you start typing.

lzybkr · 2017-10-20T14:15:18Z

The binary built from this repo works in PowerShell Core all platforms too.

Artifacts in screen are new? I wonder if I'm using an escape sequence that isn't supported under screen.

drvink · 2017-10-20T14:53:34Z

The junk I'm seeing is [37m[40m[0m, which are parts of SGR sequences: set foreground color white, set background black, set normal. If they're showing up for you (i.e. if you can reproduce), try seeing what's actually getting written to the terminal (with strace or similar).

lzybkr · 2017-10-20T16:11:01Z

I can reproduce, and I'm strace noob, but I can't see anything in the output that looks like what I'm sending, either with v1.2 (which works in screen) or in v2.0 which doesn't.

drvink · 2017-10-20T16:39:49Z

Sorry, brainfart--you would want to strace the screen daemon process, so that you can see what powershell is writing to it. Here's what strace -p $PIDGOESHERE -e read=all -e write=all shows after I press a key to make the junk appear at the prompt (this asks to produce a hexdump of the full contents of reads and writes to any of that PID's file descriptors):

arch-vm[1022]:~% sudo strace -p 5249 -e read=all -e write=all
strace: Process 5249 attached
select(1024, [3 4 6 7 8 10], [], NULL, NULL) = 1 (in [10])
read(10, "a", 4096)                     = 1
 | 00000  61                                                a                |
select(1024, [3 4 6 7 8 10], [8], NULL, NULL) = 1 (out [8])
write(8, "a", 1)                        = 1
 | 00000  61                                                a                |
select(1024, [3 4 6 7 8 10], [], NULL, NULL) = 1 (in [8])
read(8, " ", 4096)                      = 1
 | 00000  20                                                                 |
ioctl(10, SNDCTL_TMR_START or TCSETS, {B38400 opost -isig -icanon -echo ...}) = 0
select(1024, [3 4 6 7 8 10], [], NULL, NULL) = 1 (in [8])
read(8, "\0\33[?25l", 4096)             = 7
 | 00000  00 1b 5b 3f 32 35 6c                              ..[?25l          |
select(1024, [3 4 6 7 8 10], [10], NULL, NULL) = 1 (out [10])
write(10, "\33[?25l", 6)                = 6
 | 00000  1b 5b 3f 32 35 6c                                 .[?25l           |
select(1024, [3 4 6 7 8 10], [], NULL, NULL) = 1 (in [8])
read(8, "\20", 4096)                    = 1
 | 00000  10                                                .                |
ioctl(10, TCXONC, TCOON)                = 0
ioctl(10, SNDCTL_TMR_START or TCSETS, {B38400 opost -isig -icanon -echo ...}) = 0
select(1024, [3 4 6 7 8 10], [], NULL, NULL) = 1 (in [8])
read(8, "\0\33[16;49H\33\0[\0009\0003\0m\0a\0\33\0[\0003\0007\0m\0\33"..., 4096) = 68
 | 00000  00 1b 5b 31 36 3b 34 39  48 1b 00 5b 00 39 00 33  ..[16;49H..[.9.3 |
 | 00010  00 6d 00 61 00 1b 00 5b  00 33 00 37 00 6d 00 1b  .m.a...[.3.7.m.. |
 | 00020  00 5b 00 34 00 30 00 6d  00 1b 00 5b 00 30 00 6d  .[.4.0.m...[.0.m |
 | 00030  00 1b 5b 31 36 3b 35 30  48 1b 5b 33 34 68 1b 5b  ..[16;50H.[34h.[ |
 | 00040  3f 32 35 68                                       ?25h             |
select(1024, [3 4 6 7 8 10], [10], NULL, NULL) = 1 (out [10])
write(10, "[93ma[37m[40m[0m\33[15D\33[?12l\33[?25"..., 33) = 33
 | 00000  5b 39 33 6d 61 5b 33 37  6d 5b 34 30 6d 5b 30 6d  [93ma[37m[40m[0m |
 | 00010  1b 5b 31 35 44 1b 5b 3f  31 32 6c 1b 5b 3f 32 35  .[15D.[?12l.[?25 |
 | 00020  68                                                h                |

The last read is what powershell is writing to screen's pty, and the write is what the screen daemon is writing to the attached client (which shows up on our terminal). Looks like some of the sequences are being output with each character as a 16-bit/.NET-style char rather than what was actually intended.

lzybkr · 2017-10-20T17:45:42Z

Thanks, that's super helpful.

I had to set Console.OutputEncoding = Encoding.Unicode for CJK characters, and that definitely fixed an issue on Windows and it seems like it also fixed CJK on Linux, see #542.

So the quick fix is to just remove where I do that, but I'm not sure that's the right fix.

lzybkr · 2017-11-02T05:22:43Z

@drvink - I just pushed what should fix the screen problem - I should have used UTF8 instead of Unicode for the output encoding - the CJK issue still seems fixed, so hopefully screen will be fine too.

drvink · 2017-11-03T09:08:57Z

@lzybkr Thanks! I don't have time to test it at the moment, but that sounds like the right fix to me as well. I'll try to comment when I get a chance to rebuild with the new changes, but if you aren't getting the incorrectly-emitted escape sequences when you strace, it's most likely fixed now.

lzybkr · 2017-11-04T00:35:09Z

I'll have an official prerelease build out next week if you want to verify this is fixed, otherwise you can grab a build out of appveyor here.

pcgeek86 · 2017-11-09T22:39:13Z

When I extract the ZIP artifact, it has backslashes in the file names, instead of forward slashes, which breaks the module file paths.

lzybkr · 2017-11-10T06:09:18Z

Compress-Archive is creating the archive - but I assume that will be a non-issue when installing from the PowerShell Gallery.

drvink · 2017-11-16T22:51:43Z

@lzybkr Just wanted to report that things work fine under screen now. Thanks!

SteveL-MSFT · 2017-11-16T23:28:53Z

@pcgeek86 the backslashes is an issue with compress-archive which I opened here PowerShell/Microsoft.PowerShell.Archive#48

pcgeek86 · 2017-11-17T21:15:06Z

@SteveL-MSFT Cool, thank you for calling that out!

lzybkr self-assigned this Nov 9, 2016

lzybkr added Area-PSReadLine labels Nov 9, 2016

lzybkr mentioned this issue Nov 9, 2016

Powershell Prompt Double Execution PowerShell/PowerShell#1897

Closed

lzybkr mentioned this issue Nov 28, 2016

Custom prompt with newline on macOS gets corrupted on entry PowerShell/PowerShell#2770

Closed

rkeithhill mentioned this issue Dec 29, 2016

PowerShell Core on Linux support dahlbyk/posh-git#302

Closed

5 tasks

lzybkr removed 3 - Working labels Jan 12, 2017

This was referenced Jan 12, 2017

Looks like changing the prompt leads to problems? #444

Closed

Garbage characters displayed in prompt on Ubuntu 14.04 #454

Closed

rkeithhill mentioned this issue Feb 18, 2017

OSX prompt suffix showed two times dahlbyk/posh-git#426

Closed

lzybkr mentioned this issue Apr 14, 2017

Prompt runs twice on linux PowerShell/PowerShell#3561

Closed

lzybkr mentioned this issue May 2, 2017

Multiline prompt behaves incorrectly on macOS PowerShell/PowerShell#3687

Closed

lzybkr mentioned this issue Aug 14, 2017

Prompt function with Write-Host on MacOS 10.12.5 PowerShell/PowerShell#4191

Closed

rkeithhill mentioned this issue Sep 28, 2017

Duplicate prompt dahlbyk/posh-git#486

Closed

lzybkr added the Resolution-Fixed label Oct 17, 2017

lzybkr closed this as completed Nov 4, 2017

markekraus mentioned this issue Dec 5, 2017

[BUG] Using Write-Host in custom promt function causes prompt to break. PowerShell/PowerShell#5630

Closed

lzybkr mentioned this issue Jun 14, 2018

Prompt Function in $PROFILE works incorrectly PowerShell/PowerShell#7056

Closed

Powershell Prompt Double Execution #468

Powershell Prompt Double Execution #468

Comments

lzybkr commented Nov 9, 2016

Steps to reproduce

Expected behavior

Actual behavior

Environment data

lzybkr commented Nov 9, 2016

lzybkr commented Nov 9, 2016

lzybkr commented Nov 9, 2016

lzybkr commented Nov 9, 2016

lzybkr commented Nov 9, 2016

lzybkr commented Nov 9, 2016

lzybkr commented Nov 9, 2016

rspaulino commented Dec 29, 2016

function prompt { return "$([char]0x1b)[91m >_ $([char]0x1b)[0m" }

rkeithhill commented Jan 27, 2017

eamodio commented Jan 27, 2017

lzybkr commented Jan 27, 2017

rkeithhill commented Jan 28, 2017

rkeithhill commented Feb 8, 2017

branneman commented May 19, 2017 • edited Loading

PowerSchill commented May 26, 2017

daxian-dbw commented May 26, 2017

lzybkr commented Sep 28, 2017

drvink commented Oct 5, 2017

lzybkr commented Oct 5, 2017

gwojan commented Oct 5, 2017

lzybkr commented Oct 5, 2017

gwojan commented Oct 5, 2017

rkeithhill commented Oct 15, 2017

lzybkr commented Oct 15, 2017

rkeithhill commented Oct 16, 2017 • edited Loading

lzybkr commented Oct 17, 2017

drvink commented Oct 20, 2017 • edited Loading

lzybkr commented Oct 20, 2017

drvink commented Oct 20, 2017

lzybkr commented Oct 20, 2017

drvink commented Oct 20, 2017 • edited Loading

lzybkr commented Oct 20, 2017 • edited Loading

lzybkr commented Nov 2, 2017

drvink commented Nov 3, 2017

lzybkr commented Nov 4, 2017

pcgeek86 commented Nov 9, 2017

lzybkr commented Nov 10, 2017

drvink commented Nov 16, 2017

SteveL-MSFT commented Nov 16, 2017

pcgeek86 commented Nov 17, 2017

function prompt {
return "$([char]0x1b)[91m >_ $([char]0x1b)[0m"
}

branneman commented May 19, 2017 •

edited

Loading

rkeithhill commented Oct 16, 2017 •

edited

Loading

drvink commented Oct 20, 2017 •

edited

Loading

drvink commented Oct 20, 2017 •

edited

Loading

lzybkr commented Oct 20, 2017 •

edited

Loading