From c26cd3b9fe1ed2545e6d9b7c5b9a5f22ed30f53b Mon Sep 17 00:00:00 2001 From: Pascal Fischer Date: Tue, 28 Feb 2023 15:46:08 +0100 Subject: [PATCH] add comments for constructors and fix typo --- management/server/http/groups_handler.go | 1 + management/server/http/handler.go | 2 +- management/server/http/peers_handler.go | 1 + management/server/http/routes_handler.go | 22 +++++++++---------- management/server/http/routes_handler_test.go | 4 ++-- management/server/http/rules_handler.go | 1 + management/server/http/setupkeys_handler.go | 1 + management/server/http/users_handler.go | 13 ++++++----- management/server/http/users_handler_test.go | 4 ++-- 9 files changed, 27 insertions(+), 22 deletions(-) diff --git a/management/server/http/groups_handler.go b/management/server/http/groups_handler.go index 17f3168a2..9712d2e75 100644 --- a/management/server/http/groups_handler.go +++ b/management/server/http/groups_handler.go @@ -23,6 +23,7 @@ type GroupsHandler struct { claimsExtractor *jwtclaims.ClaimsExtractor } +// NewGroupsHandler creates a new GroupsHandler HTTP handler func NewGroupsHandler(accountManager server.AccountManager, authCfg AuthCfg) *GroupsHandler { return &GroupsHandler{ accountManager: accountManager, diff --git a/management/server/http/handler.go b/management/server/http/handler.go index f5b9fccc1..2749880ee 100644 --- a/management/server/http/handler.go +++ b/management/server/http/handler.go @@ -46,7 +46,7 @@ func APIHandler(accountManager s.AccountManager, appMetrics telemetry.AppMetrics rulesHandler := NewRulesHandler(accountManager, authCfg) peersHandler := NewPeersHandler(accountManager, authCfg) keysHandler := NewSetupKeysHandler(accountManager, authCfg) - userHandler := NewUserHandler(accountManager, authCfg) + userHandler := NewUsersHandler(accountManager, authCfg) routesHandler := NewRoutesHandler(accountManager, authCfg) nameserversHandler := NewNameserversHandler(accountManager, authCfg) eventsHandler := NewEventsHandler(accountManager, authCfg) diff --git a/management/server/http/peers_handler.go b/management/server/http/peers_handler.go index 34c52c36e..a0bf09b7b 100644 --- a/management/server/http/peers_handler.go +++ b/management/server/http/peers_handler.go @@ -20,6 +20,7 @@ type PeersHandler struct { claimsExtractor *jwtclaims.ClaimsExtractor } +// NewPeersHandler creates a new PeersHandler HTTP handler func NewPeersHandler(accountManager server.AccountManager, authCfg AuthCfg) *PeersHandler { return &PeersHandler{ accountManager: accountManager, diff --git a/management/server/http/routes_handler.go b/management/server/http/routes_handler.go index 09b842eba..b29e5c261 100644 --- a/management/server/http/routes_handler.go +++ b/management/server/http/routes_handler.go @@ -15,15 +15,15 @@ import ( "github.com/netbirdio/netbird/route" ) -// RoutesHanlder is the routes handler of the account -type RoutesHanlder struct { +// RoutesHandler is the routes handler of the account +type RoutesHandler struct { accountManager server.AccountManager claimsExtractor *jwtclaims.ClaimsExtractor } -// NewRoutesHandler returns a new instance of RoutesHanlder handler -func NewRoutesHandler(accountManager server.AccountManager, authCfg AuthCfg) *RoutesHanlder { - return &RoutesHanlder{ +// NewRoutesHandler returns a new instance of RoutesHandler handler +func NewRoutesHandler(accountManager server.AccountManager, authCfg AuthCfg) *RoutesHandler { + return &RoutesHandler{ accountManager: accountManager, claimsExtractor: jwtclaims.NewClaimsExtractor( jwtclaims.WithAudience(authCfg.Audience), @@ -33,7 +33,7 @@ func NewRoutesHandler(accountManager server.AccountManager, authCfg AuthCfg) *Ro } // GetAllRoutes returns the list of routes for the account -func (h *RoutesHanlder) GetAllRoutes(w http.ResponseWriter, r *http.Request) { +func (h *RoutesHandler) GetAllRoutes(w http.ResponseWriter, r *http.Request) { claims := h.claimsExtractor.FromRequestContext(r) account, user, err := h.accountManager.GetAccountFromToken(claims) if err != nil { @@ -55,7 +55,7 @@ func (h *RoutesHanlder) GetAllRoutes(w http.ResponseWriter, r *http.Request) { } // CreateRoute handles route creation request -func (h *RoutesHanlder) CreateRoute(w http.ResponseWriter, r *http.Request) { +func (h *RoutesHandler) CreateRoute(w http.ResponseWriter, r *http.Request) { claims := h.claimsExtractor.FromRequestContext(r) account, user, err := h.accountManager.GetAccountFromToken(claims) if err != nil { @@ -94,7 +94,7 @@ func (h *RoutesHanlder) CreateRoute(w http.ResponseWriter, r *http.Request) { } // UpdateRoute handles update to a route identified by a given ID -func (h *RoutesHanlder) UpdateRoute(w http.ResponseWriter, r *http.Request) { +func (h *RoutesHandler) UpdateRoute(w http.ResponseWriter, r *http.Request) { claims := h.claimsExtractor.FromRequestContext(r) account, user, err := h.accountManager.GetAccountFromToken(claims) if err != nil { @@ -160,7 +160,7 @@ func (h *RoutesHanlder) UpdateRoute(w http.ResponseWriter, r *http.Request) { } // PatchRoute handles patch updates to a route identified by a given ID -func (h *RoutesHanlder) PatchRoute(w http.ResponseWriter, r *http.Request) { +func (h *RoutesHandler) PatchRoute(w http.ResponseWriter, r *http.Request) { claims := h.claimsExtractor.FromRequestContext(r) account, user, err := h.accountManager.GetAccountFromToken(claims) if err != nil { @@ -301,7 +301,7 @@ func (h *RoutesHanlder) PatchRoute(w http.ResponseWriter, r *http.Request) { } // DeleteRoute handles route deletion request -func (h *RoutesHanlder) DeleteRoute(w http.ResponseWriter, r *http.Request) { +func (h *RoutesHandler) DeleteRoute(w http.ResponseWriter, r *http.Request) { claims := h.claimsExtractor.FromRequestContext(r) account, user, err := h.accountManager.GetAccountFromToken(claims) if err != nil { @@ -325,7 +325,7 @@ func (h *RoutesHanlder) DeleteRoute(w http.ResponseWriter, r *http.Request) { } // GetRoute handles a route Get request identified by ID -func (h *RoutesHanlder) GetRoute(w http.ResponseWriter, r *http.Request) { +func (h *RoutesHandler) GetRoute(w http.ResponseWriter, r *http.Request) { claims := h.claimsExtractor.FromRequestContext(r) account, user, err := h.accountManager.GetAccountFromToken(claims) if err != nil { diff --git a/management/server/http/routes_handler_test.go b/management/server/http/routes_handler_test.go index 58c2ff9c7..5862910ab 100644 --- a/management/server/http/routes_handler_test.go +++ b/management/server/http/routes_handler_test.go @@ -61,8 +61,8 @@ var testingAccount = &server.Account{ }, } -func initRoutesTestData() *RoutesHanlder { - return &RoutesHanlder{ +func initRoutesTestData() *RoutesHandler { + return &RoutesHandler{ accountManager: &mock_server.MockAccountManager{ GetRouteFunc: func(_, routeID, _ string) (*route.Route, error) { if routeID == existingRouteID { diff --git a/management/server/http/rules_handler.go b/management/server/http/rules_handler.go index a2a35d5cc..2dd2e7511 100644 --- a/management/server/http/rules_handler.go +++ b/management/server/http/rules_handler.go @@ -20,6 +20,7 @@ type RulesHandler struct { claimsExtractor *jwtclaims.ClaimsExtractor } +// NewRulesHandler creates a new RulesHandler HTTP handler func NewRulesHandler(accountManager server.AccountManager, authCfg AuthCfg) *RulesHandler { return &RulesHandler{ accountManager: accountManager, diff --git a/management/server/http/setupkeys_handler.go b/management/server/http/setupkeys_handler.go index 3366f7a94..316ac97ec 100644 --- a/management/server/http/setupkeys_handler.go +++ b/management/server/http/setupkeys_handler.go @@ -20,6 +20,7 @@ type SetupKeysHandler struct { claimsExtractor *jwtclaims.ClaimsExtractor } +// NewSetupKeysHandler creates a new SetupKeysHandler HTTP handler func NewSetupKeysHandler(accountManager server.AccountManager, authCfg AuthCfg) *SetupKeysHandler { return &SetupKeysHandler{ accountManager: accountManager, diff --git a/management/server/http/users_handler.go b/management/server/http/users_handler.go index bfb3c4220..848c3ee50 100644 --- a/management/server/http/users_handler.go +++ b/management/server/http/users_handler.go @@ -14,13 +14,14 @@ import ( "github.com/netbirdio/netbird/management/server/jwtclaims" ) -type UserHandler struct { +type UsersHandler struct { accountManager server.AccountManager claimsExtractor *jwtclaims.ClaimsExtractor } -func NewUserHandler(accountManager server.AccountManager, authCfg AuthCfg) *UserHandler { - return &UserHandler{ +// NewUsersHandler creates a new UsersHandler HTTP handler +func NewUsersHandler(accountManager server.AccountManager, authCfg AuthCfg) *UsersHandler { + return &UsersHandler{ accountManager: accountManager, claimsExtractor: jwtclaims.NewClaimsExtractor( jwtclaims.WithAudience(authCfg.Audience), @@ -30,7 +31,7 @@ func NewUserHandler(accountManager server.AccountManager, authCfg AuthCfg) *User } // UpdateUser is a PUT requests to update User data -func (h *UserHandler) UpdateUser(w http.ResponseWriter, r *http.Request) { +func (h *UsersHandler) UpdateUser(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPut { util.WriteErrorResponse("wrong HTTP method", http.StatusMethodNotAllowed, w) return @@ -76,7 +77,7 @@ func (h *UserHandler) UpdateUser(w http.ResponseWriter, r *http.Request) { } // CreateUser creates a User in the system with a status "invited" (effectively this is a user invite). -func (h *UserHandler) CreateUser(w http.ResponseWriter, r *http.Request) { +func (h *UsersHandler) CreateUser(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { util.WriteErrorResponse("wrong HTTP method", http.StatusMethodNotAllowed, w) return @@ -116,7 +117,7 @@ func (h *UserHandler) CreateUser(w http.ResponseWriter, r *http.Request) { // GetAllUsers returns a list of users of the account this user belongs to. // It also gathers additional user data (like email and name) from the IDP manager. -func (h *UserHandler) GetAllUsers(w http.ResponseWriter, r *http.Request) { +func (h *UsersHandler) GetAllUsers(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodGet { util.WriteErrorResponse("wrong HTTP method", http.StatusMethodNotAllowed, w) return diff --git a/management/server/http/users_handler_test.go b/management/server/http/users_handler_test.go index 1675f39f1..9bba1c472 100644 --- a/management/server/http/users_handler_test.go +++ b/management/server/http/users_handler_test.go @@ -14,8 +14,8 @@ import ( "github.com/netbirdio/netbird/management/server/mock_server" ) -func initUsers(user ...*server.User) *UserHandler { - return &UserHandler{ +func initUsers(user ...*server.User) *UsersHandler { + return &UsersHandler{ accountManager: &mock_server.MockAccountManager{ GetAccountFromTokenFunc: func(claims jwtclaims.AuthorizationClaims) (*server.Account, *server.User, error) { users := make(map[string]*server.User, 0)