bug #911 More precisely initializing services/config for asset mapper (weaverryan)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

More precisely initializing services/config for asset mapper

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| Tickets       | Fix #907
| License       | MIT

Hi!

A few fixes for the new 2.9 version, which included a lot of under-the-hood changes to support asset mapper. These shouldn't be noticed by users and hopefully this will smooth out the final bumps:

A) Avoid prepending the `asset_mapper` config unless FWBundle 6.3 is present. I don't love the solution - but it should work well enough, especially as this applies to asset mapper users and that is still experimental.

B) Avoid registering a few asset mapper services that, on older versions of PHP/Symfony, may cause a container explosion due to a trait that won't be present.

C) Plug some holes in the CI to test lower deps. The CI really needs to become much more dynamic than it is now, but this makes sure that all packages are tested for highest/lowest deps.

Cheers!

Commits
-------

34e7ec1 More precisely initializing services/config for asset mapper

Author: weaverryan

.github/workflows/test.yaml

@@ -67,7 +67,7 @@ jobs:
                 echo "${{ steps.changes.outputs.STATUS }}"
                 exit 1
 
-    tests-php-low-deps:
+    tests-php72-low-deps:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@master
@@ -102,7 +102,7 @@ jobs:
               run: php vendor/bin/simple-phpunit
               working-directory: src/LazyImage
 
-    tests-php8-low-deps:
+    tests-php80-low-deps:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@master
@@ -147,7 +147,7 @@ jobs:
             - name: Translator Tests
               run: php vendor/bin/simple-phpunit
               working-directory: src/Translator
-    tests-php-high-deps:
+    tests-php80-high-deps:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@master
@@ -279,6 +279,69 @@ jobs:
               run: php vendor/bin/simple-phpunit
               working-directory: src/Vue
 
+    tests-php81-low-deps:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@master
+
+            - uses: shivammathur/setup-php@v2
+              with:
+                  php-version: '8.1'
+
+            - name: Chartjs Dependencies
+              uses: ramsey/composer-install@v2
+              with:
+                  working-directory: src/Chartjs
+                  dependency-versions: lowest
+            - name: Chartjs Tests
+              working-directory: src/Chartjs
+              run: php vendor/bin/simple-phpunit
+
+            - name: Notify Dependencies
+              uses: ramsey/composer-install@v2
+              with:
+                  working-directory: src/Notify
+                  dependency-versions: lowest
+            - name: Notify Tests
+              working-directory: src/Notify
+              run: php vendor/bin/simple-phpunit
+
+            - name: React Dependencies
+              uses: ramsey/composer-install@v2
+              with:
+                  working-directory: src/React
+                  dependency-versions: lowest
+            - name: React Tests
+              run: php vendor/bin/simple-phpunit
+              working-directory: src/React
+
+            - name: StimulusBundle Dependencies
+              uses: ramsey/composer-install@v2
+              with:
+                working-directory: src/StimulusBundle
+                dependency-versions: lowest
+            - name: StimulusBundle Tests
+              working-directory: src/StimulusBundle
+              run: php vendor/bin/simple-phpunit
+
+            - name: Svelte Dependencies
+              uses: ramsey/composer-install@v2
+              with:
+                  working-directory: src/Svelte
+                  dependency-versions: lowest
+            - name: Svelte Tests
+              run: php vendor/bin/simple-phpunit
+              working-directory: src/Svelte
+
+            - name: Vue Dependencies
+              uses: ramsey/composer-install@v2
+              with:
+                  working-directory: src/Vue
+                  dependency-versions: lowest
+            - name: Vue Tests
+              run: php vendor/bin/simple-phpunit
+              working-directory: src/Vue
+
     tests-js:
         runs-on: ubuntu-latest
         steps:

src/Autocomplete/src/DependencyInjection/AutocompleteExtension.php

@@ -48,7 +48,7 @@ public function prepend(ContainerBuilder $container)
             ]);
         }
 
-        if (interface_exists(AssetMapperInterface::class)) {
+        if ($this->isAssetMapperAvailable($container)) {
             $container->prependExtensionConfig('framework', [
                 'asset_mapper' => [
                     'paths' => [
@@ -155,4 +155,19 @@ private function registerFormServices(ContainerBuilder $container): void
                 new Reference('ux.autocomplete.entity_search_util'),
             ]);
     }
+
+    private function isAssetMapperAvailable(ContainerBuilder $container): bool
+    {
+        if (!interface_exists(AssetMapperInterface::class)) {
+            return false;
+        }
+
+        // check that FrameworkBundle 6.3 or higher is installed
+        $bundlesMetadata = $container->getParameter('kernel.bundles_metadata');
+        if (!isset($bundlesMetadata['FrameworkBundle'])) {
+            return false;
+        }
+
+        return is_file($bundlesMetadata['FrameworkBundle']['path'].'/Resources/config/asset_mapper.php');
+    }
 }

src/Chartjs/composer.json

@@ -32,7 +32,7 @@
         "symfony/config": "^5.4|^6.0",
         "symfony/dependency-injection": "^5.4|^6.0",
         "symfony/http-kernel": "^5.4|^6.0",
-        "symfony/stimulus-bundle": "^2.9"
+        "symfony/stimulus-bundle": "^2.9.1"
     },
     "require-dev": {
         "symfony/framework-bundle": "^5.4|^6.0",

src/Chartjs/src/DependencyInjection/ChartjsExtension.php

@@ -50,7 +50,7 @@ public function load(array $configs, ContainerBuilder $container)
 
     public function prepend(ContainerBuilder $container)
     {
-        if (!interface_exists(AssetMapperInterface::class)) {
+        if (!$this->isAssetMapperAvailable($container)) {
             return;
         }
 
@@ -62,4 +62,19 @@ public function prepend(ContainerBuilder $container)
             ],
         ]);
     }
+
+    private function isAssetMapperAvailable(ContainerBuilder $container): bool
+    {
+        if (!interface_exists(AssetMapperInterface::class)) {
+            return false;
+        }
+
+        // check that FrameworkBundle 6.3 or higher is installed
+        $bundlesMetadata = $container->getParameter('kernel.bundles_metadata');
+        if (!isset($bundlesMetadata['FrameworkBundle'])) {
+            return false;
+        }
+
+        return is_file($bundlesMetadata['FrameworkBundle']['path'].'/Resources/config/asset_mapper.php');
+    }
 }

src/Cropperjs/src/DependencyInjection/CropperjsExtension.php

@@ -53,7 +53,7 @@ public function load(array $configs, ContainerBuilder $container)
 
     public function prepend(ContainerBuilder $container)
     {
-        if (!interface_exists(AssetMapperInterface::class)) {
+        if (!$this->isAssetMapperAvailable($container)) {
             return;
         }
 
@@ -65,4 +65,19 @@ public function prepend(ContainerBuilder $container)
             ],
         ]);
     }
+
+    private function isAssetMapperAvailable(ContainerBuilder $container): bool
+    {
+        if (!interface_exists(AssetMapperInterface::class)) {
+            return false;
+        }
+
+        // check that FrameworkBundle 6.3 or higher is installed
+        $bundlesMetadata = $container->getParameter('kernel.bundles_metadata');
+        if (!isset($bundlesMetadata['FrameworkBundle'])) {
+            return false;
+        }
+
+        return is_file($bundlesMetadata['FrameworkBundle']['path'].'/Resources/config/asset_mapper.php');
+    }
 }

src/Dropzone/src/DependencyInjection/DropzoneExtension.php

@@ -34,7 +34,7 @@ public function prepend(ContainerBuilder $container)
             $container->prependExtensionConfig('twig', ['form_themes' => ['@Dropzone/form_theme.html.twig']]);
         }
 
-        if (interface_exists(AssetMapperInterface::class)) {
+        if ($this->isAssetMapperAvailable($container)) {
             $container->prependExtensionConfig('framework', [
                 'asset_mapper' => [
                     'paths' => [
@@ -53,4 +53,19 @@ public function load(array $configs, ContainerBuilder $container)
             ->setPublic(false)
         ;
     }
+
+    private function isAssetMapperAvailable(ContainerBuilder $container): bool
+    {
+        if (!interface_exists(AssetMapperInterface::class)) {
+            return false;
+        }
+
+        // check that FrameworkBundle 6.3 or higher is installed
+        $bundlesMetadata = $container->getParameter('kernel.bundles_metadata');
+        if (!isset($bundlesMetadata['FrameworkBundle'])) {
+            return false;
+        }
+
+        return is_file($bundlesMetadata['FrameworkBundle']['path'].'/Resources/config/asset_mapper.php');
+    }
 }

src/LazyImage/src/DependencyInjection/LazyImageExtension.php

@@ -57,7 +57,7 @@ public function load(array $configs, ContainerBuilder $container)
 
     public function prepend(ContainerBuilder $container)
     {
-        if (!interface_exists(AssetMapperInterface::class)) {
+        if (!$this->isAssetMapperAvailable($container)) {
             return;
         }
 
@@ -69,4 +69,19 @@ public function prepend(ContainerBuilder $container)
             ],
         ]);
     }
+
+    private function isAssetMapperAvailable(ContainerBuilder $container): bool
+    {
+        if (!interface_exists(AssetMapperInterface::class)) {
+            return false;
+        }
+
+        // check that FrameworkBundle 6.3 or higher is installed
+        $bundlesMetadata = $container->getParameter('kernel.bundles_metadata');
+        if (!isset($bundlesMetadata['FrameworkBundle'])) {
+            return false;
+        }
+
+        return is_file($bundlesMetadata['FrameworkBundle']['path'].'/Resources/config/asset_mapper.php');
+    }
 }

src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php

@@ -64,7 +64,7 @@ public function prepend(ContainerBuilder $container)
             $container->prependExtensionConfig('twig', ['form_themes' => ['@LiveComponent/form_theme.html.twig']]);
         }
 
-        if (interface_exists(AssetMapperInterface::class)) {
+        if ($this->isAssetMapperAvailable($container)) {
             $container->prependExtensionConfig('framework', [
                 'asset_mapper' => [
                     'paths' => [
@@ -213,4 +213,19 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
             ->setPublic(false)
         ;
     }
+
+    private function isAssetMapperAvailable(ContainerBuilder $container): bool
+    {
+        if (!interface_exists(AssetMapperInterface::class)) {
+            return false;
+        }
+
+        // check that FrameworkBundle 6.3 or higher is installed
+        $bundlesMetadata = $container->getParameter('kernel.bundles_metadata');
+        if (!isset($bundlesMetadata['FrameworkBundle'])) {
+            return false;
+        }
+
+        return is_file($bundlesMetadata['FrameworkBundle']['path'].'/Resources/config/asset_mapper.php');
+    }
 }

src/Notify/composer.json

@@ -34,7 +34,7 @@
         "symfony/http-kernel": "^5.4|^6.0",
         "symfony/mercure-bundle": "^0.3.4",
         "symfony/mercure-notifier": "^5.4|^6.0",
-        "symfony/stimulus-bundle": "^2.9",
+        "symfony/stimulus-bundle": "^2.9.1",
         "symfony/twig-bundle": "^5.4|^6.0"
     },
     "require-dev": {

src/Notify/src/DependencyInjection/NotifyExtension.php

@@ -43,7 +43,7 @@ public function loadInternal(array $config, ContainerBuilder $container)
 
     public function prepend(ContainerBuilder $container)
     {
-        if (!interface_exists(AssetMapperInterface::class)) {
+        if (!$this->isAssetMapperAvailable($container)) {
             return;
         }
 
@@ -55,4 +55,19 @@ public function prepend(ContainerBuilder $container)
             ],
         ]);
     }
+
+    private function isAssetMapperAvailable(ContainerBuilder $container): bool
+    {
+        if (!interface_exists(AssetMapperInterface::class)) {
+            return false;
+        }
+
+        // check that FrameworkBundle 6.3 or higher is installed
+        $bundlesMetadata = $container->getParameter('kernel.bundles_metadata');
+        if (!isset($bundlesMetadata['FrameworkBundle'])) {
+            return false;
+        }
+
+        return is_file($bundlesMetadata['FrameworkBundle']['path'].'/Resources/config/asset_mapper.php');
+    }
 }