Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a header to mark when a response is from openfaas #71

Merged
merged 2 commits into from
Aug 8, 2023
Merged

Add a header to mark when a response is from openfaas #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ad7bdb
Add a header to mark when a response is from openfaas
alexellis Aug 8, 2023
59a6101
Modify to uppercase for X-OpenFaaS-Internal
alexellis Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion proxy/handler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ func (tr *testBaseURLResolver) Resolve(name string) (url.URL, error) {
Host: tr.testServerBase,
}, nil
}

func Test_NewHandlerFunc_Panic(t *testing.T) {
defer func() {
if r := recover(); r == nil {
Expand Down Expand Up @@ -126,6 +127,12 @@ func Test_ProxyHandler_ResolveError(t *testing.T) {
if !strings.Contains(logs.String(), resolveErr.Error()) {
t.Errorf("expected logs to contain `%s`", resolveErr.Error())
}

internalErrorHeader := w.Header().Get("X-OpenFaaS-Internal")
wantHeaderValue := "proxy"
if internalErrorHeader != wantHeaderValue {
t.Errorf("expected X-OpenFaaS-Internal header to be %s, got %s", wantHeaderValue, internalErrorHeader)
}
}

func Test_ProxyHandler_Proxy_Success(t *testing.T) {
Expand Down Expand Up @@ -160,8 +167,48 @@ func Test_ProxyHandler_Proxy_Success(t *testing.T) {
proxyFunc(w, req)
resp := w.Result()
if resp.StatusCode != http.StatusNoContent {
t.Errorf("expected status code `%d`, got `%d`", http.StatusNoContent, resp.StatusCode)
t.Fatalf("expected status code `%d`, got `%d`", http.StatusNoContent, resp.StatusCode)
}

if v := resp.Header.Get("X-OpenFaaS-Internal"); v != "" {
t.Fatalf("expected X-OpenFaaS-Internal header to be empty, got %q", v)
}

})
}
}

func Test_ProxyHandler_Proxy_FailsMidFlight(t *testing.T) {
var svr *httptest.Server

testHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

svr.Close()
// w.WriteHeader(http.StatusOK)
})
svr = httptest.NewServer(testHandler)

config := types.FaaSConfig{
ReadTimeout: 100 * time.Millisecond,
WriteTimeout: 100 * time.Millisecond,
}

serverURL := strings.TrimPrefix(svr.URL, "http://")
proxyFunc := NewHandlerFunc(config, &testBaseURLResolver{serverURL, nil})

w := httptest.NewRecorder()

req := httptest.NewRequest(http.MethodPost, "http://example.com/foo", nil)
req = mux.SetURLVars(req, map[string]string{"name": "foo"})

proxyFunc(w, req)
resp := w.Result()
wantCode := http.StatusInternalServerError
if resp.StatusCode != wantCode {
t.Fatalf("want status code `%d`, got `%d`", wantCode, resp.StatusCode)
}

if v := resp.Header.Get("X-OpenFaaS-Internal"); v != "proxy" {
t.Errorf("expected X-OpenFaaS-Internal header to be `proxy`, got %s", v)
}
}
15 changes: 12 additions & 3 deletions proxy/proxy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,20 +137,27 @@ func proxyRequest(w http.ResponseWriter, originalReq *http.Request, proxyClient
pathVars := mux.Vars(originalReq)
functionName := pathVars["name"]
if functionName == "" {
w.Header().Add("X-OpenFaaS-Internal", "proxy")

httputil.Errorf(w, http.StatusBadRequest, "Provide function name in the request path")
return
}

functionAddr, resolveErr := resolver.Resolve(functionName)
if resolveErr != nil {
functionAddr, err := resolver.Resolve(functionName)
if err != nil {
w.Header().Add("X-OpenFaaS-Internal", "proxy")

// TODO: Should record the 404/not found error in Prometheus.
log.Printf("resolver error: no endpoints for %s: %s\n", functionName, resolveErr.Error())
log.Printf("resolver error: no endpoints for %s: %s\n", functionName, err.Error())
httputil.Errorf(w, http.StatusServiceUnavailable, "No endpoints available for: %s.", functionName)
return
}

proxyReq, err := buildProxyRequest(originalReq, functionAddr, pathVars["params"])
if err != nil {

w.Header().Add("X-OpenFaaS-Internal", "proxy")

httputil.Errorf(w, http.StatusInternalServerError, "Failed to resolve service: %s.", functionName)
return
}
Expand All @@ -166,6 +173,8 @@ func proxyRequest(w http.ResponseWriter, originalReq *http.Request, proxyClient
if err != nil {
log.Printf("error with proxy request to: %s, %s\n", proxyReq.URL.String(), err.Error())

w.Header().Add("X-OpenFaaS-Internal", "proxy")

httputil.Errorf(w, http.StatusInternalServerError, "Can't reach service for: %s.", functionName)
return
}
Expand Down
10 changes: 5 additions & 5 deletions proxy/proxy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package proxy
import (
"bytes"
"fmt"
"io/ioutil"
"io"
"net/http"
"net/http/httptest"
"net/url"
Expand Down Expand Up @@ -186,7 +186,7 @@ func Test_buildProxyRequest_Body_Method_Query(t *testing.T) {
t.Fail()
}

upstreamBytes, _ := ioutil.ReadAll(upstream.Body)
upstreamBytes, _ := io.ReadAll(upstream.Body)

if string(upstreamBytes) != string(srcBytes) {
t.Errorf("Body - want: %s, got: %s", string(upstreamBytes), string(srcBytes))
Expand Down Expand Up @@ -357,7 +357,7 @@ func Test_buildProxyRequest_WithPathNoQuery(t *testing.T) {
t.Fail()
}

upstreamBytes, _ := ioutil.ReadAll(upstream.Body)
upstreamBytes, _ := io.ReadAll(upstream.Body)

if string(upstreamBytes) != string(srcBytes) {
t.Errorf("Body - want: %s, got: %s", string(upstreamBytes), string(srcBytes))
Expand Down Expand Up @@ -409,7 +409,7 @@ func Test_buildProxyRequest_WithNoPathNoQuery(t *testing.T) {
t.Fail()
}

upstreamBytes, _ := ioutil.ReadAll(upstream.Body)
upstreamBytes, _ := io.ReadAll(upstream.Body)

if string(upstreamBytes) != string(srcBytes) {
t.Errorf("Body - want: %s, got: %s", string(upstreamBytes), string(srcBytes))
Expand Down Expand Up @@ -459,7 +459,7 @@ func Test_buildProxyRequest_WithPathAndQuery(t *testing.T) {
t.Fail()
}

upstreamBytes, _ := ioutil.ReadAll(upstream.Body)
upstreamBytes, _ := io.ReadAll(upstream.Body)

if string(upstreamBytes) != string(srcBytes) {
t.Errorf("Body - want: %s, got: %s", string(upstreamBytes), string(srcBytes))
Expand Down