with "simplified" app.php Schedule initiates on any command

[yurii-stickee-2023]

Laravel Version

11.47.0 / 12.42.0

PHP Version

8.3

Database Driver & Version

No response

Description

With this new "simplified" bootstrap/app.php approach \Illuminate\Console\Scheduling\Schedule object is now initiated on EVERY command, not only on commands that actually use it, like schedule:run.

Steps To Reproduce

Specifically it triggers this \Illuminate\Foundation\Providers\FoundationServiceProvider::registerConsoleSchedule all the time.

I made events as suggested by docs by adding scheduled items to routes/console.php.

Tried to use bootstrap/app.php

    ->withSchedule(function ($schedule) {
    })

but it has the same effect.

Is there a way with this "simplified" architecture to add scheduled events here \Illuminate\Foundation\Console\Kernel::schedule() so they are initiated ONLY by commands that use schedule?

Is this a bug or a feature now?

regards

[macropay-solutions]

V12

//\Illuminate\Foundation\Console\Kernel::__construct
    public function __construct(Application $app, Dispatcher $events)
    {
        if (! defined('ARTISAN_BINARY')) {
            define('ARTISAN_BINARY', 'artisan');
        }

        $this->app = $app;
        $this->events = $events;

        $this->app->booted(function () {
            if (! $this->app->runningUnitTests()) {
                $this->rerouteSymfonyCommandEvents();
            }
        });
    }
//\Illuminate\Foundation\Providers\FoundationServiceProvider::registerConsoleSchedule
    public function registerConsoleSchedule()
    {
        $this->app->singleton(Schedule::class, function ($app) {
            return $app->make(ConsoleKernel::class)->resolveConsoleSchedule();
        });
    }
//\Illuminate\Foundation\Console\Kernel::resolveConsoleSchedule
    public function resolveConsoleSchedule()
    {
        return tap(new Schedule($this->scheduleTimezone()), function ($schedule) {
            $this->schedule($schedule->useCache($this->scheduleCache()));
        });
    }

vs

V10

// \Illuminate\Foundation\Console\Kernel::__construct
    public function __construct(Application $app, Dispatcher $events)
    {
        if (!defined('ARTISAN_BINARY')) {
            define('ARTISAN_BINARY', 'artisan');
        }

        $this->app = $app;
        $this->events = $events;

        $this->app->booted(function () {
            if (!$this->app->runningUnitTests()) {
                $this->rerouteSymfonyCommandEvents();
            }

            $this->defineConsoleSchedule(); // this was removed
        });
    }
// \Illuminate\Foundation\Console\Kernel::defineConsoleSchedule
    protected function defineConsoleSchedule()
    {
        $this->app->singleton(Schedule::class, function ($app) {
//            return tap(new Schedule($this->scheduleTimezone()), function ($schedule) {
            return tap(\di(Schedule::class, [$this->scheduleTimezone()]), function ($schedule) {
                $this->schedule($schedule->useCache($this->scheduleCache()));
            });
        });
    }

\Illuminate\Foundation\Providers\FoundationServiceProvider::register:

// v12
    public function register()
    {
        parent::register();

        $this->registerConsoleSchedule(); // new
        $this->registerDumper();
        $this->registerRequestValidation();
        $this->registerRequestSignatureValidation();
        $this->registerUriUrlGeneration(); // new
        $this->registerDeferHandler(); // new
        $this->registerExceptionTracking();
        $this->registerExceptionRenderer(); // new
        $this->registerMaintenanceModeManager();
    }

// v10
    public function register()
    {
        parent::register();

        $this->registerDumper();
        $this->registerRequestValidation();
        $this->registerRequestSignatureValidation();
        $this->registerExceptionTracking();
        $this->registerMaintenanceModeManager();
    }

[yurii-stickee-2023]

I did some code tweaking and I am 99% sure this is an issue.
For projects with 100+ schedule events this adds a lot of extra workload, especially if input parameters in a command are dynamic.

As a note, also testing of scheduled events are NOT possible because test date in Carbon will not have any effect as commands were already populated.

---

The problem exists in \Illuminate\Foundation\Configuration\ApplicationBuilder::withKernels() as it cannot be overriden.

Attempt to make a race condition by registering custom kernel class during configuration with ->withSingletons() allows me to boot custom kernel but it breaks in tests as they initiate kernel directly (similar to ->withKernels().

The only viable solution for me for now is to override \Illuminate\Foundation\Configuration\ApplicationBuilder and \Illuminate\Foundation\Application as it does not allow builder override too.

Also \Illuminate\Foundation\Console\Kernel::shouldDiscoverCommands is bugged, unless it was intentional to limit command discovery to the base class only. Without custom workaround it will not properly load commands.

NOTE! This solution adds limitation to routes/schedule.php as we can register events only with $schedule object, using Schedule facade will cause infinite loop!

Here is a full list of custom changes i had to do to fix this issue

// app/Console/Kernel.php
<?php

declare(strict_types=1);

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;

class Kernel extends \Illuminate\Foundation\Console\Kernel
{
    protected function schedule(Schedule $schedule)
    {
        include base_path('routes/schedule.php');
    }

    protected function shouldDiscoverCommands(): true
    {
        // WORKAROUND: Laravel is bugged, this must be TRUE to discover commands from 'routes/console.php'
        return true;
    }
}

<?php
// app/Application.php
declare(strict_types=1);

namespace App;

class Application extends \Illuminate\Foundation\Application
{
    public static function configure(?string $basePath = null)
    {
        $basePath = match (true) {
            is_string($basePath) => $basePath,
            default => static::inferBasePath(),
        };

        return (new ApplicationBuilder(new static($basePath)))
            ->withKernels()
            ->withEvents()
            ->withCommands()
            ->withProviders();
    }
}

<?php
// app/ApplicationBuilder.php
declare(strict_types=1);

namespace App;

class ApplicationBuilder extends \Illuminate\Foundation\Configuration\ApplicationBuilder
{
    public function withSchedule(callable $callback)
    {
        throw new \RuntimeException('This is bugged method, it triggers schedule on every command. Use `schedule(..)` in custom console kernel instead.');
    }

    public function withKernels()
    {
        $this->app->singleton(
            \Illuminate\Contracts\Http\Kernel::class,
            \Illuminate\Foundation\Http\Kernel::class,
        );

        // WORKAROUND: We must register custom kernel to fix issue with Schedule in Laravel 11.x
        $this->app->singleton(
            \Illuminate\Contracts\Console\Kernel::class,
            \App\Console\Kernel::class,
        );

        return $this;
    }
}

I still did not push it to production, but so far it looks like it fixes the problem for me.

edit: runs fine on production, hopefully this will be useful to somebody

[yurii-stickee-2023]

p.s. the easiest way to understand what i am talking about is to set breakpoint in routes/schedule.php and run some unrelated command like ./artisan --version.

You will see that with current implementation it will trigger scheduler, with my code it will not.

[macropay-solutions]

Easiest way would be to not use V 11 or 12.

[yurii-stickee-2023]

Easiest way would be to not use V 11 or 12.

E-em.. not sure if you are serious or just trolling me. 10.x is dead like over 1 year now, see here https://laravel.com/docs/12.x/releases#support-policy

11.x is kind of closed for bug fixes. but it has the same code/problem as 12.x which is currently actively supported until August 13th, 2026

regards

[macropay-solutions]

Dead serious. Not trolling.