-
Notifications
You must be signed in to change notification settings - Fork 1
/
user_management.go
700 lines (638 loc) · 23.7 KB
/
user_management.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
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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
package apis
import (
"encoding/json"
"fmt"
"net/http"
"github.com/alwitt/goutils"
"github.com/alwitt/padlock/common"
"github.com/alwitt/padlock/models"
"github.com/alwitt/padlock/users"
"github.com/apex/log"
"github.com/go-playground/validator/v10"
"github.com/gorilla/mux"
)
// UserManagementHandler the user / role management REST API handler
type UserManagementHandler struct {
goutils.RestAPIHandler
validate *validator.Validate
core users.Management
}
// defineUserManagementHandler define a new UserManagementHandler instance
func defineUserManagementHandler(
logConfig common.HTTPRequestLogging,
core users.Management,
validateSupport common.CustomFieldValidator,
metrics goutils.HTTPRequestMetricHelper,
) (UserManagementHandler, error) {
validate := validator.New()
if err := validateSupport.RegisterWithValidator(validate); err != nil {
return UserManagementHandler{}, err
}
logTags := log.Fields{
"module": "apis", "component": "api-handler", "instance": "user-management",
}
return UserManagementHandler{
RestAPIHandler: goutils.RestAPIHandler{
Component: goutils.Component{
LogTags: logTags,
LogTagModifiers: []goutils.LogMetadataModifier{
goutils.ModifyLogMetadataByRestRequestParam,
},
},
CallRequestIDHeaderField: &logConfig.RequestIDHeader,
DoNotLogHeaders: func() map[string]bool {
result := map[string]bool{}
for _, v := range logConfig.DoNotLogHeaders {
result[v] = true
}
return result
}(),
LogLevel: logConfig.LogLevel,
MetricsHelper: metrics,
},
validate: validate,
core: core,
}, nil
}
// ====================================================================================
// Role Management
// RespListAllRoles is the API response listing all roles the system is operating against
type RespListAllRoles struct {
goutils.RestAPIBaseResponse
// Roles are the roles
Roles map[string]common.UserRoleConfig `json:"roles" validate:"required,dive"`
}
// ListAllRoles godoc
// @Summary List All Roles
// @Description List all roles the system is operating against
// @tags Management
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Success 200 {object} RespListAllRoles "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/role [get]
func (h UserManagementHandler) ListAllRoles(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
roles, err := h.core.ListAllRoles(r.Context())
if err != nil {
msg := "Failed to query for all roles in system"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(
r.Context(), http.StatusInternalServerError, msg, err.Error(),
)
} else {
respCode = http.StatusOK
response = RespListAllRoles{
RestAPIBaseResponse: h.GetStdRESTSuccessMsg(r.Context()), Roles: roles,
}
}
}
// ListAllRolesHandler Wrapper around ListAllRoles
func (h UserManagementHandler) ListAllRolesHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.ListAllRoles(w, r)
}
}
// -----------------------------------------------------------------------
// RespRoleInfo is the API response giving info on one role
type RespRoleInfo struct {
goutils.RestAPIBaseResponse
// Role is info on this role
Role common.UserRoleConfig `json:"role" validate:"required,dive"`
// AssignedUsers is the list of users being assigned this role
AssignedUsers []models.UserInfo `json:"assigned_users,omitempty" validate:"omitempty"`
}
// GetRole godoc
// @Summary Get info on role
// @Description Query for information regarding one role, along with users assigned this role.
// @tags Management
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Param roleName path string true "Role name"
// @Success 200 {object} RespRoleInfo "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/role/{roleName} [get]
func (h UserManagementHandler) GetRole(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
// Verify the role name is valid
vars := mux.Vars(r)
roleName, ok := vars["roleName"]
if !ok {
log.WithFields(logTags).Errorf("Role name missing")
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(
r.Context(),
http.StatusBadRequest,
"role name missing",
"Role name must be provided",
)
return
}
type testStruct struct {
Role string `validate:"required,role_name"`
}
if err := h.validate.Struct(&testStruct{Role: roleName}); err != nil {
msg := fmt.Sprintf("role name %s is not valid", roleName)
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
roleInfo, users, err := h.core.GetRoleWithLinkedUsers(r.Context(), roleName)
if err != nil {
msg := fmt.Sprintf("Failed to query for role %s", roleName)
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusInternalServerError, msg, err.Error())
} else {
respCode = http.StatusOK
response = RespRoleInfo{
RestAPIBaseResponse: h.GetStdRESTSuccessMsg(r.Context()),
Role: roleInfo,
AssignedUsers: users,
}
}
}
// GetRoleHandler Wrapper around GetRole
func (h UserManagementHandler) GetRoleHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.GetRole(w, r)
}
}
// ====================================================================================
// User Management
// ReqNewUserParams is the API request with information on a new user
type ReqNewUserParams struct {
// User contains the new user parameters
User models.UserConfig `json:"user" validate:"required,dive"`
// Roles list the roles to assign to this user
Roles []string `json:"roles" validate:"omitempty,dive,role_name"`
}
// DefineUser godoc
// @Summary Define new user
// @Description Define a new user, and optionally assign roles to it
// @tags Management
// @Accept json
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Param userInfo body ReqNewUserParams true "New user information"
// @Success 200 {object} goutils.RestAPIBaseResponse "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/user [post]
func (h UserManagementHandler) DefineUser(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
var userInfo ReqNewUserParams
if err := json.NewDecoder(r.Body).Decode(&userInfo); err != nil {
msg := "new user parameters not parsable"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
if err := h.validate.Struct(&userInfo); err != nil {
msg := "new user parameters not valid"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
if err := h.core.DefineUser(r.Context(), userInfo.User, userInfo.Roles); err != nil {
msg := fmt.Sprintf("Failed to define new user %s", userInfo.User.UserID)
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusInternalServerError, msg, err.Error())
} else {
respCode = http.StatusOK
response = h.GetStdRESTSuccessMsg(r.Context())
}
}
// DefineUserHandler Wrapper around DefineUser
func (h UserManagementHandler) DefineUserHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.DefineUser(w, r)
}
}
// -----------------------------------------------------------------------
// RespListAllUsers is the API response listing all the users the system is managing
type RespListAllUsers struct {
goutils.RestAPIBaseResponse
// Users are the users in system
Users []models.UserInfo `json:"users" validate:"required,dive"`
}
// ListAllUsers godoc
// @Summary List all users
// @Description List all users currently managed by the system
// @tags Management
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Success 200 {object} RespListAllUsers "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/user [get]
func (h UserManagementHandler) ListAllUsers(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
users, err := h.core.ListAllUsers(r.Context())
if err != nil {
msg := "Failed to query for all users in system"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(
r.Context(), http.StatusInternalServerError, msg, err.Error(),
)
} else {
respCode = http.StatusOK
response = RespListAllUsers{
RestAPIBaseResponse: h.GetStdRESTSuccessMsg(r.Context()), Users: users,
}
}
}
// ListAllUsersHandler Wrapper around ListAllUsers
func (h UserManagementHandler) ListAllUsersHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.ListAllUsers(w, r)
}
}
// -----------------------------------------------------------------------
// fetchUserID helper function to fetch the user ID from URI path
func (h UserManagementHandler) fetchUserID(r *http.Request) (string, error) {
vars := mux.Vars(r)
userID, ok := vars["userID"]
if !ok {
return "", fmt.Errorf("missing user ID in URI path")
}
type testStruct struct {
UserID string `validate:"required,user_id"`
}
if err := h.validate.Struct(&testStruct{UserID: userID}); err != nil {
return "", err
}
return userID, nil
}
// RespUserInfo is the API response giving info on one user
type RespUserInfo struct {
goutils.RestAPIBaseResponse
// User is info on this user
User users.UserDetailsWithPermission `json:"user" validate:"required,dive"`
}
// GetUser godoc
// @Summary Get info on user
// @Description Query for information regarding one user.
// @tags Management
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Param userID path string true "User ID"
// @Success 200 {object} RespUserInfo "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/user/{userID} [get]
func (h UserManagementHandler) GetUser(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
// Get user ID
userID, err := h.fetchUserID(r)
if err != nil {
msg := "no valid user ID"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
userInfo, err := h.core.GetUser(r.Context(), userID)
if err != nil {
msg := fmt.Sprintf("Failed to query for user %s", userID)
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusInternalServerError, msg, err.Error())
} else {
respCode = http.StatusOK
response = RespUserInfo{
RestAPIBaseResponse: h.GetStdRESTSuccessMsg(r.Context()), User: userInfo,
}
}
}
// GetUserHandler Wrapper around GetUser
func (h UserManagementHandler) GetUserHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.GetUser(w, r)
}
}
// -----------------------------------------------------------------------
// DeleteUser godoc
// @Summary Delete user
// @Description Remove user from the system.
// @tags Management
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Param userID path string true "User ID"
// @Success 200 {object} goutils.RestAPIBaseResponse "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/user/{userID} [delete]
func (h UserManagementHandler) DeleteUser(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
// Get user ID
userID, err := h.fetchUserID(r)
if err != nil {
msg := "no valid user ID"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
if err := h.core.DeleteUser(r.Context(), userID); err != nil {
msg := fmt.Sprintf("Failed to delete user %s", userID)
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusInternalServerError, msg, err.Error())
} else {
respCode = http.StatusOK
response = h.GetStdRESTSuccessMsg(r.Context())
}
}
// DeleteUserHandler Wrapper around DeleteUser
func (h UserManagementHandler) DeleteUserHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.DeleteUser(w, r)
}
}
// -----------------------------------------------------------------------
// UpdateUser godoc
// @Summary Update a user's info
// @Description Update an existing user's information
// @tags Management
// @Accept json
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Param userID path string true "User ID"
// @Param userInfo body models.UserConfig true "Updated user information"
// @Success 200 {object} goutils.RestAPIBaseResponse "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/user/{userID} [put]
func (h UserManagementHandler) UpdateUser(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
// Get user ID
userID, err := h.fetchUserID(r)
if err != nil {
msg := "no valid user ID"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
var userInfo models.UserConfig
if err := json.NewDecoder(r.Body).Decode(&userInfo); err != nil {
msg := "user parameters not parsable"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
if err := h.validate.Struct(&userInfo); err != nil {
msg := "user parameters not valid"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
if err := h.core.UpdateUser(r.Context(), userID, userInfo); err != nil {
msg := fmt.Sprintf("Failed to update user %s", userID)
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusInternalServerError, msg, err.Error())
} else {
respCode = http.StatusOK
response = h.GetStdRESTSuccessMsg(r.Context())
}
}
// UpdateUserHandler Wrapper around UpdateUser
func (h UserManagementHandler) UpdateUserHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.UpdateUser(w, r)
}
}
// -----------------------------------------------------------------------
// ReqNewUserRoles is the new roles to be assigned to the user
type ReqNewUserRoles struct {
// Roles list the roles to assign to this user
Roles []string `json:"roles" validate:"omitempty,dive,role_name"`
}
// UpdateUserRoles godoc
// @Summary Update a user's roles
// @Description Change the user's roles to what caller requested
// @tags Management
// @Accept json
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Param userID path string true "User ID"
// @Param roles body ReqNewUserRoles true "User's new roles"
// @Success 200 {object} goutils.RestAPIBaseResponse "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/user/{userID}/roles [put]
func (h UserManagementHandler) UpdateUserRoles(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
// Get user ID
userID, err := h.fetchUserID(r)
if err != nil {
msg := "no valid user ID"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
var newRoles ReqNewUserRoles
if err := json.NewDecoder(r.Body).Decode(&newRoles); err != nil {
msg := "new role parameters not parsable"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
if err := h.validate.Struct(&newRoles); err != nil {
msg := "new role parameters not valid"
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusBadRequest
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusBadRequest, msg, err.Error())
return
}
if err := h.core.SetUserRoles(r.Context(), userID, newRoles.Roles); err != nil {
msg := fmt.Sprintf("Failed to set user %s roles", userID)
log.WithError(err).WithFields(logTags).Error(msg)
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(r.Context(), http.StatusInternalServerError, msg, err.Error())
} else {
respCode = http.StatusOK
response = h.GetStdRESTSuccessMsg(r.Context())
}
}
// UpdateUserRolesHandler Wrapper around UpdateUserRoles
func (h UserManagementHandler) UpdateUserRolesHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.UpdateUserRoles(w, r)
}
}
// ====================================================================================
// Utilities
// UserManagementLivenessHandler the user / role management REST API liveness handler
type UserManagementLivenessHandler struct {
goutils.RestAPIHandler
core users.Management
}
func defineUserManagementLivenessHandler(
logConfig common.HTTPRequestLogging,
core users.Management,
) UserManagementLivenessHandler {
logTags := log.Fields{
"module": "apis", "component": "api-handler", "instance": "user-management-liveness",
}
return UserManagementLivenessHandler{
RestAPIHandler: goutils.RestAPIHandler{
Component: goutils.Component{
LogTags: logTags,
LogTagModifiers: []goutils.LogMetadataModifier{
goutils.ModifyLogMetadataByRestRequestParam,
common.ModifyLogMetadataByAccessAuthorizeParam,
},
},
CallRequestIDHeaderField: &logConfig.RequestIDHeader,
DoNotLogHeaders: func() map[string]bool {
result := map[string]bool{}
for _, v := range logConfig.DoNotLogHeaders {
result[v] = true
}
return result
}(),
LogLevel: logConfig.HealthLogLevel,
}, core: core,
}
}
// Alive godoc
// @Summary User Management API liveness check
// @Description Will return success to indicate user management REST API module is live
// @tags Management
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Success 200 {object} goutils.RestAPIBaseResponse "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/alive [get]
func (h UserManagementLivenessHandler) Alive(w http.ResponseWriter, r *http.Request) {
logTags := h.GetLogTagsForContext(r.Context())
if err := h.WriteRESTResponse(
w, http.StatusOK, h.GetStdRESTSuccessMsg(r.Context()), nil,
); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}
// AliveHandler Wrapper around Alive
func (h UserManagementLivenessHandler) AliveHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.Alive(w, r)
}
}
// -----------------------------------------------------------------------
// Ready godoc
// @Summary User Management API readiness check
// @Description Will return success if user management REST API module is ready for use
// @tags Management
// @Produce json
// @Param Padlock-Request-ID header string false "User provided request ID to match against logs"
// @Success 200 {object} goutils.RestAPIBaseResponse "success"
// @Failure 400 {object} goutils.RestAPIBaseResponse "error"
// @Failure 404 {string} string "error"
// @Failure 500 {object} goutils.RestAPIBaseResponse "error"
// @Router /v1/ready [get]
func (h UserManagementLivenessHandler) Ready(w http.ResponseWriter, r *http.Request) {
var respCode int
var response interface{}
logTags := h.GetLogTagsForContext(r.Context())
defer func() {
if err := h.WriteRESTResponse(w, respCode, response, nil); err != nil {
log.WithError(err).WithFields(logTags).Error("Failed to form response")
}
}()
if err := h.core.Ready(); err != nil {
respCode = http.StatusInternalServerError
response = h.GetStdRESTErrorMsg(
r.Context(), http.StatusInternalServerError, "not ready", err.Error(),
)
} else {
respCode = http.StatusOK
response = h.GetStdRESTSuccessMsg(r.Context())
}
}
// ReadyHandler Wrapper around Alive
func (h UserManagementLivenessHandler) ReadyHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
h.Ready(w, r)
}
}