Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FEATURE: Site configuration presets #4735

Merged
merged 5 commits into from
Apr 30, 2024
Merged

FEATURE: Site configuration presets #4735

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a220de
WIP: FEATURE: Site configuration presets
bwaidelich Nov 12, 2023
c4fe7a5
Merge remote-tracking branch 'origin/9.0' into feature/4582-site-conf…
mhsdesign Jan 13, 2024
53a0d13
TASK make phpstan happy
mhsdesign Jan 13, 2024
bbe8491
Merge branch '9.0' into feature/4582-site-config-presets
bwaidelich Apr 26, 2024
1909e8c
Tweak `Site::getConfiguration()` and add tests
bwaidelich Apr 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 20 additions & 3 deletions Neos.Neos/Classes/Domain/Model/Site.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use Doctrine\ORM\Mapping as ORM;
use Neos\Flow\Annotations as Flow;
use Neos\Media\Domain\Model\AssetCollection;
use Neos\Utility\Arrays;

/**
* Domain model of a site
Expand All @@ -35,12 +36,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,mixed>
*/
#[Flow\InjectConfiguration(path: 'sitePresets')]
protected $sitePresetsConfiguration = [];

/**
* Name of the site
*
Expand Down Expand Up @@ -372,7 +380,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);
mhsdesign marked this conversation as resolved.
Show resolved Hide resolved
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);
}
}
18 changes: 18 additions & 0 deletions Neos.Neos/Configuration/Settings.Sites.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'
16 changes: 0 additions & 16 deletions Neos.Neos/Configuration/Settings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@
Neos:

Neos:
contentDimensions:
resolution:
uriPathSegmentDelimiter: '_'

fusion:
# if set to true, Fusion is cached on a per-site basis.
Expand Down Expand Up @@ -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
mhsdesign marked this conversation as resolved.
Show resolved Hide resolved

sites:
'*':
uriPathSuffix: '.html'
contentRepository: default
contentDimensions:
resolver:
factoryClassName: Neos\Neos\FrontendRouting\DimensionResolution\Resolver\AutoUriPathResolverFactory

nodeTypes:
groups:
general:
Expand Down
4 changes: 2 additions & 2 deletions Neos.Neos/Migrations/Code/Version20230801154834.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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']);
}
}
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/FrontendRouting/Basic.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
30 changes: 18 additions & 12 deletions Neos.Neos/Tests/Behavior/Features/FrontendRouting/Dimensions.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,9 @@ Feature: Routing functionality with multiple content dimensions
Neos:
Neos:
sites:
'*':
contentRepository: default
'node1':
preset: default
uriPathSuffix: ''
contentDimensions:
defaultDimensionSpacePoint:
market: DE
Expand Down Expand Up @@ -111,8 +112,9 @@ Feature: Routing functionality with multiple content dimensions
Neos:
Neos:
sites:
'*':
contentRepository: default
'node1':
preset: default
uriPathSuffix: ''
contentDimensions:
defaultDimensionSpacePoint:
market: DE
Expand Down Expand Up @@ -170,8 +172,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
Expand Down Expand Up @@ -239,8 +242,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
Expand Down Expand Up @@ -306,8 +310,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
Expand Down Expand Up @@ -367,8 +372,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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/FrontendRouting/DisableNodes.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,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
Expand Down
11 changes: 9 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/FrontendRouting/MultiSiteLinking.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/FrontendRouting/RouteCache.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/FrontendRouting/Shortcuts.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/FrontendRouting/TetheredSiteChildDocuments.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/Fusion/ContentCase.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/Fusion/ContentCollection.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/Fusion/ConvertUris.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions Neos.Neos/Tests/Behavior/Features/Fusion/Menu.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,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
Expand Down