[CM-28] Generate and process post request with mastery learning info #30

naveen-nathan · 2024-11-27T09:15:12Z

Jira Ticket

Description

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Refactoring (non-breaking change)
Breaking change (fix or feature that would change existing functionality)

Changes

In progressReport/app.py
- Created the function generate_cm_from_post_parameters, which is essentially a modified version of index
- Added validation for the post request in validate_mastery_learning_post_request
- Load default school and class from progressReport/meta/defaults.json
In website/src/views/conceptMap.js
- Added a conceptMapHTML state constant, which stores the html which renders the concept map, to be embedded in the iframe. Added code to issue a post request to CM in order to retrieve the html. Removed the old studentMastery state constant.
In masterymapping/index.js
- Pasted the preexisting function getTopicsFromUser
- Created the function getMasteryMapping to generate the dictionary used in the POST request. It takes in the dictionaries userTopicPoints, maxTopicPoints, which map node names to points earned and max points respectively, and returns the dictionary which will be issued as a POST request.
In api/v2/Routes/students/index.js
- Added a route to the above functionality in masterymapping

Testing

Ran GV and confirmed that output matches data in HAID.

Checklist

My branch name matches the format: <ticket-id>/<brief-description-of-change>
My PR name matches the format: [<ticket-id>] <brief-description-of-change>
I have added doc-comments to all new functions (JSDoc for JS and Docstrings for Python)
I have reviewed all of my code
My code only contains major changes related to my ticket

Screenshots/Video

`

Additional Notes

Post Request Schema:

The "school", "class", all concepts, and all nested "class_mastery" fields are optional. CM will default to school = "Berkeley", class = "CS10", and class_mastery = 0 in lieu of these fields being provided.

{"school": [String], "class": [String], "[Insert concept name 1]": {student_mastery: [Integer], class_mastery: [Integer]}, "[Insert concept name2]":...}

progressReport/app.py

Connor-Bernard

Couple of comments and/or changes

progressReport/app.py

Connor-Bernard · 2024-12-02T20:11:35Z

For testing, you should do a local integration test using the docker stack (you can use the dev stack)

Connor-Bernard · 2024-12-02T20:11:55Z

Please add screenshots as necessary. Also, you can give an example using postman

naveen-nathan · 2024-12-02T23:47:59Z

Please add screenshots as necessary. Also, you can give an example using postman

Will do!

…rame

api/v2/Routes/students/masterymapping/index.js

progressReport/app.py

website/src/views/conceptMap.js

progressReport/app.py

Co-authored-by: Connor <[email protected]>

api/v2/Routes/students/progressquerystring/index.js

api/v2/Routes/students/masterymapping/index.js

website/src/views/conceptMap.js

api/v2/Routes/students/masterymapping/index.js

Connor-Bernard · 2025-02-12T05:33:15Z

website/src/views/conceptMap.js

+                    setConceptMapHTML(res.data);
+                });
                setLoading(false);
            });


Why do we set the concept map html twice?

When the selected student in the dropdown changes, the html for that student’s CM is retrieved and conceptMapHTML is updated accordingly. In the prior version of this file, this useEffect function used to update the query string when the selected student changed.

Oh so its twice for backwards compatibility?

Not quite. This code updates conceptMapHTML every time the selected student in the dropdown (available to users with admin privileges) changes to ensure that the corresponding CM is displayed. It isn’t to ensure backwards compatibility; I meant that this useEffect function currently serves a purpose analogous to its purpose in the prior version of this file.

TeetoToast · 2025-02-13T22:33:01Z

From what I see, when many nodes are collapsed, clicking on a node to expand it makes that node occupy a large amount of space. I believe that it would be better if each node expanded within an allocated space, regardless of how many nodes are open or closed. I don't know much about how that would be implemented, or if that's possible, but that's the only feedback I can think to give. Below is a ss where only the quest node is expanded, but as can be seen, it expands far beyond the view.

naveen-nathan · 2025-02-13T22:50:51Z

From what I see, when many nodes are collapsed, clicking on a node to expand it makes that node occupy a large amount of space. I believe that it would be better if each node expanded within an allocated space, regardless of how many nodes are open or closed. I don't know much about how that would be implemented, or if that's possible, but that's the only feedback I can think to give. Below is a ss where only the quest node is expanded, but as can be seen, it expands far beyond the view.

Thank you for the review, Aanvi. This PR does not include changes related to node formatting; the node formatting on this branch is the same as it is on main. There is a separate PR/ticket (CM-23) dedicated to solving the issue you described, though.

Connor-Bernard

LGTM (approved and QA by team)

naveen-nathan · 2025-02-20T23:53:04Z

LGTM (approved and QA by team)

Thanks a ton, Connor and CM team!!!

…30) * Process post request with mastery learning info * Restore index method to original state * Generate CM from post parameters * Access nested student and class mastery keys * Bug fix + return correct error code * Fix validation bug + load constants from file * Attempt to POST CM through the iframe + transfer CM-200 changes * Implement api endpoint to return mastery mapping and post to CM in iframe * Make dedicated router for mastery mapping + cleanup * Formatting changes * Formatting changes * Formatting changes * Formatting change * Misc. changes + optimize getTopicsFromUser * Rename variables per convention Co-authored-by: Connor <[email protected]> * Nest async function within useEffect * Minor change * Use axios to retrieve CM html * Remove error handling * Mark deprecated functions as such --------- Co-authored-by: Connor <[email protected]>

Process post request with mastery learning info

3b7a3c4

naveen-nathan requested a review from Connor-Bernard November 27, 2024 09:15

naveen-nathan commented Nov 27, 2024

View reviewed changes

progressReport/app.py Show resolved Hide resolved

naveen-nathan commented Nov 27, 2024

View reviewed changes

progressReport/app.py Outdated Show resolved Hide resolved

naveen-nathan commented Nov 28, 2024

View reviewed changes

progressReport/app.py Outdated Show resolved Hide resolved

naveen-nathan added 3 commits November 29, 2024 22:31

Restore index method to original state

6fd229c

Generate CM from post parameters

a8232ab

Access nested student and class mastery keys

6e875a7

naveen-nathan commented Nov 30, 2024

View reviewed changes

progressReport/app.py Show resolved Hide resolved

Connor-Bernard reviewed Dec 2, 2024

View reviewed changes

progressReport/app.py Outdated Show resolved Hide resolved

progressReport/app.py Show resolved Hide resolved

progressReport/app.py Outdated Show resolved Hide resolved

progressReport/app.py Show resolved Hide resolved

naveen-nathan added 2 commits December 2, 2024 21:28

Bug fix + return correct error code

d82e70a

Fix validation bug + load constants from file

ed2f1c2

naveen-nathan requested a review from Connor-Bernard December 3, 2024 23:56

naveen-nathan added 7 commits December 11, 2024 18:56

Attempt to POST CM through the iframe + transfer CM-200 changes

1e9c7c8

Implement api endpoint to return mastery mapping and post to CM in if…

a51cdc5

…rame

Make dedicated router for mastery mapping + cleanup

8037a38

Formatting changes

fcd71d8

Formatting changes

40c97fe

Formatting changes

99d1c45

Formatting change

65706c5

naveen-nathan changed the title ~~[CM-28] Process post request with mastery learning info~~ [CM-28] Generate and process post request with mastery learning info Dec 13, 2024

Connor-Bernard reviewed Dec 14, 2024

View reviewed changes

naveen-nathan requested review from AanviKothari456 and CatherineZhuang-cz December 18, 2024 06:05

naveen-nathan and others added 3 commits December 18, 2024 23:26

Misc. changes + optimize getTopicsFromUser

d454114

Rename variables per convention

4d22d42

Co-authored-by: Connor <[email protected]>

Nest async function within useEffect

68f296c

Merge branch 'main' into CM-28/process-mastery-level-POST-request

28e54a7

Connor-Bernard reviewed Dec 19, 2024

View reviewed changes

naveen-nathan added 2 commits December 19, 2024 01:05

Minor change

564662b

Use axios to retrieve CM html

307c193

naveen-nathan requested a review from Connor-Bernard December 19, 2024 10:51

naveen-nathan added 2 commits December 19, 2024 09:38

Remove error handling

ea8ae67

Mark deprecated functions as such

97b6586

Connor-Bernard reviewed Feb 12, 2025

View reviewed changes

naveen-nathan requested a review from Connor-Bernard February 12, 2025 06:53

Connor-Bernard approved these changes Feb 20, 2025

View reviewed changes

Connor-Bernard merged commit 5e5f90c into main Feb 20, 2025
4 checks passed

Connor-Bernard deleted the CM-28/process-mastery-level-POST-request branch February 20, 2025 01:16

[CM-28] Generate and process post request with mastery learning info #30

[CM-28] Generate and process post request with mastery learning info #30

Uh oh!

Conversation

naveen-nathan commented Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jira Ticket

Description

Type of Change

Changes

Testing

Checklist

Screenshots/Video

Additional Notes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Connor-Bernard left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Connor-Bernard commented Dec 2, 2024

Uh oh!

Connor-Bernard commented Dec 2, 2024

Uh oh!

naveen-nathan commented Dec 2, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Connor-Bernard Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

naveen-nathan Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

Connor-Bernard Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

naveen-nathan Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

TeetoToast commented Feb 13, 2025

Uh oh!

naveen-nathan commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Connor-Bernard left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

naveen-nathan commented Feb 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

naveen-nathan commented Nov 27, 2024 •

edited

Loading

naveen-nathan commented Feb 13, 2025 •

edited

Loading