File: stash_modifier.go

package info (click to toggle)
golang-github-google-martian 3.3.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,324 kB
  • sloc: makefile: 5
file content (79 lines) | stat: -rw-r--r-- 2,442 bytes parent folder | download | duplicates (2)
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
74
75
76
77
78
79
// Copyright 2015 Google Inc. All rights reserved.
//
// 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 stash provides a modifier that stores the request URL in a
// specified header.
package stash

import (
	"encoding/json"
	"fmt"
	"net/http"

	"github.com/google/martian/v3/parse"
)

func init() {
	parse.Register("stash.Modifier", modifierFromJSON)
}

// Modifier adds a header to the request containing the current state of the URL.
// The header will be named with the value stored in headerName.
// There will be no validation done on this header name.
type Modifier struct {
	headerName string
}

type modifierJSON struct {
	HeaderName string               `json:"headerName"`
	Scope      []parse.ModifierType `json:"scope"`
}

// NewModifier returns a RequestModifier that write the current URL into a header.
func NewModifier(headerName string) *Modifier {
	return &Modifier{headerName: headerName}
}

// ModifyRequest writes the current URL into a header.
func (m *Modifier) ModifyRequest(req *http.Request) error {
	req.Header.Set(m.headerName, req.URL.String())
	return nil
}

// ModifyResponse writes the same header written in the request into the response.
func (m *Modifier) ModifyResponse(res *http.Response) error {
	res.Header.Set(m.headerName, res.Request.Header.Get(m.headerName))
	return nil
}

func modifierFromJSON(b []byte) (*parse.Result, error) {
	// If you would like the saved state of the URL to be written in the response you must specify
	// this modifier's scope as both request and response.
	msg := &modifierJSON{}
	if err := json.Unmarshal(b, msg); err != nil {
		return nil, err
	}

	mod := NewModifier(msg.HeaderName)
	r, err := parse.NewResult(mod, msg.Scope)
	if err != nil {
		return nil, err
	}

	if r.ResponseModifier() != nil && r.RequestModifier() == nil {
		return nil, fmt.Errorf("to write header on a response, specify scope as both request and response")
	}

	return r, nil
}