Revive Laravel Package

Technical Evaluation

Architecture Fit

• Filament Integration: Perfectly aligns with Filament v5’s plugin architecture, leveraging its panel system for seamless UI integration.
• Soft-Deletes Compatibility: Built for Eloquent models with SoftDeletes, requiring minimal additional setup.
• State Snapshots: Preserves deleted model state (e.g., timestamps, user context) for auditability, which is critical for compliance-heavy applications.
• Multi-Tenancy Support: Native integration with Filament’s tenant system and customizable scoping logic for SaaS platforms.

Integration Feasibility

• Low-Coupling Design: Plugin operates independently of business logic; only requires Recyclable trait on models.
• Migration Path: Clear upgrade paths from Filament v3/v4 to v5, with backward-compatibility for existing soft-deleted records.
• CLI Tooling: revive:discover-soft-deleted mitigates data migration risks by retroactively indexing pre-existing soft-deleted records.
• Namespace Constraints: Limited to App\Models by default, but workarounds (e.g., wrapper classes) exist for third-party models.

Technical Risk

• Filament Version Lock: Tight coupling to Filament v5 (V3.x) may require rework if upgrading Filament later.
• Soft-Deletes Dependency: Assumes all recyclable models use SoftDeletes; manual overrides needed for custom deletion logic.
• Performance: Large-scale deployments may need optimization for queries scanning soft-deleted records (e.g., indexing deleted_at).
• State Snapshots: Storage of deleted model states could bloat the database if not managed (e.g., TTL policies for old records).

Key Questions

1. Scalability: How will the plugin perform with millions of soft-deleted records? Are there query optimizations (e.g., database indexes) needed?
2. Multi-Tenancy Complexity: For highly segmented SaaS apps, how does tenant scoping interact with Filament’s built-in tenancy?
3. Audit Compliance: Does the state snapshot feature meet regulatory requirements (e.g., GDPR right to erasure)?
4. Customization Limits: Can the UI/UX be fully themed to match existing Filament panels without CSS conflicts?
5. Third-Party Models: What’s the long-term strategy for supporting models outside App\Models (e.g., Laravel Nova or custom packages)?

Integration Approach

Stack Fit

• Laravel/Eloquent: Native support for soft-deletes and model traits; minimal ORM overhead.
• Filament v5: Designed as a first-class plugin with panel integration, navigation, and Livewire tables.
• PHP 8.2+: Leverages modern features (e.g., enums, attributes) for type safety and performance.
• Multi-Tenancy: Works with Filament’s built-in tenancy or custom tenant models (e.g., tenant_id fields).

Migration Path

1. Assessment Phase:
   • Audit existing soft-deleted models to identify gaps (e.g., missing deleted_at or user context).
   • Test the revive:discover-soft-deleted command in a staging environment.
2. Installation:
   • Composer install (promethys/revive:^3.0) + php artisan revive:install.
   • Publish migrations if customizing the schema (e.g., adding deleted_by_user_id).
3. Configuration:
   • Register the plugin in each Filament panel with scoping rules (e.g., user/tenant/admin).
   • Add Recyclable trait to critical models (start with high-risk data like User, Order).
4. Data Migration:
   • Run revive:discover-soft-deleted --with-scope to backfill existing records.
   • Validate scoping (e.g., admins see all records; users see only theirs).
5. Testing:
   • Verify restore/permanent delete workflows for edge cases (e.g., foreign key constraints).
   • Test multi-tenancy boundaries (e.g., tenant A’s deleted items don’t leak to tenant B).

Compatibility

• Filament v4/v3: Downgrade paths exist but require manual migration steps (e.g., schema changes in V1→V2).
• Custom Models: Wrapper classes are needed for third-party models lacking SoftDeletes.
• Legacy Systems: May require extending the Recyclable trait to handle non-Eloquent deletions.

Sequencing

1. Phase 1: Pilot with non-critical models (e.g., Log, Cache) to validate the plugin’s behavior.
2. Phase 2: Roll out to core models (User, Post, Order) with scoping enabled.
3. Phase 3: Enable multi-tenancy and admin panels if applicable.
4. Phase 4: Optimize performance (e.g., add indexes, adjust snapshot retention).

Operational Impact

Maintenance

• Dependencies: Tied to Filament’s release cycle; updates may require testing for breaking changes.
• Schema: Minimal maintenance if using default migrations, but custom fields (e.g., deleted_by) need monitoring.
• Logging: No built-in logging; may need to wrap restore/delete actions in Laravel’s logging system.

Support

• Troubleshooting: Common issues include:
  • Scoping misconfigurations (e.g., admins not seeing all records).
  • Missing soft-deleted records (resolve with revive:discover-soft-deleted).
  • UI rendering conflicts (override Livewire components if needed).
• Documentation: README is comprehensive but lacks deep-dive examples for complex tenancy setups.
• Community: Low stars (16) suggest limited community support; issues may require direct engagement with maintainers.

Scaling

• Database Load: Soft-deleted records are queried separately from live data; ensure deleted_at is indexed.

  ALTER TABLE your_table ADD INDEX deleted_at_index ON deleted_at;
  

• Snapshot Storage: State snapshots could grow large; consider archiving old records or using a separate table.
• Concurrency: Livewire tables may need rate-limiting for high-traffic panels (e.g., admin dashboards).

Failure Modes

Ramp-Up

• Developer Onboarding:
  • 1–2 hours: Install and configure for a single model.
  • 4–8 hours: Customize scoping, UI, and handle edge cases (e.g., third-party models).
• Team Training:
  • Demo the restore workflow for non-technical users (e.g., support teams).
  • Document CLI commands (revive:discover-soft-deleted) for data migration tasks.
• Performance Tuning:
  • Profile queries with telescope:record-sql to identify slow scans.
  • Adjust snapshot retention policies (e.g., soft-delete old snapshots after 90 days).