nghttpx: Change mruby script handling

This commit changes nghttpx's mruby script handling. Previously we have 2 options to specify the mruby script file to be run on request and on response. Now they are merged into 1 option, namely --mruby-file. It now must return object. On request, the object's on_req(env) method is invoked with env object. Similarly, on response, the object's on_resp(env) method is invoked. The specification of Env object has not changed.
lioncfliu · Oct 8, 2015 · f1eb763 · f1eb763
1 parent c71c357
commit f1eb763
Show file tree

Hide file tree

Showing 17 changed files with 181 additions and 158 deletions.
diff --git a/gennghttpxfun.py b/gennghttpxfun.py
@@ -98,8 +98,7 @@
     "tls-ticket-key-memcached-interval",
     "tls-ticket-key-memcached-max-retry",
     "tls-ticket-key-memcached-max-fail",
-    "request-phase-file",
-    "response-phase-file",
+    "mruby-file",
     "accept-proxy-protocol",
     "conf",
     "fastopen",

diff --git a/integration-tests/nghttpx_http1_test.go b/integration-tests/nghttpx_http1_test.go
@@ -360,7 +360,7 @@ func TestH1H1Websocket(t *testing.T) {
 // TestH1H1ReqPhaseSetHeader tests mruby request phase hook
 // modifies request header fields.
 func TestH1H1ReqPhaseSetHeader(t *testing.T) {
-	st := newServerTester([]string{"--request-phase-file=" + testDir + "/req-set-header.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/req-set-header.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		if got, want := r.Header.Get("User-Agent"), "mruby"; got != want {
 			t.Errorf("User-Agent = %v; want %v", got, want)
 		}
@@ -382,7 +382,7 @@ func TestH1H1ReqPhaseSetHeader(t *testing.T) {
 // TestH1H1ReqPhaseReturn tests mruby request phase hook returns
 // custom response.
 func TestH1H1ReqPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--request-phase-file=" + testDir + "/return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/req-return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		t.Fatalf("request should not be forwarded")
 	})
 	defer st.Close()
@@ -401,7 +401,7 @@ func TestH1H1ReqPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "20"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -410,15 +410,15 @@ func TestH1H1ReqPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from req"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
 
 // TestH1H1RespPhaseSetHeader tests mruby response phase hook modifies
 // response header fields.
 func TestH1H1RespPhaseSetHeader(t *testing.T) {
-	st := newServerTester([]string{"--response-phase-file=" + testDir + "/resp-set-header.rb"}, t, noopHandler)
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/resp-set-header.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.http1(requestParam{
@@ -440,7 +440,7 @@ func TestH1H1RespPhaseSetHeader(t *testing.T) {
 // TestH1H1RespPhaseReturn tests mruby response phase hook returns
 // custom response.
 func TestH1H1RespPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--response-phase-file=" + testDir + "/return.rb"}, t, noopHandler)
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/resp-return.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.http1(requestParam{
@@ -457,7 +457,7 @@ func TestH1H1RespPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "21"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -466,7 +466,7 @@ func TestH1H1RespPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from resp"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
@@ -667,7 +667,7 @@ func TestH1H2NoVia(t *testing.T) {
 // TestH1H2ReqPhaseReturn tests mruby request phase hook returns
 // custom response.
 func TestH1H2ReqPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--http2-bridge", "--request-phase-file=" + testDir + "/return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTester([]string{"--http2-bridge", "--mruby-file=" + testDir + "/req-return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		t.Fatalf("request should not be forwarded")
 	})
 	defer st.Close()
@@ -686,7 +686,7 @@ func TestH1H2ReqPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "20"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -695,15 +695,15 @@ func TestH1H2ReqPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from req"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
 
 // TestH1H2RespPhaseReturn tests mruby response phase hook returns
 // custom response.
 func TestH1H2RespPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--http2-bridge", "--response-phase-file=" + testDir + "/return.rb"}, t, noopHandler)
+	st := newServerTester([]string{"--http2-bridge", "--mruby-file=" + testDir + "/resp-return.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.http1(requestParam{
@@ -720,7 +720,7 @@ func TestH1H2RespPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "21"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -729,7 +729,7 @@ func TestH1H2RespPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from resp"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
diff --git a/integration-tests/nghttpx_http2_test.go b/integration-tests/nghttpx_http2_test.go
@@ -644,7 +644,7 @@ func TestH2H1HeaderFields(t *testing.T) {
 // TestH2H1ReqPhaseSetHeader tests mruby request phase hook
 // modifies request header fields.
 func TestH2H1ReqPhaseSetHeader(t *testing.T) {
-	st := newServerTester([]string{"--request-phase-file=" + testDir + "/req-set-header.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/req-set-header.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		if got, want := r.Header.Get("User-Agent"), "mruby"; got != want {
 			t.Errorf("User-Agent = %v; want %v", got, want)
 		}
@@ -666,7 +666,7 @@ func TestH2H1ReqPhaseSetHeader(t *testing.T) {
 // TestH2H1ReqPhaseReturn tests mruby request phase hook returns
 // custom response.
 func TestH2H1ReqPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--request-phase-file=" + testDir + "/return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/req-return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		t.Fatalf("request should not be forwarded")
 	})
 	defer st.Close()
@@ -685,7 +685,7 @@ func TestH2H1ReqPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "20"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -694,15 +694,15 @@ func TestH2H1ReqPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from req"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
 
 // TestH2H1RespPhaseSetHeader tests mruby response phase hook modifies
 // response header fields.
 func TestH2H1RespPhaseSetHeader(t *testing.T) {
-	st := newServerTester([]string{"--response-phase-file=" + testDir + "/resp-set-header.rb"}, t, noopHandler)
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/resp-set-header.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.http2(requestParam{
@@ -724,7 +724,7 @@ func TestH2H1RespPhaseSetHeader(t *testing.T) {
 // TestH2H1RespPhaseReturn tests mruby response phase hook returns
 // custom response.
 func TestH2H1RespPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--response-phase-file=" + testDir + "/return.rb"}, t, noopHandler)
+	st := newServerTester([]string{"--mruby-file=" + testDir + "/resp-return.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.http2(requestParam{
@@ -741,7 +741,7 @@ func TestH2H1RespPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "21"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -750,7 +750,7 @@ func TestH2H1RespPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from resp"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
@@ -1351,7 +1351,7 @@ func TestH2H2TLSXfp(t *testing.T) {
 // TestH2H2ReqPhaseReturn tests mruby request phase hook returns
 // custom response.
 func TestH2H2ReqPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--http2-bridge", "--request-phase-file=" + testDir + "/return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTester([]string{"--http2-bridge", "--mruby-file=" + testDir + "/req-return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		t.Fatalf("request should not be forwarded")
 	})
 	defer st.Close()
@@ -1370,7 +1370,7 @@ func TestH2H2ReqPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "20"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -1379,15 +1379,15 @@ func TestH2H2ReqPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from req"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
 
 // TestH2H2RespPhaseReturn tests mruby response phase hook returns
 // custom response.
 func TestH2H2RespPhaseReturn(t *testing.T) {
-	st := newServerTester([]string{"--http2-bridge", "--response-phase-file=" + testDir + "/return.rb"}, t, noopHandler)
+	st := newServerTester([]string{"--http2-bridge", "--mruby-file=" + testDir + "/resp-return.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.http2(requestParam{
@@ -1404,7 +1404,7 @@ func TestH2H2RespPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "21"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -1413,7 +1413,7 @@ func TestH2H2RespPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from resp"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
diff --git a/integration-tests/nghttpx_spdy_test.go b/integration-tests/nghttpx_spdy_test.go
@@ -233,7 +233,7 @@ func TestS3H1InvalidMethod(t *testing.T) {
 // TestS3H1ReqPhaseSetHeader tests mruby request phase hook
 // modifies request header fields.
 func TestS3H1ReqPhaseSetHeader(t *testing.T) {
-	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--request-phase-file=" + testDir + "/req-set-header.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--mruby-file=" + testDir + "/req-set-header.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		if got, want := r.Header.Get("User-Agent"), "mruby"; got != want {
 			t.Errorf("User-Agent = %v; want %v", got, want)
 		}
@@ -255,7 +255,7 @@ func TestS3H1ReqPhaseSetHeader(t *testing.T) {
 // TestS3H1ReqPhaseReturn tests mruby request phase hook returns
 // custom response.
 func TestS3H1ReqPhaseReturn(t *testing.T) {
-	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--request-phase-file=" + testDir + "/return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--mruby-file=" + testDir + "/req-return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		t.Fatalf("request should not be forwarded")
 	})
 	defer st.Close()
@@ -274,7 +274,7 @@ func TestS3H1ReqPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "20"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -283,15 +283,15 @@ func TestS3H1ReqPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from req"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
 
 // TestS3H1RespPhaseSetHeader tests mruby response phase hook modifies
 // response header fields.
 func TestS3H1RespPhaseSetHeader(t *testing.T) {
-	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--response-phase-file=" + testDir + "/resp-set-header.rb"}, t, noopHandler)
+	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--mruby-file=" + testDir + "/resp-set-header.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.spdy(requestParam{
@@ -313,7 +313,7 @@ func TestS3H1RespPhaseSetHeader(t *testing.T) {
 // TestS3H1RespPhaseReturn tests mruby response phase hook returns
 // custom response.
 func TestS3H1RespPhaseReturn(t *testing.T) {
-	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--response-phase-file=" + testDir + "/return.rb"}, t, noopHandler)
+	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--mruby-file=" + testDir + "/resp-return.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.spdy(requestParam{
@@ -330,7 +330,7 @@ func TestS3H1RespPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "21"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -339,7 +339,7 @@ func TestS3H1RespPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from resp"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
@@ -368,7 +368,7 @@ func TestS3H2ConnectFailure(t *testing.T) {
 // TestS3H2ReqPhaseReturn tests mruby request phase hook returns
 // custom response.
 func TestS3H2ReqPhaseReturn(t *testing.T) {
-	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--http2-bridge", "--request-phase-file=" + testDir + "/return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
+	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--http2-bridge", "--mruby-file=" + testDir + "/req-return.rb"}, t, func(w http.ResponseWriter, r *http.Request) {
 		t.Fatalf("request should not be forwarded")
 	})
 	defer st.Close()
@@ -387,7 +387,7 @@ func TestS3H2ReqPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "20"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -396,15 +396,15 @@ func TestS3H2ReqPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from req"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }
 
 // TestS3H2RespPhaseReturn tests mruby response phase hook returns
 // custom response.
 func TestS3H2RespPhaseReturn(t *testing.T) {
-	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--http2-bridge", "--response-phase-file=" + testDir + "/return.rb"}, t, noopHandler)
+	st := newServerTesterTLS([]string{"--npn-list=spdy/3.1", "--http2-bridge", "--mruby-file=" + testDir + "/resp-return.rb"}, t, noopHandler)
 	defer st.Close()
 
 	res, err := st.spdy(requestParam{
@@ -421,7 +421,7 @@ func TestS3H2RespPhaseReturn(t *testing.T) {
 	hdtests := []struct {
 		k, v string
 	}{
-		{"content-length", "11"},
+		{"content-length", "21"},
 		{"from", "mruby"},
 	}
 	for _, tt := range hdtests {
@@ -430,7 +430,7 @@ func TestS3H2RespPhaseReturn(t *testing.T) {
 		}
 	}
 
-	if got, want := string(res.body), "Hello World"; got != want {
+	if got, want := string(res.body), "Hello World from resp"; got != want {
 		t.Errorf("body = %v; want %v", got, want)
 	}
 }