New event listeners added (#40)

Author: tarampampam

.codecov.yml

@@ -0,0 +1,26 @@
+# Docs: <https://docs.codecov.io/docs/commit-status>
+
+coverage:
+  # coverage lower than 50 is red, higher than 90 green
+  range: 30..80
+
+  status:
+    project:
+      default:
+        # Choose a minimum coverage ratio that the commit must meet to be considered a success.
+        #
+        # `auto` will use the coverage from the base commit (pull request base or parent commit) coverage to compare
+        # against.
+        target: auto
+
+        # Allow the coverage to drop by X%, and posting a success status.
+        threshold: 5%
+
+        # Resulting status will pass no matter what the coverage is or what other settings are specified.
+        informational: true
+
+    patch:
+      default:
+        target: auto
+        threshold: 5%
+        informational: true

.github/workflows/tests.yml

@@ -12,7 +12,7 @@ on:
     paths-ignore:
       - '**.md'
   schedule:
-    - cron: '0 0 * * 0' # once in a week, docs: <https://git.io/JvxXE#onschedule>
+    - cron: '0 0 * * 1' # once in a week, docs: <https://git.io/JvxXE#onschedule>
 
 jobs: # Docs: <https://help.github.com/en/articles/workflow-syntax-for-github-actions>
   tests:
@@ -24,14 +24,17 @@ jobs: # Docs: <https://help.github.com/en/articles/workflow-syntax-for-github-ac
       matrix:
         setup: ['basic', 'lowest']
         php: ['7.4', '8.0']
-        rr: ['2.0.1']
+        rr: ['2.2.1'] # Releases: <https://github.com/spiral/roadrunner-binary/releases>
+        coverage: ['true']
         include:
           - php: '7.4'
             setup: 'basic'
-            coverage: 'true'
+            rr: '2.0.0'
+            coverage: 'false'
           - php: '8.0'
-            setup: 'basic'
-            coverage: 'true'
+            setup: 'lowest'
+            rr: '2.0.0'
+            coverage: 'false'
     steps:
       - name: Check out code
         uses: actions/checkout@v2
@@ -43,7 +46,7 @@ jobs: # Docs: <https://help.github.com/en/articles/workflow-syntax-for-github-ac
         uses: shivammathur/setup-php@v2 # Action page: <https://github.com/shivammathur/setup-php>
         with:
           php-version: ${{ matrix.php }}
-          extensions: mbstring, pdo, pdo_sqlite, sqlite3, xdebug # definition is required for php 7.4
+          extensions: xdebug
 
       - name: Get Composer Cache Directory # Docs: <https://github.com/actions/cache/blob/master/examples.md#php---composer>
         id: composer-cache
@@ -95,7 +98,6 @@ jobs: # Docs: <https://help.github.com/en/articles/workflow-syntax-for-github-ac
         uses: shivammathur/setup-php@v2
         with:
           php-version: 7.4
-          extensions: mbstring
 
       - name: Get Composer Cache Directory
         id: composer-cache

CHANGELOG.md

@@ -4,6 +4,30 @@ 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
+
+### Added
+
+- Listener `FlushArrayCacheListener` for flushing `array`-based cache storages
+- Listener `FlushAuthenticationStateListener` for authentication state flushing
+- Listener `RebindAuthorizationGateListener` for the authorization gate container rebinding
+- Listener `RebindBroadcastManagerListener` for the broadcast manager container rebinding
+- Listener `RebindDatabaseManagerListener` for the database manager container rebinding
+- Listener `RebindMailManagerListener` for the mail manager container rebinding and resolved mailer instances clearing
+- Listener `RebindNotificationChannelManagerListener` for the notification channel manager container rebinding and resolved driver instances clearing
+- Listener `RebindPipelineHubListener` for the pipeline hub container rebinding
+- Listener `RebindQueueManagerListener` for the queue manager container rebinding
+- Listener `RebindValidationFactoryListener` for the validator container rebinding
+- Listener `ResetDatabaseRecordModificationStateListener` for resetting the database record modification state
+- Listener `ResetLocaleStateListener` for the translator locale resetting
+- Integration with [inertiajs](https://inertiajs.com/) (package [inertiajs/inertia-laravel](https://github.com/inertiajs/inertia-laravel)) is supported now (just enable `ResetInertiaListener` for `BeforeLoopIterationEvent`)
+- Integration with [Laravel Scout](https://laravel.com/docs/master/scout/) is supported now (just enable `ResetLaravelScoutListener` for `BeforeLoopIterationEvent`)
+- Integration with [Laravel Socialite](https://github.com/laravel/socialite/) is supported now (just enable `ResetLaravelSocialiteListener` for `BeforeLoopIterationEvent`)
+
+### Changed
+
+- Listeners `RebindHttpKernelListener`, `RebindRouterListener`, `RebindViewListener` and `UnqueueCookiesListener` improved
+
 ## v4.0.1
 
 ### Fixed

Dockerfile

@@ -4,10 +4,10 @@ FROM php:8.0-alpine
 ENV COMPOSER_HOME="/tmp/composer"
 
 # Image page: <https://hub.docker.com/_/composer>
-COPY --from=composer:2.0.11 /usr/bin/composer /usr/bin/composer
+COPY --from=composer:2.0.13 /usr/bin/composer /usr/bin/composer
 
 # Image page: <https://hub.docker.com/r/spiralscout/roadrunner>
-COPY --from=spiralscout/roadrunner:2.0.1 /usr/bin/rr /usr/bin/rr
+COPY --from=spiralscout/roadrunner:2.2.1 /usr/bin/rr /usr/bin/rr
 
 RUN set -x \
     && apk add --no-cache binutils git \

README.md

@@ -2,7 +2,7 @@
   <img src="https://hsto.org/webt/xl/pr/89/xlpr891cyv9ux3gm7dtzwjse_5a.png" alt="logo" width="420" />
 </p>
 
-# [RoadRunner][roadrunner] ⇆ Laravel bridge
+# [RoadRunner][roadrunner] ⇆ [Laravel][laravel] bridge
 
 [![Version][badge_packagist_version]][link_packagist]
 [![Version][badge_php_version]][link_packagist]

composer.json

@@ -16,23 +16,39 @@
     ],
     "require": {
         "php": "^7.4 || ^8.0",
+        "composer-runtime-api": "^2.0",
+        "illuminate/auth": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/broadcasting": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/cache": "~6.0 || ~7.0 || ~8.0",
         "illuminate/contracts": "~6.0 || ~7.0 || ~8.0",
-        "illuminate/support": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/cookie": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/database": "~6.0 || ~7.0 || ~8.0",
         "illuminate/http": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/mail": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/notifications": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/pipeline": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/queue": "~6.0 || ~7.0 || ~8.0",
         "illuminate/routing": "~6.0 || ~7.0 || ~8.0",
-        "spiral/roadrunner-worker": "^2.0",
-        "spiral/roadrunner-http": "^2.0",
-        "symfony/psr-http-message-bridge": "^1.2 || ^2.0",
+        "illuminate/session": "~6.0 || ~7.0 || ~8.0",
+        "illuminate/support": "~6.0 || ~7.0 || ~8.0",
+        "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",
+        "spiral/roadrunner-http": "^2.0",
+        "spiral/roadrunner-worker": "^2.0",
         "symfony/console": "^4.3.4 || ^5.0",
-        "composer-runtime-api": "^2.0"
+        "symfony/psr-http-message-bridge": "^1.2 || ^2.0"
     },
     "require-dev": {
+        "guzzlehttp/guzzle": "^6.3 || ~7.0",
+        "inertiajs/inertia-laravel": "^0.4.2",
         "laravel/laravel": "~6.0 || ~7.0 || ~8.0",
+        "laravel/scout": "~8.0 || ~9.0",
+        "laravel/socialite": "^5.0",
         "mockery/mockery": "^1.3.2",
         "phpstan/phpstan": "~0.12.80",
-        "phpunit/phpunit": "^8.0 || ^9.3",
-        "guzzlehttp/guzzle": "^6.3 || ~7.0"
+        "phpunit/phpunit": "^8.0 || ^9.3"
     },
     "autoload": {
         "psr-4": {
@@ -48,7 +64,7 @@
         "bin/rr-worker"
     ],
     "scripts": {
-        "phpunit": "@php ./vendor/bin/phpunit --no-coverage --colors=always",
+        "phpunit": "@php ./vendor/bin/phpunit --no-coverage",
         "phpunit-cover": "@php ./vendor/bin/phpunit",
         "phpstan": "@php ./vendor/bin/phpstan analyze -c ./phpstan.neon.dist --no-progress --ansi",
         "test": [

config/roadrunner.php

@@ -27,23 +27,24 @@
     */
 
     'pre_resolving' => [
-        'view',
-        'files',
-        'session',
-        'session.store',
-        'routes',
-        'db',
-        'db.factory',
+        'auth',
         'cache',
         'cache.store',
         'config',
         'cookie',
+        'db',
+        'db.factory',
         'encrypter',
+        'files',
         'hash',
+        'log',
         'router',
+        'routes',
+        'session',
+        'session.store',
         'translator',
         'url',
-        'log',
+        'view',
     ],
 
     /*
@@ -66,10 +67,24 @@
             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
         ],
 
         Events\BeforeRequestHandlingEvent::class => [
@@ -85,6 +100,8 @@
         ],
 
         Events\AfterLoopIterationEvent::class => [
+            Listeners\FlushArrayCacheListener::class,
+            Listeners\ResetDatabaseRecordModificationStateListener::class,
             Listeners\ClearInstancesListener::class,
             Listeners\RunGarbageCollectorListener::class,
         ],
@@ -110,7 +127,7 @@
     */
 
     'clear_instances' => [
-        'auth',
+        'auth', // is not required for Laravel >= v8.35
     ],
 
     /*
@@ -124,8 +141,8 @@
     */
 
     'reset_providers' => [
-        Illuminate\Auth\AuthServiceProvider::class,
+        Illuminate\Auth\AuthServiceProvider::class, // is not required for Laravel >= v8.35
         // App\Your\Custom\AuthServiceProvider::class,
-        Illuminate\Pagination\PaginationServiceProvider::class,
+        Illuminate\Pagination\PaginationServiceProvider::class, // is not required for Laravel >= v8.35
     ],
 ];

phpstan.neon.dist

@@ -3,11 +3,4 @@ parameters:
   paths:
     - src
     - bin/rr-worker
-  reportUnmatchedIgnoredErrors: false
-  ignoreErrors:
-    - message: '#Access to an undefined property.*::\$app#'
-      paths: [src/Listeners/RebindHttpKernelListener.php]
-    - message: '#Access to an undefined property.*::\$container#'
-      paths: [src/Listeners/RebindRouterListener.php]
-    - message: '#Access to an undefined property.*::\$(container|shared)#'
-      paths: [src/Listeners/RebindViewListener.php]
+  reportUnmatchedIgnoredErrors: true

phpunit.xml.dist

@@ -6,10 +6,10 @@
 
     <testsuites>
         <testsuite name="Unit">
-            <directory suffix="Test.php">./tests/Unit</directory>
+            <directory>./tests/Unit</directory>
         </testsuite>
         <testsuite name="Feature">
-            <directory suffix="Test.php">./tests/Feature</directory>
+            <directory>./tests/Feature</directory>
         </testsuite>
     </testsuites>
 
@@ -22,10 +22,10 @@
             <directory>./tests</directory>
         </exclude>
         <report>
-            <clover outputFile="./coverage/clover.xml"/>
             <html outputDirectory="./coverage/html"/>
-            <text outputFile="php://stdout" showUncoveredFiles="false"/>
             <xml outputDirectory="./coverage/xml"/>
+            <clover outputFile="./coverage/clover.xml"/>
+            <text outputFile="php://stdout" showUncoveredFiles="false"/>
         </report>
     </coverage>
 
@@ -36,6 +36,11 @@
         <log type="coverage-clover" target="./coverage/clover.xml"/>
         <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"/>
     </logging>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
     <!-- /deprecated -->
 
     <php>

src/Listeners/FlushArrayCacheListener.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\RoadRunnerLaravel\Listeners;
+
+use Illuminate\Cache\CacheManager;
+use Spiral\RoadRunnerLaravel\Events\Contracts\WithApplication;
+use Illuminate\Contracts\Config\Repository as ConfigRepository;
+
+/**
+ * @link https://github.com/laravel/octane/blob/1.x/src/Listeners/FlushArrayCache.php
+ */
+class FlushArrayCacheListener implements ListenerInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function handle($event): void
+    {
+        if ($event instanceof WithApplication) {
+            $app = $event->application();
+
+            /** @var ConfigRepository $config */
+            $config = $app->make(ConfigRepository::class);
+
+            /** @var CacheManager $cache_manager */
+            $cache_manager = $app->make('cache');
+
+            foreach ($config->get('cache.stores') as $name => $options) {
+                if (($options['driver'] ?? '') === 'array') {
+                    $cache_manager->store($name)->getStore()->flush();
+                }
+            }
+        }
+    }
+}