mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-10-03 20:02:29 +02:00
Clean up the admin stream loopback scripts (api/live/proxy_api/thumb/
timeshift/vod) for readability and to give their core logic unit-test
coverage, without changing behavior — except the two bugs called out below.
Readability:
- Invert the pervasive empty `if (c) {} else { body }` into `if (!c) { body }`.
- Flatten deep if/else nests into guard-clause / elseif chains (live, vod).
- Drop dead blank lines.
Testability (pure logic extracted, then covered):
- New value object XcVm\Domain\Stream\AdminStreamToken (decode + isValid)
replaces the uitoken decrypt+expiry+IP block duplicated across live/thumb/
timeshift/vod; it reuses the existing-but-unadopted NetworkUtils::ipMatches().
Token start/duration are kept raw (a timeshift date string must not be cast).
- Four pure helpers folded into the existing StreamUtils (not new one-method
classes): sanitizeSegmentName, containerMimeType, timeshiftStartTimestamp,
segmentRetryBudget — replacing inline path sanitization, a 44-line MIME
switch, the timeshift date parser, and the retry-budget math.
- Tests: AdminStreamTokenTest, NetworkUtilsTest (ipMatches had no coverage),
and StreamUtilsTest extended for the four helpers. OPENSSL_EXTRA is defined
in tests/bootstrap.php so token round-trips work.
Bug fixes (behavior changes):
- live: the retry budget used `$rTotalFails < intval(...) ?: 20`, which by
operator precedence parsed as `(... < ...) ?: 20` — always truthy — so the
`seg_time * 2` floor was ignored and the budget was always the configured
wait. Now max(seg_time*2, wait ?: 20) via StreamUtils::segmentRetryBudget().
- proxy_api: the per-second byte-rate divided by `time() - last`, which is 0
for two samples in the same second (division by zero). Clamp to >= 1s.
74 lines
2.6 KiB
PHP
74 lines
2.6 KiB
PHP
<?php
|
|
|
|
use XcVm\Core\Util\Encryption;
|
|
use XcVm\Domain\Stream\AdminStreamToken;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
/**
|
|
* @covers XcVm\Domain\Stream\AdminStreamToken
|
|
*/
|
|
final class AdminStreamTokenTest extends TestCase {
|
|
|
|
private const KEY = 'live-streaming-pass';
|
|
|
|
/** @param array<string,mixed> $data */
|
|
private function makeToken(array $data): string {
|
|
return Encryption::encrypt(json_encode($data), self::KEY, OPENSSL_EXTRA);
|
|
}
|
|
|
|
public function testDecodeReturnsNullOnGarbageCiphertext() {
|
|
$this->assertNull(AdminStreamToken::decode('not-a-valid-token', self::KEY));
|
|
}
|
|
|
|
public function testDecodeReturnsNullOnWrongKey() {
|
|
$token = $this->makeToken(array('stream_id' => 7, 'ip' => '1.2.3.4', 'expires' => time() + 60));
|
|
$this->assertNull(AdminStreamToken::decode($token, 'wrong-key'));
|
|
}
|
|
|
|
public function testDecodeReturnsNullWhenRequiredFieldMissing() {
|
|
$token = $this->makeToken(array('stream_id' => 7, 'ip' => '1.2.3.4')); // no expires
|
|
$this->assertNull(AdminStreamToken::decode($token, self::KEY));
|
|
}
|
|
|
|
public function testDecodeExposesTypedFieldsAndKeepsStartRaw() {
|
|
$token = $this->makeToken(array(
|
|
'stream_id' => '7',
|
|
'ip' => '1.2.3.4',
|
|
'expires' => '123',
|
|
'container' => 'mp4',
|
|
'start' => '20250101-13',
|
|
'duration' => 30,
|
|
));
|
|
$rToken = AdminStreamToken::decode($token, self::KEY);
|
|
|
|
$this->assertNotNull($rToken);
|
|
$this->assertSame(7, $rToken->streamId);
|
|
$this->assertSame('1.2.3.4', $rToken->ip);
|
|
$this->assertSame(123, $rToken->expires);
|
|
$this->assertSame('mp4', $rToken->container);
|
|
$this->assertSame('20250101-13', $rToken->start); // raw — NOT cast to int
|
|
$this->assertSame(30, $rToken->duration);
|
|
}
|
|
|
|
public function testIsValidExpiryBoundaryIsInclusive() {
|
|
$rToken = AdminStreamToken::decode($this->makeToken(array('stream_id' => 1, 'ip' => '1.2.3.4', 'expires' => 1000)), self::KEY);
|
|
|
|
$this->assertTrue($rToken->isValid(false, '1.2.3.4', 1000)); // expires == now → valid
|
|
$this->assertFalse($rToken->isValid(false, '1.2.3.4', 1001)); // now past expiry
|
|
}
|
|
|
|
public function testIsValidExactIpMatch() {
|
|
$rToken = AdminStreamToken::decode($this->makeToken(array('stream_id' => 1, 'ip' => '1.2.3.4', 'expires' => 2000)), self::KEY);
|
|
|
|
$this->assertTrue($rToken->isValid(false, '1.2.3.4', 1000));
|
|
$this->assertFalse($rToken->isValid(false, '1.2.3.5', 1000));
|
|
}
|
|
|
|
public function testIsValidSubnetMatch() {
|
|
$rToken = AdminStreamToken::decode($this->makeToken(array('stream_id' => 1, 'ip' => '1.2.3.4', 'expires' => 2000)), self::KEY);
|
|
|
|
$this->assertTrue($rToken->isValid(true, '1.2.3.99', 1000)); // same /24
|
|
$this->assertFalse($rToken->isValid(true, '1.2.9.4', 1000)); // different third octet
|
|
}
|
|
}
|