feat: [FC-7879] add signal handler to save assignment dates to edx-when models #37988
Conversation
openedx-webhooks
added
the
open-source-contribution
|
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. |
| @@ -181,3 +182,15 @@ def extract_dates(sender, course_key, **kwargs): # pylint: disable=unused-argum | |||
| set_dates_for_course(course_key, date_items) | |||
| except Exception: # pylint: disable=broad-except | |||
| log.exception('Unable to set dates for %s on course publish', course_key) | |||
|
|
|||
|
|
|||
| @receiver(SignalHandler.course_published) | |||
There was a problem hiding this comment.
How does this receiver interact with the existing one?
| staff_user = User.objects.filter(is_staff=True).first() | ||
| if not staff_user: | ||
| LOGGER.error("No staff user found to update assignment dates for course %s", course_key_str) | ||
| return |
There was a problem hiding this comment.
Shouldn't this throw an exception? The task will return and the only way to know it failed will be to look at the logs and trace the message back to this code.
| LOGGER.info("Successfully updated assignment dates for course %s", course_key_str) | ||
| except Exception: # pylint: disable=broad-except | ||
| LOGGER.exception("Could not update assignment dates for course %s", course_key_str) | ||
| raise |
There was a problem hiding this comment.
What happens here after the exception is raised? Does logging here help debug or confuse things?
| LOGGER = get_task_logger(__name__) | ||
|
|
||
|
|
||
| @shared_task |
There was a problem hiding this comment.
This should specify retry logic, timeouts, etc.
| LOGGER.error("No staff user found to update assignment dates for course %s", course_key_str) | ||
| return | ||
| assignments = get_course_assignments(course_key, staff_user) | ||
| update_or_create_assignments_due_dates(course_key, assignments) |
There was a problem hiding this comment.
Can you unroll the call stack here and say what the transaction approach is? Shouldn't it be atomic per task? If not, why not?
| User = get_user_model() | ||
|
|
||
|
|
||
| LOGGER = get_task_logger(__name__) |
There was a problem hiding this comment.
Handlers is
log = get_task_logger(__name__)
Adopt for consistency.
| """ | ||
| Test inserting new records when missing. | ||
| """ | ||
| assignment = Mock() |
There was a problem hiding this comment.
I don't think you need to mock a data transfer object. Per other comment, make it public. It's already used as an argument to an API. Then just use the DTO directly here.
kyrylo-kh
force-pushed
the
rg/axm-dates-listen-to-course-published-and-process
branch
from
b8d7a3e to
bcfc718
Compare
4 participants
Description
This PR introduces a new signal-based mechanism to automatically sync assignment due dates with the
ContentDatemodel in edx-when when a course is published.Key Features
Signal Handler:
course_publishedsignal.update_assignment_dates_for_course) after publish.Celery Task:
get_course_assignments.update_or_create_assignments_due_dates()to persist due dates to theContentDatemodel.Tests
Includes comprehensive test coverage for: