/
encode.go
188 lines (154 loc) · 4.5 KB
/
encode.go
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
package processor
import (
"bytes"
"encoding/ascii85"
"encoding/base64"
"encoding/hex"
"fmt"
"time"
"github.com/Jeffail/benthos/v3/internal/docs"
"github.com/Jeffail/benthos/v3/internal/tracing"
"github.com/Jeffail/benthos/v3/lib/log"
"github.com/Jeffail/benthos/v3/lib/metrics"
"github.com/Jeffail/benthos/v3/lib/response"
"github.com/Jeffail/benthos/v3/lib/types"
"github.com/tilinna/z85"
)
//------------------------------------------------------------------------------
func init() {
Constructors[TypeEncode] = TypeSpec{
constructor: NewEncode,
Status: docs.StatusDeprecated,
Footnotes: `
## Alternatives
All functionality of this processor has been superseded by the
[bloblang](/docs/components/processors/bloblang) processor.`,
FieldSpecs: docs.FieldSpecs{
docs.FieldCommon("scheme", "The decoding scheme to use.").HasOptions("hex", "base64", "ascii85", "z85"),
PartsFieldSpec,
},
}
}
//------------------------------------------------------------------------------
// EncodeConfig contains configuration fields for the Encode processor.
type EncodeConfig struct {
Scheme string `json:"scheme" yaml:"scheme"`
Parts []int `json:"parts" yaml:"parts"`
}
// NewEncodeConfig returns a EncodeConfig with default values.
func NewEncodeConfig() EncodeConfig {
return EncodeConfig{
Scheme: "base64",
Parts: []int{},
}
}
//------------------------------------------------------------------------------
type encodeFunc func(bytes []byte) ([]byte, error)
func base64Encode(b []byte) ([]byte, error) {
var buf bytes.Buffer
e := base64.NewEncoder(base64.StdEncoding, &buf)
e.Write(b)
e.Close()
return buf.Bytes(), nil
}
func hexEncode(b []byte) ([]byte, error) {
var buf bytes.Buffer
e := hex.NewEncoder(&buf)
if _, err := e.Write(b); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func ascii85Encode(b []byte) ([]byte, error) {
var buf bytes.Buffer
e := ascii85.NewEncoder(&buf)
if _, err := e.Write(b); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func z85Encode(b []byte) ([]byte, error) {
enc := make([]byte, z85.EncodedLen(len(b)))
if _, err := z85.Encode(enc, b); err != nil {
return nil, err
}
return enc, nil
}
func strToEncoder(str string) (encodeFunc, error) {
switch str {
case "base64":
return base64Encode, nil
case "hex":
return hexEncode, nil
case "ascii85":
return ascii85Encode, nil
case "z85":
return z85Encode, nil
}
return nil, fmt.Errorf("encode scheme not recognised: %v", str)
}
//------------------------------------------------------------------------------
// Encode is a processor that can selectively encode parts of a message
// following a chosen scheme.
type Encode struct {
conf EncodeConfig
fn encodeFunc
log log.Modular
stats metrics.Type
mCount metrics.StatCounter
mErr metrics.StatCounter
mSent metrics.StatCounter
mBatchSent metrics.StatCounter
}
// NewEncode returns a Encode processor.
func NewEncode(
conf Config, mgr types.Manager, log log.Modular, stats metrics.Type,
) (Type, error) {
cor, err := strToEncoder(conf.Encode.Scheme)
if err != nil {
return nil, err
}
return &Encode{
conf: conf.Encode,
fn: cor,
log: log,
stats: stats,
mCount: stats.GetCounter("count"),
mErr: stats.GetCounter("error"),
mSent: stats.GetCounter("sent"),
mBatchSent: stats.GetCounter("batch.sent"),
}, nil
}
//------------------------------------------------------------------------------
// ProcessMessage applies the processor to a message, either creating >0
// resulting messages or a response to be sent back to the message source.
func (c *Encode) ProcessMessage(msg types.Message) ([]types.Message, types.Response) {
c.mCount.Incr(1)
newMsg := msg.Copy()
proc := func(i int, span *tracing.Span, part types.Part) error {
newPart, err := c.fn(part.Get())
if err == nil {
newMsg.Get(i).Set(newPart)
} else {
c.log.Debugf("Failed to encode message part: %v\n", err)
c.mErr.Incr(1)
}
return err
}
if newMsg.Len() == 0 {
return nil, response.NewAck()
}
IteratePartsWithSpanV2(TypeEncode, c.conf.Parts, newMsg, proc)
c.mBatchSent.Incr(1)
c.mSent.Incr(int64(newMsg.Len()))
msgs := [1]types.Message{newMsg}
return msgs[:], nil
}
// CloseAsync shuts down the processor and stops processing requests.
func (c *Encode) CloseAsync() {
}
// WaitForClose blocks until the processor has closed down.
func (c *Encode) WaitForClose(timeout time.Duration) error {
return nil
}
//------------------------------------------------------------------------------