mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-23 22:27:38 -05:00
a5ebec0041
Previously, all matchers in a route would be evaluated before any handlers were executed, and a composite route of the matching routes would be created. This made rewrites especially tricky, since the only way to defer later matchers' evaluation was to wrap them in a subroute, or to invoke a "rehandle" which often caused bugs. Instead, this new sequential design evaluates each route's matchers then its handlers in lock-step; matcher-handlers-matcher-handlers... If the first matching route consists of a rewrite, then the second route will be evaluated against the rewritten request, rather than the original one, and so on. This should do away with any need for rehandling. I've also taken this opportunity to avoid adding new values to the request context in the handler chain, as this creates a copy of the Request struct, which may possibly lead to bugs like it has in the past (see PR #1542, PR #1481, and maybe issue #2463). We now add all the expected context values in the top-level handler at the server, then any new values can be added to the variable table via the VarsCtxKey context key, or just the GetVar/SetVar functions. In particular, we are using this facility to convey dial information in the reverse proxy. Had to be careful in one place as the middleware compilation logic has changed, and moved a bit. We no longer compile a middleware chain per- request; instead, we can compile it at provision-time, and defer only the evaluation of matchers to request-time, which should slightly improve performance. Doing this, however, we take advantage of multiple function closures, and we also changed the use of HandlerFunc (function pointer) to Handler (interface)... this led to a situation where, if we aren't careful, allows one request routed a certain way to permanently change the "next" handler for all/most other requests! We avoid this by making a copy of the interface value (which is a lightweight pointer copy) and using exclusively that within our wrapped handlers. This way, the original stack frame is preserved in a "read-only" fashion. The comments in the code describe this phenomenon. This may very well be a breaking change for some configurations, however I do not expect it to impact many people. I will make it clear in the release notes that this change has occurred.
87 lines
2.6 KiB
Go
87 lines
2.6 KiB
Go
// Copyright 2015 Matthew Holt and The Caddy Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package caddyhttp
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
)
|
|
|
|
func init() {
|
|
caddy.RegisterModule(Subroute{})
|
|
}
|
|
|
|
// Subroute implements a handler that compiles and executes routes.
|
|
// This is useful for a batch of routes that all inherit the same
|
|
// matchers, or for multiple routes that should be treated as a
|
|
// single route.
|
|
//
|
|
// You can also use subroutes to handle errors from its handlers.
|
|
// First the primary routes will be executed, and if they return an
|
|
// error, the errors routes will be executed; in that case, an error
|
|
// is only returned to the entry point at the server if there is an
|
|
// additional error returned from the errors routes.
|
|
type Subroute struct {
|
|
// The primary list of routes to compile and execute.
|
|
Routes RouteList `json:"routes,omitempty"`
|
|
|
|
// If the primary routes return an error, error handling
|
|
// can be promoted to this configuration instead.
|
|
Errors *HTTPErrorConfig `json:"errors,omitempty"`
|
|
}
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
func (Subroute) CaddyModule() caddy.ModuleInfo {
|
|
return caddy.ModuleInfo{
|
|
ID: "http.handlers.subroute",
|
|
New: func() caddy.Module { return new(Subroute) },
|
|
}
|
|
}
|
|
|
|
// Provision sets up subrouting.
|
|
func (sr *Subroute) Provision(ctx caddy.Context) error {
|
|
if sr.Routes != nil {
|
|
err := sr.Routes.Provision(ctx)
|
|
if err != nil {
|
|
return fmt.Errorf("setting up subroutes: %v", err)
|
|
}
|
|
if sr.Errors != nil {
|
|
err := sr.Errors.Routes.Provision(ctx)
|
|
if err != nil {
|
|
return fmt.Errorf("setting up error subroutes: %v", err)
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (sr *Subroute) ServeHTTP(w http.ResponseWriter, r *http.Request, _ Handler) error {
|
|
subroute := sr.Routes.Compile()
|
|
err := subroute.ServeHTTP(w, r)
|
|
if err != nil && sr.Errors != nil {
|
|
r = sr.Errors.WithError(r, err)
|
|
errRoute := sr.Errors.Routes.Compile()
|
|
return errRoute.ServeHTTP(w, r)
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Interface guards
|
|
var (
|
|
_ caddy.Provisioner = (*Subroute)(nil)
|
|
_ MiddlewareHandler = (*Subroute)(nil)
|
|
)
|