Configuration class

Merge branch 'v4.0-main' into v4-wotk

Author: sirn-se

Makefile

@@ -14,7 +14,7 @@ cs: composer.lock
 stan: composer.lock
 	./vendor/bin/phpstan analyse --memory-limit 256M
 
-coverage: composer.lock
+coverage: composer.lock clean-coverage
 	./vendor/bin/phpunit --coverage-clover coverage/clover.xml --coverage-html=coverage -d --min-coverage=100
 
 composer.phar:
@@ -25,7 +25,10 @@ composer.lock: composer.phar
 
 vendor/bin/phpunit: install
 
-clean:
-	rm composer.lock
-	rm -r vendor
-	rm -r coverage
+clean: clean-coverage
+	rm -f composer.lock
+	rm -rf vendor
+	rm -rf coverage
+
+clean-coverage:
+	rm -rf coverage

composer.json

@@ -28,6 +28,7 @@
     },
     "require": {
         "php": "^8.1",
+        "phrity/http": "^1.0",
         "phrity/net-uri": "^2.1",
         "phrity/net-stream": "dev-ws4 as 2.4.0",
         "psr/http-message": "^1.1 | ^2.0",
@@ -45,7 +46,7 @@
     },
     "suggest": {
         "ext-zlib": "Required for per-message deflate compression",
-        "psr/http-message-implementation": "Use a complete http-message implementation",
+        "psr/http-factory-implementation": "Use a complete http-factory implementation",
         "psr/log-implementation": "Use a logger implementation"
     }
 }

docs/Changelog.md

@@ -8,6 +8,9 @@
 
 ### `4.0.0`
 
+ * Shared stream observer, sharable across multiple cients and servers (@sirn-se)
+ * Configuration class for various settings (@sirn-se)
+ * Many class local configuration setters removed (@sirn-se)
  * Remove deprecated code (@sirn-se)
 
 ## `v3.6`

docs/Client.md

@@ -201,13 +201,22 @@ $client->getContext(); // => currently used Phrity\Net\Context
 ### HTTP factories
 
 By default the Client uses a minimal [PSR-7 HTTP message](https://www.php-fig.org/psr/psr-7/) implementation.
-To use complete implementations such as `nyholm/psr7` or `guzzlehttp/psr7`, add their [PSR-17 HTTP factories](https://www.php-fig.org/psr/psr-17/) during setup.
+Other (more complete) implementations can be used by setting [PSR-17 HTTP factories](https://www.php-fig.org/psr/psr-17/) on the CLient.
+
+Set a configured HttpFactory class on the Client.
 ```php
-$httpFactory = new Nyholm\Psr7\Factory\Psr17Factory(); // Or any other PSR-17 factory
-$client
-    ->setResponseFactory($httpFactory)
-    ->setRequestFactory($httpFactory)
-    ->setUriFactory($httpFactory);
+$factory = new Phrity\Http\HttpFactory(
+    requestFactory: $myRequestFactory,
+    responseFactory: $myResponseFactory,
+    uriFactory: $myUriFactory,
+);
+$client->setHttpFactory($factory);
+
+```
+Or if you use factories that support multiple interfaces, available in libraries such as `nyholm/psr7` or `guzzlehttp/psr7`.
+```php
+$psrFactory = new Nyholm\Psr7\Factory\Psr17Factory(); // Or any other PSR-17 factory
+$client->setHttpFactory(Phrity\Http\HttpFactory::create($psrFactory));
 ```
 
 ### Handshake headers

docs/Migrate_3_4.md

@@ -15,6 +15,8 @@ Version 4.x has few changes compared to previous version.
 * Server `onConnect()` - use `onHandshake()` instead
 * Server `setContext()` - no longer accepts array input
 
+## Configuration management
+
 v4 uses the Configuration class to propagate configurations throughout internal classes.
 
 This affects the following classes;
@@ -26,9 +28,23 @@ This affects the following classes;
 
 He following methods (when applicable) are removed;
 * `setLogger()`
+* `getTimeout()`
+* `setTimeout()`
+* `getFrameSize()`
+* `setFrameSize()`
 
-Instead these classes get the method;
+Instead these classes can be configured using;
+* `__construct(..., WebSocket\Configuration|null $configuration = null)`
 * `setConfiguration(WebSocket\Configuration $configuration)`
 
+If you need to set configuration on internal classes, best way is to clone the original;
+```php
+$clonedConfiguration = clone $source->getConfiguration();
+$clonedConfiguration->setLogger(...);
+$clonedConfiguration->setTimeout(...);
+$clonedConfiguration->setFrameSize(...);
+$source->setConfiguration($clonedConfiguration);
+```
+
 ## Extending
 

docs/Server.md

@@ -192,13 +192,22 @@ $server->getContext(); // => currently used Phrity\Net\Context
 ### HTTP factories
 
 By default the Server uses a minimal [PSR-7 HTTP message](https://www.php-fig.org/psr/psr-7/) implementation.
-To use complete implementations such as `nyholm/psr7` or `guzzlehttp/psr7`, add their [PSR-17 HTTP factories](https://www.php-fig.org/psr/psr-17/) during setup.
+Other (more complete) implementations can be used by setting [PSR-17 HTTP factories](https://www.php-fig.org/psr/psr-17/) on the Server.
+
+Set a configured HttpFactory class on the Client.
 ```php
-$httpFactory = new Nyholm\Psr7\Factory\Psr17Factory(); // Or any other PSR-17 factory
-$server
-    ->setResponseFactory($httpFactory)
-    ->setServerRequestFactory($httpFactory)
-    ->setUriFactory($httpFactory);
+$factory = new Phrity\Http\HttpFactory(
+    serverRequestFactory: $myServerRequestFactory,
+    responseFactory: $myResponseFactory,
+    uriFactory: $myUriFactory,
+);
+$server->setHttpFactory($factory);
+```
+
+Or if you use factories that support multiple interfaces, available in libraries such as `nyholm/psr7` or `guzzlehttp/psr7`.
+```php
+$psrFactory = new Nyholm\Psr7\Factory\Psr17Factory(); // Or any other PSR-17 factory
+$server->setHttpFactory(Phrity\Http\HttpFactory::create($psrFactory));
 ```
 
 ### Max connections

examples/delegating_server.php

@@ -54,7 +54,7 @@
  *     ssl: bool,
  *     timeout: int<0, max>|float,
  *     framesize: int<1, max>,
- *     connections: int<0, max>|null,
+ *     connections: int<1, max>|null,
  *     deflate: bool,
  * } $options
  */
@@ -102,7 +102,7 @@
         echo "# Set frame size: {$options['framesize']}\n";
     }
     if (isset($options['connections'])) {
-        $server->setMaxConnections($options['connections']);
+        $server->getConfiguration()->setMaxConnections($options['connections']);
         echo "# Set max connections: {$options['connections']}\n";
     }
     if (isset($options['deflate'])) {

examples/echoserver.php

@@ -53,7 +53,7 @@
  *     ssl: bool,
  *     timeout: int<0, max>|float,
  *     framesize: int<1, max>,
- *     connections: int<0, max>|null,
+ *     connections: int<1, max>|null,
  *     deflate: bool,
  * } $options
  */
@@ -83,7 +83,7 @@
         echo "# Set frame size: {$options['framesize']}\n";
     }
     if (isset($options['connections'])) {
-        $server->setMaxConnections($options['connections']);
+        $server->getConfiguration()->setMaxConnections($options['connections']);
         echo "# Set max connections: {$options['connections']}\n";
     }
     if (isset($options['deflate'])) {
@@ -121,8 +121,8 @@
                 $msg .= "  - Connected:   " . json_encode($connection->isConnected()) . "\n";
                 $msg .= "  - Readable:    " . json_encode($connection->isReadable()) . "\n";
                 $msg .= "  - Writable:    " . json_encode($connection->isWritable()) . "\n";
-                $msg .= "  - Timeout:     {$connection->getTimeout()}s\n";
-                $msg .= "  - Frame size:  {$connection->getFrameSize()}b\n";
+                $msg .= "  - Timeout:     {$connection->getConfiguration()->getTimeout()}s\n";
+                $msg .= "  - Frame size:  {$connection->getConfiguration()->getFrameSize()}b\n";
                 echo "< [{$connection->getRemoteName()}] {$msg}";
                 $server->send(new Text($msg));
                 break;

examples/random_server.php

@@ -63,7 +63,7 @@
  *     ssl: bool,
  *     timeout: int<0, max>|float,
  *     framesize: int<1, max>,
- *     connections: int<0, max>|null,
+ *     connections: int<1, max>|null,
  *     deflate: bool,
  * } $options
  */
@@ -95,7 +95,7 @@
         echo "# Set frame size: {$options['framesize']}\n";
     }
     if (isset($options['connections'])) {
-        $server->setMaxConnections($options['connections']);
+        $server->getConfiguration()->setMaxConnections($options['connections']);
         echo "# Set max connections: {$options['connections']}\n";
     }
     if (isset($options['deflate'])) {

phpunit.xml

@@ -14,6 +14,7 @@
     <testsuites>
         <testsuite name="Unit tests">
             <directory suffix=".php">tests/suites/client</directory>
+            <directory suffix=".php">tests/suites/configuration</directory>
             <directory suffix=".php">tests/suites/connection</directory>
             <directory suffix=".php">tests/suites/frame</directory>
             <directory suffix=".php">tests/suites/http</directory>