[8.x] Improved Maintenance Mode #33560
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
That is awesome Mr @taylorotwell always wanted this kinda thing instead of doing “private” routes. |
GrahamCampbell
changed the title
|
I love this so much :) |
|
This is awesome 🙌 |
|
This is fantastic, thanks! |
|
This is a good one 👍 |
|
How will this work in environments like Vapor as we can't persist a file to the file system? |
ghost
reviewed
Jul 17, 2020
| * Determine if the incoming request has a maintenance mode bypass cookie. | ||
| * | ||
| * @param \Illuminate\Http\Request $request | ||
| * @return bool |
| */ | ||
| protected function redirectPath() | ||
| { | ||
| if ($this->option('redirect') && $this->option('redirect') !== '/') { |
There was a problem hiding this comment.
Note - looks good but generally not a fan of directly comparing strings, would prefer str cmp methods instead
There was a problem hiding this comment.
Why?
FTR, there's exactly one strcmp in the entire framework AFAICS. I didn't bother to count the direct string comparison checks 😄
|
I can get |
71 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements a much improved maintenance mode.
Prerendered Templates
One main deficiency of the previous implementation was the entire framework has to be booted in order to render the maintenance page. This could cause various problems if Composer was in the middle of updating dependencies, an infrastructure component was down, etc.
The new
renderoption of thedowncommand allows you to prerender a view. In addition, a newbootstrap/maintenance.phpfile is written. This file is loaded before Composer in the framework'sindex.phpfile and is able to render the template and exit with zero dependencies. Composer and Laravel are never loaded.Secret Bypass Instead Of IP Allow List
The IP allow list has been removed in favor of a secret bypass route. The IP white list isn't practical for many applications. You may now use the
secretoption of thedowncommand:Once the application is in maintenance mode, you may navigate to the secret's value as a route. For example:
https://example.com/MvYgEHudaikRaX4JRcyh
The maintenance middleware will intercept this request and issue a maintenance mode bypass cookie to the user and redirect them to
/, allowing them to access the application and bypass maintenance mode for 12 hours. The cookie contains a HMAC signed expiration time.Redirects
A new
redirectoption has been added to thedowncommand to instruct all paths of the application to redirect to the given path during maintenance:Status Code
A new
statusoption has been added to thedowncommand to allow the status code to be customized. The default is 503. You can combine this with theredirectandsecretoptions to still show a normal marketing / "coming soon" site but allow the real application to be accessed via the secret...