Merge branch 'pr12620'

Author: taylorotwell

README.md

@@ -164,10 +164,6 @@ You may gracefully restart the Octane server's application workers using the `oc
 php artisan octane:reload
 ```
 
-### Debugging
-
-Because Octane starts a long running process that continually serves requests to your application, it is not possible to use the `dump` helper. Instead, we recommend using [Telescope](https://github.com/laravel/telescope), [Ray](https://spatie.be/products/ray), [Debug Bar](https://github.com/barryvdh/laravel-debugbar), or [logging](https://laravel.com/docs/logging).
-
 ### Dependency Injection & Octane
 
 Since Octane boots your application once and keeps it in memory while serving requests, there are a few caveats you should consider while building your application. For example, the `register` and `boot` methods of your application's service providers will only be executed once when the request worker initially boots. On subsequent requests, the same application instance will be reused.

src/Contracts/Client.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Foundation\Application;
 use Illuminate\Http\Request;
+use Laravel\Octane\OctaneResponse;
 use Laravel\Octane\RequestContext;
 use Symfony\Component\HttpFoundation\Response;
 use Throwable;
@@ -22,10 +23,10 @@ public function marshalRequest(RequestContext $context): array;
      * Send the response to the server.
      *
      * @param  \Laravel\Octane\RequestContext  $context
-     * @param  \Symfony\Component\HttpFoundation\Response  $response
+     * @param  \Laravel\Octane\OctaneResponse  $response
      * @return void
      */
-    public function respond(RequestContext $context, Response $response): void;
+    public function respond(RequestContext $context, OctaneResponse $response): void;
 
     /**
      * Send an error message to the server.

src/OctaneResponse.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Laravel\Octane;
+
+use Symfony\Component\HttpFoundation\Response;
+
+class OctaneResponse
+{
+    public function __construct(public Response $response, public ?string $outputBuffer = null)
+    {
+    }
+}

src/RoadRunner/RoadRunnerClient.php

@@ -8,9 +8,12 @@
 use Laravel\Octane\Contracts\StoppableClient;
 use Laravel\Octane\MarshalsPsr7RequestsAndResponses;
 use Laravel\Octane\Octane;
+use Laravel\Octane\OctaneResponse;
 use Laravel\Octane\RequestContext;
 use Spiral\RoadRunner\Http\PSR7Worker;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\StreamedResponse;
 use Throwable;
 
 class RoadRunnerClient implements Client, StoppableClient
@@ -39,12 +42,20 @@ public function marshalRequest(RequestContext $context): array
      * Send the response to the server.
      *
      * @param  \Laravel\Octane\RequestContext  $context
-     * @param  \Symfony\Component\HttpFoundation\Response  $response
+     * @param  \Laravel\Octane\OctaneResponse  $octaneResponse
      * @return void
      */
-    public function respond(RequestContext $context, Response $response): void
+    public function respond(RequestContext $context, OctaneResponse $octaneResponse): void
     {
-        $this->client->respond($this->toPsr7Response($response));
+        if ($octaneResponse->outputBuffer &&
+            ! $octaneResponse->response instanceof StreamedResponse &&
+            ! $octaneResponse->response instanceof BinaryFileResponse) {
+            $octaneResponse->response->setContent(
+                $octaneResponse->outputBuffer.$octaneResponse->response->getContent()
+            );
+        }
+
+        $this->client->respond($this->toPsr7Response($octaneResponse->response));
     }
 
     /**

src/Swoole/SwooleClient.php

@@ -9,6 +9,7 @@
 use Laravel\Octane\Contracts\ServesStaticFiles;
 use Laravel\Octane\MimeType;
 use Laravel\Octane\Octane;
+use Laravel\Octane\OctaneResponse;
 use Laravel\Octane\RequestContext;
 use Swoole\Http\Response as SwooleResponse;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
@@ -98,13 +99,13 @@ public function serveStaticFile(Request $request, RequestContext $context): void
      * Send the response to the server.
      *
      * @param  \Laravel\Octane\RequestContext  $context
-     * @param  \Symfony\Component\HttpFoundation\Response  $response
+     * @param  \Laravel\Octane\OctaneResponse  $octaneResponse
      * @return void
      */
-    public function respond(RequestContext $context, Response $response): void
+    public function respond(RequestContext $context, OctaneResponse $octaneResponse): void
     {
-        $this->sendResponseHeaders($response, $context->swooleResponse);
-        $this->sendResponseContent($response, $context->swooleResponse);
+        $this->sendResponseHeaders($octaneResponse->response, $context->swooleResponse);
+        $this->sendResponseContent($octaneResponse, $context->swooleResponse);
     }
 
     /**
@@ -150,23 +151,41 @@ public function sendResponseHeaders(Response $response, SwooleResponse $swooleRe
     /**
      * Send the headers from the Illuminate response to the Swoole response.
      *
-     * @param  \Symfony\Component\HtpFoundation\Response  $response
+     * @param  \Laravel\Octane\OctaneResponse  $response
      * @param  \Swoole\Http\Response  $response
      * @return void
      */
-    protected function sendResponseContent(Response $response, SwooleResponse $swooleResponse): void
+    protected function sendResponseContent(OctaneResponse $octaneResponse, SwooleResponse $swooleResponse): void
     {
-        if ($response instanceof StreamedResponse && property_exists($response, 'output')) {
-            $swooleResponse->end($response->output);
+        if ($octaneResponse->response instanceof BinaryFileResponse) {
+            $swooleResponse->sendfile($octaneResponse->response->getFile()->getPathname());
 
             return;
-        } elseif ($response instanceof BinaryFileResponse) {
-            $swooleResponse->sendfile($response->getFile()->getPathname());
+        }
+
+        if ($octaneResponse->outputBuffer) {
+            $swooleResponse->write($octaneResponse->outputBuffer);
+        }
+
+        if ($octaneResponse->response instanceof StreamedResponse) {
+            ob_start(function ($data) use ($swooleResponse) {
+                if (strlen($data) > 0) {
+                    $swooleResponse->write($data);
+                }
+
+                return '';
+            }, 1);
+
+            $octaneResponse->response->sendContent();
+
+            ob_end_clean();
+
+            $swooleResponse->end();
 
             return;
         }
 
-        $content = $response->getContent();
+        $content = $octaneResponse->response->getContent();
 
         $length = strlen($content);
 

src/Testing/Fakes/FakeClient.php

@@ -5,8 +5,8 @@
 use Illuminate\Foundation\Application;
 use Illuminate\Http\Request;
 use Laravel\Octane\Contracts\Client;
+use Laravel\Octane\OctaneResponse;
 use Laravel\Octane\RequestContext;
-use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
 class FakeClient implements Client
@@ -24,9 +24,9 @@ public function marshalRequest(RequestContext $context): array
         return [$context->request, $context];
     }
 
-    public function respond(RequestContext $context, Response $response): void
+    public function respond(RequestContext $context, OctaneResponse $octaneResponse): void
     {
-        $this->responses[] = $response;
+        $this->responses[] = $octaneResponse->response;
     }
 
     public function error(Throwable $e, Application $app, Request $request, RequestContext $context): void

src/Worker.php

@@ -86,12 +86,20 @@ public function handle(Request $request, RequestContext $context): void
         try {
             $responded = false;
 
+            ob_start();
+
+            $response = $gateway->handle($request);
+
+            $output = ob_get_contents();
+
+            ob_end_clean();
+
             // Here we will actually hand the incoming request to the Laravel application so
             // it can generate a response. We'll send this response back to the client so
             // it can be returned to a browser. This gateway will also dispatch events.
             $this->client->respond(
                 $context,
-                $response = $gateway->handle($request),
+                $octaneResponse = new OctaneResponse($response, $output),
             );
 
             $responded = true;
@@ -105,7 +113,7 @@ public function handle(Request $request, RequestContext $context): void
             // After the request handling process has completed we will unset some variables
             // plus reset the current application state back to its original state before
             // it was cloned. Then we will be ready for the next worker iteration loop.
-            unset($gateway, $sandbox, $request, $response);
+            unset($gateway, $sandbox, $request, $response, $octaneResponse, $output);
 
             CurrentApplication::set($this->app);
         }

tests/RoadRunnerClientTest.php

@@ -6,6 +6,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Laminas\Diactoros\ServerRequestFactory;
+use Laravel\Octane\OctaneResponse;
 use Laravel\Octane\RequestContext;
 use Laravel\Octane\RoadRunner\RoadRunnerClient;
 use Mockery;
@@ -42,7 +43,7 @@ public function test_respond_method_send_response_to_roadrunner()
 
         $client->respond(new RequestContext([
             'psr7Request' => $psr7Request,
-        ]), new Response('Hello World', 200));
+        ]), new OctaneResponse(new Response('Hello World', 200)));
     }
 
     /** @doesNotPerformAssertions @test */

tests/SwooleClientTest.php

@@ -5,6 +5,7 @@
 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
+use Laravel\Octane\OctaneResponse;
 use Laravel\Octane\RequestContext;
 use Laravel\Octane\Swoole\SwooleClient;
 use Mockery;
@@ -129,7 +130,7 @@ public function test_respond_method_send_response_to_swoole()
 
         $client->respond(new RequestContext([
             'swooleResponse' => $swooleResponse,
-        ]), new Response('Hello World', 200, ['Content-Type' => 'text/html']));
+        ]), new OctaneResponse(new Response('Hello World', 200, ['Content-Type' => 'text/html'])));
     }
 
     /** @doesNotPerformAssertions @test */