projectsend/tests/Feature/Platform/ExtensionSeamsTest.php

<?php

declare(strict_types=1);

use App\Models\User;
use App\Modules\Platform\Announcements\Events\ResolvingAnnouncement;
use App\Modules\Platform\Navigation\Events\ResolvingNavigationLinks;
use Illuminate\Support\Facades\Event;
use Inertia\Testing\AssertableInertia;

beforeEach(function () {
    $this->admin = User::factory()->create();
});

/*
|--------------------------------------------------------------------------
| Two seams a package fills, and core does not
|--------------------------------------------------------------------------
|
| Both are dispatched unconditionally, and with nothing listening the
| documented default holds — no links, no callout. That is what makes them
| safe to add to a community installation that will never have a listener.
*/

test('with nothing listening the dashboard is exactly what it was', function () {
    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement', null),
    );

    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page->where('extra_nav_links', []),
    );
});

test('a listener can put a message in front of staff', function () {
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('Heads up', 'Something worth reading.', ResolvingAnnouncement::AUDIENCE_STAFF, 'Do the thing', 'https://example.test/', 'warning');
    });

    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page
            ->where('announcement.title', 'Heads up')
            ->where('announcement.action_url', 'https://example.test/')
            ->where('announcement.tone', 'warning'),
    );
});

test('a listener can add a sidebar link', function () {
    Event::listen(ResolvingNavigationLinks::class, function (ResolvingNavigationLinks $event): void {
        $event->add('Somewhere else', 'https://example.test/', external: true);
    });

    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page
            ->where('extra_nav_links.0.title', 'Somewhere else')
            ->where('extra_nav_links.0.external', true),
    );
});

// The sidebar is the administration area. A client's portal shows their
// own files and nothing about the installation, so these must not reach
// them however careless a listener is.
test('a client gets no contributed links, even from a listener that adds unconditionally', function () {
    Event::listen(ResolvingNavigationLinks::class, function (ResolvingNavigationLinks $event): void {
        $event->add('Staff only really', 'https://example.test/');
    });

    $client = User::factory()->client()->create();

    $this->actingAs($client)->get('/my-files')->assertInertia(
        fn (AssertableInertia $page) => $page->where('extra_nav_links', []),
    );
});

// One band. A dashboard that can accumulate banners accumulates them, and
// the second is what teaches people to skip the first.
test('the first listener to set a callout keeps it', function () {
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('First', 'Set first.', ResolvingAnnouncement::AUDIENCE_STAFF);
    });
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('Second', 'Should not win.', ResolvingAnnouncement::AUDIENCE_STAFF);
    });

    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement.title', 'First'),
    );
});

test('an unknown tone falls back rather than rendering unstyled', function () {
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('T', 'B', ResolvingAnnouncement::AUDIENCE_STAFF, tone: 'chartreuse');
    });

    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement.tone', 'info'),
    );
});


// The header icon and the dashboard band read one shared prop, so a
// message reaches somebody who never opens the dashboard. Two props would
// have drifted the first time anybody edited one.
test('the same message is available away from the dashboard', function () {
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('Everywhere', 'Not only on the dashboard.', ResolvingAnnouncement::AUDIENCE_STAFF);
    });

    $this->actingAs($this->admin)->get('/system/settings/general')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement.title', 'Everywhere'),
    );
});

// A client's header carries the bell too. Nothing addressed to staff may
// appear there, however careless the listener.
// The guard that replaced "clients never see one". A listener aimed at
// staff reaches no client even when it never checks who is looking —
// which is the whole reason audience is enforced here rather than left
// to each listener to remember.
test('a message for staff reaches no client, even from a listener that never checks', function () {
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('Staff only', 'Not for clients.', ResolvingAnnouncement::AUDIENCE_STAFF);
    });

    $client = User::factory()->client()->create();

    $this->actingAs($client)->get('/my-files')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement', null),
    );
});

test('a message for clients reaches a client, and no staff member', function () {
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('For you', 'About your account.', ResolvingAnnouncement::AUDIENCE_CLIENTS);
    });

    $client = User::factory()->client()->create();

    $this->actingAs($client)->get('/my-files')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement.title', 'For you'),
    );

    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement', null),
    );
});

// An unrecognised audience reaches nobody rather than everybody: the
// mistake belongs in the quiet direction.
test('an unknown audience reaches nobody', function () {
    Event::listen(ResolvingAnnouncement::class, function (ResolvingAnnouncement $event): void {
        $event->show('Nowhere', 'Bad audience.', 'everyone');
    });

    $client = User::factory()->client()->create();

    $this->actingAs($this->admin)->get('/dashboard')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement', null),
    );
    $this->actingAs($client)->get('/my-files')->assertInertia(
        fn (AssertableInertia $page) => $page->where('announcement', null),
    );
});