On Demand not working with Laravel Octane

[finalgamer]

When running with a configured on demand key no requests are captured.

My investigation shows that this is caused because the service provider is only booted on startup of Octane and the event listeners and middleware are not registered.

clockwork/Clockwork/Support/Laravel/ClockworkServiceProvider.php

Lines 27 to 30 in bd13e76

	if ($this->app['clockwork.support']->isCollectingData()) {
	$this->registerEventListeners();
	$this->registerMiddleware();
	}

Line 27 will evaluate to false.

Analysis

When the Octane server boots up and registers the service providers and a new empty request is created in the support class.

clockwork/Clockwork/Support/Laravel/ClockworkSupport.php

Lines 661 to 672 in bd13e76

	// Make an incoming request instance
	protected function incomingRequest()
	{
	if ($this->incomingRequest) return $this->incomingRequest;
	return $this->incomingRequest = new IncomingRequest([
	'method' => $this->app['request']->getMethod(),
	'uri' => $this->app['request']->getRequestUri(),
	'input' => $this->app['request']->input(),
	'cookies' => $this->app['request']->cookie()
	]);
	}

This empty request does not contain the on demand key and thus will fail the shouldCollect() call on Line 54

clockwork/Clockwork/Support/Laravel/ClockworkSupport.php

Lines 549 to 555 in bd13e76

	// Check whether we are collecting http requests
	public function isCollectingRequests()
	{
	return ($this->isEnabled() || $this->getConfig('collect_data_always', false))
	&& ! $this->app->runningInConsole()
	&& $this->app['clockwork']->shouldCollect()->filter($this->incomingRequest());
	}

The end result is that the middleware and event listeners are not registered.

[flexchar]

@finalgamer have you tried adding Clockwork class to the flush list in config/octane.php file?

[itsgoingd]

Hey, thanks for the detailed report, this indeed seems to be a bug, I will have to take a closer look.

Though be aware that the Octane support currently has a known limitation, where the Clockwork profiling is always active, even for filtered requests. If you are planning to use the on-demand mode to avoid the performance overhead from running Clockwork for all requests, this unfortunately won't work atm.

[finalgamer]

@finalgamer have you tried adding Clockwork class to the flush list in config/octane.php file?

@flexchar What class are you talking about?

[matthiasmetzen]

Flushing the resolved instances did not work for me unfortuantely, but for now I got it working by focefully reloading the ClockworkServiceProvider on every request using a Listener:

<?php

namespace App\Listeners;

use Clockwork\Support\Laravel\ClockworkServiceProvider;
use Laravel\Octane\Events\RequestReceived;

class ReloadClockworkProvider
{
    /**
     * Handle the event.
     *
     * @param  \Laravel\Octane\Events\RequestReceived  $event
     * @return void
     */
    public function handle(RequestReceived $event): void
    {
        $event->sandbox->register(ClockworkServiceProvider::class, true);
    }
}

and then register it inside config/octane.php

'listeners' => [
        ...
        RequestReceived::class => [
            ...
            ReloadClockworkProvider::class,
        ],

[flexchar]

@finalgamer I was talking about the main Clockwork class. Adding me helped to fix getting false warnings for duplicate queries.

// config/octane.php
    'flush' => [
        //
        \Clockwork\Clockwork::class,
    ],

[itsgoingd]

@flexchar That sounds like something we should actually fix in Clockwork itself. :)