feat(api): Endpoints for classroom - exchanging user data

[NewtonLC]

Co-Authored by:
@CarlyAThomas
@ZhenyuYu1

Checklist:

• I have read and followed the contribution guidelines.
• I have read and followed the how to open a pull request guide.
• My pull request targets the main branch of freeCodeCamp.
• I have tested these changes either locally on my machine, or Gitpod.

Closes freeCodeCamp/classroom#548

This issue calls for the Classroom App to retrieve real users' data directly from freeCodeCamp proper, which is vital for making the Classroom App work. This will allow teachers to monitor students' progress and activity in the freeCodeCamp curriculum.

This PR creates an API endpoint in freeCodeCamp that allows the Classroom App to fetch students' completed challenge data from their usernames. Since users' completedChallenges attribute does not contain metadata about the completed challenges(name, certification, etc.), we also created an endpoint that maps challenge IDs to challenge metadata, then returns this map. The Classroom App will call this endpoint in order to retrieve the map, which will be used to help display the challenges.

[raisedadead]

Action Items:

@raisedadead:

• will create the curriculum server repository with all the wiring in it so the @freeCodeCamp/classroom team can expand the same as per the needs of the classroom app
• will document steps for the Classroom team to setup and start working on it. It will be available in the project README.

@freecodecamp/classroom:

• needs to remove the build curriculum endpoints entirely, since the functionality will be made available via the above.

This PR:

• will need another endpoint to send a single email and retrieve the user id (camper's id), classroom can store the User id in its own DB. The user id will not change (emails can).
• the get-user-data endpoint needs to:
  • send user ids (batch is OK) to retrieve the data it needs
  • check the user consent (more on this later) is given before sending the data out

User consent:

• will need a separate PR (@raisedadead will share code examples) to add a check box to the settings page UI
• the check box can map to a isClassroomAccount prop on the user -- false by default

[raisedadead]

I have left my quick notes on this PR from the meeting. We can discuss more on this async if you prefer in the Google Chat room we have for this.

[raisedadead]

Update: #62891 will add the consent settings.

freeCodeCamp's API will only return data when isClassroomAccount true. This restriction will need to be baked into this PR for acceptance

[NewtonLC]

Update: @CarlyAThomas and I have completed the Action items listed for the classroom team for this PR. When retrieving student data from Classroom, we are explicitly skipping students who did not give permission.

[raisedadead]

Great! https://github.com/freeCodeCamp/curriculum-db is also coming along nicely.

[ojeytonwilliams]

Thanks for the updates @NewtonLC and @CarlyAThomas, this looks like what we want. I found a few things, but nothing serious - just minor tweaks and suggestions to be a little more consistent with the rest of the codebase.

[CarlyAThomas]

We have updated the PR based on your suggestions. One note though, we are still looking into how we would like to specify the shape of the userData object and will need to get back to you on this specific.

Thank you for reviewing our PR!

[ojeytonwilliams]

Thanks, @CarlyAThomas, no rush. I'm still discussing with Mrugesh how we want to go about querying for the classroom accounts. It might be easier to go with your original approach (we need fewer indexes that way). I'll let you know.

[ojeytonwilliams]

Sorry for the lack of updates, but this approach should be fine.

Could you add some simple tests to lock this down? Something that checks the expected output would have caught the fact that challengeName doesn't exist.

[NewtonLC]

Hello @ojeytonwilliams! I added some simple test cases for the classroom endpoints. Here's a quick summary:
get-user-ids tests:
Call with incorrectly formatted email --> 200 Status, return ''
No classroom account matches email --> 200 Status, return ''
A classroom account matches email --> 200 Status, return camper ID
Other failed database query --> 500 Error

get-user-data tests:
Call with more than 50 camper IDs --> 400 Error
Call with 50 or fewer camper IDs --> 200 Status, return record of camper's data
Other failed database query --> 500 Error

Unauthenticated call --> 401 Error

[NewtonLC]

Hello! Just a quick note to say that this PR is ready for review. Thank you!