feat: [FC-7879] implement get_user_dates() method to get all user dates for a course#326#346
Conversation
|
Thanks for the pull request, @kyrylo-kh! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
| @@ -0,0 +1,378 @@ | |||
| """ | |||
| Test cases for the api module of edx-when. | |||
There was a problem hiding this comment.
How is this file different from this https://github.com/openedx/edx-when/blob/master/tests/test_api.py
| dates[key] = content_date.user_overrides[0].actual_date | ||
| else: | ||
| try: | ||
| dates[key] = content_date.policy.actual_date() |
There was a problem hiding this comment.
I notice that this call is without arguments, compared to this:
Line 251 in ab2ee71
Has this been tested with self-paced courses?
| return schedules | ||
|
|
||
|
|
||
| def get_user_dates(course_id, user_id, block_types=None, block_keys=None, date_types=None): |
There was a problem hiding this comment.
I'm trying to grok how this function and [get_dates_for_course()](https://github.com/openedx/edx-when/blob/ab2ee71af64ee6ef720083586eb26e1f58a748d9/edx_when/api.py#L163) relate. Given that there is some repeated code, is there a cleaner refactoring that's possible?
| content_date=content_date, | ||
| abs_date=datetime(2023, 1, 20, 10, 0, 0) | ||
| ) | ||
| older_override.modified = datetime(2023, 1, 1, 10, 0, 0) |
There was a problem hiding this comment.
Does the model potentially override your override of the modified field given this is a TimeStampedModel? Can you add a check to confirm this field is returned with the expected value?
4 participants
Description
This PR adds a new API function
get_user_dates(course_id, user_id)to return a comprehensive map of dates for a given course and user.Functionality
Returns a dictionary where keys are
(block_key, field)tuples and values aredatetimeobjects.Prioritizes user-specific overrides (
UserDate) over default content dates (ContentDatewithDatePolicy).Supports optional filtering by:
block_types(e.g.,sequential,vertical)block_keys(UsageKey or string list)date_types(due,start, etc.)Features
Testing
Extensive test suite verifies: