-
Notifications
You must be signed in to change notification settings - Fork 19
/
manual.go
159 lines (131 loc) · 4 KB
/
manual.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
package triggers
import (
"encoding/json"
"github.com/nyaruka/gocommon/jsonx"
"github.com/nyaruka/gocommon/urns"
"github.com/nyaruka/goflow/assets"
"github.com/nyaruka/goflow/envs"
"github.com/nyaruka/goflow/excellent/types"
"github.com/nyaruka/goflow/flows"
"github.com/nyaruka/goflow/utils"
)
func init() {
registerType(TypeManual, readManualTrigger)
}
// TypeManual is the type for manually triggered sessions
const TypeManual string = "manual"
// ManualTrigger is used when a session was triggered manually by a user
//
// {
// "type": "manual",
// "flow": {"uuid": "50c3706e-fedb-42c0-8eab-dda3335714b7", "name": "Registration"},
// "contact": {
// "uuid": "9f7ede93-4b16-4692-80ad-b7dc54a1cd81",
// "name": "Bob",
// "created_on": "2018-01-01T12:00:00.000000Z"
// },
// "user": {"email": "bob@nyaruka.com", "name": "Bob"},
// "origin": "ui",
// "triggered_on": "2000-01-01T00:00:00.000000000-00:00"
// }
//
// @trigger manual
type ManualTrigger struct {
baseTrigger
user *flows.User
origin string
}
// Context for manual triggers always has non-nil params
func (t *ManualTrigger) Context(env envs.Environment) map[string]types.XValue {
c := t.context()
c.user = flows.Context(env, t.user)
c.origin = t.origin
return c.asMap()
}
var _ flows.Trigger = (*ManualTrigger)(nil)
//------------------------------------------------------------------------------------------
// Builder
//------------------------------------------------------------------------------------------
// ManualBuilder is a builder for manual type triggers
type ManualBuilder struct {
t *ManualTrigger
}
// Manual returns a manual trigger builder
func (b *Builder) Manual() *ManualBuilder {
return &ManualBuilder{
t: &ManualTrigger{baseTrigger: newBaseTrigger(TypeManual, b.environment, b.flow, b.contact, nil, false, nil)},
}
}
// WithParams sets the params for the trigger
func (b *ManualBuilder) WithParams(params *types.XObject) *ManualBuilder {
b.t.params = params
return b
}
// WithCall sets the call for the trigger
func (b *ManualBuilder) WithCall(channel *assets.ChannelReference, urn urns.URN) *ManualBuilder {
b.t.call = flows.NewCall(channel, urn)
return b
}
// WithUser sets the user (e.g. an email address, login) for the trigger
func (b *ManualBuilder) WithUser(user *flows.User) *ManualBuilder {
b.t.user = user
return b
}
// WithOrigin sets the origin (e.g. ui, api) for the trigger
func (b *ManualBuilder) WithOrigin(origin string) *ManualBuilder {
b.t.origin = origin
return b
}
// AsBatch sets batch mode on for the trigger
func (b *ManualBuilder) AsBatch() *ManualBuilder {
b.t.batch = true
return b
}
// Build builds the trigger
func (b *ManualBuilder) Build() *ManualTrigger {
return b.t
}
//------------------------------------------------------------------------------------------
// JSON Encoding / Decoding
//------------------------------------------------------------------------------------------
type manualTriggerEnvelope struct {
baseTriggerEnvelope
User *assets.UserReference `json:"user,omitempty" validate:"omitempty,dive"`
Origin string `json:"origin,omitempty"`
}
func readManualTrigger(sa flows.SessionAssets, data json.RawMessage, missing assets.MissingCallback) (flows.Trigger, error) {
e := &manualTriggerEnvelope{}
if err := utils.UnmarshalAndValidate(data, e); err != nil {
return nil, err
}
var user *flows.User
if e.User != nil {
user = sa.Users().Get(e.User.Email)
if user == nil {
missing(e.User, nil)
}
}
t := &ManualTrigger{
user: user,
origin: e.Origin,
}
if err := t.unmarshal(sa, &e.baseTriggerEnvelope, missing); err != nil {
return nil, err
}
return t, nil
}
// MarshalJSON marshals this trigger into JSON
func (t *ManualTrigger) MarshalJSON() ([]byte, error) {
var userRef *assets.UserReference
if t.user != nil {
userRef = t.user.Reference()
}
e := &manualTriggerEnvelope{
User: userRef,
Origin: t.origin,
}
if err := t.marshal(&e.baseTriggerEnvelope); err != nil {
return nil, err
}
return jsonx.Marshal(e)
}