WMS/Modules/Helpdesk/Tests/Browser/HelpdeskCreateTicketAttachmentBrowserTest.php

<?php

declare(strict_types=1);

namespace Modules\Helpdesk\Tests\Browser;

use Laravel\Dusk\Browser;
use Modules\Helpdesk\Models\Attachment;
use Modules\Helpdesk\Models\Ticket;
use Modules\Helpdesk\Tests\Concerns\BuildsHelpdeskFixtures;
use Tests\DuskTestCase;

final class HelpdeskCreateTicketAttachmentBrowserTest extends DuskTestCase
{
    use BuildsHelpdeskFixtures;

    public function test_user_can_create_ticket_with_attachment_in_browser(): void
    {
        $fixtures = $this->seedLookupData();
        $user = $this->user(['name' => 'Browser Attachment User']);
        $subject = 'Browser attachment ticket ' . uniqid('', true);
        $filePath = $this->makeBrowserUploadFile('browser-upload-proof.log', 'Browser upload proof file.');

        $this->browse(function (Browser $browser) use ($user, $fixtures, $subject, $filePath): void {
            $browser->loginAs($user)
                ->visitRoute('helpdesk.tickets.create')
                ->waitFor('@helpdesk-ticket-create', 10)
                ->assertSee('Create ticket')
                ->type('@ticket-subject', $subject);

            $this->setHelpdeskEditor(
                $browser,
                'ticket-body-editor',
                'This browser ticket proves attachments can be uploaded and saved.',
            );

            $this->setHelpdeskSelect($browser, 'board_id', $fixtures['board']->id);
            $this->setHelpdeskSelect($browser, 'priority_id', $fixtures['high']->id);
            $this->setHelpdeskSelect($browser, 'category_id', $fixtures['category']->id);
            $this->setHelpdeskSelect($browser, 'team_id', $fixtures['team']->id);
            $this->setHelpdeskSelect($browser, 'project_id', $fixtures['project']->id);

            $browser->attach('#attachments', $filePath);

            $this->waitForHelpdeskUploadToFinish($browser);

            $browser->press('@ticket-create-submit')
                ->waitUntilMissing('@helpdesk-ticket-create', 20)
                ->assertPathIs('/helpdesk/tickets')
                ->assertSee($subject);
        });

        $ticket = Ticket::query()
            ->where('subject', $subject)
            ->firstOrFail();

        $attachment = Attachment::query()
            ->where('ticket_id', $ticket->id)
            ->whereNull('comment_id')
            ->where('original_name', 'browser-upload-proof.log')
            ->firstOrFail();

        self::assertSame($ticket->id, (int) $attachment->ticket_id);
    }

    public function test_user_can_create_ticket_with_multiple_attachments_in_browser(): void
    {
        $fixtures = $this->seedLookupData();
        $user = $this->user(['name' => 'Browser Multi Attachment User']);
        $subject = 'Browser multiple attachment ticket ' . uniqid('', true);
        $firstFile = $this->makeBrowserUploadFile('browser-first-proof.txt', 'First browser upload proof file.');
        $secondFile = $this->makeBrowserUploadFile('browser-second-proof.csv', 'name,value' . PHP_EOL . 'proof,1');

        $this->browse(function (Browser $browser) use ($user, $fixtures, $subject, $firstFile, $secondFile): void {
            $browser->loginAs($user)
                ->visitRoute('helpdesk.tickets.create')
                ->waitFor('@helpdesk-ticket-create', 10)
                ->assertSee('Create ticket')
                ->type('@ticket-subject', $subject);

            $this->setHelpdeskEditor(
                $browser,
                'ticket-body-editor',
                'This browser ticket proves multiple attachments can be uploaded and saved.',
            );

            $this->setHelpdeskSelect($browser, 'board_id', $fixtures['board']->id);
            $this->setHelpdeskSelect($browser, 'priority_id', $fixtures['normal']->id);
            $this->setHelpdeskSelect($browser, 'category_id', $fixtures['category']->id);
            $this->setHelpdeskSelect($browser, 'team_id', $fixtures['team']->id);
            $this->setHelpdeskSelect($browser, 'project_id', $fixtures['project']->id);

            $browser->attach('#attachments', $firstFile . "\n" . $secondFile);

            $this->waitForHelpdeskUploadToFinish($browser);

            $browser->press('@ticket-create-submit')
                ->waitUntilMissing('@helpdesk-ticket-create', 20)
                ->assertPathIs('/helpdesk/tickets')
                ->assertSee($subject);
        });

        $ticket = Ticket::query()
            ->where('subject', $subject)
            ->firstOrFail();

        self::assertSame(
            2,
            Attachment::query()->where('ticket_id', $ticket->id)->whereNull('comment_id')->count(),
        );

        foreach (['browser-first-proof.txt', 'browser-second-proof.csv'] as $name) {
            $this->assertDatabaseHas('helpdesk_attachments', [
                'ticket_id' => $ticket->id,
                'comment_id' => null,
                'original_name' => $name,
            ]);
        }
    }

    private function makeBrowserUploadFile(string $name, string $contents): string
    {
        $directory = storage_path('framework/testing/helpdesk-browser-uploads');

        if (! is_dir($directory)) {
            mkdir($directory, 0777, true);
        }

        $path = $directory . DIRECTORY_SEPARATOR . $name;
        file_put_contents($path, $contents);

        return $path;
    }

    private function setHelpdeskEditor(Browser $browser, string $dusk, string $text): void
    {
        $encodedDusk = json_encode($dusk, JSON_THROW_ON_ERROR);
        $encodedText = json_encode($text, JSON_THROW_ON_ERROR);

        $browser->script(<<<JS
const key = {$encodedDusk};
const text = {$encodedText};
const editor = document.querySelector('[dusk="' + key + '"], [data-dusk="' + key + '"]');

if (! editor) {
    throw new Error('Helpdesk editor ' + key + ' was not found.');
}

editor.focus();
editor.textContent = text;
editor.dispatchEvent(new InputEvent('input', { bubbles: true, composed: true, inputType: 'insertText', data: text }));
editor.dispatchEvent(new Event('change', { bubbles: true, composed: true }));
editor.dispatchEvent(new Event('blur', { bubbles: true, composed: true }));
JS);

        $browser->pause(500);
    }

    private function setHelpdeskSelect(Browser $browser, string $model, int|string|null $value): void
    {
        $encodedModel = json_encode($model, JSON_THROW_ON_ERROR);
        $encodedValue = json_encode($value === null ? '' : (string) $value, JSON_THROW_ON_ERROR);

        $browser->script(<<<JS
const model = {$encodedModel};
const value = {$encodedValue};
const select = document.querySelector('[data-wire-model="' + model + '"]');

if (! select) {
    throw new Error('Helpdesk select ' + model + ' was not found.');
}

select.value = value;
select.dispatchEvent(new Event('change', { bubbles: true, composed: true }));

if (window.jQuery) {
    window.jQuery(select).val(value).trigger('change.select2').trigger('change.helpdesk-select2').trigger('change');
}
JS);

        $browser->pause(250);
    }

    private function waitForHelpdeskUploadToFinish(Browser $browser): void
    {
        $browser->waitUsing(30, 250, static function () use ($browser): bool {
            return (bool) $browser->script(<<<'JS'
const input = document.querySelector('#attachments');
const button = document.querySelector('[dusk="ticket-create-submit"], [data-dusk="ticket-create-submit"]');

const isVisible = (element) => {
    if (! element) {
        return false;
    }

    const style = window.getComputedStyle(element);

    return style.display !== 'none'
        && style.visibility !== 'hidden'
        && style.opacity !== '0'
        && element.getClientRects().length > 0;
};

const visibleUploadText = Array.from(document.querySelectorAll('div, span'))
    .some((element) => {
        const text = (element.textContent || '').trim();

        return (text.includes('Uploading attachments...') || text === 'Uploading...')
            && isVisible(element);
    });

return Boolean(input)
    && input.files.length > 0
    && Boolean(button)
    && button.disabled === false
    && visibleUploadText === false;
JS)[0];
        }, 'The attachment upload did not finish before submit.');
    }
}