Roberto fix assigning duplicate badges

[robertoooc]

Description

Whenever trying to manually assign badges to a user and duplicate badges are involved there aren't any clear updates being made. There was no logic to handle duplicate badges which would not allow badges to be updated anymore.

Related PRS (if any):

Use latest frontend

Main changes explained:

• Shortened fillEarnedDateToMatchCount function to handle all logic itself not needing a second helper function, also added edge case of user trying to lower badges count
• Added logic to assignBadge function to handle instances of duplicate badges and merge them to one with updated variables.

How to test:

1. check into current branch
2. go to src/controllers/userProfileController.js, comment out lines 579 - 583. This step is important to clear backend cache, clearing cache through browser won't help when making changes to mongo compass and wanting to see changes immediately
3. do npm install and npm run build && npm start to run this PR locally
4. log as admin user
5. go to any user profile and make sure they have at least 2 different badges assigned to them
6. create duplicate badges, here's a quick way to do this:

How.to.force.duplicates.mov

8. Verify that either assigning a new badge or even incrementing count of any badge results in duplicate badges being merged.

Screenshots or videos of changes:

Fixed.mov

Note:

Make sure to follow step 2, if you make changes to the database through mongo compass, you won't see immediate changes in frontend due to the backend cache still not being renewed

[jerryren527]

Hi, @robertoooc ,

This is a great solution for the issue of having duplicate badges and no real logic to handle this case! Your solution is elegant and works correctly according to my testing. Your code for the fillEarnedDateToMatchCount() function works well too. In my testing demonstration, I had two duplicate badges with multiple different earned dates. And after the two duplicate badges merge into one badge, all the earned dates are present and sorted in order. Great job!

fix.assigning.duplicate.badges.earned.dates.correct.mp4

[ilyaflaks]

I reviewed the functionality and the code changes and everything works well!
Reproduced the issue by editing badge UUID in Compass:

Assigned a new badge of a different kind on the front end:

The duplicates are now grouped together:

I then reproduced the problem again and tested if changing the badge count groups the badges:

The duplicate badges are grouped together!

Very good, clean code! fillEarnedDateToMatchCount is now much more robust and the overall logic of combining "earnedDate" is now easier to follow

[ChengyanOo]

Hi @robertoooc,

Excellent work on implementing the new feature! I've thoroughly reviewed your code and can confirm that the changes are functioning as intended. Keep up the good work!

HGNRest_PR.666.mov

[pshereen]

Tested the PR.
The implemented feature is working as per the requirement.
Added two new badges to a user.

Incremented count of one of the badges from 1 to 3. And the duplicate badges are grouped together.

The edge case of user trying to lower badges count is also handled.

[Renanluizssx]

Hi @robertoooc, i reviewed your application and it's correct, nice.

2024-01-26-04-52-48.mov

[xmyoot]

Hi Roberto, I reviewed your badge feature on the front end and it looks great! working properly please reference video:

PR.666.mov

[Pandani07]

Reviewed your PR and works as intended! Great
The duplicates are grouped together and after that, all the earned dates are retained and organized in sequential order

[XiaohanMeng]

Hi @robertoooc,

I've tested the PR you submitted, and I'm pleased to report that it runs smoothly and the code is efficient. My testing procedure involved the following steps: I used an admin account to change the badge of a volunteer account; then, in MongoDB Compass, I modified the badge to be the same as another; upon refreshing, all identical badges were successfully merged. Additionally, I observed that adding a badge also results in the merging of identical badges. Well done on implementing this feature.

BE-666-result.mov

[brandta-1]

Review

I've reviewed the code in src/controllers/badgeController.js and tested through the front end as well as MongoDB Compass. The changes are functioning correctly.

Videos:

Splitting duplicate badge dates through MongoDB:

00_split_duplicate_MongoDB.mov

Creating duplicate badge dates through MongoDB:

01_duplicate_MongoDB.mov

Creating duplicate badge as front-end admin:

02_duplicate_front-end.mov

[huangweihou]

Hi Roberto, The duplicate badges updated correctly and please use the screenshots as reference:

[peterson337]

HI Roberto, I tested your application, and everything worked as expected. Good job!

[Coops023]

Hi Roberto, i reviewed this PR and everything works as it should, great job on this one!

[psharma1984]

Reviewed the PR, it works efficiently. I used an admin account to change the badge of another account; then, in MongoDB Compass, upon refreshing, found that all identical badges were successfully merged and saw the increase of the badge count as i added new badge. Screenshots for reference below

[Weiyao-Li]

Following exactly the same step and encountering error during the build:

[PratimaSingh02]

duplicate_badge.mp4

I reviewed the functionality and it works well.
When adding new badges the duplicate badge created via Compass gets merged.
However assigning a new same type of badge from the frontend again, might give a wrong count (as shown in the video). It shows one extra badge when adding the same badge, after changing directly in database.

[robertoooc]

@Weiyao-Li, I've tried compiling my code with the same command but don't face that issue at all.
Is this an issue you've encountered on other branches like development as well?

[robertoooc]

@PratimaSingh02, nice catch! Seems like some new FE changes may have caused this problem.
OneCommunityGlobal/HighestGoodNetworkApp#1999
This new pr ^^ helps fix this issue.

[DiegoSalas27]

Hi @robertoooc . Nice work. Your code seems clean and well written. I have some questions regarding the behavior (since there could be other alternative flows in the bagde assigning process). I have attached a video with related questions about how the webpage should behave in different scenarions. Overall, I really like the simplicity of your code, it was very easy to follow along.

screen-recording-2024-03-01-at-90140-am_6gPihOV5.mp4

[Sarthak32]

Nice work! Your code is well-organized and easy to understand. It functions seamlessly.(There seems to be no duplication of badges) Here's how I tested it...

[PratimaSingh02]

The merge functionality seems to be working great except the wrong count that shows up when adding the same type of badges. Approving the change as new PR has been created for the same.

[one-community]

Thank you all, moving to final review.

[ChengyanOo]

Great work, I went through your code and didn't found any code smells. Check out the last comment I left for the video

[robertoooc]

@DiegoSalas27, to clarify any doubts mentioned in your video:
We're currently using the mongodb GUI to force duplicate badges, the cause for this is because there have been some occasions where we've seen duplicate badges pop up in a user's profile and it's not fully clear how they're being generated, so for testing purposes I am having people use the GUI to force duplicates and check the new logic fixes the bug. A duplicate badge in this case is the array of badgesCollection having instances where there are more than one object with the same badgeId as another, so basically at some point the logic was flawed and would push a new instance of a badge to the array rather than updating the contents of the object. Our previous logic for this route would also break when you tried to update the badgeCollection array if it contained duplicates because it didn't know how to handle it.
Another thing you may have mentioned in your video was about the counts, the logic is supposed to merge the counts by adding them and all other variables of the badge if there are duplicates.

[DiegoSalas27]

@DiegoSalas27, to clarify any doubts mentioned in your video:

We're currently using the mongodb GUI to force duplicate badges, the cause for this is because there have been some occasions where we've seen duplicate badges pop up in a user's profile and it's not fully clear how they're being generated, so for testing purposes I am having people use the GUI to force duplicates and check the new logic fixes the bug. A duplicate badge in this case is the array of badgesCollection having instances where there are more than one object with the same badgeId as another, so basically at some point the logic was flawed and would push a new instance of a badge to the array rather than updating the contents of the object. Our previous logic for this route would also break when you tried to update the badgeCollection array if it contained duplicates because it didn't know how to handle it.

Another thing you may have mentioned in your video was about the counts, the logic is supposed to merge the counts by adding them and all other variables of the badge if there are duplicates.

Got it. Thank you for clarifying that.

[666saofeng]

Hi Roberto, it worked as intended. Great job!

HGN.APP.-.Google.Chrome.2024-03-13.18-08-51.mp4

[cvtqx]

Works as described - duplicate badges are grouped together.

1. User with assigned badges:

2. Added a duplicate badge to this user and the badges are grouped:

3. The issue dates of duplicates are displayed correctly:

4.Incremented count, duplicate badges are grouped together and the count is correct:

Great job!

[one-community]

Thank you all, merging!