Add auto-detection of debug mode

contributte · Jan 6, 2025 · d7d5fcf · d7d5fcf
1 parent 715f358
commit d7d5fcf
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 7 deletions.
diff --git a/.docs/README.md b/.docs/README.md
@@ -33,6 +33,8 @@ extensions:
   nettrine.dbal: Nettrine\DBAL\DI\DbalExtension
 ```
 
+Debug mode can be passed in extension constructor `DbalExtension(%debugMode%)`, but it's optional and determined automatically from `Tracy\Debugger::$productionMode`.
+
 > [!NOTE]
 > This is just **DBAL**, for **ORM** please use [nettrine/orm](https://github.com/contributte/doctrine-orm).
 
@@ -85,7 +87,7 @@ Here is the list of all available options with their types.
  ```neon
 nettrine.dbal:
   debug:
-    panel: <boolean>
+    panel: <boolean> # optional, it's determined automatically or passed to constructor when extension is registered
 
   types: array<string, class-string>
   typesMapping: array<string, class-string>

diff --git a/src/DI/DbalExtension.php b/src/DI/DbalExtension.php
@@ -13,6 +13,7 @@
 use Nettrine\DBAL\DI\Pass\ConsolePass;
 use Nettrine\DBAL\DI\Pass\DoctrinePass;
 use stdClass;
+use Tracy\Debugger;
 
 /**
  * @property-read stdClass $config
@@ -79,8 +80,14 @@ class DbalExtension extends CompilerExtension
 	/** @var AbstractPass[] */
 	protected array $passes = [];
 
-	public function __construct()
+	public function __construct(
+		private ?bool $debugMode = null
+	)
 	{
+		if ($this->debugMode === null) {
+			$this->debugMode = class_exists(Debugger::class) && Debugger::$productionMode === false;
+		}
+
 		$this->passes[] = new DoctrinePass($this);
 		$this->passes[] = new ConsolePass($this);
 		$this->passes[] = new ConnectionPass($this);
@@ -107,7 +114,7 @@ public function getConfigSchema(): Schema
 
 		return Expect::structure([
 			'debug' => Expect::structure([
-				'panel' => Expect::bool(false),
+				'panel' => Expect::bool($this->debugMode),
 				'sourcePaths' => Expect::arrayOf('string'),
 			]),
 			'types' => Expect::arrayOf('string', 'string'),

diff --git a/tests/Cases/DI/DbalExtension.debugMode.phpt b/tests/Cases/DI/DbalExtension.debugMode.phpt
@@ -16,10 +16,36 @@ use Tracy\Debugger;
 
 require_once __DIR__ . '/../../bootstrap.php';
 
-// Debug mode
+// Disabled debug mode
 Toolkit::test(function (): void {
 	$container = ContainerBuilder::of()
 		->withCompiler(static function (Compiler $compiler): void {
+			$compiler->addExtension('nettrine.dbal', new DbalExtension());
+			$compiler->addExtension('nette.tracy', new TracyExtension());
+			$compiler->addConfig(Neonkit::load(<<<'NEON'
+				nettrine.dbal:
+					connections:
+						default:
+							driver: pdo_sqlite
+							password: test
+							user: test
+							path: ":memory:"
+			NEON
+			));
+		})->build();
+
+	$container->getByName('nettrine.dbal.connections.default.connection');
+	$blueScreen = Debugger::getBlueScreen();
+	$panels = Liberator::of($blueScreen)->panels;
+
+	Assert::count(0, $panels);
+});
+
+// Debug mode auto-detection from Tracy/Debugger with multiple panels
+Toolkit::test(function (): void {
+	$container = ContainerBuilder::of()
+		->withCompiler(static function (Compiler $compiler): void {
+			Debugger::$productionMode = false;
 			$compiler->addExtension('nettrine.dbal', new DbalExtension());
 			$compiler->addExtension('nette.tracy', new TracyExtension());
 			$compiler->addConfig(Neonkit::load(<<<'NEON'
@@ -36,10 +62,9 @@ Toolkit::test(function (): void {
 							password: test
 							user: test
 							path: ":memory:"
-					debug:
-						panel: true
 			NEON
 			));
+			Debugger::$productionMode = null;
 		})->build();
 
 	$container->getByName('nettrine.dbal.connections.default.connection');
@@ -50,7 +75,32 @@ Toolkit::test(function (): void {
 	Assert::count(2, $panels);
 });
 
-// Debug mode
+// Debug mode passed via constructor
+Toolkit::test(function (): void {
+	$container = ContainerBuilder::of()
+		->withCompiler(static function (Compiler $compiler): void {
+			$compiler->addExtension('nettrine.dbal', new DbalExtension(true));
+			$compiler->addExtension('nette.tracy', new TracyExtension());
+			$compiler->addConfig(Neonkit::load(<<<'NEON'
+				nettrine.dbal:
+					connections:
+						default:
+							driver: pdo_sqlite
+							password: test
+							user: test
+							path: ":memory:"
+			NEON
+			));
+		})->build();
+
+	$container->getByName('nettrine.dbal.connections.default.connection');
+	$blueScreen = Debugger::getBlueScreen();
+	$panels = Liberator::of($blueScreen)->panels;
+
+	Assert::count(3, $panels); // 2 are from previous test
+});
+
+// Debug mode defined in debug.panel, testing DebugStack middleware
 Toolkit::test(function (): void {
 	$container = ContainerBuilder::of()
 		->withCompiler(static function (Compiler $compiler): void {