InfyOmLabs / laravel-generator

API and Admin Panel CRUD Generator for Laravel.
https://www.infyom.com/open-source
MIT License
3.78k stars 802 forks source link

Make `config` variable available only in infyom view files #1088

Open krydos opened 10 months ago

krydos commented 10 months ago

After upgrade to laravel 10 and upgrading this library we noticed that every $config variable that we use in our blade files now suddenly has type of InfyOm\Generator\Common\GeneratorConfig instead of being something we want it to be.

After some research we found THIS COMMIT that registers $config for every view.

So expected behaviour is this (please note, myveiw.blade.php is not related to laravel-generator in any way):

// controller
return view('myview', ['config' => ['key' => 'value']]); // pass $config variable to myview.blade.php

// myview.blade.php
$config['key'] == 'value' // true

actual behaviour:

// controller
return view('myview', ['config' => ['key' => 'value']]); // pass $config variable to myview.blade.php

// myview.blade.php
$config['key'] == 'value' // false. Moreover $config is InfyOm\Generator\Common\GeneratorConfig.

This PR makes $config variable available for laravel-generator's views only.

@mitulgolakiya could you please help me to make sure it's valid change that doesn't break what was intended initially with that commit.

Thanks!

abewartech commented 9 months ago

i install https://laravel.com/docs/10.x/pulse on laravel 10, this commit effectively resolved an issue encountered during the installation of Laravel Pulse

Cannot use object of type InfyOm\Generator\Common\GeneratorConfig as array

krydos commented 9 months ago

Good catch @abewartech. It looks like Pulse is also using $config variable in some (e.g. here or here or here) blade files and this lib overrides the variable with its own class.

As a temp solution you need several steps:

  1. create your custom InfyOmGeneratorServiceProvider.php file in app/Providers folder
  2. copy the service provider provided by this lib. You can just copy this file. It's literally just a copy of the lib's service provider but with the fix from this PR.
  3. replace InfyOm\Generator\InfyOmGeneratorServiceProvider::class with your custom service provider (App\Providers\InfyOmGeneratorServiceProvider::class) in your config/app.php file. If you don't have it there then just add it.
  4. update composer.json file's extra.laravel.dont-discover" section and add "infyomlabs/laravel-generator" there ("dont-discover": ["infyomlabs/laravel-generator"]. This will force laravel to not auto discover the lib's service provider and use the custom one instead.
krydos commented 8 months ago

What I've just found is that other infyom packages also depend on the $config variable injection. At least adminlte-templates does. My 'laravel-generator::*' isn't fixing the issue fully in this case. Is adminlte-templates the only template supported by laravel-generator?

Karkisushant commented 8 months ago

I think it would be helpful if Laravel Generator had a configuration option where we could specify directories or files to exclude, or conversely, include. After encountering the same issue while attempting to use Pulse, I believe right now the suitable solution is temporarily setting the "dont-discover" option to ["infyomlabs/laravel-generator"] until a patch is available.

krydos commented 7 months ago

As mentioned above adminlte-template package is also using this config variable provided by the InfyOmGeneratorServiceProvider. I added this package to my PR as well so only laravel-generator and adminlte-templates are getting this variable passed through.

Seems working ok.

leonelngande commented 1 month ago

Also experiencing this conflict after upgrading to Laravel 10 and installing Laravel Pulse.