Adds ability to use separate pipes for reading and writing (#785)

* Adds ability to use separate pipes for reading and writing

Some clients (e.g. Java on Windows) have blocking File I/O API, thus it is not possible for them to use single named pipe for reading and writing asynchronously. It will add the ability to use separate pipes for reading and writing when the client specifies the "-SplitInOutPipes" switch for the startup script.

* Use Path.DirectorySeparatorChar as read/write pipe name separator for transport config endpoint

* WritePipeServer: pipe direction should be "Out"

* Organize startup script parameters by parameter sets

* EditorServiceTransportType: Introduce separate properties for read/write pipes

* [ #785 PR ] Cleanup: refactorings, code style and reformat

* remove e in excpe

Author: ant-druha

module/PowerShellEditorServices/PowerShellEditorServices.psm1

@@ -31,15 +31,37 @@ function Start-EditorServicesHost {
         [string]
         $HostVersion,
 
+        [Parameter(ParameterSetName="Stdio",Mandatory=$true)]
         [switch]
         $Stdio,
 
+        [Parameter(ParameterSetName="NamedPipe",Mandatory=$true)]
+        [ValidateNotNullOrEmpty()]
         [string]
         $LanguageServiceNamedPipe,
 
+        [Parameter(ParameterSetName="NamedPipe")]
         [string]
         $DebugServiceNamedPipe,
 
+        [Parameter(ParameterSetName="NamedPipeSimplex",Mandatory=$true)]
+        [ValidateNotNullOrEmpty()]
+        [string]
+        $LanguageServiceInNamedPipe,
+
+        [Parameter(ParameterSetName="NamedPipeSimplex",Mandatory=$true)]
+        [ValidateNotNullOrEmpty()]
+        [string]
+        $LanguageServiceOutNamedPipe,
+
+        [Parameter(ParameterSetName="NamedPipeSimplex")]
+        [string]
+        $DebugServiceInNamedPipe,
+
+        [Parameter(ParameterSetName="NamedPipeSimplex")]
+        [string]
+        $DebugServiceOutNamedPipe,
+
         [ValidateNotNullOrEmpty()]
         [string]
         $BundledModulesPath,
@@ -99,19 +121,32 @@ function Start-EditorServicesHost {
     $debugServiceConfig =
         Microsoft.PowerShell.Utility\New-Object Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportConfig
 
-    if ($Stdio.IsPresent) {
-        $languageServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::Stdio
-        $debugServiceConfig.TransportType    = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::Stdio
-    }
-
-    if ($LanguageServiceNamedPipe) {
-        $languageServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::NamedPipe
-        $languageServiceConfig.Endpoint = "$LanguageServiceNamedPipe"
-    }
-
-    if ($DebugServiceNamedPipe) {
-        $debugServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::NamedPipe
-        $debugServiceConfig.Endpoint = "$DebugServiceNamedPipe"
+    switch ($PSCmdlet.ParameterSetName) {
+        "Stdio" {
+            $languageServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::Stdio
+            $debugServiceConfig.TransportType    = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::Stdio
+            break
+        }
+        "NamedPipe" {
+            $languageServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::NamedPipe
+            $languageServiceConfig.InOutPipeName = "$LanguageServiceNamedPipe"
+            if ($DebugServiceNamedPipe) {
+                $debugServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::NamedPipe
+                $debugServiceConfig.InOutPipeName = "$DebugServiceNamedPipe"
+            }
+            break
+        }
+        "NamedPipeSimplex" {
+            $languageServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::NamedPipe
+            $languageServiceConfig.InPipeName = $LanguageServiceInNamedPipe
+            $languageServiceConfig.OutPipeName = $LanguageServiceOutNamedPipe
+            if ($DebugServiceInNamedPipe -and $DebugServiceOutNamedPipe) {
+                $debugServiceConfig.TransportType = [Microsoft.PowerShell.EditorServices.Host.EditorServiceTransportType]::NamedPipe
+                $debugServiceConfig.InPipeName = $DebugServiceInNamedPipe
+                $debugServiceConfig.OutPipeName = $DebugServiceOutNamedPipe
+            }
+            break
+        }
     }
 
     if ($DebugServiceOnly.IsPresent) {

module/PowerShellEditorServices/Start-EditorServices.ps1

@@ -15,7 +15,7 @@
 #       Services GitHub repository:
 #
 #       https://github.com/PowerShell/PowerShellEditorServices/blob/master/module/PowerShellEditorServices/Start-EditorServices.ps1
-
+[CmdletBinding(DefaultParameterSetName="NamedPipe")]
 param(
     [Parameter(Mandatory=$true)]
     [ValidateNotNullOrEmpty()]
@@ -65,14 +65,37 @@ param(
     [switch]
     $ConfirmInstall,
 
+    [Parameter(ParameterSetName="Stdio",Mandatory=$true)]
     [switch]
     $Stdio,
 
+    [Parameter(ParameterSetName="NamedPipe")]
     [string]
     $LanguageServicePipeName = $null,
 
+    [Parameter(ParameterSetName="NamedPipe")]
+    [string]
+    $DebugServicePipeName = $null,
+
+    [Parameter(ParameterSetName="NamedPipeSimplex")]
+    [switch]
+    $SplitInOutPipes,
+
+    [Parameter(ParameterSetName="NamedPipeSimplex")]
+    [string]
+    $LanguageServiceInPipeName,
+
+    [Parameter(ParameterSetName="NamedPipeSimplex")]
     [string]
-    $DebugServicePipeName = $null
+    $LanguageServiceOutPipeName,
+
+    [Parameter(ParameterSetName="NamedPipeSimplex")]
+    [string]
+    $DebugServiceInPipeName = $null,
+
+    [Parameter(ParameterSetName="NamedPipeSimplex")]
+    [string]
+    $DebugServiceOutPipeName = $null
 )
 
 $DEFAULT_USER_MODE = "600"
@@ -173,8 +196,7 @@ function New-NamedPipeName {
 
     # We try 10 times to find a valid pipe name
     for ($i = 0; $i -lt 10; $i++) {
-        # add a guid to make the pipe unique
-        $PipeName = "PSES_$([guid]::NewGuid())"
+        $PipeName = "PSES_$([System.IO.Path]::GetRandomFileName())"
 
         if ((Test-NamedPipeName -PipeName $PipeName)) {
             return $PipeName
@@ -246,6 +268,37 @@ function Set-NamedPipeMode {
 LogSection "Console Encoding"
 Log $OutputEncoding
 
+function Test-NamedPipeName-OrCreate-IfNull {
+    param(
+        [string]
+        $PipeName
+    )
+    if (-not $PipeName) {
+        $PipeName = New-NamedPipeName
+    }
+    else {
+        if (-not (Test-NamedPipeName -PipeName $PipeName)) {
+            ExitWithError "Pipe name supplied is already taken: $PipeName"
+        }
+    }
+    return $PipeName
+}
+
+function Set-PipeFileResult {
+    param (
+        [Hashtable]
+        $ResultTable,
+        [string]
+        $PipeNameKey,
+        [string]
+        $PipeNameValue
+    )
+    $ResultTable[$PipeNameKey] = Get-NamedPipePath -PipeName $PipeNameValue
+    if ($IsLinux -or $IsMacOS) {
+        Set-NamedPipeMode -PipeFile $ResultTable[$PipeNameKey]
+    }
+}
+
 # Add BundledModulesPath to $env:PSModulePath
 if ($BundledModulesPath) {
     $env:PSModulePath = $env:PSModulePath.TrimEnd([System.IO.Path]::PathSeparator) + [System.IO.Path]::PathSeparator + $BundledModulesPath
@@ -266,81 +319,93 @@ try {
 
     Microsoft.PowerShell.Core\Import-Module PowerShellEditorServices -ErrorAction Stop
 
-    # Locate available port numbers for services
-    # There could be only one service on Stdio channel
-
-    $languageServiceTransport = $null
-    $debugServiceTransport = $null
-
-    if ($Stdio.IsPresent) {
-        $languageServiceTransport = "Stdio"
-        $debugServiceTransport = "Stdio"
-    }
-    else {
-        $languageServiceTransport = "NamedPipe"
-        $debugServiceTransport = "NamedPipe"
-        if (-not $LanguageServicePipeName) {
-            $LanguageServicePipeName = New-NamedPipeName
-        }
-        else {
-            if (-not (Test-NamedPipeName -PipeName $LanguageServicePipeName)) {
-                ExitWithError "Pipe name supplied is already taken: $LanguageServicePipeName"
-            }
-        }
-        if (-not $DebugServicePipeName) {
-            $DebugServicePipeName = New-NamedPipeName
-        }
-        else {
-            if (-not (Test-NamedPipeName -PipeName $DebugServicePipeName)) {
-                ExitWithError "Pipe name supplied is already taken: $DebugServicePipeName"
-            }
-        }
-    }
-
     if ($EnableConsoleRepl) {
         Write-Host "PowerShell Integrated Console`n"
     }
 
-    # Create the Editor Services host
-    Log "Invoking Start-EditorServicesHost"
-    $editorServicesHost =
-        Start-EditorServicesHost `
-            -HostName $HostName `
-            -HostProfileId $HostProfileId `
-            -HostVersion $HostVersion `
-            -LogPath $LogPath `
-            -LogLevel $LogLevel `
-            -AdditionalModules $AdditionalModules `
-            -LanguageServiceNamedPipe $LanguageServicePipeName `
-            -DebugServiceNamedPipe $DebugServicePipeName `
-            -Stdio:$Stdio.IsPresent`
-            -BundledModulesPath $BundledModulesPath `
-            -EnableConsoleRepl:$EnableConsoleRepl.IsPresent `
-            -DebugServiceOnly:$DebugServiceOnly.IsPresent `
-            -WaitForDebugger:$WaitForDebugger.IsPresent
-
-    # TODO: Verify that the service is started
-    Log "Start-EditorServicesHost returned $editorServicesHost"
-
     $resultDetails = @{
-        "status" = "started";
-        "languageServiceTransport" = $languageServiceTransport;
-        "debugServiceTransport" = $debugServiceTransport;
+        "status" = "not started";
+        "languageServiceTransport" = $PSCmdlet.ParameterSetName;
+        "debugServiceTransport" = $PSCmdlet.ParameterSetName;
     };
 
-    if ($LanguageServicePipeName) {
-        $resultDetails["languageServicePipeName"] = Get-NamedPipePath -PipeName $LanguageServicePipeName
-        if ($IsLinux -or $IsMacOS) {
-            Set-NamedPipeMode -PipeFile $resultDetails["languageServicePipeName"]
+    # Create the Editor Services host
+    Log "Invoking Start-EditorServicesHost"
+    # There could be only one service on Stdio channel
+    # Locate available port numbers for services
+    switch ($PSCmdlet.ParameterSetName) {
+        "Stdio" {
+            $editorServicesHost = Start-EditorServicesHost `
+                                        -HostName $HostName `
+                                        -HostProfileId $HostProfileId `
+                                        -HostVersion $HostVersion `
+                                        -LogPath $LogPath `
+                                        -LogLevel $LogLevel `
+                                        -AdditionalModules $AdditionalModules `
+                                        -Stdio `
+                                        -BundledModulesPath $BundledModulesPath `
+                                        -EnableConsoleRepl:$EnableConsoleRepl.IsPresent `
+                                        -DebugServiceOnly:$DebugServiceOnly.IsPresent `
+                                        -WaitForDebugger:$WaitForDebugger.IsPresent
+            break
         }
-    }
-    if ($DebugServicePipeName) {
-        $resultDetails["debugServicePipeName"] = Get-NamedPipePath -PipeName $DebugServicePipeName
-        if ($IsLinux -or $IsMacOS) {
-            Set-NamedPipeMode -PipeFile $resultDetails["debugServicePipeName"]
+        "NamedPipeSimplex" {
+            $LanguageServiceInPipeName = Test-NamedPipeName-OrCreate-IfNull $LanguageServiceInPipeName
+            $LanguageServiceOutPipeName = Test-NamedPipeName-OrCreate-IfNull $LanguageServiceOutPipeName
+            $DebugServiceInPipeName = Test-NamedPipeName-OrCreate-IfNull $DebugServiceInPipeName
+            $DebugServiceOutPipeName = Test-NamedPipeName-OrCreate-IfNull $DebugServiceOutPipeName
+
+            $editorServicesHost = Start-EditorServicesHost `
+                                        -HostName $HostName `
+                                        -HostProfileId $HostProfileId `
+                                        -HostVersion $HostVersion `
+                                        -LogPath $LogPath `
+                                        -LogLevel $LogLevel `
+                                        -AdditionalModules $AdditionalModules `
+                                        -LanguageServiceInNamedPipe $LanguageServiceInPipeName `
+                                        -LanguageServiceOutNamedPipe $LanguageServiceOutPipeName `
+                                        -DebugServiceInNamedPipe $DebugServiceInPipeName `
+                                        -DebugServiceOutNamedPipe $DebugServiceOutPipeName `
+                                        -BundledModulesPath $BundledModulesPath `
+                                        -EnableConsoleRepl:$EnableConsoleRepl.IsPresent `
+                                        -DebugServiceOnly:$DebugServiceOnly.IsPresent `
+                                        -WaitForDebugger:$WaitForDebugger.IsPresent
+
+            Set-PipeFileResult $resultDetails "languageServiceReadPipeName" $LanguageServiceInPipeName
+            Set-PipeFileResult $resultDetails "languageServiceWritePipeName" $LanguageServiceOutPipeName
+            Set-PipeFileResult $resultDetails "debugServiceReadPipeName" $DebugServiceInPipeName
+            Set-PipeFileResult $resultDetails "debugServiceWritePipeName" $DebugServiceOutPipeName
+            break
+        }
+        Default {
+            $LanguageServicePipeName = Test-NamedPipeName-OrCreate-IfNull $LanguageServicePipeName
+            $DebugServicePipeName = Test-NamedPipeName-OrCreate-IfNull $DebugServicePipeName
+
+            $editorServicesHost = Start-EditorServicesHost `
+                                        -HostName $HostName `
+                                        -HostProfileId $HostProfileId `
+                                        -HostVersion $HostVersion `
+                                        -LogPath $LogPath `
+                                        -LogLevel $LogLevel `
+                                        -AdditionalModules $AdditionalModules `
+                                        -LanguageServiceNamedPipe $LanguageServicePipeName `
+                                        -DebugServiceNamedPipe $DebugServicePipeName `
+                                        -BundledModulesPath $BundledModulesPath `
+                                        -EnableConsoleRepl:$EnableConsoleRepl.IsPresent `
+                                        -DebugServiceOnly:$DebugServiceOnly.IsPresent `
+                                        -WaitForDebugger:$WaitForDebugger.IsPresent
+
+            Set-PipeFileResult $resultDetails "languageServicePipeName" $LanguageServicePipeName
+            Set-PipeFileResult $resultDetails "debugServicePipeName" $DebugServicePipeName
+            break
         }
     }
 
+    # TODO: Verify that the service is started
+    Log "Start-EditorServicesHost returned $editorServicesHost"
+
+    $resultDetails["status"] = "started"
+
     # Notify the client that the services have started
     WriteSessionFile $resultDetails
 

src/PowerShellEditorServices.Host/EditorServicesHost.cs

@@ -44,7 +44,10 @@ public class EditorServiceTransportConfig
         /// For Stdio it's ignored.
         /// For NamedPipe it's the pipe name.
         /// </summary>
-        public string Endpoint { get; set; }
+        public string InOutPipeName { get; set; }
+        public string OutPipeName { get; set; }
+        public string InPipeName { get; set; }
+        internal string Endpoint => OutPipeName != null && InPipeName != null ? $"In pipe: {InPipeName} Out pipe: {OutPipeName}" : $" InOut pipe: {InOutPipeName}";
     }
 
     /// <summary>
@@ -463,7 +466,15 @@ private IServerListener CreateServiceListener(MessageProtocolType protocol, Edit
 
                 case EditorServiceTransportType.NamedPipe:
                 {
-                    return new NamedPipeServerListener(protocol, config.Endpoint, this.logger);
+                    if (config.OutPipeName !=null && config.InPipeName !=null)
+                    {
+                        this.logger.Write(LogLevel.Verbose, $"Creating NamedPipeServerListener for ${protocol} protocol with two pipes: In: '{config.InPipeName}'. Out: '{config.OutPipeName}'");
+                        return new NamedPipeServerListener(protocol, config.InPipeName, config.OutPipeName, this.logger);
+                    }
+                    else
+                    {
+                        return new NamedPipeServerListener(protocol, config.InOutPipeName, this.logger);
+                    }
                 }
 
                 default: