-
Notifications
You must be signed in to change notification settings - Fork 8
/
custom_cmd.go
348 lines (307 loc) · 9.61 KB
/
custom_cmd.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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
// Copyright 2023 Greenmask
//
// 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 custom
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"os"
"os/exec"
"time"
"github.com/rs/zerolog/log"
"golang.org/x/sync/errgroup"
"github.com/greenmaskio/greenmask/internal/db/postgres/transformers/utils"
"github.com/greenmaskio/greenmask/pkg/toolkit"
)
var (
ErrValidationTimeout = errors.New("validation timeout")
)
const (
ValidateArgName = "--validate"
PrintDefinitionArgName = "--print-definition"
TransformArgName = "--transform"
)
func ProduceNewCmdTransformerFunction(ctd *TransformerDefinition) utils.NewTransformerFunc {
return func(
ctx context.Context, driver *toolkit.Driver, parameters map[string]*toolkit.Parameter,
) (utils.Transformer, toolkit.ValidationWarnings, error) {
return NewCustomCmdTransformer(ctx, driver, parameters, ctd)
}
}
type CmdTransformer struct {
*utils.CmdTransformerBase
name string
executable string
args []string
eg *errgroup.Group
driver *toolkit.Driver
parameters map[string]*toolkit.Parameter
affectedColumns map[int]string
ctd *TransformerDefinition
}
func NewCustomCmdTransformer(
ctx context.Context, driver *toolkit.Driver, parameters map[string]*toolkit.Parameter,
ctd *TransformerDefinition,
) (*CmdTransformer, toolkit.ValidationWarnings, error) {
affectedColumns := make(map[int]string)
affectedColumnsIdx, transferringColumnsIdx, err := toolkit.GetAffectedAndTransferringColumns(parameters, driver)
if err != nil {
return nil, nil, fmt.Errorf("error getting affeected and transferring columns: %w", err)
}
for _, c := range affectedColumnsIdx {
affectedColumns[c.Idx] = c.Name
}
api, err := toolkit.NewApi(ctd.Driver, transferringColumnsIdx, affectedColumnsIdx, driver)
if err != nil {
return nil, nil, fmt.Errorf("error creating InteractionApi: %w", err)
}
cct := utils.NewCmdTransformerBase(ctd.Name, ctd.ExpectedExitCode, ctd.RowTransformationTimeout, driver, api)
ct := &CmdTransformer{
CmdTransformerBase: cct,
executable: ctd.Executable,
args: ctd.Args,
driver: driver,
parameters: parameters,
affectedColumns: affectedColumns,
name: ctd.Name,
ctd: ctd,
}
var warnings toolkit.ValidationWarnings
if ctd.Validate {
warnings, err = ct.Validate(ctx)
if err != nil {
return nil, nil, fmt.Errorf("error validating transformer: %w", err)
}
}
return ct, warnings, nil
}
func (ct *CmdTransformer) GetAffectedColumns() map[int]string {
return ct.affectedColumns
}
func (ct *CmdTransformer) Init(ctx context.Context) (err error) {
args := make([]string, len(ct.args))
copy(args, ct.args)
args = append(args, TransformArgName)
err = ct.BaseInit(ct.executable, args)
if err != nil {
return err
}
if err = ct.sendMetadata(); err != nil {
return fmt.Errorf("error sending metadata: %w", err)
}
ct.eg = &errgroup.Group{}
ct.eg.Go(func() error {
return ct.stderrForwarder(ctx)
})
ct.eg.Go(func() error {
if err := ct.Cmd.Wait(); err != nil {
var exitErr *exec.ExitError
if errors.As(err, &exitErr) {
if exitErr.ExitCode() != ct.ctd.ExpectedExitCode {
log.Warn().
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerExitCode", ct.Cmd.ProcessState.ExitCode()).
Msg("unexpected exit code")
return fmt.Errorf("unexpeted transformer exit code: exepected %d received %d",
ct.ctd.ExpectedExitCode, ct.Cmd.ProcessState.ExitCode())
}
return err
} else {
log.Error().
Err(err).
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerPid", ct.Cmd.Process.Pid).
Msg("custom transformer exited with error")
return fmt.Errorf("transformer exited with error: %w", err)
}
}
log.Debug().
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerPid", ct.Cmd.Process.Pid).
Msg("transformer exited normally")
return nil
})
return nil
}
func (ct *CmdTransformer) Validate(ctx context.Context) (toolkit.ValidationWarnings, error) {
args := make([]string, len(ct.args))
copy(args, ct.args)
args = append(args, ValidateArgName)
ct.eg = &errgroup.Group{}
ctx, cancel := context.WithTimeout(ctx, ct.ctd.ValidationTimeout)
defer cancel()
err := ct.BaseInitWithContext(ctx, ct.executable, args)
if err != nil {
return nil, fmt.Errorf("transformer initialisation error: %w", err)
}
if err = ct.sendMetadata(); err != nil {
return nil, fmt.Errorf("error sending metadata: %w", err)
}
ct.eg.Go(func() error {
return ct.stderrForwarder(ctx)
})
ct.eg.Go(func() error {
if err := ct.Cmd.Wait(); err != nil {
log.Error().
Err(err).
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerPid", ct.Cmd.Process.Pid).
Msg("custom transformer exited with error")
return fmt.Errorf("transformer exited with error: %w", err)
}
log.Debug().
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerPid", ct.Cmd.Process.Pid).
Msg("transformer exited normally")
return nil
})
var warnings toolkit.ValidationWarnings
for {
line, err := ct.ReceiveStdoutLine(ctx)
if err != nil {
if errors.Is(err, io.EOF) || errors.Is(err, os.ErrClosed) {
break
}
log.Debug().Err(err).Msg("line reader error")
return nil, err
}
vw := toolkit.NewValidationWarning()
if err := json.Unmarshal(line, &vw); err != nil {
log.Warn().
Err(err).
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerPid", ct.Cmd.Process.Pid).
Str("Data", string(line)).
Msg("error unmarshalling ValidationWarning")
vw = toolkit.NewValidationWarning().
AddMeta("Payload", string(line)).
SetSeverity(toolkit.ErrorValidationSeverity).
SetMsg("error unmarshalling validation warning")
}
warnings = append(warnings, vw)
}
if err = ct.eg.Wait(); err != nil {
if ctx.Err() != nil && errors.Is(ctx.Err(), context.DeadlineExceeded) {
log.Warn().
Err(err).
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerPid", ct.Cmd.Process.Pid).
Dur("ValidationTimeout", ct.ctd.ValidationTimeout).
Msg("validation timeout")
return nil, ErrValidationTimeout
}
return nil, err
}
return warnings, nil
}
func (ct *CmdTransformer) Done(ctx context.Context) error {
if err := ct.BaseDone(); err != nil {
return err
}
if err := ct.eg.Wait(); err != nil {
log.Warn().
Err(err).
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Msg("one of custom transformer goroutine exited with error")
return fmt.Errorf("one of custom transformer goroutine exited with error: %w", err)
}
return nil
}
func (ct *CmdTransformer) getMetadata() ([]byte, error) {
params := make(toolkit.Params)
for name, p := range ct.parameters {
params[name] = p.RawValue()
}
meta := &toolkit.Meta{
Table: ct.driver.Table,
Parameters: params,
Types: ct.driver.CustomTypes,
}
res, err := json.Marshal(&meta)
if err != nil {
return nil, fmt.Errorf("cannot marshal metadata: %w", err)
}
return res, nil
}
func (ct *CmdTransformer) stderrForwarder(ctx context.Context) error {
t := time.NewTicker(500 * time.Millisecond)
lineNum := 0
// This is required for convenient verbosity of output.
// Write "stderr forwarding" log message each 500ms otherwise just print received stderr data
// If it does not use this logic each line would be covered with "stderr forwarding" message and it will be
// complicated to recognize the traceback or multiline message
for {
line, _, err := ct.StderrReader.ReadLine()
if err != nil {
if errors.Is(err, io.EOF) || errors.Is(err, os.ErrClosed) {
return nil
}
log.Debug().Err(err).Msg("line reader error")
return err
}
if lineNum == 0 {
log.Warn().
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Int("TransformerPid", ct.Cmd.Process.Pid).
Msg("stderr forwarding")
}
fmt.Printf("\tDATA: %s\n", string(line))
select {
case <-ctx.Done():
return nil
case <-t.C:
lineNum = 0
default:
}
lineNum++
}
}
func (ct *CmdTransformer) sendMetadata() error {
meta, err := ct.getMetadata()
if err != nil {
return err
}
log.Debug().
RawJSON("Meta", meta).
Str("TableSchema", ct.driver.Table.Schema).
Str("TableName", ct.driver.Table.Name).
Str("TransformerName", ct.name).
Msg("running transformer with metadata")
meta = append(meta, '\n')
_, err = ct.StdinWriter.Write(meta)
if err != nil {
return fmt.Errorf("error writing metatda to stdin: %w", err)
}
return nil
}