nodejs / nodejs/node

Unix Domain Socket doesn't support on Windows

Open
#55,979 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

libuv windows
Dominant language
JavaScript
Stars
122k
Forks
37.3k
Avg merge
4d 2h
Merged PRs (30d)
283

Description

Version

20.18.0

Platform
Microsoft Windows NT 10.0.26100.0 x64
Subsystem

No response

What steps will reproduce the bug?

Currently, Windows (at least .NET) supports connect to UnixDomainSocket, or listen to UnixDomainSocket in ASP.NET Core. But node's net module seems not support connect to a Windows local file.

public class UnixDomainSocketsConnectionFactory(EndPoint endPoint) {
   public async ValueTask<Stream> ConnectAsync(SocketsHttpConnectionContext _,
      CancellationToken cancellationToken = default) {
      var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified);

      try {
         await socket.ConnectAsync(endPoint, cancellationToken).ConfigureAwait(false);
         return new NetworkStream(socket, true);
      } catch {
         socket.Dispose();
         throw;
      }
   }

   public static GrpcChannel CreateChannel(string socketPath) {
      var udsEndPoint = new UnixDomainSocketEndPoint(socketPath);
      var connectionFactory = new UnixDomainSocketsConnectionFactory(udsEndPoint);
      var socketsHttpHandler = new SocketsHttpHandler {
         ConnectCallback = connectionFactory.ConnectAsync
      };

      return GrpcChannel.ForAddress("http://localhost", new GrpcChannelOptions {
         HttpHandler = socketsHttpHandler
      });
   }
}
   protected void Initialize(string token) {
      var builder = WebApplication.CreateBuilder();
      builder.WebHost.ConfigureKestrel(serverOptions => {
         if (!Directory.Exists(MetaBoxStatic.UnixSocketPath)) {
            Directory.CreateDirectory(MetaBoxStatic.UnixSocketPath);
         }

         var socketPath = Path.Combine(MetaBoxStatic.UnixSocketPath, $"MetaBox-{token}.tmp");
         serverOptions.ListenUnixSocket(socketPath);
         serverOptions.ConfigureEndpointDefaults(listenOptions => { listenOptions.Protocols = HttpProtocols.Http2; });
      });

      ConfigureBuilder(builder);
      builder.Services.PostConfigureAll<HostOptions>(opts => opts.ShutdownTimeout = TimeSpan.FromSeconds(1));

      WebApp = builder.Build();
      ConfigureApp(WebApp);
   }
How often does it reproduce? Is there a required condition?

Always

What is the expected behavior? Why is that the expected behavior?

The net connects to the "Windows" UnixDomainSocket as it could.

What do you see instead?

EACCESS / ENOENT

Additional information

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Node.js's net module handling of Unix domain sockets on Windows and reproduce the failure using the supplied Windows and .NET examples. Done means Node can connect to and listen on the Windows UnixDomainSocket, with the reported EACCESS and ENOENT errors resolved; add or run the relevant platform-specific tests if available.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
networking, operating-systems
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.