coolify/tests/Feature/TrafficAnalytics/ToggleTrafficAnalyticsTest.php

<?php

use App\Actions\Server\ConfigureTrafficAnalytics;
use App\Enums\ServerRole;
use App\Enums\TrafficIpMode;
use App\Livewire\Analytics;
use App\Livewire\Server\TrafficAnalyticsSettings;
use App\Models\InstanceSettings;
use App\Models\Server;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Queue;
use Livewire\Livewire;

uses(RefreshDatabase::class);

beforeEach(function () {
    InstanceSettings::forceCreate(['id' => 0]);
    $this->user = User::factory()->create();
    $this->team = $this->user->teams()->first();
    $this->actingAs($this->user);
    session(['currentTeam' => $this->team]);
});

it('toggles traffic analytics via the sentinel settings component', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->once()->andReturnUsing(function ($server, $enable) {
        $server->settings->is_traffic_analytics_enabled = $enable;
        $server->settings->save();

        return true;
    });

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'TRAEFIK');
    $server->save();
    // New servers default analytics on; start from the disabled state to exercise enabling.
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeFalse();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->call('toggleTrafficAnalytics')
        ->assertDispatchedTo(Analytics::class, 'trafficAnalyticsStateChanged')
        ->assertHasNoErrors();

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeTrue();
});

it('warns about the application interruption before enabling traffic analytics', function () {
    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'TRAEFIK');
    $server->save();
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->assertSee('Enable traffic analytics?')
        ->assertSee('Restarting Sentinel and proxy...')
        ->assertSee('Enabling traffic analytics will restart Sentinel and the proxy. Your applications will experience a brief interruption.');
});

it('does not enable traffic analytics on a swarm server', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->never();

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'TRAEFIK');
    $server->save();
    $server->settings->is_swarm_manager = true;
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeFalse();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->call('toggleTrafficAnalytics')
        ->assertDispatched('error', 'Traffic analytics is not supported on Swarm/Build servers.')
        ->assertHasNoErrors();

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeFalse();
});

it('saves traffic analytics settings from the sentinel form', function () {
    Queue::fake();

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->settings->is_traffic_analytics_enabled = true;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->set('trafficTopn', 100)
        ->set('trafficSampleThreshold', 500)
        ->set('trafficRetention1hDays', 14)
        ->set('trafficRetention1dDays', 180)
        ->set('isGeoipEnabled', false)
        ->set('geoipRefreshDays', 7)
        ->call('saveTrafficAnalyticsSettings')
        ->assertHasNoErrors();

    $settings = $server->settings->fresh();
    expect($settings->traffic_topn)->toBe(100)
        ->and($settings->traffic_sample_threshold)->toBe(500)
        ->and($settings->traffic_retention_1h_days)->toBe(14)
        ->and($settings->traffic_retention_1d_days)->toBe(180)
        ->and($settings->is_geoip_enabled)->toBeFalse()
        ->and($settings->geoip_refresh_days)->toBe(7);
});

it('saves the client IP mode from the sentinel form', function () {
    Queue::fake();

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->settings->is_traffic_analytics_enabled = true;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->assertSet('trafficIpMode', 'full')
        ->assertSee('Client IP addresses')
        ->set('trafficIpMode', 'anonymized')
        ->call('saveTrafficAnalyticsSettings')
        ->assertHasNoErrors();

    expect($server->settings->fresh()->traffic_ip_mode)->toBe(TrafficIpMode::Anonymized);
});

it('rejects an unknown client IP mode', function () {
    $server = Server::factory()->create(['team_id' => $this->team->id]);

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->set('trafficIpMode', 'partial')
        ->call('saveTrafficAnalyticsSettings')
        ->assertHasErrors(['trafficIpMode']);

    expect($server->settings->fresh()->traffic_ip_mode)->toBe(TrafficIpMode::Full);
});

it('does not let a team member change the client IP mode', function () {
    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->settings->is_traffic_analytics_enabled = true;
    $server->settings->save();

    $component = Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server]);

    $member = User::factory()->create();
    $this->team->members()->attach($member->id, ['role' => 'member']);
    $this->actingAs($member);

    $component->set('trafficIpMode', 'off')
        ->call('saveTrafficAnalyticsSettings');

    expect($server->settings->fresh()->traffic_ip_mode)->toBe(TrafficIpMode::Full);
});

it('rejects a zero top-n cap', function () {
    $server = Server::factory()->create(['team_id' => $this->team->id]);

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->set('trafficTopn', 0)
        ->call('saveTrafficAnalyticsSettings')
        ->assertHasErrors(['trafficTopn']);
});

it('does not enable traffic analytics on a build server', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->never();

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'TRAEFIK');
    $server->save();
    $server->settings->server_role = ServerRole::BUILD;
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeFalse();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->call('toggleTrafficAnalytics')
        ->assertDispatched('error', 'Traffic analytics is not supported on Swarm/Build servers.')
        ->assertHasNoErrors();

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeFalse();
});

it('disables the analytics toggle and explains why when the server has no traefik or caddy proxy', function () {
    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'NONE');
    $server->save();
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    $html = Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->assertSee('Traffic analytics needs the Traefik or Caddy proxy.')
        ->assertDontSee('Enable traffic analytics?')
        ->assertDontSeeHtml('submitAction')
        ->html();

    expect($html)->toMatch('/<button disabled[^>]*>(?:\s|<!--.*?-->)*Enable traffic analytics\s*<\/button>/s');
});

it('rejects enabling analytics from the component when the server has no traefik or caddy proxy', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->never();

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'NONE');
    $server->save();
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->call('toggleTrafficAnalytics')
        ->assertDispatched('error', 'Traffic analytics needs the Traefik or Caddy proxy.')
        ->assertSet('isTrafficAnalyticsEnabled', false);

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeFalse();
});

it('lets analytics be disabled on a server whose proxy was removed', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->once()->andReturnUsing(function ($server, $enable) {
        $server->settings->is_traffic_analytics_enabled = $enable;
        $server->settings->save();

        return false;
    });

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'NONE');
    $server->save();
    $server->settings->is_traffic_analytics_enabled = true;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->assertDontSee('Traffic analytics needs the Traefik or Caddy proxy.')
        ->call('toggleTrafficAnalytics')
        ->assertDispatched('success', 'Traffic analytics disabled.')
        ->assertSet('isTrafficAnalyticsEnabled', false);
});

it('tells the user a stopped proxy picks up the change on its next start', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->once()->andReturnUsing(function ($server, $enable) {
        $server->settings->is_traffic_analytics_enabled = $enable;
        $server->settings->save();

        return false;
    });

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'TRAEFIK');
    $server->proxy->set('status', 'exited');
    $server->proxy->set('force_stop', true);
    $server->save();
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->call('toggleTrafficAnalytics')
        ->assertDispatched('success', 'Traffic analytics enabled. The proxy is stopped, so the new configuration applies the next time you start it.');
});

it('does not let a team member toggle traffic analytics', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->never();

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'TRAEFIK');
    $server->save();
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    $member = User::factory()->create();
    $this->team->members()->attach($member->id, ['role' => 'member']);
    $this->actingAs($member);
    session(['currentTeam' => $this->team]);

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->assertForbidden();

    expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeFalse();
});

it('tells the user that Caddy logs a resource only after a redeploy', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->once()->andReturnUsing(function ($server, $enable) {
        $server->settings->is_traffic_analytics_enabled = $enable;
        $server->settings->save();

        return true;
    });

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'CADDY');
    $server->save();
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->assertDontSee('Caddy logs a resource only after you redeploy it.')
        ->call('toggleTrafficAnalytics')
        ->assertDispatched('success', 'Traffic analytics enabled. Restarting proxy and Sentinel. Caddy logs a resource only after you redeploy it.')
        ->assertSee('Caddy logs a resource only after you redeploy it.');
});

it('does not show the Caddy redeploy note on a Traefik server', function () {
    ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->once()->andReturnUsing(function ($server, $enable) {
        $server->settings->is_traffic_analytics_enabled = $enable;
        $server->settings->save();

        return true;
    });

    $server = Server::factory()->create(['team_id' => $this->team->id]);
    $server->proxy->set('type', 'TRAEFIK');
    $server->save();
    $server->settings->is_traffic_analytics_enabled = false;
    $server->settings->save();

    Livewire::test(TrafficAnalyticsSettings::class, ['server' => $server])
        ->call('toggleTrafficAnalytics')
        ->assertDispatched('success', 'Traffic analytics enabled. Restarting proxy and Sentinel.')
        ->assertDontSee('Caddy logs a resource only after you redeploy it.');
});