Compatibility with new Tideways XHProf extension. (#3707)

* Compatibility with new Tideways XHProf extension.

* Code standard cleanup.

* Get tmp dir from Drush config.

* Added additional documentation about tideways_xhprof.

Author: danepowell

src/Commands/core/XhprofCommands.php

@@ -8,6 +8,19 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Drush\Commands\DrushCommands;
 
+/**
+ * Class XhprofCommands
+ * @package Drush\Commands\core
+ *
+ * Supports profiling Drush commands using either XHProf or Tideways XHProf.
+ *
+ * Note that XHProf is only compatible with PHP 5.6. For PHP 7+, you must use
+ * the Tideways XHProf fork. The Tideways XHProf extension recently underwent a
+ * major refactor; Drush is only compatible with the newer version.
+ * @see https://tideways.com/profiler/blog/releasing-new-tideways-xhprof-extension
+ *
+ * @todo Remove support for XHProf extension once PHP 5.6 is EOL.
+ */
 class XhprofCommands extends DrushCommands
 {
 
@@ -37,10 +50,7 @@ public function xhprofPost($result, CommandData $commandData)
     {
         if (self::xhprofIsEnabled()) {
             $namespace = 'Drush';
-            $xhprof_data = xhprof_disable();
-            $xhprof_runs = new \XHProfRuns_Default();
-            $run_id =  $xhprof_runs->save_run($xhprof_data, $namespace);
-            $namespace = 'Drush';
+            $run_id = self::xhprofFinishRun($namespace);
             $url = Drush::config()->get('xh.link') . '/index.php?run=' . urlencode($run_id) . '&source=' . urlencode($namespace);
             $this->logger()->notice(dt('XHProf run saved. View report at !url', ['!url' => $url]));
         }
@@ -53,25 +63,32 @@ public function xhprofPost($result, CommandData $commandData)
      */
     public function xhprofInitialize(InputInterface $input, AnnotationData $annotationData)
     {
-        if (self::xhprofIsEnabled($input)) {
+        if (self::xhprofIsEnabled()) {
             $config = Drush::config()->get('xh');
             $flags = self::xhprofFlags($config);
-            \xhprof_enable($flags);
+            self::xhprofEnable($flags);
         }
     }
 
     public static function xhprofIsEnabled()
     {
         if (Drush::config()->get('xh.link')) {
-            if (!extension_loaded('xhprof') && !extension_loaded('tideways')) {
-                throw new \Exception(dt('You must enable the xhprof or tideways PHP extensions in your CLI PHP in order to profile.'));
+            if (!extension_loaded('xhprof') && !extension_loaded('tideways_xhprof')) {
+                if (extension_loaded('tideways')) {
+                    throw new \Exception(dt('You are using an older incompatible version of the tideways extension. Please upgrade to the new tideways_xhprof extension.'));
+                } else {
+                    throw new \Exception(dt('You must enable the xhprof or tideways_xhprof PHP extensions in your CLI PHP in order to profile.'));
+                }
             }
             return true;
         }
+        return false;
     }
 
     /**
      * Determines flags.
+     *
+     * TODO: Make these work for Tideways as well.
      */
     public static function xhprofFlags(array $config)
     {
@@ -87,4 +104,34 @@ public static function xhprofFlags(array $config)
         }
         return $flags;
     }
+
+    /**
+     * Enable profiling.
+     */
+    public static function xhprofEnable($flags)
+    {
+        if (extension_loaded('tideways_xhprof')) {
+            \tideways_xhprof_enable(TIDEWAYS_XHPROF_FLAGS_MEMORY | TIDEWAYS_XHPROF_FLAGS_CPU);
+        } else {
+            \xhprof_enable($flags);
+        }
+    }
+
+    /**
+     * Disable profiling and save results.
+     */
+    public function xhprofFinishRun($namespace)
+    {
+        if (extension_loaded('tideways_xhprof')) {
+            $data = \tideways_xhprof_disable();
+            $dir = $this->getConfig()->tmp();
+            $run_id = uniqid();
+            file_put_contents($dir . DIRECTORY_SEPARATOR . $run_id . '.' . $namespace . '.xhprof', serialize($data));
+            return $run_id;
+        } else {
+            $xhprof_data = \xhprof_disable();
+            $xhprof_runs = new \XHProfRuns_Default();
+            return $xhprof_runs->save_run($xhprof_data, $namespace);
+        }
+    }
 }