/
messages.go
205 lines (178 loc) · 6.17 KB
/
messages.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
package messages
import (
"encoding/json"
"fmt"
"os"
"sync"
"time"
"github.com/ActiveState/cli/internal/config"
"github.com/ActiveState/cli/internal/constants"
"github.com/ActiveState/cli/internal/errs"
"github.com/ActiveState/cli/internal/fileutils"
"github.com/ActiveState/cli/internal/graph"
"github.com/ActiveState/cli/internal/httputil"
"github.com/ActiveState/cli/internal/logging"
"github.com/ActiveState/cli/internal/poller"
"github.com/ActiveState/cli/internal/strutils"
auth "github.com/ActiveState/cli/pkg/platform/authentication"
"github.com/ActiveState/cli/pkg/sysinfo"
"github.com/blang/semver"
)
const ConfigKeyLastReport = "messages.last_reported"
type Messages struct {
cfg *config.Instance
auth *auth.Auth
baseParams *ConditionParams
poll *poller.Poller
checkMutex sync.Mutex
}
func New(cfg *config.Instance, auth *auth.Auth) (*Messages, error) {
osVersion, err := sysinfo.OSVersion()
if err != nil {
return nil, errs.Wrap(err, "Could not get OS version")
}
stateVersion, err := semver.Parse(constants.Version)
if err != nil {
return nil, errs.Wrap(err, "Could not parse state version")
}
poll := poller.New(1*time.Hour, func() (interface{}, error) {
resp, err := fetch()
return resp, err
})
return &Messages{
baseParams: &ConditionParams{
OS: sysinfo.OS().String(),
OSVersion: NewVersionFromSysinfo(osVersion),
StateChannel: constants.ChannelName,
StateVersion: NewVersionFromSemver(stateVersion),
},
cfg: cfg,
auth: auth,
poll: poll,
}, nil
}
func (m *Messages) Close() error {
m.poll.Close()
return nil
}
func (m *Messages) Check(command string, flags []string) ([]*graph.MessageInfo, error) {
// Prevent multiple checks at the same time, which could lead to the same message showing multiple times
m.checkMutex.Lock()
defer m.checkMutex.Unlock()
cacheValue := m.poll.ValueFromCache()
if cacheValue == nil {
return []*graph.MessageInfo{}, nil
}
allMessages := cacheValue.([]*graph.MessageInfo)
conditionParams := *m.baseParams // copy
conditionParams.UserEmail = m.auth.Email()
conditionParams.UserName = m.auth.WhoAmI()
conditionParams.Command = command
conditionParams.Flags = flags
if id := m.auth.UserID(); id != nil {
conditionParams.UserID = id.String()
}
logging.Debug("Checking %d messages with params: %#v", len(allMessages), conditionParams)
lastReportMap := m.cfg.GetStringMap(ConfigKeyLastReport)
msgs, err := check(&conditionParams, allMessages, lastReportMap, time.Now())
if err != nil {
return nil, errs.Wrap(err, "Could not check messages")
}
for _, msg := range msgs {
lastReportMap[msg.ID] = time.Now().Format(time.RFC3339)
}
if err := m.cfg.Set(ConfigKeyLastReport, lastReportMap); err != nil {
return nil, errs.Wrap(err, "Could not save last reported messages")
}
return msgs, nil
}
func check(params *ConditionParams, messages []*graph.MessageInfo, lastReportMap map[string]interface{}, baseTime time.Time) ([]*graph.MessageInfo, error) {
funcMap := conditionFuncMap()
filteredMessages := []*graph.MessageInfo{}
for _, message := range messages {
logging.Debug("Checking message %s", message.ID)
// Ensure we don't show the same message too often
if lastReport, ok := lastReportMap[message.ID]; ok {
lastReportTime, err := time.Parse(time.RFC3339, lastReport.(string))
if err != nil {
return nil, errs.New("Could not parse last reported time for message %s as it's not a valid RFC3339 value: %v", message.ID, lastReport)
}
lastReportTimeAgo := baseTime.Sub(lastReportTime)
showMessage, err := repeatValid(message.Repeat, lastReportTimeAgo)
if err != nil {
return nil, errs.Wrap(err, "Could not validate repeat for message %s", message.ID)
}
if !showMessage {
logging.Debug("Skipping message %s as it was shown %s ago", message.ID, lastReportTimeAgo)
continue
}
}
// Validate the conditional
if message.Condition != "" {
result, err := strutils.ParseTemplate(fmt.Sprintf(`{{%s}}`, message.Condition), params, funcMap)
if err != nil {
return nil, errs.Wrap(err, "Could not parse condition template for message %s", message.ID)
}
if result == "true" {
logging.Debug("Including message %s as condition %s evaluated to %s", message.ID, message.Condition, result)
filteredMessages = append(filteredMessages, message)
} else {
logging.Debug("Skipping message %s as condition %s evaluated to %s", message.ID, message.Condition, result)
}
} else {
logging.Debug("Including message %s as it has no condition", message.ID)
filteredMessages = append(filteredMessages, message)
}
}
return filteredMessages, nil
}
func fetch() ([]*graph.MessageInfo, error) {
var body []byte
var err error
if v := os.Getenv(constants.MessagesOverrideEnvVarName); v != "" {
body, err = fileutils.ReadFile(v)
if err != nil {
return nil, errs.Wrap(err, "Could not read messages override file")
}
} else {
body, err = httputil.Get(constants.MessagesInfoURL)
if err != nil {
return nil, errs.Wrap(err, "Could not fetch messages information")
}
}
var messages []*graph.MessageInfo
if err := json.Unmarshal(body, &messages); err != nil {
return nil, errs.Wrap(err, "Could not unmarshall messages information")
}
// Set defaults
for _, message := range messages {
if message.Placement == "" {
message.Placement = graph.MessagePlacementTypeBeforeCmd
}
if message.Interrupt == "" {
message.Interrupt = graph.MessageInterruptTypeDisabled
}
if message.Repeat == "" {
message.Repeat = graph.MessageRepeatTypeDisabled
}
}
return messages, nil
}
func repeatValid(repeatType graph.MessageRepeatType, lastReportTimeAgo time.Duration) (bool, error) {
switch repeatType {
case graph.MessageRepeatTypeConstantly:
return true, nil
case graph.MessageRepeatTypeDisabled:
return false, nil
case graph.MessageRepeatTypeHourly:
return lastReportTimeAgo >= time.Hour, nil
case graph.MessageRepeatTypeDaily:
return lastReportTimeAgo >= 24*time.Hour, nil
case graph.MessageRepeatTypeWeekly:
return lastReportTimeAgo >= 7*24*time.Hour, nil
case graph.MessageRepeatTypeMonthly:
return lastReportTimeAgo >= 30*24*time.Hour, nil
default:
return false, errs.New("Unknown repeat type: %s", repeatType)
}
}