X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/783f215608cc94f1dd7450e802ecf8b4b06f1cf9..6e5b24e817a0972ab30c9065cfc6a726821e7b66:/lib/controller/router/router.go diff --git a/lib/controller/router/router.go b/lib/controller/router/router.go index 6f2b0f5cb2..2944524344 100644 --- a/lib/controller/router/router.go +++ b/lib/controller/router/router.go @@ -10,131 +10,162 @@ import ( "net/http" "strings" - "git.curoverse.com/arvados.git/lib/controller/federation" - "git.curoverse.com/arvados.git/sdk/go/arvados" - "git.curoverse.com/arvados.git/sdk/go/auth" - "git.curoverse.com/arvados.git/sdk/go/ctxlog" - "git.curoverse.com/arvados.git/sdk/go/httpserver" - "github.com/julienschmidt/httprouter" + "git.arvados.org/arvados.git/lib/controller/api" + "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/auth" + "git.arvados.org/arvados.git/sdk/go/ctxlog" + "git.arvados.org/arvados.git/sdk/go/httpserver" + "github.com/gorilla/mux" "github.com/sirupsen/logrus" ) type router struct { - mux *httprouter.Router - fed federation.Interface + mux *mux.Router + backend arvados.API + wrapCalls func(api.RoutableFunc) api.RoutableFunc } -func New(cluster *arvados.Cluster) *router { +// New returns a new router (which implements the http.Handler +// interface) that serves requests by calling Arvados API methods on +// the given backend. +// +// If wrapCalls is not nil, it is called once for each API method, and +// the returned method is used in its place. This can be used to +// install hooks before and after each API call and alter responses; +// see localdb.WrapCallsInTransaction for an example. +func New(backend arvados.API, wrapCalls func(api.RoutableFunc) api.RoutableFunc) *router { rtr := &router{ - mux: httprouter.New(), - fed: federation.New(cluster), + mux: mux.NewRouter(), + backend: backend, + wrapCalls: wrapCalls, } - rtr.addRoutes(cluster) + rtr.addRoutes() return rtr } -func (rtr *router) addRoutes(cluster *arvados.Cluster) { +func (rtr *router) addRoutes() { for _, route := range []struct { endpoint arvados.APIEndpoint defaultOpts func() interface{} - exec func(ctx context.Context, opts interface{}) (interface{}, error) + exec api.RoutableFunc }{ + { + arvados.EndpointConfigGet, + func() interface{} { return &struct{}{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.ConfigGet(ctx) + }, + }, + { + arvados.EndpointLogin, + func() interface{} { return &arvados.LoginOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.Login(ctx, *opts.(*arvados.LoginOptions)) + }, + }, + { + arvados.EndpointLogout, + func() interface{} { return &arvados.LogoutOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.Logout(ctx, *opts.(*arvados.LogoutOptions)) + }, + }, { arvados.EndpointCollectionCreate, func() interface{} { return &arvados.CreateOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionCreate(ctx, *opts.(*arvados.CreateOptions)) + return rtr.backend.CollectionCreate(ctx, *opts.(*arvados.CreateOptions)) }, }, { arvados.EndpointCollectionUpdate, func() interface{} { return &arvados.UpdateOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionUpdate(ctx, *opts.(*arvados.UpdateOptions)) + return rtr.backend.CollectionUpdate(ctx, *opts.(*arvados.UpdateOptions)) }, }, { arvados.EndpointCollectionGet, func() interface{} { return &arvados.GetOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionGet(ctx, *opts.(*arvados.GetOptions)) + return rtr.backend.CollectionGet(ctx, *opts.(*arvados.GetOptions)) }, }, { arvados.EndpointCollectionList, func() interface{} { return &arvados.ListOptions{Limit: -1} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionList(ctx, *opts.(*arvados.ListOptions)) + return rtr.backend.CollectionList(ctx, *opts.(*arvados.ListOptions)) }, }, { arvados.EndpointCollectionProvenance, func() interface{} { return &arvados.GetOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionProvenance(ctx, *opts.(*arvados.GetOptions)) + return rtr.backend.CollectionProvenance(ctx, *opts.(*arvados.GetOptions)) }, }, { arvados.EndpointCollectionUsedBy, func() interface{} { return &arvados.GetOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionUsedBy(ctx, *opts.(*arvados.GetOptions)) + return rtr.backend.CollectionUsedBy(ctx, *opts.(*arvados.GetOptions)) }, }, { arvados.EndpointCollectionDelete, func() interface{} { return &arvados.DeleteOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionDelete(ctx, *opts.(*arvados.DeleteOptions)) + return rtr.backend.CollectionDelete(ctx, *opts.(*arvados.DeleteOptions)) }, }, { arvados.EndpointCollectionTrash, func() interface{} { return &arvados.DeleteOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionTrash(ctx, *opts.(*arvados.DeleteOptions)) + return rtr.backend.CollectionTrash(ctx, *opts.(*arvados.DeleteOptions)) }, }, { arvados.EndpointCollectionUntrash, func() interface{} { return &arvados.UntrashOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.CollectionUntrash(ctx, *opts.(*arvados.UntrashOptions)) + return rtr.backend.CollectionUntrash(ctx, *opts.(*arvados.UntrashOptions)) }, }, { arvados.EndpointContainerCreate, func() interface{} { return &arvados.CreateOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.ContainerCreate(ctx, *opts.(*arvados.CreateOptions)) + return rtr.backend.ContainerCreate(ctx, *opts.(*arvados.CreateOptions)) }, }, { arvados.EndpointContainerUpdate, func() interface{} { return &arvados.UpdateOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.ContainerUpdate(ctx, *opts.(*arvados.UpdateOptions)) + return rtr.backend.ContainerUpdate(ctx, *opts.(*arvados.UpdateOptions)) }, }, { arvados.EndpointContainerGet, func() interface{} { return &arvados.GetOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.ContainerGet(ctx, *opts.(*arvados.GetOptions)) + return rtr.backend.ContainerGet(ctx, *opts.(*arvados.GetOptions)) }, }, { arvados.EndpointContainerList, func() interface{} { return &arvados.ListOptions{Limit: -1} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.ContainerList(ctx, *opts.(*arvados.ListOptions)) + return rtr.backend.ContainerList(ctx, *opts.(*arvados.ListOptions)) }, }, { arvados.EndpointContainerDelete, func() interface{} { return &arvados.DeleteOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.ContainerDelete(ctx, *opts.(*arvados.DeleteOptions)) + return rtr.backend.ContainerDelete(ctx, *opts.(*arvados.DeleteOptions)) }, }, { @@ -143,7 +174,7 @@ func (rtr *router) addRoutes(cluster *arvados.Cluster) { return &arvados.GetOptions{Select: []string{"uuid", "state", "priority", "auth_uuid", "locked_by_uuid"}} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.ContainerLock(ctx, *opts.(*arvados.GetOptions)) + return rtr.backend.ContainerLock(ctx, *opts.(*arvados.GetOptions)) }, }, { @@ -152,101 +183,220 @@ func (rtr *router) addRoutes(cluster *arvados.Cluster) { return &arvados.GetOptions{Select: []string{"uuid", "state", "priority", "auth_uuid", "locked_by_uuid"}} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.ContainerUnlock(ctx, *opts.(*arvados.GetOptions)) + return rtr.backend.ContainerUnlock(ctx, *opts.(*arvados.GetOptions)) }, }, { arvados.EndpointSpecimenCreate, func() interface{} { return &arvados.CreateOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.SpecimenCreate(ctx, *opts.(*arvados.CreateOptions)) + return rtr.backend.SpecimenCreate(ctx, *opts.(*arvados.CreateOptions)) }, }, { arvados.EndpointSpecimenUpdate, func() interface{} { return &arvados.UpdateOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.SpecimenUpdate(ctx, *opts.(*arvados.UpdateOptions)) + return rtr.backend.SpecimenUpdate(ctx, *opts.(*arvados.UpdateOptions)) }, }, { arvados.EndpointSpecimenGet, func() interface{} { return &arvados.GetOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.SpecimenGet(ctx, *opts.(*arvados.GetOptions)) + return rtr.backend.SpecimenGet(ctx, *opts.(*arvados.GetOptions)) }, }, { arvados.EndpointSpecimenList, func() interface{} { return &arvados.ListOptions{Limit: -1} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.SpecimenList(ctx, *opts.(*arvados.ListOptions)) + return rtr.backend.SpecimenList(ctx, *opts.(*arvados.ListOptions)) }, }, { arvados.EndpointSpecimenDelete, func() interface{} { return &arvados.DeleteOptions{} }, func(ctx context.Context, opts interface{}) (interface{}, error) { - return rtr.fed.SpecimenDelete(ctx, *opts.(*arvados.DeleteOptions)) + return rtr.backend.SpecimenDelete(ctx, *opts.(*arvados.DeleteOptions)) + }, + }, + { + arvados.EndpointUserCreate, + func() interface{} { return &arvados.CreateOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserCreate(ctx, *opts.(*arvados.CreateOptions)) + }, + }, + { + arvados.EndpointUserMerge, + func() interface{} { return &arvados.UserMergeOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserMerge(ctx, *opts.(*arvados.UserMergeOptions)) + }, + }, + { + arvados.EndpointUserActivate, + func() interface{} { return &arvados.UserActivateOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserActivate(ctx, *opts.(*arvados.UserActivateOptions)) + }, + }, + { + arvados.EndpointUserSetup, + func() interface{} { return &arvados.UserSetupOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserSetup(ctx, *opts.(*arvados.UserSetupOptions)) + }, + }, + { + arvados.EndpointUserUnsetup, + func() interface{} { return &arvados.GetOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserUnsetup(ctx, *opts.(*arvados.GetOptions)) + }, + }, + { + arvados.EndpointUserGetCurrent, + func() interface{} { return &arvados.GetOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserGetCurrent(ctx, *opts.(*arvados.GetOptions)) + }, + }, + { + arvados.EndpointUserGetSystem, + func() interface{} { return &arvados.GetOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserGetSystem(ctx, *opts.(*arvados.GetOptions)) + }, + }, + { + arvados.EndpointUserGet, + func() interface{} { return &arvados.GetOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserGet(ctx, *opts.(*arvados.GetOptions)) + }, + }, + { + arvados.EndpointUserUpdateUUID, + func() interface{} { return &arvados.UpdateUUIDOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserUpdateUUID(ctx, *opts.(*arvados.UpdateUUIDOptions)) + }, + }, + { + arvados.EndpointUserUpdate, + func() interface{} { return &arvados.UpdateOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserUpdate(ctx, *opts.(*arvados.UpdateOptions)) + }, + }, + { + arvados.EndpointUserList, + func() interface{} { return &arvados.ListOptions{Limit: -1} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserList(ctx, *opts.(*arvados.ListOptions)) + }, + }, + { + arvados.EndpointUserBatchUpdate, + func() interface{} { return &arvados.UserBatchUpdateOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserBatchUpdate(ctx, *opts.(*arvados.UserBatchUpdateOptions)) + }, + }, + { + arvados.EndpointUserDelete, + func() interface{} { return &arvados.DeleteOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserDelete(ctx, *opts.(*arvados.DeleteOptions)) + }, + }, + { + arvados.EndpointUserAuthenticate, + func() interface{} { return &arvados.UserAuthenticateOptions{} }, + func(ctx context.Context, opts interface{}) (interface{}, error) { + return rtr.backend.UserAuthenticate(ctx, *opts.(*arvados.UserAuthenticateOptions)) }, }, } { - route := route - methods := []string{route.endpoint.Method} - if route.endpoint.Method == "PATCH" { - methods = append(methods, "PUT") + exec := route.exec + if rtr.wrapCalls != nil { + exec = rtr.wrapCalls(exec) } - for _, method := range methods { - rtr.mux.HandlerFunc(method, "/"+route.endpoint.Path, func(w http.ResponseWriter, req *http.Request) { - logger := ctxlog.FromContext(req.Context()) - params, err := rtr.loadRequestParams(req, route.endpoint.AttrsKey) - if err != nil { - logger.WithField("req", req).WithField("route", route).WithError(err).Debug("error loading request params") - rtr.sendError(w, err) - return - } - opts := route.defaultOpts() - err = rtr.transcode(params, opts) - if err != nil { - logger.WithField("params", params).WithError(err).Debugf("error transcoding params to %T", opts) - rtr.sendError(w, err) - return - } - respOpts, err := rtr.responseOptions(opts) - if err != nil { - logger.WithField("opts", opts).WithError(err).Debugf("error getting response options from %T", opts) - rtr.sendError(w, err) - return - } + rtr.addRoute(route.endpoint, route.defaultOpts, exec) + } + rtr.mux.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { + httpserver.Errors(w, []string{"API endpoint not found"}, http.StatusNotFound) + }) + rtr.mux.MethodNotAllowedHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { + httpserver.Errors(w, []string{"API endpoint not found"}, http.StatusMethodNotAllowed) + }) +} - creds := auth.CredentialsFromRequest(req) - if rt, _ := params["reader_tokens"].([]interface{}); len(rt) > 0 { - for _, t := range rt { - if t, ok := t.(string); ok { - creds.Tokens = append(creds.Tokens, t) - } - } - } - ctx := req.Context() - ctx = context.WithValue(ctx, auth.ContextKeyCredentials, creds) - ctx = arvados.ContextWithRequestID(ctx, req.Header.Get("X-Request-Id")) - logger.WithFields(logrus.Fields{ - "apiEndpoint": route.endpoint, - "apiOptsType": fmt.Sprintf("%T", opts), - "apiOpts": opts, - }).Debug("exec") - resp, err := route.exec(ctx, opts) - if err != nil { - logger.WithError(err).Debugf("returning error type %T", err) - rtr.sendError(w, err) - return +var altMethod = map[string]string{ + "PATCH": "PUT", // Accept PUT as a synonym for PATCH + "GET": "HEAD", // Accept HEAD at any GET route +} + +func (rtr *router) addRoute(endpoint arvados.APIEndpoint, defaultOpts func() interface{}, exec api.RoutableFunc) { + methods := []string{endpoint.Method} + if alt, ok := altMethod[endpoint.Method]; ok { + methods = append(methods, alt) + } + rtr.mux.Methods(methods...).Path("/" + endpoint.Path).HandlerFunc(func(w http.ResponseWriter, req *http.Request) { + logger := ctxlog.FromContext(req.Context()) + params, err := rtr.loadRequestParams(req, endpoint.AttrsKey) + if err != nil { + logger.WithFields(logrus.Fields{ + "req": req, + "method": endpoint.Method, + "endpoint": endpoint, + }).WithError(err).Debug("error loading request params") + rtr.sendError(w, err) + return + } + opts := defaultOpts() + err = rtr.transcode(params, opts) + if err != nil { + logger.WithField("params", params).WithError(err).Debugf("error transcoding params to %T", opts) + rtr.sendError(w, err) + return + } + respOpts, err := rtr.responseOptions(opts) + if err != nil { + logger.WithField("opts", opts).WithError(err).Debugf("error getting response options from %T", opts) + rtr.sendError(w, err) + return + } + + creds := auth.CredentialsFromRequest(req) + err = creds.LoadTokensFromHTTPRequestBody(req) + if err != nil { + rtr.sendError(w, fmt.Errorf("error loading tokens from request body: %s", err)) + return + } + if rt, _ := params["reader_tokens"].([]interface{}); len(rt) > 0 { + for _, t := range rt { + if t, ok := t.(string); ok { + creds.Tokens = append(creds.Tokens, t) } - rtr.sendResponse(w, resp, respOpts) - }) + } } - } - rtr.mux.NotFound = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { - httpserver.Errors(w, []string{"API endpoint not found"}, http.StatusNotFound) + ctx := auth.NewContext(req.Context(), creds) + ctx = arvados.ContextWithRequestID(ctx, req.Header.Get("X-Request-Id")) + logger.WithFields(logrus.Fields{ + "apiEndpoint": endpoint, + "apiOptsType": fmt.Sprintf("%T", opts), + "apiOpts": opts, + }).Debug("exec") + resp, err := exec(ctx, opts) + if err != nil { + logger.WithError(err).Debugf("returning error type %T", err) + rtr.sendError(w, err) + return + } + rtr.sendResponse(w, req, resp, respOpts) }) } @@ -255,18 +405,24 @@ func (rtr *router) ServeHTTP(w http.ResponseWriter, r *http.Request) { case "login", "logout", "auth": default: w.Header().Set("Access-Control-Allow-Origin", "*") - w.Header().Set("Access-Control-Allow-Methods", "GET, HEAD, PUT, POST, DELETE") - w.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Type") + w.Header().Set("Access-Control-Allow-Methods", "GET, HEAD, PUT, POST, PATCH, DELETE") + w.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Type, X-Http-Method-Override") w.Header().Set("Access-Control-Max-Age", "86486400") } if r.Method == "OPTIONS" { return } - r.ParseForm() - if m := r.FormValue("_method"); m != "" { - r2 := *r - r = &r2 - r.Method = m + if r.Method == "POST" { + r.ParseForm() + if m := r.FormValue("_method"); m != "" { + r2 := *r + r = &r2 + r.Method = m + } else if m = r.Header.Get("X-Http-Method-Override"); m != "" { + r2 := *r + r = &r2 + r.Method = m + } } rtr.mux.ServeHTTP(w, r) }