-
Notifications
You must be signed in to change notification settings - Fork 1
/
state.go
285 lines (238 loc) · 7.06 KB
/
state.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
package sync
import (
"context"
"encoding/json"
"fmt"
"sync"
"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
"go.uber.org/zap"
)
type State interface {
PushAction(ctx context.Context, action Action)
FinishAction(ctx context.Context)
NextPage(ctx context.Context, pageToken string) error
ResourceTypeID(ctx context.Context) string
ResourceID(ctx context.Context) string
ParentResourceID(ctx context.Context) string
ParentResourceTypeID(ctx context.Context) string
PageToken(ctx context.Context) string
Current() *Action
Marshal() (string, error)
Unmarshal(input string) error
}
// ActionOp represents a sync operation.
type ActionOp uint8
// String() returns the string representation for an ActionOp. This is used for marshalling the op.
func (s ActionOp) String() string {
switch s {
case InitOp:
return "init"
case SyncResourceTypesOp:
return "list-resource-types"
case SyncResourcesOp:
return "list-resources"
case SyncEntitlementsOp:
return "list-entitlements"
case SyncGrantsOp:
return "list-grants"
case SyncAssetsOp:
return "fetch-assets"
default:
return "unknown"
}
}
// MarshalJSON marshals the ActionOp insto a json string.
func (s *ActionOp) MarshalJSON() ([]byte, error) {
return json.Marshal(s.String())
}
// UnmarshalJSON unmarshal's the input byte slice and updates this action op.
func (s *ActionOp) UnmarshalJSON(data []byte) error {
var v string
err := json.Unmarshal(data, &v)
if err != nil {
return err
}
*s = newActionOp(v)
return nil
}
// newActionOp returns a new ActionOp given a string name. This is useful for unmarshalling.
func newActionOp(str string) ActionOp {
switch str {
case InitOp.String():
return InitOp
case SyncResourceTypesOp.String():
return SyncResourceTypesOp
case SyncResourcesOp.String():
return SyncResourcesOp
case SyncEntitlementsOp.String():
return SyncEntitlementsOp
case SyncGrantsOp.String():
return SyncGrantsOp
case SyncAssetsOp.String():
return SyncAssetsOp
default:
return UnknownOp
}
}
const (
UnknownOp ActionOp = iota
InitOp
SyncResourceTypesOp
SyncResourcesOp
SyncEntitlementsOp
ListResourcesForEntitlementsOp
SyncGrantsOp
SyncAssetsOp
)
// Action stores the current operation, page token, and optional fields for which resource is being worked with.
type Action struct {
Op ActionOp `json:"operation,omitempty"`
PageToken string `json:"page_token,omitempty"`
ResourceTypeID string `json:"resource_type_id,omitempty"`
ResourceID string `json:"resource_id,omitempty"`
ParentResourceTypeID string `json:"parent_resource_type_id,omitempty"`
ParentResourceID string `json:"parent_resource_id,omitempty"`
}
// state is an object used for tracking the current status of a connector sync. It operates like a stack.
type state struct {
mtx sync.RWMutex
actions []Action
currentAction *Action
}
// serializedToken is used to serialize the token to JSON. This separate object is used to avoid having exported fields
// on the object used externally. We should interface this, probably.
type serializedToken struct {
Actions []Action `json:"actions"`
CurrentAction *Action `json:"current_action"`
}
// push adds a new action to the stack. If there is no current state, the action is directly set to current, else
// the current state is appened to the slice of actions, and the new action is set to current.
func (st *state) push(action Action) {
st.mtx.Lock()
defer st.mtx.Unlock()
if st.currentAction == nil {
st.currentAction = &action
return
}
st.actions = append(st.actions, *st.currentAction)
st.currentAction = &action
}
// pop returns nil if there is no current action. Otherwise it returns the current action, and replace it with the last
// item in the actions slice.
func (st *state) pop() *Action {
st.mtx.Lock()
defer st.mtx.Unlock()
if st.currentAction == nil {
return nil
}
ret := *st.currentAction
if len(st.actions) > 0 {
st.currentAction = &st.actions[len(st.actions)-1]
st.actions = st.actions[:len(st.actions)-1]
} else {
st.currentAction = nil
}
return &ret
}
// Current returns nil if there is no current action. Otherwise it returns a pointer to a copy of the current state.
func (st *state) Current() *Action {
st.mtx.RLock()
defer st.mtx.RUnlock()
if st.currentAction == nil {
return nil
}
current := *st.currentAction
return ¤t
}
// Unmarshal takes an input string and unmarshals it onto the state object. If the input is empty, we set the state to
// have an init action.
func (st *state) Unmarshal(input string) error {
st.mtx.RLock()
defer st.mtx.RUnlock()
token := serializedToken{}
if input != "" {
err := json.Unmarshal([]byte(input), &token)
if err != nil {
return fmt.Errorf("syncer token corrust: %w", err)
}
st.actions = token.Actions
st.currentAction = token.CurrentAction
} else {
st.actions = nil
st.currentAction = &Action{Op: InitOp}
}
return nil
}
// Marshal returns a string encoding of the state object. This is useful for datastores to checkpoint the current state.
func (st *state) Marshal() (string, error) {
st.mtx.RLock()
defer st.mtx.RUnlock()
data, err := json.Marshal(serializedToken{
Actions: st.actions,
CurrentAction: st.currentAction,
})
if err != nil {
return "", err
}
return string(data), nil
}
// PushAction adds a new action to the stack.
func (st *state) PushAction(ctx context.Context, action Action) {
st.push(action)
ctxzap.Extract(ctx).Debug("pushing action", zap.Any("action", action))
}
// FinishAction pops the current action from the state.
func (st *state) FinishAction(ctx context.Context) {
action := st.pop()
ctxzap.Extract(ctx).Debug("finishing action", zap.Any("action", action))
}
// NextPage pops the current action, and pushes a copy of it with the provided page token. This is useful for paginating
// requests.
func (st *state) NextPage(ctx context.Context, pageToken string) error {
action := st.pop()
if action == nil {
return fmt.Errorf("no active syncer action")
}
action.PageToken = pageToken
st.push(*action)
ctxzap.Extract(ctx).Debug("pushing next page action", zap.Any("action", action))
return nil
}
// PageToken returns the page token for the current action.
func (st *state) PageToken(ctx context.Context) string {
c := st.Current()
if c == nil {
panic("no current state")
}
return c.PageToken
}
// ResourceTypeID returns the resource type id for the current action.
func (st *state) ResourceTypeID(ctx context.Context) string {
c := st.Current()
if c == nil {
panic("no current state")
}
return c.ResourceTypeID
}
// ResourceID returns the resource ID for the current action.
func (st *state) ResourceID(ctx context.Context) string {
c := st.Current()
if c == nil {
panic("no current state")
}
return c.ResourceID
}
func (st *state) ParentResourceID(ctx context.Context) string {
c := st.Current()
if c == nil {
panic("no current state")
}
return c.ParentResourceID
}
func (st *state) ParentResourceTypeID(ctx context.Context) string {
c := st.Current()
if c == nil {
panic("no current state")
}
return c.ParentResourceTypeID
}