WIP: FEATURE: Site configuration presets

Resolves: #4582
neos · Nov 12, 2023 · 7a220de · 7a220de
1 parent 1801fbb
commit 7a220de
Show file tree

Hide file tree

Showing 15 changed files with 95 additions and 53 deletions.
diff --git a/Neos.Neos/Classes/Domain/Model/Site.php b/Neos.Neos/Classes/Domain/Model/Site.php
@@ -17,8 +17,10 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use Neos\ContentRepositoryRegistry\Exception\InvalidConfigurationException;
 use Neos\Flow\Annotations as Flow;
 use Neos\Media\Domain\Model\AssetCollection;
+use Neos\Utility\Arrays;
 
 /**
  * Domain model of a site
@@ -35,12 +37,19 @@ class Site
     public const STATE_OFFLINE = 2;
 
     /**
-     * @Flow\InjectConfiguration(path="sites")
      * @var array
      * @phpstan-var array<string,array<string,mixed>>
      */
+    #[Flow\InjectConfiguration(path: 'sites')]
     protected $sitesConfiguration = [];
 
+    /**
+     * @var array
+     * @phpstan-var array<string,array<string,mixed>>
+     */
+    #[Flow\InjectConfiguration(path: 'sitePresets')]
+    protected $sitePresetsConfiguration = [];
+
     /**
      * Name of the site
      *
@@ -372,7 +381,16 @@ public function emitSiteChanged()
 
     public function getConfiguration(): SiteConfiguration
     {
-        // we DO NOT want recursive merge here
-        return SiteConfiguration::fromArray($this->sitesConfiguration[$this->nodeName] ?? $this->sitesConfiguration['*']);
+        $siteSettingsPath = array_key_exists($this->nodeName, $this->sitesConfiguration) ? $this->nodeName : '*';
+        $siteSettings = $this->sitesConfiguration[$siteSettingsPath];
+        if (isset($siteSettings['preset'])) {
+            is_string($siteSettings['preset']) || throw new \RuntimeException(sprintf('Invalid "preset" configuration for "Neos.Neos.sites.%s". Expected string, got: %s', $siteSettingsPath, get_debug_type($siteSettings['preset'])), 1699785648);
+            if (!isset($this->sitePresetsConfiguration[$siteSettings['preset']]) || !is_array($this->sitePresetsConfiguration[$siteSettings['preset']])) {
+                throw new \RuntimeException(sprintf('Site settings "Neos.Neos.sites.%s" refer to a preset "%s", but no corresponding preset is configured', $siteSettingsPath, $siteSettings['preset']), 1699785736);
+            }
+            $siteSettings = Arrays::arrayMergeRecursiveOverrule($this->sitePresetsConfiguration[$siteSettings['preset']], $siteSettings);
+            unset($siteSettings['preset']);
+        }
+        return SiteConfiguration::fromArray($siteSettings);
     }
 }
diff --git a/Neos.Neos/Configuration/Settings.Sites.yaml b/Neos.Neos/Configuration/Settings.Sites.yaml
@@ -0,0 +1,18 @@
+#                                                                        #
+# Site specific settings                                                 #
+#                                                                        #
+# This file contains settings specific to Neos Sites                     #
+
+Neos:
+
+  Neos:
+    sitePresets:
+      'default':
+        uriPathSuffix: '.html'
+        contentRepository: default
+        contentDimensions:
+          resolver:
+            factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\AutoUriPathResolverFactory
+    sites:
+      '*':
+        preset: 'default'
diff --git a/Neos.Neos/Configuration/Settings.yaml b/Neos.Neos/Configuration/Settings.yaml
@@ -11,9 +11,6 @@
 Neos:
 
   Neos:
-    contentDimensions:
-      resolution:
-        uriPathSegmentDelimiter: '_'
 
     fusion:
       # if set to true, Fusion is cached on a per-site basis.
@@ -54,19 +51,6 @@ Neos:
       More information and contribution opportunities at https://www.neos.io
       -->
 
-    routing:
-      # Setting this to true allows to use an empty uriSegment for default dimensions.
-      # The only limitation is that all segments must be unique across all dimenions.
-      supportEmptySegmentForDimensions: true
-
-    sites:
-      '*':
-        uriPathSuffix: '.html'
-        contentRepository: default
-        contentDimensions:
-          resolver:
-            factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\AutoUriPathResolverFactory
-
     nodeTypes:
       groups:
         general:

diff --git a/Neos.Neos/Migrations/Code/Version20230801154834.php b/Neos.Neos/Migrations/Code/Version20230801154834.php
@@ -4,7 +4,7 @@
 
 
 /**
- * Replace defaultUriSuffix configuration with uriPathSuffix in default site configuration
+ * Replace defaultUriSuffix configuration with uriPathSuffix in default site preset configuration
  */
 class Version20230801154834 extends AbstractMigration
 {
@@ -16,6 +16,6 @@ public function getIdentifier(): string
 
     public function up(): void
     {
-        $this->moveSettingsPaths(['Neos', 'Flow', 'mvc', 'routes', 'Neos.Neos', 'variables', 'defaultUriSuffix'], ['Neos', 'Neos', 'sites', '*', 'uriPathSuffix']);
+        $this->moveSettingsPaths(['Neos', 'Flow', 'mvc', 'routes', 'Neos.Neos', 'variables', 'defaultUriSuffix'], ['Neos', 'Neos', 'sitePresets', 'default', 'uriPathSuffix']);
     }
 }
diff --git a/Neos.Neos/Tests/Behavior/Features/FrontendRouting/Basic.feature b/Neos.Neos/Tests/Behavior/Features/FrontendRouting/Basic.feature
@@ -59,8 +59,9 @@ Feature: Basic routing functionality (match & resolve document nodes in one dime
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: 'default'
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/FrontendRouting/Dimensions.feature b/Neos.Neos/Tests/Behavior/Features/FrontendRouting/Dimensions.feature
@@ -74,8 +74,9 @@ Feature: Routing functionality with multiple content dimensions
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               defaultDimensionSpacePoint:
                 market: DE
@@ -114,8 +115,9 @@ Feature: Routing functionality with multiple content dimensions
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               defaultDimensionSpacePoint:
                 market: DE
@@ -173,8 +175,9 @@ Feature: Routing functionality with multiple content dimensions
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\UriPathResolverFactory
@@ -242,8 +245,9 @@ Feature: Routing functionality with multiple content dimensions
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\UriPathResolverFactory
@@ -309,8 +313,9 @@ Feature: Routing functionality with multiple content dimensions
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\UriPathResolverFactory
@@ -373,8 +378,9 @@ Feature: Routing functionality with multiple content dimensions
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\UriPathResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/FrontendRouting/DisableNodes.feature b/Neos.Neos/Tests/Behavior/Features/FrontendRouting/DisableNodes.feature
@@ -60,8 +60,9 @@ Feature: Routing behavior of removed, disabled and re-enabled nodes
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/FrontendRouting/MultiSiteLinking.feature b/Neos.Neos/Tests/Behavior/Features/FrontendRouting/MultiSiteLinking.feature
@@ -66,8 +66,15 @@ Feature: Linking between multiple websites
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'site-1':
+            preset: default
+            uriPathSuffix: ''
+            contentDimensions:
+              resolver:
+                factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory
+          'site-2':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/FrontendRouting/RouteCache.feature b/Neos.Neos/Tests/Behavior/Features/FrontendRouting/RouteCache.feature
@@ -58,8 +58,9 @@ Feature: Route cache invalidation
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/FrontendRouting/Shortcuts.feature b/Neos.Neos/Tests/Behavior/Features/FrontendRouting/Shortcuts.feature
@@ -88,8 +88,9 @@ Feature: Routing behavior of shortcut nodes
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'node1':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/FrontendRouting/TetheredSiteChildDocuments.feature b/Neos.Neos/Tests/Behavior/Features/FrontendRouting/TetheredSiteChildDocuments.feature
@@ -47,8 +47,9 @@ Feature: Tests for site node child documents. These are special in that they hav
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'site':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/Fusion/ContentCase.feature b/Neos.Neos/Tests/Behavior/Features/Fusion/ContentCase.feature
@@ -50,8 +50,9 @@ Feature: Tests for the "Neos.Neos:ContentCase" Fusion prototype
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'a':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/Fusion/ContentCollection.feature b/Neos.Neos/Tests/Behavior/Features/Fusion/ContentCollection.feature
@@ -57,8 +57,9 @@ Feature: Tests for the "Neos.Neos:ContentCollection" Fusion prototype
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'a':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/Fusion/ConvertUris.feature b/Neos.Neos/Tests/Behavior/Features/Fusion/ConvertUris.feature
@@ -47,8 +47,9 @@ Feature: Tests for the "Neos.Neos:ConvertUris" Fusion prototype
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'a':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory

diff --git a/Neos.Neos/Tests/Behavior/Features/Fusion/Menu.feature b/Neos.Neos/Tests/Behavior/Features/Fusion/Menu.feature
@@ -72,8 +72,9 @@ Feature: Tests for the "Neos.Neos:Menu" and related Fusion prototypes
     Neos:
       Neos:
         sites:
-          '*':
-            contentRepository: default
+          'a':
+            preset: default
+            uriPathSuffix: ''
             contentDimensions:
               resolver:
                 factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\NoopResolverFactory