Merge pull request #3 from JSainsburyPLC/feature/redirects

Support redirects

Author: steinfletcher

README.md

@@ -44,9 +44,10 @@ See `examples/config.json`
   "type": "proxy", // Required
   "path_pattern": "^/test-ui/.*", // regex to match request path. Required
   "backend": "http://localhost:3000", // backend scheme and host to proxy to. Required
-  "rewrite": { // optional rewrite rules
-    "/test-ui/(.*)": "/$1"
-  }
+  "rewrite": [{ // rewrite rules. Optional
+    "path_pattern": "/test-ui/(.*)",
+    "to": "/$1",
+  }],
 }
 ```
 
@@ -76,6 +77,19 @@ See `examples/config.json`
 }
 ```
 
+### Redirect type rules
+
+```json
+{
+  "type": "redirect",
+  "path_pattern": "^/test-ui/(.*)",
+  "redirect": {
+    "to": "http://localhost:3000/$1",
+    "type": "temporary"
+  }
+}
+```
+
 ## Development
 
 ### Release

commands/start.go

@@ -2,7 +2,7 @@ package commands
 
 import (
 	"github.com/JSainsburyPLC/ui-dev-proxy/domain"
-	"github.com/JSainsburyPLC/ui-dev-proxy/http/proxy"
+	"github.com/JSainsburyPLC/ui-dev-proxy/proxy"
 	"github.com/urfave/cli"
 	"log"
 	"net/url"

domain/config.go

@@ -7,20 +7,32 @@ import (
 )
 
 const (
-	RouteTypeProxy = "proxy"
-	RouteTypeMock  = "mock"
+	RouteTypeProxy    = "proxy"
+	RouteTypeMock     = "mock"
+	RouteTypeRedirect = "redirect"
 )
 
 type Config struct {
 	Routes []Route `json:"routes"`
 }
 
 type Route struct {
-	Type        string            `json:"type"`
-	PathPattern *PathPattern      `json:"path_pattern"`
-	Backend     *Backend          `json:"backend"`
-	Mock        *Mock             `json:"mock"`
-	Rewrite     map[string]string `json:"rewrite"`
+	Type        string       `json:"type"`
+	PathPattern *PathPattern `json:"path_pattern"`
+	Backend     *Backend     `json:"backend"`
+	Mock        *Mock        `json:"mock"`
+	Rewrite     []Rewrite    `json:"rewrite"`
+	Redirect    *Redirect    `json:"redirect"`
+}
+
+type Rewrite struct {
+	PathPattern *PathPattern `json:"path_pattern"`
+	To          string       `json:"to"`
+}
+
+type Redirect struct {
+	To   string `json:"to"`
+	Type string `json:"type"` // either permanent or temporary. Defaults to permanent if not provided
 }
 
 type PathPattern struct {

domain/mocks.go

@@ -54,7 +54,7 @@ func NewMatcher() Matcher {
 	}
 }
 
-// Matches a mock against all matchers
+// Match matches a mock against all matchers
 func (m Matcher) Match(r *http.Request, mock Mock) bool {
 	found := true
 	for _, matcher := range m.matchers {

examples/config.json

@@ -25,6 +25,23 @@
           ]
         }
       }
+    },
+    {
+      "type": "proxy",
+      "path_pattern": "^/test-ui/.*",
+      "backend": "http://localhost:3000",
+      "rewrite": [{
+        "path_pattern": "/test-ui/(.*)",
+        "to": "/$1"
+      }]
+    },
+    {
+      "type": "redirect",
+      "path_pattern": "^/test-ui/(.*)",
+      "redirect": {
+        "to": "http://localhost:3000/$1",
+        "type": "temporary"
+      }
     }
   ]
 }

file/config.go

@@ -3,11 +3,13 @@ package file
 import (
 	"encoding/json"
 	"errors"
-	"github.com/JSainsburyPLC/ui-dev-proxy/domain"
+	"fmt"
 	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
+
+	"github.com/JSainsburyPLC/ui-dev-proxy/domain"
 )
 
 func ConfigProvider() domain.ConfigProvider {
@@ -30,6 +32,13 @@ func ConfigProvider() domain.ConfigProvider {
 
 		for _, r := range c.Routes {
 			if r.Type != domain.RouteTypeMock {
+				if r.Redirect != nil {
+					redirectType := r.Redirect.Type
+					if redirectType != "permanent" && redirectType != "temporary" {
+						return domain.Config{}, fmt.Errorf("invalid redirect type '%s'", redirectType)
+					}
+				}
+
 				continue
 			}
 

http/rewrite/rewrite.go

@@ -5,14 +5,14 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"github.com/JSainsburyPLC/ui-dev-proxy/domain"
-	"github.com/JSainsburyPLC/ui-dev-proxy/http/rewrite"
-
 	"log"
 	"net/http"
 	"net/http/httputil"
 	"net/url"
+	"path"
 	"time"
+
+	"github.com/JSainsburyPLC/ui-dev-proxy/domain"
 )
 
 const routeCtxKey = "route"
@@ -68,27 +68,19 @@ func director(defaultBackend *url.URL, logger *log.Logger) func(req *http.Reques
 			req.Host = defaultBackend.Host
 			return
 		}
+
 		// if route is set redirect to route backend
 		req.URL.Scheme = route.Backend.Scheme
 		req.URL.Host = route.Backend.Host
 		req.Host = route.Backend.Host
 
 		// apply any defined rewrite rules
-		for pattern, to := range route.Rewrite {
-			rule, err := rewrite.NewRule(pattern, to)
-			if err != nil {
-				logger.Println(fmt.Sprintf("error creating rewrite rule. %v", err))
-				continue
-			}
-
-			matched, err := rule.Rewrite(req)
-			if err != nil {
-				logger.Println(fmt.Sprintf("failed to rewrite request. %v", err))
-				continue
-			}
-
-			// recursive rewrites are not supported, exit on first rewrite
-			if matched {
+		for _, rule := range route.Rewrite {
+			if matches := rule.PathPattern.MatchString(path.Clean(req.URL.Path)); matches {
+				if err := rewrite(rule, req); err != nil {
+					logger.Println(fmt.Sprintf("failed to rewrite request. %v", err))
+					continue
+				}
 				break
 			}
 		}
@@ -131,6 +123,16 @@ func handler(
 			logger.Printf("directing to route backend '%s'\n", matchedRoute.Backend.Host)
 			r = r.WithContext(context.WithValue(r.Context(), routeCtxKey, matchedRoute))
 			reverseProxy.ServeHTTP(w, r)
+		case domain.RouteTypeRedirect:
+			to := replaceURL(matchedRoute.PathPattern, matchedRoute.Redirect.To, r.URL)
+			u, err := url.Parse(to)
+			if err != nil {
+				logger.Printf(err.Error())
+				w.WriteHeader(http.StatusBadGateway)
+				_, _ = w.Write([]byte("Bad gateway"))
+			}
+
+			http.Redirect(w, r, u.String(), redirectStatusCode(matchedRoute.Redirect.Type))
 		case domain.RouteTypeMock:
 			if !mocksEnabled {
 				logger.Println("directing to default backend")
@@ -150,6 +152,13 @@ func matchRoute(conf domain.Config, matcher domain.Matcher, r *http.Request, moc
 			if route.PathPattern.MatchString(r.URL.Path) {
 				return &route, nil
 			}
+		case domain.RouteTypeRedirect:
+			if route.Redirect == nil {
+				return nil, errors.New("missing redirect in config")
+			}
+			if route.PathPattern.MatchString(r.URL.Path) {
+				return &route, nil
+			}
 		case domain.RouteTypeMock:
 			if mocksEnabled {
 				if route.Mock == nil {
@@ -192,3 +201,33 @@ func addCookie(w http.ResponseWriter, cookie domain.Cookie) {
 	}
 	http.SetCookie(w, &c)
 }
+
+func rewrite(rule domain.Rewrite, req *http.Request) error {
+	to := path.Clean(replaceURL(rule.PathPattern, rule.To, req.URL))
+	u, e := url.Parse(to)
+	if e != nil {
+		return fmt.Errorf("rewritten URL is not valid. %w", e)
+	}
+
+	req.URL.Path = u.Path
+	req.URL.RawPath = u.RawPath
+	if u.RawQuery != "" {
+		req.URL.RawQuery = u.RawQuery
+	}
+
+	return nil
+}
+
+func replaceURL(pattern *domain.PathPattern, to string, u *url.URL) string {
+	uri := u.RequestURI()
+	match := pattern.FindStringSubmatchIndex(uri)
+	result := pattern.ExpandString([]byte(""), to, uri, match)
+	return string(result[:])
+}
+
+func redirectStatusCode(method string) int {
+	if method == "permanent" || method == "" {
+		return http.StatusMovedPermanently
+	}
+	return http.StatusFound
+}