README

This bundle provides a PHPStreamServer integration with Symfony framework to run your application in a highly efficient event-loop based runtime.

Getting started

Install composer packages

$ composer require luzrain/phpstreamserver-bundle

Enable the bundle

<?php
// config/bundles.php

return [
    // ...
    Luzrain\PHPStreamServerBundle\PHPStreamServerBundle::class => ['all' => true],
];

Configure the bundle

A minimal configuration might look like this.
For all available options with documentation, see the command output.

$ bin/console config:dump-reference phpstreamserver

# config/packages/phpstreamserver.yaml

phpstreamserver:
  servers:
    - name: 'Webserver'
      listen: http://0.0.0.0:80
      processes: 4

Start application

$ APP_RUNTIME=Luzrain\\PHPStreamServerBundle\\Runtime php public/index.php start

* For better performance, install the php-uv extension.

Reload strategies

Because of the asynchronous nature of the server, the workers reuse loaded resources on each request. This means that in some cases we need to restart workers. For example, after an exception is thrown, to prevent services from being in an unrecoverable state. Or every time you change the code in the IDE in dev environment.
The bundle provides several restart strategies that can be configured depending on what you need.

on_exception
Reload worker each time that an exception is thrown during the worker lifetime.
on_each_request
Reload worker after each http request. This strategy is for debug purposes.
on_ttl_limit
Reload worker after TTL lifiteme will be reached. Can be used to prevent memory leaks.
on_requests_limit
Reload worker on every N request.
on_memory_limit
Reload worker after memory usage exceeds threshold value.
on_file_change
Reload all workers each time that monitored files are changed. **

** It is highly recommended to install the php-inotify extension for file monitoring. Without it, monitoring will work in polling mode, which can be very cpu and disk intensive for large projects.

See all available options for each strategy in the command output.

$ bin/console config:dump-reference phpstreamserver reload_strategy

# config/packages/phpstreamserver.yaml

phpstreamserver:
  reload_strategy:
    on_exception:
      active: true

    on_file_change:
      active: true

Scheduler

Periodic tasks can schedule the execution of external programs as well as internal Symfony application commands.
To run a Symfony command, simply type the command name without any prefixes.
Schedule string can be formatted in several ways:

An integer to define the frequency as a number of seconds. Example: 60
An ISO8601 datetime format. Example: 2024-02-14T018:00:00+08:00
An ISO8601 duration format. Example: PT1M
A relative date format as supported by DateInterval. Example: 1 minutes
A cron expression**. Example: */1 * * * *

** Note that you need to install the dragonmantank/cron-expression package if you want to use cron expressions as schedule strings

# config/packages/phpstreamserver.yaml

phpstreamserver:
  tasks:
    # Runs external program every 15 seconds
    - name: 'Task 1'
      schedule: '15 second'
      command: '/bin/external-program'

    # Runs symfony command as a task every minute
    - name: 'Task 2'
      schedule: '*/1 * * * *'
      command: 'app:my-task-command'

Supervisor

Supervisor can keep processes alive and wake up when one of them dies.
It can also work with both external commands and internal Symfony commands.
To run a Symfony command, simply type the command name without any prefixes.

# config/packages/phpstreamserver.yaml

phpstreamserver:
  processes:
    # Runs external program
    - name: 'External process'
      command: '/bin/external-program'
      count: 1

    # Runs symfony command
    - name: 'Symfony command process'
      command: 'messenger:consume queue --time-limit=600'
      count: 4

luzrain / phpstreamserver-bundle

Maintainers

Details