File size: 12,760 Bytes
2e6b65c
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
# Error Handling Standardization Plan

## Current State Analysis

**Issues Identified**:
- Inconsistent `gin.H{"error": ...}` scattered across handlers
- No clear separation between internal and user-facing errors
- HTTP status codes set manually in each handler
- Error messages exposed directly to clients
- No structured error logging with context

## Target Architecture

```
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                    HTTP Transport Layer                      β”‚
β”‚              (Gin Handlers - no error logic)                 β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                       β”‚
                       β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                  Application Use Cases                       β”‚
β”‚         (Return domain errors, no HTTP knowledge)            β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                       β”‚
                       β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                    Domain Services                           β”‚
β”‚              (Business logic, domain errors)                 β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                       β”‚
                       β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚              Infrastructure (DB, External APIs)              β”‚
β”‚              (Wrap external errors to domain)                β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
```

## Phase 1: Domain Error Types (Week 1)

### 1.1 Core Error Types
**File**: `internal/domain/errors/errors.go`

```go
package errors

import "fmt"

type ErrorCode string

const (
    // Authentication errors
    ErrCodeInvalidCredentials   ErrorCode = "AUTH_INVALID_CREDENTIALS"
    ErrCodeTokenExpired         ErrorCode = "AUTH_TOKEN_EXPIRED"
    ErrCodeTokenInvalid         ErrorCode = "AUTH_TOKEN_INVALID"
    ErrCodeUnauthorized         ErrorCode = "AUTH_UNAUTHORIZED"

    // Configuration errors
    ErrCodeConfigNotFound       ErrorCode = "CONFIG_NOT_FOUND"
    ErrCodeConfigInvalid        ErrorCode = "CONFIG_INVALID"
    ErrCodeConfigValidation     ErrorCode = "CONFIG_VALIDATION_FAILED"

    // Provider errors
    ErrCodeProviderNotFound     ErrorCode = "PROVIDER_NOT_FOUND"
    ErrCodeProviderUnavailable  ErrorCode = "PROVIDER_UNAVAILABLE"
    ErrCodeProviderRateLimited  ErrorCode = "PROVIDER_RATE_LIMITED"

    // Request errors
    ErrCodeInvalidRequest       ErrorCode = "REQUEST_INVALID"
    ErrCodeMissingField         ErrorCode = "REQUEST_MISSING_FIELD"
    ErrCodeInvalidFormat        ErrorCode = "REQUEST_INVALID_FORMAT"

    // Storage errors
    ErrCodeStorageFailure       ErrorCode = "STORAGE_FAILURE"
    ErrCodeNotFound             ErrorCode = "RESOURCE_NOT_FOUND"
    ErrCodeConflict             ErrorCode = "RESOURCE_CONFLICT"

    // Internal errors
    ErrCodeInternal             ErrorCode = "INTERNAL_ERROR"
    ErrCodeNotImplemented       ErrorCode = "NOT_IMPLEMENTED"
)

// DomainError is the base error type for the application
type DomainError struct {
    Code       ErrorCode
    Message    string
    Details    map[string]interface{}
    Cause      error
    HTTPStatus int
}

func (e *DomainError) Error() string {
    if e.Cause != nil {
        return fmt.Sprintf("%s: %s (caused by: %v)", e.Code, e.Message, e.Cause)
    }
    return fmt.Sprintf("%s: %s", e.Code, e.Message)
}

func (e *DomainError) Unwrap() error {
    return e.Cause
}

// Error constructors for common cases
func NewInvalidCredentials(msg string) *DomainError {
    return &DomainError{
        Code:       ErrCodeInvalidCredentials,
        Message:    msg,
        HTTPStatus: 401,
    }
}

func NewConfigNotFound(resource string) *DomainError {
    return &DomainError{
        Code:       ErrCodeConfigNotFound,
        Message:    fmt.Sprintf("configuration not found: %s", resource),
        HTTPStatus: 404,
        Details:    map[string]interface{}{"resource": resource},
    }
}

func NewProviderUnavailable(provider string, cause error) *DomainError {
    return &DomainError{
        Code:       ErrCodeProviderUnavailable,
        Message:    fmt.Sprintf("provider %s is unavailable", provider),
        HTTPStatus: 503,
        Cause:      cause,
        Details:    map[string]interface{}{"provider": provider},
    }
}

func NewValidationError(field string, msg string) *DomainError {
    return &DomainError{
        Code:       ErrCodeConfigValidation,
        Message:    fmt.Sprintf("validation failed for %s: %s", field, msg),
        HTTPStatus: 400,
        Details:    map[string]interface{}{"field": field},
    }
}

func NewInternalError(cause error) *DomainError {
    return &DomainError{
        Code:       ErrCodeInternal,
        Message:    "an internal error occurred",
        HTTPStatus: 500,
        Cause:      cause,
    }
}
```

### 1.2 Error Response DTO
**File**: `internal/application/dto/error.go`

```go
package dto

// ErrorResponse is the standardized error response for clients
type ErrorResponse struct {
    Success   bool                   `json:"success" example:"false"`
    Error     ErrorInfo              `json:"error"`
    RequestID string                 `json:"request_id,omitempty"`
}

type ErrorInfo struct {
    Code    string                 `json:"code" example:"AUTH_INVALID_CREDENTIALS"`
    Message string                 `json:"message" example:"Invalid credentials provided"`
    Details map[string]interface{} `json:"details,omitempty"`
}

// InternalErrorResponse is returned for 500 errors (no sensitive info)
type InternalErrorResponse struct {
    Success   bool   `json:"success"`
    Error     string `json:"error"`
    RequestID string `json:"request_id"`
}
```

## Phase 2: Error Middleware (Week 1)

### 2.1 Error Handler Middleware
**File**: `internal/api/middleware/error_handler.go`

```go
package middleware

import (
    "net/http"

    "github.com/gin-gonic/gin"
    "github.com/sirupsen/logrus"

    domainerrors "github.com/echyai/cliproxyapi/internal/domain/errors"
    "github.com/echyai/cliproxyapi/internal/application/dto"
)

// ErrorHandler returns a middleware that handles domain errors
func ErrorHandler(logger *logrus.Logger) gin.HandlerFunc {
    return func(c *gin.Context) {
        c.Next()

        // Check if there are any errors
        if len(c.Errors) == 0 {
            return
        }

        // Get the last error
        err := c.Errors.Last().Err
        requestID := c.GetString("request_id")

        // Handle domain errors
        if domainErr, ok := err.(*domainerrors.DomainError); ok {
            handleDomainError(c, domainErr, requestID, logger)
            return
        }

        // Handle wrapped domain errors
        var domainErr *domainerrors.DomainError
        if errors.As(err, &domainErr) {
            handleDomainError(c, domainErr, requestID, logger)
            return
        }

        // Unknown error - log full details but return generic message
        logger.WithError(err).
            WithField("request_id", requestID).
            WithField("path", c.Request.URL.Path).
            Error("Unhandled error")

        c.JSON(http.StatusInternalServerError, dto.InternalErrorResponse{
            Success:   false,
            Error:     "An unexpected error occurred",
            RequestID: requestID,
        })
    }
}

func handleDomainError(c *gin.Context, err *domainerrors.DomainError, requestID string, logger *logrus.Logger) {
    // Log with appropriate level based on status code
    entry := logger.WithError(err).
        WithField("request_id", requestID).
        WithField("error_code", err.Code).
        WithField("path", c.Request.URL.Path)

    if err.HTTPStatus >= 500 {
        entry.Error("Server error")
    } else if err.HTTPStatus >= 400 {
        entry.Warn("Client error")
    }

    // Return structured error response
    c.JSON(err.HTTPStatus, dto.ErrorResponse{
        Success:   false,
        Error: dto.ErrorInfo{
            Code:    string(err.Code),
            Message: err.Message,
            Details: err.Details,
        },
        RequestID: requestID,
    })
}
```

### 2.2 Request ID Middleware
**File**: `internal/api/middleware/request_id.go`

```go
package middleware

import (
    "github.com/gin-gonic/gin"
    "github.com/google/uuid"
)

func RequestID() gin.HandlerFunc {
    return func(c *gin.Context) {
        requestID := c.GetHeader("X-Request-ID")
        if requestID == "" {
            requestID = uuid.New().String()
        }
        c.Set("request_id", requestID)
        c.Header("X-Request-ID", requestID)
        c.Next()
    }
}
```

## Phase 3: Handler Refactoring Example (Week 2)

### Before (Current)
**File**: Example from auth handlers

```go
func (h *Handler) GetAuth(c *gin.Context) {
    id := c.Param("id")
    auth, err := h.store.GetAuth(id)
    if err != nil {
        c.JSON(500, gin.H{"error": err.Error()})
        return
    }
    if auth == nil {
        c.JSON(404, gin.H{"error": "not found"})
        return
    }
    c.JSON(200, auth)
}
```

### After (Refactored)

```go
func (h *Handler) GetAuth(c *gin.Context) {
    id := c.Param("id")

    auth, err := h.usecase.GetAuth(c.Request.Context(), id)
    if err != nil {
        _ = c.Error(err) // Pass to error middleware
        return
    }

    c.JSON(200, dto.SuccessResponse{Data: auth})
}
```

### Use Case Implementation

```go
func (uc *AuthUseCase) GetAuth(ctx context.Context, id string) (*dto.AuthDTO, error) {
    if id == "" {
        return nil, domainerrors.NewValidationError("id", "cannot be empty")
    }

    auth, err := uc.repo.FindByID(ctx, id)
    if err != nil {
        return nil, domainerrors.NewInternalError(err)
    }

    if auth == nil {
        return nil, domainerrors.NewConfigNotFound(id)
    }

    return uc.mapper.ToDTO(auth), nil
}
```

## Phase 4: Migration Strategy

### Step-by-Step Migration

1. **Week 1**: Create error types and middleware (new code only)
2. **Week 2-3**: Migrate handlers one package at a time:
   - [ ] `internal/api/handlers/management/auth_files.go`
   - [ ] `internal/api/handlers/management/config_lists.go`
   - [ ] `internal/api/handlers/proxy/`
   - [ ] `internal/api/handlers/oauth/`
3. **Week 4**: Remove old error handling patterns
4. **Week 5**: Add error logging aggregation

### Compatibility Layer (Temporary)

```go
// Deprecated: Use c.Error(err) instead
func LegacyErrorResponse(c *gin.Context, status int, err error) {
    domainErr := &domainerrors.DomainError{
        Code:       domainerrors.ErrorCode(fmt.Sprintf("LEGACY_%d", status)),
        Message:    err.Error(),
        HTTPStatus: status,
    }
    _ = c.Error(domainErr)
}
```

## Testing

### Unit Tests for Error Handling
**File**: `internal/api/middleware/error_handler_test.go`

```go
func TestErrorHandler_DomainError(t *testing.T) {
    gin.SetMode(gin.TestMode)
    w := httptest.NewRecorder()
    c, _ := gin.CreateTestContext(w)

    // Simulate error
    c.Error(domainerrors.NewConfigNotFound("test-config"))

    // Run middleware
    middleware := ErrorHandler(logrus.New())
    middleware(c)

    assert.Equal(t, 404, w.Code)

    var resp dto.ErrorResponse
    json.Unmarshal(w.Body.Bytes(), &resp)
    assert.Equal(t, "CONFIG_NOT_FOUND", resp.Error.Code)
}
```

## Success Metrics

- [ ] All handlers use `c.Error()` instead of direct `c.JSON()` for errors
- [ ] Zero `gin.H{"error": ...}` patterns in codebase
- [ ] Consistent error response format across all APIs
- [ ] Internal errors don't leak sensitive details
- [ ] Request ID tracking for all error responses