Merge pull request #120 from Textalk/v1.4.3

Version 1.4.3

.travis.yml

@@ -4,6 +4,7 @@ php:
   - 7.4
   - 7.3
   - 7.2
+  - 7.1
 
 before_script:
   - make install build

Makefile

@@ -12,7 +12,7 @@ cs-check: composer.lock
 	./vendor/bin/phpcs --standard=codestandard.xml lib tests examples
 
 coverage: composer.lock build
-	./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+	XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
 	./vendor/bin/php-coveralls -v
 
 composer.phar:

docs/Changelog.md

@@ -6,6 +6,11 @@
 
  > PHP version `^7.1`
 
+#### `1.4.3`
+
+ * Solve stream closure/get meta conflict (@sirn-se)
+ * Examples and documentation overhaul (@sirn-se)
+
 #### `1.4.2`
 
  * Force stream close on read error (@sirn-se)

examples/echoserver.php

@@ -41,6 +41,10 @@
         while (true) {
             $message = $server->receive();
             $opcode = $server->getLastOpcode();
+            if ($opcode == 'close') {
+                echo "> Closed connection\n";
+                continue;
+            }
             echo "> Got '{$message}' [opcode: {$opcode}]\n";
 
             switch ($message) {

lib/Base.php

@@ -249,6 +249,8 @@ protected function receiveFragment(): array
 
         if ($opcode === 'close') {
             // Get the close status.
+            $status_bin = '';
+            $status = '';
             if ($payload_length > 0) {
                 $status_bin = $payload[0] . $payload[1];
                 $status = bindec(sprintf("%08b%08b", ord($payload[0]), ord($payload[1])));
@@ -305,12 +307,9 @@ protected function write($data): void
         $length = strlen($data);
         $written = fwrite($this->socket, $data);
         if ($written === false) {
-            fclose($this->socket);
             $this->throwException("Failed to write {$length} bytes.");
         }
-
         if ($written < strlen($data)) {
-            fclose($this->socket);
             $this->throwException("Could only write {$written} out of {$length} bytes.");
         }
         $this->logger->debug("Wrote {$written} of {$length} bytes.");
@@ -323,11 +322,9 @@ protected function read($length): string
             $buffer = fread($this->socket, $length - strlen($data));
             if ($buffer === false) {
                 $read = strlen($data);
-                fclose($this->socket);
                 $this->throwException("Broken frame, read {$read} of stated {$length} bytes.");
             }
             if ($buffer === '') {
-                fclose($this->socket);
                 $this->throwException("Empty read; connection dead?");
             }
             $data .= $buffer;
@@ -339,6 +336,7 @@ protected function throwException($message, $code = 0): void
     {
         $meta = $this->isConnected() ? stream_get_meta_data($this->socket) : [];
         $json_meta = json_encode($meta);
+        fclose($this->socket);
         if (!empty($meta['timed_out'])) {
             $code = ConnectionException::TIMED_OUT;
             $this->logger->warning("{$message}", (array)$meta);

lib/Client.php

@@ -186,7 +186,7 @@ function ($key, $value) {
             throw new ConnectionException($error);
         }
 
-        $this->logger->info("Client connected to to {$address}");
+        $this->logger->info("Client connected to {$address}");
     }
 
     /**

lib/Server.php

@@ -110,8 +110,8 @@ protected function connect(): void
             stream_set_timeout($this->socket, $this->options['timeout']);
         }
 
+        $this->logger->info("Client has connected to port {$this->port}");
         $this->performHandshake();
-        $this->logger->info("Server connected to port {$this->port}");
     }
 
     protected function performHandshake(): void
@@ -153,5 +153,6 @@ protected function performHandshake(): void
                 . "\r\n";
 
         $this->write($header);
+        $this->logger->debug("Handshake on {$get_uri}");
     }
 }

tests/scripts/receive-broken-read.json

@@ -11,13 +11,6 @@
         "params": [],
         "return": false
     },
-    {
-        "function": "fclose",
-        "params": [
-            "@mock-stream"
-        ],
-        "return":true
-    },
     {
         "function": "get_resource_type",
         "params": [
@@ -39,5 +32,12 @@
             "unread_bytes": 2,
             "seekable": false
         }
+    },
+    {
+        "function": "fclose",
+        "params": [
+            "@mock-stream"
+        ],
+        "return":true
     }
 ]

tests/scripts/receive-empty-read.json

@@ -11,13 +11,6 @@
         "params": [],
         "return": ""
     },
-    {
-        "function": "fclose",
-        "params": [
-            "@mock-stream"
-        ],
-        "return":true
-    },
     {
         "function": "get_resource_type",
         "params": [
@@ -39,5 +32,12 @@
             "unread_bytes": 2,
             "seekable": false
         }
+    },
+    {
+        "function": "fclose",
+        "params": [
+            "@mock-stream"
+        ],
+        "return":true
     }
 ]

tests/scripts/send-broken-write.json

@@ -13,11 +13,6 @@
         ],
         "return": 18
     },
-    {
-        "function": "fclose",
-        "params": [],
-        "return": true
-    },
     {
         "function": "get_resource_type",
         "params": [
@@ -39,5 +34,10 @@
             "unread_bytes": 2,
             "seekable": false
         }
+    },
+    {
+        "function": "fclose",
+        "params": [],
+        "return": true
     }
 ]

tests/scripts/send-failed-write.json

@@ -13,11 +13,6 @@
         ],
         "return": false
     },
-    {
-        "function": "fclose",
-        "params": [],
-        "return": true
-    },
     {
         "function": "get_resource_type",
         "params": [
@@ -39,5 +34,10 @@
             "unread_bytes": 2,
             "seekable": false
         }
+    },
+    {
+        "function": "fclose",
+        "params": [],
+        "return": true
     }
 ]