Merge pull request cakephp#17514 from cakephp/5.1-server-terminate

Add Server.terminate event.

src/Http/Server.php

@@ -139,6 +139,24 @@ public function emit(ResponseInterface $response, ?ResponseEmitter $emitter = nu
         $emitter->emit($response);
     }
 
+    /**
+     * Trigger the Server.terminate event.
+     *
+     * The event is used to do potentially heavy tasks after the response is sent
+     * to the client. Only the PHP FPM server API is able to send a response to
+     * the client while the server's PHP process still performs some tasks. For
+     * other environments the event will be triggered before the response is flushed
+     * to the client and will have no benefit.
+     *
+     * @param \Psr\Http\Message\ServerRequestInterface $request Request instance.
+     * @param \Psr\Http\Message\ResponseInterface $response Response instance.
+     * @return void
+     */
+    public function terminate(ServerRequestInterface $request, ResponseInterface $response): void
+    {
+        $this->dispatchEvent('Server.terminate', compact('request', 'response'));
+    }
+
     /**
      * Get the current application.
      *

tests/TestCase/Http/ServerTest.php

@@ -22,6 +22,7 @@
 use Cake\Http\BaseApplication;
 use Cake\Http\CallbackStream;
 use Cake\Http\MiddlewareQueue;
+use Cake\Http\Response;
 use Cake\Http\ResponseEmitter;
 use Cake\Http\Server;
 use Cake\Http\ServerRequest;
@@ -32,6 +33,7 @@
 use Laminas\Diactoros\ServerRequest as LaminasServerRequest;
 use Mockery;
 use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use TestApp\Http\MiddlewareApplication;
 
 require_once __DIR__ . '/server_mocks.php';
@@ -353,4 +355,23 @@ public function testAppWithoutContainerApplicationInterface(): void
         $request = new ServerRequest();
         $this->assertInstanceOf(ResponseInterface::class, $server->run($request));
     }
+
+    public function testTerminate(): void
+    {
+        /** @var \Cake\Core\HttpApplicationInterface|\PHPUnit\Framework\MockObject\MockObject $app */
+        $app = $this->createMock(HttpApplicationInterface::class);
+        $server = new Server($app);
+
+        $triggered = false;
+        $server->getEventManager()->on(
+            'Server.terminate',
+            function (EventInterface $event, ServerRequestInterface $request, ResponseInterface $response) use (&$triggered) {
+                $triggered = true;
+            }
+        );
+
+        $server->terminate(new ServerRequest(), new Response());
+
+        $this->assertTrue($triggered);
+    }
 }