-
Notifications
You must be signed in to change notification settings - Fork 38
/
renders.go
67 lines (56 loc) · 1.99 KB
/
renders.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
// Copyright The Karpor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package handler
import (
"context"
"time"
appmiddleware "github.com/KusionStack/karpor/pkg/core/middleware"
"github.com/go-chi/chi/v5/middleware"
"github.com/go-chi/render"
)
// SuccessMessage is the default success message for successful responses.
const SuccessMessage = "OK"
// Response creates a standard API response renderer.
func Response(ctx context.Context, data any, err error) render.Renderer {
resp := &response{}
// Set the Success and Message fields based on the error parameter.
if err == nil {
resp.Success = true
resp.Message = SuccessMessage
resp.Data = data
} else {
resp.Success = false
resp.Message = err.Error()
}
// Include the request trace ID if available.
if requestID := middleware.GetReqID(ctx); len(requestID) > 0 {
resp.TraceID = requestID
}
// Calculate and include timing details if a start time is set.
if startTime := appmiddleware.GetStartTime(ctx); !startTime.IsZero() {
endTime := time.Now()
resp.StartTime = &startTime
resp.EndTime = &endTime
resp.CostTime = Duration(endTime.Sub(startTime))
}
return resp
}
// FailureResponse creates a response renderer for a failed request.
func FailureResponse(ctx context.Context, err error) render.Renderer {
return Response(ctx, nil, err)
}
// SuccessResponse creates a response renderer for a successful request.
func SuccessResponse(ctx context.Context, data any) render.Renderer {
return Response(ctx, data, nil)
}