Merge pull request #14925 from cakephp/deprecation-disable

Add support for ignoring deprecations by path
cakephp · Aug 28, 2020 · e194b11 · e194b11
2 parents fc3e741 + 42e48bf
commit e194b11
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/src/Core/functions.php b/src/Core/functions.php
@@ -292,13 +292,24 @@ function deprecationWarning(string $message, int $stackFrame = 1): void
             $frame = $trace[$stackFrame];
             $frame += ['file' => '[internal]', 'line' => '??'];
 
+            $relative = str_replace(DIRECTORY_SEPARATOR, '/', substr($frame['file'], strlen(ROOT) + 1));
+            $patterns = (array)Configure::read('Error.ignoredDeprecationPaths');
+            foreach ($patterns as $pattern) {
+                $pattern = str_replace(DIRECTORY_SEPARATOR, '/', $pattern);
+                if (fnmatch($pattern, $relative)) {
+                    return;
+                }
+            }
+
             $message = sprintf(
                 '%s - %s, line: %s' . "\n" .
-                ' You can disable deprecation warnings by setting `Error.errorLevel` to' .
-                ' `E_ALL & ~E_USER_DEPRECATED` in your config/app.php.',
+                ' You can disable all deprecation warnings by setting `Error.errorLevel` to' .
+                ' `E_ALL & ~E_USER_DEPRECATED`, or add `%s` to ' .
+                ' `Error.ignoredDeprecationPaths` in your `config/app.php` to mute deprecations from only this file.',
                 $message,
                 $frame['file'],
-                $frame['line']
+                $frame['line'],
+                $relative
             );
         }
 

diff --git a/tests/TestCase/Core/FunctionsTest.php b/tests/TestCase/Core/FunctionsTest.php
@@ -16,6 +16,7 @@
  */
 namespace Cake\Test\TestCase\Core;
 
+use Cake\Core\Configure;
 use Cake\Http\Response;
 use Cake\TestSuite\TestCase;
 
@@ -101,6 +102,21 @@ public function testDeprecationWarningEnabledDefaultFrame()
         });
     }
 
+    /**
+     * Test no error when deprecation matches ignore paths.
+     *
+     * @return void
+     */
+    public function testDeprecationWarningPathDisabled()
+    {
+        $this->expectNotToPerformAssertions();
+
+        Configure::write('Error.ignoredDeprecationPaths', ['src/TestSuite/*']);
+        $this->withErrorReporting(E_ALL, function () {
+            deprecationWarning('This is going away');
+        });
+    }
+
     /**
      * Test no error when deprecated level is off.
      *