Skip to content

feat: [AXM-2307] add management command to backfill ContentDate model…#37989

Open
kyrylo-kh wants to merge 3 commits intoopenedx:masterfrom
raccoongang:rg/axm-dates-add-management-command-to-backfill-contentdates
Open

feat: [AXM-2307] add management command to backfill ContentDate model…#37989
kyrylo-kh wants to merge 3 commits intoopenedx:masterfrom
raccoongang:rg/axm-dates-add-management-command-to-backfill-contentdates

Conversation

@kyrylo-kh
Copy link
Member

… with existing assignments

NOTE: Depends on: openedx/edx-when#347

Description

This PR adds a new Django management command seed_content_dates that extracts assignment due dates from the modulestore and populates the ContentDate table in the edx-when service.

Key Features

  • Command: python manage.py lms seed_content_dates
  • Backfills assignment due dates into ContentDate from course assignments in the modulestore.

Options

  • --course-id: Seed a specific course.
  • --org: Seed all courses for a specific organization.
  • --dry-run: Simulate processing without writing to the database.
  • --force-update: Overwrite existing ContentDate records instead of skipping.
  • --batch-size: Process assignments in batches (default: 100).

Example Usage

# Dry run for all courses
python manage.py lms seed_content_dates --dry-run

# Process a specific course
python manage.py lms seed_content_dates --course-id "course-v1:MITx+6.00x+2023_Fall"

# Process all courses for an organization
python manage.py lms seed_content_dates --org "MITx"

# Force update existing records
python manage.py lms seed_content_dates --force-update

@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
@kyrylo-kh kyrylo-kh force-pushed the rg/axm-dates-add-management-command-to-backfill-contentdates branch from 40a7206 to 57a09ad Compare February 11, 2026 20:33
@kyrylo-kh kyrylo-kh force-pushed the rg/axm-dates-add-management-command-to-backfill-contentdates branch from db632e6 to 71a4fe7 Compare February 18, 2026 21:11
@mphilbrick211 mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Feb 25, 2026
Copy link
Contributor

@e0d e0d left a comment

Choose a reason for hiding this comment

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

A general comment: there are no tests for this new command.

continue

try:
update_or_create_assignments_due_dates(course_key, [assignment])
Copy link
Contributor

Choose a reason for hiding this comment

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

Why aren't we using the batch capability of the imported function rather than running this in a loop with single item lists?

Copy link
Member Author

Choose a reason for hiding this comment

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

Re-implemented in batch way

f"Created ContentDate for {assignment.title} "
f"in course {course_key}"
)

Copy link
Contributor

Choose a reason for hiding this comment

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

Why this broad catch and continue? I think this is problematic because Django, I believe, will mark the atomic transaction that you created above as invalid and all of the updates will ultimately fail. If the idea is to make this save as much as possible, you will have to change the transaction boundaries.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed the outer atomic() around the course; each batch is its own atomic(); failures are handled outside that block.

return processed, 0, 0, 0

existing_due_locations: set = set(
when_models.ContentDate.objects.filter(
Copy link
Contributor

Choose a reason for hiding this comment

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

We shouldn't be reaching in to when's models directly. If there isn't an API that currently supports this, we should create it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Switched to get_existing_due_locations() on edx_when.api (added there).

log.warning(f"Course not found in modulestore: {course_key}")
return (0, 0, 0, 0)

staff_user = User.objects.filter(is_staff=True).first()
Copy link
Contributor

Choose a reason for hiding this comment

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

This pattern is unacceptable in my opinion. We need a more robust approach that doesn't pick any old staff user for the convenience of the management command.

Copy link
Member Author

Choose a reason for hiding this comment

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

Replaced with required --username and validation (is_staff, is_active).

"""
Process a single course and return (processed, created, updated, skipped) counts.
"""
store = modulestore()
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure of the current performance of this, but passing it as an argument seems like the right thing to do.

Copy link
Member Author

Choose a reason for hiding this comment

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

Re-implemented and now it's called once and the store is passed into _process_course

@kyrylo-kh
Copy link
Member Author

Tests are failing because they depends on openedx/edx-when#346. This should be merged after merging edx-when PR

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