Name all context extracting functions consistently

Response       -> ContextResponse
Request        -> ContextRequest
RequestService -> ContextService
RequestLogger  -> ContextLogger

Author: raphael

context.go

@@ -66,32 +66,32 @@ func UseLogger(ctx context.Context, logger Logger) context.Context {
 	return context.WithValue(ctx, logKey, logger)
 }
 
-// Request gives access to the underlying HTTP request.
-func Request(ctx context.Context) *RequestData {
+// ContextRequest gives access to the underlying HTTP request.
+func ContextRequest(ctx context.Context) *RequestData {
 	if r := ctx.Value(reqKey); r != nil {
 		return r.(*RequestData)
 	}
 	return nil
 }
 
-// Response gives access to the underlying HTTP response.
-func Response(ctx context.Context) *ResponseData {
+// ContextResponse gives access to the underlying HTTP response.
+func ContextResponse(ctx context.Context) *ResponseData {
 	if r := ctx.Value(respKey); r != nil {
 		return r.(*ResponseData)
 	}
 	return nil
 }
 
-// RequestService returns the service tageted by the request with the given context.
-func RequestService(ctx context.Context) *Service {
+// ContextService returns the service tageted by the request with the given context.
+func ContextService(ctx context.Context) *Service {
 	if r := ctx.Value(serviceKey); r != nil {
 		return r.(*Service)
 	}
 	return nil
 }
 
-// RequestLogger returns the logger used by the request context.
-func RequestLogger(ctx context.Context) Logger {
+// ContextLogger returns the logger used by the request context.
+func ContextLogger(ctx context.Context) Logger {
 	if v := ctx.Value(logKey); v != nil {
 		return v.(Logger)
 	}
@@ -115,7 +115,7 @@ func (r *ResponseData) Written() bool {
 // encoders. It uses the default service encoder if no match is found.
 func (r *ResponseData) Send(ctx context.Context, code int, body interface{}) error {
 	r.WriteHeader(code)
-	return RequestService(ctx).EncodeResponse(ctx, body)
+	return ContextService(ctx).EncodeResponse(ctx, body)
 }
 
 // BadRequest sends a HTTP response with status code 400 and the given error as body.

context_test.go

@@ -24,7 +24,7 @@ var _ = Describe("ResponseData", func() {
 		rw = &TestResponseWriter{Status: 42}
 		params = url.Values{"query": []string{"value"}}
 		ctx := goa.NewContext(context.Background(), rw, req, params)
-		data = goa.Response(ctx)
+		data = goa.ContextResponse(ctx)
 	})
 
 	Context("SwitchWriter", func() {

encoding.go

@@ -180,7 +180,7 @@ func (p *decoderPool) Put(d Decoder) {
 // `Accept` header and writes it to the http.ResponseWriter
 func (service *Service) EncodeResponse(ctx context.Context, v interface{}) error {
 	now := time.Now()
-	accept := Request(ctx).Header.Get("Accept")
+	accept := ContextRequest(ctx).Header.Get("Accept")
 	if accept == "" {
 		accept = "*/*"
 	}
@@ -201,7 +201,7 @@ func (service *Service) EncodeResponse(ctx context.Context, v interface{}) error
 	}
 
 	// the encoderPool will handle whether or not a pool is actually in use
-	encoder := p.Get(Response(ctx))
+	encoder := p.Get(ContextResponse(ctx))
 	if err := encoder.Encode(v); err != nil {
 		return err
 	}

error.go

@@ -1,22 +1,23 @@
 // Package goa standardizes on structured error responses: a request that fails because of
-// invalid input or unexpected condition produces a response that contains one or more structured
-// error(s). Each error object has three keys: a id (number), a title and a message. The title
-// for a given id is always the same, the intent is to provide a human friendly categorization.
-// The message is specific to the error occurrence and provides additional details that often
-// include contextual information (name of parameters etc.).
+// invalid input or unexpected condition produces a response that contains a structured error.
+// Error objects has four keys: a code, a status, a detail and metadata. The code defines the class
+// of error (e.g. "invalid_parameter_type") and the status is the corresponding HTTP status
+// (e.g. 400). The detail is specific to the error occurrence. The medata provides additional
+// values that provide contextual information (name of parameters etc.).
 //
-// The basic data structure backing errors is TypedError which simply contains the id and message.
-// Multiple errors (not just TypedError instances) can be encapsulated in a HTTPError. Both
-// TypedError and HTTPError implement the error interface, the Error methods return valid JSON
-// that can be written directly to a response body.
+// The basic data structure backing errors is Error. Instances of Error can be created via Error
+// Class functions. See http://goa.design/implement/error_handling.html
 //
 // The code generated by goagen calls the helper functions exposed in this file when it encounters
 // invalid data (wrong type, validation errors etc.) such as InvalidParamTypeError,
-// InvalidAttributeTypeError etc. These methods take and return an error which is a HTTPError that
-// gets built over time. The final HTTPError object then gets serialized into the response and sent
-// back to the client. The response status code is inferred from the type wrapping the error object:
-// a BadRequestError produces a 400 status code while any other error produce a 500. This behavior
-// can be overridden by setting a custom ErrorHandler in the application.
+// InvalidAttributeTypeError etc. These methods return errors that get merged with any previously
+// encountered error via the Error Merge method.
+//
+// goa includes an error handler middleware that takes care of mapping back any error returned by
+// previously called middleware or action handler into HTTP responses. If the error is an instance
+// of Error then the corresponding content including the HTTP status is used otherwise an internal
+// error is returned. Errors that bubble up all the way to the top (i.e. not handled by the error
+// middleware) also generate an internal error response.
 package goa
 
 import (

goagen/codegen/types.go

@@ -269,7 +269,7 @@ func GoTypeDesc(t design.DataType, upper bool) string {
 // or the empty string if there isn't one.
 func GoaMediaTypeName(mt *design.MediaTypeDefinition) string {
 	if mt == design.ErrorMedia {
-		return "*goa.HTTPError"
+		return "*goa.Error"
 	}
 	return ""
 }

goagen/gen_app/generator_test.go

@@ -360,8 +360,8 @@ type GetWidgetContext struct {
 // context used by the Widget controller get action.
 func NewGetWidgetContext(ctx context.Context) (*GetWidgetContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := GetWidgetContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := GetWidgetContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawID := req.Params.Get("id")
 	if rawID != "" {
 		rctx.ID = rawID
@@ -479,7 +479,7 @@ func MountWidgetController(service *goa.Service, ctrl WidgetController) {
 		if err != nil {
 			return err
 		}
-		if rawPayload := goa.Request(ctx).Payload; rawPayload != nil {
+		if rawPayload := goa.ContextRequest(ctx).Payload; rawPayload != nil {
 			rctx.Payload = rawPayload.(Collection)
 		}
 		return ctrl.Get(rctx)
@@ -491,10 +491,10 @@ func MountWidgetController(service *goa.Service, ctrl WidgetController) {
 // unmarshalGetWidgetPayload unmarshals the request body into the context request data Payload field.
 func unmarshalGetWidgetPayload(ctx context.Context, req *http.Request) error {
 	var payload Collection
-	if err := goa.RequestService(ctx).DecodeRequest(req, &payload); err != nil {
+	if err := goa.ContextService(ctx).DecodeRequest(req, &payload); err != nil {
 		return err
 	}
-	goa.Request(ctx).Payload = payload
+	goa.ContextRequest(ctx).Payload = payload
 	return nil
 }
 `

goagen/gen_app/writers.go

@@ -460,8 +460,8 @@ type {{ .Name }} struct {
 // context used by the {{ .ResourceName }} controller {{ .ActionName }} action.
 func New{{ .Name }}(ctx context.Context) (*{{ .Name }}, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := {{ .Name }}{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := {{ .Name }}{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 {{ if .Headers }}{{ $headers := .Headers }}{{ range $name, $att := $headers.Type.ToObject }}	raw{{ goify $name true }} := req.Header.Get("{{ $name }}")
 {{ if $headers.IsRequired $name }}	if raw{{ goify $name true }} == "" {
 		err = err.Merge(goa.MissingHeaderError("{{ $name }}"))
@@ -579,7 +579,7 @@ func Mount{{ .Resource }}Controller(service *goa.Service, ctrl {{ .Resource }}Co
 		if err != nil {
 			return err
 		}
-{{ if .Payload }}if rawPayload := goa.Request(ctx).Payload; rawPayload != nil {
+{{ if .Payload }}if rawPayload := goa.ContextRequest(ctx).Payload; rawPayload != nil {
 			rctx.Payload = rawPayload.({{ gotyperef .Payload nil 1 }})
 		}
 		{{ end }}		return ctrl.{{ .Name }}(rctx)
@@ -626,13 +626,13 @@ func handle{{ .Resource }}Origin(h goa.Handler) goa.Handler {
 // {{ .Unmarshal }} unmarshals the request body into the context request data Payload field.
 func {{ .Unmarshal }}(ctx context.Context, req *http.Request) error {
 	var payload {{ gotypename .Payload nil 1 }}
-	if err := goa.RequestService(ctx).DecodeRequest(req, &payload); err != nil {
+	if err := goa.ContextService(ctx).DecodeRequest(req, &payload); err != nil {
 		return err
 	}{{ $validation := recursiveValidate .Payload.AttributeDefinition false false "payload" "raw" 1 }}{{ if $validation }}
 	if err := payload.Validate(); err != nil {
 		return err
 	}{{ end }}
-	goa.Request(ctx).Payload = {{ if .Payload.IsObject }}&{{ end }}payload
+	goa.ContextRequest(ctx).Payload = {{ if .Payload.IsObject }}&{{ end }}payload
 	return nil
 }
 {{ end }}

goagen/gen_app/writers_test.go

@@ -723,8 +723,8 @@ type ListBottleContext struct {
 	emptyContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	return &rctx, err
 }
 `
@@ -741,8 +741,8 @@ type ListBottleContext struct {
 	intContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawParam := req.Params.Get("param")
 	if rawParam != "" {
 		if param, err2 := strconv.Atoi(rawParam); err2 == nil {
@@ -769,8 +769,8 @@ type ListBottleContext struct {
 	strContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawParam := req.Params.Get("param")
 	if rawParam != "" {
 		rctx.Param = &rawParam
@@ -791,8 +791,8 @@ type ListBottleContext struct {
 	numContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawParam := req.Params.Get("param")
 	if rawParam != "" {
 		if param, err2 := strconv.ParseFloat(rawParam, 64); err2 == nil {
@@ -817,8 +817,8 @@ type ListBottleContext struct {
 	boolContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawParam := req.Params.Get("param")
 	if rawParam != "" {
 		if param, err2 := strconv.ParseBool(rawParam); err2 == nil {
@@ -844,8 +844,8 @@ type ListBottleContext struct {
 	arrayContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawParam := req.Params.Get("param")
 	if rawParam != "" {
 		elemsParam := strings.Split(rawParam, ",")
@@ -867,8 +867,8 @@ type ListBottleContext struct {
 	intArrayContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawParam := req.Params.Get("param")
 	if rawParam != "" {
 		elemsParam := strings.Split(rawParam, ",")
@@ -898,8 +898,8 @@ type ListBottleContext struct {
 	resContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawInt := req.Params.Get("int")
 	if rawInt != "" {
 		if int_, err2 := strconv.Atoi(rawInt); err2 == nil {
@@ -926,8 +926,8 @@ type ListBottleContext struct {
 	requiredContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	rawInt := req.Params.Get("int")
 	if rawInt == "" {
 		err = err.Merge(goa.MissingParamError("int"))
@@ -954,8 +954,8 @@ type ListBottleContext struct {
 	payloadContextFactory = `
 func NewListBottleContext(ctx context.Context) (*ListBottleContext, error) {
 	var err *goa.Error
-	req := goa.Request(ctx)
-	rctx := ListBottleContext{Context: ctx, ResponseData: goa.Response(ctx), RequestData: req}
+	req := goa.ContextRequest(ctx)
+	rctx := ListBottleContext{Context: ctx, ResponseData: goa.ContextResponse(ctx), RequestData: req}
 	return &rctx, err
 }
 `
@@ -971,23 +971,23 @@ type ListBottleContext struct {
 	payloadObjUnmarshal = `
 func unmarshalListBottlePayload(ctx context.Context, req *http.Request) error {
 	var payload ListBottlePayload
-	if err := goa.RequestService(ctx).DecodeRequest(req, &payload); err != nil {
+	if err := goa.ContextService(ctx).DecodeRequest(req, &payload); err != nil {
 		return err
 	}
 	if err := payload.Validate(); err != nil {
 		return err
 	}
-	goa.Request(ctx).Payload = &payload
+	goa.ContextRequest(ctx).Payload = &payload
 	return nil
 }
 `
 	payloadNoValidationsObjUnmarshal = `
 func unmarshalListBottlePayload(ctx context.Context, req *http.Request) error {
 	var payload ListBottlePayload
-	if err := goa.RequestService(ctx).DecodeRequest(req, &payload); err != nil {
+	if err := goa.ContextService(ctx).DecodeRequest(req, &payload); err != nil {
 		return err
 	}
-	goa.Request(ctx).Payload = &payload
+	goa.ContextRequest(ctx).Payload = &payload
 	return nil
 }
 `

middleware_test.go

@@ -62,13 +62,13 @@ var _ = Describe("NewMiddleware", func() {
 			Ω(err).ShouldNot(HaveOccurred())
 			rw = new(TestResponseWriter)
 			ctx = goa.NewContext(ctrl.Context, rw, req, nil)
-			Ω(goa.Response(ctx).Status).Should(Equal(0))
+			Ω(goa.ContextResponse(ctx).Status).Should(Equal(0))
 		})
 
 		Context("using a goa handler", func() {
 			BeforeEach(func() {
 				var goaHandler goa.Handler = func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error {
-					goa.Response(ctx).Send(ctx, 200, "ok")
+					goa.ContextResponse(ctx).Send(ctx, 200, "ok")
 					return nil
 				}
 				input = goaHandler
@@ -78,14 +78,14 @@ var _ = Describe("NewMiddleware", func() {
 				Ω(mErr).ShouldNot(HaveOccurred())
 				h := func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error { return nil }
 				Ω(middleware(h)(ctx, rw, req)).ShouldNot(HaveOccurred())
-				Ω(goa.Response(ctx).Status).Should(Equal(200))
+				Ω(goa.ContextResponse(ctx).Status).Should(Equal(200))
 			})
 		})
 
 		Context("using a goa handler func", func() {
 			BeforeEach(func() {
 				input = func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error {
-					goa.Response(ctx).Send(ctx, 200, "ok")
+					goa.ContextResponse(ctx).Send(ctx, 200, "ok")
 					return nil
 				}
 			})
@@ -94,7 +94,7 @@ var _ = Describe("NewMiddleware", func() {
 				Ω(mErr).ShouldNot(HaveOccurred())
 				h := func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error { return nil }
 				Ω(middleware(h)(ctx, rw, req)).ShouldNot(HaveOccurred())
-				Ω(goa.Response(ctx).Status).Should(Equal(200))
+				Ω(goa.ContextResponse(ctx).Status).Should(Equal(200))
 			})
 		})
 
@@ -106,11 +106,11 @@ var _ = Describe("NewMiddleware", func() {
 			It("wraps it in a middleware", func() {
 				Ω(mErr).ShouldNot(HaveOccurred())
 				h := func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error {
-					goa.Response(ctx).Send(ctx, 200, "ok")
+					goa.ContextResponse(ctx).Send(ctx, 200, "ok")
 					return nil
 				}
 				Ω(middleware(h)(ctx, rw, req)).ShouldNot(HaveOccurred())
-				Ω(goa.Response(ctx).Status).Should(Equal(200))
+				Ω(goa.ContextResponse(ctx).Status).Should(Equal(200))
 			})
 		})