2014-03-28 22:59:29 +00:00
|
|
|
package server
|
2013-04-11 02:48:21 +00:00
|
|
|
|
|
|
|
import (
|
2015-05-07 16:49:07 +00:00
|
|
|
"crypto/tls"
|
2013-06-18 18:59:56 +00:00
|
|
|
"net"
|
2013-04-11 02:48:21 +00:00
|
|
|
"net/http"
|
2013-04-19 13:24:37 +00:00
|
|
|
"strings"
|
2014-03-28 22:59:29 +00:00
|
|
|
|
2015-03-26 22:22:04 +00:00
|
|
|
"github.com/Sirupsen/logrus"
|
2015-09-23 23:42:08 +00:00
|
|
|
"github.com/docker/docker/api/server/httputils"
|
|
|
|
"github.com/docker/docker/api/server/router"
|
2015-11-12 11:06:47 +00:00
|
|
|
"github.com/docker/docker/pkg/authorization"
|
2015-09-29 21:32:07 +00:00
|
|
|
"github.com/gorilla/mux"
|
|
|
|
"golang.org/x/net/context"
|
2013-04-11 02:48:21 +00:00
|
|
|
)
|
|
|
|
|
2015-09-25 10:19:17 +00:00
|
|
|
// versionMatcher defines a variable matcher to be parsed by the router
|
|
|
|
// when a request is about to be served.
|
|
|
|
const versionMatcher = "/v{version:[0-9.]+}"
|
|
|
|
|
2015-07-21 05:15:44 +00:00
|
|
|
// Config provides the configuration for the API server
|
|
|
|
type Config struct {
|
2016-01-13 00:38:18 +00:00
|
|
|
Logging bool
|
|
|
|
EnableCors bool
|
|
|
|
CorsHeaders string
|
|
|
|
AuthorizationPluginNames []string
|
|
|
|
Version string
|
|
|
|
SocketGroup string
|
|
|
|
TLSConfig *tls.Config
|
2015-04-16 19:48:04 +00:00
|
|
|
}
|
|
|
|
|
2015-07-21 05:15:44 +00:00
|
|
|
// Server contains instance details for the server
|
2015-04-17 21:32:18 +00:00
|
|
|
type Server struct {
|
2015-12-10 23:35:10 +00:00
|
|
|
cfg *Config
|
|
|
|
servers []*HTTPServer
|
|
|
|
routers []router.Router
|
|
|
|
authZPlugins []authorization.Plugin
|
|
|
|
routerSwapper *routerSwapper
|
2015-04-17 21:32:18 +00:00
|
|
|
}
|
|
|
|
|
2015-07-21 05:15:44 +00:00
|
|
|
// New returns a new instance of the server based on the specified configuration.
|
2015-10-05 16:32:08 +00:00
|
|
|
// It allocates resources which will be needed for ServeAPI(ports, unix-sockets).
|
2016-02-11 18:30:23 +00:00
|
|
|
func New(cfg *Config) *Server {
|
|
|
|
return &Server{
|
2015-11-25 19:05:31 +00:00
|
|
|
cfg: cfg,
|
2015-04-17 21:32:18 +00:00
|
|
|
}
|
2016-02-11 18:30:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Accept sets a listener the server accepts connections into.
|
|
|
|
func (s *Server) Accept(addr string, listeners ...net.Listener) {
|
|
|
|
for _, listener := range listeners {
|
|
|
|
httpServer := &HTTPServer{
|
|
|
|
srv: &http.Server{
|
|
|
|
Addr: addr,
|
|
|
|
},
|
|
|
|
l: listener,
|
2015-10-05 16:32:08 +00:00
|
|
|
}
|
2016-02-11 18:30:23 +00:00
|
|
|
s.servers = append(s.servers, httpServer)
|
2015-10-05 16:32:08 +00:00
|
|
|
}
|
2015-04-17 21:32:18 +00:00
|
|
|
}
|
|
|
|
|
2015-07-21 05:15:44 +00:00
|
|
|
// Close closes servers and thus stop receiving requests
|
2015-04-27 21:11:29 +00:00
|
|
|
func (s *Server) Close() {
|
|
|
|
for _, srv := range s.servers {
|
|
|
|
if err := srv.Close(); err != nil {
|
|
|
|
logrus.Error(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-12-10 23:35:10 +00:00
|
|
|
// serveAPI loops through all initialized servers and spawns goroutine
|
|
|
|
// with Server method for each. It sets createMux() as Handler also.
|
|
|
|
func (s *Server) serveAPI() error {
|
2015-10-05 16:32:08 +00:00
|
|
|
var chErrors = make(chan error, len(s.servers))
|
|
|
|
for _, srv := range s.servers {
|
2015-12-10 23:35:10 +00:00
|
|
|
srv.srv.Handler = s.routerSwapper
|
2015-10-05 16:32:08 +00:00
|
|
|
go func(srv *HTTPServer) {
|
|
|
|
var err error
|
2015-10-05 23:17:25 +00:00
|
|
|
logrus.Infof("API listen on %s", srv.l.Addr())
|
2015-10-05 16:32:08 +00:00
|
|
|
if err = srv.Serve(); err != nil && strings.Contains(err.Error(), "use of closed network connection") {
|
|
|
|
err = nil
|
|
|
|
}
|
|
|
|
chErrors <- err
|
|
|
|
}(srv)
|
2015-04-17 21:32:18 +00:00
|
|
|
}
|
|
|
|
|
2015-10-05 16:32:08 +00:00
|
|
|
for i := 0; i < len(s.servers); i++ {
|
2015-04-17 21:32:18 +00:00
|
|
|
err := <-chErrors
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2015-07-21 05:15:44 +00:00
|
|
|
// HTTPServer contains an instance of http server and the listener.
|
|
|
|
// srv *http.Server, contains configuration to create a http server and a mux router with all api end points.
|
|
|
|
// l net.Listener, is a TCP or Socket listener that dispatches incoming request to the router.
|
|
|
|
type HTTPServer struct {
|
2014-11-07 20:21:19 +00:00
|
|
|
srv *http.Server
|
|
|
|
l net.Listener
|
|
|
|
}
|
|
|
|
|
2015-07-21 05:15:44 +00:00
|
|
|
// Serve starts listening for inbound requests.
|
|
|
|
func (s *HTTPServer) Serve() error {
|
2014-11-07 20:21:19 +00:00
|
|
|
return s.srv.Serve(s.l)
|
|
|
|
}
|
2015-07-21 05:15:44 +00:00
|
|
|
|
|
|
|
// Close closes the HTTPServer from listening for the inbound requests.
|
|
|
|
func (s *HTTPServer) Close() error {
|
2014-11-07 20:21:19 +00:00
|
|
|
return s.l.Close()
|
|
|
|
}
|
|
|
|
|
2015-09-23 23:42:08 +00:00
|
|
|
func (s *Server) makeHTTPHandler(handler httputils.APIFunc) http.HandlerFunc {
|
2013-07-13 14:59:07 +00:00
|
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
2015-08-31 14:55:51 +00:00
|
|
|
// Define the context that we'll pass around to share info
|
|
|
|
// like the docker-request-id.
|
|
|
|
//
|
|
|
|
// The 'context' will be used for global data that should
|
|
|
|
// apply to all requests. Data that is specific to the
|
|
|
|
// immediate function being called should still be passed
|
|
|
|
// as 'args' on the function call.
|
2015-09-29 17:51:40 +00:00
|
|
|
ctx := context.Background()
|
2015-09-23 23:42:08 +00:00
|
|
|
handlerFunc := s.handleWithGlobalMiddlewares(handler)
|
2015-06-04 13:30:14 +00:00
|
|
|
|
2015-10-14 17:31:09 +00:00
|
|
|
vars := mux.Vars(r)
|
|
|
|
if vars == nil {
|
|
|
|
vars = make(map[string]string)
|
|
|
|
}
|
|
|
|
|
|
|
|
if err := handlerFunc(ctx, w, r, vars); err != nil {
|
Remove static errors from errors package.
Moving all strings to the errors package wasn't a good idea after all.
Our custom implementation of Go errors predates everything that's nice
and good about working with errors in Go. Take as an example what we
have to do to get an error message:
```go
func GetErrorMessage(err error) string {
switch err.(type) {
case errcode.Error:
e, _ := err.(errcode.Error)
return e.Message
case errcode.ErrorCode:
ec, _ := err.(errcode.ErrorCode)
return ec.Message()
default:
return err.Error()
}
}
```
This goes against every good practice for Go development. The language already provides a simple, intuitive and standard way to get error messages, that is calling the `Error()` method from an error. Reinventing the error interface is a mistake.
Our custom implementation also makes very hard to reason about errors, another nice thing about Go. I found several (>10) error declarations that we don't use anywhere. This is a clear sign about how little we know about the errors we return. I also found several error usages where the number of arguments was different than the parameters declared in the error, another clear example of how difficult is to reason about errors.
Moreover, our custom implementation didn't really make easier for people to return custom HTTP status code depending on the errors. Again, it's hard to reason about when to set custom codes and how. Take an example what we have to do to extract the message and status code from an error before returning a response from the API:
```go
switch err.(type) {
case errcode.ErrorCode:
daError, _ := err.(errcode.ErrorCode)
statusCode = daError.Descriptor().HTTPStatusCode
errMsg = daError.Message()
case errcode.Error:
// For reference, if you're looking for a particular error
// then you can do something like :
// import ( derr "github.com/docker/docker/errors" )
// if daError.ErrorCode() == derr.ErrorCodeNoSuchContainer { ... }
daError, _ := err.(errcode.Error)
statusCode = daError.ErrorCode().Descriptor().HTTPStatusCode
errMsg = daError.Message
default:
// This part of will be removed once we've
// converted everything over to use the errcode package
// FIXME: this is brittle and should not be necessary.
// If we need to differentiate between different possible error types,
// we should create appropriate error types with clearly defined meaning
errStr := strings.ToLower(err.Error())
for keyword, status := range map[string]int{
"not found": http.StatusNotFound,
"no such": http.StatusNotFound,
"bad parameter": http.StatusBadRequest,
"conflict": http.StatusConflict,
"impossible": http.StatusNotAcceptable,
"wrong login/password": http.StatusUnauthorized,
"hasn't been activated": http.StatusForbidden,
} {
if strings.Contains(errStr, keyword) {
statusCode = status
break
}
}
}
```
You can notice two things in that code:
1. We have to explain how errors work, because our implementation goes against how easy to use Go errors are.
2. At no moment we arrived to remove that `switch` statement that was the original reason to use our custom implementation.
This change removes all our status errors from the errors package and puts them back in their specific contexts.
IT puts the messages back with their contexts. That way, we know right away when errors used and how to generate their messages.
It uses custom interfaces to reason about errors. Errors that need to response with a custom status code MUST implementent this simple interface:
```go
type errorWithStatus interface {
HTTPErrorStatusCode() int
}
```
This interface is very straightforward to implement. It also preserves Go errors real behavior, getting the message is as simple as using the `Error()` method.
I included helper functions to generate errors that use custom status code in `errors/errors.go`.
By doing this, we remove the hard dependency we have eeverywhere to our custom errors package. Yes, you can use it as a helper to generate error, but it's still very easy to generate errors without it.
Please, read this fantastic blog post about errors in Go: http://dave.cheney.net/2014/12/24/inspecting-errors
Signed-off-by: David Calavera <david.calavera@gmail.com>
2016-02-25 15:53:35 +00:00
|
|
|
logrus.Errorf("Handler for %s %s returned error: %v", r.Method, r.URL.Path, err)
|
2015-09-23 23:42:08 +00:00
|
|
|
httputils.WriteError(w, err)
|
2013-07-13 14:59:07 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-16 18:58:24 +00:00
|
|
|
// InitRouter initializes the list of routers for the server.
|
|
|
|
// This method also enables the Go profiler if enableProfiler is true.
|
|
|
|
func (s *Server) InitRouter(enableProfiler bool, routers ...router.Router) {
|
2016-02-10 20:16:59 +00:00
|
|
|
for _, r := range routers {
|
2016-02-16 18:58:24 +00:00
|
|
|
s.routers = append(s.routers, r)
|
2016-02-10 20:16:59 +00:00
|
|
|
}
|
2015-09-23 23:42:08 +00:00
|
|
|
|
2016-02-16 18:58:24 +00:00
|
|
|
m := s.createMux()
|
|
|
|
if enableProfiler {
|
|
|
|
profilerSetup(m)
|
|
|
|
}
|
|
|
|
s.routerSwapper = &routerSwapper{
|
|
|
|
router: m,
|
|
|
|
}
|
2015-09-23 23:42:08 +00:00
|
|
|
}
|
|
|
|
|
2015-12-10 23:35:10 +00:00
|
|
|
// createMux initializes the main router the server uses.
|
|
|
|
func (s *Server) createMux() *mux.Router {
|
2015-09-23 23:42:08 +00:00
|
|
|
m := mux.NewRouter()
|
2013-06-21 01:18:36 +00:00
|
|
|
|
2015-09-23 23:42:08 +00:00
|
|
|
logrus.Debugf("Registering routers")
|
2015-09-25 10:19:17 +00:00
|
|
|
for _, apiRouter := range s.routers {
|
|
|
|
for _, r := range apiRouter.Routes() {
|
2015-09-23 23:42:08 +00:00
|
|
|
f := s.makeHTTPHandler(r.Handler())
|
2015-09-25 10:19:17 +00:00
|
|
|
|
|
|
|
logrus.Debugf("Registering %s, %s", r.Method(), r.Path())
|
|
|
|
m.Path(versionMatcher + r.Path()).Methods(r.Method()).Handler(f)
|
|
|
|
m.Path(r.Path()).Methods(r.Method()).Handler(f)
|
2013-04-29 15:46:41 +00:00
|
|
|
}
|
2013-05-07 23:33:12 +00:00
|
|
|
}
|
2013-07-05 17:55:15 +00:00
|
|
|
|
2015-09-23 23:42:08 +00:00
|
|
|
return m
|
|
|
|
}
|
2015-12-10 23:35:10 +00:00
|
|
|
|
|
|
|
// Wait blocks the server goroutine until it exits.
|
|
|
|
// It sends an error message if there is any error during
|
|
|
|
// the API execution.
|
|
|
|
func (s *Server) Wait(waitChan chan error) {
|
|
|
|
if err := s.serveAPI(); err != nil {
|
|
|
|
logrus.Errorf("ServeAPI error: %v", err)
|
|
|
|
waitChan <- err
|
|
|
|
return
|
|
|
|
}
|
|
|
|
waitChan <- nil
|
|
|
|
}
|
|
|
|
|
2016-02-16 18:58:24 +00:00
|
|
|
// DisableProfiler reloads the server mux without adding the profiler routes.
|
|
|
|
func (s *Server) DisableProfiler() {
|
|
|
|
s.routerSwapper.Swap(s.createMux())
|
2015-12-10 23:35:10 +00:00
|
|
|
}
|
|
|
|
|
2016-02-16 18:58:24 +00:00
|
|
|
// EnableProfiler reloads the server mux adding the profiler routes.
|
|
|
|
func (s *Server) EnableProfiler() {
|
|
|
|
m := s.createMux()
|
|
|
|
profilerSetup(m)
|
|
|
|
s.routerSwapper.Swap(m)
|
2015-12-10 23:35:10 +00:00
|
|
|
}
|