feat(mobile_api): Add course access object to mobile course info API

[GlugovGrGlib]

Description

This PR is a follow-up to FC-0031 project for Mobile API updates #33304, and extends BlocksInfoInCourseView view with courseware_access_details data for a user in the form:

"course_access_details": {
		"has_unmet_prerequisites": <bool>,
		"is_too_early": <bool>,
		"is_staff": <bool>,
		"audit_access_expires": null,
		"courseware_access": {
			"has_access": <bool>,
			"error_code": <string> or null,
			"developer_message":  <string> or null,
			"user_message":  <string> or null,
			"additional_context_user_message":  <string> or null,
			"user_fragment": null
		}
	},
	
"enrollment_details": {
		"created": <date>,
		"mode": <string>,
		"is_active": <bool>
	},

"course_updates": <str>,
"course_handouts": <str>,
"discussion_url": <str> or null,
	
"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_modes": [
		{
			"slug": <str>,
			"sku": null,
			"android_sku": null,
			"ios_sku": null,
			"min_price": <int>
		}
	]

The coursewareAccess data should be provided only if it is requested by a staff or admin user, or by the users themselves.

Supporting information

This PR further extends the mobile BlocksInfoInCourseView that was introduced in the #33296

Testing instructions

Run a GET /api/mobile/{api_version}/course_info/blocks/?course_id=<course_id>&username=<username>&return_type=dict

Asses the response, check that fields "course_access_details" and "certificate" are in the response body.

Deadline

End of the month, as those changes are required to unblock the further works around mobile courseware enhancements.

[openedx-webhooks]

Thanks for the pull request, @GlugovGrGlib! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[miankhalid]

Apologies for the late review on this PR, I was waiting to have a chat with @volodymyr-chekyrta which we did last night.

Approach reconsideration

The change this PR brings to the Blocks API is altogether a new dictionary with a new name and new key-value pairs i.e:

"coursewareAccess": {
    "hasUnmetPrerequisites": <bool>,
    "isTooEarly": <bool>,
    "isStaff": <bool>
}

while what we wanted was the same courseware_access access object that is sent as part of the Enrollments API (/api/mobile/v3/users/{username}}/course_enrollments/) i.e:

{
  "courseware_access": {
    "has_access": <bool>,
    "error_code": <enum> {"course_not_started", "audit_expired", "not_visible_to_user", "unfulfilled_milestones"},
    "developer_message": <string>,
    "user_message": <string>,
    "additional_context_user_message": <string>
  }
}

here's a sample response for a real user on one of our sandboxes:

{
  "courseware_access": {
    "has_access": false,
    "error_code": "audit_expired",
    "developer_message": "User {username} had access to {course_run_key} until 2024-01-15 13:15:13+00:00",
    "user_message": "Access expired on Jan 15, 2024",
    "additional_context_user_message": "Access to {course_name} expired on Jan 15, 2024"
  }
}

Benefit of the old response structure

We'll be able to easily copy over the previous error handling logic that we had in our prod apps already in the market without missing out any of the edge cases.

Code references

iOS

1. https://github.com/openedx/edx-app-ios/blob/a07db33dd0e2ef0d2c30582c79b2e7273c7e1aac/Source/OEXCoursewareAccess.h
2. https://github.com/openedx/edx-app-ios/blob/a07db33dd0e2ef0d2c30582c79b2e7273c7e1aac/Source/OEXCoursewareAccess.m

Android

1. https://github.com/openedx/edx-app-android/blob/459dee23fc14f76abb4d1e05d31e54032aa6d894/OpenEdXMobile/src/main/java/org/edx/mobile/model/api/CoursewareAccess.java
2. https://github.com/openedx/edx-app-android/blob/459dee23fc14f76abb4d1e05d31e54032aa6d894/OpenEdXMobile/src/main/java/org/edx/mobile/model/api/AccessError.java

[miankhalid]

Also, since this change:

1. might require pulling data from different models or queries that need to be done on the db
2. and increase the JSON response size

so, is there a plan to do performance & load testing before and after this change?

[GlugovGrGlib]

@miankhalid Thanks for the details, it seems like it shouldn't take long to update the response to the structure you've mentioned.

Also, I have checked the code around has_access, and it appears to be optimized in terms of the number of database queries. However, I appreciate you raising this concern. I will conduct a small load test to compare the performance before and after changes to the /api/mobile/{api_version}/course_info/blocks/ endpoint.

[miankhalid]

Great @GlugovGrGlib, thanks for making these changes!

Do let us know when the PR is ready for another pass.

[miankhalid]

@GlugovGrGlib @volodymyr-chekyrta here are some more things that should be added to the Blocks API (/api/mobile/v3/course_info/blocks/) that are currently available in the Enrollments API (/api/mobile/v3/users/{username}/course_enrollments/):

1. Elements in red boxes are absolutely needed currently for app's working and especially analytics.
2. Elements in green boxes would be needed in future for in-app payments in the apps.

cc @omerhabib26 @saeedbashir @moiz994 @touchapp

[moeez96]

Hi @GlugovGrGlib Is this ready for another review?

[GlugovGrGlib]

Hi @GlugovGrGlib Is this ready for another review?

@moeez96 Not yet, I have to do the final changes today, so it should be ready by next week.

[GlugovGrGlib]

@moeez96 @miankhalid
The PR is ready for the final review

The final response from the endpoint was extended with all requested fields except dynamic_deadline_upgrade and subscription_id

The course access messages can be accessed using $.course_access_details.courseware_access.has_access

[moeez96]

Any specific reason of writing tests for mobile_api/course_info/* in mobile_api/tests/* rather than the existing mobile_api/course_info/tests.py?

[GlugovGrGlib]

Any specific reason of writing tests for mobile_api/course_info/* in mobile_api/tests/* rather than the existing mobile_api/course_info/tests.py?

@moeez96 I have done this change to fix the Quality check. If tests are placed in the tests/* directory, it will be ignored during xsslint, this way it's possible to fix quality check without change to xsslint configuration - https://github.com/openedx/edx-platform/blob/master/scripts/xsslint_config.py#L49.

[moeez96]

@GlugovGrGlib Can we then add the test code to files named lms/djangoapps/mobile_api/tests/test_course_info_serializers.py
and
lms/djangoapps/mobile_api/tests/test_course_info_views.py?

This way file seggregation will remain intact and xsslint will also test these files. Otherwise the first impression a code reader gets is that these tests are written for mobile_api views and serializers.
Rest looks good to me!

[GlugovGrGlib]

@moeez96 Thank you for the suggestion, I have renamed test files

[GlugovGrGlib]

@moeez96 @miankhalid If everything looks good from your side, please merge this PR whenever you're ready.

[miankhalid]

LGTM 👍

[openedx-webhooks]

@GlugovGrGlib 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.