Debug

添加一个组件调试。

引入相关类

• use Error;
• use Exception;
• use Leevel\Debug\Debug;
• use Leevel\Event\Dispatch;
• use Leevel\Event\IDispatch;
• use Leevel\Http\JsonResponse;
• use Leevel\Http\Request;
• use Leevel\Http\Response;
• use Leevel\Leevel\App as Apps;
• use Leevel\Log\File as LogFile;
• use Leevel\Log\ILog;
• use Leevel\Log\Log;
• use Leevel\Option\IOption;
• use Leevel\Option\Option;
• use Leevel\Session\File as SessionFile;
• use Leevel\Session\ISession;
• use Leevel\Session\Session;

  JSON 关联数组调试

关联数组结构会在尾部追加一个选项 :trace 用于调试。

返回结构

$response = ["foo" => "bar", ":trace" => []];

关联数组在尾部追加一个选项作为调试信息，这与非关联数组有所不同。

public function testJson()
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('{"foo":"bar",":trace":', $content);
    $this->assertContains('"php":{"version":', $content);
    $this->assertContains('Starts from this moment with QueryPHP.', $content);
}

JSON 非关联数组调试

非关联数组结构会在尾部追加一个 :trace 用于调试。

返回结构

$response = ["foo", "bar", [":trace" => []]];

非关联数组在尾部追加一个调试信息，将不会破坏返回接口的 JSON 结构。

public function testJsonForNotAssociativeArray()
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo', 'bar']);
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('"foo","bar",{":trace":{', $content);
    $this->assertContains('"php":{"version":', $content);
    $this->assertContains('Starts from this moment with QueryPHP.', $content);
}

关闭调试

public function testDisable()
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('{"foo":"bar",":trace":', $content);
    $this->assertContains('"php":{"version":', $content);
    $this->assertContains('Starts from this moment with QueryPHP.', $content);
    $debug->disable();
    $response2 = new JsonResponse(['foo' => 'bar']);
    $debug->handle($request, $response2);
    $content = $response2->getContent();
    $this->assertNotContains('{"foo":"bar",":trace":', $content);
    $this->assertNotContains('"php":{"version":', $content);
    $this->assertNotContains('Starts from this moment with QueryPHP.', $content);
}

启用调试

public function testEnable()
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $debug->disable();
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertNotContains('{"foo":"bar",":trace":', $content);
    $this->assertNotContains('"php":{"version":', $content);
    $this->assertNotContains('Starts from this moment with QueryPHP.', $content);
    $this->assertTrue($debug->isBootstrap());
    $debug->enable();
    $this->assertTrue($debug->isBootstrap());
    $response2 = new JsonResponse(['foo' => 'bar']);
    $debug->handle($request, $response2);
    $content = $response2->getContent();
    $this->assertContains('{"foo":"bar",":trace":', $content);
    $this->assertContains('"php":{"version":', $content);
    $this->assertContains('Starts from this moment with QueryPHP.', $content);
}

启用调试但是未初始化

public function testEnableWithoutBootstrap()
{
    $debug = $this->createDebug();
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $debug->disable();
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertNotContains('{"foo":"bar",":trace":', $content);
    $this->assertNotContains('"php":{"version":', $content);
    $this->assertNotContains('Starts from this moment with QueryPHP.', $content);
    $this->assertFalse($debug->isBootstrap());
    $debug->enable();
    $this->assertTrue($debug->isBootstrap());
    $response2 = new JsonResponse(['foo' => 'bar']);
    $debug->handle($request, $response2);
    $content = $response2->getContent();
    $this->assertContains('{"foo":"bar",":trace":', $content);
    $this->assertContains('"php":{"version":', $content);
    $this->assertContains('Starts from this moment with QueryPHP.', $content);
}

调试消息等级

支持的消息类型

public function getMessageLevelsData()
{
    return [
        ['emergency'], ['alert'], ['critical'],
        ['error'], ['warning'], ['notice'],
        ['info'], ['debug'], ['log'],
    ];
}

系统支持多种消息类型，可以参考这个进行调试。

public function testMessageLevelsData(string $level)
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $debug->{$level}('hello', 'world');
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('{"foo":"bar",":trace":', $content);
    $this->assertContains('"php":{"version":', $content);
    $this->assertContains('Starts from this moment with QueryPHP.', $content);
    $this->assertContains('{"message":"hello","message_html":null,"is_string":true,"label":"'.$level.'",', $content);
    $this->assertContains('{"message":"world","message_html":null,"is_string":true,"label":"'.$level.'",', $content);
}

调试 Session

public function testWithSession()
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $session = $debug->getApp()->make('session');
    $session->set('test_session', 'test_value');
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('"session":{"test_session":"test_value"},', $content);
}

调试 Log

public function testWithLog()
{
    $debug = $this->createDebugWithLog();
    $app = $debug->getApp();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $log = $app->make('log');
    $log->info('test_log', ['exends' => 'bar']);
    $log->debug('test_log_debug');
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('"logs":{"count":2,', $content);
    $this->assertContains('test_log info: {\"exends\":\"bar\"}', $content);
    $this->assertContains('test_log_debug debug: []', $content);
}

调试时间

public function testTime()
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $debug->time('time_test');
    $debug->end('time_test');
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('"time":{"start"', $content);
    $this->assertContains('"measures":[{"label":"time_test","start":', $content);
}

调试带有标签的时间

public function testTimeWithLabel()
{
    $debug = $this->createDebug();
    $this->assertFalse($debug->isBootstrap());
    $debug->bootstrap();
    $this->assertTrue($debug->isBootstrap());
    $request = new Request();
    $response = new JsonResponse(['foo' => 'bar']);
    $debug->time('time_test', 'time_label');
    $debug->end('time_test');
    $debug->handle($request, $response);
    $content = $response->getContent();
    $this->assertContains('"time":{"start"', $content);
    $this->assertContains('"measures":[{"label":"time_label","start":', $content);
}