Fixing any_unfulfilled_milestones in enrollments API

[iamjazzar]

Description

In User Course Enrollments List: /api/mobile/v0.5/users/username/course_enrollments, if we enabled Entrance Exam from Schedule & Details section and then re-desabling it, thecourseware_access field in the API will keep preventing the student from showing the course on the mobile apps.

            "courseware_access": {
                "has_access": false,
                "error_code": "unfulfilled_milestones",
                "developer_message": "User has unfulfilled milestones",
                "user_message": "User has unfulfilled milestones."
            },

This problem is happening because the get_course_milestones_fulfillment_paths method in the milestones API is returning an empty dictionary {} if the course doesn't have any milestones, after enabling Entrance Exam it returns a complex dict-of-dicts like this:

{
  "course-v1:org+course+run.entrance_exams.Completed Course Entrance Exam": {
     "content": [
          "block-v1:org+course+run+type@chapter+block@cd5f1b8bef874bcdad80b2857f5aeffd"
     ]
  }
}

While redoubling the entrance exam causes the method to return the previously-enabled prerequisites with an empty dictionary like this:

{"course-v1:org+course+run.entrance_exams.Completed Course Entrance Exam": {}}

The method any_unfulfilled_milestones is not addressing this scenario, so what I did is checking that every value in the dict returned from get_course_milestones_fulfillment_paths, if any value has a non-empty dictionary then the student is still having unfulfilled milestones and we are returning True, if the dictionary is empty or the student have fulfilled the milestones then we are returning False.

Note

This solution won't affect the result if the learner completed the prerequisites since the get_course_milestones_fulfillment_paths will return an empty dictionary if the Entrance Exam fulfilled.

TODO

• Squash and rebase after review.

Update

Another issue arised as if the instructor enabled and disabled the Prerequisite Course in Studio's Requirements section, the course became inaccessible for learner in the dashboard and the API views.
This happens because selecting None from the dropdown list in Studio has no functionality in the code.

[openedx-webhooks]

Thanks for the pull request, @AhmedAljazzar! I've created OSPR-1717 to keep track of it in JIRA. JIRA is a place for product owners to prioritize feature reviews by the engineering development teams.

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

• supporting documentation
• edx-code email 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 still be done via the GitHub pull request interface. As a reminder, our process documentation is here.

If you like, you can add yourself to the AUTHORS file for this repo, though that isn't required. Please see the CONTRIBUTING file for more information.

[gsong]

Jenkins ok to test

[iamjazzar]

Tests are passing now after the rebase.

[iamjazzar]

The branch updated with another commit.

[OmarIthawi]

Hey @gsong I've updated the branch again to fix a recent merge conflict. Please let me know if I need anything else to do.

[OmarIthawi]

Hey @gsong, just a gentle reminder about this PR.

[gsong]

@andy-armstrong @BenjiLee Do you know who might be the right person to review this PR?

[BenjiLee]

@gsong Probably me. @mattdrayer would be another option.

[gsong]

@BenjiLee Would appreciate getting this into a sprint, let me know the best way to do that. Thank you.

[BenjiLee]

@jasperho CC

[OmarIthawi]

Thanks a lot @BenjiLee and @gsong 😃

[gsong]

jenkins run all

[gsong]

Jenkins ok to test

[OmarIthawi]

Thanks @gsong, I'll fix the brokens tests/quality checks.

[OmarIthawi]

@AhmedAljazzar I've rebase this PR and fixed both of the conflicts and PEP8 issue. Unfortunately, I left the subtle broken test to you. Please check jenkins/python suite.

[iamjazzar]

@OmarIthawi looks like we lost remove_prerequisite_course import during the rebase. I imported it again and waiting for tests results.

[OmarIthawi]

Thanks @AhmedAljazzar, looks like the tests are good. CC: @gsong

[gsong]

@jasperho Can you help us schedule this into a sprint review? Thanks.

[OmarIthawi]

Just a gentle reminder @jasperho.

[BenjiLee]

This ticket is currently in our sprint and will be reviewed.

[OmarIthawi]

Thanks @BenjiLee! Looking forward for your feedback.

[OmarIthawi]

@AhmedAljazzar I think this one bug deserves a test case to ensure it survives future updates. Let's work on it today if you have time.

[BenjiLee]

This LGTM. Waiting on testcase.

[OmarIthawi]

Thanks @BenjiLee! Could you please mark this as ok to test?

[OmarIthawi]

I did some refactoring as well. Please review and let me know your feedback.

[OmarIthawi]

@AhmedAljazzar could you please do a quick review? I'd like to squash the commits.

[gsong]

Jenkins ok to test

[gsong]

jenkins run all

[OmarIthawi]

@gsong how about sudo jenkins run all 😄

[gsong]

@OmarIthawi Jenkins is a bit backed up right now, it'll get to this eventually.

[BenjiLee]

Waiting on passing tests

[gsong]

Merged via #15623.