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.

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

contrib/go-chi/chi: Handle 0 status code correctly #740

Merged
merged 2 commits into from
Oct 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions contrib/go-chi/chi/chi.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ func Middleware(opts ...Option) func(next http.Handler) http.Handler {

// set the status code
status := ww.Status()
// 0 status means one has not yet been sent in which case net/http library will write StatusOK
if ww.Status() == 0 {
status = http.StatusOK
}
span.SetTag(ext.HTTPCode, strconv.Itoa(status))

if status >= 500 && status < 600 {
Expand Down
85 changes: 53 additions & 32 deletions contrib/go-chi/chi/chi_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,42 +39,63 @@ func TestChildSpan(t *testing.T) {
}

func TestTrace200(t *testing.T) {
assert := assert.New(t)
mt := mocktracer.Start()
defer mt.Stop()
assertDoRequest := func(assert *assert.Assertions, mt mocktracer.Tracer, router *chi.Mux) {
r := httptest.NewRequest("GET", "/user/123", nil)
w := httptest.NewRecorder()

router := chi.NewRouter()
router.Use(Middleware(WithServiceName("foobar")))
router.Get("/user/{id}", func(w http.ResponseWriter, r *http.Request) {
span, ok := tracer.SpanFromContext(r.Context())
assert.True(ok)
assert.Equal(span.(mocktracer.Span).Tag(ext.ServiceName), "foobar")
id := chi.URLParam(r, "id")
w.Write([]byte(id))
})
// do and verify the request
router.ServeHTTP(w, r)
response := w.Result()
assert.Equal(response.StatusCode, 200)

r := httptest.NewRequest("GET", "/user/123", nil)
w := httptest.NewRecorder()
// verify traces look good
spans := mt.FinishedSpans()
assert.Len(spans, 1)
if len(spans) < 1 {
t.Fatalf("no spans")
}
span := spans[0]
assert.Equal("http.request", span.OperationName())
assert.Equal(ext.SpanTypeWeb, span.Tag(ext.SpanType))
assert.Equal("foobar", span.Tag(ext.ServiceName))
assert.Equal("GET /user/{id}", span.Tag(ext.ResourceName))
assert.Equal("200", span.Tag(ext.HTTPCode))
assert.Equal("GET", span.Tag(ext.HTTPMethod))
assert.Equal("/user/123", span.Tag(ext.HTTPURL))
}

// do and verify the request
router.ServeHTTP(w, r)
response := w.Result()
assert.Equal(response.StatusCode, 200)
t.Run("response written", func(t *testing.T) {
assert := assert.New(t)
mt := mocktracer.Start()
defer mt.Stop()

// verify traces look good
spans := mt.FinishedSpans()
assert.Len(spans, 1)
if len(spans) < 1 {
t.Fatalf("no spans")
}
span := spans[0]
assert.Equal("http.request", span.OperationName())
assert.Equal(ext.SpanTypeWeb, span.Tag(ext.SpanType))
assert.Equal("foobar", span.Tag(ext.ServiceName))
assert.Equal("GET /user/{id}", span.Tag(ext.ResourceName))
assert.Equal("200", span.Tag(ext.HTTPCode))
assert.Equal("GET", span.Tag(ext.HTTPMethod))
assert.Equal("/user/123", span.Tag(ext.HTTPURL))
router := chi.NewRouter()
router.Use(Middleware(WithServiceName("foobar")))
router.Get("/user/{id}", func(w http.ResponseWriter, r *http.Request) {
span, ok := tracer.SpanFromContext(r.Context())
assert.True(ok)
assert.Equal(span.(mocktracer.Span).Tag(ext.ServiceName), "foobar")
id := chi.URLParam(r, "id")
_, err := w.Write([]byte(id))
assert.NoError(err)
})
assertDoRequest(assert, mt, router)
})

t.Run("no response written", func(t *testing.T) {
assert := assert.New(t)
mt := mocktracer.Start()
defer mt.Stop()

router := chi.NewRouter()
router.Use(Middleware(WithServiceName("foobar")))
router.Get("/user/{id}", func(w http.ResponseWriter, r *http.Request) {
span, ok := tracer.SpanFromContext(r.Context())
assert.True(ok)
assert.Equal(span.(mocktracer.Span).Tag(ext.ServiceName), "foobar")
})
assertDoRequest(assert, mt, router)
})
}

func TestError(t *testing.T) {
Expand Down