update to insert APIContexter into Request

Author: interlock

api.go

@@ -257,7 +257,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 		c := api.contextPool.Get().(APIContexter)
 		c.Reset()
 		api.middlewareChain(c, w, r)
-		err := res.handleIndex(w, r, api.info)
+		err := res.handleIndex(c, w, r, api.info)
 		api.contextPool.Put(c)
 		if err != nil {
 			handleError(err, w, r, marshalers)
@@ -268,7 +268,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 		c := api.contextPool.Get().(APIContexter)
 		c.Reset()
 		api.middlewareChain(c, w, r)
-		err := res.handleRead(w, r, ps, api.info)
+		err := res.handleRead(c, w, r, ps, api.info)
 		api.contextPool.Put(c)
 		if err != nil {
 			handleError(err, w, r, marshalers)
@@ -285,7 +285,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 					c := api.contextPool.Get().(APIContexter)
 					c.Reset()
 					api.middlewareChain(c, w, r)
-					err := res.handleReadRelation(w, r, ps, api.info, relation)
+					err := res.handleReadRelation(c, w, r, ps, api.info, relation)
 					api.contextPool.Put(c)
 					if err != nil {
 						handleError(err, w, r, marshalers)
@@ -298,7 +298,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 					c := api.contextPool.Get().(APIContexter)
 					c.Reset()
 					api.middlewareChain(c, w, r)
-					err := res.handleLinked(api, w, r, ps, relation, api.info)
+					err := res.handleLinked(c, api, w, r, ps, relation, api.info)
 					api.contextPool.Put(c)
 					if err != nil {
 						handleError(err, w, r, marshalers)
@@ -311,7 +311,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 					c := api.contextPool.Get().(APIContexter)
 					c.Reset()
 					api.middlewareChain(c, w, r)
-					err := res.handleReplaceRelation(w, r, ps, relation)
+					err := res.handleReplaceRelation(c, w, r, ps, relation)
 					api.contextPool.Put(c)
 					if err != nil {
 						handleError(err, w, r, marshalers)
@@ -326,7 +326,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 						c := api.contextPool.Get().(APIContexter)
 						c.Reset()
 						api.middlewareChain(c, w, r)
-						err := res.handleAddToManyRelation(w, r, ps, relation)
+						err := res.handleAddToManyRelation(c, w, r, ps, relation)
 						api.contextPool.Put(c)
 						if err != nil {
 							handleError(err, w, r, marshalers)
@@ -339,7 +339,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 						c := api.contextPool.Get().(APIContexter)
 						c.Reset()
 						api.middlewareChain(c, w, r)
-						err := res.handleDeleteToManyRelation(w, r, ps, relation)
+						err := res.handleDeleteToManyRelation(c, w, r, ps, relation)
 						api.contextPool.Put(c)
 						if err != nil {
 							handleError(err, w, r, marshalers)
@@ -354,7 +354,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 		c := api.contextPool.Get().(APIContexter)
 		c.Reset()
 		api.middlewareChain(c, w, r)
-		err := res.handleCreate(w, r, api.prefix, api.info)
+		err := res.handleCreate(c, w, r, api.prefix, api.info)
 		api.contextPool.Put(c)
 		if err != nil {
 			handleError(err, w, r, marshalers)
@@ -365,7 +365,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 		c := api.contextPool.Get().(APIContexter)
 		c.Reset()
 		api.middlewareChain(c, w, r)
-		err := res.handleDelete(w, r, ps)
+		err := res.handleDelete(c, w, r, ps)
 		api.contextPool.Put(c)
 		if err != nil {
 			handleError(err, w, r, marshalers)
@@ -376,7 +376,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 		c := api.contextPool.Get().(APIContexter)
 		c.Reset()
 		api.middlewareChain(c, w, r)
-		err := res.handleUpdate(w, r, ps)
+		err := res.handleUpdate(c, w, r, ps)
 		api.contextPool.Put(c)
 		if err != nil {
 			handleError(err, w, r, marshalers)
@@ -388,26 +388,27 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source CRUD, ma
 	return &res
 }
 
-func buildRequest(r *http.Request) Request {
+func buildRequest(c APIContexter, r *http.Request) Request {
 	req := Request{PlainRequest: r}
 	params := make(map[string][]string)
 	for key, values := range r.URL.Query() {
 		params[key] = strings.Split(values[0], ",")
 	}
 	req.QueryParams = params
 	req.Header = r.Header
+	req.Context = c
 	return req
 }
 
-func (res *resource) handleIndex(w http.ResponseWriter, r *http.Request, info information) error {
+func (res *resource) handleIndex(c APIContexter, w http.ResponseWriter, r *http.Request, info information) error {
 	pagination := newPaginationQueryParams(r)
 	if pagination.isValid() {
 		source, ok := res.source.(PaginatedFindAll)
 		if !ok {
 			return NewHTTPError(nil, "Resource does not implement the PaginatedFindAll interface", http.StatusNotFound)
 		}
 
-		count, response, err := source.PaginatedFindAll(buildRequest(r))
+		count, response, err := source.PaginatedFindAll(buildRequest(c, r))
 		if err != nil {
 			return err
 		}
@@ -424,18 +425,18 @@ func (res *resource) handleIndex(w http.ResponseWriter, r *http.Request, info in
 		return NewHTTPError(nil, "Resource does not implement the FindAll interface", http.StatusNotFound)
 	}
 
-	response, err := source.FindAll(buildRequest(r))
+	response, err := source.FindAll(buildRequest(c, r))
 	if err != nil {
 		return err
 	}
 
 	return respondWith(response, info, http.StatusOK, w, r, res.marshalers)
 }
 
-func (res *resource) handleRead(w http.ResponseWriter, r *http.Request, ps httprouter.Params, info information) error {
+func (res *resource) handleRead(c APIContexter, w http.ResponseWriter, r *http.Request, ps httprouter.Params, info information) error {
 	id := ps.ByName("id")
 
-	response, err := res.source.FindOne(id, buildRequest(r))
+	response, err := res.source.FindOne(id, buildRequest(c, r))
 
 	if err != nil {
 		return err
@@ -444,10 +445,10 @@ func (res *resource) handleRead(w http.ResponseWriter, r *http.Request, ps httpr
 	return respondWith(response, info, http.StatusOK, w, r, res.marshalers)
 }
 
-func (res *resource) handleReadRelation(w http.ResponseWriter, r *http.Request, ps httprouter.Params, info information, relation jsonapi.Reference) error {
+func (res *resource) handleReadRelation(c APIContexter, w http.ResponseWriter, r *http.Request, ps httprouter.Params, info information, relation jsonapi.Reference) error {
 	id := ps.ByName("id")
 
-	obj, err := res.source.FindOne(id, buildRequest(r))
+	obj, err := res.source.FindOne(id, buildRequest(c, r))
 	if err != nil {
 		return err
 	}
@@ -500,11 +501,11 @@ func (res *resource) handleReadRelation(w http.ResponseWriter, r *http.Request,
 }
 
 // try to find the referenced resource and call the findAll Method with referencing resource id as param
-func (res *resource) handleLinked(api *API, w http.ResponseWriter, r *http.Request, ps httprouter.Params, linked jsonapi.Reference, info information) error {
+func (res *resource) handleLinked(c APIContexter, api *API, w http.ResponseWriter, r *http.Request, ps httprouter.Params, linked jsonapi.Reference, info information) error {
 	id := ps.ByName("id")
 	for _, resource := range api.resources {
 		if resource.name == linked.Type {
-			request := buildRequest(r)
+			request := buildRequest(c, r)
 			request.QueryParams[res.name+"ID"] = []string{id}
 			request.QueryParams[res.name+"Name"] = []string{linked.Name}
 
@@ -555,7 +556,7 @@ func (res *resource) handleLinked(api *API, w http.ResponseWriter, r *http.Reque
 
 }
 
-func (res *resource) handleCreate(w http.ResponseWriter, r *http.Request, prefix string, info information) error {
+func (res *resource) handleCreate(c APIContexter, w http.ResponseWriter, r *http.Request, prefix string, info information) error {
 	ctx, err := unmarshalRequest(r, res.marshalers)
 	if err != nil {
 		return err
@@ -578,7 +579,7 @@ func (res *resource) handleCreate(w http.ResponseWriter, r *http.Request, prefix
 	//TODO create multiple objects not only one.
 	newObj := newObjs.Index(0).Interface()
 
-	response, err := res.source.Create(newObj, buildRequest(r))
+	response, err := res.source.Create(newObj, buildRequest(c, r))
 	if err != nil {
 		return err
 	}
@@ -605,8 +606,8 @@ func (res *resource) handleCreate(w http.ResponseWriter, r *http.Request, prefix
 	}
 }
 
-func (res *resource) handleUpdate(w http.ResponseWriter, r *http.Request, ps httprouter.Params) error {
-	obj, err := res.source.FindOne(ps.ByName("id"), buildRequest(r))
+func (res *resource) handleUpdate(c APIContexter, w http.ResponseWriter, r *http.Request, ps httprouter.Params) error {
+	obj, err := res.source.FindOne(ps.ByName("id"), buildRequest(c, r))
 	if err != nil {
 		return err
 	}
@@ -669,7 +670,7 @@ func (res *resource) handleUpdate(w http.ResponseWriter, r *http.Request, ps htt
 
 	updatingObj := updatingObjs.Index(0).Interface()
 
-	response, err := res.source.Update(updatingObj, buildRequest(r))
+	response, err := res.source.Update(updatingObj, buildRequest(c, r))
 
 	if err != nil {
 		return err
@@ -679,7 +680,7 @@ func (res *resource) handleUpdate(w http.ResponseWriter, r *http.Request, ps htt
 	case http.StatusOK:
 		updated := response.Result()
 		if updated == nil {
-			internalResponse, err := res.source.FindOne(ps.ByName("id"), buildRequest(r))
+			internalResponse, err := res.source.FindOne(ps.ByName("id"), buildRequest(c, r))
 			if err != nil {
 				return err
 			}
@@ -703,13 +704,13 @@ func (res *resource) handleUpdate(w http.ResponseWriter, r *http.Request, ps htt
 	}
 }
 
-func (res *resource) handleReplaceRelation(w http.ResponseWriter, r *http.Request, ps httprouter.Params, relation jsonapi.Reference) error {
+func (res *resource) handleReplaceRelation(c APIContexter, w http.ResponseWriter, r *http.Request, ps httprouter.Params, relation jsonapi.Reference) error {
 	var (
 		err     error
 		editObj interface{}
 	)
 
-	response, err := res.source.FindOne(ps.ByName("id"), buildRequest(r))
+	response, err := res.source.FindOne(ps.ByName("id"), buildRequest(c, r))
 	if err != nil {
 		return err
 	}
@@ -737,22 +738,22 @@ func (res *resource) handleReplaceRelation(w http.ResponseWriter, r *http.Reques
 	}
 
 	if resType == reflect.Struct {
-		_, err = res.source.Update(reflect.ValueOf(editObj).Elem().Interface(), buildRequest(r))
+		_, err = res.source.Update(reflect.ValueOf(editObj).Elem().Interface(), buildRequest(c, r))
 	} else {
-		_, err = res.source.Update(editObj, buildRequest(r))
+		_, err = res.source.Update(editObj, buildRequest(c, r))
 	}
 
 	w.WriteHeader(http.StatusNoContent)
 	return err
 }
 
-func (res *resource) handleAddToManyRelation(w http.ResponseWriter, r *http.Request, ps httprouter.Params, relation jsonapi.Reference) error {
+func (res *resource) handleAddToManyRelation(c APIContexter, w http.ResponseWriter, r *http.Request, ps httprouter.Params, relation jsonapi.Reference) error {
 	var (
 		err     error
 		editObj interface{}
 	)
 
-	response, err := res.source.FindOne(ps.ByName("id"), buildRequest(r))
+	response, err := res.source.FindOne(ps.ByName("id"), buildRequest(c, r))
 	if err != nil {
 		return err
 	}
@@ -801,22 +802,22 @@ func (res *resource) handleAddToManyRelation(w http.ResponseWriter, r *http.Requ
 	targetObj.AddToManyIDs(relation.Name, newIDs)
 
 	if resType == reflect.Struct {
-		_, err = res.source.Update(reflect.ValueOf(targetObj).Elem().Interface(), buildRequest(r))
+		_, err = res.source.Update(reflect.ValueOf(targetObj).Elem().Interface(), buildRequest(c, r))
 	} else {
-		_, err = res.source.Update(targetObj, buildRequest(r))
+		_, err = res.source.Update(targetObj, buildRequest(c, r))
 	}
 
 	w.WriteHeader(http.StatusNoContent)
 
 	return err
 }
 
-func (res *resource) handleDeleteToManyRelation(w http.ResponseWriter, r *http.Request, ps httprouter.Params, relation jsonapi.Reference) error {
+func (res *resource) handleDeleteToManyRelation(c APIContexter, w http.ResponseWriter, r *http.Request, ps httprouter.Params, relation jsonapi.Reference) error {
 	var (
 		err     error
 		editObj interface{}
 	)
-	response, err := res.source.FindOne(ps.ByName("id"), buildRequest(r))
+	response, err := res.source.FindOne(ps.ByName("id"), buildRequest(c, r))
 	if err != nil {
 		return err
 	}
@@ -865,9 +866,9 @@ func (res *resource) handleDeleteToManyRelation(w http.ResponseWriter, r *http.R
 	targetObj.DeleteToManyIDs(relation.Name, obsoleteIDs)
 
 	if resType == reflect.Struct {
-		_, err = res.source.Update(reflect.ValueOf(targetObj).Elem().Interface(), buildRequest(r))
+		_, err = res.source.Update(reflect.ValueOf(targetObj).Elem().Interface(), buildRequest(c, r))
 	} else {
-		_, err = res.source.Update(targetObj, buildRequest(r))
+		_, err = res.source.Update(targetObj, buildRequest(c, r))
 	}
 
 	w.WriteHeader(http.StatusNoContent)
@@ -883,8 +884,8 @@ func getPointerToStruct(oldObj interface{}) interface{} {
 	return ptr.Interface()
 }
 
-func (res *resource) handleDelete(w http.ResponseWriter, r *http.Request, ps httprouter.Params) error {
-	response, err := res.source.Delete(ps.ByName("id"), buildRequest(r))
+func (res *resource) handleDelete(c APIContexter, w http.ResponseWriter, r *http.Request, ps httprouter.Params) error {
+	response, err := res.source.Delete(ps.ByName("id"), buildRequest(c, r))
 	if err != nil {
 		return err
 	}

api_public.go

@@ -60,6 +60,7 @@ type Request struct {
 	PlainRequest *http.Request
 	QueryParams  map[string][]string
 	Header       http.Header
+	Context      APIContexter
 }
 
 //SetRedirectTrailingSlash enables 307 redirects on urls ending with /

api_test.go

@@ -1241,8 +1241,9 @@ var _ = Describe("RestHandler", func() {
 		It("Extracts multiple parameters correctly", func() {
 			req, err := http.NewRequest("GET", "/v0/posts?sort=title,date", nil)
 			Expect(err).To(BeNil())
+			c := &APIContext{}
 
-			api2goReq := buildRequest(req)
+			api2goReq := buildRequest(c, req)
 			Expect(api2goReq.QueryParams).To(Equal(map[string][]string{"sort": {"title", "date"}}))
 		})
 	})