1
0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00

Compare commits

...

10 Commits

Author SHA1 Message Date
Steve Boyd
751c1fb87d
Merge b5fee199c8 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 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 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 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
Steve Boyd
b5fee199c8 NEW Give feedback of password strength 2024-10-04 15:39:19 +13:00
13 changed files with 383 additions and 31 deletions

View File

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

View File

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

View File

@ -3,11 +3,14 @@
namespace SilverStripe\Dev;
use BadMethodCallException;
use RuntimeException;
use SilverStripe\Control\Director;
use SilverStripe\Core\Environment;
use SilverStripe\Core\Injector\InjectionCreator;
use SilverStripe\Core\Injector\InjectorLoader;
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.
@ -77,6 +80,18 @@ class Deprecation
*/
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
* deprecated code which is called by core Silverstripe modules.
@ -146,6 +161,12 @@ class Deprecation
if (!$level) {
$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;
// handle closures inside withSuppressedNotice()
if (Deprecation::$insideNoticeSuppression
@ -163,8 +184,51 @@ class Deprecation
if ($level == 4 && ($backtrace[$newLevel]['class'] ?? '') === InjectionCreator::class) {
$newLevel = $newLevel + 4;
}
// handle noticeWithNoReplacment()
foreach ($backtrace as $trace) {
if (($trace['class'] ?? '') === Deprecation::class
&& ($trace['function'] ?? '') === 'noticeWithNoReplacment'
) {
$newLevel = $newLevel + 1;
break;
}
}
$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
@ -245,6 +309,22 @@ class Deprecation
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
{
if (!Deprecation::isEnabled()) {
@ -258,9 +338,13 @@ class Deprecation
$arr = array_shift(Deprecation::$userErrorMessageBuffer);
$message = $arr['message'];
$calledWithNoticeSuppression = $arr['calledWithNoticeSuppression'];
$isCalledFromSupportedCode = $arr['isCalledFromSupportedCode'];
if ($calledWithNoticeSuppression && !Deprecation::$showNoReplacementNotices) {
continue;
}
if ($isCalledFromSupportedCode && !Deprecation::$showNoticesCalledFromSupportedCode) {
continue;
}
Deprecation::$isTriggeringError = true;
user_error($message, E_USER_DEPRECATED);
Deprecation::$isTriggeringError = false;
@ -294,6 +378,10 @@ class Deprecation
$data = [
'key' => sha1($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
];
} else {
@ -322,13 +410,13 @@ class Deprecation
$level = Deprecation::$insideNoticeSuppression ? 4 : 2;
$string .= " Called from " . Deprecation::get_called_method_from_trace($backtrace, $level) . '.';
if ($caller) {
$string = $caller . ' is deprecated.' . ($string ? ' ' . $string : '');
}
$data = [
'key' => sha1($string),
'message' => $string,
'isCalledFromSupportedCode' => Deprecation::isCalledFromSupportedCode($backtrace),
'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
{
if (is_string($val)) {

View File

@ -10,8 +10,13 @@ use SilverStripe\Security\Authenticator;
use SilverStripe\Security\Security;
use SilverStripe\View\HTML;
use Closure;
use SilverStripe\Control\HTTP;
use SilverStripe\Core\Validation\ConstraintValidator;
use Symfony\Component\Validator\Constraints\PasswordStrength;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Security\Validation\PasswordValidator;
/**
* Two masked input fields, checks for matching passwords.
@ -24,6 +29,9 @@ use Symfony\Component\Validator\Constraints\PasswordStrength;
*/
class ConfirmedPasswordField extends FormField
{
private static $allowed_actions = [
'strength',
];
/**
* Minimum character length of the password.
@ -106,6 +114,8 @@ class ConfirmedPasswordField extends FormField
protected ?PasswordField $passwordField;
protected ?LiteralField $passwordStrengthField;
protected ?PasswordField $confirmPasswordfield;
protected ?HiddenField $hiddenField = null;
@ -132,6 +142,10 @@ class ConfirmedPasswordField extends FormField
"{$name}[_Password]",
$title
),
$this->passwordStrengthField = LiteralField::create(
"{$name}[_PasswordStrength]",
'<div class="passwordstrength"></div>'
),
$this->confirmPasswordfield = PasswordField::create(
"{$name}[_ConfirmPassword]",
(isset($titleConfirmField)) ? $titleConfirmField : _t('SilverStripe\\Security\\Member.CONFIRMPASSWORD', 'Confirm Password')
@ -154,6 +168,50 @@ class ConfirmedPasswordField extends FormField
$this->setValue($value);
}
/**
* Provides feedback for the current and required level of password strength
*/
public function strength(HTTPRequest $request): HTTPResponse
{
$response = HTTPResponse::create();
$json = json_decode($request->getBody(), true);
if (!$json || !array_key_exists('password', $json) || !$request->isPOST()) {
$response->setStatusCode(400);
return $response;
}
$password = $json['password'];
$validator = PasswordValidator::create();
if ($this->getRequireStrongPassword()) {
$requiredStrength = $this->getMinPasswordStrength();
} else {
$requiredStrength = $validator->getRequiredStrength();
}
$requiredLevel = $validator->getStrengthLevel($requiredStrength);
$passwordStrength = $validator->evaluateStrength($password);
$passwordLevel = $validator->getStrengthLevel($passwordStrength);
if ($passwordStrength < $requiredStrength) {
$valid = false;
$message = _t(
__CLASS__ . '.STRENGTH',
'Password strength is {passwordLevel}, must be at least {requiredLevel}',
['passwordLevel' => $passwordLevel, 'requiredLevel' => $requiredLevel]
);
} else {
$valid = true;
$message = _t(
__CLASS__ . '.STRENGTH',
'Password strength is {passwordLevel}',
['passwordLevel' => $passwordLevel]
);
}
$body = json_encode((object) [
'valid' => $valid,
'message' => $message,
]);
$response->setBody($body);
return $response;
}
public function Title()
{
// Title is displayed on nested field, not on the top level field
@ -173,6 +231,7 @@ class ConfirmedPasswordField extends FormField
*/
public function Field($properties = [])
{
$canEvaluateStrength = PasswordValidator::singleton()->canEvaluateStrength();
// Build inner content
$fieldContent = '';
foreach ($this->getChildren() as $field) {
@ -184,6 +243,9 @@ class ConfirmedPasswordField extends FormField
$field->setAttribute($name, $value);
}
}
if ($canEvaluateStrength && is_a($field, PasswordField::class)) {
$field->setAttribute('data-strengthurl', $this->Link('strength'));
}
$fieldContent .= $field->FieldHolder(['AttributesHTML' => $this->getAttributesHTMLForChild($field)]);
}

View File

@ -2,6 +2,12 @@
namespace SilverStripe\Forms;
use SilverStripe\Control\Director;
use SilverStripe\Security\Security;
use SilverStripe\Security\Validation\PasswordValidator;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
/**
* Password input field.
*/

View File

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

View File

@ -15,7 +15,8 @@ class DBBoolean extends DBField
{
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);
}
@ -27,7 +28,7 @@ class DBBoolean extends DBField
'precision' => 1,
'sign' => 'unsigned',
'null' => 'not null',
'default' => $this->defaultVal,
'default' => $this->getDefaultValue(),
'arrayValue' => $this->arrayValue
];
$values = ['type' => 'boolean', 'parts' => $parts];

View File

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

View File

@ -13,7 +13,8 @@ class DBFloat extends DBField
{
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);
}
@ -23,7 +24,7 @@ class DBFloat extends DBField
$parts = [
'datatype' => 'float',
'null' => 'not null',
'default' => $this->defaultVal,
'default' => $this->getDefaultValue(),
'arrayValue' => $this->arrayValue
];
$values = ['type' => 'float', 'parts' => $parts];

View File

@ -16,7 +16,8 @@ class DBInt extends DBField
{
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);
}
@ -44,7 +45,7 @@ class DBInt extends DBField
'datatype' => 'int',
'precision' => 11,
'null' => 'not null',
'default' => $this->defaultVal,
'default' => $this->getDefaultValue(),
'arrayValue' => $this->arrayValue
];
$values = ['type' => 'int', 'parts' => $parts];

View File

@ -20,7 +20,7 @@ class EntropyPasswordValidator extends PasswordValidator
* The strength of a valid password.
* See https://symfony.com/doc/current/reference/constraints/PasswordStrength.html#minscore
*/
private static int $password_strength = PasswordStrength::STRENGTH_STRONG;
private static int $password_strength = PasswordStrength::STRENGTH_MEDIUM;
public function validate(string $password, Member $member): ValidationResult
{
@ -30,4 +30,35 @@ class EntropyPasswordValidator extends PasswordValidator
$this->extend('updateValidatePassword', $password, $member, $result, $this);
return $result;
}
public function getRequiredStrength(): int
{
return static::config()->get('password_strength');
}
public function canEvaluateStrength(): bool
{
return true;
}
public function evaluateStrength(string $password): int
{
$strengths = [
PasswordStrength::STRENGTH_WEAK,
PasswordStrength::STRENGTH_MEDIUM,
PasswordStrength::STRENGTH_STRONG,
PasswordStrength::STRENGTH_VERY_STRONG,
];
// STRENGTH_VERY_WEAK is not validatable, it's just the default value
$lastPassedStrength = PasswordStrength::STRENGTH_VERY_WEAK;
foreach ($strengths as $strength) {
$result = ConstraintValidator::validate($password, new PasswordStrength(minScore: $strength));
if ($result->isValid()) {
$lastPassedStrength = $strength;
} else {
break;
}
}
return $lastPassedStrength;
}
}

View File

@ -8,6 +8,7 @@ use SilverStripe\ORM\DataObject;
use SilverStripe\Core\Validation\ValidationResult;
use SilverStripe\Security\Member;
use SilverStripe\Security\MemberPassword;
use Symfony\Component\Validator\Constraints\PasswordStrength;
/**
* Abstract validator with functionality for checking for reusing old passwords.
@ -69,4 +70,63 @@ abstract class PasswordValidator
$this->historicalPasswordCount = $count;
return $this;
}
/**
* Get the required strength of a password based on the consts in
* Symfony\Component\Validator\Constraints\PasswordStrength
* Default return -1 for validators that do not support this
*
*/
public function getRequiredStrength(): int
{
return -1;
}
/**
* Check if this validator can evaluate password strength.
*/
public function canEvaluateStrength(): bool
{
return false;
}
/**
* Evaluate the strength of a password based on the consts in
* Symfony\Component\Validator\Constraints\PasswordStrength
* Default return -1 for validators that do not support this
*/
public function evaluateStrength(string $password): int
{
return -1;
}
/**
* Textual representation of an evaluated password strength
*/
public static function getStrengthLevel(int $strength): string
{
return match ($strength) {
PasswordStrength::STRENGTH_VERY_WEAK => _t(
PasswordValidator::class . '.VERYWEAK',
'very weak'
),
PasswordStrength::STRENGTH_WEAK => _t(
PasswordValidator::class . '.WEAK',
'weak'
),
PasswordStrength::STRENGTH_MEDIUM => _t(
PasswordValidator::class . '.MEDIUM',
'medium'
),
PasswordStrength::STRENGTH_STRONG => _t(
PasswordValidator::class . '.STRONG',
'strong'
),
PasswordStrength::STRENGTH_VERY_STRONG => _t(
PasswordValidator::class . '.VERYSTRONG',
'very strong'
),
default => '',
};
}
}

View File

@ -26,6 +26,8 @@ class DeprecationTest extends SapphireTest
private bool $noticesWereEnabled = false;
private bool $showSupportedNoticesWasEnabled = false;
protected function setup(): void
{
// 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
parent::setup();
$this->noticesWereEnabled = Deprecation::isEnabled();
$this->showSupportedNoticesWasEnabled = Deprecation::getShowNoticesCalledFromSupportedCode();
$this->oldHandler = set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline) {
if ($errno === E_USER_DEPRECATED) {
if (str_contains($errstr, 'SilverStripe\\Dev\\Tests\\DeprecationTest')) {
@ -49,6 +52,8 @@ class DeprecationTest extends SapphireTest
// Fallback to default PHP error handler
return false;
});
// This is required to clear out the notice from instantiating DeprecationTestObject in TableBuilder::buildTables().
Deprecation::outputNotices();
}
protected function tearDown(): void
@ -58,6 +63,7 @@ class DeprecationTest extends SapphireTest
} else {
Deprecation::disable();
}
Deprecation::setShowNoticesCalledFromSupportedCode($this->showSupportedNoticesWasEnabled);
restore_error_handler();
$this->oldHandler = null;
parent::tearDown();
@ -69,6 +75,18 @@ class DeprecationTest extends SapphireTest
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()
{
$message = implode(' ', [
@ -78,7 +96,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
$ret = $this->myDeprecatedMethod();
$this->assertSame('abc', $ret);
// call outputNotices() directly because the regular shutdown function that emits
@ -86,6 +104,29 @@ class DeprecationTest extends SapphireTest
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()
{
$message = implode(' ', [
@ -95,7 +136,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
$ret = call_user_func([$this, 'myDeprecatedMethod']);
$this->assertSame('abc', $ret);
Deprecation::outputNotices();
@ -110,7 +151,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
$ret = call_user_func_array([$this, 'myDeprecatedMethod'], []);
$this->assertSame('abc', $ret);
Deprecation::outputNotices();
@ -118,7 +159,7 @@ class DeprecationTest extends SapphireTest
public function testwithSuppressedNoticeDefault()
{
Deprecation::enable();
$this->enableDeprecationNotices();
$ret = Deprecation::withSuppressedNotice(function () {
return $this->myDeprecatedMethod();
});
@ -135,7 +176,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable(true);
$this->enableDeprecationNotices(true);
$ret = Deprecation::withSuppressedNotice(function () {
return $this->myDeprecatedMethod();
});
@ -152,7 +193,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable(true);
$this->enableDeprecationNotices(true);
$ret = Deprecation::withSuppressedNotice(function () {
return call_user_func([$this, 'myDeprecatedMethod']);
});
@ -169,7 +210,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable(true);
$this->enableDeprecationNotices(true);
Deprecation::withSuppressedNotice(function () {
Deprecation::notice('123', 'My message.');
});
@ -185,7 +226,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable(true);
$this->enableDeprecationNotices(true);
// using this syntax because my IDE was complaining about DeprecationTestObject not existing
// when trying to use `new DeprecationTestObject();`
$class = DeprecationTestObject::class;
@ -202,7 +243,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable(true);
$this->enableDeprecationNotices(true);
Injector::inst()->get(DeprecationTestObject::class);
Deprecation::outputNotices();
}
@ -218,6 +259,50 @@ class DeprecationTest extends SapphireTest
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
// 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.
@ -232,7 +317,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
Config::inst()->get(DeprecationTestObject::class, 'first_config');
Deprecation::outputNotices();
}
@ -245,7 +330,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
Config::inst()->get(DeprecationTestObject::class, 'second_config');
Deprecation::outputNotices();
}
@ -255,7 +340,7 @@ class DeprecationTest extends SapphireTest
$message = 'Config SilverStripe\Dev\Tests\DeprecationTest\DeprecationTestObject.third_config is deprecated.';
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
Config::inst()->get(DeprecationTestObject::class, 'third_config');
Deprecation::outputNotices();
}
@ -268,7 +353,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
Config::modify()->set(DeprecationTestObject::class, 'first_config', 'abc');
Deprecation::outputNotices();
}
@ -281,7 +366,7 @@ class DeprecationTest extends SapphireTest
]);
$this->expectException(DeprecationTestException::class);
$this->expectExceptionMessage($message);
Deprecation::enable();
$this->enableDeprecationNotices();
Config::modify()->merge(DeprecationTestObject::class, 'array_config', ['abc']);
Deprecation::outputNotices();
}
@ -361,7 +446,7 @@ class DeprecationTest extends SapphireTest
switch ($varName) {
case 'SS_DEPRECATION_ENABLED':
if ($configVal) {
Deprecation::enable();
$this->enableDeprecationNotices();
} else {
Deprecation::disable();
}
@ -533,7 +618,7 @@ class DeprecationTest extends SapphireTest
private function setEnabledViaStatic(bool $enabled): void
{
if ($enabled) {
Deprecation::enable();
$this->enableDeprecationNotices();
} else {
Deprecation::disable();
}