SAC-5 Update User PATCH #28

michael-brennan2005 · 2024-01-19T21:29:43Z

Description

Link to Ticket

This PR:

Implements the PATCH update user endpoint, specified in the JIRA ticket
Adds the UserParams struct for validation and creating a models.User from, and which can hopefully be reused for POST create user requests.

How Has This Been Tested?

3 Tests can be found in tests/user_test.go:

Successful update (returns 200)
Invalid update due to invalid request parameters (returns 400)
Invalid update due to invalid id (returns 404)

Checklist

[X ] I have performed a self-review of my code
I have reached out to another developer to review my code
I have commented my code, particularly in hard-to-understand areas
New and existing unit tests pass locally with my changes

…to use it

garrettladley

Great job @michael-brennan2005 & @melodyyu754 👏 ❗Some minor feedback and some things @DOOduneye and I have to figure out. Super solid PR and attention to detail. So proud 😁

garrettladley · 2024-01-19T22:58:07Z

frontend/yarn.lock

can we untrack this?

ignore this, we need to track it

reasoning
https://classic.yarnpkg.com/en/docs/migrating-from-npm

garrettladley · 2024-01-19T22:58:33Z

frontend/node_modules/.yarn-integrity

can we untrack this?

backend/src/types/user_params.go

backend/src/transactions/user.go

backend/src/services/user.go

backend/src/controllers/user.go

garrettladley · 2024-01-19T23:10:40Z

backend/src/utilities/validator.go

good stuff! conceptual question for you guys, should adding an approved email domain require a code change 🤔 ? see the config directory and config.go for how we could handle this 🦀

garrettladley · 2024-01-19T23:11:41Z

backend/src/utilities/validator.go

could we test this validation here

garrettladley · 2024-01-19T23:12:50Z

backend/tests/api/user_test.go

@@ -39,3 +40,121 @@ func TestGetAllUsersWorks(t *testing.T) {
 	// assert that the user returned from the database is the same as the user returned from the API
 	assert.Equal(dbUser, respUser)
 }
+
+func TestUpdateUserWorks(t *testing.T) {


see this new PR for an improvement to our testing helpers!

backend/src/controllers/user.go

backend/src/services/user.go

backend/src/types/user_params.go

DOOduneye · 2024-01-19T22:55:42Z

backend/src/utilities/validator.go

 )

+func ValidateEmail(fl validator.FieldLevel) bool {
+	email, err := emailaddress.Parse(fl.Field().String())


might be worth it to take advantage of regex over importing a utility if you have the time

backend/src/utilities/validator.go

backend/src/types/user_params.go

backend/src/services/user.go

Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: Garrett Ladley <[email protected]> Co-authored-by: garrettladley <[email protected]>

garrettladley · 2024-01-21T21:48:17Z

backend/src/transactions/user.go

@@ -16,3 +16,22 @@ func GetAllUsers(db *gorm.DB) ([]models.User, error) {

 	return users, nil
 }
+
+func UpdateUser(db *gorm.DB, id string, user models.User) (*models.User, error) {


Suggested change

func UpdateUser(db *gorm.DB, id string, user models.User) (*models.User, error) {

func UpdateUser(db *gorm.DB, id uint, user models.User) (*models.User, error) {

garrettladley · 2024-01-21T21:50:03Z

backend/src/services/user.go

@@ -19,3 +23,30 @@ type UserService struct {
 func (u *UserService) GetAllUsers() ([]models.User, error) {
 	return transactions.GetAllUsers(u.DB)
 }
+
+// Updates a user
+func (u *UserService) UpdateUser(id string, params models.UpdateUserRequestBody) (*models.User, error) {


for standardization, use utilities.ValidateID to validate and convert id into a uint at some point before passing id to transaction. see UpdateTag for inspo

garrettladley

Also see my reply to your message on Slack

Co-authored-by: Garrett Ladley <[email protected]>

…ssecary validation

…to use it

…ssecary validation

Co-authored-by: Melody Yu <[email protected]> Co-authored-by: Garrett Ladley <[email protected]> Co-authored-by: Zackary Lassetter <[email protected]> Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: garrettladley <[email protected]> Co-authored-by: David Oduneye <[email protected]> Co-authored-by: David Oduneye <[email protected]>

yu-melody and others added 8 commits January 16, 2024 16:53

feat: PATCH UpdateUser initial commit

d672b26

test: PATCH UpdateUser tests

57f5526

feat: PATCH UpdateUser - introduce UserParams struct & refactor code …

d885380

…to use it

Merge branch 'main' into SAC-5-Update-User-PATCH

a82c5d5

feat: PATCH UpdateUser - fiber error handling + swagger docs

5b94a3c

feat: PATCH UpdateUser - redo validation to use go-validator library

f87db2c

Merge branch 'main' into SAC-5-Update-User-PATCH

294f5cd

chore: fix merging

9f7e80e

michael-brennan2005 requested review from DOOduneye, alderwhiteford and garrettladley January 19, 2024 21:29

michael-brennan2005 assigned michael-brennan2005 and yu-melody Jan 19, 2024

michael-brennan2005 removed request for DOOduneye, alderwhiteford and garrettladley January 19, 2024 21:31

Merge branch 'main' into SAC-5-Update-User-PATCH

51318bd

garrettladley requested review from a team, edwinliiiii, DOOduneye and garrettladley and removed request for a team January 19, 2024 21:42

garrettladley changed the title ~~Sac 5 update user patch~~ SAC-5 Update User PATCH Jan 19, 2024

garrettladley requested changes Jan 19, 2024

View reviewed changes

Merge branch 'main' into SAC-5-Update-User-PATCH

21cde93

DOOduneye suggested changes Jan 20, 2024

View reviewed changes

michael-brennan2005 added 2 commits January 21, 2024 15:01

Merge branch 'main' into SAC-5-Update-User-PATCH

ec56f0a

chore: merge errors

9d6142d

zacklassetter and others added 2 commits January 21, 2024 15:04

SAC-6 Get User GET (#14)

5c57959

Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: Garrett Ladley <[email protected]> Co-authored-by: garrettladley <[email protected]>

fix: PATCH UpdateUser, adding requested changes

f534d68

garrettladley reviewed Jan 21, 2024

View reviewed changes

garrettladley requested changes Jan 21, 2024

View reviewed changes

DOOduneye and others added 21 commits January 21, 2024 21:42

CLI Updates (#40)

adbeeff

Co-authored-by: Garrett Ladley <[email protected]>

relative paths for cli, can run anywhere

048def1

resolved casting and model manipulation

c4ed6eb

Update auto_request_review.yml

e76a317

fix: fix UpdateUser transaction to use uint instead of string, add ne…

96dd0fc

…ssecary validation

Validator singleton (#43)

83bb7cf

rebase'

fbed175

feat: PATCH UpdateUser initial commit

47c2e2e

test: PATCH UpdateUser tests

5e37291

feat: PATCH UpdateUser - introduce UserParams struct & refactor code …

233ec1f

…to use it

feat: PATCH UpdateUser - fiber error handling + swagger docs

19244fb

feat: PATCH UpdateUser - redo validation to use go-validator library

6de9c6e

chore: fix merging

987be83

chore: merge errors

d07a6de

fix: PATCH UpdateUser, adding requested changes

e1057df

resolved casting and model manipulation

ad2ecfb

fix: fix UpdateUser transaction to use uint instead of string, add ne…

036e31e

…ssecary validation

rebase'

50c8f24

refactor: design to increase standardization

ded313d

rebase

141d946

removed duplicate functions

375abb2

DOOduneye merged commit de0127b into main Jan 22, 2024
2 checks passed

DOOduneye deleted the SAC-5-Update-User-PATCH branch January 22, 2024 20:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SAC-5 Update User PATCH #28

SAC-5 Update User PATCH #28

michael-brennan2005 commented Jan 19, 2024 •

edited

Loading

garrettladley left a comment

garrettladley Jan 19, 2024

DOOduneye Jan 19, 2024

DOOduneye Jan 19, 2024

garrettladley Jan 19, 2024

garrettladley Jan 19, 2024

garrettladley Jan 19, 2024

garrettladley Jan 19, 2024 •

edited

Loading

DOOduneye Jan 19, 2024

garrettladley Jan 21, 2024

garrettladley Jan 21, 2024

garrettladley left a comment

	func UpdateUser(db gorm.DB, id string, user models.User) (models.User, error) {
	func UpdateUser(db gorm.DB, id uint, user models.User) (models.User, error) {

SAC-5 Update User PATCH #28

SAC-5 Update User PATCH #28

Conversation

michael-brennan2005 commented Jan 19, 2024 • edited Loading

Description

How Has This Been Tested?

Checklist

garrettladley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

garrettladley Jan 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

garrettladley left a comment

Choose a reason for hiding this comment

michael-brennan2005 commented Jan 19, 2024 •

edited

Loading

garrettladley Jan 19, 2024 •

edited

Loading