feature #57408 [FrameworkBundle] Simpler Kernel setup with MicroKernelTrait (yceruto)

This PR was merged into the 7.2 branch.

Discussion
----------

[FrameworkBundle] Simpler Kernel setup with `MicroKernelTrait`

| Q             | A
| ------------- | ---
| Branch?       | 7.2
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | -
| License       | MIT

Minor improvements to create minimalistic Symfony apps with zero config (initially) + invokable controller using the Kernel class only:
```php
// index.php
<?php

require_once __DIR__.'/vendor/autoload_runtime.php';

// ...

class StripeWebhookEventSubscriber extends Kernel
{
    use MicroKernelTrait;

    #[Route('/', methods: 'GET')]
    public function __invoke(Request $request, NotifierInterface $notifier): Response
    {
        // ...

        return new Response('OK');
    }
}

return static function (array $context) {
    $kernel = new StripeWebhookEventSubscriber($context['APP_ENV'], (bool) $context['APP_DEBUG']);

    return \PHP_SAPI === 'cli' ? new Application($kernel) : $kernel;
};
```
> [!NOTE]
> Ideal for one-file apps or workers.

**What exactly does this PR improve?**
* It makes the `config/` directory optional. Then you can add extension configs by redefining the `configureContainer()` method or by importing external files in `config/packages/*` as usual.
* It adds support for service arguments when an invokable controller is defined within the same kernel class (as shown in the example)
* Fall back to `yield new FrameworkBundle()` in `registerBundles()` method in case the `$this->getBundlesPath()` file does not exist.

What do you think?

Commits
-------

8176573134 Simpler kernel setup with MicroKernelTrait

Author: fabpot

CHANGELOG.md

@@ -6,6 +6,8 @@ CHANGELOG
 
  * Add support for setting `headers` with `Symfony\Bundle\FrameworkBundle\Controller\TemplateController`
  * Derivate `kernel.secret` from the decryption secret when its env var is not defined
+ * Make the `config/` directory optional in `MicroKernelTrait`, add support for service arguments in the
+   invokable Kernel class, and register `FrameworkBundle` by default when the `bundles.php` file is missing
 
 7.1
 ---

Kernel/MicroKernelTrait.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Kernel;
 
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\Configurator\AbstractConfigurator;
@@ -48,7 +49,7 @@ trait MicroKernelTrait
      */
     private function configureContainer(ContainerConfigurator $container, LoaderInterface $loader, ContainerBuilder $builder): void
     {
-        $configDir = $this->getConfigDir();
+        $configDir = preg_replace('{/config$}', '/{config}', $this->getConfigDir());
 
         $container->import($configDir.'/{packages}/*.{php,yaml}');
         $container->import($configDir.'/{packages}/'.$this->environment.'/*.{php,yaml}');
@@ -73,7 +74,7 @@ private function configureContainer(ContainerConfigurator $container, LoaderInte
      */
     private function configureRoutes(RoutingConfigurator $routes): void
     {
-        $configDir = $this->getConfigDir();
+        $configDir = preg_replace('{/config$}', '/{config}', $this->getConfigDir());
 
         $routes->import($configDir.'/{routes}/'.$this->environment.'/*.{php,yaml}');
         $routes->import($configDir.'/{routes}/*.{php,yaml}');
@@ -84,7 +85,7 @@ private function configureRoutes(RoutingConfigurator $routes): void
             $routes->import($configDir.'/{routes}.php');
         }
 
-        if (false !== ($fileName = (new \ReflectionObject($this))->getFileName())) {
+        if ($fileName = (new \ReflectionObject($this))->getFileName()) {
             $routes->import($fileName, 'attribute');
         }
     }
@@ -130,7 +131,13 @@ public function getLogDir(): string
 
     public function registerBundles(): iterable
     {
-        $contents = require $this->getBundlesPath();
+        if (!is_file($bundlesPath = $this->getBundlesPath())) {
+            yield new FrameworkBundle();
+
+            return;
+        }
+
+        $contents = require $bundlesPath;
         foreach ($contents as $class => $envs) {
             if ($envs[$this->environment] ?? $envs['all'] ?? false) {
                 yield new $class();
@@ -216,6 +223,8 @@ public function loadRoutes(LoaderInterface $loader): RouteCollection
                 $route->setDefault('_controller', ['kernel', $controller[1]]);
             } elseif ($controller instanceof \Closure && $this === ($r = new \ReflectionFunction($controller))->getClosureThis() && !$r->isAnonymous()) {
                 $route->setDefault('_controller', ['kernel', $r->name]);
+            } elseif ($this::class === $controller && method_exists($this, '__invoke')) {
+                $route->setDefault('_controller', 'kernel');
             }
         }
 

Tests/Kernel/ConcreteMicroKernel.php

@@ -12,7 +12,6 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\Kernel;
 
 use Psr\Log\NullLogger;
-use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -46,13 +45,6 @@ public function dangerousAction()
         throw new Danger();
     }
 
-    public function registerBundles(): iterable
-    {
-        return [
-            new FrameworkBundle(),
-        ];
-    }
-
     public function getCacheDir(): string
     {
         return $this->cacheDir = sys_get_temp_dir().'/sf_micro_kernel';

Tests/Kernel/MicroKernelTraitTest.php

@@ -13,7 +13,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Log\NullLogger;
-use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
@@ -140,6 +139,17 @@ protected function configureRoutes(RoutingConfigurator $routes): void
 
         $this->assertSame('Hello World!', $response->getContent());
     }
+
+    public function testSimpleKernel()
+    {
+        $kernel = $this->kernel = new SimpleKernel('simple_kernel');
+        $kernel->boot();
+
+        $request = Request::create('/');
+        $response = $kernel->handle($request, HttpKernelInterface::MAIN_REQUEST, false);
+
+        $this->assertSame('Hello World!', $response->getContent());
+    }
 }
 
 abstract class MinimalKernel extends Kernel
@@ -155,11 +165,6 @@ public function __construct(string $cacheDir)
         $this->cacheDir = sys_get_temp_dir().'/'.$cacheDir;
     }
 
-    public function registerBundles(): iterable
-    {
-        yield new FrameworkBundle();
-    }
-
     public function getCacheDir(): string
     {
         return $this->cacheDir;

Tests/Kernel/SimpleKernel.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Kernel;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+final class SimpleKernel extends MinimalKernel
+{
+    #[Route('/')]
+    public function __invoke(UrlGeneratorInterface $urlGenerator): Response
+    {
+        return new Response('Hello World!');
+    }
+}