Framework-agnostic REST controller toolkit in vanilla PHP. - Router with path parameters, 404 and 405 with an Allow header. - Immutable Request, JsonRequest and Response; nothing is printed. - CrudController over a ResourceGateway port the application implements. - Composable Middleware/Pipeline chain. - Security middlewares: BearerAuth, RequireRole, RateLimit, Cors. - Transport middlewares: Logging, ContentNegotiation. - Nine typed HTTP exceptions with snake_case JSON bodies. - Declares PHP >=8.3 and no dependency on an ORM: ports are local. - MIT license.
117 lines
3.7 KiB
PHP
117 lines
3.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Camelia\Controllers\Tests\Unit\Middleware;
|
|
|
|
use Camelia\Controllers\JsonRequest;
|
|
use Camelia\Controllers\Middleware\Logging;
|
|
use Camelia\Controllers\Request;
|
|
use Camelia\Controllers\Response;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
final class LoggingTest extends TestCase
|
|
{
|
|
/** @var list<array{level: string, message: string, context: array<string, mixed>}> */
|
|
private array $logs = [];
|
|
|
|
private float $now = 100.0;
|
|
|
|
private function logging(): Logging
|
|
{
|
|
return new Logging(
|
|
function (string $level, string $message, array $context): void {
|
|
$this->logs[] = ['level' => $level, 'message' => $message, 'context' => $context];
|
|
},
|
|
fn(): float => $this->now,
|
|
);
|
|
}
|
|
|
|
private static function ok(Request $request): Response
|
|
{
|
|
return new Response(['ok' => true]);
|
|
}
|
|
|
|
public function testRecordsSuccessfulRequest(): void
|
|
{
|
|
$response = $this->logging()->process(
|
|
new JsonRequest(method: 'GET', path: '/articulos'),
|
|
self::ok(...),
|
|
);
|
|
|
|
self::assertSame(200, $response->status());
|
|
self::assertCount(1, $this->logs);
|
|
self::assertSame('info', $this->logs[0]['level']);
|
|
self::assertSame('GET /articulos 200', $this->logs[0]['message']);
|
|
self::assertSame('/articulos', $this->logs[0]['context']['path']);
|
|
self::assertSame(200, $this->logs[0]['context']['status']);
|
|
}
|
|
|
|
public function testClientErrorLogsWarning(): void
|
|
{
|
|
$this->logging()->process(
|
|
new JsonRequest(path: '/x'),
|
|
static fn(): Response => new Response(['e' => 1], 404),
|
|
);
|
|
|
|
self::assertSame('warning', $this->logs[0]['level']);
|
|
}
|
|
|
|
public function testServerErrorLogsError(): void
|
|
{
|
|
$this->logging()->process(
|
|
new JsonRequest(path: '/x'),
|
|
static fn(): Response => new Response(null, 500),
|
|
);
|
|
|
|
self::assertSame('error', $this->logs[0]['level']);
|
|
}
|
|
|
|
public function testDurationIsMeasured(): void
|
|
{
|
|
$reads = [100.0, 120.5, 120.5, 163.0];
|
|
$logging = new Logging(function (string $level, string $message, array $context): void {
|
|
$this->logs[] = ['level' => $level, 'message' => $message, 'context' => $context];
|
|
}, static function () use (&$reads): float {
|
|
return (float) array_shift($reads);
|
|
});
|
|
|
|
$logging->process(new JsonRequest(), static fn(): Response => new Response(null));
|
|
self::assertSame(20.5, $this->logs[0]['context']['duration_ms']);
|
|
|
|
$logging->process(new JsonRequest(), static fn(): Response => new Response(null));
|
|
self::assertSame(42.5, $this->logs[1]['context']['duration_ms']);
|
|
}
|
|
|
|
public function testThrowableIsLoggedAndRethrown(): void
|
|
{
|
|
$logging = $this->logging();
|
|
|
|
try {
|
|
$logging->process(new JsonRequest(path: '/boom'), static function (): Response {
|
|
throw new \RuntimeException('exploded');
|
|
});
|
|
|
|
self::fail('The exception must propagate: the router owns error mapping.');
|
|
} catch (\RuntimeException $exception) {
|
|
self::assertSame('exploded', $exception->getMessage());
|
|
}
|
|
|
|
self::assertCount(1, $this->logs);
|
|
self::assertSame(500, $this->logs[0]['context']['status']);
|
|
self::assertSame('error', $this->logs[0]['level']);
|
|
}
|
|
|
|
public function testReturnsHandlerResponseUnchanged(): void
|
|
{
|
|
$original = new Response(['x' => 1], 201, ['Location' => '/a/1']);
|
|
|
|
$response = $this->logging()->process(
|
|
new JsonRequest(),
|
|
static fn(): Response => $original,
|
|
);
|
|
|
|
self::assertSame($original, $response);
|
|
}
|
|
}
|