Add a generic PSR-17 runtime (#43)

* typo

* Add a generic PSR-17

* Fixed tests

* cs

Author: Nyholm

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [nyholm]

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+composer.lock

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tobias Nyholm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,78 @@
+# PSR-7 and PSR-15 Runtime
+
+A runtime with support for any PSR-17 compatible implementation.
+
+## Installation
+
+Install this runtime plus a package that [provide psr/http-factory-implementation](https://packagist.org/providers/psr/http-factory-implementation).
+
+```
+composer require runtime/psr-17 slim/psr7
+```
+
+Also update your composer.json with some extra config:
+
+```json
+{
+    "require": {
+        "...": "..."
+    },
+    "extra": {
+        "runtime": {
+            "psr17_server_request_factory": "Slim\\Psr7\\Factory\\ServerRequestFactory"
+            "psr17_uri_factory": "Slim\\Psr7\\Factory\\UriFactory"
+            "psr17_uploaded_file_factory": "Slim\\Psr7\\Factory\\UploadedFileFactory"
+            "psr17_stream_factory": "Slim\\Psr7\\Factory\\StreamFactory"
+        }
+    }
+}
+```
+
+## Usage
+
+This runtime is discovered automatically. You can force your application to use
+this runtime by defining the environment variable `APP_RUNTIME`.
+
+```
+APP_RUNTIME=Runtime\Psr17\Runtime
+```
+
+### PSR-7
+
+```php
+// public/index.php
+
+use Psr\Http\Message\ServerRequestInterface;
+use Any\Psr7;
+
+require_once dirname(__DIR__).'/vendor/autoload_runtime.php';
+
+return function (ServerRequestInterface $request) {
+    return new Psr7\Response(200, [], 'PSR-7');
+};
+```
+
+### PSR-15
+
+```php
+// public/index.php
+
+use Psr\Http\Server\RequestHandlerInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Any\Psr7;
+
+require_once dirname(__DIR__).'/vendor/autoload_runtime.php';
+
+class Application implements RequestHandlerInterface {
+    // ...
+    public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        return new Psr7\Response(200, [], 'PSR-15');
+    }
+}
+
+return function (array $context) {
+    return new Application($context['APP_ENV'] ?? 'dev');
+};
+```

composer.json

@@ -0,0 +1,35 @@
+{
+    "name": "runtime/psr-17",
+    "type": "library",
+    "description": "PSR runtime with support for any PSR-17 implementation",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Tobias Nyholm",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "nyholm/psr7-server": "^1.0",
+        "psr/http-factory-implementation": "^1.0",
+        "psr/http-server-handler": "^1.0",
+        "symfony/runtime": "^5.3"
+    },
+    "require-dev": {
+        "nyholm/psr7": "^1.4",
+        "symfony/phpunit-bridge": "^5.2"
+    },
+    "autoload": {
+        "psr-4": {
+            "Runtime\\Psr17\\": "src/",
+            "Symfony\\Runtime\\Psr\\Http\\": "runtime/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Runtime\\Psr17\\Tests\\": "tests/"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

phpunit.xml.dist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         failOnRisky="true"
+         failOnWarning="true"
+>
+  <php>
+    <ini name="error_reporting" value="-1"/>
+  </php>
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory>./tests</directory>
+      <directory suffix=".phpt">./tests/phpt</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

runtime/Message/ResponseInterfaceRuntime.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\Runtime\Psr\Http\Message;
+
+use Runtime\Psr17\Runtime;
+
+class ResponseInterfaceRuntime extends Runtime
+{
+}

runtime/Message/ServerRequestInterfaceRuntime.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\Runtime\Psr\Http\Message;
+
+use Runtime\Psr17\Runtime;
+
+class ServerRequestInterfaceRuntime extends Runtime
+{
+}

runtime/Server/RequestHandlerInterfaceRuntime.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\Runtime\Psr\Http\Server;
+
+use Runtime\Psr17\Runtime;
+
+class RequestHandlerInterfaceRuntime extends Runtime
+{
+}

src/Emitter.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace Runtime\Psr17;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Symfony\Component\Runtime\RunnerInterface;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class Emitter implements RunnerInterface
+{
+    private $requestHandler;
+    private $response;
+    private $request;
+
+    private function __construct()
+    {
+    }
+
+    public static function createForResponse(ResponseInterface $response): self
+    {
+        $self = new self();
+        $self->response = $response;
+
+        return $self;
+    }
+
+    public static function createForRequestHandler(RequestHandlerInterface $handler, ServerRequestInterface $request): self
+    {
+        $self = new self();
+        $self->requestHandler = $handler;
+        $self->request = $request;
+
+        return $self;
+    }
+
+    public function run(): int
+    {
+        if (null === $this->response) {
+            $this->response = $this->requestHandler->handle($this->request);
+        }
+
+        $this->emit($this->response);
+
+        return 0;
+    }
+
+    /**
+     * Emits a response for a PHP SAPI environment.
+     *
+     * Emits the status line and headers via the header() function, and the
+     * body content via the output buffer.
+     *
+     * @Copyright (c) 2020 Laminas Project a Series of LF Projects, LLC.
+     */
+    public function emit(ResponseInterface $response): void
+    {
+        if (headers_sent()) {
+            throw EmitterException::forHeadersSent();
+        }
+
+        if (ob_get_level() > 0 && ob_get_length() > 0) {
+            throw EmitterException::forOutputSent();
+        }
+
+        $this->emitHeaders($response);
+        $this->emitStatusLine($response);
+        echo $response->getBody();
+    }
+
+    /**
+     * Emit the status line.
+     *
+     * Emits the status line using the protocol version and status code from
+     * the response; if a reason phrase is available, it, too, is emitted.
+     *
+     * It is important to mention that this method should be called after
+     * `emitHeaders()` in order to prevent PHP from changing the status code of
+     * the emitted response.
+     *
+     * @Copyright (c) 2020 Laminas Project a Series of LF Projects, LLC.
+     */
+    private function emitStatusLine(ResponseInterface $response): void
+    {
+        $reasonPhrase = $response->getReasonPhrase();
+        $statusCode = $response->getStatusCode();
+
+        header(sprintf(
+            'HTTP/%s %d%s',
+            $response->getProtocolVersion(),
+            $statusCode,
+            ($reasonPhrase ? ' '.$reasonPhrase : '')
+        ), true, $statusCode);
+    }
+
+    /**
+     * Emit response headers.
+     *
+     * Loops through each header, emitting each; if the header value
+     * is an array with multiple values, ensures that each is sent
+     * in such a way as to create aggregate headers (instead of replace
+     * the previous).
+     *
+     * @Copyright (c) 2020 Laminas Project a Series of LF Projects, LLC.
+     */
+    private function emitHeaders(ResponseInterface $response): void
+    {
+        $statusCode = $response->getStatusCode();
+
+        foreach ($response->getHeaders() as $header => $values) {
+            $name = ucwords($header, '-');
+            $first = 'Set-Cookie' === $name ? false : true;
+            foreach ($values as $value) {
+                header(sprintf('%s: %s', $name, $value), $first, $statusCode);
+                $first = false;
+            }
+        }
+    }
+}

src/EmitterException.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * Copyright (c) 2020 Laminas Project a Series of LF Projects, LLC.
+ */
+
+declare(strict_types=1);
+
+namespace Runtime\Psr17;
+
+class EmitterException extends \RuntimeException
+{
+    public static function forHeadersSent(): self
+    {
+        return new self('Unable to emit response; headers already sent');
+    }
+
+    public static function forOutputSent(): self
+    {
+        return new self('Output has been emitted previously; cannot emit response');
+    }
+}