whisper-money/tests/Feature/MailSenderTest.php

<?php

use App\Mail\BankingConnectionAuthFailedEmail;
use App\Mail\BankTransactionsSyncedEmail;
use App\Mail\BrokenBankLogosReportEmail;
use App\Mail\Drip\AiConsentFollowUpEmail;
use App\Mail\Drip\FeedbackEmail;
use App\Mail\Drip\ImportHelpEmail;
use App\Mail\Drip\OnboardingReminderEmail;
use App\Mail\Drip\PaywallFollowUpEmail;
use App\Mail\Drip\PromoCodeEmail;
use App\Mail\Drip\SubscriptionCancelledEmail;
use App\Mail\Drip\WelcomeEmail;
use App\Mail\EnableBankingConnectionsCancelledEmail;
use App\Mail\UpdateEmail;
use App\Mail\WaitlistOvertaken;
use App\Mail\WaitlistReferralNotification;
use App\Mail\WaitlistWelcome;
use App\Models\BankingConnection;
use App\Models\User;
use App\Models\UserLead;
use App\Notifications\VerifyEmailNotification;
use App\Notifications\VerifyUserLeadEmailNotification;
use Illuminate\Mail\Mailables\Address;
use Illuminate\Mail\Mailer;
use Illuminate\Mail\Transport\ArrayTransport;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Mail;

beforeEach(function () {
    config([
        'mail.default' => 'array',
        'mail.from.address' => 'no-reply@whisper.money',
        'mail.from.name' => 'Whisper Money',
        'mail.drip_from.address' => 'hi@whisper.money',
        'mail.drip_from.name' => 'Álvaro and Víctor',
    ]);

    $viewPath = resource_path('views/mail/updates');

    if (! File::exists($viewPath)) {
        File::makeDirectory($viewPath, 0755, true);
    }

    File::put(resource_path('views/mail/updates/test-update.blade.php'), <<<'BLADE'
<x-mail::message>
# Test Update

Hello {{ $user->name }},

Test update.
</x-mail::message>
BLADE);
});

afterEach(function () {
    $testViewPath = resource_path('views/mail/updates/test-update.blade.php');

    if (File::exists($testViewPath)) {
        File::delete($testViewPath);
    }
});

function lastSentMailMessage(): object
{
    /** @var Mailer $mailer */
    $mailer = Mail::mailer('array');
    /** @var ArrayTransport $transport */
    $transport = $mailer->getSymfonyTransport();

    return $transport->messages()->last();
}

function sendWithArrayMailer($mailable): void
{
    /** @var Mailer $mailer */
    $mailer = Mail::mailer('array');
    /** @var ArrayTransport $transport */
    $transport = $mailer->getSymfonyTransport();
    $transport->flush();

    $mailer->to('recipient@example.com')->sendNow($mailable);
}

test('drip mailables use the drip sender', function (string $mailableClass) {
    $user = User::factory()->create();

    $mailable = match ($mailableClass) {
        AiConsentFollowUpEmail::class => new AiConsentFollowUpEmail($user),
        WelcomeEmail::class => new WelcomeEmail($user),
        FeedbackEmail::class => new FeedbackEmail($user),
        ImportHelpEmail::class => new ImportHelpEmail($user),
        OnboardingReminderEmail::class => new OnboardingReminderEmail($user),
        PaywallFollowUpEmail::class => new PaywallFollowUpEmail($user),
        PromoCodeEmail::class => new PromoCodeEmail($user),
        SubscriptionCancelledEmail::class => new SubscriptionCancelledEmail($user),
    };

    expect($mailable->envelope()->from)->toEqual(new Address('hi@whisper.money', 'Álvaro and Víctor'));
})->with([
    AiConsentFollowUpEmail::class,
    WelcomeEmail::class,
    FeedbackEmail::class,
    ImportHelpEmail::class,
    OnboardingReminderEmail::class,
    PaywallFollowUpEmail::class,
    PromoCodeEmail::class,
    SubscriptionCancelledEmail::class,
]);

test('only the paywall follow-up sets a reply-to, back to the drip sender', function () {
    $user = User::factory()->create();

    expect((new PaywallFollowUpEmail($user))->envelope()->replyTo)
        ->toEqual([new Address('hi@whisper.money', 'Álvaro and Víctor')]);

    expect((new WelcomeEmail($user))->envelope()->replyTo)->toBe([]);
});

test('promo code email adds the founder promo code to its view data', function () {
    $user = User::factory()->create();

    expect((new PromoCodeEmail($user))->content()->with)
        ->toEqual(['userName' => $user->name, 'promoCode' => 'FOUNDER']);
});

test('default sender is used for active non-drip mailables', function (string $mailableClass) {
    $user = User::factory()->create();

    $mailable = match ($mailableClass) {
        UpdateEmail::class => new UpdateEmail($user, 'test-update'),
        BankTransactionsSyncedEmail::class => new BankTransactionsSyncedEmail($user, 3, ['Test Bank' => 3]),
        BankingConnectionAuthFailedEmail::class => new BankingConnectionAuthFailedEmail($user, BankingConnection::factory()->for($user)->create(['aspsp_name' => 'Test Bank'])),
        EnableBankingConnectionsCancelledEmail::class => new EnableBankingConnectionsCancelledEmail($user, 2),
        BrokenBankLogosReportEmail::class => new BrokenBankLogosReportEmail([['id' => 'bank-1', 'name' => 'Test Bank', 'previous_logo' => 'https://example.com/logo.png']]),
        WaitlistWelcome::class => new WaitlistWelcome(UserLead::factory()->create()),
        WaitlistReferralNotification::class => new WaitlistReferralNotification(UserLead::factory()->create()),
        WaitlistOvertaken::class => new WaitlistOvertaken(UserLead::factory()->create()),
    };

    sendWithArrayMailer($mailable);

    $from = lastSentMailMessage()->getOriginalMessage()->getFrom()[0];

    expect($from->getAddress())->toBe('no-reply@whisper.money')
        ->and($from->getName())->toBe('Whisper Money');
})->with([
    UpdateEmail::class,
    BankTransactionsSyncedEmail::class,
    BankingConnectionAuthFailedEmail::class,
    EnableBankingConnectionsCancelledEmail::class,
    BrokenBankLogosReportEmail::class,
    WaitlistWelcome::class,
    WaitlistReferralNotification::class,
    WaitlistOvertaken::class,
]);

test('transaction sync email envelope explicitly uses the default sender', function () {
    $user = User::factory()->create();

    $mailable = new BankTransactionsSyncedEmail($user, 3, ['Test Bank' => 3]);

    expect($mailable->envelope()->from)->toEqual(new Address('no-reply@whisper.money', 'Whisper Money'));
});

test('verification notification uses the default sender', function () {
    $user = User::factory()->unverified()->create();

    $user->notify(new VerifyEmailNotification);

    $from = lastSentMailMessage()->getOriginalMessage()->getFrom()[0];

    expect($from->getAddress())->toBe('no-reply@whisper.money')
        ->and($from->getName())->toBe('Whisper Money');
});

test('user lead verification notification uses the default sender', function () {
    $lead = UserLead::factory()->unverified()->create();

    $lead->notify(new VerifyUserLeadEmailNotification('https://example.com/verify'));

    $from = lastSentMailMessage()->getOriginalMessage()->getFrom()[0];

    expect($from->getAddress())->toBe('no-reply@whisper.money')
        ->and($from->getName())->toBe('Whisper Money');
});

test('mail blade signatures use alvaro before victor', function () {
    $mailViews = [
        'mail/verify-email.blade.php',
        'mail/verify-user-lead-email.blade.php',
        'mail/waitlist-welcome.blade.php',
        'mail/waitlist-referral-notification.blade.php',
        'mail/user-lead-invitation.blade.php',
        'mail/waitlist-overtaken.blade.php',
        'mail/drip/import-help.blade.php',
        'mail/drip/onboarding-reminder.blade.php',
        'mail/drip/promo-code.blade.php',
        'mail/drip/subscription-cancelled.blade.php',
        'mail/drip/welcome.blade.php',
        'mail/bank-transactions-synced.blade.php',
        'mail/drip/feedback.blade.php',
        'mail/banking-connection-auth-failed.blade.php',
        'mail/enable-banking-connections-cancelled.blade.php',
    ];

    foreach ($mailViews as $mailView) {
        $contents = File::get(resource_path("views/{$mailView}"));

        expect($contents)
            ->toContain("{{ __('Álvaro & Víctor') }}<br>")
            ->not->toContain("{{ __('Víctor & Álvaro') }}<br>");
    }
});

test('enable banking cancellation email includes dashboard access messaging', function () {
    $user = User::factory()->create(['name' => 'Test User']);

    $mailable = new EnableBankingConnectionsCancelledEmail($user, 2);

    $mailable->assertHasSubject('Your bank connections were disconnected');
    $mailable->assertSeeInHtml('Go to Dashboard');
    $mailable->assertSeeInHtml('free access');
    $mailable->assertSeeInHtml('accounts, transactions, and balances remain in Whisper Money');
    $mailable->assertSeeInHtml(route('dashboard'));
});