Skip to content

Open-source social media scheduler built for AI agents and the teams behind them. Create, schedule and publish posts to every network through MCP or the REST API, or write them yourself in a composer your team will love.

11.5 KB
Raw Blame
<?php

declare(strict_types=1);

use App\Jobs\PostHog\SendEvent;
use App\Models\Account;
use App\Models\Plan;
use App\Services\PostHogService;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Queue;
use PostHog\Client;
use PostHog\PostHog;

uses(RefreshDatabase::class);

test('capture dispatches job when api key is configured', function () {
    Queue::fake();
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_test_key']);

    $service = new PostHogService;
    $service->capture('user-123', 'test_event', ['foo' => 'bar']);

    Queue::assertPushed(SendEvent::class, function ($job) {
        return $job->method === 'capture'
            && $job->payload['event'] === 'test_event'
            && $job->payload['distinctId'] === 'user-123';
    });
});

test('capture does not dispatch job when api key is missing', function () {
    Queue::fake();
    config(['services.posthog.api_key' => null]);

    $service = new PostHogService;
    $service->capture('user-123', 'test_event');

    Queue::assertNothingPushed();
});

test('identify dispatches job when api key is configured', function () {
    Queue::fake();
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_test_key']);

    $service = new PostHogService;
    $service->identify('user-123', ['$email' => '[email protected]']);

    Queue::assertPushed(SendEvent::class, function ($job) {
        return $job->method === 'identify'
            && $job->payload['distinctId'] === 'user-123';
    });
});

test('identify does not dispatch job when api key is missing', function () {
    Queue::fake();
    config(['services.posthog.api_key' => null]);

    $service = new PostHogService;
    $service->identify('user-123', ['$email' => '[email protected]']);

    Queue::assertNothingPushed();
});

test('group identify dispatches job when api key is configured', function () {
    Queue::fake();
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_test_key']);

    $service = new PostHogService;
    $service->groupIdentify('workspace', 'ws-123', ['name' => 'Test Workspace']);

    Queue::assertPushed(SendEvent::class, function ($job) {
        return $job->method === 'groupIdentify'
            && $job->payload['groupType'] === 'workspace'
            && $job->payload['groupKey'] === 'ws-123';
    });
});

test('group identify does not dispatch job when api key is missing', function () {
    Queue::fake();
    config(['services.posthog.api_key' => null]);

    $service = new PostHogService;
    $service->groupIdentify('workspace', 'ws-123', ['name' => 'Test']);

    Queue::assertNothingPushed();
});

test('group identify now sends without dispatching a second job', function () {
    Queue::fake();
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_test_key']);
    $client = Mockery::mock(Client::class);
    $client->shouldReceive('capture')
        ->once()
        ->withArgs(fn (array $payload): bool => $payload['event'] === '$groupidentify'
            && $payload['properties']['$group_type'] === 'account'
            && $payload['properties']['$group_key'] === 'account-123')
        ->andReturnTrue();
    $client->shouldReceive('flush')->once()->andReturnTrue();
    PostHog::init(client: $client);

    (new PostHogService)->groupIdentifyNow('account', 'account-123', [
        'last_post_published_at' => now()->toIso8601String(),
    ]);

    Queue::assertNothingPushed();
});

test('group identify now throws when PostHog rejects the payload', function () {
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_test_key']);
    $client = Mockery::mock(Client::class);
    $client->shouldReceive('capture')->once()->andReturnFalse();
    $client->shouldNotReceive('flush');
    PostHog::init(client: $client);

    expect(fn () => (new PostHogService)->groupIdentifyNow('account', 'account-123'))
        ->toThrow(RuntimeException::class, 'PostHog group identify failed.');
});

test('capture auto-attaches account groups when account is supplied', function () {
    Queue::fake();
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_test_key']);

    $plan = Plan::query()->where('slug', 'workspace')->first();
    $account = Account::factory()->create(['plan_id' => $plan?->id]);

    $service = new PostHogService;
    $service->capture('user-123', 'subscription.created', ['stripe_status' => 'active'], $account);

    Queue::assertPushed(SendEvent::class, function ($job) use ($account, $plan) {
        $payload = $job->payload;

        return $payload['event'] === 'subscription.created'
            && $payload['properties']['$groups']['account'] === (string) $account->id
            && $payload['properties']['account_id'] === (string) $account->id
            && $payload['properties']['plan'] === $plan?->name
            && $payload['properties']['stripe_status'] === 'active';
    });
});

test('capture without account does not attach group properties', function () {
    Queue::fake();
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_test_key']);

    $service = new PostHogService;
    $service->capture('user-123', 'page.viewed', ['url' => '/dashboard']);

    Queue::assertPushed(SendEvent::class, function ($job) {
        $properties = $job->payload['properties'];

        return ! array_key_exists('$groups', $properties)
            && ! array_key_exists('account_id', $properties)
            && ! array_key_exists('plan', $properties);
    });
});

// ========================================
// Self-hosted contract: enabled=false dominates regardless of api key
// ========================================
//
// These cover the exact scenario the open-source gate exists to defend
// against: a self-hosted install that inherited POSTHOG_API_KEY from an
// example env file but did NOT explicitly opt in via POSTHOG_ENABLED.

test('capture is a no-op when enabled is false even with an api key set', function () {
    Queue::fake();
    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => 'phc_inherited_key']);

    $service = new PostHogService;
    $service->capture('user-123', 'test_event');

    Queue::assertNothingPushed();
});

test('identify is a no-op when enabled is false even with an api key set', function () {
    Queue::fake();
    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => 'phc_inherited_key']);

    $service = new PostHogService;
    $service->identify('user-123', ['$email' => '[email protected]']);

    Queue::assertNothingPushed();
});

test('groupIdentify is a no-op when enabled is false even with an api key set', function () {
    Queue::fake();
    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => 'phc_inherited_key']);

    $service = new PostHogService;
    $service->groupIdentify('account', 'acc-123', ['name' => 'Test']);

    Queue::assertNothingPushed();
});

// ========================================
// Local debug logging
// ========================================

test('capture logs to laravel.log in the local environment even when disabled', function () {
    app()->detectEnvironment(fn () => 'local');
    config(['services.posthog.api_key' => null]);
    Queue::fake();

    Log::shouldReceive('info')->once()->withArgs(function ($message, $payload) {
        return $message === 'PostHogService: capture'
            && $payload['event'] === 'test_event'
            && $payload['distinctId'] === 'user-123';
    });

    (new PostHogService)->capture('user-123', 'test_event', ['foo' => 'bar']);

    Queue::assertNothingPushed();
});

test('identify logs to laravel.log in the local environment even when disabled', function () {
    app()->detectEnvironment(fn () => 'local');
    config(['services.posthog.api_key' => null]);

    Log::shouldReceive('info')->once()->withArgs(function ($message, $payload) {
        return $message === 'PostHogService: identify'
            && $payload['distinctId'] === 'user-123';
    });

    (new PostHogService)->identify('user-123', ['$email' => '[email protected]']);
});

test('groupIdentify logs to laravel.log in the local environment even when disabled', function () {
    app()->detectEnvironment(fn () => 'local');
    config(['services.posthog.api_key' => null]);

    Log::shouldReceive('info')->once()->withArgs(function ($message, $payload) {
        return $message === 'PostHogService: groupIdentify'
            && $payload['groupType'] === 'workspace';
    });

    (new PostHogService)->groupIdentify('workspace', 'ws-123', ['name' => 'Test']);
});

test('capture does not log outside the local environment', function () {
    app()->detectEnvironment(fn () => 'testing');
    config(['services.posthog.api_key' => null]);

    Log::shouldReceive('info')->never();

    (new PostHogService)->capture('user-123', 'test_event');
});

test('isEnabled requires both enabled and api key', function () {
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => null]);
    expect(PostHogService::isEnabled())->toBeFalse();

    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => 'phc_x']);
    expect(PostHogService::isEnabled())->toBeFalse();

    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_x']);
    expect(PostHogService::isEnabled())->toBeTrue();
});

// ========================================
// shouldTrack: the gate used by call sites that pre-check before ever
// reaching capture()/identify() (CreateUser, StripeEventListener, and the
// individual PostHog job handle() methods). Must never let a disabled,
// non-local (i.e. production) install actually track — that's the exact
// self-hosted/production contract isEnabled() already guarantees. It only
// adds an escape hatch for the local environment, so local dev can see what
// would be sent without a real API key.
// ========================================

test('shouldTrack is false when disabled outside the local environment (production contract)', function () {
    app()->detectEnvironment(fn () => 'production');
    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => null]);

    expect(PostHogService::shouldTrack())->toBeFalse();
});

test('shouldTrack is false when disabled with an inherited api key outside the local environment', function () {
    app()->detectEnvironment(fn () => 'production');
    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => 'phc_inherited_key']);

    expect(PostHogService::shouldTrack())->toBeFalse();
});

test('shouldTrack is false when disabled in the testing environment (the default test env)', function () {
    app()->detectEnvironment(fn () => 'testing');
    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => null]);

    expect(PostHogService::shouldTrack())->toBeFalse();
});

test('shouldTrack is true when enabled, regardless of environment', function () {
    config(['services.posthog.enabled' => true, 'services.posthog.api_key' => 'phc_x']);

    app()->detectEnvironment(fn () => 'production');
    expect(PostHogService::shouldTrack())->toBeTrue();

    app()->detectEnvironment(fn () => 'local');
    expect(PostHogService::shouldTrack())->toBeTrue();
});

test('shouldTrack is true in the local environment even when disabled', function () {
    app()->detectEnvironment(fn () => 'local');
    config(['services.posthog.enabled' => false, 'services.posthog.api_key' => null]);

    expect(PostHogService::shouldTrack())->toBeTrue();
});