Fixes #1506

[nagmat84]

Fixes #1506.

Occasionally, updating Lychee fails because users explicitly cached the Lychee/Laravel configuration, forget about it and after a package update strange things start to happen, because the Laravel caches still contain outdated configurations or source files.

This PR prevent this from happening by running artisan optimize --clever --dont-ask=assume-no during update.

This PR also puts the original optimize command provided by the framework on steroids. The extended optimize command allows to only build a cache if the user has explicitly chosen to do so in the past. From the comment above the new command:

/**
 * Improves the original "optimize" command provided by the framework.
 *
 * There are three improvements:
 *
 *  1) This command explicitly clears the old cache before building a new one.
 *     Note that rebuilding a new cache is not sufficient, because this
 *     does *not* overwrite the entire cache but some leftovers may remain.
 *     This actually looks like an oversight and bug in the original command.
 *  2) This command adds a "clever" mode which only rebuilds a new cache if
 *     a previous cache has existed.
 *     We use this in our install/update scripts in order to rebuild the cache
 *     after installation/update without enforcing to use a cache for everyone.
 *  3) This command adds a confirmation, if the user requests to build a cache
 *     for non-productive environments as this is most likely an error and
 *     undesired.
 *     The confirmation can be skipped by pre-selecting the answer via a
 *     command line option.
 */

[codecov]

Codecov Report

Merging #1516 (29d2c8f) into master (fd445f6) will decrease coverage by 0.95%.
The diff coverage is n/a.

❗ Current head 29d2c8f differs from pull request most recent head b2bd466. Consider uploading reports for the commit b2bd466 to get more accurate results

Additional details and impacted files

[ildyria]

You could check the existence of vendor/bin/phpunit or vendor/bin/phpstan to determine if dev is being used or prod. :)

[nagmat84]

I know, I could, but I actually don't feel like doing it. What I meant is, there is no option to do it inside Composer using the means offered by Composer.

First of all, it would require just another script and I feel like we already have too many scripts (in too many different script languages) and I don't want to add another one onto that pile. Secondly, using the existence of a particular file which "accidentally" happens to exist as a development dependency as an indicator whether Composer is in development mode or not feels kind of nasty workaround. In particular, it feels like something which might break at some point and then nobody knows why.

So, yes I wanted to fix #1506 with as little complications as possible. I don't mind if this PR gets dropped and #1506 stays open or gets closed as "won't fix". In particular, as the users brought themselves into that situation in the first place. I also don't mind if someone extends this PR and fixes #1506 in a better way.

[kamil4]

LGTM (untested).

[kamil4]

At least the post-merge is a script already. Does php artisan optimize create some files with predictable names? We could run optimize:clear followed by optimize only if the files in question already exist...

[nagmat84]

Actually, opimize is a meta command to cache the routes, the configuration and the views. We could probably check the existence of

• $this->laravel->getCachedConfigPath() for the cached configuration (see Illuminate\Foundation\Console\ConfigCacheCommand:60), and
• $this->laravel->getCachedRoutesPath() for the cached routes (see Illuminate\Foundation\Console\RouteCacheCommand:66)

inside our own console command. Checking for compiled views seems to a little bit more complicated as there does not seem to be a single file, but at least one file for each compiled view.

[nagmat84]

@ildyria and @kamil4: You have already approved the PR but I would like to ask you to re-review it again as it has changed significantly. As suggested by @kamil4 in #1516 (comment) and discussed in #1516 (comment) I decided to improve the original Laravel command optimize.

[ildyria]

LGTM.