feat: display allocated runs on the course about page

[brobro10000]

For variant based assignments, if an assignment is allocated to a specific variant (course run) or multiple variants of the same course, we want to ensure that the course about page only displays the enrollable course run card and calls can-redeem appropriately.

We leverage the field isAssignedCourseRun to conditionally filter courseMetadata's courseRuns & availableCourseRuns to conditionally render single or multiple course run cards.

The changes made also ensures that on load of the course about page, if there is an allocated assignment with a variant, only run can-redeem on that specific variant to improve page performance.

Screen.Recording.2024-08-06.at.10.52.56.AM.mov

TODOs:
Verify only the late enrollment card is displayed.
Clear up TODOs in the code
Tests

For all changes

• Ensure adequate tests are in place (or reviewed existing tests cover changes)
• Ensure English strings are marked for translation. See documentation for more details.

Only if submitting a visual change

• Ensure to attach screenshots
• Ensure to have UX team confirm screenshots

[codecov]

Codecov Report

Attention: Patch coverage is 96.87500% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.07%. Comparing base (10362ba) to head (4f3397f).

Files	Patch %	Lines
src/components/course/data/courseLoader.ts	88.88%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1142      +/-   ##
==========================================
+ Coverage   88.05%   88.07%   +0.02%     
==========================================
  Files         393      393              
  Lines        8268     8292      +24     
  Branches     2021     2027       +6     
==========================================
+ Hits         7280     7303      +23     
  Misses        946      946              
- Partials       42       43       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[brobro10000]

Spent some time making this a hook that sourced its own courseKey and redeemableLearnerCreditPolicies but ran into an issue attempting to use this in the couresLoader. B/c the courseLoader is not a functional react component, I could not utilize this function as a hook. The tradeoff of using a hook vs a function was not including the performance enhancements of the can-redeem call, so I opted to retain the performance enhancements of can-redeem and keep it as a function.

One improvement is the return of the allocatedCourseRunAssignments value which returns the metadata of the course run based allocations versus just the course keys.

[adamstankiewicz]

Overall, looking great! Left mostly nit comments, but also had a few clarifying questions and handful of minor suggestions.

[adamstankiewicz]

[question/clarification] Why might we only want to mutate the below courseRuns and availableCourseRuns values when hasMultipleAssignedCourseRuns: true? Is there a particular reason we wouldn't want to go that if the user has a single allocated assignment applicable to the current course?

[brobro10000]

When a user has a single allocated assignment, we alter how we retrieve course metadata.

  let courseRunKey = searchParams.get('course_run_key')?.replaceAll(' ', '+');
  if (!courseRunKey && hasAssignedCourseRuns) {
    courseRunKey = hasMultipleAssignedCourseRuns ? null : allocatedCourseRunAssignmentKeys[0];
  }

For a single allocation with no course_run_key defined, we are defaulting the courseRunKey to the allocated course run key, only returning a single course from course metadata. That way we don't have to go through the additional step of filtering by the allocated course run a second time.

For a single allocation with a course_run_key, we are returning a single course regardless, so any UI changes (such as important dates) would have to be parsed down stream to determine if the singular course run displayed (via course_run_key) is an allocated course run.

For hasMultipleAssignedCourseRuns: true state, we are opting to use the courseKey to return all course runs from course metadata. Then we transform it further with this function. This approach allows us to treat the multiple course runs for a single course as a true edge case (that could easily be ripped out) as opposed to baking it into the default logic.

[adamstankiewicz]

Great job!