animethemes-server/tests/Feature/Http/Wiki/Video/VideoTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature\Http\Wiki\Video;

use App\Constants\Config\FlagConstants;
use App\Constants\Config\VideoConstants;
use App\Enums\Http\StreamingMethod;
use App\Events\Wiki\Video\VideoThrottled;
use App\Jobs\SendDiscordNotificationJob;
use App\Models\Wiki\Video;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Bus;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Storage;
use Symfony\Component\HttpFoundation\StreamedResponse;
use Tests\TestCase;

/**
 * Class VideoTest.
 */
class VideoTest extends TestCase
{
    use WithFaker;

    /**
     * If video streaming is disabled through the 'flags.allow_video_streams' property,
     * the user shall receive a forbidden exception.
     *
     * @return void
     */
    public function testVideoStreamingNotAllowedForbidden(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, false);

        $video = Video::factory()->createOne();

        $response = $this->get(route('video.show', ['video' => $video]));

        $response->assertForbidden();
    }

    /**
     * If the video is soft-deleted, the user shall receive a forbidden exception.
     *
     * @return void
     */
    public function testSoftDeleteVideoStreamingForbidden(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);

        $video = Video::factory()->createOne();

        $video->delete();

        $response = $this->get(route('video.show', ['video' => $video]));

        $response->assertForbidden();
    }

    /**
     * If view recording is disabled, the video show route shall not record a view for the video.
     *
     * @return void
     */
    public function testViewRecordingNotAllowed(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(FlagConstants::ALLOW_VIEW_RECORDING_FLAG_QUALIFIED, false);

        $video = Video::factory()->createOne();

        $this->get(route('video.show', ['video' => $video]));

        static::assertEquals(0, $video->views()->count());
    }

    /**
     * If view recording is enabled, the video show route shall record a view for the video.
     *
     * @return void
     */
    public function testViewRecordingIsAllowed(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(FlagConstants::ALLOW_VIEW_RECORDING_FLAG_QUALIFIED, true);

        $video = Video::factory()->createOne();

        $this->get(route('video.show', ['video' => $video]));

        static::assertEquals(1, $video->views()->count());
    }

    /**
     * If view recording is enabled, the video show route shall record a view for the video.
     *
     * @return void
     */
    public function testViewRecordingCooldown(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(FlagConstants::ALLOW_VIEW_RECORDING_FLAG_QUALIFIED, true);

        $video = Video::factory()->createOne();

        Collection::times($this->faker->randomDigitNotNull(), function () use ($video) {
            $this->get(route('video.show', ['video' => $video]));
        });

        static::assertEquals(1, $video->views()->count());
    }

    /**
     * If the streaming method is set to an unexpected value, the user shall receive an error.
     *
     * @return void
     */
    public function testInvalidStreamingMethodError(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(VideoConstants::STREAMING_METHOD_QUALIFIED, $this->faker->word());

        $video = Video::factory()->createOne();

        $response = $this->get(route('video.show', ['video' => $video]));

        $response->assertServerError();
    }

    /**
     * If the streaming method is set to 'response', the video shall be streamed through a Symfony StreamedResponse.
     *
     * @return void
     */
    public function testStreamedThroughResponse(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(VideoConstants::STREAMING_METHOD_QUALIFIED, StreamingMethod::RESPONSE);

        $video = Video::factory()->createOne();

        $response = $this->get(route('video.show', ['video' => $video]));

        static::assertInstanceOf(StreamedResponse::class, $response->baseResponse);
    }

    /**
     * If the streaming method is set to 'nginx', the video shall be streamed through a nginx internal redirect.
     *
     * @return void
     */
    public function testStreamedThroughNginxRedirect(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(VideoConstants::STREAMING_METHOD_QUALIFIED, StreamingMethod::NGINX);

        $video = Video::factory()->createOne();

        $response = $this->get(route('video.show', ['video' => $video]));

        $response->assertHeader('X-Accel-Redirect');
    }

    /**
     * If the video rate limit is less than or equal to zero, videos shall not be throttled.
     *
     * @return void
     */
    public function testNotThrottled(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(VideoConstants::STREAMING_METHOD_QUALIFIED, StreamingMethod::getRandomValue());

        $video = Video::factory()->createOne();

        $response = $this->get(route('video.show', ['video' => $video]));

        $response->assertHeaderMissing('X-RateLimit-Limit');
        $response->assertHeaderMissing('X-RateLimit-Remaining');
    }

    /**
     * If the video rate limit is greater than or equal to zero, videos shall be throttled.
     *
     * @return void
     */
    public function testRateLimited(): void
    {
        $this->withoutEvents();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(VideoConstants::STREAMING_METHOD_QUALIFIED, StreamingMethod::getRandomValue());
        Config::set(VideoConstants::RATE_LIMITER_QUALIFIED, $this->faker->randomDigitNotNull());

        $video = Video::factory()->createOne();

        $response = $this->get(route('video.show', ['video' => $video]));

        $response->assertHeader('X-RateLimit-Limit');
        $response->assertHeader('X-RateLimit-Remaining');
    }

    /**
     * If the video rate limit attempt is exceeded, a VideoThrottled event shall be dispatched.
     *
     * @return void
     */
    public function testThrottledEvent(): void
    {
        $limit = $this->faker->randomDigitNotNull();

        Event::fake();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(VideoConstants::STREAMING_METHOD_QUALIFIED, StreamingMethod::getRandomValue());
        Config::set(VideoConstants::RATE_LIMITER_QUALIFIED, $limit);

        $video = Video::factory()->createOne();

        Collection::times($limit + 1, function () use ($video) {
            $this->get(route('video.show', ['video' => $video]));
        });

        Event::assertDispatched(VideoThrottled::class);
    }

    /**
     * If the video rate limit attempt is exceeded, a SendDiscordNotification job shall be dispatched.
     *
     * @return void
     */
    public function testThrottledNotification(): void
    {
        $limit = $this->faker->randomDigitNotNull();

        Storage::fake(Config::get(VideoConstants::DEFAULT_DISK_QUALIFIED));

        Bus::fake(SendDiscordNotificationJob::class);

        Config::set(FlagConstants::ALLOW_DISCORD_NOTIFICATIONS_FLAG_QUALIFIED, true);
        Config::set(FlagConstants::ALLOW_VIDEO_STREAMS_FLAG_QUALIFIED, true);
        Config::set(VideoConstants::STREAMING_METHOD_QUALIFIED, StreamingMethod::getRandomValue());
        Config::set(VideoConstants::RATE_LIMITER_QUALIFIED, $limit);

        $video = Video::factory()->createOne();

        Collection::times($limit + 1, function () use ($video) {
            $this->get(route('video.show', ['video' => $video]));
        });

        Bus::assertDispatched(SendDiscordNotificationJob::class);
    }
}