Compare commits

...

10 Commits

Author SHA1 Message Date
Garion Herman
dad64f132f
Merge 4b6c248296 into ba97de9458 2024-10-22 05:30:41 +13:00
Guy Sartorelli
ba97de9458
Merge branch '5' into 6 2024-10-21 14:03:32 +13:00
Guy Sartorelli
82b0851a2a
Merge pull request #11429 from creative-commoners/pulls/5/core-deprecation
ENH Do not output core code deprecation messages by default
2024-10-21 13:57:52 +13:00
github-actions
4d26063850 Merge branch '5' into 6 2024-10-20 23:36:45 +00:00
Guy Sartorelli
8845794012
Merge pull request #11431 from maxime-rainville/pulls/6/remove-legacy-charset-setting
ENH Default DB settings to use 4 bytes to store UTF8 characters
2024-10-21 10:54:26 +13:00
Steve Boyd
7401bcf02e ENH Do not output core code deprecation messages by default 2024-10-21 10:20:44 +13:00
Guy Sartorelli
969d7b4bd2
Merge pull request #11427 from creative-commoners/pulls/5/field-validator-depr
API Add deprecation
2024-10-21 10:05:32 +13:00
Maxime Rainville
acbde0c24d
ENH Default DB settings to use 4 bytes to store UTF8 characters 2024-10-19 23:36:26 +13:00
Steve Boyd
8ec068f3fd API Add deprecation 2024-10-17 16:06:06 +13:00
Garion Herman
4b6c248296 API Remove ALC renewal, tweak extension point
The ALC token is no longer rotated during an active login. Also removed related
`replace_token_during_session_renewal` config. The extension point that was
previously provided in the `renew()` method has been renamed and is now triggered
externally in the `CookieAuthenticationHandler::authenticateRequest()` method.
2024-10-01 12:55:44 +09:00
11 changed files with 225 additions and 77 deletions

View File

@ -39,6 +39,7 @@
"sensiolabs/ansi-to-html": "^1.2", "sensiolabs/ansi-to-html": "^1.2",
"silverstripe/config": "^3", "silverstripe/config": "^3",
"silverstripe/assets": "^3", "silverstripe/assets": "^3",
"silverstripe/supported-modules": "^1.1",
"silverstripe/vendor-plugin": "^2", "silverstripe/vendor-plugin": "^2",
"sminnee/callbacklist": "^0.1.1", "sminnee/callbacklist": "^0.1.1",
"symfony/cache": "^7.0", "symfony/cache": "^7.0",

View File

@ -19,7 +19,6 @@ use SilverStripe\View\TemplateGlobalProvider;
*/ */
class Controller extends RequestHandler implements TemplateGlobalProvider class Controller extends RequestHandler implements TemplateGlobalProvider
{ {
/** /**
* An array of arguments extracted from the URL. * An array of arguments extracted from the URL.
* *

View File

@ -3,11 +3,14 @@
namespace SilverStripe\Dev; namespace SilverStripe\Dev;
use BadMethodCallException; use BadMethodCallException;
use RuntimeException;
use SilverStripe\Control\Director; use SilverStripe\Control\Director;
use SilverStripe\Core\Environment; use SilverStripe\Core\Environment;
use SilverStripe\Core\Injector\InjectionCreator; use SilverStripe\Core\Injector\InjectionCreator;
use SilverStripe\Core\Injector\InjectorLoader; use SilverStripe\Core\Injector\InjectorLoader;
use SilverStripe\Core\Manifest\Module; use SilverStripe\Core\Manifest\Module;
use SilverStripe\Core\Path;
use SilverStripe\SupportedModules\MetaData;
/** /**
* Handles raising an notice when accessing a deprecated method, class, configuration, or behaviour. * Handles raising an notice when accessing a deprecated method, class, configuration, or behaviour.
@ -77,6 +80,18 @@ class Deprecation
*/ */
private static bool $showNoReplacementNotices = false; private static bool $showNoReplacementNotices = false;
/**
* @internal
*/
private static bool $showNoticesCalledFromSupportedCode = false;
/**
* Cache of supported module directories, read from silverstripe/supported-modules repositories.json
*
* @internal
*/
private static array $supportedModuleDirectories = [];
/** /**
* Enable throwing deprecation warnings. By default, this excludes warnings for * Enable throwing deprecation warnings. By default, this excludes warnings for
* deprecated code which is called by core Silverstripe modules. * deprecated code which is called by core Silverstripe modules.
@ -146,6 +161,12 @@ class Deprecation
if (!$level) { if (!$level) {
$level = 1; $level = 1;
} }
$called = Deprecation::get_called_from_trace($backtrace, $level);
return ($called['class'] ?? '') . ($called['type'] ?? '') . ($called['function'] ?? '');
}
private static function get_called_from_trace(array $backtrace, int $level): array
{
$newLevel = $level; $newLevel = $level;
// handle closures inside withSuppressedNotice() // handle closures inside withSuppressedNotice()
if (Deprecation::$insideNoticeSuppression if (Deprecation::$insideNoticeSuppression
@ -163,8 +184,51 @@ class Deprecation
if ($level == 4 && ($backtrace[$newLevel]['class'] ?? '') === InjectionCreator::class) { if ($level == 4 && ($backtrace[$newLevel]['class'] ?? '') === InjectionCreator::class) {
$newLevel = $newLevel + 4; $newLevel = $newLevel + 4;
} }
// handle noticeWithNoReplacment()
foreach ($backtrace as $trace) {
if (($trace['class'] ?? '') === Deprecation::class
&& ($trace['function'] ?? '') === 'noticeWithNoReplacment'
) {
$newLevel = $newLevel + 1;
break;
}
}
$called = $backtrace[$newLevel] ?? []; $called = $backtrace[$newLevel] ?? [];
return ($called['class'] ?? '') . ($called['type'] ?? '') . ($called['function'] ?? ''); return $called;
}
private static function isCalledFromSupportedCode(array $backtrace): bool
{
$called = Deprecation::get_called_from_trace($backtrace, 1);
$file = $called['file'] ?? '';
if (!$file) {
return false;
}
return Deprecation::fileIsInSupportedModule($file);
}
/**
* Check whether a file (path to file) is in a supported module
*/
public static function fileIsInSupportedModule(string $file): bool
{
// Cache the supported modules list
if (count(Deprecation::$supportedModuleDirectories) === 0) {
// Do not make a network request when fetching metadata which could slow down a website
// While there is a small risk of the list being out of date, there is minimal downside to this
$metaData = MetaData::getAllRepositoryMetaData(fromRemote: false);
$dirs = array_map(fn($module) => "/vendor/{$module['packagist']}/", $metaData['supportedModules']);
// This is a special case for silverstripe-framework when running in CI
// Needed because module is run in the root folder rather than in the vendor folder
$dirs[] = '/silverstripe-framework/';
Deprecation::$supportedModuleDirectories = $dirs;
}
foreach (Deprecation::$supportedModuleDirectories as $dir) {
if (str_contains($file, $dir)) {
return true;
}
}
return false;
} }
public static function isEnabled(): bool public static function isEnabled(): bool
@ -245,6 +309,22 @@ class Deprecation
return Deprecation::$shouldShowForCli; return Deprecation::$shouldShowForCli;
} }
/**
* If true, deprecation warnings will be shown for deprecated code which is called by core Silverstripe modules.
*/
public static function getShowNoticesCalledFromSupportedCode(): bool
{
return Deprecation::$showNoticesCalledFromSupportedCode;
}
/**
* Set whether deprecation warnings will be shown for deprecated code which is called by core Silverstripe modules.
*/
public static function setShowNoticesCalledFromSupportedCode(bool $value): void
{
Deprecation::$showNoticesCalledFromSupportedCode = $value;
}
public static function outputNotices(): void public static function outputNotices(): void
{ {
if (!Deprecation::isEnabled()) { if (!Deprecation::isEnabled()) {
@ -258,9 +338,13 @@ class Deprecation
$arr = array_shift(Deprecation::$userErrorMessageBuffer); $arr = array_shift(Deprecation::$userErrorMessageBuffer);
$message = $arr['message']; $message = $arr['message'];
$calledWithNoticeSuppression = $arr['calledWithNoticeSuppression']; $calledWithNoticeSuppression = $arr['calledWithNoticeSuppression'];
$isCalledFromSupportedCode = $arr['isCalledFromSupportedCode'];
if ($calledWithNoticeSuppression && !Deprecation::$showNoReplacementNotices) { if ($calledWithNoticeSuppression && !Deprecation::$showNoReplacementNotices) {
continue; continue;
} }
if ($isCalledFromSupportedCode && !Deprecation::$showNoticesCalledFromSupportedCode) {
continue;
}
Deprecation::$isTriggeringError = true; Deprecation::$isTriggeringError = true;
user_error($message, E_USER_DEPRECATED); user_error($message, E_USER_DEPRECATED);
Deprecation::$isTriggeringError = false; Deprecation::$isTriggeringError = false;
@ -294,6 +378,10 @@ class Deprecation
$data = [ $data = [
'key' => sha1($string), 'key' => sha1($string),
'message' => $string, 'message' => $string,
// Setting to `false` as here as any SCOPE_CONFIG notices from supported modules have
// already been filtered out if needed if they came from a supported module in
// SilverStripe\Config\Transformer\YamlTransformer::checkForDeprecatedConfig()
'isCalledFromSupportedCode' => false,
'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression 'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression
]; ];
} else { } else {
@ -322,13 +410,13 @@ class Deprecation
$level = Deprecation::$insideNoticeSuppression ? 4 : 2; $level = Deprecation::$insideNoticeSuppression ? 4 : 2;
$string .= " Called from " . Deprecation::get_called_method_from_trace($backtrace, $level) . '.'; $string .= " Called from " . Deprecation::get_called_method_from_trace($backtrace, $level) . '.';
if ($caller) { if ($caller) {
$string = $caller . ' is deprecated.' . ($string ? ' ' . $string : ''); $string = $caller . ' is deprecated.' . ($string ? ' ' . $string : '');
} }
$data = [ $data = [
'key' => sha1($string), 'key' => sha1($string),
'message' => $string, 'message' => $string,
'isCalledFromSupportedCode' => Deprecation::isCalledFromSupportedCode($backtrace),
'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression 'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression
]; ];
} }
@ -360,6 +448,23 @@ class Deprecation
} }
} }
/**
* Shorthand method to create a suppressed notice for something with no immediate replacement.
* If $message is empty, then a standardised message will be used
*/
public static function noticeWithNoReplacment(
string $atVersion,
string $message = '',
int $scope = Deprecation::SCOPE_METHOD
): void {
if ($message === '') {
$message = 'Will be removed without equivalent functionality to replace it.';
}
Deprecation::withSuppressedNotice(
fn() => Deprecation::notice($atVersion, $message, $scope)
);
}
private static function varAsBoolean($val): bool private static function varAsBoolean($val): bool
{ {
if (is_string($val)) { if (is_string($val)) {

View File

@ -10,7 +10,6 @@ use SilverStripe\Model\List\PaginatedList;
use SilverStripe\ORM\DataList; use SilverStripe\ORM\DataList;
use SilverStripe\Model\List\ArrayList; use SilverStripe\Model\List\ArrayList;
use SilverStripe\ORM\DataObject; use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\Queries\SQLSelect;
use Exception; use Exception;
/** /**
@ -31,7 +30,7 @@ class MySQLDatabase extends Database implements TransactionManager
* @config * @config
* @var String * @var String
*/ */
private static $connection_charset = 'utf8'; private static $connection_charset = 'utf8mb4';
/** /**
* Default connection collation * Default connection collation
@ -39,7 +38,7 @@ class MySQLDatabase extends Database implements TransactionManager
* @config * @config
* @var string * @var string
*/ */
private static $connection_collation = 'utf8_general_ci'; private static $connection_collation = 'utf8mb4_unicode_ci';
/** /**
* Default charset * Default charset
@ -47,7 +46,7 @@ class MySQLDatabase extends Database implements TransactionManager
* @config * @config
* @var string * @var string
*/ */
private static $charset = 'utf8'; private static $charset = 'utf8mb4';
/** /**
* SQL Mode used on connections to MySQL. Defaults to ANSI. For basic ORM * SQL Mode used on connections to MySQL. Defaults to ANSI. For basic ORM
@ -73,7 +72,7 @@ class MySQLDatabase extends Database implements TransactionManager
* @config * @config
* @var string * @var string
*/ */
private static $collation = 'utf8_general_ci'; private static $collation = 'utf8mb4_unicode_ci';
public function connect($parameters) public function connect($parameters)
{ {

View File

@ -15,7 +15,8 @@ class DBBoolean extends DBField
{ {
public function __construct(?string $name = null, bool|int $defaultVal = 0) public function __construct(?string $name = null, bool|int $defaultVal = 0)
{ {
$this->defaultVal = ($defaultVal) ? 1 : 0; $defaultValue = $defaultVal ? 1 : 0;
$this->setDefaultValue($defaultValue);
parent::__construct($name); parent::__construct($name);
} }
@ -27,7 +28,7 @@ class DBBoolean extends DBField
'precision' => 1, 'precision' => 1,
'sign' => 'unsigned', 'sign' => 'unsigned',
'null' => 'not null', 'null' => 'not null',
'default' => $this->defaultVal, 'default' => $this->getDefaultValue(),
'arrayValue' => $this->arrayValue 'arrayValue' => $this->arrayValue
]; ];
$values = ['type' => 'boolean', 'parts' => $parts]; $values = ['type' => 'boolean', 'parts' => $parts];

View File

@ -103,6 +103,7 @@ abstract class DBField extends ModelData implements DBIndexable
* Default value in the database. * Default value in the database.
* Might be overridden on DataObject-level, but still useful for setting defaults on * Might be overridden on DataObject-level, but still useful for setting defaults on
* already existing records after a db-build. * already existing records after a db-build.
* @deprecated 5.4.0 Use getDefaultValue() and setDefaultValue() instead
*/ */
protected mixed $defaultVal = null; protected mixed $defaultVal = null;

View File

@ -13,7 +13,8 @@ class DBFloat extends DBField
{ {
public function __construct(?string $name = null, float|int $defaultVal = 0) public function __construct(?string $name = null, float|int $defaultVal = 0)
{ {
$this->defaultVal = is_float($defaultVal) ? $defaultVal : (float) 0; $defaultValue = is_float($defaultVal) ? $defaultVal : (float) 0;
$this->setDefaultValue($defaultValue);
parent::__construct($name); parent::__construct($name);
} }
@ -23,7 +24,7 @@ class DBFloat extends DBField
$parts = [ $parts = [
'datatype' => 'float', 'datatype' => 'float',
'null' => 'not null', 'null' => 'not null',
'default' => $this->defaultVal, 'default' => $this->getDefaultValue(),
'arrayValue' => $this->arrayValue 'arrayValue' => $this->arrayValue
]; ];
$values = ['type' => 'float', 'parts' => $parts]; $values = ['type' => 'float', 'parts' => $parts];

View File

@ -16,7 +16,8 @@ class DBInt extends DBField
{ {
public function __construct(?string $name = null, int $defaultVal = 0) public function __construct(?string $name = null, int $defaultVal = 0)
{ {
$this->defaultVal = is_int($defaultVal) ? $defaultVal : 0; $defaultValue = is_int($defaultVal) ? $defaultVal : 0;
$this->setDefaultValue($defaultValue);
parent::__construct($name); parent::__construct($name);
} }
@ -44,7 +45,7 @@ class DBInt extends DBField
'datatype' => 'int', 'datatype' => 'int',
'precision' => 11, 'precision' => 11,
'null' => 'not null', 'null' => 'not null',
'default' => $this->defaultVal, 'default' => $this->getDefaultValue(),
'arrayValue' => $this->arrayValue 'arrayValue' => $this->arrayValue
]; ];
$values = ['type' => 'int', 'parts' => $parts]; $values = ['type' => 'int', 'parts' => $parts];

View File

@ -175,22 +175,8 @@ class CookieAuthenticationHandler implements AuthenticationHandler
$this->cascadeInTo->logIn($member, false, $request); $this->cascadeInTo->logIn($member, false, $request);
} }
// Renew the token // Session renewal hook
Deprecation::withSuppressedNotice(fn() => $rememberLoginHash->renew()); $rememberLoginHash->extend('onAfterRenewSession');
// Send the new token to the client if it was changed
if ($rememberLoginHash->getToken()) {
$tokenExpiryDays = RememberLoginHash::config()->uninherited('token_expiry_days');
Cookie::set(
$this->getTokenCookieName(),
$member->ID . ':' . $rememberLoginHash->getToken(),
$tokenExpiryDays,
null,
null,
false,
true
);
}
// Audit logging hook // Audit logging hook
$member->extend('memberAutoLoggedIn'); $member->extend('memberAutoLoggedIn');

View File

@ -82,15 +82,6 @@ class RememberLoginHash extends DataObject
*/ */
private static $force_single_token = false; private static $force_single_token = false;
/**
* If true, the token will be replaced during session renewal. This can cause unexpected
* logouts if the new token does not reach the client (e.g. due to a network error).
*
* This can be disabled as of CMS 5.3, and renewal will be removed entirely in CMS 6.
* @deprecated 5.3.0 Will be removed without equivalent functionality
*/
private static bool $replace_token_during_session_renewal = true;
/** /**
* The token used for the hash. Only present during the lifetime of the request * The token used for the hash. Only present during the lifetime of the request
* that generates it, as the hash representation is stored in the database and * that generates it, as the hash representation is stored in the database and
@ -201,28 +192,6 @@ class RememberLoginHash extends DataObject
return $rememberLoginHash; return $rememberLoginHash;
} }
/**
* Generates a new hash for this member but keeps the device ID intact
*
* @deprecated 5.3.0 Will be removed without equivalent functionality
* @return RememberLoginHash
*/
public function renew()
{
// Only regenerate token if configured to do so
Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality');
$replaceToken = RememberLoginHash::config()->get('replace_token_during_session_renewal');
if ($replaceToken) {
$hash = $this->getNewHash($this->Member());
$this->Hash = $hash;
}
$this->extend('onAfterRenewToken', $replaceToken);
$this->write();
return $this;
}
/** /**
* Deletes existing tokens for this member * Deletes existing tokens for this member
* if logout_across_devices is true, all tokens are deleted, otherwise * if logout_across_devices is true, all tokens are deleted, otherwise

View File

@ -26,6 +26,8 @@ class DeprecationTest extends SapphireTest
private bool $noticesWereEnabled = false; private bool $noticesWereEnabled = false;
private bool $showSupportedNoticesWasEnabled = false;
protected function setup(): void protected function setup(): void
{ {
// Use custom error handler for two reasons: // Use custom error handler for two reasons:
@ -34,6 +36,7 @@ class DeprecationTest extends SapphireTest
// https://github.com/laminas/laminas-di/pull/30#issuecomment-927585210 // https://github.com/laminas/laminas-di/pull/30#issuecomment-927585210
parent::setup(); parent::setup();
$this->noticesWereEnabled = Deprecation::isEnabled(); $this->noticesWereEnabled = Deprecation::isEnabled();
$this->showSupportedNoticesWasEnabled = Deprecation::getShowNoticesCalledFromSupportedCode();
$this->oldHandler = set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline) { $this->oldHandler = set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline) {
if ($errno === E_USER_DEPRECATED) { if ($errno === E_USER_DEPRECATED) {
if (str_contains($errstr, 'SilverStripe\\Dev\\Tests\\DeprecationTest')) { if (str_contains($errstr, 'SilverStripe\\Dev\\Tests\\DeprecationTest')) {
@ -49,6 +52,8 @@ class DeprecationTest extends SapphireTest
// Fallback to default PHP error handler // Fallback to default PHP error handler
return false; return false;
}); });
// This is required to clear out the notice from instantiating DeprecationTestObject in TableBuilder::buildTables().
Deprecation::outputNotices();
} }
protected function tearDown(): void protected function tearDown(): void
@ -58,6 +63,7 @@ class DeprecationTest extends SapphireTest
} else { } else {
Deprecation::disable(); Deprecation::disable();
} }
Deprecation::setShowNoticesCalledFromSupportedCode($this->showSupportedNoticesWasEnabled);
restore_error_handler(); restore_error_handler();
$this->oldHandler = null; $this->oldHandler = null;
parent::tearDown(); parent::tearDown();
@ -69,6 +75,18 @@ class DeprecationTest extends SapphireTest
return 'abc'; return 'abc';
} }
private function myDeprecatedMethodNoReplacement(): string
{
Deprecation::noticeWithNoReplacment('1.2.3');
return 'abc';
}
private function enableDeprecationNotices(bool $showNoReplacementNotices = false): void
{
Deprecation::enable($showNoReplacementNotices);
Deprecation::setShowNoticesCalledFromSupportedCode(true);
}
public function testNotice() public function testNotice()
{ {
$message = implode(' ', [ $message = implode(' ', [
@ -78,7 +96,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
$ret = $this->myDeprecatedMethod(); $ret = $this->myDeprecatedMethod();
$this->assertSame('abc', $ret); $this->assertSame('abc', $ret);
// call outputNotices() directly because the regular shutdown function that emits // call outputNotices() directly because the regular shutdown function that emits
@ -86,6 +104,29 @@ class DeprecationTest extends SapphireTest
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
public function testNoticeNoReplacement()
{
$message = implode(' ', [
'SilverStripe\Dev\Tests\DeprecationTest->myDeprecatedMethodNoReplacement is deprecated.',
'Will be removed without equivalent functionality to replace it.',
'Called from SilverStripe\Dev\Tests\DeprecationTest->testNoticeNoReplacement.'
]);
$this->expectDeprecation();
$this->expectDeprecationMessage($message);
$this->enableDeprecationNotices(true);
$ret = $this->myDeprecatedMethodNoReplacement();
$this->assertSame('abc', $ret);
Deprecation::outputNotices();
}
public function testNoticeNoReplacementNoSupressed()
{
$this->enableDeprecationNotices();
$ret = $this->myDeprecatedMethodNoReplacement();
$this->assertSame('abc', $ret);
Deprecation::outputNotices();
}
public function testCallUserFunc() public function testCallUserFunc()
{ {
$message = implode(' ', [ $message = implode(' ', [
@ -95,7 +136,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
$ret = call_user_func([$this, 'myDeprecatedMethod']); $ret = call_user_func([$this, 'myDeprecatedMethod']);
$this->assertSame('abc', $ret); $this->assertSame('abc', $ret);
Deprecation::outputNotices(); Deprecation::outputNotices();
@ -110,7 +151,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
$ret = call_user_func_array([$this, 'myDeprecatedMethod'], []); $ret = call_user_func_array([$this, 'myDeprecatedMethod'], []);
$this->assertSame('abc', $ret); $this->assertSame('abc', $ret);
Deprecation::outputNotices(); Deprecation::outputNotices();
@ -118,7 +159,7 @@ class DeprecationTest extends SapphireTest
public function testwithSuppressedNoticeDefault() public function testwithSuppressedNoticeDefault()
{ {
Deprecation::enable(); $this->enableDeprecationNotices();
$ret = Deprecation::withSuppressedNotice(function () { $ret = Deprecation::withSuppressedNotice(function () {
return $this->myDeprecatedMethod(); return $this->myDeprecatedMethod();
}); });
@ -135,7 +176,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(true); $this->enableDeprecationNotices(true);
$ret = Deprecation::withSuppressedNotice(function () { $ret = Deprecation::withSuppressedNotice(function () {
return $this->myDeprecatedMethod(); return $this->myDeprecatedMethod();
}); });
@ -152,7 +193,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(true); $this->enableDeprecationNotices(true);
$ret = Deprecation::withSuppressedNotice(function () { $ret = Deprecation::withSuppressedNotice(function () {
return call_user_func([$this, 'myDeprecatedMethod']); return call_user_func([$this, 'myDeprecatedMethod']);
}); });
@ -169,7 +210,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(true); $this->enableDeprecationNotices(true);
Deprecation::withSuppressedNotice(function () { Deprecation::withSuppressedNotice(function () {
Deprecation::notice('123', 'My message.'); Deprecation::notice('123', 'My message.');
}); });
@ -185,7 +226,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(true); $this->enableDeprecationNotices(true);
// using this syntax because my IDE was complaining about DeprecationTestObject not existing // using this syntax because my IDE was complaining about DeprecationTestObject not existing
// when trying to use `new DeprecationTestObject();` // when trying to use `new DeprecationTestObject();`
$class = DeprecationTestObject::class; $class = DeprecationTestObject::class;
@ -202,7 +243,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(true); $this->enableDeprecationNotices(true);
Injector::inst()->get(DeprecationTestObject::class); Injector::inst()->get(DeprecationTestObject::class);
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
@ -218,6 +259,50 @@ class DeprecationTest extends SapphireTest
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
public function testshowNoticesCalledFromSupportedCode()
{
$this->expectNotToPerformAssertions();
$this->enableDeprecationNotices(true);
// showNoticesCalledFromSupportedCode is set to true by default for these unit tests
// as it is testing code within vendor/silverstripe
// This test is to ensure that the method works as expected when we disable this
// and we should expect no exceptions to be thrown
//
// Note specifically NOT testing the following because it's counted as being called
// from phpunit itself, which is not considered supported code
// Deprecation::withSuppressedNotice(function () {
// Deprecation::notice('123', 'My message.');
// });
Deprecation::setShowNoticesCalledFromSupportedCode(false);
// notice()
$this->myDeprecatedMethod();
// noticeNoReplacement()
$this->myDeprecatedMethodNoReplacement();
// callUserFunc()
call_user_func([$this, 'myDeprecatedMethod']);
// callUserFuncArray()
call_user_func_array([$this, 'myDeprecatedMethod'], []);
// withSuppressedNotice()
Deprecation::withSuppressedNotice(
fn() => $this->myDeprecatedMethod()
);
// withSuppressedNoticeTrue()
Deprecation::withSuppressedNotice(function () {
$this->myDeprecatedMethod();
});
// withSuppressedNoticeTrueCallUserFunc()
Deprecation::withSuppressedNotice(function () {
call_user_func([$this, 'myDeprecatedMethod']);
});
// classWithSuppressedNotice()
$class = DeprecationTestObject::class;
new $class();
// classWithInjectorwithSuppressedNotice()
Injector::inst()->get(DeprecationTestObject::class);
// Output notices - there should be none
Deprecation::outputNotices();
}
// The following tests would be better to put in the silverstripe/config module, however this is not // The following tests would be better to put in the silverstripe/config module, however this is not
// possible to do in a clean way as the config for the DeprecationTestObject will not load if it // possible to do in a clean way as the config for the DeprecationTestObject will not load if it
// is inside the silverstripe/config directory, as there is no _config.php file or _config folder. // is inside the silverstripe/config directory, as there is no _config.php file or _config folder.
@ -232,7 +317,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
Config::inst()->get(DeprecationTestObject::class, 'first_config'); Config::inst()->get(DeprecationTestObject::class, 'first_config');
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
@ -245,7 +330,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
Config::inst()->get(DeprecationTestObject::class, 'second_config'); Config::inst()->get(DeprecationTestObject::class, 'second_config');
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
@ -255,7 +340,7 @@ class DeprecationTest extends SapphireTest
$message = 'Config SilverStripe\Dev\Tests\DeprecationTest\DeprecationTestObject.third_config is deprecated.'; $message = 'Config SilverStripe\Dev\Tests\DeprecationTest\DeprecationTestObject.third_config is deprecated.';
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
Config::inst()->get(DeprecationTestObject::class, 'third_config'); Config::inst()->get(DeprecationTestObject::class, 'third_config');
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
@ -268,7 +353,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
Config::modify()->set(DeprecationTestObject::class, 'first_config', 'abc'); Config::modify()->set(DeprecationTestObject::class, 'first_config', 'abc');
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
@ -281,7 +366,7 @@ class DeprecationTest extends SapphireTest
]); ]);
$this->expectException(DeprecationTestException::class); $this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message); $this->expectExceptionMessage($message);
Deprecation::enable(); $this->enableDeprecationNotices();
Config::modify()->merge(DeprecationTestObject::class, 'array_config', ['abc']); Config::modify()->merge(DeprecationTestObject::class, 'array_config', ['abc']);
Deprecation::outputNotices(); Deprecation::outputNotices();
} }
@ -361,7 +446,7 @@ class DeprecationTest extends SapphireTest
switch ($varName) { switch ($varName) {
case 'SS_DEPRECATION_ENABLED': case 'SS_DEPRECATION_ENABLED':
if ($configVal) { if ($configVal) {
Deprecation::enable(); $this->enableDeprecationNotices();
} else { } else {
Deprecation::disable(); Deprecation::disable();
} }
@ -533,7 +618,7 @@ class DeprecationTest extends SapphireTest
private function setEnabledViaStatic(bool $enabled): void private function setEnabledViaStatic(bool $enabled): void
{ {
if ($enabled) { if ($enabled) {
Deprecation::enable(); $this->enableDeprecationNotices();
} else { } else {
Deprecation::disable(); Deprecation::disable();
} }