Fix Symfony 5.2 compatibility because Kernel::preBoot() broke the current implementation

[t-richard]

No description provided.

[t-richard]

Did a really dumb test on this issue and it turns out the cache is not copied due the preBoot function being added in Symfony 5.2.

To test it, I required bref/symfony-bridge, extended the BrefKernel then added this in my own Kernel to add var_dump statements.

    public function handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true)
    {
        var_dump('handle');
        var_dump(scandir('/tmp/cache/prod'));
        var_dump(scandir($_SERVER['LAMBDA_TASK_ROOT'].'/var/cache/prod'));
        return parent::handle($request, $type, $catch);
    }

    public function boot()
    {
        var_dump('boot');
        var_dump(scandir('/tmp/cache/prod'));
        var_dump(scandir($_SERVER['LAMBDA_TASK_ROOT'].'/var/cache/prod'));
        parent::boot();
    }

    protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, string $class, string $baseClass)
    {
        var_dump('dumpContainer');
        parent::dumpContainer($cache, $container, $class, $baseClass);
    }

You can see the dump below but it basically goes like so

• handle
  • empty /tmp/var/cache
  • deployed cache with container abc
• dump container
• boot
  • container xyz in /tmp/var/cache
  • deployed cache with container abc

So Symfony is generating a new cache in /tmp and the deployed pre-warmed cache is never copied.

string(6) "handle"
bool(false)
array(12) {
  [0]=>
  string(1) "."
  [1]=>
  string(2) ".."
  [2]=>
  string(27) "App_KernelProdContainer.php"
  [3]=>
  string(32) "App_KernelProdContainer.php.lock"
  [4]=>
  string(32) "App_KernelProdContainer.php.meta"
  [5]=>
  string(35) "App_KernelProdContainer.preload.php"
  [6]=>
  string(16) "ContainerCGtKGrl"
  [7]=>
  string(15) "annotations.map"
  [8]=>
  string(25) "url_generating_routes.php"
  [9]=>
  string(30) "url_generating_routes.php.meta"
  [10]=>
  string(23) "url_matching_routes.php"
  [11]=>
  string(28) "url_matching_routes.php.meta"
}
string(13) "dumpContainer"
string(4) "boot"
array(8) {
  [0]=>
  string(1) "."
  [1]=>
  string(2) ".."
  [2]=>
  string(27) "App_KernelProdContainer.php"
  [3]=>
  string(32) "App_KernelProdContainer.php.lock"
  [4]=>
  string(32) "App_KernelProdContainer.php.meta"
  [5]=>
  string(35) "App_KernelProdContainer.preload.php"
  [6]=>
  string(16) "ContainerNNgOvfp"
  [7]=>
  string(15) "annotations.map"
}
array(12) {
  [0]=>
  string(1) "."
  [1]=>
  string(2) ".."
  [2]=>
  string(27) "App_KernelProdContainer.php"
  [3]=>
  string(32) "App_KernelProdContainer.php.lock"
  [4]=>
  string(32) "App_KernelProdContainer.php.meta"
  [5]=>
  string(35) "App_KernelProdContainer.preload.php"
  [6]=>
  string(16) "ContainerCGtKGrl"
  [7]=>
  string(15) "annotations.map"
  [8]=>
  string(25) "url_generating_routes.php"
  [9]=>
  string(30) "url_generating_routes.php.meta"
  [10]=>
  string(23) "url_matching_routes.php"
  [11]=>
  string(28) "url_matching_routes.php.meta"
}

[t-richard]

Following investigation on why the tests are NOT failing here.

We are actually testing with the console which also uses the Kernel but the console is not calling preBoot (this function was introduced for some http related feature) so it doesn't fail and work as expected but in a console context.

We should probably change the tests to simulate an HttpRequest instead

[t-richard]

Ok, I fixed the tests to fail on Symfony 5.2 where the behaviour of Kernel::handle() changed. I've also added PHP 8.0 to the version matrix because support was added in #34 but the CI, tests and dev-dependencies weren't updated.

This commit is a point at which the tests are failing but the bug was not resolved and we can see all 5.2 tests on all PHP versions are failing while others are fine.

I'll now work on making it all green again 🚥

[mnapoli]

Thank you for going through all of that!

[t-richard]

@mnapoli you're welcome 🙂

That was easier than I thought once I understood why the tests were not failing on 5.2