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
12 changes: 4 additions & 8 deletions lib/AppInfo/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use OCP\AppFramework\Bootstrap\IRegistrationContext;
use OCP\Http\Client\IClientService;
use OCP\IConfig;
use OCP\IRequest;
use Psr\Log\LoggerInterface;

class Application extends App implements IBootstrap {
Expand All @@ -24,23 +25,18 @@ public function __construct() {
}

public function register(IRegistrationContext $context): void {
// Prepared for future use — see HandlerStackReadyListener.php and
// https://gist.github.com/ernolf/ecd9a66610be46f2afff840b1c70d513
// $context->registerEventListener(
// \OCA\AdminAuditHttpClient\Event\HttpClientHandlerStackReadyEvent::class,
// \OCA\AdminAuditHttpClient\Listener\HandlerStackReadyListener::class
// );
}

public function boot(IBootContext $context): void {
$server = \OC::$server;
$server = $context->getServerContainer();
$inner = $server->get(IClientService::class);
$logger = $context->getAppContainer()->get(LoggerInterface::class);
$config = $server->get(IConfig::class);
$request = $server->get(IRequest::class);

$server->registerService(
IClientService::class,
fn () => new LoggingClientService($inner, $logger, $config)
fn () => new LoggingClientService($inner, $logger, $config, $request)
);
}
}
3 changes: 3 additions & 0 deletions lib/Http/Client/LoggingClientService.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\IConfig;
use OCP\IRequest;
use Psr\Log\LoggerInterface;

class LoggingClientService implements IClientService {
public function __construct(
private IClientService $inner,
private LoggerInterface $logger,
private IConfig $config,
private IRequest $request,
) {
}

Expand Down Expand Up @@ -48,6 +50,7 @@ public function newClient(?callable $handler = null): IClient {
$this->config->getSystemValueString('audit_http_client_logs', 'both'),
(array)$this->config->getSystemValue('audit_http_client_logs_exclude_domain', []),
(array)$this->config->getSystemValue('audit_http_client_redact_headers', []),
$this->request->getId(),
),
'admin_audit_http_client'
);
Expand Down
23 changes: 16 additions & 7 deletions lib/Http/Client/Middleware/HttpClientLoggerMiddleware.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ class HttpClientLoggerMiddleware {
private string $logFormat;
private array $excludeDomains;
private array $redactHeaders;
private string $serverReqId;

public function __construct(
LoggerInterface $logger,
Expand All @@ -43,12 +44,14 @@ public function __construct(
string $logFormat = 'both',
array $excludeDomains = [],
array $redactHeaders = [],
string $serverReqId = '',
) {
$this->logger = $logger;
$this->logBaseDir = rtrim($logBaseDir, '/');
$this->logLevel = $logLevel;
$this->logFormat = $logFormat;
$this->excludeDomains = $excludeDomains;
$this->serverReqId = $serverReqId;

$this->redactHeaders = self::DEFAULT_REDACT_HEADERS;
foreach ($redactHeaders as $name) {
Expand All @@ -65,13 +68,19 @@ public function __invoke(callable $handler): callable {
return $handler($request, $options);
}

// Generate/extract request ID
try {
$reqId = $request->hasHeader('X-Nextcloud-ReqId')
? $request->getHeaderLine('X-Nextcloud-ReqId')
: (isset($options['nc_request_id']) ? (string)$options['nc_request_id'] : bin2hex(random_bytes(6)));
} catch (\Throwable $e) {
$reqId = isset($options['nc_request_id']) ? (string)$options['nc_request_id'] : uniqid('', true);
// Request ID: reuse a caller-provided header, otherwise derive a
// unique ID per outgoing request. Prefixing the server request ID
// makes log entries correlatable with nextcloud.log while the
// random suffix keeps concurrent outgoing requests apart.
if ($request->hasHeader('X-Nextcloud-ReqId')) {
$reqId = $request->getHeaderLine('X-Nextcloud-ReqId');
} else {
try {
$suffix = bin2hex(random_bytes(4));
} catch (\Throwable $e) {
$suffix = uniqid('', true);
}
$reqId = $this->serverReqId === '' ? $suffix : $this->serverReqId . '-' . $suffix;
}

// Inject X-Nextcloud-ReqId header so remote servers can correlate
Expand Down
43 changes: 0 additions & 43 deletions lib/Listener/HandlerStackReadyListener.php

This file was deleted.

2 changes: 2 additions & 0 deletions tests/integration/MiddlewareInjectionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use OCA\AdminAuditHttpClient\Http\Client\LoggingClientService;
use OCP\Http\Client\IClientService;
use OCP\IConfig;
use OCP\IRequest;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;

Expand All @@ -29,6 +30,7 @@ public function testMiddlewareIsInjectedIntoHandlerStack(): void {
$server->get(IClientService::class),
$server->get(LoggerInterface::class),
$server->get(IConfig::class),
$server->get(IRequest::class),
);

$client = $service->newClient();
Expand Down
1 change: 0 additions & 1 deletion tests/stub.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

namespace {
class OC {
public static \OCP\IServerContainer $server;
public static string $SERVERROOT;
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ private function middleware(
int $logLevel = 0,
array $excludeDomains = [],
array $redactHeaders = [],
string $serverReqId = '',
): HttpClientLoggerMiddleware {
return new HttpClientLoggerMiddleware(
new NullLogger(),
Expand All @@ -33,6 +34,7 @@ private function middleware(
'both',
$excludeDomains,
$redactHeaders,
$serverReqId,
);
}

Expand Down Expand Up @@ -102,14 +104,27 @@ public function testStatsEntryIsClearedWhenResponseIsNotLogged(): void {
});

$response = $handler(
new Request('GET', 'https://example.com/'),
['nc_request_id' => $reqId],
new Request('GET', 'https://example.com/', ['X-Nextcloud-ReqId' => $reqId]),
[],
)->wait();

$this->assertNotInstanceOf(CountingStream::class, $response->getBody());
$this->assertNull(TransferStatsStore::get($reqId));
}

public function testGeneratedRequestIdCarriesServerRequestIdPrefix(): void {
$mw = $this->middleware(2, [], [], 'server-req');
$seen = null;

$handler = $mw(function (Request $request, array $options) use (&$seen) {
$seen = $request->getHeaderLine('X-Nextcloud-ReqId');
return new FulfilledPromise(new Response(200, [], 'x'));
});
$handler(new Request('GET', 'https://example.com/'), [])->wait();

$this->assertStringStartsWith('server-req-', (string)$seen);
}

public function testWriteImmediateOmitsDecompressedBytesAndRatio(): void {
$dir = sys_get_temp_dir() . '/aahc-wi-' . bin2hex(random_bytes(4));
$mw = new HttpClientLoggerMiddleware(new NullLogger(), $dir);
Expand Down
Loading