New major (v4) package version (#35)

### Added

- Package "binary" file allows using next options:
  - `laravel-path` for Laravel application base path changing
  - `relay-dsn` for RR relay changing (you can set `tcp://localhost:6001`, `unix:///tmp/rpc.sock` and others; `pipes` is used by default)
  - `refresh-app` for application instance refreshing on each incoming HTTP request (instead `APP_REFRESH` env variable)
- Possibility to use unix socket or TCP port as a relay to communicate with RoadRunner
- `Spiral\RoadRunnerLaravel\WorkerOptionsInterface` that describes worker starting options
- Feature tests (`phpunit`) that uses real RR server running

### Changed

- Minimal required PHP version now is `7.4`
- Dependency `spiral/roadrunner` (`~1.8`) changed with `spiral/roadrunner-worker` and `spiral/roadrunner-http` (`^2.0`)
- RR worker instance binding for DI from `Spiral\RoadRunner\PSR7Client` to `Spiral\RoadRunner\Http\PSR7Worker`
- `Spiral\RoadRunnerLaravel\WorkerInterface::start` accepts `Spiral\RoadRunnerLaravel\WorkerOptionsInterface` now

### Removed

- RR config file (`.rr.yaml`) publishing using `artisan vendor:publish` command
- Listener `Spiral\RoadRunnerLaravel\Listeners\ResetDbConnectionsListener`

Author: tarampampam

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,7 +3,6 @@ name: Bug report
 about: Create a report to help us improve
 labels: type:bug
 assignees: tarampampam
-
 ---
 
 ## Describe the bug
@@ -28,9 +27,9 @@ assignees: tarampampam
 
 Key                     | Value
 ----------------------- | ----
-PHP version             | <!-- e.g. `7.2.6` -->
-Current package version | <!-- e.g. `3.6.0` -->
-RoadRunner version      | <!-- e.g. `1.8.3` -->
+PHP version             | <!-- e.g. `8.0.3` -->
+Current package version | <!-- e.g. `4.0.0` -->
+RoadRunner version      | <!-- e.g. `2.0.1` -->
 Environment             | <!-- e.g. `docker`, `local`, `aws` -->
 
 ### RoadRunner configuration file content

.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,7 +3,6 @@ name: Feature request
 about: Suggest an idea for this package
 labels: type:enhancement
 assignees: tarampampam
-
 ---
 
 ### Is your feature request related to a problem?

.github/ISSUE_TEMPLATE/question.md

@@ -3,7 +3,6 @@ name: Question
 about: Ask anything
 labels: type:question
 assignees: tarampampam
-
 ---
 
 > If you have any questions feel free to ask

.github/workflows/tests.yml

@@ -16,16 +16,17 @@ on:
 
 jobs: # Docs: <https://help.github.com/en/articles/workflow-syntax-for-github-actions>
   tests:
-    name: PHP ${{ matrix.php }} (${{ matrix.setup }} setup)
+    name: PHP ${{ matrix.php }}, RR ${{ matrix.rr }} (${{ matrix.setup }} setup)
     runs-on: ubuntu-20.04
     timeout-minutes: 10
     strategy:
       fail-fast: false
       matrix:
         setup: ['basic', 'lowest']
-        php: ['7.3', '7.4', '8.0']
+        php: ['7.4', '8.0']
+        rr: ['2.0.1']
         include:
-          - php: '7.3'
+          - php: '7.4'
             setup: 'basic'
             coverage: 'true'
           - php: '8.0'
@@ -35,6 +36,9 @@ jobs: # Docs: <https://help.github.com/en/articles/workflow-syntax-for-github-ac
       - name: Check out code
         uses: actions/checkout@v2
 
+      - name: Install RoadRunner Binary
+        run: docker run --rm -v "/:/rootfs:rw" --entrypoint "" spiralscout/roadrunner:${{ matrix.rr }} cp /usr/bin/rr /rootfs/usr/bin/rr
+
       - name: Setup PHP, with composer and extensions
         uses: shivammathur/setup-php@v2 # Action page: <https://github.com/shivammathur/setup-php>
         with:

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 (v4 candidate)
+
+### Added
+
+- Package "binary" file allows using next options:
+  - `laravel-path` for Laravel application base path changing
+  - `relay-dsn` for RR relay changing (you can set `tcp://localhost:6001`, `unix:///tmp/rpc.sock` and others; `pipes` is used by default)
+  - `refresh-app` for application instance refreshing on each incoming HTTP request (instead `APP_REFRESH` env variable)
+- Possibility to use unix socket or TCP port as a relay to communicate with RoadRunner
+- `Spiral\RoadRunnerLaravel\WorkerOptionsInterface` that describes worker starting options
+- Feature tests (`phpunit`) that uses real RR server running
+
+### Changed
+
+- Minimal required PHP version now is `7.4`
+- Dependency `spiral/roadrunner` (`~1.8`) changed with `spiral/roadrunner-worker` and `spiral/roadrunner-http` (`^2.0`)
+- RR worker instance binding for DI from `Spiral\RoadRunner\PSR7Client` to `Spiral\RoadRunner\Http\PSR7Worker`
+- `Spiral\RoadRunnerLaravel\WorkerInterface::start` accepts `Spiral\RoadRunnerLaravel\WorkerOptionsInterface` now
+
+### Removed
+
+- RR config file (`.rr.yaml`) publishing using `artisan vendor:publish` command
+- Listener `Spiral\RoadRunnerLaravel\Listeners\ResetDbConnectionsListener`
+
 ## v3.7.0
 
 ### Added

Dockerfile

@@ -1,14 +1,20 @@
+# Image page: <https://hub.docker.com/_/php>
 FROM php:8.0-alpine
 
 ENV COMPOSER_HOME="/tmp/composer"
 
-COPY --from=composer:2.0.7 /usr/bin/composer /usr/bin/composer
+# Image page: <https://hub.docker.com/_/composer>
+COPY --from=composer:2.0.11 /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
 
 RUN set -x \
     && apk add --no-cache binutils git \
     && apk add --no-cache --virtual .build-deps autoconf pkgconf make g++ gcc 1>/dev/null \
     # install xdebug (for testing with code coverage), but do not enable it
-    && pecl install xdebug-3.0.0 1>/dev/null \
+    && pecl install xdebug-3.0.3 1>/dev/null \
+    && docker-php-ext-install sockets pcntl \
     && apk del .build-deps \
     && mkdir --parents --mode=777 /src ${COMPOSER_HOME}/cache/repo ${COMPOSER_HOME}/cache/files \
     && ln -s /usr/bin/composer /usr/bin/c \

README.md

@@ -17,35 +17,41 @@ Easy way for connecting [RoadRunner][roadrunner] and [Laravel][laravel] applicat
 
 ## Installation
 
-Require this package with composer using next command:
+Make sure that [RR binary file][roadrunner-binary-releases] already installed on your system (or docker image). Require this package with composer using next command:
 
 ```shell script
-$ composer require spiral/roadrunner-laravel "^3.4"
+$ composer require spiral/roadrunner-laravel "^4.0"
 ```
 
 > Installed `composer` is required ([how to install composer][getcomposer]).
 
-> You need to fix the major version of package.
-
 After that you can "publish" package configuration file (`./config/roadrunner.php`) using next command:
 
 ```shell script
 $ php ./artisan vendor:publish --provider='Spiral\RoadRunnerLaravel\ServiceProvider' --tag=config
 ```
 
-And basic RoadRunner configuration file (`./.rr.yaml.dist`):
+**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.
 
-```shell script
-$ php ./artisan vendor:publish --provider='Spiral\RoadRunnerLaravel\ServiceProvider' --tag=rr-config
-```
+### Upgrading guide (`v3.x` → `v4.x`)
 
-After that you can modify configuration files as you wish.
-
-**Important**: despite the fact that worker allows you to refresh application instance on each HTTP request _(if environment variable `APP_REFRESH` set to `true`)_, we strongly recommend to avoid 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.
+- Update current package in your application:
+  - `composer remove spiral/roadrunner-laravel`
+  - `composer require spiral/roadrunner-laravel "^4.0"`
+- Update your `.rr.yaml` config (take a look for sample [here][roadrunner_config]) - a lot of options was changed
+  - 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"
+    > ```
+- 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
+- In your application code replace `Spiral\RoadRunner\PSR7Client` with `Spiral\RoadRunner\Http\PSR7Worker`
 
 ## Usage
 
-After package installation you can use provided "binary" file as RoadRunner worker: `./vendor/bin/rr-worker`. This worker allows you to interact with incoming requests and outcoming responses using [laravel events system][laravel_events]. Also events contains:
+After package installation you can use provided "binary" file as RoadRunner worker: `./vendor/bin/rr-worker`. This worker allows you to interact with incoming requests and outgoing responses using [laravel events system][laravel_events]. Event contains:
 
 Event classname              | Application object | HTTP server request | HTTP request | HTTP response | Exception
 ---------------------------- | :----------------: | :-----------------: | :----------: | :-----------: | :-------:
@@ -57,48 +63,47 @@ Event classname              | Application object | HTTP server request | HTTP r
 `AfterLoopStoppedEvent`      |          ✔         |                     |              |               |
 `LoopErrorOccurredEvent`     |          ✔         |          ✔          |              |               |     ✔
 
-Simple `.rr.yaml` config example:
+Simple `.rr.yaml` config example ([full example can be found here][roadrunner_config]):
+
+> For `windows` path must be full (eg.: `php vendor/spiral/roadrunner-laravel/bin/rr-worker start`)
 
 ```yaml
-env:
-  #APP_REFRESH: true
+server:
+  command: "php ./vendor/bin/rr-worker start --relay-dsn unix:///var/run/rr-rpc.sock"
+  relay: "unix:///var/run/rr-rpc.sock"
 
 http:
   address: 0.0.0.0:8080
-  workers:
-    command: 'php ./vendor/bin/rr-worker' # for windows: `php vendor/spiral/roadrunner-laravel/bin/rr-worker`
-    pool:
-      numWorkers: 4
-      maxJobs: 64 # jobs limitation is important
-
-static:
-  dir: 'public'
+  middleware: ["headers", "static", "gzip"]
+  pool:
+    max_jobs: 64 # feel free to change this
+    supervisor:
+      exec_ttl: 60s
+  headers:
+    response:
+      X-Powered-By: "RoadRunner"
+  static:
+    dir: "public"
+    forbid: [".php"]
 ```
 
+**Socket** or **TCP port** relay usage is strongly recommended for avoiding problems with `dd()`, `dump()`, `echo()` and other similar functions, that sends data to the IO pipes.
+
 Roadrunner server starting:
 
 ```shell script
-$ rr -c ./.rr.yaml serve -d
+$ rr serve -c ./.rr.yaml
 ```
 
 ### Listeners
 
-This package provides event listeners for resetings application state without full application reload _(like cookies, HTTP request, application instance, service-providers and other)_. Some of them already declared in configuration file, but you can declare own without any limitations.
-
-### Environment variables
-
-You can use the following environment variables:
-
-Variable name     | Description
------------------ | -----------
-`APP_FORCE_HTTPS` | _(declared in configuration file)_ Forces application HTTPS schema usage
-`APP_REFRESH`     | Refresh application instance on every request
+This package provides event listeners for resetting application state without full application reload _(like cookies, HTTP request, application instance, service-providers and other)_. Some of them already declared in configuration file, but you can declare own without any limitations.
 
 ### Known issues
 
 #### Controller constructors
 
-You should avoid to use HTTP controller constructors _(created or resolved instances in constructor can be shared between different requests)_. Use dependencies resolving in controller **methods** instead.
+You should avoid to use HTTP controller constructors _(created or resolved instances in a constructor can be shared between different requests)_. Use dependencies resolving in a controller **methods** instead.
 
 Bad:
 
@@ -266,7 +271,7 @@ Changes log can be [found here][link_changes_log].
 [![Issues][badge_issues]][link_issues]
 [![Issues][badge_pulls]][link_pulls]
 
-If you will find any package errors, please, [make an issue][link_create_issue] in current repository.
+If you find any package errors, please, [make an issue][link_create_issue] in a current repository.
 
 ## License
 
@@ -294,6 +299,9 @@ MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maint
 [link_license]:https://github.com/spiral/roadrunner-laravel/blob/master/LICENSE
 [getcomposer]:https://getcomposer.org/download/
 [roadrunner]:https://github.com/spiral/roadrunner
+[roadrunner_config]:https://github.com/spiral/roadrunner-binary/blob/master/.rr.yaml
 [laravel]:https://laravel.com
 [laravel_events]:https://laravel.com/docs/events
+[roadrunner-cli]:https://github.com/spiral/roadrunner-cli
+[roadrunner-binary-releases]:https://github.com/spiral/roadrunner-binary/releases
 [#10]:https://github.com/spiral/roadrunner-laravel/issues/10

bin/rr-worker

@@ -31,7 +31,7 @@ foreach (['../../..', '../..', '..', 'vendor', '../vendor', '../../vendor'] as $
 
 if ($loaded !== true) {
     \fwrite(\STDERR, 'Composer autoload file was not found. Try to install project dependencies' . PHP_EOL);
-    exit(10);
+    exit(1);
 }
 
 /*
@@ -45,33 +45,33 @@ if ($loaded !== true) {
 |
 */
 
+/** @var string|null $base_path */
 $base_path = null;
 
 foreach (['../../../..', '../../..', '../..', '..', '../vendor/laravel/laravel'] as $path) {
     if (\is_file(__DIR__ . '/' . $path . '/bootstrap/app.php')) {
-        $base_path = \realpath(__DIR__ . '/' . $path);
+        $base_path = (string) \realpath(__DIR__ . '/' . $path);
         break;
     }
 }
 
-if (! \is_string($base_path)) {
-    \fwrite(\STDERR, 'Cannot find application base path' . PHP_EOL);
-    exit(11);
-}
-
 /*
 |--------------------------------------------------------------------------
-| Create Worker Instance
+| Create And Run Console Application
 |--------------------------------------------------------------------------
+|
+| Symfony console component is a nice wrapper around worker CLI options.
+|
 */
 
-// @todo: Make possible to use another worker class
-$worker = new \Spiral\RoadRunnerLaravel\Worker($base_path);
+$app = new \Symfony\Component\Console\Application(
+    'RoadRunner worker',
+    \Composer\InstalledVersions::getPrettyVersion('spiral/roadrunner-laravel')
+);
 
-/*
-|--------------------------------------------------------------------------
-| Start Worker Loop
-|--------------------------------------------------------------------------
-*/
+$app->add(new \Spiral\RoadRunnerLaravel\Console\Commands\StartCommand(
+    new \Spiral\RoadRunnerLaravel\Worker(),
+    $base_path
+));
 
-$worker->start((bool) \getenv('APP_REFRESH'));
+$app->run();

composer.json

@@ -15,24 +15,24 @@
         }
     ],
     "require": {
-        "php": "^7.3 || ^8.0",
-        "ext-mbstring": "*",
+        "php": "^7.4 || ^8.0",
         "illuminate/contracts": "~6.0 || ~7.0 || ~8.0",
         "illuminate/support": "~6.0 || ~7.0 || ~8.0",
         "illuminate/http": "~6.0 || ~7.0 || ~8.0",
         "illuminate/routing": "~6.0 || ~7.0 || ~8.0",
-        "spiral/roadrunner": "~1.8",
+        "spiral/roadrunner-worker": "^2.0",
+        "spiral/roadrunner-http": "^2.0",
         "symfony/psr-http-message-bridge": "^1.2 || ^2.0",
-        "laminas/laminas-diactoros": "^2"
+        "laminas/laminas-diactoros": "^2",
+        "symfony/console": "^4.3.4 || ^5.0",
+        "composer-runtime-api": "^2.0"
     },
     "require-dev": {
-        "ext-pdo": "*",
-        "ext-pdo_sqlite": "*",
-        "ext-sqlite3": "*",
         "laravel/laravel": "~6.0 || ~7.0 || ~8.0",
         "mockery/mockery": "^1.3.2",
-        "phpstan/phpstan": "~0.12.34",
-        "phpunit/phpunit": "^8.0 || ^9.3"
+        "phpstan/phpstan": "~0.12.80",
+        "phpunit/phpunit": "^8.0 || ^9.3",
+        "guzzlehttp/guzzle": "^6.3 || ~7.0"
     },
     "autoload": {
         "psr-4": {
@@ -67,11 +67,6 @@
             ]
         }
     },
-    "suggest": {
-        "illuminate/redis": "Required for dropping redis connections",
-        "illuminate/database": "Required for dropping database connections",
-        "avto-dev/stacked-dumper-laravel": "Stacked variables dumper for Laravel-based application"
-    },
     "support": {
         "issues": "https://github.com/spiral/roadrunner-laravel/issues",
         "source": "https://github.com/spiral/roadrunner-laravel"

config/roadrunner.php

@@ -4,7 +4,6 @@
 use Spiral\RoadRunnerLaravel\Listeners;
 
 return [
-
     /*
     |--------------------------------------------------------------------------
     | Force HTTPS Schema Usage
@@ -87,7 +86,6 @@
 
         Events\AfterLoopIterationEvent::class => [
             Listeners\ClearInstancesListener::class,
-            // Listeners\ResetDbConnectionsListener::class,
             Listeners\RunGarbageCollectorListener::class,
         ],