Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
name: Run tests

on: [ push, pull_request ]
on:
push:
pull_request:
schedule:
- cron: '0 0 * * *'

jobs:
test:
Expand All @@ -13,6 +17,9 @@ jobs:
laravel: [ 8.*, 7.*, 6.*, 5.8.* ]
stability: [ prefer-stable ]
include:
- laravel: 8.*
php: 8.1
stability: prefer-stable
- laravel: 8.*
php: 8.0
stability: prefer-stable
Expand Down
5 changes: 3 additions & 2 deletions src/Middlewares/AppLogger.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,12 @@ public function handle(Request $request, Closure $next)

/**
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Http\Response $response
*/
public function terminate(Request $request)
public function terminate(Request $request, $response)
{
if ($this->performanceLogProfile->shouldLog($request)) {
$this->performanceLogWriter->log($request, $this->uniqId);
$this->performanceLogWriter->log($request, $response, $this->uniqId);
}
}
}
21 changes: 17 additions & 4 deletions src/PerformanceLog/LogWriter.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,32 @@ public function __construct()
}
}

public function log(Request $request, string $uniqId): void
/**
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Http\Response $response
* @param string $uniqId
* @return void
*/
public function log(Request $request, $response, string $uniqId): void
{
$message = $this->formatMessage($this->getMessages($request, $uniqId));
$message = $this->formatMessage($this->getMessages($request, $response, $uniqId));

Log::channel(config('app-logger.performance.channel'))->info($message);
}

protected function getMessages(Request $request, string $uniqId): array
/**
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Http\Response $response
* @param string $uniqId
* @return array
*/
protected function getMessages(Request $request, $response, string $uniqId): array
{
return [
'uniqid' => $uniqId,
'method' => strtoupper($request->getMethod()),
'uri' => $request->getPathInfo(),
'status' => $response->getStatusCode(),
'time' => $this->getTimeInMilliSeconds(),
'memory' => $this->getMemoryInMB(),
];
Expand All @@ -60,6 +73,6 @@ protected function getMemoryInMB(): string
protected function formatMessage(array $message): string
{
// phpcs:ignore
return "{$message['uniqid']} {$message['method']} {$message['uri']} - Time: {$message['time']} ms - Memory: {$message['memory']} MiB";
return "{$message['uniqid']} {$message['method']} {$message['uri']} {$message['status']} - Time: {$message['time']} ms - Memory: {$message['memory']} MiB";
}
}
8 changes: 7 additions & 1 deletion src/PerformanceLog/PerformanceLogWriter.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,11 @@

interface PerformanceLogWriter
{
public function log(Request $request, string $uniqId): void;
/**
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Http\Response $response
* @param string $uniqId
* @return void
*/
public function log(Request $request, $response, string $uniqId): void;
}
5 changes: 5 additions & 0 deletions src/QueryLog/LogWriter.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ protected function getMessages(QueryExecuted $query): array
$binding = $this->quote($binding);
}

// Make null visible in log
if (is_null($binding)) {
$binding = 'null';
}

$sql = preg_replace($regex, $binding, $sql, 1);
}

Expand Down
20 changes: 13 additions & 7 deletions tests/PerformanceLog/LogWriterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
namespace KitLoong\AppLogger\Tests\PerformanceLog;

use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Log;
use KitLoong\AppLogger\PerformanceLog\LogWriter;
Expand Down Expand Up @@ -46,28 +47,32 @@ public function testLog()
Log::shouldReceive('info')
->withArgs(function ($args) {
$this->assertStringMatchesFormat(
'test-uniqid POST /test/uri - Time: %f ms - Memory: %f MiB',
'test-uniqid POST /test/uri %d - Time: %f ms - Memory: %f MiB',
$args
);
return true;
})
->once();

$logWriter->log($request, 'test-uniqid');
$response = new Response('content', Response::HTTP_OK);

$logWriter->log($request, $response, 'test-uniqid');
}

public function testGetMessages()
{
$logWriter = $this->getLogWriter();

$request = $this->makeRequest(Request::METHOD_POST, self::TEST_URI);
$response = new Response('content', Response::HTTP_OK);

$messages = $logWriter->testGetMessages($request, 'test-uniqid');
$messages = $logWriter->testGetMessages($request, $response, 'test-uniqid');

$this->assertSame(5, count($messages));
$this->assertSame(6, count($messages));
$this->assertSame('test-uniqid', $messages['uniqid']);
$this->assertSame('POST', $messages['method']);
$this->assertSame($request->getPathInfo(), $messages['uri']);
$this->assertSame(Response::HTTP_OK, $messages['status']);
$this->assertArrayHasKey('time', $messages);
$this->assertArrayHasKey('memory', $messages);
}
Expand All @@ -80,11 +85,12 @@ public function testFormatMessage()
'uniqid' => 'test-uniqid',
'method' => 'post',
'uri' => '/test/url',
'status' => '200',
'time' => '50',
'memory' => '20',
]);

$this->assertSame('test-uniqid post /test/url - Time: 50 ms - Memory: 20 MiB', $message);
$this->assertSame('test-uniqid post /test/url 200 - Time: 50 ms - Memory: 20 MiB', $message);
}

private function getLogWriter(): LogWriter
Expand All @@ -95,9 +101,9 @@ public function getStart()
return $this->start;
}

public function testGetMessages(Request $request, string $uniqId): array
public function testGetMessages(Request $request, $response, string $uniqId): array
{
return $this->getMessages($request, $uniqId);
return $this->getMessages($request, $response, $uniqId);
}

public function testFormatMessage(array $message): string
Expand Down
28 changes: 28 additions & 0 deletions tests/QueryLog/LogWriterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,34 @@ public function testGetMessage()
], $messages);
}

public function testGetMessageWithNull()
{
$connection = Mockery::mock(Connection::class);
$connection->shouldReceive('getName')
->andReturn('mysql')
->once();

$query = new QueryExecuted(
'INSERT INTO users SET name = :name, email = :email, remember_token = :remember_token',
[
'id' => 1,
'name' => 'Name',
'remember_token' => null,
],
10,
$connection
);

$logWriter = $this->getLogWriter();
$messages = $logWriter->testGetMessages($query);

$this->assertSame([
'time' => 10,
'connection_name' => 'mysql',
'sql' => "INSERT INTO users SET name = 'Name', email = :email, remember_token = null",
], $messages);
}

public function testFormatMessage()
{
$logWriter = $this->getLogWriter();
Expand Down