fix: have a helper that returns a http Response as well (#1594)

codyoss · web-flow · commit b947c6511043 · 2024-12-09T16:33:17.000-06:00
When a rpc returns an httpBody, see https://pkg.go.dev/google.golang.org/genproto/googleapis/api/httpbody#HttpBody, we need to return a response from the helper so we can examine the headers.
diff --git a/internal/gengapic/gengapic.go b/internal/gengapic/gengapic.go
@@ -268,22 +268,28 @@ func (g *generator) genAndCommitHelpers(scopes []string) error {
 		g.imports[pbinfo.ImportSpec{Path: "google.golang.org/api/googleapi"}] = true
 		g.imports[pbinfo.ImportSpec{Path: "github.com/googleapis/gax-go/v2/internallog"}] = true
 
-		p("func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger,	body []byte, rpc string) ([]byte, error) {")
+		p("func executeHTTPRequestWithResponse(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, *http.Response, error) {")
 		p(`  logger.DebugContext(ctx, "api request", "serviceName", serviceName, "rpcName", rpc, "request", internallog.HTTPRequest(req, body))`)
 		p("  resp, err := client.Do(req)")
 		p("  if err != nil{")
-		p("    return nil, err")
+		p("    return nil, nil, err")
 		p("  }")
 		p("  defer resp.Body.Close()")
 		p("  buf, err := io.ReadAll(resp.Body)")
 		p("  if err != nil {")
-		p("    return nil, err")
+		p("    return nil, nil, err")
 		p("  }")
 		p(`  logger.DebugContext(ctx, "api response", "serviceName", serviceName, "rpcName", rpc, "response", internallog.HTTPResponse(resp, buf))`)
 		p("  if err = googleapi.CheckResponse(resp); err != nil {")
-		p("    return nil, err")
+		p("    return nil, nil, err")
 		p("  }")
-		p("  return buf, nil")
+		p("  return buf, resp, nil")
+		p("}")
+		p("")
+
+		p("func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {")
+		p("  buf, _, err := executeHTTPRequestWithResponse(ctx, client, req, logger, body, rpc)")
+		p("  return buf, err")
 		p("}")
 		p("")
 
diff --git a/internal/gengapic/genrest.go b/internal/gengapic/genrest.go
@@ -1135,7 +1135,11 @@ func (g *generator) unaryRESTCall(servName string, m *descriptorpb.MethodDescrip
 	p("  httpReq = httpReq.WithContext(ctx)")
 	p("  httpReq.Header = headers")
 	p("")
-	p("  buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, %s, %q)", logBody, m.GetName())
+	if isHTTPBodyMessage {
+		p("  buf, httpRsp, err := executeHTTPRequestWithResponse(ctx, c.httpClient, httpReq, c.logger, %s, %q)", logBody, m.GetName())
+	} else {
+		p("  buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, %s, %q)", logBody, m.GetName())
+	}
 	p("  if err != nil{")
 	p("   return err")
 	p("  }")
diff --git a/internal/gengapic/testdata/helpers_default_scope.want b/internal/gengapic/testdata/helpers_default_scope.want
@@ -21,22 +21,27 @@ func DefaultAuthScopes() []string {
 	}
 }
 
-func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger,	body []byte, rpc string) ([]byte, error) {
+func executeHTTPRequestWithResponse(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, *http.Response, error) {
 	logger.DebugContext(ctx, "api request", "serviceName", serviceName, "rpcName", rpc, "request", internallog.HTTPRequest(req, body))
 	resp, err := client.Do(req)
 	if err != nil{
-		return nil, err
+		return nil, nil, err
 	}
 	defer resp.Body.Close()
 	buf, err := io.ReadAll(resp.Body)
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
 	logger.DebugContext(ctx, "api response", "serviceName", serviceName, "rpcName", rpc, "response", internallog.HTTPResponse(resp, buf))
 	if err = googleapi.CheckResponse(resp); err != nil {
-		return nil, err
+		return nil, nil, err
 	}
-	return buf, nil
+	return buf, resp, nil
+}
+
+func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {
+	buf, _, err := executeHTTPRequestWithResponse(ctx, client, req, logger, body, rpc)
+	return buf, err
 }
 
 func executeStreamingHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) (*http.Response, error) {
diff --git a/internal/gengapic/testdata/helpers_multiple_scopes.want b/internal/gengapic/testdata/helpers_multiple_scopes.want
@@ -23,22 +23,27 @@ func DefaultAuthScopes() []string {
 	}
 }
 
-func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger,	body []byte, rpc string) ([]byte, error) {
+func executeHTTPRequestWithResponse(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, *http.Response, error) {
 	logger.DebugContext(ctx, "api request", "serviceName", serviceName, "rpcName", rpc, "request", internallog.HTTPRequest(req, body))
 	resp, err := client.Do(req)
 	if err != nil{
-		return nil, err
+		return nil, nil, err
 	}
 	defer resp.Body.Close()
 	buf, err := io.ReadAll(resp.Body)
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
 	logger.DebugContext(ctx, "api response", "serviceName", serviceName, "rpcName", rpc, "response", internallog.HTTPResponse(resp, buf))
 	if err = googleapi.CheckResponse(resp); err != nil {
-		return nil, err
+		return nil, nil, err
 	}
-	return buf, nil
+	return buf, resp, nil
+}
+
+func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {
+	buf, _, err := executeHTTPRequestWithResponse(ctx, client, req, logger, body, rpc)
+	return buf, err
 }
 
 func executeStreamingHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) (*http.Response, error) {
diff --git a/internal/gengapic/testdata/helpers_no_scopes.want b/internal/gengapic/testdata/helpers_no_scopes.want
@@ -20,22 +20,27 @@ func DefaultAuthScopes() []string {
 	}
 }
 
-func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger,	body []byte, rpc string) ([]byte, error) {
+func executeHTTPRequestWithResponse(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, *http.Response, error) {
 	logger.DebugContext(ctx, "api request", "serviceName", serviceName, "rpcName", rpc, "request", internallog.HTTPRequest(req, body))
 	resp, err := client.Do(req)
 	if err != nil{
-		return nil, err
+		return nil, nil, err
 	}
 	defer resp.Body.Close()
 	buf, err := io.ReadAll(resp.Body)
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
 	logger.DebugContext(ctx, "api response", "serviceName", serviceName, "rpcName", rpc, "response", internallog.HTTPResponse(resp, buf))
 	if err = googleapi.CheckResponse(resp); err != nil {
-		return nil, err
+		return nil, nil, err
 	}
-	return buf, nil
+	return buf, resp, nil
+}
+
+func executeHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {
+	buf, _, err := executeHTTPRequestWithResponse(ctx, client, req, logger, body, rpc)
+	return buf, err
 }
 
 func executeStreamingHTTPRequest(ctx context.Context, client *http.Client, req *http.Request, logger *slog.Logger, body []byte, rpc string) (*http.Response, error) {
diff --git a/internal/gengapic/testdata/rest_HttpBodyRPC.want b/internal/gengapic/testdata/rest_HttpBodyRPC.want
@@ -39,7 +39,7 @@ func (c *fooRESTClient) HttpBodyRPC(ctx context.Context, req *foopb.Foo, opts ..
 		httpReq = httpReq.WithContext(ctx)
 		httpReq.Header = headers
 
-		buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "HttpBodyRPC")
+		buf, httpRsp, err := executeHTTPRequestWithResponse(ctx, c.httpClient, httpReq, c.logger, jsonReq, "HttpBodyRPC")
 		if err != nil{
 			return err
 		}

Original file line number	Diff line number	Diff line change
`@@ -21,22 +21,27 @@ func DefaultAuthScopes() []string {`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`
`24`		`-func executeHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {`
	`24`	`+func executeHTTPRequestWithResponse(ctx context.Context, client http.Client, req http.Request, logger slog.Logger, body []byte, rpc string) ([]byte, http.Response, error) {`
`25`	`25`	`logger.DebugContext(ctx, "api request", "serviceName", serviceName, "rpcName", rpc, "request", internallog.HTTPRequest(req, body))`
`26`	`26`	`resp, err := client.Do(req)`
`27`	`27`	`if err != nil{`
`28`		`- return nil, err`
	`28`	`+ return nil, nil, err`
`29`	`29`	`}`
`30`	`30`	`defer resp.Body.Close()`
`31`	`31`	`buf, err := io.ReadAll(resp.Body)`
`32`	`32`	`if err != nil {`
`33`		`- return nil, err`
	`33`	`+ return nil, nil, err`
`34`	`34`	`}`
`35`	`35`	`logger.DebugContext(ctx, "api response", "serviceName", serviceName, "rpcName", rpc, "response", internallog.HTTPResponse(resp, buf))`
`36`	`36`	`if err = googleapi.CheckResponse(resp); err != nil {`
`37`		`- return nil, err`
	`37`	`+ return nil, nil, err`
`38`	`38`	`}`
`39`		`- return buf, nil`
	`39`	`+ return buf, resp, nil`
	`40`	`+}`
	`41`	`+`
	`42`	`+func executeHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {`
	`43`	`+ buf, _, err := executeHTTPRequestWithResponse(ctx, client, req, logger, body, rpc)`
	`44`	`+ return buf, err`
`40`	`45`	`}`
`41`	`46`
`42`	`47`	`func executeStreamingHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger slog.Logger, body []byte, rpc string) (http.Response, error) {`
Original file line number	Diff line number	Diff line change
`@@ -23,22 +23,27 @@ func DefaultAuthScopes() []string {`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`
`26`		`-func executeHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {`
	`26`	`+func executeHTTPRequestWithResponse(ctx context.Context, client http.Client, req http.Request, logger slog.Logger, body []byte, rpc string) ([]byte, http.Response, error) {`
`27`	`27`	`logger.DebugContext(ctx, "api request", "serviceName", serviceName, "rpcName", rpc, "request", internallog.HTTPRequest(req, body))`
`28`	`28`	`resp, err := client.Do(req)`
`29`	`29`	`if err != nil{`
`30`		`- return nil, err`
	`30`	`+ return nil, nil, err`
`31`	`31`	`}`
`32`	`32`	`defer resp.Body.Close()`
`33`	`33`	`buf, err := io.ReadAll(resp.Body)`
`34`	`34`	`if err != nil {`
`35`		`- return nil, err`
	`35`	`+ return nil, nil, err`
`36`	`36`	`}`
`37`	`37`	`logger.DebugContext(ctx, "api response", "serviceName", serviceName, "rpcName", rpc, "response", internallog.HTTPResponse(resp, buf))`
`38`	`38`	`if err = googleapi.CheckResponse(resp); err != nil {`
`39`		`- return nil, err`
	`39`	`+ return nil, nil, err`
`40`	`40`	`}`
`41`		`- return buf, nil`
	`41`	`+ return buf, resp, nil`
	`42`	`+}`
	`43`	`+`
	`44`	`+func executeHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {`
	`45`	`+ buf, _, err := executeHTTPRequestWithResponse(ctx, client, req, logger, body, rpc)`
	`46`	`+ return buf, err`
`42`	`47`	`}`
`43`	`48`
`44`	`49`	`func executeStreamingHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger slog.Logger, body []byte, rpc string) (http.Response, error) {`
Original file line number	Diff line number	Diff line change
`@@ -20,22 +20,27 @@ func DefaultAuthScopes() []string {`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`
`23`		`-func executeHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {`
	`23`	`+func executeHTTPRequestWithResponse(ctx context.Context, client http.Client, req http.Request, logger slog.Logger, body []byte, rpc string) ([]byte, http.Response, error) {`
`24`	`24`	`logger.DebugContext(ctx, "api request", "serviceName", serviceName, "rpcName", rpc, "request", internallog.HTTPRequest(req, body))`
`25`	`25`	`resp, err := client.Do(req)`
`26`	`26`	`if err != nil{`
`27`		`- return nil, err`
	`27`	`+ return nil, nil, err`
`28`	`28`	`}`
`29`	`29`	`defer resp.Body.Close()`
`30`	`30`	`buf, err := io.ReadAll(resp.Body)`
`31`	`31`	`if err != nil {`
`32`		`- return nil, err`
	`32`	`+ return nil, nil, err`
`33`	`33`	`}`
`34`	`34`	`logger.DebugContext(ctx, "api response", "serviceName", serviceName, "rpcName", rpc, "response", internallog.HTTPResponse(resp, buf))`
`35`	`35`	`if err = googleapi.CheckResponse(resp); err != nil {`
`36`		`- return nil, err`
	`36`	`+ return nil, nil, err`
`37`	`37`	`}`
`38`		`- return buf, nil`
	`38`	`+ return buf, resp, nil`
	`39`	`+}`
	`40`	`+`
	`41`	`+func executeHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger *slog.Logger, body []byte, rpc string) ([]byte, error) {`
	`42`	`+ buf, _, err := executeHTTPRequestWithResponse(ctx, client, req, logger, body, rpc)`
	`43`	`+ return buf, err`
`39`	`44`	`}`
`40`	`45`
`41`	`46`	`func executeStreamingHTTPRequest(ctx context.Context, client http.Client, req http.Request, logger slog.Logger, body []byte, rpc string) (http.Response, error) {`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func (c fooRESTClient) HttpBodyRPC(ctx context.Context, req foopb.Foo, opts ..`
`39`	`39`	`httpReq = httpReq.WithContext(ctx)`
`40`	`40`	`httpReq.Header = headers`
`41`	`41`
`42`		`- buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "HttpBodyRPC")`
	`42`	`+ buf, httpRsp, err := executeHTTPRequestWithResponse(ctx, c.httpClient, httpReq, c.logger, jsonReq, "HttpBodyRPC")`
`43`	`43`	`if err != nil{`
`44`	`44`	`return err`
`45`	`45`	`}`