Download the PHP package pushrbx/lumen-roadrunner without Composer
On this page you can find all versions of the php package pushrbx/lumen-roadrunner. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pushrbx/lumen-roadrunner
More information about pushrbx/lumen-roadrunner
Files in pushrbx/lumen-roadrunner
Informations about the package lumen-roadrunner
Lumen framework on RoadRunner
Easy way for connecting RoadRunner and Lumen applications. This is a fork of spiral/roadrunner-laravel, which makes it work with lumen instead of the full laravel framework.
Please note that this lib is not production ready yet, it's under development.
Installation
Make sure that RR binary file already installed on your system (or docker image). Require this package with composer using next command:
Installed
composer
is required (how to install composer).
After that you can "publish" package configuration file (./config/roadrunner.php
) using next command:
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.
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 outgoing responses using laravel events system. Event contains:
Event classname | Application object | HTTP server request | HTTP request | HTTP response | Exception |
---|---|---|---|---|---|
BeforeLoopStartedEvent |
✔ | ||||
BeforeLoopIterationEvent |
✔ | ✔ | |||
BeforeRequestHandlingEvent |
✔ | ✔ | |||
AfterRequestHandlingEvent |
✔ | ✔ | ✔ | ||
AfterLoopIterationEvent |
✔ | ✔ | ✔ | ||
AfterLoopStoppedEvent |
✔ | ||||
LoopErrorOccurredEvent |
✔ | ✔ | ✔ |
Simple .rr.yaml
config example (full example can be found here):
For
windows
path must be full (eg.:php vendor/pushrbx/lumen-roadrunner/bin/rr-worker start
)
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:
Listeners
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.
Helpers
This package provides the following helpers:
Name | Description |
---|---|
\rr\dump(...) |
Dump passed values (dumped result will be available in the HTTP response) |
\rr\dd(...) |
Dump passed values and stop the execution |
\rr\worker() |
Easy access to the RoadRunner PSR worker instance |
Known issues
Performance degradation
...when file
driver is set for your sessions. Please, use redis
(or something similar) driver instead (related issue). This package or/and RoadRunner has nothing to do with it, but since this is a fairly common issue - it is described here.
Controller constructors
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:
Good:
Middleware constructors
You should never to use middleware constructor for session
, session.store
, auth
or auth Guard
instances resolving and storing in properties (for example). Use method-injection or access them through Request
instance.
Bad:
Good:
Testing
For package testing we use phpunit
framework and docker-ce
+ docker-compose
as develop environment. So, just write into your terminal after repository cloning:
Changes log
If you find any package errors, please, make an issue in a current repository.
License
MIT License (MIT). Please see pushrbx.
All versions of lumen-roadrunner with dependencies
composer-runtime-api Version ^2.0
laravel/lumen-framework Version ^9.0
nyholm/psr7 Version ^1.5
spiral/roadrunner-http Version ^2.0.4
spiral/roadrunner-worker Version ^2.1.5
symfony/psr-http-message-bridge Version ^2.0