forked from NdoleStudio/httpsms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbilling_service.go
More file actions
241 lines (195 loc) · 8.72 KB
/
Copy pathbilling_service.go
File metadata and controls
241 lines (195 loc) · 8.72 KB
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
package services
import (
"context"
"fmt"
"time"
"github.com/NdoleStudio/httpsms/pkg/cache"
"github.com/NdoleStudio/httpsms/pkg/emails"
"github.com/NdoleStudio/httpsms/pkg/entities"
"github.com/NdoleStudio/httpsms/pkg/repositories"
"github.com/NdoleStudio/httpsms/pkg/telemetry"
"github.com/google/uuid"
"github.com/palantir/stacktrace"
)
// BillingService is responsible for tracking usages and billing users
type BillingService struct {
service
logger telemetry.Logger
tracer telemetry.Tracer
cache cache.Cache
emailFactory emails.UserEmailFactory
mailer emails.Mailer
userRepository repositories.UserRepository
billingUsageRepository repositories.BillingUsageRepository
}
// NewBillingService creates a new BillingService
func NewBillingService(
logger telemetry.Logger,
tracer telemetry.Tracer,
cache cache.Cache,
mailer emails.Mailer,
emailFactory emails.UserEmailFactory,
usageRepository repositories.BillingUsageRepository,
userRepository repositories.UserRepository,
) (s *BillingService) {
return &BillingService{
logger: logger.WithService(fmt.Sprintf("%T", s)),
tracer: tracer,
cache: cache,
emailFactory: emailFactory,
mailer: mailer,
userRepository: userRepository,
billingUsageRepository: usageRepository,
}
}
// IsEntitledWithCount checks if a user can send or receive and SMS message
func (service *BillingService) IsEntitledWithCount(ctx context.Context, userID entities.UserID, count uint) *string {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
user, err := service.userRepository.Load(ctx, userID)
if err != nil {
msg := fmt.Sprintf("cannot load user with ID [%s], entitlement successfull", userID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return nil
}
usage, err := service.billingUsageRepository.GetCurrent(ctx, userID)
if err != nil {
msg := fmt.Sprintf("cannot load billing usage for user with ID [%s], entitlement successfull", userID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return nil
}
if !usage.IsEntitled(count, user.SubscriptionName.Limit()) {
return service.handleLimitExceeded(ctx, user)
}
return nil
}
// IsEntitled checks if a user can send or receive and SMS message
func (service *BillingService) IsEntitled(ctx context.Context, userID entities.UserID) *string {
return service.IsEntitledWithCount(ctx, userID, 1)
}
func (service *BillingService) handleLimitExceeded(ctx context.Context, user *entities.User) *string {
ctx, span := service.tracer.Start(ctx)
defer span.End()
service.sendLimitExceededEmail(ctx, user)
message := fmt.Sprintf(
"You have exceeded your limit of [%d] messages on your [%s] plan. Upgrade to send more messages on https://httpsms.com/billing",
user.SubscriptionName.Limit(),
user.SubscriptionName,
)
return &message
}
func (service *BillingService) sendLimitExceededEmail(ctx context.Context, user *entities.User) {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
key := fmt.Sprintf("user.limit.exceeded.%s", user.ID)
if _, err := service.cache.Get(ctx, key); err == nil {
return
}
email, err := service.emailFactory.UsageLimitExceeded(user)
if err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot create usage limit email for user [%s]", user.ID)))
return
}
if err = service.mailer.Send(ctx, email); err != nil {
msg := fmt.Sprintf("canot send usage limit exceeded notification to user [%s]", user.ID)
ctxLogger.Error(stacktrace.Propagate(err, msg))
return
}
ctxLogger.Info(fmt.Sprintf("usage limit exceeded email sent to user [%s]", user.ID))
if err = service.cache.Set(ctx, key, "", time.Hour*12); err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot set item in redis with key [%s]", key)))
}
}
// GetCurrentUsage gets the current billing usage for a user
func (service *BillingService) GetCurrentUsage(ctx context.Context, userID entities.UserID) (*entities.BillingUsage, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
return service.billingUsageRepository.GetCurrent(ctx, userID)
}
// GetUsageHistory gets the billing usage history for a user
func (service *BillingService) GetUsageHistory(ctx context.Context, userID entities.UserID, params repositories.IndexParams) (*[]entities.BillingUsage, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
return service.billingUsageRepository.GetHistory(ctx, userID, params)
}
// RegisterSentMessage records the billing usage for a sent message
func (service *BillingService) RegisterSentMessage(ctx context.Context, messageID uuid.UUID, timestamp time.Time, userID entities.UserID) error {
ctx, span := service.tracer.Start(ctx)
defer span.End()
ctxLogger := service.tracer.CtxLogger(service.logger, span)
if err := service.billingUsageRepository.RegisterSentMessage(ctx, timestamp, userID); err != nil {
msg := fmt.Sprintf("could not register [sent] message with ID [%s] for user with ID [%s]", messageID, userID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("registered [sent] message with ID [%s] for user [%s]", messageID, userID))
service.sendUsageAlert(ctx, userID)
return nil
}
// RegisterReceivedMessage records the billing usage for a received message
func (service *BillingService) RegisterReceivedMessage(ctx context.Context, messageID uuid.UUID, timestamp time.Time, userID entities.UserID) error {
ctx, span := service.tracer.Start(ctx)
defer span.End()
ctxLogger := service.tracer.CtxLogger(service.logger, span)
if err := service.billingUsageRepository.RegisterReceivedMessage(ctx, timestamp, userID); err != nil {
msg := fmt.Sprintf("could not register [received] message with ID [%s] for user with ID [%s]", messageID, userID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("registered [received] message with ID [%s] for user [%s]", messageID, userID))
service.sendUsageAlert(ctx, userID)
return nil
}
// DeleteAllForUser deletes all entities.BillingUsage for an entities.UserID.
func (service *BillingService) DeleteAllForUser(ctx context.Context, userID entities.UserID) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
if err := service.billingUsageRepository.DeleteAllForUser(ctx, userID); err != nil {
msg := fmt.Sprintf("could not delete [entities.BillingUsage] for user with ID [%s]", userID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("deleted all [entities.BillingUsage] for user with ID [%s]", userID))
return nil
}
func (service *BillingService) sendUsageAlert(ctx context.Context, userID entities.UserID) {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
user, err := service.userRepository.Load(ctx, userID)
if err != nil {
msg := fmt.Sprintf("cannot load user with ID [%s]", userID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return
}
billingUsage, err := service.billingUsageRepository.GetCurrent(ctx, userID)
if err != nil {
msg := fmt.Sprintf("cannot load billing usage for user with ID [%s]", userID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return
}
if !service.shouldSendAlert(user, billingUsage) {
return
}
email, err := service.emailFactory.UsageLimitAlert(user, billingUsage)
if err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot create usage alert email for user [%s]", user.ID)))
return
}
if err = service.mailer.Send(ctx, email); err != nil {
msg := fmt.Sprintf("canot send usage alert notification to user [%s]", user.ID)
ctxLogger.Error(stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("usage alert email sent to user [%s]", user.ID))
}
func (service *BillingService) shouldSendAlert(user *entities.User, usage *entities.BillingUsage) bool {
if user.IsOnFreePlan() && (usage.TotalMessages() == 160 || usage.TotalMessages() == 180 || usage.TotalMessages() == 190) {
return true
}
if user.IsOnProPlan() && (usage.TotalMessages() == 4000 || usage.TotalMessages() == 4500 || usage.TotalMessages() == 4750) {
return true
}
if user.IsOnUltraPlan() && (usage.TotalMessages() == 8000 || usage.TotalMessages() == 9000 || usage.TotalMessages() == 9500) {
return true
}
if user.IsOn20kPlan() && (usage.TotalMessages() == 16000 || usage.TotalMessages() == 18000 || usage.TotalMessages() == 19000) {
return true
}
return false
}