Support listening on Unix domain sockets (UDS) file descriptors (FDs)

Author: clue

src/FdServer.php

@@ -35,6 +35,7 @@ final class FdServer extends EventEmitter implements ServerInterface
 {
     private $master;
     private $loop;
+    private $unix = false;
     private $listening = false;
 
     /**
@@ -115,6 +116,10 @@ public function __construct($fd, LoopInterface $loop = null)
             throw new \RuntimeException('Failed to listen on FD ' . $fd . ': ' . $errstr, $errno);
         }
 
+        // Assume this is a Unix domain socket (UDS) when its listening address doesn't parse as a valid URL with a port.
+        // Looks like this work-around is the closest we can get because PHP doesn't expose SO_DOMAIN even with ext-sockets.
+        $this->unix = \parse_url($this->getAddress(), \PHP_URL_PORT) === false;
+
         \stream_set_blocking($this->master, false);
 
         $this->resume();
@@ -128,6 +133,10 @@ public function getAddress()
 
         $address = \stream_socket_get_name($this->master, false);
 
+        if ($this->unix === true) {
+            return 'unix://' . $address;
+        }
+
         // check if this is an IPv6 address which includes multiple colons but no square brackets
         $pos = \strrpos($address, ':');
         if ($pos !== false && \strpos($address, ':') < $pos && \substr($address, 0, 1) !== '[') {
@@ -180,8 +189,9 @@ public function close()
     /** @internal */
     public function handleConnection($socket)
     {
-        $this->emit('connection', array(
-            new Connection($socket, $this->loop)
-        ));
+        $connection = new Connection($socket, $this->loop);
+        $connection->unix = $this->unix;
+
+        $this->emit('connection', array($connection));
     }
 }

tests/FdServerTest.php

@@ -120,7 +120,7 @@ public function testGetAddressReturnsSameAddressAsOriginalSocketForIpv6Socket()
 
         $socket = @stream_socket_server('[::1]:0');
         if ($socket === false) {
-            $this->markTestSkipped('IPv6 not supported ');
+            $this->markTestSkipped('Listening on IPv6 not supported');
         }
 
         $fd = $this->getFdFromResource($socket);
@@ -133,6 +133,26 @@ public function testGetAddressReturnsSameAddressAsOriginalSocketForIpv6Socket()
         $this->assertEquals('tcp://[::1]:' . $port, $server->getAddress());
     }
 
+    public function testGetAddressReturnsSameAddressAsOriginalSocketForUnixDomainSocket()
+    {
+        if (!is_dir('/dev/fd') || defined('HHVM_VERSION')) {
+            $this->markTestSkipped('Not supported on your platform');
+        }
+
+        $socket = @stream_socket_server($this->getRandomSocketUri());
+        if ($socket === false) {
+            $this->markTestSkipped('Listening on Unix domain socket (UDS) not supported');
+        }
+
+        $fd = $this->getFdFromResource($socket);
+
+        $loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
+
+        $server = new FdServer($fd, $loop);
+
+        $this->assertEquals('unix://' . stream_socket_get_name($socket, false), $server->getAddress());
+    }
+
     public function testGetAddressReturnsNullAfterClose()
     {
         if (!is_dir('/dev/fd') || defined('HHVM_VERSION')) {
@@ -335,4 +355,9 @@ private function getFdFromResource($resource)
 
         throw new \UnderflowException('Could not locate file descriptor for this resource');
     }
+
+    private function getRandomSocketUri()
+    {
+        return "unix://" . sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid(rand(), true) . '.sock';
+    }
 }