feat: [FC-7879] add signal handler to save assignment dates to edx-when models by kyrylo-kh · Pull Request #37988 · openedx/openedx-platform

kyrylo-kh · 2026-02-09T14:00:25Z

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 · 2026-02-09T14:00:31Z

Thanks for the pull request, @kyrylo-kh!

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

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.

e0d · 2026-02-11T03:08:58Z

@@ -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)


How does this receiver interact with the existing one?

https://github.com/raccoongang/edx-platform/blob/b8d7a3ef8ae2f8b25038493104e5af572a7098c8/openedx/core/djangoapps/course_date_signals/handlers.py#L166

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.

@kyrylo-kh Can you please extend docstring with the description on how this signal listener is different from and extends the above mentioned set_dates_for_course?

e0d · 2026-02-11T03:22:26Z

+            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)


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?

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.

…en models

kyrylo-kh · 2026-02-16T20:41:56Z

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

pkulkark · 2026-06-16T15:07:44Z

+        )
+    log.info("Starting to update assignment dates for course %s", course_key_str)
+    assignments = get_course_assignments(course_key, staff_user)
+    update_or_create_assignments_due_dates(course_key, assignments)


This forwards get_course_assignments's output directly into edx-when's api, but the two Assignment types don't match. For example, the LMS _Assignment namedtuple has no subsection_name. This needs an explicit mapping step that builds edx-when Assignment objects.

GlugovGrGlib

The PR drifted a little bit after the changes in edx-when PRs including Assignments mismatch mentioned above. Need to revisit after edx-when PRs merged and version is updated.

GlugovGrGlib · 2026-06-17T15:04:11Z

@@ -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)


@kyrylo-kh Can you please extend docstring with the description on how this signal listener is different from and extends the above mentioned set_dates_for_course?

GlugovGrGlib · 2026-06-17T15:13:41Z

+        """
+        Test inserting new records when missing.
+        """
+        mock_get_assignments.return_value = [self._assignment()]


As @pkulkark mentions correctly actual return value of the get_course_assignments is different from the Assignment. So this mock masks the issue with subsection_name, either _Assignment named tuple should be used, or a helper with explicit mapping as suggested.

GlugovGrGlib · 2026-06-17T16:37:22Z

+User = get_user_model()
+
+
+class TestUpdateAssignmentDatesForCourse(TestCase):


Can you please add docstring expanding context to the test class and/or the module?

kyrylo-kh · 2026-07-29T20:43:09Z

I resolved issues above. Please, take a look at latest commit

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

openedx-webhooks added this to Contributions Feb 9, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Feb 9, 2026

kyrylo-kh mentioned this pull request Feb 9, 2026

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

Closed

kyrylo-kh requested a review from e0d February 9, 2026 18:23

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 9, 2026

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Feb 9, 2026

e0d requested changes Feb 11, 2026

View reviewed changes

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

feat: [FC-7879] add signal handler to save assignment dates to edx-wh…

bb6792f

…en models

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

feat: [FC-7879] refactor according to comments

a229b44

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

mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Feb 25, 2026

pkulkark reviewed Jun 16, 2026

View reviewed changes

GlugovGrGlib suggested changes Jun 17, 2026

View reviewed changes

itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Jun 25, 2026

feat: [AXM-2300] map course assignments to edx-when Assignment DTOs

c3eefa5

		User = get_user_model()


		class TestUpdateAssignmentDatesForCourse(TestCase):

Uh oh!

Conversation

kyrylo-kh commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Key Features

Tests

Uh oh!

openedx-webhooks commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kyrylo-kh commented Feb 16, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GlugovGrGlib left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kyrylo-kh commented Jul 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

kyrylo-kh commented Feb 9, 2026 •

edited

Loading

openedx-webhooks commented Feb 9, 2026 •

edited

Loading