-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy patherrors.go
More file actions
627 lines (501 loc) · 15.4 KB
/
errors.go
File metadata and controls
627 lines (501 loc) · 15.4 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
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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
package twelvedata
import (
"errors"
"fmt"
"net/http"
"strings"
"github.com/soulgarden/twelvedata/dictionary"
"github.com/soulgarden/twelvedata/response"
)
// HTTPError represents HTTP-related errors with status codes.
type HTTPError struct {
StatusCode int
Message string
Body []byte
URL string // request URL that failed
Cause error // underlying error that caused this HTTP error
}
func (e HTTPError) Error() string {
if e.URL != "" {
return fmt.Sprintf("HTTP %d %s (URL: %s)", e.StatusCode, e.Message, e.URL)
}
return fmt.Sprintf("HTTP %d: %s", e.StatusCode, e.Message)
}
// Unwrap returns the underlying cause if this HTTPError wraps another error.
func (e HTTPError) Unwrap() error {
return e.Cause
}
// IsHTTPError checks if an error is an HTTPError or any of its subtypes.
func IsHTTPError(err error) bool {
// Check for direct HTTPError
var httpErr *HTTPError
if errors.As(err, &httpErr) {
return true
}
// Check for specific HTTP error types
var badReqErr *BadRequestError
var unauthorizedErr *UnauthorizedError
var notFoundErr *NotFoundError
var rateLimitErr *TooManyRequestsError
var serverErr *InternalServerError
return errors.As(err, &badReqErr) ||
errors.As(err, &unauthorizedErr) ||
errors.As(err, ¬FoundErr) ||
errors.As(err, &rateLimitErr) ||
errors.As(err, &serverErr)
}
// BadRequestError represents 400 Bad Request errors.
type BadRequestError struct {
HTTPError
APIError *response.Error
}
func (e BadRequestError) Error() string {
baseMsg := "HTTP 400 Bad Request"
if e.APIError != nil {
baseMsg += ": " + e.APIError.Error()
} else {
baseMsg += ": " + e.Message
}
if e.URL != "" {
baseMsg += " (URL: " + e.URL + ")"
}
return baseMsg
}
// UnauthorizedError represents 401 Unauthorized errors.
type UnauthorizedError struct {
HTTPError
APIError *response.Error
}
func (e UnauthorizedError) Error() string {
baseMsg := "HTTP 401 Unauthorized"
if e.APIError != nil {
baseMsg += ": " + e.APIError.Error()
} else {
baseMsg += ": Invalid API key or authentication failed"
}
if e.URL != "" {
baseMsg += " (URL: " + e.URL + ")"
}
return baseMsg
}
// NotFoundError represents 404 Not Found errors.
type NotFoundError struct {
HTTPError
APIError *response.Error
}
func (e NotFoundError) Error() string {
baseMsg := "HTTP 404 Not Found"
if e.APIError != nil {
baseMsg += ": " + e.APIError.Error()
} else {
baseMsg += ": " + e.Message
}
if e.URL != "" {
baseMsg += " (URL: " + e.URL + ")"
}
return baseMsg
}
// TooManyRequestsError represents 429 Rate Limit errors.
type TooManyRequestsError struct {
HTTPError
APIError *response.Error
}
func (e TooManyRequestsError) Error() string {
baseMsg := "HTTP 429 Too Many Requests"
if e.APIError != nil {
baseMsg += ": " + e.APIError.Error()
} else {
baseMsg += ": Rate limit exceeded"
}
if e.URL != "" {
baseMsg += " (URL: " + e.URL + ")"
}
return baseMsg
}
// InternalServerError represents 500 Internal Server errors.
type InternalServerError struct {
HTTPError
APIError *response.Error
}
func (e InternalServerError) Error() string {
baseMsg := "HTTP 500 Internal Server Error"
if e.APIError != nil {
baseMsg += ": " + e.APIError.Error()
} else {
baseMsg += ": " + e.Message
}
if e.URL != "" {
baseMsg += " (URL: " + e.URL + ")"
}
return baseMsg
}
// TimeoutError represents request timeout errors.
type TimeoutError struct {
Message string
}
func (e TimeoutError) Error() string {
return "Request Timeout: " + e.Message
}
// NetworkError represents network connectivity errors.
type NetworkError struct {
Message string
Cause error
}
func (e NetworkError) Error() string {
return "Network Error: " + e.Message
}
func (e NetworkError) Unwrap() error {
return e.Cause
}
// WebSocket-specific errors
// WSConnectionError represents WebSocket connection errors.
type WSConnectionError struct {
URL string
Message string
Cause error
}
func (e WSConnectionError) Error() string {
return fmt.Sprintf("WebSocket Connection Error: %s (URL: %s)", e.Message, e.URL)
}
func (e WSConnectionError) Unwrap() error {
return e.Cause
}
// WSMessageError represents WebSocket message handling errors.
type WSMessageError struct {
Message string
Data []byte
Cause error
}
func (e WSMessageError) Error() string {
return "WebSocket Message Error: " + e.Message
}
func (e WSMessageError) Unwrap() error {
return e.Cause
}
// WSSubscriptionError represents WebSocket subscription errors.
type WSSubscriptionError struct {
Symbols []string
Message string
Cause error
}
func (e WSSubscriptionError) Error() string {
return fmt.Sprintf("WebSocket Subscription Error: %s (symbols: %v)", e.Message, e.Symbols)
}
func (e WSSubscriptionError) Unwrap() error {
return e.Cause
}
// NewHTTPError creates appropriate typed error based on HTTP status code.
func NewHTTPError(statusCode int, body []byte, url string, apiError *response.Error, cause error) error {
baseError := HTTPError{
StatusCode: statusCode,
Body: body,
URL: url,
Message: http.StatusText(statusCode),
Cause: cause,
}
switch statusCode {
case http.StatusBadRequest:
return &BadRequestError{
HTTPError: baseError,
APIError: apiError,
}
case http.StatusUnauthorized:
return &UnauthorizedError{
HTTPError: baseError,
APIError: apiError,
}
case http.StatusNotFound:
return &NotFoundError{
HTTPError: baseError,
APIError: apiError,
}
case http.StatusTooManyRequests:
return &TooManyRequestsError{
HTTPError: baseError,
APIError: apiError,
}
case http.StatusInternalServerError:
return &InternalServerError{
HTTPError: baseError,
APIError: apiError,
}
default:
if apiError != nil {
baseError.Message = apiError.Error()
}
return &baseError
}
}
// Error type checking helpers.
// IsBadRequestError checks if an error is a BadRequestError type.
func IsBadRequestError(err error) bool {
var badReqErr *BadRequestError
return errors.As(err, &badReqErr)
}
// IsUnauthorizedError checks if an error is an UnauthorizedError type.
func IsUnauthorizedError(err error) bool {
var unauthorizedErr *UnauthorizedError
return errors.As(err, &unauthorizedErr)
}
// IsNotFoundError checks if an error is a NotFoundError type.
func IsNotFoundError(err error) bool {
var notFoundErr *NotFoundError
return errors.As(err, ¬FoundErr)
}
// IsRateLimitError checks if an error is a TooManyRequestsError type.
func IsRateLimitError(err error) bool {
var rateLimitErr *TooManyRequestsError
return errors.As(err, &rateLimitErr)
}
// IsTimeoutError checks if an error is a TimeoutError type.
func IsTimeoutError(err error) bool {
var timeoutErr *TimeoutError
return errors.As(err, &timeoutErr)
}
// IsNetworkError checks if an error is a NetworkError type.
func IsNetworkError(err error) bool {
var networkErr *NetworkError
return errors.As(err, &networkErr)
}
// WebSocket error checking functions
// IsWSConnectionError checks if an error is a WSConnectionError type.
func IsWSConnectionError(err error) bool {
var wsConnErr *WSConnectionError
return errors.As(err, &wsConnErr)
}
// IsWSMessageError checks if an error is a WSMessageError type.
func IsWSMessageError(err error) bool {
var wsMsgErr *WSMessageError
return errors.As(err, &wsMsgErr)
}
// IsWSSubscriptionError checks if an error is a WSSubscriptionError type.
func IsWSSubscriptionError(err error) bool {
var wsSubErr *WSSubscriptionError
return errors.As(err, &wsSubErr)
}
// IsWSError checks if an error is any WebSocket-related error type.
func IsWSError(err error) bool {
return IsWSConnectionError(err) || IsWSMessageError(err) || IsWSSubscriptionError(err)
}
// Domain-specific errors for Twelve Data API
// SymbolNotFoundError represents errors when a requested symbol is not found.
type SymbolNotFoundError struct {
Symbol string
Message string
Cause error
}
func (e SymbolNotFoundError) Error() string {
if e.Symbol != "" {
return fmt.Sprintf("Symbol Not Found: %s - %s", e.Symbol, e.Message)
}
return "Symbol Not Found: " + e.Message
}
func (e SymbolNotFoundError) Unwrap() error {
return e.Cause
}
// PlanLimitationError represents errors when a feature is not available with the current plan.
type PlanLimitationError struct {
Feature string
Plan string
Message string
Cause error
}
func (e PlanLimitationError) Error() string {
if e.Feature != "" && e.Plan != "" {
return fmt.Sprintf("Plan Limitation: %s is not available with %s plan", e.Feature, e.Plan)
}
return "Plan Limitation: " + e.Message
}
func (e PlanLimitationError) Unwrap() error {
return e.Cause
}
// InsufficientCreditsError represents errors when user has insufficient API credits.
type InsufficientCreditsError struct {
Required int64
Available int64
Message string
Cause error
}
func (e InsufficientCreditsError) Error() string {
if e.Required > 0 && e.Available >= 0 {
return fmt.Sprintf("Insufficient Credits: required %d, available %d", e.Required, e.Available)
}
return "Insufficient Credits: " + e.Message
}
func (e InsufficientCreditsError) Unwrap() error {
return e.Cause
}
// APIKeyError represents API key related errors.
type APIKeyError struct {
Type string // "invalid", "required", "expired"
Message string
Cause error
}
func (e APIKeyError) Error() string {
switch e.Type {
case "invalid":
return "API Key Error: Invalid API key provided"
case "required":
return "API Key Error: API key is required"
case "expired":
return "API Key Error: API key has expired"
default:
return "API Key Error: " + e.Message
}
}
func (e APIKeyError) Unwrap() error {
return e.Cause
}
// Domain-specific error checking functions
// IsSymbolNotFoundError checks if an error is a SymbolNotFoundError type.
func IsSymbolNotFoundError(err error) bool {
var symbolErr *SymbolNotFoundError
return errors.As(err, &symbolErr)
}
// IsPlanLimitationError checks if an error is a PlanLimitationError type.
func IsPlanLimitationError(err error) bool {
var planErr *PlanLimitationError
return errors.As(err, &planErr)
}
// IsInsufficientCreditsError checks if an error is an InsufficientCreditsError type.
func IsInsufficientCreditsError(err error) bool {
var creditsErr *InsufficientCreditsError
return errors.As(err, &creditsErr)
}
// IsAPIKeyError checks if an error is an APIKeyError type.
func IsAPIKeyError(err error) bool {
var keyErr *APIKeyError
return errors.As(err, &keyErr)
}
// IsDomainError checks if an error is any of the Twelve Data domain-specific errors.
func IsDomainError(err error) bool {
return IsSymbolNotFoundError(err) ||
IsPlanLimitationError(err) ||
IsInsufficientCreditsError(err) ||
IsAPIKeyError(err)
}
// API error message parsing functions
// ParseDomainError analyzes an API error response and converts it to a domain-specific error.
func ParseDomainError(apiError *response.Error, _ int, _ string) error {
if apiError == nil || apiError.Message == "" {
return nil
}
message := strings.ToLower(apiError.Message)
// Check for symbol not found errors
if strings.Contains(message, "not found:") && strings.Contains(message, "**") ||
strings.Contains(message, "with specified criteria not found") && strings.Contains(message, "**") {
symbol := extractSymbolFromMessage(apiError.Message)
return &SymbolNotFoundError{
Symbol: symbol,
Message: apiError.Message,
Cause: fmt.Errorf("API returned symbol not found: %s", apiError.Message),
}
}
// Check for plan limitation errors (old format)
if strings.Contains(message, strings.ToLower(dictionary.IsNotAvailableWithYourPlanMsg)) {
feature := extractFeatureFromMessage(apiError.Message)
return &PlanLimitationError{
Feature: feature,
Message: apiError.Message,
Cause: fmt.Errorf("API returned plan limitation: %s", apiError.Message),
}
}
// Check for plan limitation errors (new format: "is available exclusively with")
if strings.Contains(message, strings.ToLower(dictionary.IsAvailableExclusivelyMsg)) {
feature := extractFeatureFromExclusiveMessage(apiError.Message)
return &PlanLimitationError{
Feature: feature,
Message: apiError.Message,
Cause: fmt.Errorf("API returned plan limitation: %s", apiError.Message),
}
}
// Check for demo API key limitation errors
if strings.Contains(message, strings.ToLower(dictionary.DemoAPIKeyLimitationMsg)) {
return &PlanLimitationError{
Feature: "demo API key",
Message: apiError.Message,
Cause: fmt.Errorf("API returned demo key limitation: %s", apiError.Message),
}
}
// Check for insufficient credits errors
if strings.Contains(message, strings.ToLower(dictionary.InsufficientCreditsMsg)) {
return &InsufficientCreditsError{
Message: apiError.Message,
Cause: fmt.Errorf("API returned insufficient credits: %s", apiError.Message),
}
}
// Check for daily credit limit exhaustion (new pattern)
if strings.Contains(message, "you have run out of api credits") {
return &InsufficientCreditsError{
Message: apiError.Message,
Cause: fmt.Errorf("API returned daily credit limit exhausted: %s", apiError.Message),
}
}
// Check for API key errors
if strings.Contains(message, strings.ToLower(dictionary.APIKeyInvalidMsg)) {
return &APIKeyError{
Type: "invalid",
Message: apiError.Message,
Cause: fmt.Errorf("API returned invalid key: %s", apiError.Message),
}
}
if strings.Contains(message, strings.ToLower(dictionary.APIKeyRequiredMsg)) {
return &APIKeyError{
Type: "required",
Message: apiError.Message,
Cause: fmt.Errorf("API returned key required: %s", apiError.Message),
}
}
return nil
}
// extractSymbolFromMessage tries to extract the symbol name from error messages like "**AAPL** not found:".
func extractSymbolFromMessage(message string) string {
// Look for pattern **SYMBOL**
start := strings.Index(message, "**")
if start == -1 {
return ""
}
start += 2
end := strings.Index(message[start:], "**")
if end == -1 {
return ""
}
return message[start : start+end]
}
// extractFeatureFromMessage tries to extract the feature name from plan limitation messages.
func extractFeatureFromMessage(message string) string {
// Look for text before " is not available with your plan"
planMsg := strings.ToLower(dictionary.IsNotAvailableWithYourPlanMsg)
idx := strings.LastIndex(strings.ToLower(message), planMsg)
if idx == -1 {
return ""
}
feature := strings.TrimSpace(message[:idx])
// Remove common prefixes
feature = strings.TrimPrefix(feature, "The ")
feature = strings.TrimPrefix(feature, "This ")
feature = strings.TrimPrefix(feature, "Feature ")
return feature
}
// extractFeatureFromExclusiveMessage extracts feature name from new format messages like
// "/dividends_calendar is available exclusively with grow or pro or ultra or enterprise plans.".
func extractFeatureFromExclusiveMessage(message string) string {
exclusiveMsg := strings.ToLower(dictionary.IsAvailableExclusivelyMsg)
idx := strings.Index(strings.ToLower(message), exclusiveMsg)
if idx == -1 {
return ""
}
feature := strings.TrimSpace(message[:idx])
// Remove leading slash if present
feature = strings.TrimPrefix(feature, "/")
// Replace underscores with spaces for readability
feature = strings.ReplaceAll(feature, "_", " ")
return feature
}
// WrapWithDomainError wraps an existing error with domain-specific error if applicable.
func WrapWithDomainError(err error, apiError *response.Error, statusCode int, url string) error {
if domainErr := ParseDomainError(apiError, statusCode, url); domainErr != nil {
return domainErr
}
return err
}