File: middleware.go

package info (click to toggle)
golang-github-mendersoftware-go-lib-micro 0.0~git20211108.4e20429%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, experimental, forky, sid, trixie
  • size: 656 kB
  • sloc: makefile: 5
file content (73 lines) | stat: -rw-r--r-- 2,769 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright 2017 Northern.tech AS
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
package context

import (
	"context"

	"github.com/ant0ine/go-json-rest/rest"

	"github.com/mendersoftware/go-lib-micro/log"
	"github.com/mendersoftware/go-lib-micro/requestid"
	"github.com/mendersoftware/go-lib-micro/requestlog"
)

// RepackLoggerToContext can be used to attach a request specific logger
// assigned by RequestLogMiddleware to context ctx. The logger can later be
// accessed using log.FromContext(ctx).
func RepackLoggerToContext(ctx context.Context, r *rest.Request) context.Context {
	return log.WithContext(ctx,
		requestlog.GetRequestLogger(r))
}

// RepackRequestIdToContext can be used to attach a request ID assigned by
// RequestIdMiddleware to context. Request ID can later be accessed using
// requestid.FromContext(ctx).
func RepackRequestIdToContext(ctx context.Context, r *rest.Request) context.Context {
	return requestid.WithContext(ctx,
		requestid.GetReqId(r))
}

// UpdateContextFunc is a function that can update context ctx using data from
// rest.Request and return modified context.
type UpdateContextFunc func(ctx context.Context, r *rest.Request) context.Context

// UpdateContextMiddleware is a middleware that can be used to update
// http.Request context. The middleware will apply user provided context
// modifications listed in Updates. The middleware operates on rest.Request and
// context is owned/assigned to http.Request. Because of this a new rest.Request
// will be allocated before passing it further in the stack.
//
// When combined with RepackRequestIdToContext and RepackLoggerToContext, the
// middleware will populate http.Request context with both request ID and
// request specific logger, Later it is possible to call
// log.FromContext(r.Context()) to obtain context logger or
// requestid.FromContext(r.Context()) to get request ID.
type UpdateContextMiddleware struct {
	Updates []UpdateContextFunc
}

func (ucmw *UpdateContextMiddleware) MiddlewareFunc(h rest.HandlerFunc) rest.HandlerFunc {
	return func(w rest.ResponseWriter, r *rest.Request) {

		ctx := r.Context()
		for _, up := range ucmw.Updates {
			ctx = up(ctx, r)
		}

		r.Request = r.WithContext(ctx)

		h(w, r)
	}
}