API Stop using deprecated API

silverstripe · Nov 2, 2022 · d10acbf · d10acbf
1 parent e454db6
commit d10acbf
Show file tree

Hide file tree

Showing 39 changed files with 100 additions and 117 deletions.
diff --git a/src/Control/Director.php b/src/Control/Director.php
@@ -228,7 +228,7 @@ public static function mockRequest(
             ? $cookies
             : Injector::inst()->createWithArgs(Cookie_Backend::class, [$cookies ?: []]);
         $newVars['_COOKIE'] = $cookieJar->getAll(false);
-        Cookie::config()->update('report_errors', false);
+        Cookie::config()->set('report_errors', false);
         Injector::inst()->registerService($cookieJar, Cookie_Backend::class);
 
         // Backup requirements

diff --git a/src/Control/Middleware/FlushMiddleware.php b/src/Control/Middleware/FlushMiddleware.php
@@ -2,10 +2,12 @@
 
 namespace SilverStripe\Control\Middleware;
 
-use SilverStripe\Control\Director;
 use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Core\BaseKernel;
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Core\Flushable;
+use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Core\Kernel;
 
 /**
  * Triggers a call to flush() on all implementors of Flushable.
@@ -14,7 +16,9 @@ class FlushMiddleware implements HTTPMiddleware
 {
     public function process(HTTPRequest $request, callable $delegate)
     {
-        if (Director::isManifestFlushed()) {
+        /** @var BaseKernel $kernel */
+        $kernel = Injector::inst()->get(Kernel::class);
+        if ((method_exists($kernel, 'isFlushed') && $kernel->isFlushed())) {
             // Disable cache when flushing
             HTTPCacheControlMiddleware::singleton()->disableCache(true);
 

diff --git a/src/Control/Middleware/URLSpecialsMiddleware/FlushScheduler.php b/src/Control/Middleware/URLSpecialsMiddleware/FlushScheduler.php
@@ -2,10 +2,10 @@
 
 namespace SilverStripe\Control\Middleware\URLSpecialsMiddleware;
 
+use SilverStripe\Core\BaseKernel;
 use SilverStripe\Core\Kernel;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Core\Startup\ScheduledFlushDiscoverer;
-use SilverStripe\Control\Director;
 use SilverStripe\Control\HTTPRequest;
 
 /**
@@ -30,11 +30,12 @@ public function scheduleFlush(HTTPRequest $request)
     {
         $flush = array_key_exists('flush', $request->getVars() ?? []) || ($request->getURL() === 'dev/build');
 
-        if (!$flush || Director::isManifestFlushed()) {
+        /** @var BaseKernel $kernel */
+        $kernel = Injector::inst()->get(Kernel::class);
+        if (!$flush || (method_exists($kernel, 'isFlushed') && $kernel->isFlushed())) {
             return false;
         }
 
-        $kernel = Injector::inst()->get(Kernel::class);
         ScheduledFlushDiscoverer::scheduleFlush($kernel);
 
         return true;

diff --git a/src/Control/RSS/RSSFeed.php b/src/Control/RSS/RSSFeed.php
@@ -222,7 +222,7 @@ public function Description()
     public function outputToBrowser()
     {
         $prevState = SSViewer::config()->uninherited('source_file_comments');
-        SSViewer::config()->update('source_file_comments', false);
+        SSViewer::config()->set('source_file_comments', false);
 
         $response = Controller::curr()->getResponse();
 
@@ -236,7 +236,7 @@ public function outputToBrowser()
 
         $response->addHeader("Content-Type", "application/rss+xml; charset=utf-8");
 
-        SSViewer::config()->update('source_file_comments', $prevState);
+        SSViewer::config()->set('source_file_comments', $prevState);
         return $this->renderWith($this->getTemplates());
     }
 

diff --git a/src/Core/BaseKernel.php b/src/Core/BaseKernel.php
@@ -259,12 +259,9 @@ protected function bootErrorHandling()
      * Get the environment type
      *
      * @return string
-     *
-     * @deprecated 4.12.0 Use Director::get_environment_type() instead
      */
     public function getEnvironment()
     {
-        Deprecation::notice('4.12.0', 'Use Director::get_environment_type() instead');
         // Check set
         if ($this->enviroment) {
             return $this->enviroment;
@@ -288,12 +285,9 @@ public function getEnvironment()
      * Check or update any temporary environment specified in the session.
      *
      * @return null|string
-     *
-     * @deprecated 4.12.0 Use Director::get_session_environment_type() instead
      */
     protected function sessionEnvironment()
     {
-        Deprecation::notice('4.12.0', 'Use Director::get_session_environment_type() instead');
         if (!$this->booted) {
             // session is not initialyzed yet, neither is manifest
             return null;

diff --git a/src/Dev/Deprecation.php b/src/Dev/Deprecation.php
@@ -179,7 +179,7 @@ public static function get_enabled()
         // noop
     }
 
-    private static function get_is_enabled(): bool
+    public static function get_is_enabled(): bool
     {
         if (!Director::isDev()) {
             return false;

diff --git a/src/Dev/FunctionalTest.php b/src/Dev/FunctionalTest.php
@@ -115,7 +115,7 @@ protected function setUp(): void
 
             // Disable theme, if necessary
             if (static::get_disable_themes()) {
-                SSViewer::config()->update('theme_enabled', false);
+                SSViewer::config()->set('theme_enabled', false);
             }
 
             // Flush user
@@ -560,7 +560,7 @@ protected function setUp()
 
         // Disable theme, if necessary
         if (static::get_disable_themes()) {
-            SSViewer::config()->update('theme_enabled', false);
+            SSViewer::config()->set('theme_enabled', false);
         }
 
         // Flush user

diff --git a/src/Dev/SapphireTest.php b/src/Dev/SapphireTest.php
@@ -329,7 +329,7 @@ protected function setUp(): void
             }
 
             if (class_exists(Cookie::class)) {
-                Cookie::config()->update('report_errors', false);
+                Cookie::config()->set('report_errors', false);
             }
 
             if (class_exists(RootURLController::class)) {
@@ -356,7 +356,7 @@ protected function setUp(): void
 
             // turn off template debugging
             if (class_exists(SSViewer::class)) {
-                SSViewer::config()->update('source_file_comments', false);
+                SSViewer::config()->set('source_file_comments', false);
             }
 
             // Set up the test mailer
@@ -1206,7 +1206,7 @@ protected function useTestTheme($themeBaseDir, $theme, $callback)
             if (strpos($themeBaseDir ?? '', BASE_PATH) === 0) {
                 $themeBaseDir = substr($themeBaseDir ?? '', strlen(BASE_PATH));
             }
-            SSViewer::config()->update('theme_enabled', true);
+            SSViewer::config()->set('theme_enabled', true);
             SSViewer::set_themes([$themeBaseDir . '/themes/' . $theme, '$default']);
 
             try {
@@ -1649,7 +1649,7 @@ protected function setUp()
         }
 
         if (class_exists(Cookie::class)) {
-            Cookie::config()->update('report_errors', false);
+            Cookie::config()->set('report_errors', false);
         }
 
         if (class_exists(RootURLController::class)) {
@@ -1676,7 +1676,7 @@ protected function setUp()
 
         // turn off template debugging
         if (class_exists(SSViewer::class)) {
-            SSViewer::config()->update('source_file_comments', false);
+            SSViewer::config()->set('source_file_comments', false);
         }
 
         // Set up the test mailer
@@ -2556,7 +2556,7 @@ protected function useTestTheme($themeBaseDir, $theme, $callback)
         if (strpos($themeBaseDir ?? '', BASE_PATH) === 0) {
             $themeBaseDir = substr($themeBaseDir ?? '', strlen(BASE_PATH));
         }
-        SSViewer::config()->update('theme_enabled', true);
+        SSViewer::config()->set('theme_enabled', true);
         SSViewer::set_themes([$themeBaseDir . '/themes/' . $theme, '$default']);
 
         try {

diff --git a/src/Forms/GridField/GridFieldAddExistingAutocompleter.php b/src/Forms/GridField/GridFieldAddExistingAutocompleter.php
@@ -262,7 +262,7 @@ public function doSearch($gridField, $request)
 
         $json = [];
         Config::nest();
-        SSViewer::config()->update('source_file_comments', false);
+        SSViewer::config()->set('source_file_comments', false);
         $viewer = SSViewer::fromString($this->resultsFormat);
         foreach ($results as $result) {
             $title = Convert::html2raw($viewer->process($result));

diff --git a/src/ORM/Connect/DBSchemaManager.php b/src/ORM/Connect/DBSchemaManager.php
@@ -60,12 +60,9 @@ abstract class DBSchemaManager
     /**
      * @param string $table
      * @param string $class
-     *
-     * @deprecated 4.0.1 Will be removed without equivalent functionality
      */
     public static function showTableNameWarning($table, $class)
     {
-        Deprecation::notice('4.0.1', 'Will be removed without equivalent functionality');
         static::$table_name_warnings[$table] = $class;
     }
 

diff --git a/tests/php/Control/ControllerTest.php b/tests/php/Control/ControllerTest.php
@@ -45,7 +45,7 @@ class ControllerTest extends FunctionalTest
     protected function setUp(): void
     {
         parent::setUp();
-        Director::config()->update('alternate_base_url', '/');
+        Director::config()->set('alternate_base_url', '/');
 
         // Add test theme
         $themeDir = substr(__DIR__, strlen(FRAMEWORK_DIR)) . '/ControllerTest/';

diff --git a/tests/php/Control/DirectorTest.php b/tests/php/Control/DirectorTest.php
@@ -16,6 +16,7 @@
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Core\Environment;
 use SilverStripe\Core\Kernel;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\Dev\SapphireTest;
 
 /**
@@ -856,6 +857,9 @@ public function testTestIgnoresHashes()
 
     public function testRequestFilterInDirectorTest()
     {
+        if (Deprecation::get_is_enabled()) {
+            $this->markTestSkipped('Test calls deprecated code');
+        }
         $filter = new DirectorTest\TestRequestFilter;
 
         $processor = new RequestProcessor([$filter]);

diff --git a/tests/php/Control/Email/EmailTest.php b/tests/php/Control/Email/EmailTest.php
@@ -271,7 +271,7 @@ public function testGetSwiftMessage()
 
     public function testSetSwiftMessage()
     {
-        Email::config()->update('admin_email', '[email protected]');
+        Email::config()->set('admin_email', '[email protected]');
         DBDatetime::set_mock_now('2017-01-01 07:00:00');
         $email = new Email();
         $swiftMessage = new Swift_Message();
@@ -294,7 +294,7 @@ public function testSetSwiftMessage()
 
     public function testAdminEmailApplied()
     {
-        Email::config()->update('admin_email', '[email protected]');
+        Email::config()->set('admin_email', '[email protected]');
         $email = new Email();
 
         $this->assertCount(1, $email->getFrom());

diff --git a/tests/php/Control/Email/SwiftMailerTest.php b/tests/php/Control/Email/SwiftMailerTest.php
@@ -21,7 +21,7 @@ public function testSwiftMailer()
         $this->assertEquals($swift, $mailer->getSwiftMailer());
 
         SwiftMailer::config()->remove('swift_plugins');
-        SwiftMailer::config()->update('swift_plugins', [Swift_Plugins_AntiFloodPlugin::class]);
+        SwiftMailer::config()->merge('swift_plugins', [Swift_Plugins_AntiFloodPlugin::class]);
 
         /** @var Swift_MailTransport $transport */
         $transport = $this->getMockBuilder(Swift_MailTransport::class)->getMock();

diff --git a/tests/php/Control/Email/SwiftPluginTest.php b/tests/php/Control/Email/SwiftPluginTest.php
@@ -39,7 +39,7 @@ protected function getMailer()
 
     public function testSendAllEmailsTo()
     {
-        Email::config()->update('send_all_emails_to', '[email protected]');
+        Email::config()->set('send_all_emails_to', '[email protected]');
         $email = $this->getEmail();
         $this->getMailer()->send($email->getSwiftMessage());
         $headers = $email->getSwiftMessage()->getHeaders();
@@ -68,7 +68,7 @@ public function testSendAllEmailsTo()
 
     public function testSendAllEmailsFrom()
     {
-        Email::config()->update('send_all_emails_from', '[email protected]');
+        Email::config()->set('send_all_emails_from', '[email protected]');
         $email = $this->getEmail();
         $this->getMailer()->send($email->getSwiftMessage());
 
@@ -88,7 +88,7 @@ public function testSendAllEmailsFrom()
 
     public function testCCAllEmailsTo()
     {
-        Email::config()->update('cc_all_emails_to', '[email protected]');
+        Email::config()->set('cc_all_emails_to', '[email protected]');
         $email = $this->getEmail();
         $this->getMailer()->send($email->getSwiftMessage());
 
@@ -99,7 +99,7 @@ public function testCCAllEmailsTo()
 
     public function testBCCAllEmailsTo()
     {
-        Email::config()->update('bcc_all_emails_to', '[email protected]');
+        Email::config()->set('bcc_all_emails_to', '[email protected]');
         $email = $this->getEmail();
         $this->getMailer()->send($email->getSwiftMessage());
 

diff --git a/tests/php/Control/HTTPRequestTest.php b/tests/php/Control/HTTPRequestTest.php
@@ -6,6 +6,7 @@
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Control\Middleware\TrustedProxyMiddleware;
 use SilverStripe\Control\Session;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\Dev\SapphireTest;
 
 class HTTPRequestTest extends SapphireTest
@@ -155,12 +156,18 @@ public function detectMethodDataProvider()
      */
     public function testDetectMethod($realMethod, $post, $expected)
     {
+        if (Deprecation::get_is_enabled()) {
+            $this->markTestSkipped('Test calls deprecated code');
+        }
         $actual = HTTPRequest::detect_method($realMethod, $post);
         $this->assertEquals($expected, $actual);
     }
 
     public function testBadDetectMethod()
     {
+        if (Deprecation::get_is_enabled()) {
+            $this->markTestSkipped('Test calls deprecated code');
+        }
         $this->expectException(\InvalidArgumentException::class);
         HTTPRequest::detect_method('POST', ['_method' => 'Boom']);
     }

diff --git a/tests/php/Control/SessionTest.php b/tests/php/Control/SessionTest.php
@@ -107,7 +107,7 @@ public function testStartUsesSecureCookieNameWithHttpsAndCookieSecureOn()
             ->setScheme('https');
         Cookie::set(session_name(), '1234');
         $session = new Session(null); // unstarted session
-        $session->config()->update('cookie_secure', true);
+        $session->config()->set('cookie_secure', true);
         $session->start($req);
         $this->assertEquals(session_name(), $session->config()->get('cookie_name_secure'));
     }
@@ -270,7 +270,7 @@ public function testRequestContainsSessionIdRespectsCookieNameSecure()
             ->setScheme('https');
         $session = new Session(null); // unstarted session
         Cookie::set($session->config()->get('cookie_name_secure'), '1234');
-        $session->config()->update('cookie_secure', true);
+        $session->config()->set('cookie_secure', true);
         $this->assertTrue($session->requestContainsSessionId($req));
     }
 

diff --git a/tests/php/Core/ConvertTest.php b/tests/php/Core/ConvertTest.php
@@ -264,7 +264,7 @@ public function testJSON2Obj()
      */
     public function testRaw2URL()
     {
-        URLSegmentFilter::config()->update('default_allow_multibyte', false);
+        URLSegmentFilter::config()->set('default_allow_multibyte', false);
         $this->assertEquals('foo', Convert::raw2url('foo'));
         $this->assertEquals('foo-and-bar', Convert::raw2url('foo & bar'));
         $this->assertEquals('foo-and-bar', Convert::raw2url('foo &amp; bar!'));

diff --git a/tests/php/Dev/BacktraceTest.php b/tests/php/Dev/BacktraceTest.php
@@ -59,7 +59,7 @@ public function testIgnoredFunctionArgs()
                 'args' => ['myarg' => 'myval']
             ]
         ];
-        Backtrace::config()->update(
+        Backtrace::config()->merge(
             'ignore_function_args',
             [
                 ['MyClass', 'myIgnoredClassFunction'],
@@ -101,7 +101,7 @@ public function testFilteredWildCard()
                 'args' => ['myarg' => 'myval']
             ]
         ];
-        Backtrace::config()->update(
+        Backtrace::config()->merge(
             'ignore_function_args',
             [
                 ['*', 'myIgnoredClassFunction'],

diff --git a/tests/php/Dev/DeprecationTest.php b/tests/php/Dev/DeprecationTest.php
@@ -16,13 +16,16 @@ class DeprecationTest extends SapphireTest
 
     private $oldHandler = null;
 
+    private bool $noticesWereEnabled = false;
+
     protected function setup(): void
     {
         // Use custom error handler for two reasons:
         // - Filter out errors for deprecated class properities unrelated to this unit test
         // - Allow the use of expectDeprecation(), which doesn't work with E_USER_DEPRECATION by default
         //   https://github.com/laminas/laminas-di/pull/30#issuecomment-927585210
         parent::setup();
+        $this->noticesWereEnabled = Deprecation::get_is_enabled();
         $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')) {
@@ -42,7 +45,9 @@ protected function setup(): void
 
     protected function tearDown(): void
     {
-        Deprecation::disable();
+        if (!$this->noticesWereEnabled) {
+            Deprecation::disable();
+        }
         set_error_handler($this->oldHandler);
         $this->oldHandler = null;
         parent::tearDown();