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 op ctx safety for apollo tracing #2709

Merged
merged 1 commit into from
Jul 11, 2023
Merged

Add op ctx safety for apollo tracing #2709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion graphql/handler/apollofederatedtracingv1/tracing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ func (Tracer) Validate(graphql.ExecutableSchema) error {
}

func (t *Tracer) shouldTrace(ctx context.Context) bool {
return graphql.GetOperationContext(ctx).Headers.Get("apollo-federation-include-trace") == "ftv1"
return graphql.HasOperationContext(ctx) &&
graphql.GetOperationContext(ctx).Headers.Get("apollo-federation-include-trace") == "ftv1"
}

func (t *Tracer) getTreeBuilder(ctx context.Context) *TreeBuilder {
Expand Down
25 changes: 22 additions & 3 deletions graphql/handler/apollofederatedtracingv1/tracing_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"encoding/base64"
"encoding/json"
"fmt"
"io"
"net/http"
"net/http/httptest"
"strings"
Expand All @@ -14,7 +15,6 @@ import (
"github.com/99designs/gqlgen/graphql"
"github.com/99designs/gqlgen/graphql/handler/apollofederatedtracingv1"
"github.com/99designs/gqlgen/graphql/handler/apollofederatedtracingv1/generated"
"github.com/99designs/gqlgen/graphql/handler/apollotracing"
"github.com/99designs/gqlgen/graphql/handler/extension"
"github.com/99designs/gqlgen/graphql/handler/lru"
"github.com/99designs/gqlgen/graphql/handler/testserver"
Expand All @@ -25,6 +25,12 @@ import (
"google.golang.org/protobuf/proto"
)

type alwaysError struct{}

func (a *alwaysError) Read(p []byte) (int, error) {
return 0, io.ErrUnexpectedEOF
}

func TestApolloTracing(t *testing.T) {
h := testserver.New()
h.AddTransport(transport.POST{})
Expand Down Expand Up @@ -89,7 +95,7 @@ func TestApolloTracing_withFail(t *testing.T) {
h := testserver.New()
h.AddTransport(transport.POST{})
h.Use(extension.AutomaticPersistedQuery{Cache: lru.New(100)})
h.Use(apollotracing.Tracer{})
h.Use(&apollofederatedtracingv1.Tracer{})

resp := doRequest(h, http.MethodPost, "/graphql", `{"operationName":"A","extensions":{"persistedQuery":{"version":1,"sha256Hash":"338bbc16ac780daf81845339fbf0342061c1e9d2b702c96d3958a13a557083a6"}}}`)
assert.Equal(t, http.StatusOK, resp.Code, resp.Body.String())
Expand All @@ -103,8 +109,21 @@ func TestApolloTracing_withFail(t *testing.T) {
require.Equal(t, "PersistedQueryNotFound", respData.Errors[0].Message)
}

func TestApolloTracing_withUnexpectedEOF(t *testing.T) {
h := testserver.New()
h.AddTransport(transport.POST{})
h.Use(&apollofederatedtracingv1.Tracer{})

resp := doRequestWithReader(h, http.MethodPost, "/graphql", &alwaysError{})
assert.Equal(t, http.StatusOK, resp.Code)
}
func doRequest(handler http.Handler, method, target, body string) *httptest.ResponseRecorder {
r := httptest.NewRequest(method, target, strings.NewReader(body))
return doRequestWithReader(handler, method, target, strings.NewReader(body))
}

func doRequestWithReader(handler http.Handler, method string, target string,
reader io.Reader) *httptest.ResponseRecorder {
r := httptest.NewRequest(method, target, reader)
r.Header.Set("Content-Type", "application/json")
r.Header.Set("apollo-federation-include-trace", "ftv1")
w := httptest.NewRecorder()
Expand Down
4 changes: 4 additions & 0 deletions graphql/handler/apollotracing/tracer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ func (Tracer) InterceptField(ctx context.Context, next graphql.Resolver) (interf
}

func (Tracer) InterceptResponse(ctx context.Context, next graphql.ResponseHandler) *graphql.Response {
if !graphql.HasOperationContext(ctx) {
return next(ctx)
}

rc := graphql.GetOperationContext(ctx)

start := rc.Stats.OperationStart
Expand Down
23 changes: 22 additions & 1 deletion graphql/handler/apollotracing/tracer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package apollotracing_test

import (
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"strings"
Expand All @@ -20,6 +21,12 @@ import (
"github.com/vektah/gqlparser/v2/gqlerror"
)

type alwaysError struct{}

func (a *alwaysError) Read(p []byte) (int, error) {
return 0, io.ErrUnexpectedEOF
}

func TestApolloTracing(t *testing.T) {
now := time.Unix(0, 0)

Expand Down Expand Up @@ -92,8 +99,22 @@ func TestApolloTracing_withFail(t *testing.T) {
require.Equal(t, "PersistedQueryNotFound", respData.Errors[0].Message)
}

func TestApolloTracing_withUnexpectedEOF(t *testing.T) {
h := testserver.New()
h.AddTransport(transport.POST{})
h.Use(apollotracing.Tracer{})

resp := doRequestWithReader(h, http.MethodPost, "/graphql", &alwaysError{})
assert.Equal(t, http.StatusOK, resp.Code)
}

func doRequest(handler http.Handler, method, target, body string) *httptest.ResponseRecorder {
r := httptest.NewRequest(method, target, strings.NewReader(body))
return doRequestWithReader(handler, method, target, strings.NewReader(body))
}

func doRequestWithReader(handler http.Handler, method string, target string,
reader io.Reader) *httptest.ResponseRecorder {
r := httptest.NewRequest(method, target, reader)
r.Header.Set("Content-Type", "application/json")
w := httptest.NewRecorder()

Expand Down