Skip to content

Commit 055181d

Browse files
prkhrkatprkhrkat
authored
Merge branch 'api-specs-post' into fix-api-phase-2
2 parents 99b719a + e01cbd9 commit 055181d

File tree

19 files changed

+706
-302
lines changed

19 files changed

+706
-302
lines changed

‎CHANGELOG/release-notes-v1.8.0.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## v1.8.0
2+
3+
## Enhancements
4+
- feat: added the plugin for aws ecr retagging (#6695)
5+
- feat: Argo version update v2.13.3(#6817)
6+
- feat: ArgoCD v2.13.3 support for private chart providers (#6766)
7+
- feat: flux cd deployment (#6660)
8+
- feat: add app name in labels list api (#6688)
9+
- feat: Audit ci trigger, precd and post cd trigger so that retrigger can happen from last failed config snapshot (#6659)
10+
- feat: optimize ci cd workflow (#6744)
11+
- feat: automate API specs workflow and documentation (#6786)
12+
13+
## Bugs
14+
- fix: argo sync (#6718)
15+
- fix: cluster delete (#6706)
16+
- fix: Notifier v1 removed (#6705)
17+
- fix: app clone panic (#6696)
18+
- fix: Spdy migration to websocket (#6682)
19+
- fix: Fix scanning optimisation (#6683)
20+
- fix: panic in logs api (#6684)
21+
- fix: Empty migration seq (#6673)
22+
- fix: Removing default value of idleReplicaCount (#6721)
23+
- fix: send HideApiToken env var in api token create and update response (#6727)
24+
- fix: removed timeout notification (#6760)
25+
- fix: unify unit formatting and conversion for CPU and memory in cluster resources (#6768)
26+
- fix: cron job suspend (#6771)
27+
- fix: panic app group (#6785)
28+
- fix: api responses enhancements (#6797)
29+
- fix: post apis minor validations (#6811)
30+
- fix: dex scopes override default required scopes (#6816)
31+
- fix: error handler correction (#6824)
32+
33+
## Others
34+
- chore: added sql file of 4.21 (#6716)
35+
- misc: added support for service extraSpec (#6702)
36+
- chore: when output dir path is /devtroncd in any pipeline stage step then the ci runner is stuck in recursive self-copy situation (#6686)
37+
- misc: Removing default value of idleReplicaCount (#6730)
38+
- chore: chart service crud and configProperties (#6642)
39+
- misc: Added Github Actions for linting and building api specs (#6720)
40+
- misc: open api spec addition (#6750)
41+
- misc: Updated the build-docs.yaml (#6752)
42+
- misc: fixing swagger openapi.yaml (#6751)
43+
- misc: adding codeowner for swagger api spec (#6754)
44+
- misc: swagger api spec fixes (#6755)
45+
- misc: Update openapi spec (#6758)
46+
- misc: updated the title of openapi specs (#6759)
47+
- misc: Timeout main notification (#6761)
48+
- misc: Api changes for env enhancement (#6769)
49+
- misc: changes in description of api spec (#6767)
50+
- chore: Update `authenticator` and `common-lib` dependencies to latest versions. (#6779)
51+
- chore: added sql files for sync (#6780)
52+
- chore: migration number chnage (#6783)
53+
- chore: add resource recommendation APIs and update openapi.yaml (#6784)
54+
- misc: added support for cronjob annotations and probes (#6787)
55+
- misc: Validation on payload and Error handling, API Specs revised (#6790)
56+
- misc: sql query param refacter (#6810)
57+

‎api/restHandler/UserAttributesRestHandler.go‎

Lines changed: 110 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,14 @@ package restHandler
1818

1919
import (
2020
"encoding/json"
21-
"errors"
22-
"github.com/devtron-labs/devtron/pkg/attributes/bean"
2321
"net/http"
2422

23+
"github.com/devtron-labs/devtron/pkg/attributes/bean"
24+
2525
"github.com/devtron-labs/devtron/api/restHandler/common"
2626
"github.com/devtron-labs/devtron/pkg/attributes"
2727
"github.com/devtron-labs/devtron/pkg/auth/authorisation/casbin"
2828
"github.com/devtron-labs/devtron/pkg/auth/user"
29-
"github.com/gorilla/mux"
3029
"go.uber.org/zap"
3130
)
3231

@@ -56,18 +55,32 @@ func NewUserAttributesRestHandlerImpl(logger *zap.SugaredLogger, enforcer casbin
5655
}
5756

5857
func (handler *UserAttributesRestHandlerImpl) AddUserAttributes(w http.ResponseWriter, r *http.Request) {
59-
dto, success := handler.validateUserAttributesRequest(w, r, "PatchUserAttributes")
58+
dto, success := handler.validateUserAttributesRequest(w, r, "AddUserAttributes")
6059
if !success {
6160
return
6261
}
6362

64-
handler.logger.Infow("request payload, AddUserAttributes", "payload", dto)
63+
handler.logger.Infow("Adding user attributes",
64+
"operation", "add_user_attributes",
65+
"userId", dto.UserId,
66+
"key", dto.Key)
67+
6568
resp, err := handler.userAttributesService.AddUserAttributes(dto)
6669
if err != nil {
67-
handler.logger.Errorw("service err, AddUserAttributes", "err", err, "payload", dto)
68-
common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
70+
handler.logger.Errorw("Failed to add user attributes",
71+
"operation", "add_user_attributes",
72+
"userId", dto.UserId,
73+
"key", dto.Key,
74+
"err", err)
75+
76+
// Use enhanced error response builder
77+
errBuilder := common.NewErrorResponseBuilder(w, r).
78+
WithOperation("user attributes creation").
79+
WithResource("user attribute", dto.Key)
80+
errBuilder.HandleError(err)
6981
return
7082
}
83+
7184
common.WriteJsonResp(w, nil, resp, http.StatusOK)
7285
}
7386

@@ -78,18 +91,32 @@ func (handler *UserAttributesRestHandlerImpl) AddUserAttributes(w http.ResponseW
7891
// @Success 200 {object} attributes.UserAttributesDto
7992
// @Router /orchestrator/attributes/user/update [POST]
8093
func (handler *UserAttributesRestHandlerImpl) UpdateUserAttributes(w http.ResponseWriter, r *http.Request) {
81-
dto, success := handler.validateUserAttributesRequest(w, r, "PatchUserAttributes")
94+
dto, success := handler.validateUserAttributesRequest(w, r, "UpdateUserAttributes")
8295
if !success {
8396
return
8497
}
8598

86-
handler.logger.Infow("request payload, UpdateUserAttributes", "payload", dto)
99+
handler.logger.Infow("Updating user attributes",
100+
"operation", "update_user_attributes",
101+
"userId", dto.UserId,
102+
"key", dto.Key)
103+
87104
resp, err := handler.userAttributesService.UpdateUserAttributes(dto)
88105
if err != nil {
89-
handler.logger.Errorw("service err, UpdateUserAttributes", "err", err, "payload", dto)
90-
common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
106+
handler.logger.Errorw("Failed to update user attributes",
107+
"operation", "update_user_attributes",
108+
"userId", dto.UserId,
109+
"key", dto.Key,
110+
"err", err)
111+
112+
// Use enhanced error response builder
113+
errBuilder := common.NewErrorResponseBuilder(w, r).
114+
WithOperation("user attributes update").
115+
WithResource("user attribute", dto.Key)
116+
errBuilder.HandleError(err)
91117
return
92118
}
119+
93120
common.WriteJsonResp(w, nil, resp, http.StatusOK)
94121
}
95122

@@ -99,38 +126,68 @@ func (handler *UserAttributesRestHandlerImpl) PatchUserAttributes(w http.Respons
99126
return
100127
}
101128

102-
handler.logger.Infow("request payload, PatchUserAttributes", "payload", dto)
129+
handler.logger.Infow("Patching user attributes",
130+
"operation", "patch_user_attributes",
131+
"userId", dto.UserId,
132+
"key", dto.Key)
133+
103134
resp, err := handler.userAttributesService.PatchUserAttributes(dto)
104135
if err != nil {
105-
handler.logger.Errorw("service err, PatchUserAttributes", "err", err, "payload", dto)
106-
common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
136+
handler.logger.Errorw("Failed to patch user attributes",
137+
"operation", "patch_user_attributes",
138+
"userId", dto.UserId,
139+
"key", dto.Key,
140+
"err", err)
141+
142+
// Use enhanced error response builder
143+
errBuilder := common.NewErrorResponseBuilder(w, r).
144+
WithOperation("user attributes patch").
145+
WithResource("user attribute", dto.Key)
146+
errBuilder.HandleError(err)
107147
return
108148
}
149+
109150
common.WriteJsonResp(w, nil, resp, http.StatusOK)
110151
}
111152

112153
func (handler *UserAttributesRestHandlerImpl) validateUserAttributesRequest(w http.ResponseWriter, r *http.Request, operation string) (*bean.UserAttributesDto, bool) {
154+
// 1. Authentication check using enhanced error handling
113155
userId, err := handler.userService.GetLoggedInUser(r)
114156
if userId == 0 || err != nil {
115157
common.HandleUnauthorized(w, r)
116158
return nil, false
117159
}
118160

161+
// 2. Request body parsing with enhanced error handling
119162
decoder := json.NewDecoder(r.Body)
120163
var dto bean.UserAttributesDto
121164
err = decoder.Decode(&dto)
122165
if err != nil {
123-
handler.logger.Errorw("request err, "+operation, "err", err, "payload", dto)
124-
common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
166+
handler.logger.Errorw("Request parsing error",
167+
"operation", operation,
168+
"err", err,
169+
"userId", userId)
170+
171+
// Use enhanced error response builder for request parsing errors
172+
errBuilder := common.NewErrorResponseBuilder(w, r).
173+
WithOperation(operation).
174+
WithResource("user attributes", "")
175+
errBuilder.HandleError(err)
125176
return nil, false
126177
}
127178

128179
dto.UserId = userId
129180

181+
// 3. Get user email with enhanced error handling
130182
emailId, err := handler.userService.GetActiveEmailById(userId)
131183
if err != nil {
132-
handler.logger.Errorw("request err, "+operation, "err", err, "payload", dto)
133-
common.WriteJsonResp(w, errors.New("unauthorized"), nil, http.StatusForbidden)
184+
handler.logger.Errorw("Failed to get user email",
185+
"operation", operation,
186+
"userId", userId,
187+
"err", err)
188+
189+
// Use enhanced error response for forbidden access
190+
common.WriteForbiddenError(w, "access user attributes", "user")
134191
return nil, false
135192
}
136193
dto.EmailId = emailId
@@ -145,36 +202,58 @@ func (handler *UserAttributesRestHandlerImpl) validateUserAttributesRequest(w ht
145202
// @Success 200 {object} attributes.UserAttributesDto
146203
// @Router /orchestrator/attributes/user/get [GET]
147204
func (handler *UserAttributesRestHandlerImpl) GetUserAttribute(w http.ResponseWriter, r *http.Request) {
205+
// 1. Authentication check using enhanced error handling
148206
userId, err := handler.userService.GetLoggedInUser(r)
149207
if userId == 0 || err != nil {
150208
common.HandleUnauthorized(w, r)
151209
return
152210
}
153211

154-
vars := mux.Vars(r)
155-
key := vars["key"]
156-
if key == "" {
157-
handler.logger.Errorw("request err, GetUserAttribute", "err", err, "key", key)
158-
common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
212+
// 2. Enhanced parameter extraction with automatic validation
213+
key, err := common.ExtractStringPathParamWithContext(w, r, "key")
214+
if err != nil {
215+
// Error already written by ExtractStringPathParamWithContext
159216
return
160217
}
161218

162-
dto := bean.UserAttributesDto{}
163-
219+
// 3. Get user email with enhanced error handling
164220
emailId, err := handler.userService.GetActiveEmailById(userId)
165221
if err != nil {
166-
handler.logger.Errorw("request err, UpdateUserAttributes", "err", err, "payload", dto)
167-
common.WriteJsonResp(w, errors.New("unauthorized"), nil, http.StatusForbidden)
222+
handler.logger.Errorw("Failed to get user email",
223+
"operation", "get_user_attribute",
224+
"userId", userId,
225+
"key", key,
226+
"err", err)
227+
228+
// Use enhanced error response for forbidden access
229+
common.WriteForbiddenError(w, "access user attributes", "user")
168230
return
169231
}
170-
dto.EmailId = emailId
171-
dto.Key = key
172232

233+
// 4. Prepare DTO
234+
dto := bean.UserAttributesDto{
235+
UserId: userId,
236+
EmailId: emailId,
237+
Key: key,
238+
}
239+
240+
// 5. Service call with enhanced error handling
173241
res, err := handler.userAttributesService.GetUserAttribute(&dto)
174242
if err != nil {
175-
handler.logger.Errorw("service err, GetAttributesById", "err", err)
176-
common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
243+
handler.logger.Errorw("Failed to get user attribute",
244+
"operation", "get_user_attribute",
245+
"userId", userId,
246+
"key", key,
247+
"err", err)
248+
249+
// Use enhanced error response builder
250+
errBuilder := common.NewErrorResponseBuilder(w, r).
251+
WithOperation("user attribute retrieval").
252+
WithResource("user attribute", key)
253+
errBuilder.HandleError(err)
177254
return
178255
}
256+
257+
// 6. Success response
179258
common.WriteJsonResp(w, nil, res, http.StatusOK)
180259
}

0 commit comments

Comments
 (0)