Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: date label for instructor paced courses #36061

Merged
merged 2 commits into from
Jan 14, 2025
Merged

fix: date label for instructor paced courses #36061

merged 2 commits into from
Jan 14, 2025

Conversation

Anas12091101
Copy link
Contributor

@Anas12091101 Anas12091101 commented Dec 27, 2024 •
edited
Loading

Description

In the instructor paced courses, in which a user enrolls after the end date, there's a bug of showing label of "Enrollment Date" instead of "Start date" on the important dates page in LMS. This PR solves this issue by matching the conditions in date and title property of CourseStartDate class.

Useful information to include:

  • Which edX user roles will this change impact? Common user roles are "Learner"

Supporting information

https://github.com/mitodl/hq/issues/5889

Testing instructions

  • On the master branch, create an instructor paced course and set the start and end date to a past date in studio.
Screenshot 2024-12-27 at 4 16 48 PM
  • Enroll in the course from a test learner account and open the course in LMS
  • Click the Dates tab. You will notice that the date label is 'Enrollment Date', and the displayed date corresponds to the start date.
Screenshot 2024-12-27 at 4 17 31 PM
  • Now, checkout to this branch and reload the above dates page. It will show the correct label.
Screenshot 2024-12-27 at 4 19 14 PM

Deadline

"None"

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
  • If your database migration can't be rolled back easily.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 27, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 27, 2024 •
edited
Loading

Thanks for the pull request, @Anas12091101!

This repository is currently maintained by @openedx/wg-maintenance-edx-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.

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.

@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Dec 27, 2024
@Anas12091101 Anas12091101 force-pushed the anas/fix-date-label branch 6 times, most recently from 8744232 to 7676a2d Compare January 3, 2025 12:14
@pdpinch
Copy link
Contributor

pdpinch commented Jan 6, 2025

@Anas12091101 can you rebase this?

asadali145
asadali145 reviewed Jan 7, 2025
View reviewed changes
lms/djangoapps/courseware/date_summary.py
@@ -268,7 +268,7 @@ def date_type(self):
@property
def title(self):
enrollment = CourseEnrollment.get_enrollment(self.user, self.course_id)
if enrollment and self.course.end and enrollment.created > self.course.end:
if self.course.self_paced and enrollment and self.course.start and enrollment.created > self.course.start:
Copy link
Contributor

@asadali145 asadali145 Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This will have an impact on 2 cases:

  • Instructor-paced course with past dates:
    • Course Starts replaced by Enrollment Date
  • Self Paced course with start date in past and end date in future:
    • 'Course Starts' replaced by Enrollment Date, Regardless of user enrollment. If user is not enrolled and you visit dates tab, it will display Enrollment Date label

Copy link
Contributor

Choose a reason for hiding this comment

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

This looks good. It displayed the wrong label due to cache.

asadali145
asadali145 approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@asadali145 asadali145 left a comment

Choose a reason for hiding this comment

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

LGTM! I appreciate you going the extra mile to include the tests.

lms/djangoapps/courseware/date_summary.py
@@ -268,7 +268,7 @@ def date_type(self):
@property
def title(self):
enrollment = CourseEnrollment.get_enrollment(self.user, self.course_id)
if enrollment and self.course.end and enrollment.created > self.course.end:
if self.course.self_paced and enrollment and self.course.start and enrollment.created > self.course.start:
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks good. It displayed the wrong label due to cache.

@Anas12091101 Anas12091101 force-pushed the anas/fix-date-label branch 2 times, most recently from a6b7814 to da5e424 Compare January 9, 2025 13:41
@pdpinch
Copy link
Contributor

pdpinch commented Jan 9, 2025

Sorry @Anas12091101 can you rebase this?

@Anas12091101 Anas12091101 force-pushed the anas/fix-date-label branch 3 times, most recently from 0e81db7 to 25661a1 Compare January 13, 2025 14:04
@pdpinch
Copy link
Contributor

pdpinch commented Jan 14, 2025

Product WG approved via Slack: https://openedx.slack.com/archives/C057J2D1WU9/p1736457689372699

@pdpinch pdpinch merged commit 952c297 into openedx:master Jan 14, 2025
49 checks passed
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asadali145 asadali145 asadali145 approved these changes

@pdpinch pdpinch pdpinch approved these changes

Assignees
No one assigned
Labels
needs reviewer assigned PR needs to be (re-)assigned a new reviewer open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Anas12091101 @openedx-webhooks @pdpinch @edx-pipeline-bot @asadali145 @mphilbrick211