Fix isXdebugActive if used before instantiation

Author: johnstevenson

src/XdebugHandler.php

@@ -44,6 +44,12 @@ class XdebugHandler
     /** @var bool */
     private static $xdebugActive;
 
+    /** @var string|null */
+    private static $xdebugMode;
+
+    /** @var string|null */
+    private static $xdebugVersion;
+
     /** @var bool */
     private $cli;
 
@@ -56,12 +62,6 @@ class XdebugHandler
     /** @var string */
     private $envOriginalInis;
 
-    /** @var string|null */
-    private $loaded;
-
-    /** @var string|null */
-    private $mode;
-
     /** @var bool */
     private $persistent;
 
@@ -91,13 +91,7 @@ public function __construct(string $envPrefix)
         $this->envAllowXdebug = self::$name.self::SUFFIX_ALLOW;
         $this->envOriginalInis = self::$name.self::SUFFIX_INIS;
 
-        if (extension_loaded('xdebug')) {
-            $version = phpversion('xdebug');
-            $this->loaded = $version !== false ? $version : 'unknown';
-            $this->mode = $this->getXdebugMode($this->loaded);
-        }
-
-        self::$xdebugActive = $this->loaded !== null && $this->mode !== 'off';
+        self::setXdebugDetails();
         self::$inRestart = false;
 
         if ($this->cli = PHP_SAPI === 'cli') {
@@ -143,7 +137,7 @@ public function setPersistent(): self
      */
     public function check(): void
     {
-        $this->notify(Status::CHECK, $this->loaded.'|'.$this->mode);
+        $this->notify(Status::CHECK, self::$xdebugVersion.'|'.self::$xdebugMode);
         $envArgs = explode('|', (string) getenv($this->envAllowXdebug));
 
         if (!((bool) $envArgs[0]) && $this->requiresRestart(self::$xdebugActive)) {
@@ -164,7 +158,7 @@ public function check(): void
             Process::setEnv($this->envAllowXdebug);
             self::$inRestart = true;
 
-            if ($this->loaded === null) {
+            if (self::$xdebugVersion === null) {
                 // Skipped version is only set if Xdebug is not loaded
                 self::$skipped = $envArgs[1];
             }
@@ -256,6 +250,7 @@ public static function getSkippedVersion(): string
      */
     public static function isXdebugActive(): bool
     {
+        self::setXdebugDetails();
         return self::$xdebugActive;
     }
 
@@ -453,7 +448,7 @@ private function setEnvironment(bool $scannedInis, array $iniFiles): bool
         // Flag restarted process and save values for it to use
         $envArgs = [
             self::RESTART_ID,
-            $this->loaded,
+            self::$xdebugVersion,
             (int) $scannedInis,
             false === $scanDir ? '*' : $scanDir,
             false === $phprc ? '*' : $phprc,
@@ -625,34 +620,48 @@ private function tryEnableSignals(): void
     }
 
     /**
-     * Returns the Xdebug mode if available
+     * Sets static properties $xdebugActive, $xdebugVersion and $xdebugMode
      */
-    private function getXdebugMode(string $version): ?string
+    private static function setXdebugDetails(): void
     {
-        if (version_compare($version, '3.1', '>=')) {
+        if (self::$xdebugActive !== null) {
+            return;
+        }
+
+        self::$xdebugActive = false;
+        if (!extension_loaded('xdebug')) {
+            return;
+        }
+
+        $version = phpversion('xdebug');
+        self::$xdebugVersion = $version !== false ? $version : 'unknown';
+
+        if (version_compare(self::$xdebugVersion, '3.1', '>=')) {
             $modes = xdebug_info('mode');
-            return count($modes) === 0 ? 'off' : implode(',', $modes);
+            self::$xdebugMode = count($modes) === 0 ? 'off' : implode(',', $modes);
+            self::$xdebugActive = self::$xdebugMode !== 'off';
+            return;
         }
 
         // See if xdebug.mode is supported in this version
         $iniMode = ini_get('xdebug.mode');
         if ($iniMode === false) {
-            return null;
+            return;
         }
 
         // Environment value wins but cannot be empty
         $envMode = (string) getenv('XDEBUG_MODE');
         if ($envMode !== '') {
-            $mode = $envMode;
+            self::$xdebugMode = $envMode;
         } else {
-            $mode = $iniMode !== '' ? $iniMode : 'off';
+            self::$xdebugMode = $iniMode !== '' ? $iniMode : 'off';
         }
 
         // An empty comma-separated list is treated as mode 'off'
-        if (Preg::isMatch('/^,+$/', str_replace(' ', '', $mode))) {
-            $mode = 'off';
+        if (Preg::isMatch('/^,+$/', str_replace(' ', '', self::$xdebugMode))) {
+            self::$xdebugMode = 'off';
         }
 
-        return $mode;
+        self::$xdebugActive = self::$xdebugMode !== 'off';
     }
 }

tests/Helpers/BaseTestCase.php

@@ -132,7 +132,7 @@ protected function checkRestart(CoreMock $xdebug)
         self::assertArrayHasKey(CoreMock::ORIGINAL_INIS, $_SERVER);
 
         // Skipped version must only be reported if it was unloaded in the restart
-        if (!$xdebug->parentLoaded) {
+        if ($xdebug->parentXdebugVersion === null) {
             // Mocked successful restart without Xdebug
             $version = '';
         } elseif ($xdebug instanceof FailMock) {

tests/Mocks/CoreMock.php

@@ -37,8 +37,8 @@ class CoreMock extends XdebugHandler
     /** @var bool */
     public $restarted;
 
-    /** @var bool */
-    public $parentLoaded;
+    /** @var string|null */
+    public $parentXdebugVersion;
 
     /** @var null|static */
     protected $childProcess;
@@ -81,7 +81,7 @@ public static function createAndCheck($loaded, ?self $parentProcess = null, arra
             // properties on the parent and child
             $parentProcess->restarted = true;
             $xdebug->restarted = true;
-            $xdebug->parentLoaded = $parentProcess->parentLoaded;
+            $xdebug->parentXdebugVersion = $parentProcess->parentXdebugVersion;
 
             // Make the child available
             $parentProcess->childProcess = $xdebug;
@@ -105,15 +105,15 @@ final public function __construct(bool $loaded, ?string $mode)
         parent::__construct('mock');
 
         $this->refClass = new \ReflectionClass('Composer\XdebugHandler\XdebugHandler');
-        $this->parentLoaded = $loaded ? static::TEST_VERSION : null;
+        $this->parentXdebugVersion = $loaded ? static::TEST_VERSION : null;
 
-        // Set private loaded
-        $prop = $this->refClass->getProperty('loaded');
+        // Set private static xdebugVersion
+        $prop = $this->refClass->getProperty('xdebugVersion');
         $prop->setAccessible(true);
-        $prop->setValue($this, $this->parentLoaded);
+        $prop->setValue($this, $this->parentXdebugVersion);
 
-        // Set private mode
-        $prop = $this->refClass->getProperty('mode');
+        // Set private static xdebugMode
+        $prop = $this->refClass->getProperty('xdebugMode');
         $prop->setAccessible(true);
         $prop->setValue($this, $mode);
 
@@ -127,11 +127,6 @@ final public function __construct(bool $loaded, ?string $mode)
         $prop->setAccessible(true);
         $prop->setValue($this, null);
 
-        // Ensure static private inRestart is unset
-        $prop = $this->refClass->getProperty('inRestart');
-        $prop->setAccessible(true);
-        $prop->setValue($this, null);
-
         $this->restarted = false;
     }
 

tests/SettingsTest.php

@@ -76,7 +76,7 @@ public function testSyncSettings(): void
         putenv(CoreMock::ORIGINAL_INIS);
         unset($_SERVER[CoreMock::ORIGINAL_INIS]);
 
-        // Mock not loaded ($inRestart and $skipped statics are unset)
+        // Mock not loaded (static $skipped is unset in mock constructor)
         $loaded = false;
         CoreMock::createAndCheck($loaded);