Merge pull request #34 from uber/improved-status-code

Cleanup usage of status code thrift annotation
uber · Apr 3, 2017 · 1bbe2ba · 1bbe2ba
2 parents 3db4e6d + 58f9a38
commit 1bbe2ba
Show file tree

Hide file tree

Showing 33 changed files with 101 additions and 111 deletions.
diff --git a/codegen/method.go b/codegen/method.go
@@ -47,7 +47,7 @@ type MethodSpec struct {
 	Headers             []string
 	RequestType         string
 	ResponseType        string
-	OKStatusCode        []StatusCode
+	OKStatusCode        StatusCode
 	ExceptionStatusCode []StatusCode
 	// Additional struct generated from the bundle of request args.
 	RequestBoxed  bool
@@ -155,15 +155,18 @@ func (ms *MethodSpec) setOKStatusCode(statusCode string) error {
 	if statusCode == "" {
 		return errors.Errorf("no http OK status code set by annotation '%s' ", antHTTPStatus)
 	}
-	scode := strings.Split(statusCode, ",")
-	ms.OKStatusCode = make([]StatusCode, len(scode))
-	var err error
-	for i, c := range scode {
-		ms.OKStatusCode[i].Code, err = strconv.Atoi(c)
-		if err != nil {
-			return errors.Wrapf(err, "failed to parse the annotation %s for ok response status")
-		}
+
+	code, err := strconv.Atoi(statusCode)
+	if err != nil {
+		return errors.Wrapf(err,
+			"Could not parse status code annotation (%s) for ok response",
+			statusCode,
+		)
 	}
+	ms.OKStatusCode = StatusCode{
+		Code: code,
+	}
+
 	return nil
 }
 

diff --git a/codegen/template.go b/codegen/template.go
@@ -30,7 +30,6 @@ import (
 	"path/filepath"
 	"regexp"
 	"sort"
-	"strconv"
 	"strings"
 	tmpl "text/template"
 
@@ -100,7 +99,6 @@ var funcMap = tmpl.FuncMap{
 	"title":        strings.Title,
 	"Title":        strings.Title,
 	"fullTypeName": fullTypeName,
-	"statusCodes":  statusCodes,
 	"camel":        camelCase,
 	"split":        strings.Split,
 	"dec":          decrement,
@@ -116,22 +114,6 @@ func fullTypeName(typeName, packageName string) string {
 	return packageName + "." + typeName
 }
 
-func statusCodes(codes []StatusCode) string {
-	if len(codes) == 0 {
-		return "[]int{}"
-	}
-	buf := bytes.NewBufferString("[]int{")
-	for i := 0; i < len(codes)-1; i++ {
-		if _, err := buf.WriteString(strconv.Itoa(codes[i].Code) + ","); err != nil {
-			return err.Error()
-		}
-	}
-	if _, err := buf.WriteString(strconv.Itoa(codes[len(codes)-1].Code) + "}"); err != nil {
-		return err.Error()
-	}
-	return string(buf.Bytes())
-}
-
 func camelCase(src string) string {
 	byteSrc := []byte(src)
 	chunks := camelingRegex.FindAll(byteSrc, -1)

diff --git a/codegen/templates/endpoint.tmpl b/codegen/templates/endpoint.tmpl
@@ -71,13 +71,14 @@ func Handle{{title .Name}}Request(
     }()
 
 	// Handle client respnse.
-	if !res.IsOKResponse(clientResp.StatusCode, {{statusCodes .OKStatusCode}}) {
+	expectedStatusCode := []int{ {{.DownstreamMethod.OKStatusCode.Code}} }
+	if !res.IsOKResponse(clientResp.StatusCode, expectedStatusCode) {
 		req.Logger.Warn("Unknown response status code",
 			zap.Int("status code", clientResp.StatusCode),
 		)
 	}
 	{{if or (eq $clientMethodResponseType "") (eq .ResponseType "") -}}
-	res.WriteJSONBytes(clientResp.StatusCode, nil)
+	res.WriteJSONBytes({{.OKStatusCode.Code}}, nil)
 	{{- else -}}
 	b, err := ioutil.ReadAll(clientResp.Body)
 	if err != nil {
@@ -90,7 +91,7 @@ func Handle{{title .Name}}Request(
 	 	return
 	}
 	response := convert{{title .Name}}ClientResponse(&clientRespBody)
-	res.WriteJSON(clientResp.StatusCode, response)
+	res.WriteJSON({{.OKStatusCode.Code}}, response)
 	{{- end -}}
 }
 

diff --git a/codegen/templates/endpoint_test.tmpl b/codegen/templates/endpoint_test.tmpl
@@ -44,7 +44,7 @@ func Test{{.HandlerID | Title}}{{.TestName | Title}}OKResponse(t *testing.T) {
 
 	{{range .ClientStubs}}
 	fake{{.ClientMethod | Title}} := func(w http.ResponseWriter, r *http.Request) {
-		w.WriteHeader({{(index $.Method.OKStatusCode 0).Code}})
+		w.WriteHeader({{$.Method.OKStatusCode.Code}})
 		// TODO(zw): generate client response.
 		if _, err := w.Write([]byte( `{{.ClientResponseString}}`)); err != nil {
 			t.Fatal("can't write fake response")
@@ -75,7 +75,7 @@ func Test{{.HandlerID | Title}}{{.TestName | Title}}OKResponse(t *testing.T) {
 		return
 	}
 
-	assert.Equal(t, "{{(index $.Method.OKStatusCode 0).Code}} OK", res.Status)
+	assert.Equal(t, {{$.Method.OKStatusCode.Code}}, res.StatusCode)
 	assert.Equal(t, 1, counter)
 }
 

diff --git a/codegen/test_data/bar.json b/codegen/test_data/bar.json
@@ -32,12 +32,10 @@
 					"Headers": null,
 					"RequestType": "ArgNotStructHTTPRequest",
 					"ResponseType": "",
-					"OKStatusCode": [
-						{
-							"Code": 200,
-							"Message": ""
-						}
-					],
+					"OKStatusCode": {
+						"Code": 200,
+						"Message": ""
+					},
 					"ExceptionStatusCode": [
 						{
 							"Code": 403,
@@ -79,12 +77,10 @@
 					"Headers": null,
 					"RequestType": "",
 					"ResponseType": "bar.BarResponse",
-					"OKStatusCode": [
-						{
-							"Code": 200,
-							"Message": ""
-						}
-					],
+					"OKStatusCode": {
+						"Code": 200,
+						"Message": ""
+					},
 					"ExceptionStatusCode": [
 						{
 							"Code": 403,
@@ -120,12 +116,10 @@
 					"Headers": null,
 					"RequestType": "",
 					"ResponseType": "bar.BarResponse",
-					"OKStatusCode": [
-						{
-							"Code": 200,
-							"Message": ""
-						}
-					],
+					"OKStatusCode": {
+						"Code": 200,
+						"Message": ""
+					},
 					"ExceptionStatusCode": [
 						{
 							"Code": 403,
@@ -161,12 +155,10 @@
 					"Headers": null,
 					"RequestType": "NormalHTTPRequest",
 					"ResponseType": "bar.BarResponse",
-					"OKStatusCode": [
-						{
-							"Code": 200,
-							"Message": ""
-						}
-					],
+					"OKStatusCode": {
+						"Code": 200,
+						"Message": ""
+					},
 					"ExceptionStatusCode": [
 						{
 							"Code": 403,
@@ -211,12 +203,10 @@
 					],
 					"RequestType": "TooManyArgsHTTPRequest",
 					"ResponseType": "bar.BarResponse",
-					"OKStatusCode": [
-						{
-							"Code": 200,
-							"Message": ""
-						}
-					],
+					"OKStatusCode": {
+						"Code": 200,
+						"Message": ""
+					},
 					"ExceptionStatusCode": [
 						{
 							"Code": 403,

diff --git a/codegen/test_data/endpoint_tests/bar_bar_method_argnotstruct_test.gogen b/codegen/test_data/endpoint_tests/bar_bar_method_argnotstruct_test.gogen
@@ -52,6 +52,6 @@ func TestArgNotStructSuccessfulRequestOKResponse(t *testing.T) {
 		return
 	}
 
-	assert.Equal(t, "200 OK", res.Status)
+	assert.Equal(t, 200, res.StatusCode)
 	assert.Equal(t, 1, counter)
 }
diff --git a/codegen/test_data/endpoint_tests/bar_bar_method_missingarg_test.gogen b/codegen/test_data/endpoint_tests/bar_bar_method_missingarg_test.gogen
@@ -52,6 +52,6 @@ func TestMissingArgSuccessfulRequestOKResponse(t *testing.T) {
 		return
 	}
 
-	assert.Equal(t, "200 OK", res.Status)
+	assert.Equal(t, 200, res.StatusCode)
 	assert.Equal(t, 1, counter)
 }
diff --git a/codegen/test_data/endpoint_tests/bar_bar_method_norequest_test.gogen b/codegen/test_data/endpoint_tests/bar_bar_method_norequest_test.gogen
@@ -52,6 +52,6 @@ func TestNoRequestSuccessfulRequestOKResponse(t *testing.T) {
 		return
 	}
 
-	assert.Equal(t, "200 OK", res.Status)
+	assert.Equal(t, 200, res.StatusCode)
 	assert.Equal(t, 1, counter)
 }
diff --git a/codegen/test_data/endpoint_tests/bar_bar_method_normal_test.gogen b/codegen/test_data/endpoint_tests/bar_bar_method_normal_test.gogen
@@ -52,6 +52,6 @@ func TestNormalSuccessfulRequestOKResponse(t *testing.T) {
 		return
 	}
 
-	assert.Equal(t, "200 OK", res.Status)
+	assert.Equal(t, 200, res.StatusCode)
 	assert.Equal(t, 1, counter)
 }
diff --git a/codegen/test_data/endpoint_tests/bar_bar_method_toomanyargs_test.gogen b/codegen/test_data/endpoint_tests/bar_bar_method_toomanyargs_test.gogen
@@ -54,6 +54,6 @@ func TestTooManyArgsSuccessfulRequestOKResponse(t *testing.T) {
 		return
 	}
 
-	assert.Equal(t, "200 OK", res.Status)
+	assert.Equal(t, 200, res.StatusCode)
 	assert.Equal(t, 1, counter)
 }
diff --git a/codegen/test_data/endpoints/bar_bar_method_argnotstruct.gogen b/codegen/test_data/endpoints/bar_bar_method_argnotstruct.gogen
@@ -44,12 +44,13 @@ func HandleArgNotStructRequest(
 	}()
 
 	// Handle client respnse.
-	if !res.IsOKResponse(clientResp.StatusCode, []int{200}) {
+	expectedStatusCode := []int{200}
+	if !res.IsOKResponse(clientResp.StatusCode, expectedStatusCode) {
 		req.Logger.Warn("Unknown response status code",
 			zap.Int("status code", clientResp.StatusCode),
 		)
 	}
-	res.WriteJSONBytes(clientResp.StatusCode, nil)
+	res.WriteJSONBytes(200, nil)
 }
 
 func convertToArgNotStructClientRequest(body *ArgNotStructHTTPRequest) *barClient.ArgNotStructHTTPRequest {

diff --git a/codegen/test_data/endpoints/bar_bar_method_missingarg.gogen b/codegen/test_data/endpoints/bar_bar_method_missingarg.gogen
@@ -40,7 +40,8 @@ func HandleMissingArgRequest(
 	}()
 
 	// Handle client respnse.
-	if !res.IsOKResponse(clientResp.StatusCode, []int{200}) {
+	expectedStatusCode := []int{200}
+	if !res.IsOKResponse(clientResp.StatusCode, expectedStatusCode) {
 		req.Logger.Warn("Unknown response status code",
 			zap.Int("status code", clientResp.StatusCode),
 		)
@@ -56,7 +57,7 @@ func HandleMissingArgRequest(
 		return
 	}
 	response := convertMissingArgClientResponse(&clientRespBody)
-	res.WriteJSON(clientResp.StatusCode, response)
+	res.WriteJSON(200, response)
 }
 
 func convertMissingArgClientResponse(body *bar.BarResponse) *bar.BarResponse {

diff --git a/codegen/test_data/endpoints/bar_bar_method_norequest.gogen b/codegen/test_data/endpoints/bar_bar_method_norequest.gogen
@@ -40,7 +40,8 @@ func HandleNoRequestRequest(
 	}()
 
 	// Handle client respnse.
-	if !res.IsOKResponse(clientResp.StatusCode, []int{200}) {
+	expectedStatusCode := []int{200}
+	if !res.IsOKResponse(clientResp.StatusCode, expectedStatusCode) {
 		req.Logger.Warn("Unknown response status code",
 			zap.Int("status code", clientResp.StatusCode),
 		)
@@ -56,7 +57,7 @@ func HandleNoRequestRequest(
 		return
 	}
 	response := convertNoRequestClientResponse(&clientRespBody)
-	res.WriteJSON(clientResp.StatusCode, response)
+	res.WriteJSON(200, response)
 }
 
 func convertNoRequestClientResponse(body *bar.BarResponse) *bar.BarResponse {

diff --git a/codegen/test_data/endpoints/bar_bar_method_normal.gogen b/codegen/test_data/endpoints/bar_bar_method_normal.gogen
@@ -48,7 +48,8 @@ func HandleNormalRequest(
 	}()
 
 	// Handle client respnse.
-	if !res.IsOKResponse(clientResp.StatusCode, []int{200}) {
+	expectedStatusCode := []int{200}
+	if !res.IsOKResponse(clientResp.StatusCode, expectedStatusCode) {
 		req.Logger.Warn("Unknown response status code",
 			zap.Int("status code", clientResp.StatusCode),
 		)
@@ -64,7 +65,7 @@ func HandleNormalRequest(
 		return
 	}
 	response := convertNormalClientResponse(&clientRespBody)
-	res.WriteJSON(clientResp.StatusCode, response)
+	res.WriteJSON(200, response)
 }
 
 func convertToNormalClientRequest(body *NormalHTTPRequest) *barClient.NormalHTTPRequest {

diff --git a/codegen/test_data/endpoints/bar_bar_method_toomanyargs.gogen b/codegen/test_data/endpoints/bar_bar_method_toomanyargs.gogen
@@ -52,7 +52,8 @@ func HandleTooManyArgsRequest(
 	}()
 
 	// Handle client respnse.
-	if !res.IsOKResponse(clientResp.StatusCode, []int{200}) {
+	expectedStatusCode := []int{200}
+	if !res.IsOKResponse(clientResp.StatusCode, expectedStatusCode) {
 		req.Logger.Warn("Unknown response status code",
 			zap.Int("status code", clientResp.StatusCode),
 		)
@@ -68,7 +69,7 @@ func HandleTooManyArgsRequest(
 		return
 	}
 	response := convertTooManyArgsClientResponse(&clientRespBody)
-	res.WriteJSON(clientResp.StatusCode, response)
+	res.WriteJSON(200, response)
 }
 
 func convertToTooManyArgsClientRequest(body *TooManyArgsHTTPRequest) *barClient.TooManyArgsHTTPRequest {

diff --git a/examples/example-gateway/build/endpoints/bar/bar_bar_method_argnotstruct.go b/examples/example-gateway/build/endpoints/bar/bar_bar_method_argnotstruct.go
diff --git a/examples/example-gateway/build/endpoints/bar/bar_bar_method_argnotstruct_test.go b/examples/example-gateway/build/endpoints/bar/bar_bar_method_argnotstruct_test.go
diff --git a/examples/example-gateway/build/endpoints/bar/bar_bar_method_missingarg.go b/examples/example-gateway/build/endpoints/bar/bar_bar_method_missingarg.go
diff --git a/examples/example-gateway/build/endpoints/bar/bar_bar_method_missingarg_test.go b/examples/example-gateway/build/endpoints/bar/bar_bar_method_missingarg_test.go