Skip to content

feat: [FC-7879] add signal handler to save assignment dates to edx-when models#37988

Open
kyrylo-kh wants to merge 2 commits intoopenedx:masterfrom
raccoongang:rg/axm-dates-listen-to-course-published-and-process
Open

feat: [FC-7879] add signal handler to save assignment dates to edx-when models#37988
kyrylo-kh wants to merge 2 commits intoopenedx:masterfrom
raccoongang:rg/axm-dates-listen-to-course-published-and-process

Conversation

@kyrylo-kh
Copy link
Member

@kyrylo-kh kyrylo-kh commented Feb 9, 2026

NOTE: Depends on openedx/edx-when#347

Description

This PR introduces a new signal-based mechanism to automatically sync assignment due dates with the ContentDate model in edx-when when a course is published.

Key Features

  • Signal Handler:

    • Listens to the course_published signal.
    • Triggers a background task (update_assignment_dates_for_course) after publish.
  • Celery Task:

    • Fetches assignments via get_course_assignments.
    • Calls update_or_create_assignments_due_dates() to persist due dates to the ContentDate model.
    • Includes logging, error handling, and staff user validation.

Tests

Includes comprehensive test coverage for:

  • New and existing assignment date records.
  • Missing or invalid data (e.g., no title/date).
  • Empty assignment lists and failure scenarios (e.g., policy creation errors).
  • Graceful handling when no staff user is available.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 9, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @kyrylo-kh!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Feb 9, 2026
@kyrylo-kh kyrylo-kh requested a review from e0d February 9, 2026 18:23
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 9, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Feb 9, 2026
@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both are connected to SignalHandler.course_published. They run in registration order: extract_dates first (sync, updates block dates in edx_when), then update_assignment_dates (only schedules a Celery task with on_commit). They don’t call each other; the new one defers work so the task runs after the publish (and extract_dates) have committed.

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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tasks.py:36 -> edx_when.api.update_or_create_assignments_due_dates(), which wraps the whole loop in a single transaction.atomic() (edx_when/api.py ~L592). So the task’s DB work is already one atomic transaction; no extra atomic is needed in the task.

@kyrylo-kh kyrylo-kh force-pushed the rg/axm-dates-listen-to-course-published-and-process branch from b8d7a3e to bcfc718 Compare February 11, 2026 20:31
@kyrylo-kh kyrylo-kh force-pushed the rg/axm-dates-listen-to-course-published-and-process branch from bcfc718 to bb6792f Compare February 16, 2026 19:50
@kyrylo-kh kyrylo-kh force-pushed the rg/axm-dates-listen-to-course-published-and-process branch from e15e89c to a229b44 Compare February 16, 2026 20:38
@kyrylo-kh
Copy link
Member Author

Tests are failing because of openedx/edx-when#347

@mphilbrick211 mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Feb 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

4 participants