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.

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

fix: certificate display behavior not showing date-picker for end-with-date #35675

Merged
merged 2 commits into from
Oct 30, 2024

Conversation

Anas12091101
Copy link
Contributor

Description

#35562 has been merged recently removing use_v2_cert_display_settings. However, useV2CertDisplaySettings was left to be removed from the backbone JS files. This resulted in a bug of not showing the date-picker when Certificate Display Behaviour was set to end-with-date. This PR solves this issue and removes all the usage of useV2CertDisplaySettings from backbone JS files.

Useful information to include:

  • Which edX user roles will this change impact? Common user roles are "Course Author"
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
    Before:
Screenshot 2024-10-18 at 11 53 42 PM

After:
Screenshot 2024-10-18 at 11 51 04 PM

Supporting information

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

Testing instructions

  • Add certificates.auto_certificate_generation waffle switch in edx-platform
  • In any instructor paced course, click the Schedule and Details in the settings tab.
  • Select A date after the course end date from the Certificates Display Behavior options.
  • A date picker s labelled as Certificates Available Date should be displayed next to Certificates Display Behavior
  • Select a date and save. Reload the page, the settings should be saved.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

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 Oct 18, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @Anas12091101!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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.

@Anas12091101 Anas12091101 force-pushed the anas/fix-certificate-display-bahaviour branch from be84eb0 to 7cdb0ab Compare October 18, 2024 19:12
@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Oct 21, 2024
Copy link
Contributor

@arslanashraf7 arslanashraf7 left a comment

Choose a reason for hiding this comment

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

Looks good 👍 Thanks for putting up a fix of this.

I've tested the functionality as well and here are the details:

  1. I was able to see the date picker when after selecting A date after the course end date
  2. I was able to set a date and save settings in Studio
  3. I was able to get the certificate available date in the API /api/courses/v1/courses/<course_id>.
  4. I have tested the behavior of this field with Self-paced courses where it should not be displayed but you have to refresh the page when you switch course pacing to actually notice the correct behavior. This was the same behavior prior to v2 certificate setting removal.
  5. Also, The date doesn't persist It's value when you change pacing or select some other certificate display behavior. This was the same behavior prior to v2 certificate setting removal.

@pdpinch pdpinch changed the title fix: certificate display behaiviour not showing date-picker for end-with-date fix: certificate display behaviour not showing date-picker for end-with-date Oct 28, 2024
@pdpinch pdpinch changed the title fix: certificate display behaviour not showing date-picker for end-with-date fix: certificate display behavior not showing date-picker for end-with-date Oct 28, 2024
@pdpinch
Copy link
Contributor

pdpinch commented Oct 28, 2024

@Anas12091101 can you rebase this?

@deborahgu deborahgu added the needs maintainer attention Issue or PR specifically needs the attention of the maintainer. label Oct 28, 2024
@Anas12091101 Anas12091101 force-pushed the anas/fix-certificate-display-bahaviour branch 2 times, most recently from 3e6a09c to d96f197 Compare October 28, 2024 14:40
@Anas12091101 Anas12091101 force-pushed the anas/fix-certificate-display-bahaviour branch from d96f197 to fb5e269 Compare October 30, 2024 12:41
@pdpinch pdpinch merged commit 3dbb993 into openedx:master Oct 30, 2024
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.

1 similar comment
@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
Labels
needs maintainer attention Issue or PR specifically needs the attention of the maintainer. needs reviewer assigned PR needs to be (re-)assigned a new reviewer open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants