package handlers import ( "context" "fmt" "io" "log" "net/http" "regexp" "strconv" "strings" "time" "github.com/openfaas/faas/gateway/metrics" "github.com/openfaas/faas/gateway/types" "github.com/prometheus/client_golang/prometheus" ) // Parse out the service name (group 1) and rest of path (group 2). var functionMatcher = regexp.MustCompile("^/?function/([^/?]+)([^?]*)") // HTTPNotifier notify about HTTP request/response type HTTPNotifier interface { Notify(method string, URL string, statusCode int, duration time.Duration) } // BaseURLResolver URL resolver for upstream requests type BaseURLResolver interface { Resolve(r *http.Request) string } // RequestURLPathTransformer Transform the incoming URL path for upstream requests type URLPathTransformer interface { Transform(r *http.Request) string } // MakeForwardingProxyHandler create a handler which forwards HTTP requests func MakeForwardingProxyHandler(proxy *types.HTTPClientReverseProxy, notifiers []HTTPNotifier, baseURLResolver BaseURLResolver, urlPathTransformer URLPathTransformer) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { baseURL := baseURLResolver.Resolve(r) requestURL := urlPathTransformer.Transform(r) start := time.Now() statusCode, err := forwardRequest(w, r, proxy.Client, baseURL, requestURL, proxy.Timeout) seconds := time.Since(start) if err != nil { log.Printf("error with upstream request to: %s, %s\n", requestURL, err.Error()) } for _, notifier := range notifiers { notifier.Notify(r.Method, requestURL, statusCode, seconds) } } } func buildUpstreamRequest(r *http.Request, baseURL string, requestURL string) *http.Request { url := baseURL + requestURL if len(r.URL.RawQuery) > 0 { url = fmt.Sprintf("%s?%s", url, r.URL.RawQuery) } upstreamReq, _ := http.NewRequest(r.Method, url, nil) if len(r.Host) > 0 { upstreamReq.Host = r.Host } copyHeaders(upstreamReq.Header, &r.Header) upstreamReq.Header["X-Forwarded-For"] = []string{r.RemoteAddr} if r.Body != nil { upstreamReq.Body = r.Body } return upstreamReq } func forwardRequest(w http.ResponseWriter, r *http.Request, proxyClient *http.Client, baseURL string, requestURL string, timeout time.Duration) (int, error) { upstreamReq := buildUpstreamRequest(r, baseURL, requestURL) if upstreamReq.Body != nil { defer upstreamReq.Body.Close() } ctx, cancel := context.WithTimeout(context.Background(), timeout) defer cancel() res, resErr := proxyClient.Do(upstreamReq.WithContext(ctx)) if resErr != nil { badStatus := http.StatusBadGateway w.WriteHeader(badStatus) return badStatus, resErr } if res.Body != nil { defer res.Body.Close() } copyHeaders(w.Header(), &res.Header) // Write status code w.WriteHeader(res.StatusCode) if res.Body != nil { // Copy the body over io.CopyBuffer(w, res.Body, nil) } return res.StatusCode, nil } func copyHeaders(destination http.Header, source *http.Header) { for k, v := range *source { vClone := make([]string, len(v)) copy(vClone, v) (destination)[k] = vClone } } // PrometheusFunctionNotifier records metrics to Prometheus type PrometheusFunctionNotifier struct { Metrics *metrics.MetricOptions } // Notify records metrics in Prometheus func (p PrometheusFunctionNotifier) Notify(method string, URL string, statusCode int, duration time.Duration) { seconds := duration.Seconds() serviceName := getServiceName(URL) p.Metrics.GatewayFunctionsHistogram. WithLabelValues(serviceName). Observe(seconds) code := strconv.Itoa(statusCode) p.Metrics.GatewayFunctionInvocation. With(prometheus.Labels{"function_name": serviceName, "code": code}). Inc() } func getServiceName(urlValue string) string { var serviceName string forward := "/function/" if strings.HasPrefix(urlValue, forward) { // With a path like `/function/xyz/rest/of/path?q=a`, the service // name we wish to locate is just the `xyz` portion. With a postive // match on the regex below, it will return a three-element slice. // The item at index `0` is the same as `urlValue`, at `1` // will be the service name we need, and at `2` the rest of the path. matcher := functionMatcher.Copy() matches := matcher.FindStringSubmatch(urlValue) if 3 == len(matches) { serviceName = matches[1] } } return strings.Trim(serviceName, "/") } // LoggingNotifier notifies a log about a request type LoggingNotifier struct { } // Notify a log about a request func (LoggingNotifier) Notify(method string, URL string, statusCode int, duration time.Duration) { log.Printf("Forwarded [%s] to %s - [%d] - %f seconds", method, URL, statusCode, duration.Seconds()) } // SingleHostBaseURLResolver resolves URLs against a single BaseURL type SingleHostBaseURLResolver struct { BaseURL string } // Resolve the base URL for a request func (s SingleHostBaseURLResolver) Resolve(r *http.Request) string { baseURL := s.BaseURL if strings.HasSuffix(baseURL, "/") { baseURL = baseURL[0 : len(baseURL)-1] } return baseURL } // FunctionAsHostBaseURLResolver resolves URLs using a function from the URL as a host type FunctionAsHostBaseURLResolver struct { FunctionSuffix string } // Resolve the base URL for a request func (f FunctionAsHostBaseURLResolver) Resolve(r *http.Request) string { svcName := getServiceName(r.URL.Path) const watchdogPort = 8080 var suffix string if len(f.FunctionSuffix) > 0 { suffix = "." + f.FunctionSuffix } return fmt.Sprintf("http://%s%s:%d", svcName, suffix, watchdogPort) } // TransparentURLPathTransformer passes the requested URL path through untouched. type TransparentURLPathTransformer struct { } // Transform returns the URL path unchanged. func (f TransparentURLPathTransformer) Transform(r *http.Request) string { return r.URL.Path } // PathTruncatingURLPathTransformer always truncated the path to "/". type PathTruncatingURLPathTransformer struct { } // Transform always return a path of "/". func (f PathTruncatingURLPathTransformer) Transform(r *http.Request) string { return "/" } // FunctionPrefixTrimmingURLPathTransformer removes the "/function/servicename/" prefix from the URL path. type FunctionPrefixTrimmingURLPathTransformer struct { } // Transform removes the "/function/servicename/" prefix from the URL path. func (f FunctionPrefixTrimmingURLPathTransformer) Transform(r *http.Request) string { ret := r.URL.Path if ret != "" { // When forwarding to a function, since the `/function/xyz` portion // of a path like `/function/xyz/rest/of/path` is only used or needed // by the Gateway, we want to trim it down to `/rest/of/path` for the // upstream request. In the following regex, in the case of a match // the r.URL.Path will be at `0`, the function name at `1` and the // rest of the path (the part we are interested in) at `2`. matcher := functionMatcher.Copy() parts := matcher.FindStringSubmatch(ret) if 3 == len(parts) { ret = parts[2] } } return ret }