Add simple API panel to Tracy bar

[MAILPOET-2239]

lib/API/JSON/API.php

@@ -4,10 +4,12 @@ namespace MailPoet\API\JSON;
 use MailPoet\Config\AccessControl;
 use MailPoet\Settings\SettingsController;
 use MailPoet\Subscription\Captcha;
+use MailPoet\Tracy\ApiPanel\ApiPanel;
 use MailPoetVendor\Psr\Container\ContainerInterface;
 use MailPoet\Util\Helpers;
 use MailPoet\Util\Security;
 use MailPoet\WP\Functions as WPFunctions;
+use Tracy\Debugger;
 
 if (!defined('ABSPATH')) exit;
 
@@ -164,6 +166,10 @@ class API {
         throw new \Exception(__('Invalid API endpoint method.', 'mailpoet'));
       }
 
+      if (class_exists(Debugger::class)) {
+        ApiPanel::init($endpoint, $this->_request_method, $this->_request_data);
+      }
+
       // check the accessibility of the requested endpoint's action
       // by default, an endpoint's action is considered "private"
       if (!$this->validatePermissions($this->_request_method, $endpoint->permissions)) {

lib/Tracy/ApiPanel/ApiPanel.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace MailPoet\Tracy\ApiPanel;
+
+use MailPoet\API\JSON\Endpoint as APIEndpoint;
+use ReflectionClass;
+use Tracy\Debugger;
+use Tracy\IBarPanel;
+
+/**
+ * Inspired by: https://componette.com/macfja/tracy-doctrine-sql/
+ */
+class ApiPanel implements IBarPanel {
+  /** @var APIEndpoint */
+  protected $endpoint;
+
+  /** @var string */
+  protected $request_method;
+
+  /** @var array */
+  protected $request_data;
+
+  /** @var ReflectionClass */
+  protected $endpoint_reflection;
+
+  function __construct($endpoint, $request_method, $request_data) {
+    $this->endpoint = $endpoint;
+    $this->request_method = $request_method;
+    $this->request_data = $request_data;
+    $this->endpoint_reflection = new ReflectionClass($endpoint);
+  }
+
+  function getTab() {
+    $img = '<svg height="128px" id="Layer_1" style="enable-background:new 0 0 128 128;" version="1.1" viewBox="0 0 128 128" width="128px" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"><g><g><g><line style="fill:none;stroke:#2F3435;stroke-width:12;stroke-linecap:square;stroke-miterlimit:10;" x1="63.185" x2="37.821" y1="84.061" y2="109.423"/><line style="fill:none;stroke:#2F3435;stroke-width:12;stroke-linecap:square;stroke-miterlimit:10;" x1="37.821" x2="12.456" y1="109.423" y2="84.061"/></g><line style="fill:none;stroke:#2F3435;stroke-width:12;stroke-miterlimit:10;" x1="37.821" x2="37.821" y1="109.423" y2="9.801"/></g><g><g><line style="fill:none;stroke:#2F3435;stroke-width:12;stroke-linecap:square;stroke-miterlimit:10;" x1="64.815" x2="90.181" y1="44.241" y2="18.877"/><line style="fill:none;stroke:#2F3435;stroke-width:12;stroke-linecap:square;stroke-miterlimit:10;" x1="90.181" x2="115.544" y1="18.877" y2="44.241"/></g><line style="fill:none;stroke:#2F3435;stroke-width:12;stroke-miterlimit:10;" x1="90.181" x2="90.181" y1="18.877" y2="118.199"/></g></g></svg>';
+    return $img . '<span class="tracy-label" >' . $this->getEndpointName() . '</span>';
+  }
+
+  function getPanel() {
+    ob_start();
+    require __DIR__ . '/api-panel.phtml';
+    return ob_get_clean();
+  }
+
+  static function init($endpoint, $request_method, $request_data) {
+    Debugger::getBar()->addPanel(new static($endpoint, $request_method, $request_data));
+  }
+
+  private function getEndpointName() {
+    return $this->endpoint_reflection->getShortName() . '::' . $this->request_method . '()';
+  }
+}

lib/Tracy/ApiPanel/api-panel.phtml

@@ -0,0 +1,40 @@
+<?php
+
+namespace MailPoet\Tracy\ApiPanel;
+
+use Tracy\Dumper;
+
+/**
+ * @var ApiPanel $this
+ */
+?>
+<h1>API call</h1>
+<table>
+  <tr>
+    <th>Endpoint</th>
+    <td><pre><?php echo $this->endpoint_reflection->getName() ?></pre></td>
+  </tr>
+  <tr>
+    <th>Method</th>
+    <td><pre><?php echo $this->request_method . '()' ?></pre></td>
+  </tr>
+</table>
+
+<?php if(!empty($this->request_data)): ?>
+<br/>
+<h2 style="font-size: 140%; color: #575753;">Data</h2>
+<div class="tracy-inner tracy-mailpoet-api">
+  <table>
+    <tr>
+      <th>Name</th>
+      <th>Value</th>
+    </tr>
+    <?php foreach ($this->request_data as $name => $value): ?>
+    <tr>
+      <td><?php echo $name ?></td>
+      <td><?php echo Dumper::toHtml($value) ?></td>
+    </tr>
+    <?php endforeach ?>
+  </table>
+</div>
+<?php endif; ?>