mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
calls, apps, and routes listing were previously returning the entire data set, which just won't scale. this adds pagination with cursoring forward to each of these endpoints (see the [docs](docs/definitions.md)). the patch is really mostly tests, shouldn't be that bad to pick through. some blarble about implementation is in order: calls are sorted by ids but allow searching within certain `created_at` ranges (finally). this is because sorting by `created_at` isn't feasible when combined with paging, as `created_at` is not guaranteed to be unique -- id's are (eliding theoreticals). i.e. on a page boundary, if there are 200 calls with the same `created_at`, providing a `cursor` of that `created_at` will skip over the remaining N calls with that `created_at`. also using id will be better on the index anyway (well, less of them). yay having sortable ids! I can't discern any issues doing this, as even if 200 calls have the same created_at, they will have different ids, and the sort should allow paginating them just fine. ids are also url safe, so the id works as the cursor value just fine. apps and routes are sorted by alphabetical order. as they aren't guaranteed to be url safe, we are base64'ing them in the front end to a url safe format and then returning them, and then base64 decoding them when we get them. this does mean that they can be relatively large if the path/app is long, but if we don't want to add ids then they were going to be pretty big anyway. a bonus that this kind of obscures them. if somebody has better idea on formatting, by all means. notably, we are not using the sql paging facilities, and we are baking our own based on cursors, which ends up being much more efficient for querying longer lists of resources. this also should be easy to implement in other non-sql dbs and the cursoring formats we can change on the fly since we are just exposing them as opaque strings. the front end deals with the base64 / formatting, etc and the back end is taking raw values (strfmt.DateTime or the id for calls). the cursor that is being passed to/by the user is simply the last resource on the previous page, so in theory we don't even need to return it, but it does make it a little easier to use, also, cursor being blank on the last page depends on page full-ness, so sometimes users will get a cursor when there are no results on next page (1/N chance, and it's not really end of world -- actually searching for the next thing would make things more complex). there are ample tests for this behavior. I've turned off all query parameters allowing `LIKE` queries on certain listing endpoints, as we should not expose sql behavior through our API in the event that we end up not using a sql db down the road. I think we should only allow prefix matching, which sql can support as well as other types of databases relatively cheaply, but this is not hooked up here as it didn't 'just work' when I was fiddling with it (can add later, they're unnecessary and weren't wired in before in front end). * remove route listing across apps (unused) * fix panic when doing `/app//`. this is prob possible for other types of endpoints, out of scope here. added a guard in front of all endpoints for this * adds `from_time` and `to_time` query parameters to calls, so you can e.g. list the last hour of tasks. these are not required and default to oldest/newest. * hooked back up the datastore tests to the sql db, only run with sqlite atm, but these are useful, added a lot to them too. * added a bunch of tests to the front end, so pretty sure this all works now. * added to swagger, we'll need to re-gen. also wrote some words about pagination workings, I'm not sure how best to link to these, feedback welcome. * not sure how we want to manage indexes, but we may need to add some (looking at created_at, mostly) * `?route` changed to `?path` in routes listing, to keep consistency with everything else * don't 404 when searching for calls where the route doesn't exist, just return an empty list (it's a query param ffs) closes #141
176 lines
4.4 KiB
Go
176 lines
4.4 KiB
Go
package server
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"path"
|
|
"strings"
|
|
|
|
"github.com/fnproject/fn/api"
|
|
"github.com/fnproject/fn/api/models"
|
|
"github.com/gin-gonic/gin"
|
|
)
|
|
|
|
/* handleRouteCreateOrUpdate is used to handle POST PUT and PATCH for routes.
|
|
Post will only create route if its not there and create app if its not.
|
|
create only
|
|
Post does not skip validation of zero values
|
|
Put will create app if its not there and if route is there update if not it will create new route.
|
|
update if exists or create if not exists
|
|
Put does not skip validation of zero values
|
|
Patch will not create app if it does not exist since the route needs to exist as well...
|
|
update only
|
|
Patch accepts partial updates / skips validation of zero values.
|
|
*/
|
|
func (s *Server) handleRoutesPostPutPatch(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
method := strings.ToUpper(c.Request.Method)
|
|
|
|
var wroute models.RouteWrapper
|
|
err := bindRoute(c, method, &wroute)
|
|
if err != nil {
|
|
handleErrorResponse(c, err)
|
|
return
|
|
}
|
|
if method != http.MethodPatch {
|
|
err = s.ensureApp(ctx, &wroute, method)
|
|
if err != nil {
|
|
handleErrorResponse(c, err)
|
|
return
|
|
}
|
|
}
|
|
resp, err := s.ensureRoute(ctx, method, &wroute)
|
|
if err != nil {
|
|
handleErrorResponse(c, err)
|
|
return
|
|
}
|
|
|
|
c.JSON(http.StatusOK, resp)
|
|
}
|
|
|
|
func (s *Server) submitRoute(ctx context.Context, wroute *models.RouteWrapper) error {
|
|
err := s.setDefaultsAndValidate(wroute)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
r, err := s.Datastore.InsertRoute(ctx, wroute.Route)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
wroute.Route = r
|
|
return nil
|
|
}
|
|
|
|
func (s *Server) changeRoute(ctx context.Context, wroute *models.RouteWrapper) error {
|
|
err := wroute.Validate(true)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
r, err := s.Datastore.UpdateRoute(ctx, wroute.Route)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
wroute.Route = r
|
|
return nil
|
|
}
|
|
|
|
// ensureApp will only execute if it is on put
|
|
func (s *Server) ensureRoute(ctx context.Context, method string, wroute *models.RouteWrapper) (routeResponse, error) {
|
|
bad := new(routeResponse)
|
|
|
|
switch method {
|
|
case http.MethodPost:
|
|
err := s.submitRoute(ctx, wroute)
|
|
if err != nil {
|
|
return *bad, err
|
|
}
|
|
return routeResponse{"Route successfully created", wroute.Route}, nil
|
|
case http.MethodPut:
|
|
_, err := s.Datastore.GetRoute(ctx, wroute.Route.AppName, wroute.Route.Path)
|
|
if err != nil && err == models.ErrRoutesNotFound {
|
|
err := s.submitRoute(ctx, wroute)
|
|
if err != nil {
|
|
return *bad, err
|
|
}
|
|
return routeResponse{"Route successfully created", wroute.Route}, nil
|
|
} else {
|
|
err := s.changeRoute(ctx, wroute)
|
|
if err != nil {
|
|
return *bad, err
|
|
}
|
|
return routeResponse{"Route successfully updated", wroute.Route}, nil
|
|
}
|
|
case http.MethodPatch:
|
|
err := s.changeRoute(ctx, wroute)
|
|
if err != nil {
|
|
return *bad, err
|
|
}
|
|
return routeResponse{"Route successfully updated", wroute.Route}, nil
|
|
}
|
|
return *bad, nil
|
|
}
|
|
|
|
// ensureApp will only execute if it is on post or put. Patch is not allowed to create apps.
|
|
func (s *Server) ensureApp(ctx context.Context, wroute *models.RouteWrapper, method string) error {
|
|
app, err := s.Datastore.GetApp(ctx, wroute.Route.AppName)
|
|
if err != nil && err != models.ErrAppsNotFound {
|
|
return err
|
|
} else if app == nil {
|
|
// Create a new application
|
|
newapp := &models.App{Name: wroute.Route.AppName}
|
|
if err = newapp.Validate(); err != nil {
|
|
return err
|
|
}
|
|
|
|
err = s.FireBeforeAppCreate(ctx, newapp)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = s.Datastore.InsertApp(ctx, newapp)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = s.FireAfterAppCreate(ctx, newapp)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// bindRoute binds the RouteWrapper to the json from the request.
|
|
func bindRoute(c *gin.Context, method string, wroute *models.RouteWrapper) error {
|
|
err := c.BindJSON(wroute)
|
|
if err != nil {
|
|
return models.ErrInvalidJSON
|
|
}
|
|
|
|
if wroute.Route == nil {
|
|
return models.ErrRoutesMissingNew
|
|
}
|
|
wroute.Route.AppName = c.MustGet(api.AppName).(string)
|
|
|
|
if method == http.MethodPut || method == http.MethodPatch {
|
|
p := path.Clean(c.MustGet(api.Path).(string))
|
|
|
|
if wroute.Route.Path != "" && wroute.Route.Path != p {
|
|
return models.ErrRoutesPathImmutable
|
|
}
|
|
wroute.Route.Path = p
|
|
}
|
|
if method == http.MethodPost {
|
|
if wroute.Route.Path == "" {
|
|
return models.ErrMissingPath
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *Server) setDefaultsAndValidate(wroute *models.RouteWrapper) error {
|
|
wroute.Route.SetDefaults()
|
|
return wroute.Validate(false)
|
|
}
|