osu-web / tests / BeatmapsetDisqualifyNotificationsTest.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.

namespace Tests;

use App\Events\NewPrivateNotificationEvent;
use App\Jobs\Notifications\BeatmapsetDisqualify;
use App\Models\Beatmap;
use App\Models\Beatmapset;
use App\Models\Notification;
use App\Models\User;
use App\Models\UserNotificationOption;
use Event;
use Queue;

class BeatmapsetDisqualifyNotificationsTest extends TestCase
{
    /** @var Beatmapset */
    protected $beatmapset;

    /** @var User */
    protected $sender;

    /** @var User */
    protected $user;

    #region notification tests
    public function testDuplicateNotificationNotSent()
    {
        $this->beatmapset->watches()->create(['user_id' => $this->user->getKey()]);
        $this->createNotificationOption();

        $this->disqualify()->assertStatus(200);

        Queue::assertPushed(BeatmapsetDisqualify::class);

        $this->runFakeQueue();

        $events = Event::dispatched(NewPrivateNotificationEvent::class, function (NewPrivateNotificationEvent $event) {
            if ($event->notification->name === Notification::BEATMAPSET_DISQUALIFY) {
                $this->assertSame(array_unique($event->getReceiverIds()), $event->getReceiverIds());

                return true;
            }

            return false;
        });

        $this->assertSame(1, $events->count());
    }

    public function testNotificationSentIfWatching()
    {
        $this->beatmapset->watches()->create(['user_id' => $this->user->getKey()]);

        $this->disqualify()->assertStatus(200);

        Queue::assertPushed(BeatmapsetDisqualify::class);

        $this->runFakeQueue();

        Event::assertDispatched(NewPrivateNotificationEvent::class, function (NewPrivateNotificationEvent $event) {
            return $event->notification->name === Notification::BEATMAPSET_DISQUALIFY
                && $this->inReceivers($this->user, $event);
        });
    }

    /**
     * @dataProvider booleanDataProvider
     */
    public function testNotificationSentWithPushNotificationDeliveryOption($pushEnabled)
    {
        $this->beatmapset->watches()->create(['user_id' => $this->user->getKey()]);
        $this->user->notificationOptions()->create([
            'name' => UserNotificationOption::BEATMAPSET_MODDING,
        ])->update(['details' => ['push' => $pushEnabled]]);

        $this->disqualify()->assertStatus(200);

        if ($pushEnabled) {
            Queue::assertPushed(BeatmapsetDisqualify::class);

            $this->runFakeQueue();

            Event::assertDispatched(NewPrivateNotificationEvent::class, function (NewPrivateNotificationEvent $event) {
                return $event->notification->name === Notification::BEATMAPSET_DISQUALIFY
                    && $this->inReceivers($this->user, $event);
            });
        } else {
            // We want to assert the job was queued but because there should be no receivers, there won't be a notification generated.
            Queue::assertPushed(BeatmapsetDisqualify::class);

            $this->runFakeQueue();

            Event::assertNotDispatched(NewPrivateNotificationEvent::class, function (NewPrivateNotificationEvent $event) {
                return $event->notification->name === Notification::BEATMAPSET_DISQUALIFY;
            });
        }
    }

    public function testNotificationSentIfNotificationOptionsEnabled()
    {
        $this->createNotificationOption();

        $this->disqualify()->assertStatus(200);

        Queue::assertPushed(BeatmapsetDisqualify::class);

        $this->runFakeQueue();

        Event::assertDispatched(NewPrivateNotificationEvent::class, function (NewPrivateNotificationEvent $event) {
            return $event->notification->name === Notification::BEATMAPSET_DISQUALIFY
                && $this->inReceivers($this->user, $event);
        });
    }

    public function testNotificationNotSentIfNotificationOptionsNotEnabled()
    {
        $this->disqualify()->assertStatus(200);

        Queue::assertPushed(BeatmapsetDisqualify::class);

        $this->runFakeQueue();

        Event::assertNotDispatched(NewPrivateNotificationEvent::class);
    }
    #endregion

    public static function booleanDataProvider()
    {
        return [
            [true],
            [false],
        ];
    }

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

        Queue::fake();
        Event::fake();

        $this->beatmapset = Beatmapset::factory()->owner()->qualified()->withDiscussion()->create();
        $this->sender = User::factory()->withGroup('bng')->create();
        $this->user = User::factory()->create();
    }

    private function createNotificationOption()
    {
        $this->user->notificationOptions()->create([
            'name' => Notification::BEATMAPSET_DISQUALIFY,
        ])->update(['details' => ['modes' => array_keys(Beatmap::MODES)]]);
    }

    private function disqualify()
    {
        return $this
            ->actingAsVerified($this->sender)
            ->post(route('beatmapsets.discussions.posts.store'), [
                'beatmapset_id' => $this->beatmapset->beatmapset_id,
                'beatmap_discussion' => [
                    'message_type' => 'problem',
                ],
                'beatmap_discussion_post' => [
                    'message' => 'Hello',
                ],
            ]);
    }
}