Hagreed Bundle Laravel Package

Technical Evaluation

Architecture Fit

• Symfony-Centric: The bundle is tightly coupled with Symfony 7.0+ and PHP 8.2+, making it a natural fit for existing Symfony applications. For non-Symfony Laravel projects, integration would require significant abstraction (e.g., wrapping Symfony HTTP client calls in Laravel’s Guzzle/HTTP client).
• Compliance-Focused: Aligns with GDPR/cookie consent requirements, addressing a critical regulatory need for EU-based or privacy-conscious applications.
• Modular Design: Configuration-driven (YAML) with optional JavaScript/CSS dependencies, allowing granular customization of consent banners, languages, and cookie categories.

Integration Feasibility

• Symfony: Low-risk—follows Symfony best practices (bundles, Twig extensions, console commands). Minimal boilerplate required.
• Laravel: High-risk—requires:
  • Replacing Symfony’s HTTP client with Laravel’s (e.g., Http facade or Guzzle).
  • Mocking Symfony’s Twig environment for header_hagreed()/body_end_hagreed() (could use Laravel’s Blade or a custom view renderer).
  • Adapting the importmap.php logic to Laravel’s asset pipeline (e.g., Vite/Laravel Mix).
  • Turbo compatibility would need manual JS integration (e.g., Alpine.js or Laravel’s Turbo adapter).

Technical Risk

Key Questions

1. Symfony Projects:

   • Does the application already use Symfony UX/Turbo? If yes, ensure turbo: true is configured.
   • Are there existing cookie consent solutions? If so, assess migration effort vs. Hagreed’s features.
   • Is the export-consents command critical for analytics? If yes, verify API rate limits for large user bases.

2. Laravel Projects:

   • Is Hagreed’s value proposition worth the integration cost?
     • Compare to alternatives like orestride/laravel-cookieconsent or iubenda.
   • How will Twig templates be replaced?
     • Option 1: Use Blade directives (@hagreedHeader, @hagreedBody).
     • Option 2: Create a Laravel service to inject JS/CSS dynamically.
   • Will the importmap.php logic conflict with Laravel’s asset pipeline?
     • Test with Vite/Laravel Mix to ensure no duplicate script loading.
   • How will Turbo compatibility be handled?
     • Option 1: Use Laravel’s Turbo adapter.
     • Option 2: Manually patch the JS to listen to Turbo’s page:load event.

Integration Approach

Stack Fit

Migration Path

Symfony (Low Effort)

1. Installation:

   composer require alteis/hagreed-bundle
   

2. Configure:
   • Add HAGREED_TOKEN to .env.
   • Register bundle in bundles.php.
   • Add YAML config (alteis_hagreed.yaml).
3. Template Integration:
   • Inject {{ header_hagreed() }} and {{ body_end_hagreed() }} into base.html.twig.
4. Turbo/JS:
   • Set turbo: true if using Symfony UX.
5. Testing:
   • Verify banner appears after timeout.
   • Test export-consents command.

Laravel (High Effort)

1. Backend Setup:
   • Create a service provider to wrap Symfony’s HttpClient:

     // app/Providers/HagreedServiceProvider.php
     public function register() {
         $this->app->singleton(ApiHagreedInterface::class, function ($app) {
             return new HagreedApi($app->make(HttpClient::class), config('hagreed.token'));
         });
     }
     

   • Publish config (e.g., config/hagreed.php).
2. Frontend Integration:
   • Option A (Blade):

     // app/Helpers/HagreedHelper.php
     function hagreedHeader() {
         return '<script src="' . asset('vendor/hagreed/hagreed.js') . '"></script>';
     }
     

     @hagreedHeader()
     

   • Option B (Vite): Add to resources/js/app.js:

     import hagreed from '@tizy/hagreed/hagreed.js';
     

3. Turbo Compatibility:
   • Listen to Turbo events in a global JS file:

     document.addEventListener('turbo:load', () => {
         window.hagreedBundle?.init();
     });
     

4. Console Command:
   • Create an Artisan command to proxy the Symfony command:

     php bin/console alteis:hagreed:export-consents
     

     (Or build a Laravel-specific command using the ApiHagreedInterface service.)
5. Testing:
   • Verify JS/CSS loads without conflicts.
   • Test cookie consent flow across pages (especially with Turbo).

Compatibility

• Symfony: Fully compatible—designed for Symfony 7.0+.
• Laravel:
  • Backend: Compatible with minor adjustments (HTTP client, service container).
  • Frontend: Requires manual JS/CSS integration (no native support for importmap.php).
  • Turbo: Needs explicit event handling (not automatic like Symfony UX).

Sequencing

1. Symfony:
   • Install → Configure → Template Injection → Test.
2. Laravel:
   • Backend Service → Frontend JS/CSS → Turbo Patch → Command Wrapper → Test.

Operational Impact

Maintenance

Support

• Symfony:
  • Leverage Symfony’s ecosystem (e.g., SymfonyCast tutorials).
  • Community support via GitHub issues or AlteisGroupe.
• Laravel:
  • Limited community support (no Laravel-specific docs).
  • May require custom troubleshooting for Twig/JS gaps.
  • Consider opening issues on the repo to advocate for Laravel compatibility.

Scaling

• API Limits:
  • Hagreed’s API may throttle export-consents for large user bases.
  • Mitigation: Cache consents in Laravel’s cache() or Symfony’s cache:pool.
• Frontend Performance:
  • JS/CSS load time could impact LCP (Largest Contentful Paint).
  • Mitigation: Defer non-critical Hagreed scripts or lazy-load.
• Database Storage:
  • Consent data is stored client-side (cookies/localStorage). No server-side DB impact.

Failure Modes

| Scenario | Symfony