EventsTest.php

<?php

use Illuminate\Support\Facades\DB;
use Pan\Contracts\AnalyticsRepository;
use Pan\PanConfiguration;
use Pan\ValueObjects\Analytic;

it('can create an analytic click event', function (): void {
    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    $analytics = array_map(fn (Analytic $analytic): array => $analytic->toArray(), app(AnalyticsRepository::class)->all());

    expect($analytics)->toBe([
        ['id' => 1, 'tenant' => null, 'name' => 'help-modal', 'impressions' => 0, 'hovers' => 0, 'clicks' => 1],
    ]);
});

it('can create an analytic hover event', function (): void {
    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal',
            'type' => 'hover',
        ]],
    ]);

    $response->assertStatus(204);

    $analytics = array_map(fn (Analytic $analytic): array => $analytic->toArray(), app(AnalyticsRepository::class)->all());

    expect($analytics)->toBe([
        ['id' => 1, 'tenant' => null, 'name' => 'help-modal', 'impressions' => 0, 'hovers' => 1, 'clicks' => 0],
    ]);
});

it('can create an analytic impression event', function (): void {
    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal',
            'type' => 'impression',
        ]],
    ]);

    $response->assertStatus(204);

    $analytics = array_map(fn (Analytic $analytic): array => $analytic->toArray(), app(AnalyticsRepository::class)->all());

    expect($analytics)->toBe([
        ['id' => 1, 'tenant' => null, 'name' => 'help-modal', 'impressions' => 1, 'hovers' => 0, 'clicks' => 0],
    ]);
});

it('can create an analytic impression event and click event', function (): void {
    $response = $this->post('/pan/events', [
        'events' => [
            [
                'name' => 'help-modal',
                'type' => 'impression',
            ],
            [
                'name' => 'help-modal',
                'type' => 'click',
            ],
        ],
    ]);

    $response->assertStatus(204);

    $analytics = array_map(fn (Analytic $analytic): array => $analytic->toArray(), app(AnalyticsRepository::class)->all());

    expect($analytics)->toBe([
        ['id' => 1, 'tenant' => null, 'name' => 'help-modal', 'impressions' => 1, 'hovers' => 0, 'clicks' => 1],
    ]);
});

it('does not create an analytic event if the event name is invalid', function (string $name): void {
    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => $name,
            'type' => 'impression',
        ]],
    ]);

    $response->assertStatus(302)->assertSessionHasErrors([
        'events.0.name' => 'The events.0.name field must only contain letters, numbers, dashes, and underscores.',
    ]);

    $analytics = array_map(fn (Analytic $analytic): array => $analytic->toArray(), app(AnalyticsRepository::class)->all());

    expect($analytics)->toBe([]);
})->with([
    'help modal',
    'help.modal',
    'help/modal',
    '🙋',
]);

it('does not create an analytic event if the event is invalid', function (): void {
    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal',
            'type' => 'invalid',
        ]],
    ]);

    $response->assertStatus(302)->assertSessionHasErrors([
        'events.0.type' => 'The selected events.0.type is invalid.',
    ]);

    $analytics = array_map(fn (Analytic $analytic): array => $analytic->toArray(), app(AnalyticsRepository::class)->all());

    expect($analytics)->toBe([]);
});

it('can create an event using a custom prefix url', function (): void {
    PanConfiguration::routePrefix('new-pan');

    $this->reloadApplication();

    $response = $this->post('/new-pan/events', [
        'events' => [[
            'name' => 'help-modal',
            'type' => 'impression',
        ]],
    ]);

    $response->assertStatus(204);

    $analytics = array_map(fn (Analytic $analytic): array => $analytic->toArray(), app(AnalyticsRepository::class)->all());

    expect($analytics)->toBe([
        ['id' => 1, 'tenant' => null, 'name' => 'help-modal', 'impressions' => 1, 'hovers' => 0, 'clicks' => 0],
    ]);
})->after(function (): void {
    PanConfiguration::routePrefix('pan');

    $this->reloadApplication();
});

it('does handle gracefully when there is more than 50 analytics created by default', function (): void {
    DB::table('pan_analytics')->insert(array_map(fn (int $index): array => [
        'name' => "help-modal-$index",
        'impressions' => 0,
        'hovers' => 0,
        'clicks' => 0,
    ], range(1, 49)));

    expect(DB::table('pan_analytics')->count())->toBe(49);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal-a',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(50);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal-b',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(50);
});

it('does handle gracefully when there is more than the max analytics created', function (): void {
    DB::table('pan_analytics')->insert(array_map(fn (int $index): array => [
        'name' => "help-modal-$index",
        'impressions' => 0,
        'hovers' => 0,
        'clicks' => 0,
    ], range(1, 49)));

    expect(DB::table('pan_analytics')->count())->toBe(49);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal-a',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(50);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal-b',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(50);

    PanConfiguration::instance()->maxAnalytics(100);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal-c',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(51);

    DB::table('pan_analytics')->insert(array_map(fn (int $index): array => [
        'name' => "help-modal-$index",
        'impressions' => 0,
        'hovers' => 0,
        'clicks' => 0,
    ], range(52, 99)));

    expect(DB::table('pan_analytics')->count())->toBe(99);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal-d',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(100);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal-e',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(100);
});

it('does handle gracefully when there is a name that is not allowed', function (): void {
    PanConfiguration::allowedAnalytics(['help-modal', 'contact-modal']);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'invalid-modal',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(0);

    $response = $this->post('/pan/events', [
        'events' => [[
            'name' => 'help-modal',
            'type' => 'click',
        ]],
    ]);

    $response->assertStatus(204);

    expect(DB::table('pan_analytics')->count())->toBe(1);
});