Disable xdebug (phpactor#408)

* Disable XDebug

* Execute new process in benchmarking tests

* Rebased

* Allow XDebug to be disabled in configuration

* Use tagged xdebug handler

* Updated doc

* Allow XDebug when running PHPUnit

Author: dantleech

CHANGELOG.md

@@ -3,6 +3,11 @@ Changelog
 
 ## Unreleased
 
+Features:
+
+    - [Application] Disable XDebug by default, very much improve performance.
+      Fixes #317
+
 Improvements:
 
     - [Completion] Do not evaluate left operand when completing expression,

bin/phpactor

@@ -5,6 +5,7 @@ use Symfony\Component\Debug\Debug;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Phpactor\Application;
+use Composer\XdebugHandler\XdebugHandler;
 
 foreach ([
     __DIR__ . '/../../../autoload.php',

composer.json

@@ -17,7 +17,8 @@
         "symfony/yaml": "^3.3",
         "microsoft/tolerant-php-parser": "dev-master",
         "monolog/monolog": "^2.0@dev",
-        "phpactor/completion": "^1.0@dev"
+        "phpactor/completion": "^1.0@dev",
+        "composer/xdebug-handler": "^1.1"
     },
     "config": {
         "platform": {

composer.lock

@@ -51,8 +51,8 @@ path. The autoloader helps Phpactor locate classes.
 
 *Default*: `true`
 
-By default Phpactor will deregister the included autoloader to prevent
 any potential conflicts. However, some autoloaders may add global dependencies
+By default Phpactor will deregister the included autoloader to prevent
 on the code available through that autoloader (e.g. Drupal). In such cases
 set this to `false` and hope that everything is *fine*.
 
@@ -86,6 +86,13 @@ The default logging level.
 
 Where the log file is
 
+#### xdebug_disable
+
+*Default*: `true`
+
+Disable XDebug if it's enabled. This can (likely will) have a very positive
+effect on performance.
+
 ### Code Transform Extension
 
 #### code_transform.class_new.variants

doc/configuration.md

@@ -39,6 +39,12 @@ public function check(): array
             $diagnostics['bad'][] = 'Git not detected. Some operations which would have been better scoped to your project repository will now include vendor paths.';
         }
 
+        if (extension_loaded('xdebug')) {
+            $diagnostics['bad'][] = 'XDebug is enabled. XDebug has a negative effect on performance.';
+        } else {
+            $diagnostics['good'][] = 'XDebug is disabled. XDebug has a negative effect on performance.';
+        }
+
         return $diagnostics;
     }
 }

lib/Extension/Core/Application/Status.php

@@ -39,6 +39,7 @@ class CoreExtension implements Extension
     const LOGGING_ENABLED = 'logging.enabled';
     const LOGGING_FINGERS_CROSSED = 'logging.fingers_crossed';
     const AUTOLOAD_DEREGISTER = 'autoload.deregister';
+    const XDEBUG_DISABLE = 'xdebug_disable';
 
     public static $autoloader;
 
@@ -54,6 +55,7 @@ public function configure(Schema $schema)
             self::LOGGING_FINGERS_CROSSED => true,
             self::LOGGING_PATH => 'phpactor.log',
             self::LOGGING_LEVEL => LogLevel::WARNING,
+            self::XDEBUG_DISABLE => true,
         ]);
     }
 

lib/Extension/Core/CoreExtension.php

@@ -18,11 +18,13 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Phpactor\Config\Paths;
 use Phpactor\Extension\ClassToFile\ClassToFileExtension;
+use Composer\XdebugHandler\XdebugHandler;
 
 class Phpactor
 {
     public static function boot(InputInterface $input): PhpactorContainer
     {
+
         $config = [];
 
         $configLoader = new ConfigLoader();
@@ -32,6 +34,12 @@ public static function boot(InputInterface $input): PhpactorContainer
             $config['cwd'] = $input->getParameterOption([ '--working-dir', '-d' ]);
         }
 
+        if (!isset($config[CoreExtension::XDEBUG_DISABLE]) || $config[CoreExtension::XDEBUG_DISABLE]) {
+            $xdebug = new XdebugHandler('PHPACTOR', '--ansi');
+            $xdebug->check();
+            unset($xdebug);
+        }
+
         $extensionNames = [
             CoreExtension::class,
             ClassToFileExtension::class,

lib/Phpactor.php

@@ -22,4 +22,8 @@
         </whitelist>
     </filter>
 
+    <php>
+        <env name="PHPACTOR_ALLOW_XDEBUG" value="1"/>
+    </php>
+
 </phpunit>

phpunit.xml.dist

@@ -6,16 +6,17 @@
 use Phpactor\Application;
 use Symfony\Component\Console\Output\BufferedOutput;
 use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Process\Process;
 
 class BaseBenchCase extends IntegrationTestCase
 {
-    protected function runCommand(array $input): BufferedOutput
+    protected function runCommand(string $command): string
     {
         chdir($this->workspaceDir());
-        $application = new Application();
-        $output = new BufferedOutput();
-        $application->setAutoExit(false);
-        $application->run(new ArrayInput($input), $output);
-        return $output;
+
+        $process = new Process(__DIR__ . '/../../bin/phpactor ' . $command);
+        $process->setWorkingDirectory($this->workspaceDir());
+        $process->run();
+        return $process->getOutput();
     }
 }