search

laravel / octane

Supercharge your Laravel application's performance.
https://laravel.com/docs/octane
MIT License
3.77k stars 296 forks source link

Automatically disable worker mode in local environments if workers aren't specified explicitly #932

Open Radiergummi opened 3 months ago

Radiergummi commented 3 months ago

This PR updates the FrankenPHP configuration to disable worker mode if the application is running in the local environment and the worker count is not specified explicitly (or set to auto).

The problem

FrankenPHP's Worker mode keeps the application in memory, which does wonders for performance when running in production. Locally, however, it causes problems with XDebug, and does not reflect file changes immediately. The solution to the latter is configuring Octane to restart the worker after every request, thereby defeating most of the advantages of an application server in the first place.

The solution

By only enabling worker mode if the application is running in a non-local environment, it will be served in a CGI-like manner, i.e. what the built-in PHP server (used in artisan serve) does—and exactly what you'd expect to happen: XDebug just works, and changes to files are reflected immediately.
In production, worker mode will be enabled and all the benefits that come with it apply. We use the setup as provided in this PR in our production application and don't face any issues with it.

This solves https://github.com/dunglas/frankenphp/issues/931, and probably solves #928 too.

dunglas commented 3 months ago

Could we detect if XDebug is installed and only disable the worker mode if it is?

It isn't by default and the worker mode improves performance even in dev mode.

Radiergummi commented 3 months ago

Could we detect if XDebug is installed and only disable the worker mode if it is?

We could do ini_get('xdebug.mode') !== 'off', or possibly check APP_DEBUG in addition to the existing conditions?

It isn't by default and the worker mode improves performance even in dev mode.

Still, that would require either using watch mode (which in turn demands node and chokidar, which makes setup more complex in e.g. Docker) or limiting the server to MAX_REQUESTS=1, which isn't too good for performance either.

But @dunglas I respect if you want to approach this differently, and will close the PR—this is your domain.

dunglas commented 2 months ago

@Radiergummi a problem with this approach is that Xdebug can be disabled (or enabled) for the CLI SAPI (which, generally, isn't using FrankenPHP), but enabled (or disabled) for the FrankenPHP SAPI. It's rare when using Docker, but more common when not using it.

Maybe would we store a tiny script detecting if Xdebug is enabled and run frankenphp php-cli the-detection-script.php to be more reliable?

driesvints commented 2 months ago

We'll need to fix the tests before continuing.

Radiergummi commented 1 month ago

@dunglas sorry for only getting back to this now, things were a bit tense on my end lately.

I just added a script as per your recommendation: Now, worker mode will be disabled if

  1. the amount of workers isn't set explicitly,
  2. we're running locally, and
  3. XDebug is not installed, or its mode is set to "off".

That should work as discussed earlier, no?