Initialize StaticSiteGeneration (SSG) feature

Author: Kocal

notes

@@ -0,0 +1,36 @@
+// [HttpKernel]
+// StaticSiteGeneration\ParamsProviderInterface (__invoke: iterable<list<mixed>>)
+// StaticSiteGeneration\StaticSiteGeneratorInterface (generate(): void)
+// - checks that: 200, GET, require stateless, no query param, no fragments
+// - generate in "public/static" dir (see in composer config - example AssetsInstallCommand)
+// DependencyInjection\StaticSiteGenerationPass (service locator for params providers)
+//
+// [Routing]
+// update RouteConfigurator to add "staticGeneration" method (params?: list<list<mixed>>|string}) - string for service id - default to true in Route
+// update Attribute\Route to add "staticGeneration" property (array{params: list<list<mixed>>|string}|true) - string for service id - default false in Route
+// make it work in YAML and XML in the same way
+// - GET method, stateless, staticGeneration depending on a new defined "params" property
+// eg: #[Route(name: 'app_blog_article', path: '/blog/{id}', methods: ['GET'], staticGeneration: true)]
+//
+// [FrameworkBundle]
+// Command\GenerateStaticSiteCommand - static-site:generate (--dry-run and fail) (should retrieve all generators)
+//
+// [Recipe]
+// update .gitignore to add "/public/static/"
+// update server configurations
+//
+// [Documentation]
+// server configurations example to rewrite
+//
+// [Other PR]
+// debug:router command - add option to see SSG details
+// StaticSiteGenerationDataCollector - add SSG section only on SSG routes, showing information, and telling if it will be ready for generation
+// Add custom formats
+
+
+
+
+StaticPagesGenerator
+-> StaticPagesProviderInterface =>
+-> -> RouteStaticPagesProvider => parcourt toutes les routes "staticGeneration"
+_> -> -> ParamsProviderInterface => /blog/* -> [ [slug => puasddsa], [ slug => qweqw] ]

src/Symfony/Bundle/FrameworkBundle/Command/StaticSiteGenerationGenerateCommand.php

@@ -0,0 +1,77 @@
+<?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\Command;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\HttpKernel\StaticSiteGeneration\StaticPagesGenerator;
+use Symfony\Component\HttpKernel\StaticSiteGeneration\StaticPageDumperInterface;
+use Symfony\Component\HttpKernel\Exception\RuntimeException;
+use Symfony\Component\Routing\StaticSiteGeneration\StaticUrisProviderInterface;
+
+/**
+ * @author Thomas Bibaut
+ */
+#[AsCommand(name: 'static-site-generation:generate', description: 'Generates the static site')]
+ // * @todo  better description
+final class StaticSiteGenerationGenerateCommand extends Command
+{
+    // @todo dry-run
+    // @todo fitlerPattern
+
+    public function __construct(
+        private readonly StaticPagesGenerator $staticPagesGenerator,
+        private readonly StaticPageDumperInterface $staticPageDumper,
+        private readonly StaticUrisProviderInterface $staticUrisProvider,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setDescription('Generates static pages')
+            ->addOption(
+                'filterPattern',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'A pattern to filter the pages to generate',
+            );
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $filterPattern = $input->getOption('filterPattern');
+
+        foreach ($this->staticUrisProvider->provide() as $uri) {
+            if (null !== $filterPattern && !preg_match($filterPattern, $uri)) {
+                continue;
+            }
+
+            try {
+                ['content' => $content, 'format' => $format] = $this->staticPagesGenerator->generate($filterPattern);
+            } catch (RuntimeException $e) {
+                // io error
+            }
+
+            $this->staticPageDumper->dump($uri, $content, $format);
+
+            // $output-> $uri
+        }
+
+        return Command::SUCCESS;
+    }
+}

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -14,6 +14,7 @@
 use Composer\InstalledVersions;
 use Http\Client\HttpAsyncClient;
 use Http\Client\HttpClient;
+use Symfony\Component\Routing\StaticSiteGeneration\ParamsProviderInterface;
 use phpDocumentor\Reflection\DocBlockFactoryInterface;
 use phpDocumentor\Reflection\Types\ContextFactory;
 use PhpParser\Parser;
@@ -1247,6 +1248,9 @@ private function registerRouterConfiguration(array $config, ContainerBuilder $co
             $container->getDefinition('router.request_context')
                 ->replaceArgument(0, $config['default_uri']);
         }
+
+        $container->registerForAutoconfiguration(ParamsProviderInterface::class)
+            ->addTag('routing.static_site.params_provider');
     }
 
     private function registerSessionConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void

src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php

@@ -39,6 +39,7 @@
 use Symfony\Bundle\FrameworkBundle\Command\TranslationExtractCommand;
 use Symfony\Bundle\FrameworkBundle\Command\WorkflowDumpCommand;
 use Symfony\Bundle\FrameworkBundle\Command\YamlLintCommand;
+use Symfony\Bundle\FrameworkBundle\Command\StaticSiteGenerationGenerateCommand;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\FrameworkBundle\EventListener\SuggestMissingPackageSubscriber;
 use Symfony\Component\Console\EventListener\ErrorListener;
@@ -397,5 +398,13 @@
                 service('console.messenger.application'),
             ])
             ->tag('messenger.message_handler')
+
+
+        ->set('console.command.static_site_generation_generate', StaticSiteGenerationGenerateCommand::class)
+            ->args([
+                service('static_site.pages_generator'),
+                service('static_site.page_dumper'),
+            ])
+            ->tag('console.command')
     ;
 };

src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.php

@@ -39,6 +39,7 @@
 use Symfony\Component\Routing\RequestContext;
 use Symfony\Component\Routing\RequestContextAwareInterface;
 use Symfony\Component\Routing\RouterInterface;
+use Symfony\Component\Routing\StaticSiteGeneration\StaticUrisProvider;
 
 return static function (ContainerConfigurator $container) {
     $container->parameters()
@@ -208,5 +209,11 @@
                 service('twig')->ignoreOnInvalid(),
             ])
             ->public()
+
+        ->set('routing.static_site.uri_provider', StaticUrisProvider::class)
+            ->args([
+                service('router'),
+                tagged_locator('routing.static_site.params_provider'),
+            ])
     ;
 };

src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php

@@ -34,6 +34,9 @@
 use Symfony\Component\HttpKernel\EventListener\LocaleListener;
 use Symfony\Component\HttpKernel\EventListener\ResponseListener;
 use Symfony\Component\HttpKernel\EventListener\ValidateRequestListener;
+use Symfony\Component\HttpKernel\StaticSiteGeneration\FilesystemStaticPageDumper;
+use Symfony\Component\HttpKernel\StaticSiteGeneration\StaticPageDumperInterface;
+use Symfony\Component\HttpKernel\StaticSiteGeneration\StaticPagesGenerator;
 
 return static function (ContainerConfigurator $container) {
     $container->services()
@@ -145,5 +148,16 @@
         ->set('controller.cache_attribute_listener', CacheAttributeListener::class)
             ->tag('kernel.event_subscriber')
 
+        ->set('static_site.pages_generator', StaticPagesGenerator::class)
+            ->args([
+                service('http_kernel'),
+                service('routing.static_site.uri_provider'),
+            ])
+
+        ->set('static_site.page_dumper', FilesystemStaticPageDumper::class)
+            ->args([
+                param('kernel.project_dir'),
+            ])
+        ->alias(StaticPageDumperInterface::class, 'static_static.page_dumper')
     ;
 };

src/Symfony/Component/HttpKernel/Exception/RuntimeException.php

@@ -0,0 +1,19 @@
+<?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\Component\HttpKernel\Exception;
+
+/**
+ * @author Thomas Bibaut
+ */
+class RuntimeException extends \RuntimeException implements ExceptionInterface
+{
+}

src/Symfony/Component/HttpKernel/StaticSiteGeneration/FilesystemStaticPageDumper.php

@@ -0,0 +1,53 @@
+<?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\Component\HttpKernel\StaticSiteGeneration;
+
+// @todo dependency compsoer.json symfony/filesystem
+use Symfony\Component\Filesystem\Filesystem;
+
+final readonly class FilesystemStaticPageDumper implements StaticPageDumperInterface
+{
+    private Filesystem $filesystem;
+
+    public function __construct(
+        private string $projectDir,
+    ) {
+        $this->filesystem = new Filesystem();
+    }
+
+    public function dump(string $uri, string $content, ?string $format): void
+    {
+        if ($format && !str_ends_with($uri, '.' . $format)) {
+            $uri = sprintf('%s.%s', $uri, $format);
+        }
+
+        // @todo no .. in $uri
+        // @todo config
+        $staticPagesDirectory = sprintf('%s/static-pages', $this->getPublicDirectory());
+
+        $this->filesystem->dumpFile(sprintf('%s/%s', $staticPagesDirectory, $uri), $content);
+    }
+
+    private function getPublicDirectory(): string
+    {
+        $defaultPublicDir = 'public';
+        $composerFilePath = sprintf('%s/composer.json', $this->projectDir);
+
+        if (!file_exists($composerFilePath)) {
+            return $defaultPublicDir;
+        }
+
+        $composerConfig = json_decode($this->filesystem->readFile($composerFilePath), true, flags: \JSON_THROW_ON_ERROR);
+
+        return $composerConfig['extra']['public-dir'] ?? $defaultPublicDir;
+    }
+}

src/Symfony/Component/HttpKernel/StaticSiteGeneration/StaticPageDumperInterface.php

@@ -0,0 +1,17 @@
+<?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\Component\HttpKernel\StaticSiteGeneration;
+
+interface StaticPageDumperInterface
+{
+    public function dump(string $uri, string $content): void;
+}

src/Symfony/Component/HttpKernel/StaticSiteGeneration/StaticPagesGenerator.php

@@ -0,0 +1,59 @@
+<?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\Component\HttpKernel\StaticSiteGeneration;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\TerminableInterface;
+use Symfony\Component\HttpKernel\Exception\RuntimeException;
+
+/**
+ * @author Thomas Bibaut
+ */
+final readonly class StaticPagesGenerator
+{
+    public function __construct(
+        private HttpKernelInterface $kernel,
+    ) {
+    }
+
+    /**
+     * @todo write doc everywhere
+     *
+     * @return array{content: string, format: ?string}
+     *
+     * @throws RuntimeException
+     */
+    public function generate(string $uri): array
+    {
+        $request = Request::create($uri);
+        try {
+            $response = $this->kernel->handle($request, HttpKernelInterface::MAIN_REQUEST);
+
+            if ($this->kernel instanceof TerminableInterface) {
+                $this->kernel->terminate($request, $response);
+            }
+        } catch (\Exception $e) {
+            throw new RuntimeException(sprintf('Cannot generate page for URI "%s".', $uri), $e->getCode(), $e);
+        }
+
+        if (Response::HTTP_OK !== $response->getStatusCode()) {
+            throw new RuntimeException(sprintf('Expected URI "%s" to return status code 200, got %d.', $uri, $response->getStatusCode()));
+        }
+
+        return [
+            'content' => $response->getContent(),
+            'format' => $request->getFormat($response->headers->get('Content-Type'))
+        ];
+    }
+}

src/Symfony/Component/HttpKernel/Tests/StaticSiteGeneration/FilesystemStaticPageDumperTest.php

@@ -0,0 +1,21 @@
+<?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\Component\HttpKernel\Tests\StaticSiteGeneration;
+
+use PHPUnit\Framework\TestCase;
+
+/*
+ * test example @see src/Symfony/Component/JsonEncoder/Tests/JsonEncoderTest.php
+ */
+class FilesystemStaticPageDumperTest extends TestCase
+{
+}