[v5] Worker&config refactoring (#44)

Author: tarampampam

CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog][keepachangelog] and this project adheres to [Semantic Versioning][semver].
 
+## UNRELEASED (v5.x.x)
+
+### Added
+
+- Listener `RebindDatabaseSessionHandlerListener` for the database session driver container rebinding [[octane#300](https://github.com/laravel/octane/issues/300)]
+- Listener `WarmInstancesListener` for instances pre-resolving
+
+### Changed
+
+- Most important configuration values (such as event listeners) now defined in `Spiral\RoadRunnerLaravel\Defaults` class and used by the package configuration file (in the future, you will not need to update your config file manually when new "core" listeners will be added)
+- Dependency `laminas/laminas-diactoros` replaced with [`nyholm/psr7`](https://github.com/Nyholm/psr7) (lightweight PSR-7 implementation, strict and fast)
+- Config option `pre_resolving` replaced with `warm`
+- Config option `clear_instances` replaced with `clear`
+- Worker code refactored
+
 ## v4.1.0
 
 ### Added

README.md

@@ -33,7 +33,13 @@ $ php ./artisan vendor:publish --provider='Spiral\RoadRunnerLaravel\ServiceProvi
 
 **Important**: despite the fact that worker allows you to refresh application instance on each HTTP request _(if worker started with option `--refresh-app`, eg.: `php ./vendor/bin/rr-worker start --refresh-app`)_, we strongly recommend avoiding this for performance reasons. Large applications can be hard to integrate with RoadRunner _(you must decide which of service providers must be reloaded on each request, avoid "static optimization" in some cases)_, but it's worth it.
 
-### Upgrading guide (`v3.x` → `v4.x`)
+### Upgrading guide
+
+#### **v4.x** → **v5.x**
+
+- Update package configuration file (`roadrunner.php`; take a look for actual example in current repository)
+
+#### **v3.x** → **v4.x**
 
 - Update current package in your application:
   - `composer remove spiral/roadrunner-laravel`
@@ -42,8 +48,8 @@ $ php ./artisan vendor:publish --provider='Spiral\RoadRunnerLaravel\ServiceProvi
   - Optionally change relay to socket or TCP port:
     > ```yaml
     > server:
-    >   command: "php ./vendor/bin/rr-worker start --relay-dsn unix:///var/run/rr-rpc.sock"
-    >   relay: "unix:///var/run/rr-rpc.sock"
+    >   command: "php ./vendor/bin/rr-worker start --relay-dsn unix:///var/run/rr-relay.sock"
+    >   relay: "unix:///var/run/rr-relay.sock"
     > ```
 - Update RR binary file (using [`roadrunner-cli`][roadrunner-cli] or download from [binary releases][roadrunner-binary-releases] page) up to `v2.x`
 - Update RoadRunner starting (`rr serve ...`) flags - `-v` and `-d` must be not used anymore
@@ -69,12 +75,12 @@ Simple `.rr.yaml` config example ([full example can be found here][roadrunner_co
 
 ```yaml
 server:
-  command: "php ./vendor/bin/rr-worker start --relay-dsn unix:///var/run/rr-rpc.sock"
-  relay: "unix:///var/run/rr-rpc.sock"
+  command: "php ./vendor/bin/rr-worker start --relay-dsn unix:///var/run/rr-relay.sock"
+  relay: "unix:///var/run/rr-relay.sock"
 
 http:
   address: 0.0.0.0:8080
-  middleware: ["headers", "static", "gzip"]
+  middleware: ["headers", "gzip"]
   pool:
     max_jobs: 64 # feel free to change this
     supervisor:

bin/rr-worker

@@ -66,7 +66,7 @@ foreach (['../../../..', '../../..', '../..', '..', '../vendor/laravel/laravel']
 
 $app = new \Symfony\Component\Console\Application(
     'RoadRunner worker',
-    \Composer\InstalledVersions::getPrettyVersion('spiral/roadrunner-laravel')
+    \Composer\InstalledVersions::getPrettyVersion('spiral/roadrunner-laravel') ?? 'unknown'
 );
 
 $app->add(new \Spiral\RoadRunnerLaravel\Console\Commands\StartCommand(

composer.json

@@ -34,7 +34,7 @@
         "illuminate/translation": "~6.0 || ~7.0 || ~8.0",
         "illuminate/validation": "~6.0 || ~7.0 || ~8.0",
         "illuminate/view": "~6.0 || ~7.0 || ~8.0",
-        "laminas/laminas-diactoros": "^2",
+        "nyholm/psr7": "^1.2",
         "spiral/roadrunner-http": "^2.0",
         "spiral/roadrunner-worker": "^2.0",
         "symfony/console": "^4.3.4 || ^5.0",

config/roadrunner.php

@@ -1,6 +1,7 @@
 <?php
 
 use Spiral\RoadRunnerLaravel\Events;
+use Spiral\RoadRunnerLaravel\Defaults;
 use Spiral\RoadRunnerLaravel\Listeners;
 
 return [
@@ -10,123 +11,80 @@
     |--------------------------------------------------------------------------
     |
     | Set this value to `true` if your application uses HTTPS (required for
-    | example for correct links generation).
+    | correct links generation, for example).
     |
     */
 
     'force_https' => (bool) env('APP_FORCE_HTTPS', false),
 
-    /*
-    |--------------------------------------------------------------------------
-    | Containers Pre Resolving
-    |--------------------------------------------------------------------------
-    |
-    | Declared here abstractions will be resolved before events loop will be
-    | started.
-    |
-    */
-
-    'pre_resolving' => [
-        'auth',
-        'cache',
-        'cache.store',
-        'config',
-        'cookie',
-        'db',
-        'db.factory',
-        'encrypter',
-        'files',
-        'hash',
-        'log',
-        'router',
-        'routes',
-        'session',
-        'session.store',
-        'translator',
-        'url',
-        'view',
-    ],
-
     /*
     |--------------------------------------------------------------------------
     | Event Listeners
     |--------------------------------------------------------------------------
     |
     | Worker provided by this package allows to interacts with request
-    | processing loop using application events. Feel free to add your own event
-    | listeners.
+    | processing loop using application events.
+    |
+    | Feel free to add your own event listeners.
     |
     */
 
     'listeners' => [
         Events\BeforeLoopStartedEvent::class => [
-            Listeners\FixSymfonyFileValidationListener::class,
+            ...Defaults::beforeLoopStarted(),
         ],
 
         Events\BeforeLoopIterationEvent::class => [
-            Listeners\EnableHttpMethodParameterOverrideListener::class,
-            Listeners\RebindHttpKernelListener::class, // Laravel 7 issue: <https://git.io/JvPpf>
-            Listeners\RebindViewListener::class,
-            Listeners\RebindAuthorizationGateListener::class,
-            Listeners\RebindBroadcastManagerListener::class,
-            Listeners\RebindDatabaseManagerListener::class,
-            Listeners\RebindMailManagerListener::class,
-            Listeners\RebindNotificationChannelManagerListener::class,
-            Listeners\RebindPipelineHubListener::class,
-            Listeners\RebindQueueManagerListener::class,
-            Listeners\RebindValidationFactoryListener::class,
-            Listeners\CloneConfigListener::class,
-            Listeners\UnqueueCookiesListener::class,
-            Listeners\FlushAuthenticationStateListener::class,
-            Listeners\ResetSessionListener::class,
-            Listeners\ResetProvidersListener::class,
-            Listeners\ResetLocaleStateListener::class,
-
-            // Listeners\ResetLaravelScoutListener::class, // for 'laravel/scout' package
-            // Listeners\ResetLaravelSocialiteListener::class, // for 'laravel/socialite' package
-            // Listeners\ResetInertiaListener::class, // for 'inertiajs/inertia-laravel' package
+            ...Defaults::beforeLoopIteration(),
+            // Listeners\ResetLaravelScoutListener::class,     // for <https://github.com/laravel/scout>
+            // Listeners\ResetLaravelSocialiteListener::class, // for <https://github.com/laravel/socialite>
+            // Listeners\ResetInertiaListener::class,          // for <https://github.com/inertiajs/inertia-laravel>
         ],
 
         Events\BeforeRequestHandlingEvent::class => [
-            Listeners\RebindRouterListener::class,
+            ...Defaults::beforeRequestHandling(),
             Listeners\InjectStatsIntoRequestListener::class,
-            Listeners\BindRequestListener::class,
-            Listeners\ForceHttpsListener::class,
-            Listeners\SetServerPortListener::class,
         ],
 
         Events\AfterRequestHandlingEvent::class => [
-            //
+            ...Defaults::afterRequestHandling(),
         ],
 
         Events\AfterLoopIterationEvent::class => [
-            Listeners\FlushArrayCacheListener::class,
-            Listeners\ResetDatabaseRecordModificationStateListener::class,
-            Listeners\ClearInstancesListener::class,
-            Listeners\RunGarbageCollectorListener::class,
+            ...Defaults::afterLoopIteration(),
+            Listeners\RunGarbageCollectorListener::class, // keep the memory usage low
         ],
 
         Events\AfterLoopStoppedEvent::class => [
-            //
+            ...Defaults::afterLoopStopped(),
         ],
 
         Events\LoopErrorOccurredEvent::class => [
+            ...Defaults::loopErrorOccurred(),
             Listeners\SendExceptionToStderrListener::class,
             Listeners\StopWorkerListener::class,
         ],
     ],
 
     /*
     |--------------------------------------------------------------------------
-    | Instances Clearing
+    | Containers Pre Resolving / Clearing
     |--------------------------------------------------------------------------
     |
-    | Instances described here will be cleared on every request (if
-    | `ClearInstancesListener` is enabled).
+    | The bindings listed below will be resolved before the events loop
+    | starting. Clearing a binding will force the container to resolve that
+    | binding again when asked.
+    |
+    | Feel free to add your own bindings here.
     |
     */
 
-    'clear_instances' => [
+    'warm' => [
+        ...Defaults::servicesToWarm(),
+    ],
+
+    'clear' => [
+        ...Defaults::servicesToClear(),
         'auth', // is not required for Laravel >= v8.35
     ],
 
@@ -135,14 +93,15 @@
     | Reset Providers
     |--------------------------------------------------------------------------
     |
-    | Providers that will be registered on every request (if
-    | `ResetProvidersListener` is enabled).
+    | Providers that will be registered on every request.
+    |
+    | Feel free to add your service-providers here.
     |
     */
 
     'reset_providers' => [
-        Illuminate\Auth\AuthServiceProvider::class, // is not required for Laravel >= v8.35
-        // App\Your\Custom\AuthServiceProvider::class,
+        ...Defaults::providersToReset(),
+        Illuminate\Auth\AuthServiceProvider::class,             // is not required for Laravel >= v8.35
         Illuminate\Pagination\PaginationServiceProvider::class, // is not required for Laravel >= v8.35
     ],
 ];

phpstan.neon.dist

@@ -7,3 +7,6 @@ parameters:
     - helpers
     - src
   reportUnmatchedIgnoredErrors: true
+  ignoreErrors:
+    - message: '#Call to protected method bootstrappers\(\) of class.+Kernel#'
+      paths: [src/Application/Factory.php]

src/Application/Factory.php

@@ -0,0 +1,92 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\RoadRunnerLaravel\Application;
+
+use Illuminate\Foundation\Http\Kernel as HttpKernel;
+use Illuminate\Foundation\Bootstrap\RegisterProviders;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+use Illuminate\Foundation\Bootstrap\SetRequestForConsole;
+use Illuminate\Contracts\Http\Kernel as HttpKernelContract;
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Illuminate\Contracts\Foundation\Application as ApplicationContract;
+
+/**
+ * @internal
+ */
+final class Factory implements FactoryInterface
+{
+    /**
+     * @param string $base_path
+     * @param bool   $boostrap_app
+     *
+     * @return ApplicationContract
+     * @throws BindingResolutionException
+     */
+    public function create(string $base_path, bool $boostrap_app = true): ApplicationContract
+    {
+        $path = \implode(\DIRECTORY_SEPARATOR, [\rtrim($base_path, \DIRECTORY_SEPARATOR), 'bootstrap', 'app.php']);
+
+        if (!\is_file($path)) {
+            throw new \InvalidArgumentException("Application bootstrap file was not found in [{$path}]");
+        }
+
+        /** @var ApplicationContract $app */
+        $app = require $path;
+
+        if ($boostrap_app) {
+            $this->bootstrap($app);
+        }
+
+        return $app;
+    }
+
+    /**
+     * @param ApplicationContract $app
+     *
+     * @throws BindingResolutionException
+     */
+    protected function bootstrap(ApplicationContract $app): void
+    {
+        /** @var HttpKernel $http_kernel */
+        $http_kernel = $app->make(HttpKernelContract::class);
+
+        $bootstrappers = $this->getKernelBootstrappers($http_kernel);
+
+        // insert `SetRequestForConsole` bootstrapper before `RegisterProviders` if it does not exists
+        if (!\in_array(SetRequestForConsole::class, $bootstrappers, true)) {
+            $register_index = \array_search(RegisterProviders::class, $bootstrappers, true);
+
+            if (\is_int($register_index)) {
+                \array_splice($bootstrappers, $register_index, 0, [SetRequestForConsole::class]);
+            }
+        }
+
+        $app->bootstrapWith($bootstrappers);
+    }
+
+    /**
+     * Get HTTP or Console kernel bootstrappers.
+     *
+     * @param HttpKernel|ConsoleKernel $kernel
+     *
+     * @return array<class-string> Bootstrappers class names
+     */
+    protected function getKernelBootstrappers($kernel): array
+    {
+        $bootstrappers = [];
+
+        \Closure::fromCallable(function () use (&$bootstrappers): void {
+            /**
+             * @see HttpKernel::bootstrappers()
+             * @see ConsoleKernel::bootstrappers()
+             *
+             * @var HttpKernel|ConsoleKernel $this
+             */
+            \array_push($bootstrappers, ...$this->bootstrappers());
+        })->bindTo($kernel, $kernel)();
+
+        return $bootstrappers;
+    }
+}

src/Application/FactoryInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spiral\RoadRunnerLaravel\Application;
+
+use Illuminate\Contracts\Foundation\Application as ApplicationContract;
+
+interface FactoryInterface
+{
+    /**
+     * Create a new application instance.
+     *
+     * @param string $base_path
+     *
+     * @return ApplicationContract
+     */
+    public function create(string $base_path): ApplicationContract;
+}

src/Console/Commands/StartCommand.php

@@ -70,7 +70,7 @@ protected function configure(): void
             InputOption::VALUE_REQUIRED,
             'Relay DSN (eg.: <comment>' . \implode(
                 '</comment>, <comment>',
-                ['pipes', 'tcp://localhost:6001', 'unix:///tmp/rpc.sock']
+                ['pipes', 'tcp://localhost:6001', 'unix:///tmp/relay.sock']
             ) . '</comment>)',
             'pipes'
         );