Merge pull request #2 from apisearch-io/feature/static-content

Adding static files server

Author: mmoreram

.circleci/config.yml

@@ -0,0 +1,14 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/php:7.1-cli
+
+    working_directory: ~/project
+    steps:
+      - checkout
+      - run:
+          name: Run tests
+          command: |
+            composer install -n --prefer-dist --no-suggest
+            php vendor/bin/phpunit

.gitignore

@@ -1,3 +1,4 @@
 vendor
 .php_cs.cache
-composer.lock
+composer.lock
+var

README.md

@@ -1,18 +1,23 @@
 # Symfony ReactPHP Server
 
+[![CircleCI](https://circleci.com/gh/apisearch-io/symfony-react-server.svg?style=svg)](https://circleci.com/gh/apisearch-io/symfony-react-server)
+[![Join the Slack](https://img.shields.io/badge/join%20us-on%20slack-blue.svg)](https://apisearch.slack.com)
+
 This package provides an async server for Symfony kernel based on ReactPHP
 packages and Promise implementation. The server is distributed with all the
 Symfony kernel adapters, and can be easily extended for new Kernel
 modifications.
 
-> At the moment, this server cannot serve static files. This feature will be
-> added soon.
-
 You can take a look at the 
 [Symfony + ReactPHP Series](https://medium.com/@apisearch/symfony-and-reactphp-series-82082167f6fb)
 in order to understand a little bit better the rationale behind using this
 server and Promises in your domain.
 
+> This server is mainly designed to work as a non-blocking symfony server. Used
+> as a regular one should be part of an architecture, containing, at least, a
+> balancer and several instanced in several ports. Otherwise you may have 
+> performance issues.
+
 ## Installation
 
 In order to use this server, you only have to add the requirement in composer.
@@ -33,7 +38,7 @@ This is a PHP file. This means that the way of starting this server is by, just,
 executing it.
 
 ```php
-php vendor/bin/server
+php vendor/bin/server 0.0.0.0:8100
 ```
 
 You will find that the server starts with a default configuration. You can
@@ -43,22 +48,83 @@ configure how the server starts and what adapters use.
   instance in order to start serving Requests. By default, `symfony4`. Can be
   overridden with option `--adapter` and the value must be a valid class
   namespace of an instance of `KernelAdapter`
-  
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --adapter=symfony4
+php vendor/bin/server 0.0.0.0:8100 --adapter=My\Own\Adapter
+```
+
 - Bootstrap: How the application is bootstrapped. This would be usually a simple
   autoload require, but sometimes, like in symfony, can be some extra actions
   before the Kernel is instanced. By default, `symfony4`. Available options are
   `Symfony4` and `autoload`. Can be overridden with the option `--bootstrap` and
   the value must be a valid path of a file, starting from the project root.
-  
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --bootstrap=symfony4
+php vendor/bin/server 0.0.0.0:8100 --bootstrap=autoload
+php vendor/bin/server 0.0.0.0:8100 --bootstrap=config/myfile.php
+```
+
 - Environment: Kernel environment. By default `prod`, but turns `dev` if the
   option `--dev` is found.
-  
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --dev
+```
+
 - Debug: Kernel will start with this option is enabled. By default false,
-  enabled if the option `--debug` is found.
-  
+  enabled if the option `--debug` is found. Makes sense on development
+  environment, but is not exclusive.
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --dev --debug
+```
+
 - Silent: No information nor any kind of report will be printed in the standard
   output. By default disabled, but can be enabled with `--silent`.
-  
-- Non Blocking: This option enabled async kernel. If this option is not found,
-  the server will use the standard `handle` kernel method. Otherwise, will
-  use the `handleAsync` method, working in that case, as a non-blocking server.
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --silent
+```
+
+
+## Turning the server non-blocking
+
+By default, the server will work as a blocking server with the Symfony HTTP 
+Kernel. The server will use the method `handle` to properly serve requests. If
+your application starts working with the asynchronous kernel, you must ensure
+your kernel uses the AsyncKernel implementation.
+
+> Make sure you have the dependency installed in your composer.json file. You
+> must include the line `apisearch-io/symfony-async-http-kernel` under require
+> section. Then, `composer update`.
+
+To turn on the asynchronous feature, just add this flag
+
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --non-blocking
+```
+
+## Serving static files
+
+Kernel Adapters have already defined the static folder related to the kernel.
+For example, Symfony4 adapter will provide static files from folder `/public`.
+
+You can override the static folder with the command option `--static-folder`.
+All files inside this defined folder will be served statically in a non-blocking
+way
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --static-folder=public
+```
+
+You can disable static folder with the option `--no-static-folder`. This can be
+useful when working with the adapter value and want to disable the default
+value, for example, for an API.
+
+
+```bash
+php vendor/bin/server 0.0.0.0:8100 --no-static-folder
+```

bin/server

@@ -69,8 +69,11 @@ use Apisearch\SymfonyReactServer\Adapter\Symfony4KernelAdapter;
  * Server.
  */
 $arguments = buildServerArguments($argv);
+$rootPath = getcwd();
 $environment = array_key_exists('--dev', $arguments) ? 'dev' : 'prod';
 $silent = $arguments['--silent'] ?? false;
+$staticFolder = $arguments['--static-folder'] ?? '';
+$staticFolder = isset($arguments['--no-static-folder']) ? null : $staticFolder;
 $debug = $arguments['--debug'] ?? false;
 $nonBlocking = $arguments['--non-blocking'] ?? false;
 $adapter = $arguments['--adapter'] ?? 'symfony4';
@@ -84,6 +87,7 @@ $bootstrapFile = [
 ][$bootstrap] ?? $bootstrap;
 
 if (
+    !requireIfExists(__DIR__."/../$bootstrapFile") &&
     !requireIfExists(__DIR__."/../../$bootstrapFile") &&
     !requireIfExists(__DIR__."/../../../../$bootstrapFile")
 ) {
@@ -99,14 +103,16 @@ if (!is_a($adapter, KernelAdapter::class, true)) {
 }
 
 $application = new \Apisearch\SymfonyReactServer\Application(
+    $rootPath,
     $host,
     $port,
     $environment,
     $debug,
     $silent,
     $nonBlocking,
     $adapter,
-    $bootstrapFile
+    $bootstrapFile,
+    $staticFolder
 );
 
-$application->run();
+$application->run();

composer.json

@@ -16,7 +16,17 @@
         "react/http": "^0.8",
         "react/event-loop": "^1",
         "react/socket": "^1",
-        "react/promise": "^2"
+        "react/promise": "^2",
+        "react/filesystem": "*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.0.0",
+        "mmoreram/php-formatter": "^1.3.1",
+        "friendsofphp/php-cs-fixer": "^2.5.0",
+        "apisearch-io/symfony-async-http-kernel": "dev-master",
+        "symfony/framework-bundle": "^4.2",
+        "symfony/process": "^4.2",
+        "symfony/config": "^4.2"
     },
     "suggest": {
         "apisearch-io/symfony-async-http-kernel": "To enable --non-blocking flag and work with Async Kernel"
@@ -26,18 +36,15 @@
             "Apisearch\\SymfonyReactServer\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Apisearch\\SymfonyReactServer\\Tests\\": "tests"
+        }
+    },
     "bin": [
         "bin/server"
     ],
     "scripts": {
-        "post-install-cmd": [
-            "OneBundleApp\\App\\ComposerHook::installConsole",
-            "OneBundleApp\\App\\ComposerHook::installReactServer"
-        ],
-        "post-update-cmd": [
-            "OneBundleApp\\App\\ComposerHook::installConsole",
-            "OneBundleApp\\App\\ComposerHook::installReactServer"
-        ],
         "fix-code": [
             "vendor/bin/php-cs-fixer fix --config=.php_cs",
             "vendor/bin/php-formatter f:h:f . --exclude=vendor --exclude=web --exclude=bin --exclude=var",

phpunit.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="false"
+         convertNoticesToExceptions="false"
+         convertWarningsToExceptions="false"
+         processIsolation="false"
+         stopOnFailure="true"
+         bootstrap="vendor/autoload.php"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+
+</phpunit>

src/Adapter/KernelAdapter.php

@@ -34,4 +34,13 @@ public static function buildKernel(
         string $environment,
         bool $debug
     ) : Kernel;
+
+    /**
+     * Get static folder by kernel
+     *
+     * @param Kernel $kernel
+     *
+     * @return string|null
+     */
+    public static function getStaticFolder(Kernel $kernel) : ? string;
 }

src/Adapter/Symfony4KernelAdapter.php

@@ -38,4 +38,16 @@ public static function buildKernel(
     {
         return new ApplicationKernel($environment, $debug);
     }
+
+    /**
+     * Get static folder by kernel
+     *
+     * @param Kernel $kernel
+     *
+     * @return string|null
+     */
+    public static function getStaticFolder(Kernel $kernel) : ? string
+    {
+        return '/public';
+    }
 }