Merge pull request #74 from pedronasser/improve-runner

Improve runner
This commit is contained in:
Travis Reeder
2016-08-29 16:23:11 -07:00
committed by GitHub
20 changed files with 865 additions and 104 deletions

View File

@@ -208,13 +208,13 @@ func (ds *BoltDatastore) StoreRoute(route *models.Route) (*models.Route, error)
return route, nil
}
func (ds *BoltDatastore) RemoveRoute(appName, routeName string) error {
func (ds *BoltDatastore) RemoveRoute(appName, routePath string) error {
if appName == "" {
return models.ErrDatastoreEmptyAppName
}
if routeName == "" {
return models.ErrDatastoreEmptyRouteName
if routePath == "" {
return models.ErrDatastoreEmptyRoutePath
}
err := ds.db.Update(func(tx *bolt.Tx) error {
@@ -223,7 +223,7 @@ func (ds *BoltDatastore) RemoveRoute(appName, routeName string) error {
return err
}
err = b.Delete([]byte(routeName))
err = b.Delete([]byte(routePath))
if err != nil {
return err
}
@@ -235,13 +235,13 @@ func (ds *BoltDatastore) RemoveRoute(appName, routeName string) error {
return nil
}
func (ds *BoltDatastore) GetRoute(appName, routeName string) (*models.Route, error) {
func (ds *BoltDatastore) GetRoute(appName, routePath string) (*models.Route, error) {
if appName == "" {
return nil, models.ErrDatastoreEmptyAppName
}
if routeName == "" {
return nil, models.ErrDatastoreEmptyRouteName
if routePath == "" {
return nil, models.ErrDatastoreEmptyRoutePath
}
var route *models.Route
@@ -251,7 +251,7 @@ func (ds *BoltDatastore) GetRoute(appName, routeName string) (*models.Route, err
return err
}
v := b.Get([]byte(routeName))
v := b.Get([]byte(routePath))
if v != nil {
err = json.Unmarshal(v, &route)
}

View File

@@ -118,7 +118,7 @@ func TestBolt(t *testing.T) {
t.Fatalf("Test GetRoute: error: %s", err)
}
if route.Path != testRoute.Path {
t.Fatalf("Test GetRoute: expected `route.Name` to be `%s` but it was `%s`", route.Path, testRoute.Path)
t.Fatalf("Test GetRoute: expected `route.Path` to be `%s` but it was `%s`", route.Path, testRoute.Path)
}
// Testing list routes

View File

@@ -9,46 +9,73 @@ type Mock struct {
FakeRoutes []*models.Route
}
func (m *Mock) GetApp(app string) (*models.App, error) {
return m.FakeApp, nil
func (m *Mock) GetApp(appName string) (*models.App, error) {
app := m.FakeApp
if app == nil && m.FakeApps != nil {
for _, a := range m.FakeApps {
if a.Name == appName {
app = a
}
}
}
return app, nil
}
func (m *Mock) GetApps(appFilter *models.AppFilter) ([]*models.App, error) {
// TODO: improve this mock method
return m.FakeApps, nil
}
func (m *Mock) StoreApp(app *models.App) (*models.App, error) {
// TODO: improve this mock method
return m.FakeApp, nil
}
func (m *Mock) RemoveApp(app string) error {
func (m *Mock) RemoveApp(appName string) error {
// TODO: improve this mock method
return nil
}
func (m *Mock) GetRoute(app, route string) (*models.Route, error) {
return m.FakeRoute, nil
func (m *Mock) GetRoute(appName, routePath string) (*models.Route, error) {
route := m.FakeRoute
if route == nil && m.FakeRoutes != nil {
for _, r := range m.FakeRoutes {
if r.AppName == appName && r.Path == routePath {
route = r
}
}
}
return route, nil
}
func (m *Mock) GetRoutes(routeFilter *models.RouteFilter) ([]*models.Route, error) {
// TODO: improve this mock method
return m.FakeRoutes, nil
}
func (m *Mock) GetRoutesByApp(appName string, routeFilter *models.RouteFilter) ([]*models.Route, error) {
// TODO: improve this mock method
return m.FakeRoutes, nil
}
func (m *Mock) StoreRoute(route *models.Route) (*models.Route, error) {
// TODO: improve this mock method
return m.FakeRoute, nil
}
func (m *Mock) RemoveRoute(app, route string) error {
func (m *Mock) RemoveRoute(appName, routePath string) error {
// TODO: improve this mock method
return nil
}
func (m *Mock) Put(key, value []byte) error {
// TODO: improve this mock method
return nil
}
func (m *Mock) Get(key []byte) ([]byte, error) {
// TODO: improve this mock method
return []byte{}, nil
}

View File

@@ -17,11 +17,13 @@ CREATE TABLE IF NOT EXISTS routes (
path text NOT NULL,
image character varying(256) NOT NULL,
headers text NOT NULL,
config text NOT NULL,
PRIMARY KEY (app_name, path)
);`
const appsTableCreate = `CREATE TABLE IF NOT EXISTS apps (
name character varying(256) NOT NULL PRIMARY KEY
config text NOT NULL,
);`
const extrasTableCreate = `CREATE TABLE IF NOT EXISTS extras (
@@ -73,13 +75,20 @@ func New(url *url.URL) (models.Datastore, error) {
}
func (ds *PostgresDatastore) StoreApp(app *models.App) (*models.App, error) {
_, err := ds.db.Exec(`
INSERT INTO apps (name)
VALUES ($1)
ON CONFLICT (name) DO NOTHING
RETURNING name;
`, app.Name)
// todo: after we support headers, the conflict should update the headers.
cbyte, err := json.Marshal(app.Config)
if err != nil {
return nil, err
}
_, err = ds.db.Exec(`
INSERT INTO apps (name, config)
VALUES ($1, $2)
ON CONFLICT (app_name) DO UPDATE SET
config = $2;
`,
app.Name,
string(cbyte),
)
if err != nil {
return nil, err
@@ -105,12 +114,15 @@ func (ds *PostgresDatastore) GetApp(name string) (*models.App, error) {
row := ds.db.QueryRow("SELECT name FROM apps WHERE name=$1", name)
var resName string
err := row.Scan(&resName)
var config string
err := row.Scan(&resName, &config)
res := &models.App{
Name: resName,
}
json.Unmarshal([]byte(config), &res.Config)
if err != nil {
return nil, err
}
@@ -155,32 +167,36 @@ func (ds *PostgresDatastore) GetApps(filter *models.AppFilter) ([]*models.App, e
}
func (ds *PostgresDatastore) StoreRoute(route *models.Route) (*models.Route, error) {
var headers string
hbyte, err := json.Marshal(route.Headers)
if err != nil {
return nil, err
}
headers = string(hbyte)
cbyte, err := json.Marshal(route.Config)
if err != nil {
return nil, err
}
_, err = ds.db.Exec(`
INSERT INTO routes (
app_name,
path,
image,
headers
headers,
config
)
VALUES ($1, $2, $3, $4)
ON CONFLICT (app_name, path) DO UPDATE SET
path = $2,
image = $3,
headers = $4;
config = $5;
`,
route.AppName,
route.Path,
route.Image,
headers,
string(hbyte),
string(cbyte),
)
if err != nil {
@@ -189,11 +205,11 @@ func (ds *PostgresDatastore) StoreRoute(route *models.Route) (*models.Route, err
return route, nil
}
func (ds *PostgresDatastore) RemoveRoute(appName, routeName string) error {
func (ds *PostgresDatastore) RemoveRoute(appName, routePath string) error {
_, err := ds.db.Exec(`
DELETE FROM routes
WHERE name = $1
`, routeName)
WHERE path = $1
`, routePath)
if err != nil {
return err
@@ -203,27 +219,30 @@ func (ds *PostgresDatastore) RemoveRoute(appName, routeName string) error {
func scanRoute(scanner rowScanner, route *models.Route) error {
var headerStr string
var configStr string
err := scanner.Scan(
// &route.Name,
&route.AppName,
&route.Path,
&route.Image,
&headerStr,
&configStr,
)
if headerStr == "" {
return models.ErrRoutesNotFound
}
err = json.Unmarshal([]byte(headerStr), &route.Headers)
json.Unmarshal([]byte(headerStr), &route.Headers)
json.Unmarshal([]byte(configStr), &route.Config)
return err
}
func getRoute(qr rowQuerier, routeName string) (*models.Route, error) {
func getRoute(qr rowQuerier, routePath string) (*models.Route, error) {
var route models.Route
row := qr.QueryRow(fmt.Sprintf("%s WHERE name=$1", routeSelector), routeName)
row := qr.QueryRow(fmt.Sprintf("%s WHERE name=$1", routeSelector), routePath)
err := scanRoute(row, &route)
if err == sql.ErrNoRows {
@@ -234,8 +253,8 @@ func getRoute(qr rowQuerier, routeName string) (*models.Route, error) {
return &route, nil
}
func (ds *PostgresDatastore) GetRoute(appName, routeName string) (*models.Route, error) {
return getRoute(ds.db, routeName)
func (ds *PostgresDatastore) GetRoute(appName, routePath string) (*models.Route, error) {
return getRoute(ds.db, routePath)
}
func (ds *PostgresDatastore) GetRoutes(filter *models.RouteFilter) ([]*models.Route, error) {

View File

@@ -22,6 +22,7 @@ var (
type App struct {
Name string `json:"name"`
Routes Routes `json:"routes,omitempty"`
Config `json:"config"`
}
const (

View File

@@ -1,7 +1,6 @@
package models
type Config struct {
}
type Config map[string]string
func (c *Config) Validate() error {
return nil

View File

@@ -8,11 +8,11 @@ type Datastore interface {
StoreApp(*App) (*App, error)
RemoveApp(appName string) error
GetRoute(appName, routeName string) (*Route, error)
GetRoute(appName, routePath string) (*Route, error)
GetRoutes(*RouteFilter) (routes []*Route, err error)
GetRoutesByApp(string, *RouteFilter) (routes []*Route, err error)
StoreRoute(*Route) (*Route, error)
RemoveRoute(appName, routeName string) error
RemoveRoute(appName, routePath string) error
// The following provide a generic key value store for arbitrary data, can be used by extensions to store extra data
// todo: should we namespace these by app? Then when an app is deleted, it can delete any of this extra data too.
@@ -22,7 +22,7 @@ type Datastore interface {
var (
ErrDatastoreEmptyAppName = errors.New("Missing app name")
ErrDatastoreEmptyRouteName = errors.New("Missing route name")
ErrDatastoreEmptyRoutePath = errors.New("Missing route name")
ErrDatastoreEmptyApp = errors.New("Missing app")
ErrDatastoreEmptyRoute = errors.New("Missing route")
)

View File

@@ -25,6 +25,7 @@ type Route struct {
Path string `json:"path,omitempty"`
Image string `json:"image,omitempty"`
Headers http.Header `json:"headers,omitempty"`
Config `json:"config"`
}
var (

View File

@@ -56,5 +56,5 @@ func handleAppCreate(c *gin.Context) {
return
}
c.JSON(http.StatusCreated, appResponse{"App successfully created", wapp})
c.JSON(http.StatusCreated, appResponse{"App successfully created", wapp})
}

View File

@@ -11,7 +11,7 @@ import (
)
func TestAppCreate(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -52,7 +52,7 @@ func TestAppCreate(t *testing.T) {
}
func TestAppDelete(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -83,7 +83,7 @@ func TestAppDelete(t *testing.T) {
}
func TestAppList(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -113,7 +113,7 @@ func TestAppList(t *testing.T) {
}
func TestAppGet(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -143,7 +143,7 @@ func TestAppGet(t *testing.T) {
}
func TestAppUpdate(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -154,13 +154,9 @@ func TestAppUpdate(t *testing.T) {
}{
// errors
{"/v1/apps/myapp", ``, http.StatusBadRequest, models.ErrInvalidJSON},
{"/v1/apps/myapp", `{ "name": "" }`, http.StatusInternalServerError, models.ErrAppsValidationMissingName},
{"/v1/apps/myapp", `{ "name": "1234567890123456789012345678901" }`, http.StatusInternalServerError, models.ErrAppsValidationTooLongName},
{"/v1/apps/myapp", `{ "name": "&&%@!#$#@$" }`, http.StatusInternalServerError, models.ErrAppsValidationInvalidName},
{"/v1/apps/myapp", `{ "name": "&&%@!#$#@$" }`, http.StatusInternalServerError, models.ErrAppsValidationInvalidName},
// success
{"/v1/apps/myapp", `{ "name": "teste" }`, http.StatusOK, nil},
{"/v1/apps/myapp", `{ "app": { "config": { "test": "1" } } }`, http.StatusOK, nil},
} {
body := bytes.NewBuffer([]byte(test.body))
_, rec := routerRequest(t, router, "PUT", test.path, body)

View File

@@ -14,34 +14,30 @@ func handleAppUpdate(c *gin.Context) {
ctx := c.MustGet("ctx").(context.Context)
log := titancommon.Logger(ctx)
app := &models.App{}
wapp := models.AppWrapper{}
err := c.BindJSON(app)
err := c.BindJSON(&wapp)
if err != nil {
log.WithError(err).Debug(models.ErrInvalidJSON)
c.JSON(http.StatusBadRequest, simpleError(models.ErrInvalidJSON))
return
}
if app == nil {
if wapp.App == nil {
log.Debug(models.ErrAppsMissingNew)
c.JSON(http.StatusBadRequest, simpleError(models.ErrAppsMissingNew))
return
}
if err := app.Validate(); err != nil {
log.Error(err)
c.JSON(http.StatusInternalServerError, simpleError(err))
app, err := Api.Datastore.StoreApp(wapp.App)
if err != nil {
log.WithError(err).Debug(models.ErrAppsCreate)
c.JSON(http.StatusInternalServerError, simpleError(models.ErrAppsCreate))
return
}
// app, err := Api.Datastore.StoreApp(wapp.App)
// if err != nil {
// log.WithError(err).Debug(models.ErrAppsCreate)
// c.JSON(http.StatusInternalServerError, simpleError(models.ErrAppsCreate))
// return
// }
wapp.App = app
// Nothing to update right now in apps
c.JSON(http.StatusOK, simpleError(models.ErrAppsNothingToUpdate))
c.JSON(http.StatusOK, appResponse{"App successfully updated", wapp})
}

View File

@@ -15,8 +15,8 @@ func handleRouteDelete(c *gin.Context) {
log := titancommon.Logger(ctx)
appName := c.Param("app")
routeName := c.Param("route")
err := Api.Datastore.RemoveRoute(appName, routeName)
routePath := c.Param("route")
err := Api.Datastore.RemoveRoute(appName, routePath)
if err != nil {
log.WithError(err).Debug(models.ErrRoutesRemoving)

View File

@@ -16,9 +16,9 @@ func handleRouteGet(c *gin.Context) {
log := titancommon.Logger(ctx)
appName := c.Param("app")
routeName := c.Param("route")
routePath := c.Param("route")
route, err := Api.Datastore.GetRoute(appName, routeName)
route, err := Api.Datastore.GetRoute(appName, routePath)
if err != nil {
log.WithError(err).Error(models.ErrRoutesGet)
c.JSON(http.StatusInternalServerError, simpleError(models.ErrRoutesGet))

View File

@@ -11,7 +11,7 @@ import (
)
func TestRouteCreate(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -52,7 +52,7 @@ func TestRouteCreate(t *testing.T) {
}
func TestRouteDelete(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -83,7 +83,7 @@ func TestRouteDelete(t *testing.T) {
}
func TestRouteList(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -113,7 +113,7 @@ func TestRouteList(t *testing.T) {
}
func TestRouteGet(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -143,7 +143,7 @@ func TestRouteGet(t *testing.T) {
}
func TestRouteUpdate(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{}, testRunner(t))
router := testRouter()
for i, test := range []struct {

View File

@@ -87,13 +87,16 @@ func handleRunner(c *gin.Context) {
route = c.Request.URL.Path
}
filter := &models.RouteFilter{
Path: route,
}
log.WithFields(logrus.Fields{"app": appName, "path": route}).Debug("Finding route on datastore")
routes, err := Api.Datastore.GetRoutesByApp(appName, filter)
app, err := Api.Datastore.GetApp(appName)
if err != nil || app == nil {
log.WithError(err).Error(models.ErrAppsNotFound)
c.JSON(http.StatusNotFound, simpleError(models.ErrAppsNotFound))
return
}
routes, err := Api.Datastore.GetRoutesByApp(appName, &models.RouteFilter{})
if err != nil {
log.WithError(err).Error(models.ErrRoutesList)
c.JSON(http.StatusInternalServerError, simpleError(models.ErrRoutesList))
@@ -108,8 +111,31 @@ func handleRunner(c *gin.Context) {
log.WithField("routes", routes).Debug("Got routes from datastore")
for _, el := range routes {
if el.Path == route {
if params, match := matchRoute(el.Path, route); match {
var stdout, stderr bytes.Buffer
envVars := map[string]string{
"METHOD": c.Request.Method,
"ROUTE": el.Path,
"PAYLOAD": string(payload),
"REQUEST_URL": c.Request.URL.String(),
}
// app config
for k, v := range app.Config {
envVars["CONFIG_"+strings.ToUpper(k)] = v
}
// route config
for k, v := range el.Config {
envVars["CONFIG_"+strings.ToUpper(k)] = v
}
// params
for _, param := range params {
envVars["PARAM_"+strings.ToUpper(param.Key)] = param.Value
}
cfg := &runner.Config{
Image: el.Image,
Timeout: 30 * time.Second,
@@ -117,10 +143,7 @@ func handleRunner(c *gin.Context) {
AppName: appName,
Stdout: &stdout,
Stderr: &stderr,
Env: map[string]string{
"PAYLOAD": string(payload),
"REQUEST_URL": c.Request.URL.String(),
},
Env: envVars,
}
if result, err := Api.Runner.Run(c, cfg); err != nil {
@@ -143,3 +166,16 @@ func handleRunner(c *gin.Context) {
}
}
var fakeHandler = func(http.ResponseWriter, *http.Request, Params) {}
func matchRoute(baseRoute, route string) (Params, bool) {
tree := &node{}
tree.addRoute(baseRoute, fakeHandler)
handler, p, _ := tree.getValue(route)
if handler == nil {
return nil, false
}
return p, true
}

View File

@@ -12,7 +12,11 @@ import (
)
func TestRouteRunnerGet(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{
FakeApps: []*models.App{
{Name: "myapp", Config: models.Config{}},
},
}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -22,7 +26,8 @@ func TestRouteRunnerGet(t *testing.T) {
expectedError error
}{
{"/route", "", http.StatusBadRequest, models.ErrAppsNotFound},
{"/r/app/route", "", http.StatusNotFound, models.ErrRunnerRouteNotFound},
{"/r/app/route", "", http.StatusNotFound, models.ErrAppsNotFound},
{"/r/myapp/route", "", http.StatusNotFound, models.ErrRunnerRouteNotFound},
{"/route?payload=test", "", http.StatusBadRequest, models.ErrInvalidJSON},
{"/r/app/route?payload=test", "", http.StatusBadRequest, models.ErrInvalidJSON},
} {
@@ -45,7 +50,11 @@ func TestRouteRunnerGet(t *testing.T) {
}
func TestRouteRunnerPost(t *testing.T) {
New(&models.Config{}, &datastore.Mock{}, testRunner(t))
New(&datastore.Mock{
FakeApps: []*models.App{
{Name: "myapp", Config: models.Config{}},
},
}, testRunner(t))
router := testRouter()
for i, test := range []struct {
@@ -57,7 +66,8 @@ func TestRouteRunnerPost(t *testing.T) {
{"/route", `payload`, http.StatusBadRequest, models.ErrInvalidJSON},
{"/r/app/route", `payload`, http.StatusBadRequest, models.ErrInvalidJSON},
{"/route", `{ "payload": "" }`, http.StatusBadRequest, models.ErrAppsNotFound},
{"/r/app/route", `{ "payload": "" }`, http.StatusNotFound, models.ErrRunnerRouteNotFound},
{"/r/app/route", `{ "payload": "" }`, http.StatusNotFound, models.ErrAppsNotFound},
{"/r/myapp/route", `{ "payload": "" }`, http.StatusNotFound, models.ErrRunnerRouteNotFound},
} {
body := bytes.NewBuffer([]byte(test.body))
_, rec := routerRequest(t, router, "POST", test.path, body)
@@ -81,10 +91,13 @@ func TestRouteRunnerPost(t *testing.T) {
}
func TestRouteRunnerExecution(t *testing.T) {
New(&models.Config{}, &datastore.Mock{
New(&datastore.Mock{
FakeApps: []*models.App{
{Name: "myapp", Config: models.Config{}},
},
FakeRoutes: []*models.Route{
{Path: "/myroute", Image: "iron/hello", Headers: map[string][]string{"X-Function": []string{"Test"}}},
{Path: "/myerror", Image: "iron/error", Headers: map[string][]string{"X-Function": []string{"Test"}}},
{Path: "/myroute", AppName: "myapp", Image: "iron/hello", Headers: map[string][]string{"X-Function": []string{"Test"}}},
{Path: "/myerror", AppName: "myapp", Image: "iron/error", Headers: map[string][]string{"X-Function": []string{"Test"}}},
},
}, testRunner(t))
router := testRouter()
@@ -120,3 +133,28 @@ func TestRouteRunnerExecution(t *testing.T) {
}
}
}
func TestMatchRoute(t *testing.T) {
for i, test := range []struct {
baseRoute string
route string
expectedParams []Param
}{
{"/myroute/", `/myroute/`, nil},
{"/myroute/:mybigparam", `/myroute/1`, []Param{{"mybigparam", "1"}}},
{"/:param/*test", `/1/2`, []Param{{"param", "1"}, {"test", "/2"}}},
} {
if params, match := matchRoute(test.baseRoute, test.route); match {
if test.expectedParams != nil {
for j, param := range test.expectedParams {
if params[j].Key != param.Key || params[j].Value != param.Value {
fmt.Println(params[j])
t.Errorf("Test %d: expected param %d, key = %s, value = %s", i, j, param.Key, param.Value)
}
}
}
} else {
t.Errorf("Test %d: %s should match %s", i, test.route, test.baseRoute)
}
}
}

View File

@@ -20,16 +20,14 @@ var Api *Server
type Server struct {
Runner *runner.Runner
Router *gin.Engine
Config *models.Config
Datastore models.Datastore
AppListeners []ifaces.AppListener
SpecialHandlers []ifaces.SpecialHandler
}
func New(c *models.Config, ds models.Datastore, r *runner.Runner) *Server {
func New(ds models.Datastore, r *runner.Runner) *Server {
Api = &Server{
Router: gin.Default(),
Config: c,
Datastore: ds,
Runner: r,
}

View File

@@ -26,7 +26,7 @@ func TestFullStack(t *testing.T) {
ds, close := prepareBolt(t)
defer close()
New(&models.Config{}, ds, testRunner(t))
New(ds, testRunner(t))
router := testRouter()
for i, test := range []struct {

657
api/server/tree.go Normal file
View File

@@ -0,0 +1,657 @@
// Copyright 2013 Julien Schmidt. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be found
// in the LICENSE file.
package server
import (
"net/http"
"strings"
"unicode"
"unicode/utf8"
)
type Handle func(http.ResponseWriter, *http.Request, Params)
type Param struct {
Key string
Value string
}
type Params []Param
func min(a, b int) int {
if a <= b {
return a
}
return b
}
func countParams(path string) uint8 {
var n uint
for i := 0; i < len(path); i++ {
if path[i] != ':' && path[i] != '*' {
continue
}
n++
}
if n >= 255 {
return 255
}
return uint8(n)
}
type nodeType uint8
const (
static nodeType = iota // default
root
param
catchAll
)
type node struct {
path string
wildChild bool
nType nodeType
maxParams uint8
indices string
children []*node
handle Handle
priority uint32
}
// increments priority of the given child and reorders if necessary
func (n *node) incrementChildPrio(pos int) int {
n.children[pos].priority++
prio := n.children[pos].priority
// adjust position (move to front)
newPos := pos
for newPos > 0 && n.children[newPos-1].priority < prio {
// swap node positions
tmpN := n.children[newPos-1]
n.children[newPos-1] = n.children[newPos]
n.children[newPos] = tmpN
newPos--
}
// build new index char string
if newPos != pos {
n.indices = n.indices[:newPos] + // unchanged prefix, might be empty
n.indices[pos:pos+1] + // the index char we move
n.indices[newPos:pos] + n.indices[pos+1:] // rest without char at 'pos'
}
return newPos
}
// addRoute adds a node with the given handle to the path.
// Not concurrency-safe!
func (n *node) addRoute(path string, handle Handle) {
fullPath := path
n.priority++
numParams := countParams(path)
// non-empty tree
if len(n.path) > 0 || len(n.children) > 0 {
walk:
for {
// Update maxParams of the current node
if numParams > n.maxParams {
n.maxParams = numParams
}
// Find the longest common prefix.
// This also implies that the common prefix contains no ':' or '*'
// since the existing key can't contain those chars.
i := 0
max := min(len(path), len(n.path))
for i < max && path[i] == n.path[i] {
i++
}
// Split edge
if i < len(n.path) {
child := node{
path: n.path[i:],
wildChild: n.wildChild,
nType: static,
indices: n.indices,
children: n.children,
handle: n.handle,
priority: n.priority - 1,
}
// Update maxParams (max of all children)
for i := range child.children {
if child.children[i].maxParams > child.maxParams {
child.maxParams = child.children[i].maxParams
}
}
n.children = []*node{&child}
// []byte for proper unicode char conversion, see #65
n.indices = string([]byte{n.path[i]})
n.path = path[:i]
n.handle = nil
n.wildChild = false
}
// Make new node a child of this node
if i < len(path) {
path = path[i:]
if n.wildChild {
n = n.children[0]
n.priority++
// Update maxParams of the child node
if numParams > n.maxParams {
n.maxParams = numParams
}
numParams--
// Check if the wildcard matches
if len(path) >= len(n.path) && n.path == path[:len(n.path)] {
// check for longer wildcard, e.g. :name and :names
if len(n.path) >= len(path) || path[len(n.path)] == '/' {
continue walk
}
}
panic("path segment '" + path +
"' conflicts with existing wildcard '" + n.path +
"' in path '" + fullPath + "'")
}
c := path[0]
// slash after param
if n.nType == param && c == '/' && len(n.children) == 1 {
n = n.children[0]
n.priority++
continue walk
}
// Check if a child with the next path byte exists
for i := 0; i < len(n.indices); i++ {
if c == n.indices[i] {
i = n.incrementChildPrio(i)
n = n.children[i]
continue walk
}
}
// Otherwise insert it
if c != ':' && c != '*' {
// []byte for proper unicode char conversion, see #65
n.indices += string([]byte{c})
child := &node{
maxParams: numParams,
}
n.children = append(n.children, child)
n.incrementChildPrio(len(n.indices) - 1)
n = child
}
n.insertChild(numParams, path, fullPath, handle)
return
} else if i == len(path) { // Make node a (in-path) leaf
if n.handle != nil {
panic("a handle is already registered for path '" + fullPath + "'")
}
n.handle = handle
}
return
}
} else { // Empty tree
n.insertChild(numParams, path, fullPath, handle)
n.nType = root
}
}
func (n *node) insertChild(numParams uint8, path, fullPath string, handle Handle) {
var offset int // already handled bytes of the path
// find prefix until first wildcard (beginning with ':'' or '*'')
for i, max := 0, len(path); numParams > 0; i++ {
c := path[i]
if c != ':' && c != '*' {
continue
}
// find wildcard end (either '/' or path end)
end := i + 1
for end < max && path[end] != '/' {
switch path[end] {
// the wildcard name must not contain ':' and '*'
case ':', '*':
panic("only one wildcard per path segment is allowed, has: '" +
path[i:] + "' in path '" + fullPath + "'")
default:
end++
}
}
// check if this Node existing children which would be
// unreachable if we insert the wildcard here
if len(n.children) > 0 {
panic("wildcard route '" + path[i:end] +
"' conflicts with existing children in path '" + fullPath + "'")
}
// check if the wildcard has a name
if end-i < 2 {
panic("wildcards must be named with a non-empty name in path '" + fullPath + "'")
}
if c == ':' { // param
// split path at the beginning of the wildcard
if i > 0 {
n.path = path[offset:i]
offset = i
}
child := &node{
nType: param,
maxParams: numParams,
}
n.children = []*node{child}
n.wildChild = true
n = child
n.priority++
numParams--
// if the path doesn't end with the wildcard, then there
// will be another non-wildcard subpath starting with '/'
if end < max {
n.path = path[offset:end]
offset = end
child := &node{
maxParams: numParams,
priority: 1,
}
n.children = []*node{child}
n = child
}
} else { // catchAll
if end != max || numParams > 1 {
panic("catch-all routes are only allowed at the end of the path in path '" + fullPath + "'")
}
if len(n.path) > 0 && n.path[len(n.path)-1] == '/' {
panic("catch-all conflicts with existing handle for the path segment root in path '" + fullPath + "'")
}
// currently fixed width 1 for '/'
i--
if path[i] != '/' {
panic("no / before catch-all in path '" + fullPath + "'")
}
n.path = path[offset:i]
// first node: catchAll node with empty path
child := &node{
wildChild: true,
nType: catchAll,
maxParams: 1,
}
n.children = []*node{child}
n.indices = string(path[i])
n = child
n.priority++
// second node: node holding the variable
child = &node{
path: path[i:],
nType: catchAll,
maxParams: 1,
handle: handle,
priority: 1,
}
n.children = []*node{child}
return
}
}
// insert remaining path part and handle to the leaf
n.path = path[offset:]
n.handle = handle
}
// Returns the handle registered with the given path (key). The values of
// wildcards are saved to a map.
// If no handle can be found, a TSR (trailing slash redirect) recommendation is
// made if a handle exists with an extra (without the) trailing slash for the
// given path.
func (n *node) getValue(path string) (handle Handle, p Params, tsr bool) {
walk: // outer loop for walking the tree
for {
if len(path) > len(n.path) {
if path[:len(n.path)] == n.path {
path = path[len(n.path):]
// If this node does not have a wildcard (param or catchAll)
// child, we can just look up the next child node and continue
// to walk down the tree
if !n.wildChild {
c := path[0]
for i := 0; i < len(n.indices); i++ {
if c == n.indices[i] {
n = n.children[i]
continue walk
}
}
// Nothing found.
// We can recommend to redirect to the same URL without a
// trailing slash if a leaf exists for that path.
tsr = (path == "/" && n.handle != nil)
return
}
// handle wildcard child
n = n.children[0]
switch n.nType {
case param:
// find param end (either '/' or path end)
end := 0
for end < len(path) && path[end] != '/' {
end++
}
// save param value
if p == nil {
// lazy allocation
p = make(Params, 0, n.maxParams)
}
i := len(p)
p = p[:i+1] // expand slice within preallocated capacity
p[i].Key = n.path[1:]
p[i].Value = path[:end]
// we need to go deeper!
if end < len(path) {
if len(n.children) > 0 {
path = path[end:]
n = n.children[0]
continue walk
}
// ... but we can't
tsr = (len(path) == end+1)
return
}
if handle = n.handle; handle != nil {
return
} else if len(n.children) == 1 {
// No handle found. Check if a handle for this path + a
// trailing slash exists for TSR recommendation
n = n.children[0]
tsr = (n.path == "/" && n.handle != nil)
}
return
case catchAll:
// save param value
if p == nil {
// lazy allocation
p = make(Params, 0, n.maxParams)
}
i := len(p)
p = p[:i+1] // expand slice within preallocated capacity
p[i].Key = n.path[2:]
p[i].Value = path
handle = n.handle
return
default:
panic("invalid node type")
}
}
} else if path == n.path {
// We should have reached the node containing the handle.
// Check if this node has a handle registered.
if handle = n.handle; handle != nil {
return
}
if path == "/" && n.wildChild && n.nType != root {
tsr = true
return
}
// No handle found. Check if a handle for this path + a
// trailing slash exists for trailing slash recommendation
for i := 0; i < len(n.indices); i++ {
if n.indices[i] == '/' {
n = n.children[i]
tsr = (len(n.path) == 1 && n.handle != nil) ||
(n.nType == catchAll && n.children[0].handle != nil)
return
}
}
return
}
// Nothing found. We can recommend to redirect to the same URL with an
// extra trailing slash if a leaf exists for that path
tsr = (path == "/") ||
(len(n.path) == len(path)+1 && n.path[len(path)] == '/' &&
path == n.path[:len(n.path)-1] && n.handle != nil)
return
}
}
// Makes a case-insensitive lookup of the given path and tries to find a handler.
// It can optionally also fix trailing slashes.
// It returns the case-corrected path and a bool indicating whether the lookup
// was successful.
func (n *node) findCaseInsensitivePath(path string, fixTrailingSlash bool) (ciPath []byte, found bool) {
return n.findCaseInsensitivePathRec(
path,
strings.ToLower(path),
make([]byte, 0, len(path)+1), // preallocate enough memory for new path
[4]byte{}, // empty rune buffer
fixTrailingSlash,
)
}
// shift bytes in array by n bytes left
func shiftNRuneBytes(rb [4]byte, n int) [4]byte {
switch n {
case 0:
return rb
case 1:
return [4]byte{rb[1], rb[2], rb[3], 0}
case 2:
return [4]byte{rb[2], rb[3]}
case 3:
return [4]byte{rb[3]}
default:
return [4]byte{}
}
}
// recursive case-insensitive lookup function used by n.findCaseInsensitivePath
func (n *node) findCaseInsensitivePathRec(path, loPath string, ciPath []byte, rb [4]byte, fixTrailingSlash bool) ([]byte, bool) {
loNPath := strings.ToLower(n.path)
walk: // outer loop for walking the tree
for len(loPath) >= len(loNPath) && (len(loNPath) == 0 || loPath[1:len(loNPath)] == loNPath[1:]) {
// add common path to result
ciPath = append(ciPath, n.path...)
if path = path[len(n.path):]; len(path) > 0 {
loOld := loPath
loPath = loPath[len(loNPath):]
// If this node does not have a wildcard (param or catchAll) child,
// we can just look up the next child node and continue to walk down
// the tree
if !n.wildChild {
// skip rune bytes already processed
rb = shiftNRuneBytes(rb, len(loNPath))
if rb[0] != 0 {
// old rune not finished
for i := 0; i < len(n.indices); i++ {
if n.indices[i] == rb[0] {
// continue with child node
n = n.children[i]
loNPath = strings.ToLower(n.path)
continue walk
}
}
} else {
// process a new rune
var rv rune
// find rune start
// runes are up to 4 byte long,
// -4 would definitely be another rune
var off int
for max := min(len(loNPath), 3); off < max; off++ {
if i := len(loNPath) - off; utf8.RuneStart(loOld[i]) {
// read rune from cached lowercase path
rv, _ = utf8.DecodeRuneInString(loOld[i:])
break
}
}
// calculate lowercase bytes of current rune
utf8.EncodeRune(rb[:], rv)
// skipp already processed bytes
rb = shiftNRuneBytes(rb, off)
for i := 0; i < len(n.indices); i++ {
// lowercase matches
if n.indices[i] == rb[0] {
// must use a recursive approach since both the
// uppercase byte and the lowercase byte might exist
// as an index
if out, found := n.children[i].findCaseInsensitivePathRec(
path, loPath, ciPath, rb, fixTrailingSlash,
); found {
return out, true
}
break
}
}
// same for uppercase rune, if it differs
if up := unicode.ToUpper(rv); up != rv {
utf8.EncodeRune(rb[:], up)
rb = shiftNRuneBytes(rb, off)
for i := 0; i < len(n.indices); i++ {
// uppercase matches
if n.indices[i] == rb[0] {
// continue with child node
n = n.children[i]
loNPath = strings.ToLower(n.path)
continue walk
}
}
}
}
// Nothing found. We can recommend to redirect to the same URL
// without a trailing slash if a leaf exists for that path
return ciPath, (fixTrailingSlash && path == "/" && n.handle != nil)
}
n = n.children[0]
switch n.nType {
case param:
// find param end (either '/' or path end)
k := 0
for k < len(path) && path[k] != '/' {
k++
}
// add param value to case insensitive path
ciPath = append(ciPath, path[:k]...)
// we need to go deeper!
if k < len(path) {
if len(n.children) > 0 {
// continue with child node
n = n.children[0]
loNPath = strings.ToLower(n.path)
loPath = loPath[k:]
path = path[k:]
continue
}
// ... but we can't
if fixTrailingSlash && len(path) == k+1 {
return ciPath, true
}
return ciPath, false
}
if n.handle != nil {
return ciPath, true
} else if fixTrailingSlash && len(n.children) == 1 {
// No handle found. Check if a handle for this path + a
// trailing slash exists
n = n.children[0]
if n.path == "/" && n.handle != nil {
return append(ciPath, '/'), true
}
}
return ciPath, false
case catchAll:
return append(ciPath, path...), true
default:
panic("invalid node type")
}
} else {
// We should have reached the node containing the handle.
// Check if this node has a handle registered.
if n.handle != nil {
return ciPath, true
}
// No handle found.
// Try to fix the path by adding a trailing slash
if fixTrailingSlash {
for i := 0; i < len(n.indices); i++ {
if n.indices[i] == '/' {
n = n.children[i]
if (len(n.path) == 1 && n.handle != nil) ||
(n.nType == catchAll && n.children[0].handle != nil) {
return append(ciPath, '/'), true
}
return ciPath, false
}
}
}
return ciPath, false
}
}
// Nothing found.
// Try to fix the path by adding / removing a trailing slash
if fixTrailingSlash {
if path == "/" {
return ciPath, true
}
if len(loPath)+1 == len(loNPath) && loNPath[len(loPath)] == '/' &&
loPath[1:] == loNPath[1:len(loPath)] && n.handle != nil {
return append(ciPath, n.path...), true
}
}
return ciPath, false
}

View File

@@ -4,7 +4,6 @@ import (
log "github.com/Sirupsen/logrus"
"github.com/iron-io/functions/api/config"
"github.com/iron-io/functions/api/datastore"
"github.com/iron-io/functions/api/models"
"github.com/iron-io/functions/api/runner"
"github.com/iron-io/functions/api/server"
"github.com/spf13/viper"
@@ -13,15 +12,9 @@ import (
func main() {
ctx := context.Background()
c := &models.Config{}
config.InitConfig()
err := c.Validate()
if err != nil {
log.WithError(err).Fatalln("Invalid config.")
}
ds, err := datastore.New(viper.GetString("DB"))
if err != nil {
log.WithError(err).Fatalln("Invalid DB url.")
@@ -32,6 +25,6 @@ func main() {
log.WithError(err).Fatalln("Failed to create a runner")
}
srv := server.New(c, ds, runner)
srv := server.New(ds, runner)
srv.Run(ctx)
}