Refactor into a single command

Author: mnapoli

README.md

@@ -1,11 +1,11 @@
 Development web server for serverless-native PHP web apps.
 
-**This project is currently experimental and the documentation incomplete.**
-
 ## Why?
 
 This web server is meant for HTTP applications implemented without framework, using API Gateway as the router and PSR-15 controllers.
 
+It is also meant to be used with the [Bref Micro](https://github.com/brefphp/micro) framework.
+
 ## Installation
 
 ```bash
@@ -17,5 +17,19 @@ composer require --dev bref/dev-server
 Run the webserver with:
 
 ```bash
-php -S 127.0.0.1:8000 vendor/bin/bref-dev-server
+vendor/bin/bref-dev-server
+```
+
+The application will be available at [http://localhost:8000/](http://localhost:8000/).
+
+Routes will be parsed from `serverless.yml` in the current directory.
+
+### Assets
+
+By default, static assets are served from the current directory.
+
+To customize that, use the `--assets` option. For example to serve static files from the `public/` directory:
+
+```bash
+vendor/bin/bref-dev-server --assets public
 ```

bin/bref-dev-server

@@ -1,13 +1,41 @@
+#!/usr/bin/env php
 <?php declare(strict_types=1);
 
-use Bref\DevServer\DevServer;
-
-if (file_exists(__DIR__ . '/vendor/autoload.php')) {
-    require_once __DIR__ . '/vendor/autoload.php';
+if (file_exists(__DIR__ . '/../vendor/autoload.php')) {
+    require_once __DIR__ . '/../vendor/autoload.php';
 } elseif (file_exists(__DIR__ . '/../../autoload.php')) {
     require_once __DIR__ . '/../../autoload.php';
 } else {
     require_once __DIR__ . '/../../../autoload.php';
 }
 
-return (new DevServer)->run();
+use Bref\DevServer\Handler;
+use Silly\Application;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Process\Process;
+
+$app = new Application('Bref dev server');
+
+$app->command('run [-a|--assets=]', function (OutputInterface $output, ?string $assets = null) {
+    $handler = __DIR__ . '/../src/server-handler.php';
+    $assetsDirectory = $assets ?: getcwd();
+    $output->writeln("<info>Serving PHP from serverless.yml routes</info>");
+    $output->writeln("<info>Serving assets from $assetsDirectory/</info>");
+
+    $server = new Process(['php', '-S', '127.0.0.1:8000', $handler, '-t', $assetsDirectory]);
+    $server->setTimeout(null);
+    $server->setTty(true);
+    $server->setEnv([
+        'PHP_CLI_SERVER_WORKERS' => 2,
+        Handler::ASSETS_DIRECTORY_VARIABLE => $assetsDirectory,
+    ]);
+
+    $server->run();
+
+    exit($server->getExitCode());
+})->descriptions('Run the development server', [
+    '--assets' => 'The directory where static assets can be found. By default it is the current directory.',
+]);
+
+$app->setDefaultCommand('run');
+$app->run();

composer.json

@@ -20,12 +20,15 @@
     "require": {
         "php": ">=8.0",
         "bref/bref": "^1.0",
-        "filp/whoops": "^2.9",
+        "filp/whoops": "^2.5",
+        "mnapoli/silly": "^1.5",
         "nyholm/psr7": "^1.0",
         "nyholm/psr7-server": "^1.0",
-        "psr/http-server-handler": "^1.0",
         "psr/http-message": "^1.0",
+        "psr/http-server-handler": "^1.0",
         "psr/http-server-middleware": "^1.0",
+        "symfony/console": "^4.0|^5.0",
+        "symfony/process": "^4.0|^5.0",
         "symfony/yaml": "^4.0|^5.0"
     },
     "require-dev": {

src/DevServer.php

@@ -2,46 +2,25 @@
 
 namespace Bref\DevServer;
 
-use Bref\Bref;
-use Nyholm\Psr7\Factory\Psr17Factory;
-use Nyholm\Psr7Server\ServerRequestCreator;
-use Symfony\Component\Yaml\Yaml;
-use Whoops\Handler\PrettyPageHandler;
-use Whoops\Run;
+use Symfony\Component\Process\Process;
 
 class DevServer
 {
-    public function run(): bool|null
+    public function run(): void
     {
-        // Serve assets
-        if (PHP_SAPI === 'cli-server') {
-            $url = parse_url($_SERVER['REQUEST_URI']);
-            if (is_file(getcwd() . '/web' . ($url['path'] ?? ''))) return false;
-        }
+        $handler = __DIR__ . '/server-handler.php';
+        $assetsDirectory = getcwd();
 
-        $whoops = new Run;
-        $whoops->pushHandler(new PrettyPageHandler);
-        $whoops->register();
+        $server = new Process(['php', '-S', '127.0.0.1:8000', $handler, '-t', $assetsDirectory]);
+        $server->setTimeout(null);
+        $server->setTty(true);
+        $server->setEnv([
+            'PHP_CLI_SERVER_WORKERS' => 2,
+            Handler::ASSETS_DIRECTORY_VARIABLE => $assetsDirectory,
+        ]);
 
-        $container = Bref::getContainer();
+        $server->run();
 
-        $psr17Factory = new Psr17Factory;
-        $requestFactory = new ServerRequestCreator(
-            $psr17Factory,
-            $psr17Factory,
-            $psr17Factory,
-            $psr17Factory
-        );
-
-        $serverlessConfig = Yaml::parseFile(getcwd() . '/serverless.yml', Yaml::PARSE_CUSTOM_TAGS);
-        $router = Router::fromServerlessConfig($serverlessConfig);
-
-        $request = $requestFactory->fromGlobals();
-        [$handler, $request] = $router->match($request);
-        $controller = $handler ? $container->get($handler) : new NotFound;
-        $response = $controller->handle($request);
-        (new ResponseEmitter)->emit($response);
-
-        return null;
+        exit($server->getExitCode());
     }
 }

src/Handler.php

@@ -0,0 +1,64 @@
+<?php declare(strict_types=1);
+
+namespace Bref\DevServer;
+
+use Bref\Bref;
+use Nyholm\Psr7\Factory\Psr17Factory;
+use Nyholm\Psr7Server\ServerRequestCreator;
+use Psr\Http\Message\ServerRequestInterface;
+use RuntimeException;
+use Symfony\Component\Yaml\Yaml;
+use Whoops\Handler\PrettyPageHandler;
+use Whoops\Run;
+
+/**
+ * @internal
+ */
+class Handler
+{
+    public const ASSETS_DIRECTORY_VARIABLE = '_BREF_LOCAL_ASSETS_DIRECTORY';
+
+    public function handleRequest(): bool|null
+    {
+        $assetsDirectory = getenv(self::ASSETS_DIRECTORY_VARIABLE);
+
+        // Serve assets
+        if (PHP_SAPI === 'cli-server') {
+            $url = parse_url($_SERVER['REQUEST_URI']);
+            if (is_file($assetsDirectory . ($url['path'] ?? ''))) return false;
+        }
+
+        $whoops = new Run;
+        $whoops->pushHandler(new PrettyPageHandler);
+        $whoops->register();
+
+        $container = Bref::getContainer();
+
+        $serverlessFile = getcwd() . '/serverless.yml';
+        if (! file_exists($serverlessFile)) {
+            throw new RuntimeException('No serverless.yml file was found in the current directory. This dev server needs a serverless.yml to discover the API Gateway routes.');
+        }
+        $serverlessConfig = Yaml::parseFile($serverlessFile, Yaml::PARSE_CUSTOM_TAGS);
+        $router = Router::fromServerlessConfig($serverlessConfig);
+
+        $request = $this->requestFromGlobals();
+        [$handler, $request] = $router->match($request);
+        $controller = $handler ? $container->get($handler) : new NotFound;
+        $response = $controller->handle($request);
+        (new ResponseEmitter)->emit($response);
+
+        return null;
+    }
+
+    private function requestFromGlobals(): ServerRequestInterface
+    {
+        $psr17Factory = new Psr17Factory;
+        $requestFactory = new ServerRequestCreator(
+            $psr17Factory,
+            $psr17Factory,
+            $psr17Factory,
+            $psr17Factory
+        );
+        return $requestFactory->fromGlobals();
+    }
+}

src/NotFound.php

@@ -14,6 +14,8 @@ class NotFound implements RequestHandlerInterface
 {
     public function handle(ServerRequestInterface $request): ResponseInterface
     {
-        return new Response(404, [], 'Route not found in serverless.yml');
+        $url = $request->getUri()->getPath();
+
+        return new Response(404, [], "Route '$url' not found in serverless.yml");
     }
 }

src/server-handler.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+use Bref\DevServer\Handler;
+
+if (file_exists(__DIR__ . '/../vendor/autoload.php')) {
+    require_once __DIR__ . '/../vendor/autoload.php';
+} else {
+    require_once __DIR__ . '/../../../autoload.php';
+}
+
+return (new Handler)->handleRequest();