osu-web / tests / Controllers / Chat / Channels / MessagesControllerTest.php

<?php

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the GNU Affero General Public License v3.0.
// See the LICENCE file in the repository root for full licence text.

declare(strict_types=1);

namespace Tests\Controllers\Chat\Channels;

use App\Models\Chat\Channel;
use App\Models\Chat\UserChannel;
use App\Models\ChatFilter;
use App\Models\User;
use App\Models\UserRelation;
use Faker;
use Tests\TestCase;

class MessagesControllerTest extends TestCase
{
    protected static $faker;

    private User $anotherUser;
    private Channel $privateChannel;
    private Channel $publicChannel;
    private User $restrictedUser;
    private User $silencedUser;
    private Channel $tourneyChannel;
    private User $user;

    public static function setUpBeforeClass(): void
    {
        self::$faker = Faker\Factory::create();
    }

    //region GET /chat/channels/[channel_id]/messages - Get Channel Messages (public)
    public function testChannelShowPublicWhenGuest() // fail
    {
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->publicChannel->channel_id]))
            ->assertStatus(401);
    }

    public function testChannelShowPublicWhenUnjoined() // fail
    {
        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->publicChannel->channel_id]))
            ->assertStatus(404);
    }

    public function testChannelShowPublicWhenJoined() // success
    {
        $this->actAsScopedUser($this->user, ['*']);
        $this->json('PUT', route('api.chat.channels.join', [
            'channel' => $this->publicChannel->channel_id,
            'user' => $this->user->user_id,
        ]));

        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->publicChannel->channel_id]))
            ->assertStatus(200);
        // TODO: Add check for messages being present?
    }

    //endregion

    //region GET /chat/channels/[channel_id]/messages - Get Channel Messages (tourney)
    public function testChannelShowTourneyWhenGuest() // fail
    {
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->tourneyChannel->channel_id]))
            ->assertStatus(401);
    }

    public function testChannelShowTourneyWhenUnjoined() // fail
    {
        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->tourneyChannel->channel_id]))
            ->assertStatus(404);
    }

    public function testChannelShowTourneyWhenJoined() // success
    {
        $this->actAsScopedUser($this->user, ['*']);
        $this->json('PUT', route('api.chat.channels.join', [
            'channel' => $this->tourneyChannel->channel_id,
            'user' => $this->user->user_id,
        ]))->assertSuccessful();

        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->tourneyChannel->channel_id]))
            ->assertStatus(200);
        // TODO: Add check for messages being present?
    }

    //endregion

    //region GET /chat/channels/[channel_id]/messages - Get Channel Messages (private)
    public function testChannelShowPrivateWhenGuest() // fail
    {
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->privateChannel->channel_id]))
            ->assertStatus(401);
    }

    public function testChannelShowPrivateWhenNotJoined() // fail
    {
        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->privateChannel->channel_id]))
            ->assertStatus(404);
    }

    public function testChannelShowPrivateWhenJoined() // success
    {
        $this->userChannel = UserChannel::factory()->create([
            'user_id' => $this->user->user_id,
            'channel_id' => $this->privateChannel->channel_id,
        ]);

        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $this->privateChannel->channel_id]))
            ->assertStatus(200);
    }

    //endregion

    //region GET /chat/channels/[channel_id]/messages - Get Channel Messages (pm)
    public function testChannelShowPMWhenGuest() // fail
    {
        $pmChannel = Channel::factory()->type('pm')->create();
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $pmChannel->channel_id]))
            ->assertStatus(401);
    }

    public function testChannelShowPMWhenNotJoined() // fail
    {
        $pmChannel = Channel::factory()->type('pm')->create();
        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $pmChannel->channel_id]))
            ->assertStatus(404);
    }

    public function testChannelShowPMWhenTargetRestricted() // fail
    {
        $pmChannel = Channel::factory()->type('pm', [$this->user, $this->restrictedUser])->create();

        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $pmChannel->channel_id]))
            ->assertStatus(404);
    }

    public function testChannelShowPM() // success
    {
        $pmChannel = Channel::factory()->type('pm', [$this->user, $this->anotherUser])->create();

        $this->actAsScopedUser($this->user, ['*']);
        $this->json('GET', route('api.chat.channels.messages.index', ['channel' => $pmChannel->channel_id]))
            ->assertStatus(200);
        // TODO: Add check for messages being present?
    }

    //endregion

    //region POST /chat/channels/[channel_id]/messages - Send Message to Channel
    public function testChannelSendFiltered()
    {
        $this->actAsScopedUser($this->user, ['*']);
        $this->json('PUT', route('api.chat.channels.join', [
            'channel' => $this->publicChannel->getKey(),
            'user' => $this->user->getKey(),
        ]));

        $filter = ChatFilter::factory()->create();

        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $this->publicChannel->getKey()]),
            ['message' => $filter->match],
        )
            ->assertJsonFragment(['content' => $filter->replacement]);
    }

    public function testChannelSendWhenGuest() // fail
    {
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $this->publicChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )->assertStatus(401);
    }

    public function testChannelSendWhenUnjoined() // fail
    {
        $this->actAsScopedUser($this->user, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $this->publicChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenJoined() // success
    {
        $message = self::$faker->sentence();

        $this->actAsScopedUser($this->user, ['*']);
        $this->json('PUT', route('api.chat.channels.join', [
            'channel' => $this->publicChannel->channel_id,
            'user' => $this->user->user_id,
        ]));

        $this->actAsScopedUser($this->user, ['*']);

        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $this->publicChannel->channel_id]),
            ['message' => $message]
        )
            ->assertStatus(200)
            ->assertJsonFragment(['content' => $message]);
    }

    public function testChannelSendWhenModerated() // fail
    {
        $moderatedChannel = Channel::factory()->type('public')->create(['moderated' => true]);

        $this->actAsScopedUser($this->user, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $moderatedChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenBlocking() // fail
    {
        $pmChannel = Channel::factory()->type('pm', [$this->user, $this->anotherUser])->create();
        UserRelation::factory()->block()->create([
            'user_id' => $this->user,
            'zebra_id' => $this->anotherUser,
        ]);

        $this->actAsScopedUser($this->user, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $pmChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenBlocked() // fail
    {
        $pmChannel = Channel::factory()->type('pm', [$this->user, $this->anotherUser])->create();
        UserRelation::factory()->block()->create([
            'user_id' => $this->anotherUser,
            'zebra_id' => $this->user,
        ]);

        $this->actAsScopedUser($this->user, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $pmChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenRestrictedToPM() // fail
    {
        $pmChannel = Channel::factory()->type('pm', [$this->restrictedUser, $this->anotherUser])->create();

        $this->actAsScopedUser($this->restrictedUser, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $pmChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenRestrictedToPublic() // fail
    {
        $this->actAsScopedUser($this->restrictedUser, ['*']);
        $this->json('PUT', route('api.chat.channels.join', [
            'channel' => $this->publicChannel->channel_id,
            'user' => $this->restrictedUser->user_id,
        ]));

        $this->actAsScopedUser($this->restrictedUser, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $this->publicChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenTargetRestricted() // fail
    {
        $pmChannel = Channel::factory()->type('pm', [$this->user, $this->restrictedUser])->create();

        $this->actAsScopedUser($this->user, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $pmChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(404);
    }

    public function testChannelSendWhenTourney() // fail
    {
        $message = self::$faker->sentence();

        $this->actAsScopedUser($this->user, ['*']);
        $this->json('PUT', route('api.chat.channels.join', [
            'channel' => $this->tourneyChannel->channel_id,
            'user' => $this->user->user_id,
        ]));

        $this->actAsScopedUser($this->user, ['*']);

        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $this->tourneyChannel->channel_id]),
            ['message' => $message]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenSilencedToPM() // fail
    {
        $pmChannel = Channel::factory()->type('pm', [$this->silencedUser, $this->anotherUser])->create();

        $this->actAsScopedUser($this->silencedUser, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $pmChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    public function testChannelSendWhenSilencedToPublic() // fail
    {
        $this->actAsScopedUser($this->silencedUser, ['*']);
        $this->json('PUT', route('api.chat.channels.join', [
            'channel' => $this->publicChannel->channel_id,
            'user' => $this->silencedUser->user_id,
        ]));

        $this->actAsScopedUser($this->silencedUser, ['*']);
        $this->json(
            'POST',
            route('api.chat.channels.messages.store', ['channel' => $this->publicChannel->channel_id]),
            ['message' => self::$faker->sentence()]
        )
            ->assertStatus(403);
    }

    //endregion

    protected function setUp(): void
    {
        parent::setUp();

        $this->user = User::factory()->withPlays()->create();
        $this->anotherUser = User::factory()->create();
        $this->restrictedUser = User::factory()->restricted()->create();
        $this->silencedUser = User::factory()->silenced()->create();
        $this->publicChannel = Channel::factory()->type('public')->create();
        $this->privateChannel = Channel::factory()->type('private')->create();
        $this->tourneyChannel = Channel::factory()->tourney()->create();
    }
}