Merge branch 'master' into v1.6-master

Author: sirn-se

.github/workflows/acceptance.yml

@@ -0,0 +1,97 @@
+name: Acceptance
+
+on: [push, pull_request]
+
+jobs:
+  test-7-3:
+    runs-on: ubuntu-latest
+    name: Test PHP 7.3
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up PHP 7.3
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '7.3'
+    - name: Composer
+      run: make install
+    - name: Test
+      run: make test
+
+  test-7-4:
+    runs-on: ubuntu-latest
+    name: Test PHP 7.4
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up PHP 7.4
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '7.4'
+    - name: Composer
+      run: make install
+    - name: Test
+      run: make test
+
+  test-8-0:
+    runs-on: ubuntu-latest
+    name: Test PHP 8.0
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up PHP 8.0
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.0'
+    - name: Composer
+      run: make install
+    - name: Test
+      run: make test
+
+  test-8-1:
+    runs-on: ubuntu-latest
+    name: Test PHP 8.1
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up PHP 8.1
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.1'
+    - name: Composer
+      run: make install
+    - name: Test
+      run: make test
+
+  cs-check:
+    runs-on: ubuntu-latest
+    name: Code standard
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up PHP 8.0
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.0'
+    - name: Composer
+      run: make install
+    - name: Code standard
+      run: make cs-check
+
+  coverage:
+    runs-on: ubuntu-latest
+    name: Code coverage
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up PHP 8.0
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.0'
+        extensions: xdebug
+    - name: Composer
+      run: make install
+    - name: Code coverage
+      env:
+        COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: make coverage

.travis.yml

@@ -1,6 +1,6 @@
 # Websocket Client and Server for PHP
 
-[![Build Status](https://travis-ci.com/Textalk/websocket-php.svg?branch=master)](https://travis-ci.com/Textalk/websocket-php)
+[![Build Status](https://github.com/Textalk/websocket-php/actions/workflows/acceptance.yml/badge.svg)](https://github.com/Textalk/websocket-php/actions)
 [![Coverage Status](https://coveralls.io/repos/github/Textalk/websocket-php/badge.svg?branch=master)](https://coveralls.io/github/Textalk/websocket-php)
 
 This library contains WebSocket client and server for PHP.
@@ -62,4 +62,5 @@ $server->listen(function ($message, $connection = null) {
 Fredrik Liljegren, Armen Baghumian Sankbarani, Ruslan Bekenev,
 Joshua Thijssen, Simon Lipp, Quentin Bellus, Patrick McCarren, swmcdonnell,
 Ignas Bernotas, Mark Herhold, Andreas Palm, Sören Jensen, pmaasz, Alexey Stavrov,
-Michael Slezak, Pierre Seznec, rmeisler, Nickolay V. Shmyrev, Christoph Kempen.
+Michael Slezak, Pierre Seznec, rmeisler, Nickolay V. Shmyrev, Christoph Kempen,
+Marc Roberts.

README.md

@@ -24,7 +24,7 @@
     },
     "require": {
         "php": "^7.2 | ^8.0",
-        "psr/log": "^1.0"
+        "psr/log": "^1 | ^2 | ^3"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.0|^9.0",

composer.json

@@ -4,7 +4,7 @@
 
 ## `v1.6`
 
- > PHP version `^7.2|^8.0`
+ > PHP version `^7.3|^8.0`
 
 ### `1.6.0`
 
@@ -16,6 +16,15 @@
 
  > PHP version `^7.2|^8.0`
 
+### `1.5.5`
+
+ * Support for psr/log v2 and v3 (@simPod)
+ * GitHub Actions replaces Travis (@sirn-se)
+
+### `1.5.4`
+
+ * Keep open connection on read timeout (@marcroberts)
+
 ### `1.5.3`
 
  * Fix for persistent connection (@sirn-se)

docs/Changelog.md

@@ -124,7 +124,7 @@ $client = new WebSocket\Client("ws://echo.websocket.org/", [
         'origin' => 'localhost',
     ],
     'logger' => $my_psr3_logger, // Attach a PSR3 compatible logger
-    'return_obj' => true, // Return Message insatnce rather than just text
+    'return_obj' => true, // Return Message instance rather than just text
     'timeout' => 60, // 1 minute time out
 ]);
 ```

docs/Client.md

@@ -124,7 +124,7 @@ $server = new WebSocket\Server([
     'filter' => ['text', 'binary', 'ping'], // Specify message types for receive() to return
     'logger' => $my_psr3_logger, // Attach a PSR3 compatible logger
     'port' => 9000, // Listening port
-    'return_obj' => true, // Return Message insatnce rather than just text
+    'return_obj' => true, // Return Message instance rather than just text
     'timeout' => 60, // 1 minute time out
 ]);
 ```

docs/Server.md

@@ -486,6 +486,14 @@ public function read(string $length): string
         $data = '';
         while (strlen($data) < $length) {
             $buffer = fread($this->stream, $length - strlen($data));
+            if (!$buffer) {
+                $meta = stream_get_meta_data($this->stream);
+                if (!empty($meta['timed_out'])) {
+                    $message = 'Client read timeout';
+                    $this->logger->error($message, $meta);
+                    throw new TimeoutException($message, ConnectionException::TIMED_OUT, $meta);
+                }
+            }
             if ($buffer === false) {
                 $read = strlen($data);
                 $this->throwException("Broken frame, read {$read} of stated {$length} bytes.");
@@ -527,7 +535,6 @@ private function throwException(string $message, int $code = 0): void
             $meta = $this->getMeta();
             $this->disconnect();
         }
-        $json_meta = json_encode($meta);
         if (!empty($meta['timed_out'])) {
             $this->logger->error($message, $meta);
             throw new TimeoutException($message, ConnectionException::TIMED_OUT, $meta);

lib/Connection.php

@@ -382,6 +382,18 @@ public function testBrokenRead(): void
         $client->receive();
     }
 
+    public function testReadTimeout(): void
+    {
+        MockSocket::initialize('client.connect', $this);
+        $client = new Client('ws://localhost:8000/my/mock/path');
+        $client->send('Connect');
+        MockSocket::initialize('receive-client-timeout', $this);
+        $this->expectException('WebSocket\TimeoutException');
+        $this->expectExceptionCode(1024);
+        $this->expectExceptionMessage('Client read timeout');
+        $client->receive();
+    }
+
     public function testEmptyRead(): void
     {
         MockSocket::initialize('client.connect', $this);

tests/ClientTest.php

@@ -11,6 +11,21 @@
         "params": [],
         "return": false
     },
+    {
+        "function": "stream_get_meta_data",
+        "params": [
+            "@mock-stream"
+        ],
+        "return": {
+            "timed_out": false,
+            "blocked": true,
+            "eof": true,
+            "stream_type": "tcp_socket\/ssl",
+            "mode": "r+",
+            "unread_bytes": 2,
+            "seekable": false
+        }
+    },
     {
         "function": "get_resource_type",
         "params": [
@@ -40,4 +55,4 @@
         ],
         "return":true
     }
-]
+]