plugins-nextcloud-mirror/spreed
1
0
Fork 0
mirror of https://github.com/nextcloud/spreed.git synced 2025-12-17 21:12:20 +01:00
Code Projects Releases Activity

feat(recording): Move RecordingRequest to Valinor

Browse source 
Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2025-11-14 16:33:26 +01:00
parent a050d92eb7
commit 0da4dc4d77
No known key found for this signature in database
GPG key ID: F72FA5B49FFA96B0
6 changed files with 211 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
lib/Controller/RecordingController.php
View file

@ -17,11 +17,18 @@ use OCA\Talk\Manager;
use OCA\Talk\Middleware\Attribute\RequireLoggedInModeratorParticipant;
use OCA\Talk\Middleware\Attribute\RequireModeratorParticipant;
use OCA\Talk\Middleware\Attribute\RequireRoom;
use OCA\Talk\Recording\RecordingFailedRequest;
use OCA\Talk\Recording\RecordingRequest;
use OCA\Talk\Recording\RecordingStartedRequest;
use OCA\Talk\Recording\RecordingStoppedRequest;
use OCA\Talk\Room;
use OCA\Talk\Service\CertificateService;
use OCA\Talk\Service\ParticipantService;
use OCA\Talk\Service\RecordingService;
use OCA\Talk\Service\RoomService;
use OCA\Talk\Vendor\CuyZ\Valinor\Mapper\MappingError;
use OCA\Talk\Vendor\CuyZ\Valinor\Mapper\Source\Source;
use OCA\Talk\Vendor\CuyZ\Valinor\MapperBuilder;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\BruteForceProtection;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
@ -154,8 +161,6 @@ class RecordingController extends AEnvironmentAwareOCSController {
/**
* Return the body of the backend request. This can be overridden in
* tests.
*
* @return string
*/
protected function getInputStream(): string {
return (string)file_get_contents('php://input');
@ -191,36 +196,39 @@ class RecordingController extends AEnvironmentAwareOCSController {
return $response;
}
$message = json_decode($json, true);
switch ($message['type'] ?? '') {
case 'started':
return $this->backendStarted($message['started']);
case 'stopped':
return $this->backendStopped($message['stopped']);
case 'failed':
return $this->backendFailed($message['failed']);
default:
return new DataResponse([
'type' => 'error',
'error' => [
'code' => 'unknown_type',
'message' => 'The given type ' . json_encode($message) . ' is not supported.',
],
], Http::STATUS_BAD_REQUEST);
try {
$request = (new MapperBuilder())
->mapper()
->map(RecordingRequest::class, Source::json($json));
} catch (MappingError $e) {
$this->logger->error($e->getMessage(), ['exception' => $e]);
return new DataResponse([
'type' => 'error',
'error' => [
'code' => 'unknown_type',
'message' => 'The given request is not supported.',
],
], Http::STATUS_BAD_REQUEST);
}
return match ($request->type) {
RecordingRequest::TYPE_STARTED => $this->backendStarted($request->started),
RecordingRequest::TYPE_STOPPED => $this->backendStopped($request->stopped),
RecordingRequest::TYPE_FAILED => $this->backendFailed($request->failed),
};
}
/**
* @return DataResponse<Http::STATUS_OK, null, array{}>|DataResponse<Http::STATUS_NOT_FOUND, array{type: string, error: array{code: string, message: string}}, array{}>
*/
private function backendStarted(array $started): DataResponse {
$token = $started['token'];
$status = $started['status'];
$actor = $started['actor'];
private function backendStarted(RecordingStartedRequest $started): DataResponse {
$token = $started->token;
$status = $started->status;
$actor = $started->actor;
try {
$room = $this->manager->getRoomByToken($token);
} catch (RoomNotFoundException $e) {
} catch (RoomNotFoundException) {
$this->logger->debug('Failed to get room {token}', [
'token' => $token,
'app' => 'spreed-recording',
@ -252,7 +260,7 @@ class RecordingController extends AEnvironmentAwareOCSController {
try {
$participant = $this->participantService->getParticipantByActor($room, $actor['type'], $actor['id']);
} catch (ParticipantNotFoundException $e) {
} catch (ParticipantNotFoundException) {
$participant = null;
}
@ -264,12 +272,9 @@ class RecordingController extends AEnvironmentAwareOCSController {
/**
* @return DataResponse<Http::STATUS_OK, null, array{}>|DataResponse<Http::STATUS_NOT_FOUND, array{type: string, error: array{code: string, message: string}}, array{}>
*/
private function backendStopped(array $stopped): DataResponse {
$token = $stopped['token'];
$actor = null;
if (array_key_exists('actor', $stopped)) {
$actor = $stopped['actor'];
}
private function backendStopped(RecordingStoppedRequest $stopped): DataResponse {
$token = $stopped->token;
$actor = $stopped->actor;
try {
$room = $this->manager->getRoomByToken($token);
@ -305,12 +310,12 @@ class RecordingController extends AEnvironmentAwareOCSController {
/**
* @return DataResponse<Http::STATUS_OK, null, array{}>|DataResponse<Http::STATUS_NOT_FOUND, array{type: string, error: array{code: string, message: string}}, array{}>
*/
private function backendFailed(array $failed): DataResponse {
$token = $failed['token'];
private function backendFailed(RecordingFailedRequest $failed): DataResponse {
$token = $failed->token;
try {
$room = $this->manager->getRoomByToken($token);
} catch (RoomNotFoundException $e) {
} catch (RoomNotFoundException) {
$this->logger->debug('Failed to get room {token}', [
'token' => $token,
'app' => 'spreed-recording',

17
lib/Recording/RecordingFailedRequest.php Normal file
View file

@ -0,0 +1,17 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Recording;
final readonly class RecordingFailedRequest {
public function __construct(
/** @var non-empty-string */
public string $token,
) {
}
}

24
lib/Recording/RecordingRequest.php Normal file
View file

@ -0,0 +1,24 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Recording;
final readonly class RecordingRequest {
public const TYPE_STARTED = 'started';
public const TYPE_STOPPED = 'stopped';
public const TYPE_FAILED = 'failed';
public function __construct(
/** @var self::TYPE_* */
public string $type,
public ?RecordingStartedRequest $started = null,
public ?RecordingStoppedRequest $stopped = null,
public ?RecordingFailedRequest $failed = null,
) {
}
}

23
lib/Recording/RecordingStartedRequest.php Normal file
View file

@ -0,0 +1,23 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Recording;
use OCA\Talk\Room;
final readonly class RecordingStartedRequest {
public function __construct(
/** @var non-empty-string */
public string $token,
/** @var Room::RECORDING_* */
public int $status,
/** @var array{type: string, id: string} */
public array $actor,
) {
}
}

19
lib/Recording/RecordingStoppedRequest.php Normal file
View file

@ -0,0 +1,19 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Recording;
final readonly class RecordingStoppedRequest {
public function __construct(
/** @var non-empty-string */
public string $token,
/** @var ?array{type: string, id: string} */
public ?array $actor = null,
) {
}
}

90
tests/php/Recording/RecordingRequestTest.php Normal file
View file

@ -0,0 +1,90 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Tests\php\Recording;
use OCA\Talk\Recording\RecordingRequest;
use OCA\Talk\Room;
use OCA\Talk\Vendor\CuyZ\Valinor\Mapper\Source\Source;
use OCA\Talk\Vendor\CuyZ\Valinor\MapperBuilder;
use PHPUnit\Framework\Attributes\DataProvider;
use Test\TestCase;
class RecordingRequestTest extends TestCase {
public static function dataRequests(): array {
return [
[
[
'type' => 'started',
'started' => [
'token' => '0123456789',
'actor' => [
'type' => 'users',
'id' => 'user1',
],
'status' => Room::RECORDING_VIDEO,
],
],
],
[
[
'type' => 'started',
'started' => [
'token' => '0123456789',
'actor' => [
'type' => 'users',
'id' => 'user1',
],
'status' => Room::RECORDING_AUDIO,
],
],
],
[
[
'type' => 'stopped',
'stopped' => [
'token' => '0123456789',
'actor' => [
'type' => 'users',
'id' => 'user1',
],
],
],
],
[
[
'type' => 'stopped',
'stopped' => [
'token' => '0123456789',
],
],
],
[
[
'type' => 'failed',
'failed' => [
'token' => '0123456789',
],
],
],
];
}
#[DataProvider('dataRequests')]
public function testRequests(array $requestArray): void {
$json = json_encode($requestArray, JSON_THROW_ON_ERROR);
$request = (new MapperBuilder())
->mapper()
->map(RecordingRequest::class, Source::json($json));
$this->assertInstanceOf(RecordingRequest::class, $request);
}
}