-
Notifications
You must be signed in to change notification settings - Fork 126
/
txn_record.go
374 lines (338 loc) · 10.5 KB
/
txn_record.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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
// Copyright (c) 2018 Cisco and/or its affiliates.
//
// 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 api
import (
"fmt"
"strings"
"time"
"github.com/ligato/vpp-agent/plugins/kvscheduler/internal/utils"
)
// TxnType differentiates between NB transaction, retry of failed operations and
// SB notification. Once queued, all three different operations are classified
// as transactions, only with different parameters.
type TxnType int
const (
// SBNotification is notification from southbound.
SBNotification TxnType = iota
// NBTransaction is transaction from northbound.
NBTransaction
// RetryFailedOps is a transaction re-trying failed operations from previous
// northbound transaction.
RetryFailedOps
)
// String returns human-readable string representation of the transaction type.
func (t TxnType) String() string {
switch t {
case SBNotification:
return "SB Notification"
case NBTransaction:
return "NB Transaction"
case RetryFailedOps:
return "Retry Transaction"
}
return "UndefinedTxnType"
}
// RecordedTxn is used to record executed transaction.
type RecordedTxn struct {
PreRecord bool // not yet fully recorded, only args + plan + pre-processing errors
WithSimulation bool
// timestamps
Start time.Time
Stop time.Time
// arguments
SeqNum uint64
TxnType TxnType
ResyncType ResyncType
Description string
RetryForTxn uint64
RetryAttempt int
Values []RecordedKVPair
// operations
Planned RecordedTxnOps
Executed RecordedTxnOps
}
// RecordedTxnOp is used to record executed/planned transaction operation.
type RecordedTxnOp struct {
// identification
Operation TxnOperation
Key string
// changes
PrevValue *utils.RecordedProtoMessage
NewValue *utils.RecordedProtoMessage
PrevState ValueState
NewState ValueState
PrevErr error
NewErr error
NOOP bool
// flags
IsDerived bool
IsProperty bool
IsRevert bool
IsRetry bool
IsRecreate bool
}
// RecordedKVPair is used to record key-value pair.
type RecordedKVPair struct {
Key string
Value *utils.RecordedProtoMessage
Origin ValueOrigin
}
// RecordedTxnOps is a list of recorded executed/planned transaction operations.
type RecordedTxnOps []*RecordedTxnOp
// RecordedTxns is a list of recorded transactions.
type RecordedTxns []*RecordedTxn
// String returns a *multi-line* human-readable string representation of recorded transaction.
func (txn *RecordedTxn) String() string {
return txn.StringWithOpts(false, false, 0)
}
// StringWithOpts allows to format string representation of recorded transaction.
func (txn *RecordedTxn) StringWithOpts(resultOnly, verbose bool, indent int) string {
var str string
indent1 := strings.Repeat(" ", indent)
indent2 := strings.Repeat(" ", indent+4)
indent3 := strings.Repeat(" ", indent+8)
if !resultOnly {
// transaction arguments
str += indent1 + "* transaction arguments:\n"
str += indent2 + fmt.Sprintf("- seqNum: %d\n", txn.SeqNum)
if txn.TxnType == NBTransaction && txn.ResyncType != NotResync {
ResyncType := "Full Resync"
if txn.ResyncType == DownstreamResync {
ResyncType = "SB Sync"
}
if txn.ResyncType == UpstreamResync {
ResyncType = "NB Sync"
}
str += indent2 + fmt.Sprintf("- type: %s, %s\n", txn.TxnType.String(), ResyncType)
} else {
if txn.TxnType == RetryFailedOps {
str += indent2 + fmt.Sprintf("- type: %s (for txn %d, attempt #%d)\n",
txn.TxnType.String(), txn.RetryForTxn, txn.RetryAttempt)
} else {
str += indent2 + fmt.Sprintf("- type: %s\n", txn.TxnType.String())
}
}
if txn.Description != "" {
descriptionLines := strings.Split(txn.Description, "\n")
for idx, line := range descriptionLines {
if idx == 0 {
str += indent2 + fmt.Sprintf("- Description: %s\n", line)
} else {
str += indent3 + fmt.Sprintf("%s\n", line)
}
}
}
if txn.ResyncType == DownstreamResync {
goto printOps
}
if len(txn.Values) == 0 {
str += indent2 + fmt.Sprintf("- values: NONE\n")
} else {
str += indent2 + fmt.Sprintf("- values:\n")
}
for _, kv := range txn.Values {
if txn.ResyncType != NotResync && kv.Origin == FromSB {
// do not print SB values updated during resync
continue
}
str += indent3 + fmt.Sprintf("- key: %s\n", kv.Key)
str += indent3 + fmt.Sprintf(" val: %s\n", utils.ProtoToString(kv.Value))
}
printOps:
// planned operations
if txn.WithSimulation {
str += indent1 + "* planned operations:\n"
str += txn.Planned.StringWithOpts(verbose, indent+4)
}
}
if !txn.PreRecord {
if len(txn.Executed) == 0 {
str += indent1 + "* executed operations:\n"
} else {
str += indent1 + fmt.Sprintf("* executed operations (%s -> %s, dur: %s):\n",
txn.Start.Round(time.Millisecond),
txn.Stop.Round(time.Millisecond),
txn.Stop.Sub(txn.Start).Round(time.Millisecond))
}
str += txn.Executed.StringWithOpts(verbose, indent+4)
}
return str
}
// String returns a *multi-line* human-readable string representation of a recorded
// transaction operation.
func (op *RecordedTxnOp) String() string {
return op.StringWithOpts(0, false, 0)
}
// StringWithOpts allows to format string representation of a transaction operation.
func (op *RecordedTxnOp) StringWithOpts(index int, verbose bool, indent int) string {
var str string
indent1 := strings.Repeat(" ", indent)
indent2 := strings.Repeat(" ", indent+4)
var flags []string
// operation flags
if op.IsDerived && !op.IsProperty {
flags = append(flags, "DERIVED")
}
if op.IsProperty {
flags = append(flags, "PROPERTY")
}
if op.NOOP {
flags = append(flags, "NOOP")
}
if op.IsRevert && !op.IsProperty {
flags = append(flags, "REVERT")
}
if op.IsRetry && !op.IsProperty {
flags = append(flags, "RETRY")
}
if op.IsRecreate {
flags = append(flags, "RECREATE")
}
// value state transition
// -> OBTAINED
if op.NewState == ValueState_OBTAINED {
flags = append(flags, "OBTAINED")
}
if op.PrevState == ValueState_OBTAINED && op.PrevState != op.NewState {
flags = append(flags, "WAS-OBTAINED")
}
// -> UNIMPLEMENTED
if op.NewState == ValueState_UNIMPLEMENTED {
flags = append(flags, "UNIMPLEMENTED")
}
if op.PrevState == ValueState_UNIMPLEMENTED && op.PrevState != op.NewState {
flags = append(flags, "WAS-UNIMPLEMENTED")
}
// -> REMOVED / MISSING
if op.PrevState == ValueState_REMOVED && op.Operation == TxnOperation_DELETE {
flags = append(flags, "ALREADY-REMOVED")
}
if op.PrevState == ValueState_MISSING {
if op.NewState == ValueState_REMOVED {
flags = append(flags, "ALREADY-MISSING")
} else {
flags = append(flags, "WAS-MISSING")
}
}
// -> DISCOVERED
if op.PrevState == ValueState_DISCOVERED {
flags = append(flags, "DISCOVERED")
}
// -> PENDING
if op.PrevState == ValueState_PENDING {
if op.NewState == ValueState_PENDING {
flags = append(flags, "STILL-PENDING")
} else {
flags = append(flags, "WAS-PENDING")
}
} else {
if op.NewState == ValueState_PENDING {
flags = append(flags, "IS-PENDING")
}
}
// -> FAILED / INVALID
if op.PrevState == ValueState_FAILED {
if op.NewState == ValueState_FAILED {
flags = append(flags, "STILL-FAILING")
} else if op.NewState == ValueState_CONFIGURED {
flags = append(flags, "FIXED")
}
} else {
if op.NewState == ValueState_FAILED {
flags = append(flags, "FAILED")
}
}
if op.PrevState == ValueState_INVALID {
if op.NewState == ValueState_INVALID {
flags = append(flags, "STILL-INVALID")
} else if op.NewState == ValueState_CONFIGURED {
flags = append(flags, "FIXED")
}
} else {
if op.NewState == ValueState_INVALID {
flags = append(flags, "INVALID")
}
}
if index > 0 {
if len(flags) == 0 {
str += indent1 + fmt.Sprintf("%d. %s:\n", index, op.Operation.String())
} else {
str += indent1 + fmt.Sprintf("%d. %s %v:\n", index, op.Operation.String(), flags)
}
} else {
if len(flags) == 0 {
str += indent1 + fmt.Sprintf("%s:\n", op.Operation.String())
} else {
str += indent1 + fmt.Sprintf("%s %v:\n", op.Operation.String(), flags)
}
}
str += indent2 + fmt.Sprintf("- key: %s\n", op.Key)
if op.Operation == TxnOperation_UPDATE {
str += indent2 + fmt.Sprintf("- prev-value: %s \n", utils.ProtoToString(op.PrevValue))
str += indent2 + fmt.Sprintf("- new-value: %s \n", utils.ProtoToString(op.NewValue))
}
if op.Operation == TxnOperation_DELETE {
str += indent2 + fmt.Sprintf("- value: %s \n", utils.ProtoToString(op.PrevValue))
}
if op.Operation == TxnOperation_CREATE {
str += indent2 + fmt.Sprintf("- value: %s \n", utils.ProtoToString(op.NewValue))
}
if op.PrevErr != nil {
str += indent2 + fmt.Sprintf("- prev-error: %s\n", utils.ErrorToString(op.PrevErr))
}
if op.NewErr != nil {
str += indent2 + fmt.Sprintf("- error: %s\n", utils.ErrorToString(op.NewErr))
}
if verbose {
str += indent2 + fmt.Sprintf("- prev-state: %s \n", op.PrevState.String())
str += indent2 + fmt.Sprintf("- new-state: %s \n", op.NewState.String())
}
return str
}
// String returns a *multi-line* human-readable string representation of transaction
// operations.
func (ops RecordedTxnOps) String() string {
return ops.StringWithOpts(false, 0)
}
// StringWithOpts allows to format string representation of transaction operations.
func (ops RecordedTxnOps) StringWithOpts(verbose bool, indent int) string {
if len(ops) == 0 {
return strings.Repeat(" ", indent) + "<NONE>\n"
}
var str string
for idx, op := range ops {
str += op.StringWithOpts(idx+1, verbose, indent)
}
return str
}
// String returns a *multi-line* human-readable string representation of a transaction
// list.
func (txns RecordedTxns) String() string {
return txns.StringWithOpts(false, false, 0)
}
// StringWithOpts allows to format string representation of a transaction list.
func (txns RecordedTxns) StringWithOpts(resultOnly, verbose bool, indent int) string {
if len(txns) == 0 {
return strings.Repeat(" ", indent) + "<NONE>\n"
}
var str string
for idx, txn := range txns {
str += strings.Repeat(" ", indent) + fmt.Sprintf("Transaction #%d:\n", txn.SeqNum)
str += txn.StringWithOpts(resultOnly, verbose, indent+4)
if idx < len(txns)-1 {
str += "\n"
}
}
return str
}