Merge remote-tracking branch 'origin/3.x' into feature-proto-payloads

# Conflicts:
#	composer.json

Author: msmakouz

.github/workflows/phpunit.yml

@@ -2,7 +2,6 @@ on:
   pull_request: null
   push:
     branches:
-      - master
       - '*.*'
 
 name: phpunit
@@ -13,7 +12,5 @@ jobs:
     with:
       os: >-
         ['ubuntu-latest']
-      php: >-
-        ['8.1', '8.2']
       stability: >-
         ['prefer-lowest', 'prefer-stable']

.github/workflows/psalm.yml

@@ -2,7 +2,6 @@ on:
   pull_request: null
   push:
     branches:
-      - master
       - '*.*'
 
 name: static analysis
@@ -13,5 +12,3 @@ jobs:
     with:
       os: >-
         ['ubuntu-latest']
-      php: >-
-        ['8.1']

README.md

@@ -1,6 +1,9 @@
-<p align="center">
- <img src="https://user-images.githubusercontent.com/796136/50286124-6f7f3780-046f-11e9-9f45-e8fedd4f786d.png" height="75px" alt="RoadRunner">
-</p>
+<a href="https://roadrunner.dev" target="_blank">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/roadrunner-server/.github/assets/8040338/e6bde856-4ec6-4a52-bd5b-bfe78736c1ff">
+    <img align="center" src="https://github.com/roadrunner-server/.github/assets/8040338/040fb694-1dd3-4865-9d29-8e0748c2c8b8">
+  </picture>
+</a>
 <p align="center">
  <a href="https://packagist.org/packages/spiral/roadrunner"><img src="https://poser.pugx.org/spiral/roadrunner/version"></a>
 	<a href="https://pkg.go.dev/github.com/spiral/roadrunner?tab=doc"><img src="https://godoc.org/github.com/spiral/roadrunner?status.svg"></a>
@@ -19,40 +22,40 @@ with much greater performance and flexibility.
 
 <p align="center">
 	<a href="https://roadrunner.dev/"><b>Official Website</b></a> | 
-	<a href="https://roadrunner.dev/docs"><b>Documentation</b></a>
+	<a href="https://docs.roadrunner.dev"><b>Documentation</b></a>
 </p>
 
-Repository:
---------
+
+## Repository:
 
 This repository contains the codebase PSR-7 PHP workers.
 Check [spiral/roadrunner](https://github.com/spiral/roadrunner) to get application server.
 
-Installation:
---------
+
+## Installation:
 
 To install application server and HTTP codebase:
 
 ```bash
-$ composer require spiral/roadrunner-http nyholm/psr7
+composer require spiral/roadrunner-http nyholm/psr7
 ```
 
 You can use the convenient installer to download the latest available compatible version of RoadRunner assembly:
 
 ```bash
-$ composer require spiral/roadrunner-cli --dev
+composer require spiral/roadrunner-cli --dev
 ```
 
 To download latest version of application server:
 
 ```bash
-$ vendor/bin/rr get
+vendor/bin/rr get
 ```
 
-> You can use any [PSR-17 compatible implementation](https://github.com/search?q=psr-17).
+> You can use any [PSR-17 compatible implementation](https://packagist.org/providers/psr/http-factory-implementation).
+
 
-Example:
--------
+## Example:
 
 To init abstract RoadRunner worker:
 
@@ -88,9 +91,9 @@ while (true) {
         $request = $psr7->waitRequest();
     } catch (\Throwable $e) {
         // Although the PSR-17 specification clearly states that there can be
-	// no exceptions when creating a request, however, some implementations
-	// may violate this rule. Therefore, it is recommended to process the 
-	// incoming request for errors.
+        // no exceptions when creating a request, however, some implementations
+        // may violate this rule. Therefore, it is recommended to process the 
+        // incoming request for errors.
         //
         // Send "Bad Request" response.
         $psr7->respond(new Response(400));
@@ -99,38 +102,61 @@ while (true) {
 
     try {
         // Here is where the call to your application code will be located. 
-	// For example:
-	//
+        // For example:
+        //
         //  $response = $app->send($request);
         //
         // Reply by the 200 OK response
         $psr7->respond(new Response(200, [], 'Hello RoadRunner!'));
     } catch (\Throwable $e) {
         // In case of any exceptions in the application code, you should handle
-	// them and inform the client about the presence of a server error.
-	//
+        // them and inform the client about the presence of a server error.
+        //
         // Reply by the 500 Internal Server Error response
         $psr7->respond(new Response(500, [], 'Something Went Wrong!'));
-        
-	// Additionally, we can inform the RoadRunner that the processing 
-	// of the request failed.
+
+        // Additionally, we can inform the RoadRunner that the processing 
+        // of the request failed.
         $worker->error((string)$e);
     }
 }
 ```
 
-<a href="https://spiral.dev/">
-<img src="https://user-images.githubusercontent.com/773481/220979012-e67b74b5-3db1-41b7-bdb0-8a042587dedc.jpg" alt="try Spiral Framework" />
-</a>
+### Stream response
+
+To send a response in a stream, set the `$chunkSize` property in `PSR7Worker`:
+
+```php
+$psr7 = new PSR7Worker($worker, $factory, $factory, $factory);
+$psr7->chunkSize = 512 * 1024; // 512KB
+```
+
+Now PSR7Worker will cut the response into chunks of 512KB and send them to the stream.
+
+### Early hints
+
+To send multiple responses you may use the `\Spiral\RoadRunner\Http\HttpWorker::respond()` method with
+the `endOfStream` parameter set to `false`. This will send the response to the client and allow you to send
+additional responses.
+
+```php
+/** @var \Spiral\RoadRunner\Http\PSR7Worker $psr7 */
+$httpWorker = $psr7->getHttpWorker()
+    ->respond(103, header: ['Link' => ['</style.css>; rel=preload; as=style']], endOfStream: false);
+
+// End of stream will be sent automatically after PSR7Worker::respond() call
+$psr7->respond(new Response(200, [], 'Hello RoadRunner!'));
+```
+
+
+[![try Spiral Framework](https://user-images.githubusercontent.com/773481/220979012-e67b74b5-3db1-41b7-bdb0-8a042587dedc.jpg)](https://spiral.dev/)
 
-Testing:
---------
+## Testing:
 
-This codebase is automatically tested via host repository - [spiral/roadrunner](https://github.com/spiral/roadrunner).
+This codebase is automatically tested via host repository - [spiral/roadrunner](https://github.com/roadrunner-server/roadrunner).
 
 
-License:
---------
+## License:
 
 The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maintained
 by [Spiral Scout](https://spiralscout.com).

composer.json

@@ -31,7 +31,7 @@
     ],
     "homepage": "https://spiral.dev/",
     "support": {
-        "docs": "https://roadrunner.dev/docs",
+        "docs": "https://docs.roadrunner.dev",
         "issues": "https://github.com/roadrunner-server/roadrunner/issues",
         "forum": "https://forum.roadrunner.dev/",
         "chat": "https://discord.gg/V6EK4he"
@@ -42,16 +42,15 @@
         "psr/http-factory": "^1.0.1",
         "psr/http-message": "^1.0.1 || ^2.0",
         "spiral/roadrunner": "^2023.3",
-        "spiral/roadrunner-worker": "^3.3.0"
+        "spiral/roadrunner-worker": "^3.1.0"
     },
     "require-dev": {
         "buggregator/trap": "^1.0",
         "jetbrains/phpstorm-attributes": "^1.0",
         "nyholm/psr7": "^1.3",
         "phpunit/phpunit": "^10.0",
         "roadrunner-php/roadrunner-api-dto": "^1.4",
-        "symfony/process": "^6.2",
-        "symfony/var-dumper": "^6.3",
+        "symfony/process": "^6.2 || ^7.0",
         "vimeo/psalm": "^5.9"
     },
     "autoload": {

src/PSR7Worker.php

@@ -54,6 +54,11 @@ public function getWorker(): WorkerInterface
         return $this->httpWorker->getWorker();
     }
 
+    public function getHttpWorker(): HttpWorker
+    {
+        return $this->httpWorker;
+    }
+
     /**
      * @throws \JsonException
      */

tests/Unit/PSR7WorkerTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Spiral\RoadRunner\Tests\Http\Unit;
+
+use Nyholm\Psr7\Factory\Psr17Factory;
+use PHPUnit\Framework\TestCase;
+use Spiral\RoadRunner\Http\HttpWorker;
+use Spiral\RoadRunner\Http\PSR7Worker;
+use Spiral\RoadRunner\Worker;
+
+class PSR7WorkerTest extends TestCase
+{
+    public function testHttpWorkerIsAvailable(): void
+    {
+        $psrFactory = new Psr17Factory();
+
+        $psrWorker = new PSR7Worker(
+            Worker::create(),
+            $psrFactory,
+            $psrFactory,
+            $psrFactory,
+        );
+
+        self::assertInstanceOf(HttpWorker::class, $psrWorker->getHttpWorker());
+    }
+
+    protected function tearDown(): void
+    {
+        // Clean all extra output buffers
+        $level = \ob_get_level();
+        while (--$level > 0) {
+            \ob_end_clean();
+        }
+
+        parent::tearDown(); // TODO: Change the autogenerated stub
+    }
+}