Octane Analyzer - Quick Reference

Command

php artisan af-octane:test [--json] [--ci] [--path=app/]

11 Scanners

Severity Levels

• ❌ CRITICAL - Must fix before Octane
• 🔴 HIGH - Should fix - likely problems
• ⚠️ MEDIUM - Review and fix if applicable
• ⚡ LOW - Best practice suggestions

Common Fixes

❌ Singleton with Request Data

// WRONG
$this->app->singleton(Service::class, fn() => new Service(auth()->user()));

// CORRECT
$this->app->scoped(Service::class, fn() => new Service(auth()->user()));

❌ Static Property with User Data

// WRONG
class Service {
    private static $user;
}

// CORRECT
class Service {
    private $user;
}

❌ Facade in Constructor

// WRONG
public function __construct() {
    $this->user = Auth::user();
}

// CORRECT
public function doAction() {
    $user = Auth::user();
}

❌ Cache Without Tenant Context

// WRONG
Cache::remember('data', 60, fn() => User::all());

// CORRECT
Cache::remember('tenant:'.tenant('id').':data', 60, fn() => User::all());

❌ Runtime Config Change

// WRONG
config(['app.name' => 'New Name']);

// CORRECT - Use .env or database instead
Setting::set('app_name', 'New Name');

CI/CD Integration

- name: Octane Safety Check
  run: php artisan af-octane:test --ci --json > report.json

Exit code 1 if critical issues found.

JSON Output Structure

{
  "summary": {
    "execution_time": 0.99,
    "files_scanned": 312,
    "passed_checks": 2,
    "warnings": 3,
    "critical_issues": 0
  },
  "results": {
    "scanner_name": {
      "vulnerabilities": [...]
    }
  }
}

Best Practices

1. ✅ Use scoped() instead of singleton() for request data
2. ✅ Never store request/user/session in static properties
3. ✅ Call Auth/Request facades only in methods, not constructors
4. ✅ Include tenant/user context in all cache keys
5. ✅ Clear static state in Octane tick events
6. ✅ Use instance properties, not static properties
7. ✅ Implement ShouldQueue for long-running jobs
8. ✅ Test under load to detect state leaks

Monitor Octane Health

php artisan octane:status        # Check worker health
php artisan octane:cache:warm    # Warm cache before deploy

Resources

• Laravel Octane Docs
• Octane GitHub
• Full documentation: OCTANE_ANALYZER_DOCUMENTATION.md