8009e9d027
Introduce a new interface Wikimedia/Http/TelemetryHeadersInterface that provides telemetry information that could be attached to HTTP Requests. MultiHttpClient is expecting `telemetry` option of TelemetryHeadersInterface type. The MediaWiki/Http/Telemetry implements the interface, therefore ObjectCache can inject it to RESTBagOStuff, that further injects it to MultiHttpClient. Bug: T344926 Change-Id: I59a3f1048c403fe2e4ef0c74353dfe74ff9ca893
117 lines
2.9 KiB
PHP
117 lines
2.9 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Tests\Unit\Http;
|
|
|
|
use MediaWiki\Http\Telemetry;
|
|
use MediaWikiUnitTestCase;
|
|
|
|
/**
|
|
* @covers \MediaWiki\Http\Telemetry
|
|
*/
|
|
class TelemetryTest extends MediaWikiUnitTestCase {
|
|
|
|
public function testItOverridesTheRequestIdWhenAsked() {
|
|
$newId = 'new_id';
|
|
$sut = new Telemetry( [ 'UNIQUE_ID' => 'test' ], false );
|
|
$sut->overrideRequestId( $newId );
|
|
$this->assertSame( $newId, $sut->getRequestId() );
|
|
}
|
|
|
|
public function testRegenerationProvidesNewId() {
|
|
$sut = new Telemetry( [], false );
|
|
$firstId = $sut->getRequestId();
|
|
$sut->regenerateRequestId();
|
|
$secondId = $sut->getRequestId();
|
|
$this->assertNotSame( $firstId, $secondId );
|
|
}
|
|
|
|
public function testItReturnsOpenTelemetryProperties() {
|
|
$sut = new Telemetry( [
|
|
'HTTP_TRACESTATE' => 'val1',
|
|
'HTTP_TRACEPARENT' => 'val2'
|
|
], true );
|
|
|
|
$this->assertSame( 'val1', $sut->getTracestate() );
|
|
$this->assertSame( 'val2', $sut->getTraceparent() );
|
|
}
|
|
|
|
public function testOpenTelemetryPropertiesAreSkippedWhenAllowExternalReqIDIsSetToFalse() {
|
|
$sut = new Telemetry( [
|
|
'HTTP_TRACESTATE' => 'val1',
|
|
'HTTP_TRACEPARENT' => 'val2'
|
|
], false );
|
|
|
|
$this->assertNull( $sut->getTracestate() );
|
|
$this->assertNull( $sut->getTraceparent() );
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideRequestHeaders
|
|
*/
|
|
public function testItHandlesRequestIdHeaders( $allowExternalReqId, $server, $expected ) {
|
|
$sut = new Telemetry( $server, $allowExternalReqId );
|
|
|
|
$this->assertSame( $expected, $sut->getRequestId() );
|
|
}
|
|
|
|
public function testItGeneratesRequestIdWhenHeadersNotPresentAndExternalReqIdIsSet() {
|
|
$sut = new Telemetry( [], true );
|
|
$this->assertNotEmpty( $sut->getRequestId() );
|
|
}
|
|
|
|
public function testItGeneratesRequestIdWhenHeadersNotPresentAndExternalReqIdIsNotSet() {
|
|
$sut = new Telemetry( [], false );
|
|
$this->assertNotEmpty( $sut->getRequestId() );
|
|
}
|
|
|
|
public function testGetRequestHeadersReturnsAllHeaders() {
|
|
$allSet = [ 'HTTP_TRACEPARENT' => 'value1', 'HTTP_TRACESTATE' => 'value2' ];
|
|
$sut = new Telemetry( $allSet, true );
|
|
|
|
$headers = $sut->getRequestHeaders();
|
|
$this->assertCount( 3, $headers );
|
|
$this->assertArrayHasKey( 'X-Request-Id', $headers );
|
|
$this->assertSame( 'value1', $headers['traceparent'] );
|
|
$this->assertSame( 'value2', $headers['tracestate'] );
|
|
}
|
|
|
|
public function testGetRequestHeadersDoesntReturnEmptyHeaders() {
|
|
$sut = new Telemetry( [], true );
|
|
|
|
$headers = $sut->getRequestHeaders();
|
|
$this->assertCount( 1, $headers );
|
|
$this->assertArrayHasKey( 'X-Request-Id', $headers );
|
|
}
|
|
|
|
public static function provideRequestHeaders() {
|
|
yield [
|
|
false,
|
|
[ 'UNIQUE_ID' => 'unique_hash' ],
|
|
'unique_hash'
|
|
];
|
|
yield [
|
|
false,
|
|
[
|
|
'HTTP_X_REQUEST_ID' => 'request_id',
|
|
'UNIQUE_ID' => 'unique_hash'
|
|
],
|
|
'unique_hash'
|
|
];
|
|
yield [
|
|
true,
|
|
[
|
|
'HTTP_X_REQUEST_ID' => 'request_id',
|
|
'UNIQUE_ID' => 'unique_hash'
|
|
],
|
|
'request_id'
|
|
];
|
|
yield [
|
|
true,
|
|
[
|
|
'UNIQUE_ID' => 'unique_hash'
|
|
],
|
|
'unique_hash'
|
|
];
|
|
}
|
|
|
|
}
|