Deprecating the Debug component

yceruto · yceruto · commit b842ad93cc0f · 2019-07-10T10:11:36.000-04:00
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -6,6 +6,12 @@ Cache
 
  * Added argument `$prefix` to `AdapterInterface::clear()`
 
+Debug
+-----
+
+ * Deprecated `FlattenException`, use the `FlattenException` of the `ErrorRenderer` component
+ * Deprecated the whole component in favor of `ErrorHandler` component
+
 DependencyInjection
 -------------------
 
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -51,6 +51,11 @@ Console
    $processHelper->run($output, Process::fromShellCommandline('ls -l'));
    ```
 
+Debug
+-----
+
+ * Removed the component
+
 DependencyInjection
 -------------------
 
diff --git a/src/Symfony/Component/Debug/BufferingLogger.php b/src/Symfony/Component/Debug/BufferingLogger.php
@@ -13,10 +13,14 @@
 
 use Psr\Log\AbstractLogger;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\BufferingLogger" instead.', BufferingLogger::class), E_USER_DEPRECATED);
+
 /**
  * A buffering logger that stacks logs for later.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\BufferingLogger instead.
  */
 class BufferingLogger extends AbstractLogger
 {
diff --git a/src/Symfony/Component/Debug/CHANGELOG.md b/src/Symfony/Component/Debug/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * deprecated `FlattenException`, use the `FlattenException` of the `ErrorRenderer` component
+ * deprecated the whole component in favor of the `ErrorHandler` component
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Debug/Debug.php b/src/Symfony/Component/Debug/Debug.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Debug" instead.', Debug::class), E_USER_DEPRECATED);
+
 /**
  * Registers all the debug tools.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Debug instead.
  */
 class Debug
 {
diff --git a/src/Symfony/Component/Debug/DebugClassLoader.php b/src/Symfony/Component/Debug/DebugClassLoader.php
@@ -13,6 +13,8 @@
 
 use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\DebugClassLoader" instead.', DebugClassLoader::class), E_USER_DEPRECATED);
+
 /**
  * Autoloader checking if the class is really defined in the file found.
  *
@@ -24,6 +26,8 @@
  * @author Christophe Coevoet <stof@notk.org>
  * @author Nicolas Grekas <p@tchwork.com>
  * @author Guilhem Niot <guilhem.niot@gmail.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\DebugClassLoader instead.
  */
 class DebugClassLoader
 {
diff --git a/src/Symfony/Component/Debug/ErrorHandler.php b/src/Symfony/Component/Debug/ErrorHandler.php
@@ -23,6 +23,8 @@
 use Symfony\Component\Debug\FatalErrorHandler\UndefinedFunctionFatalErrorHandler;
 use Symfony\Component\Debug\FatalErrorHandler\UndefinedMethodFatalErrorHandler;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\ErrorHandler" instead.', ErrorHandler::class), E_USER_DEPRECATED);
+
 /**
  * A generic ErrorHandler for the PHP engine.
  *
@@ -47,6 +49,8 @@
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  *
  * @final since Symfony 4.3
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\ErrorHandler instead.
  */
 class ErrorHandler
 {
diff --git a/src/Symfony/Component/Debug/Exception/ClassNotFoundException.php b/src/Symfony/Component/Debug/Exception/ClassNotFoundException.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug\Exception;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Exception\ClassNotFoundException" instead.', ClassNotFoundException::class), E_USER_DEPRECATED);
+
 /**
  * Class (or Trait or Interface) Not Found Exception.
  *
  * @author Konstanton Myakshin <koc-dp@yandex.ru>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception\ClassNotFoundException instead.
  */
 class ClassNotFoundException extends FatalErrorException
 {
diff --git a/src/Symfony/Component/Debug/Exception/FatalErrorException.php b/src/Symfony/Component/Debug/Exception/FatalErrorException.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug\Exception;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Exception\FatalErrorException" instead.', FatalErrorException::class), E_USER_DEPRECATED);
+
 /**
  * Fatal Error Exception.
  *
  * @author Konstanton Myakshin <koc-dp@yandex.ru>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception\FatalErrorException instead.
  */
 class FatalErrorException extends \ErrorException
 {
diff --git a/src/Symfony/Component/Debug/Exception/FatalThrowableError.php b/src/Symfony/Component/Debug/Exception/FatalThrowableError.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug\Exception;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Exception\FatalThrowableError" instead.', FatalThrowableError::class), E_USER_DEPRECATED);
+
 /**
  * Fatal Throwable Error.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception\FatalThrowableError instead.
  */
 class FatalThrowableError extends FatalErrorException
 {
diff --git a/src/Symfony/Component/Debug/Exception/OutOfMemoryException.php b/src/Symfony/Component/Debug/Exception/OutOfMemoryException.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug\Exception;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Exception\OutOfMemoryException" instead.', OutOfMemoryException::class), E_USER_DEPRECATED);
+
 /**
  * Out of memory exception.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception\OutOfMemoryException instead.
  */
 class OutOfMemoryException extends FatalErrorException
 {
diff --git a/src/Symfony/Component/Debug/Exception/SilencedErrorContext.php b/src/Symfony/Component/Debug/Exception/SilencedErrorContext.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug\Exception;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Exception\SilencedErrorContext" instead.', SilencedErrorContext::class), E_USER_DEPRECATED);
+
 /**
  * Data Object that represents a Silenced Error.
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception\SilencedErrorContext instead.
  */
 class SilencedErrorContext implements \JsonSerializable
 {
diff --git a/src/Symfony/Component/Debug/Exception/UndefinedFunctionException.php b/src/Symfony/Component/Debug/Exception/UndefinedFunctionException.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug\Exception;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Exception\UndefinedFunctionException" instead.', UndefinedFunctionException::class), E_USER_DEPRECATED);
+
 /**
  * Undefined Function Exception.
  *
  * @author Konstanton Myakshin <koc-dp@yandex.ru>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception\UndefinedFunctionException instead.
  */
 class UndefinedFunctionException extends FatalErrorException
 {
diff --git a/src/Symfony/Component/Debug/Exception/UndefinedMethodException.php b/src/Symfony/Component/Debug/Exception/UndefinedMethodException.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Debug\Exception;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Exception\UndefinedMethodException" instead.', UndefinedMethodException::class), E_USER_DEPRECATED);
+
 /**
  * Undefined Method Exception.
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception\UndefinedMethodException instead.
  */
 class UndefinedMethodException extends FatalErrorException
 {
diff --git a/src/Symfony/Component/Debug/ExceptionHandler.php b/src/Symfony/Component/Debug/ExceptionHandler.php
@@ -15,6 +15,8 @@
 use Symfony\Component\Debug\Exception\OutOfMemoryException;
 use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\ExceptionHandler" instead.', ExceptionHandler::class), E_USER_DEPRECATED);
+
 /**
  * ExceptionHandler converts an exception to a Response object.
  *
@@ -28,6 +30,8 @@
  * @author Nicolas Grekas <p@tchwork.com>
  *
  * @final since Symfony 4.3
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\ExceptionHandler instead.
  */
 class ExceptionHandler
 {
diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/ClassNotFoundFatalErrorHandler.php b/src/Symfony/Component/Debug/FatalErrorHandler/ClassNotFoundFatalErrorHandler.php
@@ -17,10 +17,14 @@
 use Symfony\Component\Debug\Exception\ClassNotFoundException;
 use Symfony\Component\Debug\Exception\FatalErrorException;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\FatalErrorHandler\ClassNotFoundFatalErrorHandler" instead.', ClassNotFoundFatalErrorHandler::class), E_USER_DEPRECATED);
+
 /**
  * ErrorHandler for classes that do not exist.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\FatalErrorHandler\ClassNotFoundFatalErrorHandler instead.
  */
 class ClassNotFoundFatalErrorHandler implements FatalErrorHandlerInterface
 {
diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/FatalErrorHandlerInterface.php b/src/Symfony/Component/Debug/FatalErrorHandler/FatalErrorHandlerInterface.php
@@ -13,10 +13,14 @@
 
 use Symfony\Component\Debug\Exception\FatalErrorException;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\FatalErrorHandler\FatalErrorHandlerInterface" instead.', FatalErrorHandlerInterface::class), E_USER_DEPRECATED);
+
 /**
  * Attempts to convert fatal errors to exceptions.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\FatalErrorHandler\FatalErrorHandlerInterface instead.
  */
 interface FatalErrorHandlerInterface
 {
diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedFunctionFatalErrorHandler.php b/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedFunctionFatalErrorHandler.php
@@ -14,10 +14,14 @@
 use Symfony\Component\Debug\Exception\FatalErrorException;
 use Symfony\Component\Debug\Exception\UndefinedFunctionException;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\FatalErrorHandler\UndefinedFunctionFatalErrorHandler" instead.', UndefinedFunctionFatalErrorHandler::class), E_USER_DEPRECATED);
+
 /**
  * ErrorHandler for undefined functions.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\FatalErrorHandler\UndefinedFunctionFatalErrorHandler instead.
  */
 class UndefinedFunctionFatalErrorHandler implements FatalErrorHandlerInterface
 {
diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedMethodFatalErrorHandler.php b/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedMethodFatalErrorHandler.php
@@ -14,10 +14,14 @@
 use Symfony\Component\Debug\Exception\FatalErrorException;
 use Symfony\Component\Debug\Exception\UndefinedMethodException;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\FatalErrorHandler\UndefinedMethodFatalErrorHandler" instead.', UndefinedMethodFatalErrorHandler::class), E_USER_DEPRECATED);
+
 /**
  * ErrorHandler for undefined methods.
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\FatalErrorHandler\UndefinedMethodFatalErrorHandler instead.
  */
 class UndefinedMethodFatalErrorHandler implements FatalErrorHandlerInterface
 {
diff --git a/src/Symfony/Component/Debug/Tests/DebugClassLoaderTest.php b/src/Symfony/Component/Debug/Tests/DebugClassLoaderTest.php
@@ -14,6 +14,9 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Debug\DebugClassLoader;
 
+/**
+ * @group legacy
+ */
 class DebugClassLoaderTest extends TestCase
 {
     /**
diff --git a/src/Symfony/Component/Debug/Tests/ErrorHandlerTest.php b/src/Symfony/Component/Debug/Tests/ErrorHandlerTest.php
@@ -25,6 +25,8 @@
  *
  * @author Robert Schönthal <seroscho@googlemail.com>
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @group legacy
  */
 class ErrorHandlerTest extends TestCase
 {
diff --git a/src/Symfony/Component/Debug/Tests/ExceptionHandlerTest.php b/src/Symfony/Component/Debug/Tests/ExceptionHandlerTest.php
@@ -19,6 +19,9 @@
 
 require_once __DIR__.'/HeaderMock.php';
 
+/**
+ * @group legacy
+ */
 class ExceptionHandlerTest extends TestCase
 {
     protected function setUp()
diff --git a/src/Symfony/Component/Debug/Tests/FatalErrorHandler/ClassNotFoundFatalErrorHandlerTest.php b/src/Symfony/Component/Debug/Tests/FatalErrorHandler/ClassNotFoundFatalErrorHandlerTest.php
@@ -17,6 +17,9 @@
 use Symfony\Component\Debug\Exception\FatalErrorException;
 use Symfony\Component\Debug\FatalErrorHandler\ClassNotFoundFatalErrorHandler;
 
+/**
+ * @group legacy
+ */
 class ClassNotFoundFatalErrorHandlerTest extends TestCase
 {
     public static function setUpBeforeClass()
diff --git a/src/Symfony/Component/Debug/Tests/FatalErrorHandler/UndefinedFunctionFatalErrorHandlerTest.php b/src/Symfony/Component/Debug/Tests/FatalErrorHandler/UndefinedFunctionFatalErrorHandlerTest.php
@@ -15,6 +15,9 @@
 use Symfony\Component\Debug\Exception\FatalErrorException;
 use Symfony\Component\Debug\FatalErrorHandler\UndefinedFunctionFatalErrorHandler;
 
+/**
+ * @group legacy
+ */
 class UndefinedFunctionFatalErrorHandlerTest extends TestCase
 {
     /**
diff --git a/src/Symfony/Component/Debug/Tests/FatalErrorHandler/UndefinedMethodFatalErrorHandlerTest.php b/src/Symfony/Component/Debug/Tests/FatalErrorHandler/UndefinedMethodFatalErrorHandlerTest.php
@@ -15,6 +15,9 @@
 use Symfony\Component\Debug\Exception\FatalErrorException;
 use Symfony\Component\Debug\FatalErrorHandler\UndefinedMethodFatalErrorHandler;
 
+/**
+ * @group legacy
+ */
 class UndefinedMethodFatalErrorHandlerTest extends TestCase
 {
     /**
diff --git a/src/Symfony/Component/Debug/Tests/phpt/debug_class_loader.phpt b/src/Symfony/Component/Debug/Tests/phpt/debug_class_loader.phpt
@@ -23,5 +23,6 @@ class_exists(ExtendedFinalMethod::class);
 
 ?>
 --EXPECTF--
+%A
 The "Symfony\Component\Debug\Tests\Fixtures\FinalMethod::finalMethod()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Symfony\Component\Debug\Tests\Fixtures\ExtendedFinalMethod".
 The "Symfony\Component\Debug\Tests\Fixtures\FinalMethod::finalMethod2()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Symfony\Component\Debug\Tests\Fixtures\ExtendedFinalMethod".
diff --git a/src/Symfony/Component/Debug/Tests/phpt/decorate_exception_hander.phpt b/src/Symfony/Component/Debug/Tests/phpt/decorate_exception_hander.phpt
@@ -26,6 +26,7 @@ if (true) {
 
 ?>
 --EXPECTF--
+%A
 object(Symfony\Component\Debug\Exception\ClassNotFoundException)#%d (8) {
   ["message":protected]=>
   string(131) "Attempted to load class "missing" from namespace "Symfony\Component\Debug".
diff --git a/src/Symfony/Component/Debug/Tests/phpt/fatal_with_nested_handlers.phpt b/src/Symfony/Component/Debug/Tests/phpt/fatal_with_nested_handlers.phpt
@@ -35,6 +35,7 @@ array(1) {
   [0]=>
   string(37) "Error and exception handlers do match"
 }
+%A
 object(Symfony\Component\Debug\Exception\FatalErrorException)#%d (%d) {
   ["message":protected]=>
   string(179) "Error: Class Symfony\Component\Debug\Broken contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (JsonSerializable::jsonSerialize)"
diff --git a/src/Symfony/Component/ErrorHandler/Tests/FatalErrorHandler/ClassNotFoundFatalErrorHandlerTest.php b/src/Symfony/Component/ErrorHandler/Tests/FatalErrorHandler/ClassNotFoundFatalErrorHandlerTest.php
@@ -40,6 +40,10 @@ public static function setUpBeforeClass()
 
     /**
      * @dataProvider provideClassNotFoundData
+     *
+     * Remove only the "@group" annotation in 5.0 when the Debug component is gone.
+     *
+     * @group legacy
      */
     public function testHandleClassNotFound($error, $translatedMessage, $autoloader = null)
     {

Original file line number	Diff line number	Diff line change
`@@ -13,10 +13,14 @@`
`13`	`13`
`14`	`14`	`use Psr\Log\AbstractLogger;`
`15`	`15`
	`16`	`+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\BufferingLogger" instead.', BufferingLogger::class), E_USER_DEPRECATED);`
	`17`	`+`
`16`	`18`	`/**`
`17`	`19`	`* A buffering logger that stacks logs for later.`
`18`	`20`	`*`
`19`	`21`	`* @author Nicolas Grekas <p@tchwork.com>`
	`22`	`+ *`
	`23`	`+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\BufferingLogger instead.`
`20`	`24`	`*/`
`21`	`25`	`class BufferingLogger extends AbstractLogger`
`22`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,14 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Debug;`
`13`	`13`
	`14`	`+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\Debug" instead.', Debug::class), E_USER_DEPRECATED);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Registers all the debug tools.`
`16`	`18`	`*`
`17`	`19`	`* @author Fabien Potencier <fabien@symfony.com>`
	`20`	`+ *`
	`21`	`+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Debug instead.`
`18`	`22`	`*/`
`19`	`23`	`class Debug`
`20`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`	`use Symfony\Component\Debug\FatalErrorHandler\UndefinedFunctionFatalErrorHandler;`
`24`	`24`	`use Symfony\Component\Debug\FatalErrorHandler\UndefinedMethodFatalErrorHandler;`
`25`	`25`
	`26`	`+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "Symfony\Component\ErrorHandler\ErrorHandler" instead.', ErrorHandler::class), E_USER_DEPRECATED);`
	`27`	`+`
`26`	`28`	`/**`
`27`	`29`	`* A generic ErrorHandler for the PHP engine.`
`28`	`30`	`*`
`@@ -47,6 +49,8 @@`
`47`	`49`	`* @author Grégoire Pineau <lyrixx@lyrixx.info>`
`48`	`50`	`*`
`49`	`51`	`* @final since Symfony 4.3`
	`52`	`+ *`
	`53`	`+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\ErrorHandler instead.`
`50`	`54`	`*/`
`51`	`55`	`class ErrorHandler`
`52`	`56`	`{`