feat: [AXM-24] Update structure for course enrollments API #2515

KyryloKireiev · 2024-03-19T10:18:09Z

Description

UserCourseEnrollmentsList - Update structure for course enrollments API. In v4 we added to the response primary object. Primary object contains the latest user’s enrollment or course where user has the latest progress. Primary object has been cut from user’s enrolments array and inserted into separated section with key primary.
TestUserEnrollmentApi - add new tests for the testing UserCourseEnrollmentsList API v4.

YouTrack

https://youtrack.raccoongang.com/issue/AXM-24/Update-structure-for-courseenrollments-API

monteri · 2024-03-19T11:49:46Z

lms/djangoapps/mobile_api/users/tests.py

+        # check that we have the new_course in primary section in the same way
+        self.assertIn('primary', response.data)
+        self.assertEqual(response.data['primary']['course']['id'], str(new_course.id))
+


Do we need some test here which course is determined as primary?

Yes, I checked in tests which course is a primary, and also I checked under what conditions a different course becomes a primary:
response.data['primary']['course']['id'] returns primary course ID

response.data['enrollments']['results'] contains all student enrollments except primary course enrollment object

monteri · 2024-03-19T11:58:39Z

lms/djangoapps/mobile_api/users/views.py

+                primary_enrollment_obj = self.get_primary_enrollment_by_latest_enrollment_or_progress()
+                if primary_enrollment_obj:
+                    serializer = self.get_serializer(primary_enrollment_obj)
+                    enrollment_data.update({'primary': serializer.data})


is it correct that there will response with structure:

{ 'primary': ..., 'configs': ..., 'enrollments': ..., }

where config will contain the data about pagination and so on?

There is json response example for the API v4:

{ "configs": { "iap_configs": {} }, "enrollments": { "next": null, "previous": null, "count": 5, "num_pages": 1, "current_page": 1, "start": 0, "results": [**array of dicts with course enrollments objects] }, "primary": { "audit_access_expires": null, "created": "2024-03-15T11:14:13.514963Z", "mode": "audit", "is_active": true, "course": { "id": "course-v1:b+b+b", "name": "b", "number": "b", "org": "b", "start": "2020-01-01T00:00:00Z", "start_display": "Jan. 1, 2020", "start_type": "timestamp", "end": null, "dynamic_upgrade_deadline": null, "subscription_id": "course_MNXXK4TTMUWXMMJ2MIVWEK3C", "courseware_access": { "has_access": true, "error_code": null, "developer_message": null, "user_message": null, "additional_context_user_message": null, "user_fragment": null }, "media": { "course_image": { "uri": "/asset-v1:b+b+b+type@[email protected]", "name": "Course Image" } }, "course_image": "/asset-v1:b+b+b+type@[email protected]", "course_about": "http://local.edly.io:8000/courses/course-v1:b+b+b/about", "course_sharing_utm_parameters": { "facebook": "utm_medium=social&utm_campaign=social-sharing-db&utm_source=facebook", "twitter": "utm_medium=social&utm_campaign=social-sharing-db&utm_source=twitter" }, "course_updates": "http://local.edly.io:8000/api/mobile/v4/course_info/course-v1:b+b+b/updates", "course_handouts": "http://local.edly.io:8000/api/mobile/v4/course_info/course-v1:b+b+b/handouts", "discussion_url": null, "video_outline": null, "is_self_paced": false }, "certificate": {}, "course_modes": [ { "slug": "audit", "sku": null, "android_sku": null, "ios_sku": null, "min_price": 0 } ] } }

All variants of responses you can see here. I attached json responses to the ticket:
https://youtrack.raccoongang.com/issue/AXM-24/Update-structure-for-courseenrollments-API

* feat: [AXM-24] Update structure for course enrollments API * style: [AXM-24] Improve code style * fix: [AXM-24] Fix student's latest enrollment filter

* feat: [AXM-24] Update structure for course enrollments API (#2515) * feat: [AXM-24] Update structure for course enrollments API * style: [AXM-24] Improve code style * fix: [AXM-24] Fix student's latest enrollment filter * feat: [AXM-47] Add course_status field to primary object (#2517) * feat: [AXM-40] add courses progress to enrollment endpoint (#2519) * fix: workaround for staticcollection introduced in e40a01c * feat: [AXM-40] add courses progress to enrollment endpoint * refactor: [AXM-40] add caching to improve performance * refactor: [AXM-40] add progress only for primary course * refactor: [AXM-40] refactor enrollment caching optimization --------- Co-authored-by: Glib Glugovskiy <[email protected]> * feat: [AXM-53] add assertions for primary course (#2522) * feat: [AXM-53] add assertions for primary course * test: [AXM-53] fix tests * style: [AXM-53] change future_assignment default value to None * refactor: [AXM-53] add some optimization for assignments collecting * feat: [AXM-200] Implement user's enrolments status API * style: [AXM-200] Improve code style * refactor: [AXM-200] Divide get method into smaller methods --------- Co-authored-by: NiedielnitsevIvan <[email protected]> Co-authored-by: Glib Glugovskiy <[email protected]>