Laravel optimize and volt anonymous components

[jamesj2]

I'm unable to successfully run php artisan optimize with this package installed. Somehow it's causing the blade path to be empty in volt. Without optimize everything works, but I'm unable to optimize for deployment. Removing "spatie/laravel-csp": "^2.10.1" the problem goes away. Any ideas?

I used this tutorial to start a Laravel 11 project with volt/folio. Added a volt component and the spatie/laravel-csp package. Then run php optimize.

  config ............................................................................................................................. 619.69ms DONE
  events ............................................................................................................................... 2.03ms DONE
  routes ............................................................................................................................. 618.34ms DONE
  views ............................................................................................................................... 25.21ms FAIL

   TypeError 

  Livewire\Volt\FragmentAlias::encode(): Argument #2 ($path) must be of type string, null given, called in /Users/james/Herd/volt/vendor/livewire/volt/src/Precompilers/ExtractFragments.php on line 98

  at vendor/livewire/volt/src/FragmentAlias.php:15
     11▕ 
     12▕     /**
     13▕      * Encode the given fragment's component name and path into a base64 embedded alias.
     14▕      */
  ➜  15▕     public static function encode(string $componentName, string $path, ?string $basePath = null): string
     16▕     {
     17▕         $basePath = $basePath ?? static::$basePath ?? base_path();
     18▕ 
     19▕         return 'volt-anonymous-fragment-'.base64_encode(json_encode([

      +2 vendor frames 

  3   [internal]:0
      Livewire\Volt\Precompilers\ExtractFragments::Livewire\Volt\Precompilers\{closure}()
      +5 vendor frames 

  9   [internal]:0
      Illuminate\Foundation\Console\ViewCacheCommand::Illuminate\Foundation\Console\{closure}(Object(Symfony\Component\Finder\SplFileInfo), "/Users/james/Herd/volt/resources/views/pages/todos.blade.php")

    "require": {
        "php": "^8.2",
        "laravel/folio": "^1.1",
        "laravel/framework": "^11.9",
        "laravel/tinker": "^2.9",
        "livewire/livewire": "^3.5",
        "livewire/volt": "^1.6",
        "spatie/laravel-csp": "^2.10.1"
    },

[ismaildasci]

Hey! 👋

It looks like there’s a conflict between spatie/laravel-csp and Livewire Volt during the php artisan optimize command, especially when caching views. The error suggests that FragmentAlias::encode is receiving a null value for the $path argument, which should be a string.

Here are a few suggestions to try:

1. Skip View Caching as a Temporary Fix:
   Instead of using php artisan optimize, you can cache configurations and routes separately:

   php artisan config:cache
   php artisan route:cache

   This bypasses view caching and might help avoid the error.

2. Adjust the Version of Spatie Laravel CSP:
   There may be a compatibility issue with the latest spatie/laravel-csp version. Try downgrading it slightly:

   composer require spatie/laravel-csp:^2.9

3. Check config/csp.php Configuration:
   Custom CSP policies could be affecting how Volt interprets views. Review your config/csp.php settings to see if any directive could be interfering with Blade templates.

4. Reach Out to Livewire Volt Maintainers:
   Since FragmentAlias::encode is a method within Volt, this might be an edge case. Reporting this on the Livewire Volt GitHub repository could help the maintainers address it in a future update.

5. Custom Service Provider as a Last Resort:
   If all else fails, create a custom service provider to conditionally disable spatie/laravel-csp during the optimize command:

   class SkipCspForOptimization extends ServiceProvider
   {
       public function register()
       {
           if (app()->runningInConsole() && $this->shouldSkipOptimization()) {
               $this->app->forgetInstance('Spatie\Csp\CspServiceProvider');
           }
       }
   
       protected function shouldSkipOptimization(): bool
       {
           return Str::contains(request()->server('argv', ''), 'optimize');
       }
   }

   Then register this provider in config/app.php only for optimization.

Hopefully, one of these solutions works for you! Let us know if this helps or if you have any other questions. 😊

[jamesj2]

@ismaildasci Thanks for the very detailed response. I tried downgrading to 2.9, checking my csp config, and disabling Csp during optimization with no luck. I'll reach out to the Livewire Volt maintainers.

[produktive]

Hey @jamesj2 I'm experiencing this same issue. Did you ever get it resolved?

[jamesj2]

Sorry but no, I moved on to another project and didn't get the time to figure it out.