search

HabitRPG / habitica

A habit tracker app which treats your goals like a Role Playing Game.
https://habitica.com
Other
11.82k stars 4.05k forks source link

Achievements Refactoring #11541

Open paglias opened 4 years ago

paglias commented 4 years ago

We've found out that the achievements code is unnecessarily complex and difficult to manage, both on client and server which caused a few bugs, it should be simplified:

Instead of having a different notification type for each achievement (https://github.com/HabitRPG/habitica/blob/develop/website/server/models/userNotification.js#L36-L49) we should use one single type (maybe ACHIEVEMENT) with the data object of the achievement notification containing:

This should allow for a big simplification of the client side code here https://github.com/HabitRPG/habitica/blob/develop/website/client/src/components/notifications.vue#L137

UPDATE by @SabreCat 5/24/2022: We've done a chunk of this work, condensing the many different notification types related to achievements down to a handful of categories. We could go still further, though, to get down to just the ACHIEVEMENT type with the right data for parsing across platforms--the trick will be getting all the right data, strings, etc. without breaking anything in the process.

paglias commented 4 years ago

Also see #11257

moniwang commented 4 years ago

Hello, can I take on this request?

Alys commented 4 years ago

@moniwang Sure, thanks! Post here if you have questions.

moniwang commented 4 years ago

What are some of the bugs that occurred because of this achievements code?

paglias commented 4 years ago

@moniwang mainly some achievements did not show up correctly and were fixed in https://github.com/HabitRPG/habitica/commit/2842087a432d7d31de1b98fe751102e079ee33fc

so right now there are no bugs due to this but it would be great if we could change the way it works to make it less error prone for the future, let me know if you have any question :)

Helcostr commented 3 years ago

I can work on this.

Alys commented 3 years ago

@Helcostr Thanks! I've marked it as in progress for you. Sorry about the delay in our reply. Let us know if you've changed your mind since you posted!

shanaqui commented 3 years ago

Hi @Helcostr! Just checking in about this one as well. :)

Helcostr commented 3 years ago

You can mark as help wanted @shanaqui

shanaqui commented 3 years ago

@Helcostr Thanks for letting us know!

CuriousMagpie commented 2 years ago

I'm taking this one!