API v3 Short-Term Roadmap 1

[paglias]

This is a list of small items regarding the upcoming API v3. If you plan to make a Pull Request just announce it with a comment. We'd like to have atomic PRs so each one should only implement 1 route and its tests, if you plan to do more (awesome!) just propose separate PRs. All PRs must be done against the api-v3-groups branch.

Members

• tests for getMember route
• option to always populate leader? (on hold)
• route to get members for challenges and tests (assigned to @paglias)

Groups

• tests for remove group member route (assigned to @TheHollidayInn, in progress)
• tests for get group route (assigned to @TheHollidayInn, in progress)
• tests for get groups route (assigned to @TheHollidayInn, in progress)
• tests for leave group route (assigned to @TheHollidayInn, in progress)
• tests for join group route (assigned to @KristianTashkov , in progress)

Challenges

• Challenge.getChallenge (assigned to @paglias)
• Get challenges for group and tests (assigned to @paglias)
• Update challenge route and tests (assigned to @paglias)
• Challenge export to CSV route and tests (assigned to @paglias)
• Get member progress route and tests (assigned to @paglias)
• join route and tests (assigned to @KristianTashkov)
• leave route and tests (assigned to @KristianTashkov)
• user.unlink (assigned to @paglias)
• tests for select winner route (assigned to @KristianTashkov)
• tests for delete route (assigned to @KristianTashkov)
• tests for create route (assigned to @crookedneighbor)
• tests for get single challenge route
• populate leader and group info

Chat

• clearFlagCount route and tests (assigned to @TheHollidayInn)
• seenMessage route and tests (assigned to @TheHollidayInn)
• deleteChatMessage route and tests (assigned to @TheHollidayInn)

Quest

• quests/invite route and tests (wip pr WIP: Quests for API v3 #6565)
• quests/accept route and tests (wip pr WIP: Quests for API v3 #6565)
• quests/reject route and tests (wip pr Added quest reject route and intial tests #6640)
• quests/cancel route and tests (wip pr Added quest cancel route and initial tests #6654)
• quests/abort route and tests (wip pr Added quest abort route and initial tests #6662)
• quests/leave route and tests (wip pr Added quest leave route and initial tests #6655)

Tasks

• clearCompleted todos route and tests
• getTasks route: add ability to get only completed todos (assigned to @paglias)
• fix move task and tests (assigned to @paglias)
• score task: when a todo is un-completed dateCompleted attribute must be removed (assigned to @paglias)
• unlinkTask route (assigned to @paglias)

Cron

• decide whether to move code to /src and tests (on hold for now)
• unit tests

Unit tests

• Group.getGroup
• challenges methods for access control (canView, canModify, hasAccess, isMember)
• Tests for challenges tasks routes, sync and user.unlinkChallengesTasks
• tests for unlinkTask route

Other

• Go though pending tests (on hold)
• port new history preening (assigned to @paglias)

[paglias]

I forgot, all PRs must be done against the api-v3-groups branch.

[GeorgeSG]

I want to start with something simple, so I think I'll try this one: tests for get group route :)

[paglias]

@GeorgeSG I may have made an error, I think that one has already been taken by @TheHollidayInn along with the one for getting all groups. I'm sorry, I'll update the issue once I get home

[paglias]

@GeorgeSG I've updated the issue, if you wanted to try something simple I'd probably suggest tests for remove group member route or tests for getMember route but this second one is currently in the api-v3-members branch, I'd reccomend the first one since it's in a more stable branch

[KristianTashkov]

@paglias reserving Challenges join and leave. If I take too long with the join route, someone can take leave 😸

[paglias]

@KristianTashkov great :) I'd do join before since there's already the code to sync data to a user (challenge.syncToUser). Note that this method still needs testing so if it doesn't work and the reason of the fail is not obvious or not easy to fix, ignore it (maybe out a TODO) and we'll enable it when it works. Also syncToUser has been rewritten in api-v3-challenges-tasks so you should probably PR against that branch

For leave you'll need to implement a method to remove challenge data from the user, the old one that we used in v2 was user.unlink that you can find in the user model

[TheHollidayInn]

I'm still working through the groups stuff, but I can continue working on the chat routes as we go. I need to work on them for some tests any way.

[SabreCat]

I've been spending so much of my days on architecture and support that I haven't been coding as much as I'd like to, but I'd like to help out with this at least a little. Maybe some of the Quests stuff would be the right size.

[paglias]

@SabreCat just assign yourself to one of those items (or to all!) :)
@TheHollidayInn I'll assign you to the chat routes

[SabreCat]

Claimed the first one off the list. Hopefully by aiming small I can follow through OK :p

[SabreCat]

I have tests almost done for /quest/invite. Could y'all smart people take a look at https://github.com/HabitRPG/habitrpg/pull/6565/files and share thoughts before I get into the route? There's one test I've commented that I'm not sure what the expected result should be, in particular.

[TheHollidayInn]

Awesome! I'll take a look in the next few minutes.

[KristianTashkov]

@paglias sign me up for the remaining two challenge tasks

[paglias]

@KristianTashkov the tests for create and select winner routes?