/
custom_errors.go
469 lines (413 loc) · 12.8 KB
/
custom_errors.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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
package exceptions
import (
"fmt"
"github.com/savannahghi/errorcodeutil"
"github.com/savannahghi/feedlib"
)
// UserNotFoundError returns an error message when a user is not found
func UserNotFoundError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: UserNotFoundErrMsg,
Code: int(errorcodeutil.UserNotFound),
}
}
// ProfileSuspendFoundError is returned is the user profile has been suspended.
func ProfileSuspendFoundError() error {
return &errorcodeutil.CustomError{
Message: ProfileSuspenedFoundErrMsg,
Code: int(errorcodeutil.ProfileSuspended),
}
}
// ProfileNotFoundError returns an error message when a profile is not found
func ProfileNotFoundError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: ProfileNotFoundErrMsg,
Code: int(errorcodeutil.ProfileNotFound),
}
}
// NormalizeMSISDNError returns an error when normalizing the msisdn fails
func NormalizeMSISDNError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: NormalizeMSISDNErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// CheckPhoneNumberExistError check if phone number is registered to another user
func CheckPhoneNumberExistError() error {
return &errorcodeutil.CustomError{
Message: PhoneNumberInUseErrMsg,
Code: int(errorcodeutil.PhoneNumberInUse),
}
}
// CheckEmailExistError returned when the provided email already exists.
func CheckEmailExistError() error {
return &errorcodeutil.CustomError{
Message: EmailInUseErrMsg,
Code: int(errorcodeutil.EmailAddressInUse),
}
}
// InternalServerError returns an error if something wrong happened in performing the operation
func InternalServerError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: InternalServerErrorMsg,
Code: int(errorcodeutil.Internal),
}
}
// PinNotFoundError displays error message when a pin is not found
func PinNotFoundError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: PINNotFoundErrMsg,
Code: int(errorcodeutil.PINNotFound),
}
}
// PinMismatchError displays an error when the supplied PIN
// does not match the PIN stored
func PinMismatchError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: PINMismatchErrMsg,
Code: int(errorcodeutil.PINMismatch),
}
}
// CustomTokenError is the error message displayed when a
// custom token is not created
func CustomTokenError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: CustomTokenErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// AuthenticateTokenError is the error message displayed when a
// custom token is not authenticated
func AuthenticateTokenError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: AuthenticateTokenErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// UpdateProfileError is the error message displayed when a
// user profile cannot be updated
func UpdateProfileError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: UpdateProfileErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// AddRecordError is the error message displayed when a
// record fails to be added to the dataerrorcodeutil
func AddRecordError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: AddRecordErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// RetrieveRecordError is the error message displayed when a
// failure occurs while retrieving records from the dataerrorcodeutil
func RetrieveRecordError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: RetrieveRecordErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// LikelyToRecommendError is the error message displayed that
// occurs when the recommendation threshold is crossed
func LikelyToRecommendError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: LikelyToRecommendErrMsg,
Code: int(errorcodeutil.UndefinedArguments),
}
}
// GenerateAndSendOTPError is the error message displayed when a
// generate and send otp fails
func GenerateAndSendOTPError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: GenerateAndSendOTPErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// CheckUserPINError is the error message displayed when
// a server is unable to check if the user has a PIN
func CheckUserPINError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: CheckUserPINErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// ExistingPINError is the error message displayed when a
// pin record fails to be retrieved from dataerrorcodeutil
func ExistingPINError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: ExistingPINErrMsg,
Code: int(errorcodeutil.PINNotFound),
}
}
// EncryptPINError is the error message displayed when
// pin encryption fails
func EncryptPINError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: EncryptPINErrMsg,
Code: int(errorcodeutil.PINError),
}
}
// ValidatePINDigitsError is the error message displayed when
// invalid pin digits are given
func ValidatePINDigitsError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: ValidatePINDigitsErrMsg,
Code: int(errorcodeutil.PINError),
}
}
// ValidatePINLengthError is the error message displayed when
// an invalid Pin length is given
func ValidatePINLengthError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: ValidatePINLengthErrMsg,
Code: int(errorcodeutil.PINError),
}
}
// InValidPushTokenLengthError is the error message displayed when
// an invalid push token is given
func InValidPushTokenLengthError() error {
return &errorcodeutil.CustomError{
Err: fmt.Errorf("invalid push token length"),
Message: ValidatePushTokenLengthErrMsg,
Code: int(errorcodeutil.InvalidPushTokenLength),
}
}
// WrongEnumTypeError is the error message displayed when
// an invalid enum is given
func WrongEnumTypeError(value string) error {
return &errorcodeutil.CustomError{
Err: fmt.Errorf("%v", WrongEnumErrMsg),
Message: fmt.Sprintf(WrongEnumErrMsg, value),
Code: int(errorcodeutil.InvalidEnum),
}
}
// VerifyOTPError returns an error when OTP verification fails
func VerifyOTPError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: OTPVerificationErrMsg,
Code: int(errorcodeutil.OTPVerificationFailed),
}
}
// MissingInputError returns an error when OTP verification fails
func MissingInputError(value string) error {
return &errorcodeutil.CustomError{
Err: nil,
Message: "expected `%s` to be defined",
Code: int(errorcodeutil.OTPVerificationFailed),
}
}
// InvalidFlavourDefinedError is the error message displayed when
// an invalid flavour is provided as input.
func InvalidFlavourDefinedError() error {
return &errorcodeutil.CustomError{
Err: fmt.Errorf("invalid flavour defined"),
Message: InvalidFlavourDefinedErrMsg,
Code: int(errorcodeutil.InvalidFlavour),
}
}
// AddPartnerTypeError is an error message displayed when there is a
// failure to create a partner type
func AddPartnerTypeError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: AddPartnerTypeErrMsg,
Code: int(errorcodeutil.InvalidEnum),
}
}
// InvalidPartnerTypeError is an error message displayed when an
// invalid partner type is provided
func InvalidPartnerTypeError() error {
return &errorcodeutil.CustomError{
Err: fmt.Errorf("invalid `partnerType` provided"),
Message: InvalidPartnerTypeErrMsg,
Code: int(errorcodeutil.InvalidEnum),
}
}
// FetchDefaultCurrencyError is an error message displayed when
// the default currency is not found
func FetchDefaultCurrencyError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: FetchDefaultCurrencyErrMsg,
Code: int(errorcodeutil.RecordNotFound),
}
}
// SupplierNotFoundError returns an error message when a supplier is not found
func SupplierNotFoundError() error {
return &errorcodeutil.CustomError{
Message: SupplierNotFoundErrMsg,
Code: int(errorcodeutil.ProfileNotFound),
}
}
// CustomerNotFoundError returns an error message when a customer is not found
func CustomerNotFoundError() error {
return &errorcodeutil.CustomError{
Message: CustomerNotFoundErrMsg,
Code: int(errorcodeutil.ProfileNotFound),
}
}
// SupplierKYCAlreadySubmittedNotFoundError is returned when the user trys to
// submit another KCY when then is one already submitted
func SupplierKYCAlreadySubmittedNotFoundError() error {
return &errorcodeutil.CustomError{
Message: SupplierKYCAlreadySubmittedErrMsg,
Code: int(errorcodeutil.KYCAlreadySubmitted),
}
}
// PublishKYCNudgeError returns an error message when there's a failure in
// creating a KYC nudge
func PublishKYCNudgeError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: PublishKYCNudgeErrMsg,
Code: int(errorcodeutil.PublishNudgeFailure),
}
}
// InvalidCredentialsError returns an error message when wrong credentials are provided
func InvalidCredentialsError() error {
return &errorcodeutil.CustomError{
Err: fmt.Errorf("invalid credentials, expected a username AND password"),
Message: InvalidCredentialsErrMsg,
Code: int(errorcodeutil.InvalidCredentials),
}
}
// SaveUserPinError returns an error message when we are unable to save a user pin
func SaveUserPinError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: SaveUserPinErrMsg,
Code: int(errorcodeutil.PINError),
}
}
// GeneratePinError returns an error message when we are unable to generate a temporary PIN
func GeneratePinError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: GeneratePinErrMsg,
Code: int(errorcodeutil.PINError),
}
}
// CompleteSignUpError returns an error message when we are unable
// to CompleteSignup
func CompleteSignUpError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: BioDataErrMsg,
Code: int(errorcodeutil.AddNewRecordError),
}
}
// UsernameInUseError is the error message displayed when the provided username
// is associated with another profile
func UsernameInUseError() error {
return &errorcodeutil.CustomError{
Message: UsernameInUseErrMsg,
Code: int(errorcodeutil.UsernameInUse),
}
}
// SecondaryResourceHardResetError this error is returned when there argument to reset a resource has a length of 0
// resource here means secondary phone numbers and secondary emails
func SecondaryResourceHardResetError() error {
return &errorcodeutil.CustomError{
Message: ResourceUpdateErrMsg,
Code: int(errorcodeutil.UndefinedArguments),
}
}
// InvalidSladeCodeError when the slade code the edi user profile doesn't match with selected provider
func InvalidSladeCodeError() error {
return &errorcodeutil.CustomError{
Message: InvalidSladeCodeErrMsg,
Code: int(errorcodeutil.InvalidSladeCode),
}
}
// ResolveNudgeErr is the error that represents the failure of not
// being able to resolve a given nudge
func ResolveNudgeErr(
err error,
flavour feedlib.Flavour,
name string,
statusCode *int,
) error {
if statusCode != nil {
return &errorcodeutil.CustomError{
Err: err,
Message: fmt.Sprintf(
ResolveNudgeBadStatusErrMsg,
flavour,
name,
statusCode,
),
Code: int(errorcodeutil.Internal),
}
}
return &errorcodeutil.CustomError{
Err: err,
Message: fmt.Sprintf(
ResolveNudgeErrMsg,
flavour,
name,
),
Code: int(errorcodeutil.Internal),
}
}
// RecordExistsError is the error message displayed when a
// similar record is found in the DB
func RecordExistsError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: RecordExistsErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// RecordDoesNotExistError is the error message displayed when a
// record is not found in the DB
func RecordDoesNotExistError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: RecordDoesNotExistErrMsg,
Code: int(errorcodeutil.Internal),
}
}
// RoleNotValid return an error when a user does not have the required role
func RoleNotValid(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: RoleNotValidMsg,
Code: int(errorcodeutil.RoleNotValid),
}
}
// NavigationActionsError return an error when user navigation actions can not be manipulated
func NavigationActionsError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: NavActionsError,
Code: int(errorcodeutil.NavigationActionsError),
}
}
// AgentNotFoundError returns an error message when an agent is not found
func AgentNotFoundError(err error) error {
return &errorcodeutil.CustomError{
Err: err,
Message: AgentNotFoundErrMsg,
Code: int(errorcodeutil.ProfileNotFound),
}
}