型が自動的にキャストされてエラーになる！

Question

実現したいこと

PowerShellでWebSocketのサーバを作っていますが、エラーが出ます。

詳細

.Net の System.Net を使って WebScoket のサーバを作っています。
下記のリファレンスの通り、次のようにコールしているんですが、後述のようなエラーが出てしまいます。

リファレンス

https://learn.microsoft.com/ja-jp/dotnet/api/system.net.httplistenercontext.acceptwebsocketasync?view=net-8.0

コール

$objContext.AcceptWebSocketAsync($null)

発生している問題・エラーメッセージ

"1" 個の引数を指定して "AcceptWebSocketAsync" を呼び出し中に例外が発生しました: "空の文字列は、有効な subprotocol 値ではありません。値を指定しない場合は、"null" を使用してください。

試したこと

調べた限りでは、この関数のオーバーロードのもととなる関数は引数が３つの関数のようでしたので、そのリファレンスに従ってコールしましたが、同じエラーが出ました。
おそらく、なぜか null が string にキャストされて string.empty になってるんだと思いますが、解決策がわかりません。

Answer 1

$objContext.AcceptWebSocketAsync($null)での呼び出し部分は、$nullではなく[NullString]::Valueで指定すると成功します。

    $wsContextTask = $context.AcceptWebSocketAsync([NullString]::Value)

以下の簡単なPowerShellスクリプトによるWebSocketサーバーのサンプルプログラムで実行例を示します。もとはAIのCopilotさん提案のコードを元に、更に簡単にしたものです。尚、クライアント側はWebブラウザー上からJavaScriptで実行する簡単なコードなので、割愛します。

# t4c.ps1
#Add-Type -AssemblyName System.Net.HttpListener
#Add-Type -AssemblyName System.Net.WebSockets

$listener = New-Object System.Net.HttpListener
$listener.Prefixes.Add("http://localhost:8081/ws/")
$listener.Start()
Write-Host "Listening on ws://localhost:8081/ws/..."
$context = $listener.GetContext()

if ($context.Request.IsWebSocketRequest) {
    # Accept the WebSocket connection
    # $nullでは失敗する
    $wsContextTask = $context.AcceptWebSocketAsync($null)
    Write-Host "#pass1 : $wsContextTask"

    # [NullString]::Valueで成功する
    $wsContextTask = $context.AcceptWebSocketAsync([NullString]::Value)

    # $wsContextTaskが返っていることを確認
    Write-Host "#pass2 : $wsContextTask"
    $wsContextTask.Wait()

    $wsContext = $wsContextTask.Result
    $websocket = $wsContext.WebSocket

    Write-Host "WebSocket connection accepted!"

    $websocket.Dispose()
} else {
    $context.Response.StatusCode = 400
    $context.Response.Close()
    Write-Host "Rejected non-WebSocket request."
}

クライアントからはws://localhost:8081/ws/で接続します。これを実行してみます。

PS> # PowerShellのバージョン
PS> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      5.1.19041.5965
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.19041.5965
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1


PS> PowerShell -ExecutionPolicy RemoteSigned .\t4c.ps1
Listening on ws://localhost:8081/ws/...
"1" 個の引数を指定して "AcceptWebSocketAsync" を呼び出し中に例外が発生しました: "空の文字列は、有効な subprotocol 値で
はありません。値を指定しない場合は、"null" を使用してください。
パラメーター名:subProtocol"
発生場所 C:\_work\ClassLibrary1\t4c.ps1:14 文字:5
+     $wsContextTask = $context.AcceptWebSocketAsync($null)
+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [], MethodInvocationException
    + FullyQualifiedErrorId : ArgumentException

#pass1 :
#pass2 : System.Threading.Tasks.Task`1[System.Net.WebSockets.HttpListenerWebSocketContext]
WebSocket connection accepted!
PS>

$nullを指定しての呼び出しではご質問と同様のエラーが発生し、[NullString]::Valueでは成功していることが分かると思います。

おそらく、なぜか null が string にキャストされて string.empty になってるんだと思いますが、

これはほぼご推測の通りで、.NETのメソッドについて$nullをSystem.String型の引数に指定するとPowerShellによってnullではなく空文字列""に変換されてしまうようです。Microsoftが個人のブログを共有したかたちで記事を載せているので、公式の情報と言ってよいのでしょう。

$nullについて知りたいこと - Microsoft Learn

※上記は自動翻訳による日本語記事なので、ところどころ読みづらい部分があります。元の英語記事はこちら。
Everything you wanted to know about $null - Microsoft Learn

nullではない空文字列は$s = ""のように表現できるのに、$nullをSystem.Stringな引数に渡したメソッド呼び出し時に変換されてしまうのは私個人的にもちょっと不便、と言うか余計なお世話にも感じますね。まぁ、スクリプトと.NETの相互運用性から便宜を図る意図があったのでしょう。

---

[NullString]::Value について追記：

[NullString]::ValueについてはPowerShellの$nullとC#のstringの扱いについての話題でたまに見かけるのですが、なかなか公式のリファレンスには辿り着きづらいようです。今回の回答にあたって気になっていたので、少し調べていました。

PowerShell SDKの以下の情報がそれにあたるようです。

NullString Class - Microsoft Learn

Definition
...
This type is introduced to provide a way to pass null into a .NET method that has a string parameter.

との説明なので、まさにその用途のクラスですね。

Comments

[dodox86]

ちなみにAIを使う場合(私の場合は主にCopilotさん)ですが、.NETのメソッドのSystem.Stringの引数に渡すのに$nullを使うかんじの使えない代替の提案をしてくるのが主でした。[NullString]::Valueにはなかなかたどり着けないかもしれません。単にWEB検索しても、少なくとも現時点では[NullString]については情報が少ないですね。

[Workshop_Lilla]

回答ありがとうございます。
試したところ問題が解決しました！
ベストアンサーに選ばせていただきました。
これは自力では全然たどり着けませんでした、お見事です！ありがとうございました！