gopher-fleece / gleece / 15284258021

86%

Build Type

push

github

Committed by web-flow

Commit Message

BREAKING - Adding support for Receiver Context Injection (#46)

This P.R adds support for context injection to Gleece authentication, middlewares and controllers.

Example:

```go
// @Method(POST)
// @Route(/context-and-route-param/{id})
// @Path(id)
func (ec *ContextController) MethodWithContext(ctx context.Context, id string) error {
	return nil
}
```

In this example, `ctx` will be the Go Context encapsulated by the underlying router's own Context.

### Controllers:

Using context injection requires no effort from users - simply add a `context.Context` parameter to whichever method/s require it.
The underlying generated code will automatically deliver it.

**Please note the following:**
* Context imports must be explicit (i.e., `context.Context`). **Dot imports or aliases are *not* supported.**
* Context parameters may appear multiple times and in any order. We recommend picking a convention and sticking to it.

--------

### Authentication/Middlewares:

**Please note this is a BREAKING change**.

Authentication handler and middlewares have had their signature updated to receive and return a Context.
Users can use the context as they see fit.

If the function (be it authentication or middleware) then returns a context, it will **replace** the router's request context, allowing users to effectively inject metadata into the session.


### Addendum

* BREAKING - Minor changes to several template variable names

Run Details

83 of 95 new or added lines in 7 files covered. (87.37%)

1 existing line in 1 file now uncovered.

3925 of 4547 relevant lines covered (86.32%)

283.16 hits per line