Laravel Pennant

laravel-pennant

When to use

Use this skill when working with feature flags:

• Gradual feature rollouts (percentage-based)
• Per-user or per-tenant feature toggling
• A/B testing with feature variants
• Environment-based feature gating

Procedure: Set up feature flags

1. Install — composer require laravel/pennant, publish config, run migrations.
2. Define feature — Create feature class or use closure-based definition.
3. Check feature — Use Feature::active('feature-name') in code.
4. Verify — Confirm feature is active/inactive for correct scopes. Run tests.

Installation

composer require laravel/pennant
php artisan vendor:publish --provider="Laravel\Pennant\PennantServiceProvider"
php artisan migrate

Defining features

Class-based features (recommended)

php artisan pennant:feature NewDashboard

declare(strict_types=1);

namespace App\Features;

use App\Models\User;
use Illuminate\Support\Lottery;

class NewDashboard
{
    /** Resolve the feature's initial value. */
    public function resolve(User $user): bool
    {
        // Percentage rollout
        return Lottery::odds(1, 10)->choose();  // 10% of users
    }
}

Closure-based features

// In a service provider
use Laravel\Pennant\Feature;

Feature::define('new-dashboard', function (User $user): bool {
    return $user->getCustomer()?->isEarlyAdopter() ?? false;
});

// Rich values (A/B testing)
Feature::define('checkout-button', function (User $user): string {
    return Arr::random(['blue', 'green', 'red']);
});

Checking features

// Boolean check
if (Feature::active('new-dashboard')) {
    // Show new dashboard
}

// Via the user model (HasFeatures trait)
if ($user->features()->active('new-dashboard')) {
    // ...
}

// Rich value
$color = Feature::value('checkout-button');  // 'blue', 'green', or 'red'

// Blade directive
@feature('new-dashboard')
    <x-new-dashboard />
@else
    <x-legacy-dashboard />
@endfeature

Managing features

// Activate for a specific user
Feature::for($user)->activate('new-dashboard');

// Deactivate
Feature::for($user)->deactivate('new-dashboard');

// Activate for everyone
Feature::activateForEveryone('new-dashboard');

// Deactivate for everyone
Feature::deactivateForEveryone('new-dashboard');

// Purge stored values (re-resolve on next check)
Feature::purge('new-dashboard');

Scopes

Features can be scoped to any model, not just users:

// Per-tenant feature
Feature::for($customer)->active('advanced-reporting');

// Define with tenant scope
Feature::define('advanced-reporting', function (Customer $customer): bool {
    return $customer->getPlan() === 'enterprise';
});

Drivers

// config/pennant.php
'default' => env('PENNANT_STORE', 'database'),

Eager loading

// Prevent N+1 when checking features for multiple users
Feature::for($users)->loadAll();

// Load specific features
Feature::for($users)->load(['new-dashboard', 'advanced-reporting']);

Core rules

• Use class-based features for anything non-trivial — they're testable and discoverable.
• Scope to the right model — user, customer, or team depending on the feature.
• Eager load when checking features for collections of users.
• Purge after full rollout — remove the flag once 100% of users have the feature.
• Use array driver in tests — prevents test pollution.
• Clean up old flags — feature flags are temporary, not permanent config.

Output format

1. Feature flag definition with scope and resolve logic
2. Integration in controllers/services using Feature::active()

Auto-trigger keywords

• feature flag
• feature toggle
• Pennant
• gradual rollout
• A/B test
• feature gate

Gotcha

• Feature flags in database driver require migration — don't forget php artisan pennant:purge for cleanup.
• The model tends to check flags without a scope — always pass the authenticated user or a default scope.
• Don't nest feature flag checks — it makes the logic impossible to reason about.

Do NOT

• Do NOT leave feature flags forever — remove them after full rollout.
• Do NOT use feature flags for permanent configuration — use config files.
• Do NOT check features in tight loops without eager loading.
• Do NOT forget to purge stored values when changing the resolve logic.