8000 [FrameworkBundle] Remove config deprecations · symfony/symfony@7935e94 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7935e94

Browse files
alexandre-dauboisnicolas-grekas
alexandre-daubois
authored and
nicolas-grekas
committed
[FrameworkBundle] Remove config deprecations
1 parent 52e98e2 commit 7935e94

File tree

5 files changed

+42
-96
lines changed

5 files changed

+42
-96
lines changed

‎UPGRADE-7.0.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,15 @@ FrameworkBundle
202202
* Remove the integration of Doctrine annotations, use native attributes instead
203203
* Remove `EnableLoggerDebugModePass`, use argument `$debug` of HttpKernel's `Logger` instead
204204
* Remove `AddDebugLogProcessorPass::configureLogger()`, use HttpKernel's `DebugLoggerConfigurator` instead
205+
* Make the `framework.handle_all_throwables` config option default to `true`
206+
* Make the `framework.php_errors.log` config option default to `true`
207+
* Make the `framework.session.cookie_secure` config option default to `auto`
208+
* Make the `framework.session.cookie_samesite` config option default to `lax`
209+
* Make the `framework.session.save_path` config option default to `%kernel.cache_dir%/sessions` when `framework.session.handler_id` is set or `null` otherwise
210+
* Make the `framework.session.handler_id` config option default to `session.handler.native_file` when `framework.session.save_path` is set or `null` otherwise
211+
* Make the `framework.uid.default_uuid_version` config option default to `7`
212+
* Make the `framework.uid.time_based_uuid_version` config option default to `7`
213+
* Make the `framework.validation.email_validation_mode` config option default to `html5`
205214

206215
HttpFoundation
207216
--------------

‎src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ CHANGELOG
1414
* Remove the integration of Doctrine annotations, use native attributes instead
1515
* Remove `EnableLoggerDebugModePass`, use argument `$debug` of HttpKernel's `Logger` instead
1616
* Remove `AddDebugLogProcessorPass::configureLogger()`, use HttpKernel's `DebugLoggerConfigurator` instead
17+
* Make the `framework.handle_all_throwables` config option default to `true`
18+
* Make the `framework.php_errors.log` config option default to `true`
19+
* Make the `framework.session.cookie_secure` config option default to `auto`
20+
* Make the `framework.session.cookie_samesite` config option default to `lax`
21+
* Make the `framework.session.save_path` config option default to `%kernel.cache_dir%/sessions` when `framework.session.handler_id` is set or `null` otherwise
22+
* Make the `framework.session.handler_id` config option default to `session.handler.native_file` when `framework.session.save_path` is set or `null` otherwise
23+
* Make the `framework.uid.default_uuid_version` config option default to `7`
24+
* Make the `framework.uid.time_based_uuid_version` config option default to `7`
25+
* Make the `framework.validation.email_validation_mode` config option default to `html5`
1726

1827
6.4
1928
---

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

Lines changed: 11 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,6 @@ public function getConfigTreeBuilder(): TreeBuilder
8282
return $v;
8383
})
8484
->end()
85-
->validate()
86-
->always(function ($v) {
87-
if (!isset($v['handle_all_throwables'])) {
88-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.handle_all_throwables" config option is deprecated. It will default to "true" in 7.0.');
89-
}
90-
91-
return $v;
92-
})
93-
->end()
9485
->fixXmlConfig('enabled_locale')
9586
->children()
9687
->scalarNode('secret')->end()
@@ -137,7 +128,7 @@ public function getConfigTreeBuilder(): TreeBuilder
137128
->scalarNode('error_controller')
138129
->defaultValue('error_controller')
139130
->end()
140-
->booleanNode('handle_all_throwables')->info('HttpKernel will handle all kinds of \Throwable')->end()
131+
->booleanNode('handle_all_throwables')->info('HttpKernel will handle all kinds of \Throwable')->defaultTrue()->end()
141132
->end()
142133
;
143134

@@ -649,42 +640,14 @@ private function addRouterSection(ArrayNodeDefinition $rootNode): void
649640
private function addSessionSection(ArrayNodeDefinition $rootNode): void
650641
{
651642
$rootNode
652-
->validate()
653-
->always(function (array $v): array {
654-
if ($v['session']['enabled']) {
655-
if (!\array_key_exists('cookie_secure', $v['session'])) {
656-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.session.cookie_secure" config option is deprecated. It will default to "auto" in 7.0.');
657-
}
658-
659-
if (!\array_key_exists('cookie_samesite', $v['session'])) {
660-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.session.cookie_samesite" config option is deprecated. It will default to "lax" in 7.0.');
661-
}
662-
663-
if (!\array_key_exists('handler_id', $v['session'])) {
664-
if (!\array_key_exists('save_path', $v['session'])) {
665-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.session.save_path" config option when the "framework.session.handler_id" config option is not set either is deprecated. Both options will default to "null" in 7.0.');
666-
} else {
667-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.session.handler_id" config option is deprecated. It will default to "session.handler.native_file" when "framework.session.save_path" is set or "null" otherwise in 7.0.');
668-
}
669-
}
670-
}
671-
672-
$v['session'] += [
673-
'cookie_samesite' => null,
674-
'handler_id' => 'session.handler.native_file',
675-
'save_path' => '%kernel.cache_dir%/sessions',
676-
];
677-
678-
return $v;
679-
})
680-
->end()
681643
->children()
682644
->arrayNode('session')
683645
->info('session configuration')
684646
->canBeEnabled()
685647
->children()
686648
->scalarNode('storage_factory_id')->defaultValue('session.storage.factory.native')->end()
687649
->scalarNode('handler_id')->end()
650+
->info('Defaults to using the native session handler, or to the native *file* session handler if "save_path" is not null.')
688651
->scalarNode('name')
689652
->validate()
690653
->ifTrue(function ($v) {
@@ -698,14 +661,16 @@ private function addSessionSection(ArrayNodeDefinition $rootNode): void
698661
->scalarNode('cookie_lifetime')->end()
699662
->scalarNode('cookie_path')->end()
700663
->scalarNode('cookie_domain')->end()
701-
->enumNode('cookie_secure')->values([true, false, 'auto'])->end()
664+
->enumNode('cookie_secure')->values([true, false, 'auto'])->defaultValue('auto')->end()
702665
->booleanNode('cookie_httponly')->defaultTrue()->end()
703-
->enumNode('cookie_samesite')->values([null, Cookie::SAMESITE_LAX, Cookie::SAMESITE_STRICT, Cookie::SAMESITE_NONE])->end()
666+
->enumNode('cookie_samesite')->values([null, Cookie::SAMESITE_LAX, Cookie::SAMESITE_STRICT, Cookie::SAMESITE_NONE])->defaultValue('lax')->end()
704667
->booleanNode('use_cookies')->end()
705668
->scalarNode('gc_divisor')->end()
706669
->scalarNode('gc_probability')->defaultValue(1)->end()
707670
->scalarNode('gc_maxlifetime')->end()
708-
->scalarNode('save_path')->end()
671+
->s 10000 calarNode('save_path')
672+
->info('Defaults to "%kernel.cache_dir%/sessions" if the "handler_id" option is not null')
673+
->end()
709674
->integerNode('metadata_update_threshold')
710675
->defaultValue(0)
711676
->info('seconds to wait between 2 session metadata updates')
@@ -1017,25 +982,6 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode, callable $e
1017982
private function addValidationSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
1018983
{
1019984
$rootNode
1020-
->validate()
1021-
->always(function ($v) {
1022-
if ($v['validation']['enabled'] && !\array_key_exists('email_validation_mode', $v['validation'])) {
1023-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.validation.email_validation_mode" config option is deprecated. It will default to "html5" in 7.0.');
1024-
}
1025-
1026-
if (isset($v['enable_annotations'])) {
1027-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Option "enable_annotations" at "framework.validation" is deprecated. Use the "enable_attributes" option instead.');
1028-
1029-
if (!isset($v['enable_attributes'])) {
1030-
$v['enable_attributes'] = $v['enable_annotations'];
1031-
} else {
1032-
throw new LogicException('The "enable_annotations" and "enable_attributes" options at path "framework.validation" must not be both set. Only the "enable_attributes" option must be used.');
1033-
}
1034-
}
1035-
1036-
return $v;
1037-
})
1038-
->end()
1039985
->children()
1040986
->arrayNode('validation')
1041987
->info('validation configuration')
@@ -1051,7 +997,7 @@ private function addValidationSection(ArrayNodeDefinition $rootNode, callable $e
1051997
->validate()->castToArray()->end()
1052998
->end()
1053999
->scalarNode('translation_domain')->defaultValue('validators')->end()
1054-
->enumNode('email_validation_mode')->values(['html5', 'loose', 'strict'])->end()
1000+
->enumNode('email_validation_mode')->values(['html5', 'loose', 'strict'])->defaultValue('html5')->end()
10551001
->arrayNode('mapping')
10561002
->addDefaultsIfNotSet()
10571003
->fixXmlConfig('path')
@@ -1316,17 +1262,6 @@ private function addCacheSection(ArrayNodeDefinition $rootNode, callable $willBe
13161262
private function addPhpErrorsSection(ArrayNodeDefinition $rootNode): void
13171263
{
13181264
$rootNode
1319-
->validate()
1320-
->always(function (array $v): array {
1321-
if (!\array_key_exists('log', $v['php_errors'])) {
1322-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.php_errors.log" config option is deprecated. It will default to "true" in 7.0.');
1323-
1324-
$v['php_errors']['log'] = $this->debug;
1325-
}
1326-
1327-
return $v;
1328-
})
1329-
->end()
13301265
->children()
13311266
->arrayNode('php_errors')
13321267
->info('PHP errors handling configuration')
@@ -1336,6 +1271,7 @@ private function addPhpErrorsSection(ArrayNodeDefinition $rootNode): void
13361271
->info('Use the application logger instead of the PHP logger for logging PHP errors.')
13371272
->example('"true" to use the default configuration: log all errors. "false" to disable. An integer bit field of E_* constants, or an array mapping E_* constants to log levels.')
13381273
->treatNullLike($this->debug)
1274+
->defaultTrue()
13391275
->beforeNormalization()
13401276
->ifArray()
13411277
->then(function (array $v): array {
@@ -2348,23 +2284,6 @@ private function addRateLimiterSection(ArrayNodeDefinition $rootNode, callable $
23482284
private function addUidSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
23492285
{
23502286
$rootNode
2351-
->validate()
2352-
->always(function ($v) {
2353-
if ($v['uid']['enabled']) {
2354-
if (!\array_key_exists('default_uuid_version', $v['uid'])) {
2355-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.uid.default_uuid_version" config option is deprecated. It will default to "7" in 7.0.');
2356-
}
2357-
2358-
if (!\array_key_exists('time_based_uuid_version', $v['uid'])) {
2359-
trigger_deprecation('symfony/framework-bundle', '6.4', 'Not setting the "framework.uid.time_based_uuid_version" config option is deprecated. It will default to "7" in 7.0.');
2360-
}
2361-
}
2362-
2363-
$v['uid'] += ['default_uuid_version' => 6, 'time_based_uuid_version' => 6];
2364-
2365-
return $v;
2366-
})
2367-
->end()
23682287
->children()
23692288
->arrayNode('uid')
23702289
->info('Uid configuration')
@@ -2373,6 +2292,7 @@ private function addUidSection(ArrayNodeDefinition $rootNode, callable $enableIf
23732292
->children()
23742293
->enumNode('default_uuid_version')
23752294
->values([7, 6, 4, 1])
2295+
->defaultValue(7)
23762296
->end()
23772297
->enumNode('name_based_uuid_version')
23782298
->defaultValue(5)
@@ -2383,6 +2303,7 @@ private function addUidSection(ArrayNodeDefinition $rootNode, callable $enableIf
23832303
->end()
23842304
->enumNode('time_based_uuid_version')
23852305
->values([7, 6, 1])
2306+
->defaultValue(7)
23862307
->end()
23872308
->scalarNode('time_based_uuid_node')
23882309
->cannotBeEmpty()

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1232,10 +1232,15 @@ private function registerSessionConfiguration(array $config, ContainerBuilder $c
12321232
$container->setParameter('session.storage.options', $options);
12331233

12341234
// session handler (the internal callback registered with PHP session management)
1235-
if (null === $config['handler_id']) {
1235+
if (null === ($config['handler_id'] ?? $config['save_path'] ?? null)) {
12361236
$config['save_path'] = null;
12371237
$container->setAlias('session.handler', 'session.handler.native');
12381238
} else {
1239+
$config['handler_id'] ??= 'session.handler.native_file';
1240+
1241+
if (!\array_key_exists('save_path', $config)) {
1242+
$config['save_path'] = '%kernel.cache_dir%/sessions';
1243+
}
12391244
$container->resolveEnvPlaceholders($config['handler_id'], null, $usedEnvs);
12401245

12411246
if ($usedEnvs || preg_match('#^[a-z]++://#', $config['handler_id'])) {

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,7 @@ protected static function getBundleDefaultConfig()
602602
'enabled' => true,
603603
'endpoint' => null,
604604
],
605+
'email_validation_mode' => 'html5',
605606
],
606607
'annotations' => [
607608
'enabled' => false,
@@ -635,11 +636,12 @@ protected static function getBundleDefaultConfig()
635636
'session' => [
636637
'enabled' => false,
637638
'storage_factory_id' => 'session.storage.factory.native',
638-
'handler_id' => 'session.handler.native_file',
639+
'handler_id' => null,
639640
'cookie_httponly' => true,
640-
'cookie_samesite' => null,
641+
'cookie_samesite' => 'lax',
642+
'cookie_secure' => 'auto',
641643
'gc_probability' => 1,
642-
'save_path' => '%kernel.cache_dir%/sessions',
644+
'save_path' => null,
643645
'metadata_update_threshold' => 0,
644646
],
645647
'request' => [
@@ -762,9 +764,9 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
762764
],
763765
'uid' => [
764766
'enabled' => !class_exists(FullStack::class) && class_exists(UuidFactory::class),
765-
'default_uuid_version' => 6,
767+
'default_uuid_version' => 7,
766768
'name_based_uuid_version' => 5,
767-
'time_based_uuid_version' => 6,
769+
'time_based_uuid_version' => 7,
768770
],
769771
'html_sanitizer' => [
770772
'enabled' => !class_exists(FullStack::class) && class_exists(HtmlSanitizer::class),

0 commit comments

Comments
 (0)
0