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: disable submit button for archived courses #34920

Merged
merged 15 commits into from
Jul 26, 2024

Conversation

Anas12091101
Copy link
Contributor

@Anas12091101 Anas12091101 commented Jun 5, 2024

Description

This PR disables the submission button for problems in the archived courses.

Current behaviour:
The learner can submit the problem in the archived courses which don't have a due date. The grade is recorded in the gradebook that should be closed.

After the PR merges:
The submit button will be disabled and the learner cannot submit the problem.

Useful information to include:

  • Which edX user roles will this change impact? "Learner"
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
    Before
Screenshot 2024-06-05 at 3 17 16 PM

After
Screenshot 2024-06-05 at 3 14 50 PM

  • Provide links to the description of corresponding configuration changes. Remember to correctly annotate these
    changes.

Supporting information

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

Testing instructions

  • Create a new course in studio.
  • From settings dropdown, select Schedule and Details.
  • Make the course self-paced and add the start date and end date to some past dates.
  • Save the changes and return back to course outline.
  • Create a section, subsection and a problem unit and publish it.
  • In the subsection's settings, set the grading to Homework
  • Go to the unit and click on View Live Version.
  • Validate that the submit button is disabled.

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 Jun 5, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Jun 5, 2024

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/disable-archive-course-submit branch from 1599550 to de46adf Compare June 5, 2024 11:04
@Anas12091101 Anas12091101 marked this pull request as draft June 5, 2024 11:27
@Anas12091101 Anas12091101 marked this pull request as ready for review June 5, 2024 13:02
Comment on lines 1447 to 1448
if self.course_is_archived():
return True
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be more direct to just check course.has_ended() here? I'm wary of adding a new method just for this. I'm not sure how well understood "archived" is within the codebase.

@pdpinch
Copy link
Contributor

pdpinch commented Jun 5, 2024

@Anas12091101 this will need a test

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.

I left some thoughs about alternate approaches to solve the problem.

Comment on lines 1437 to 1448
# Checking if the course is archived
from xmodule.modulestore.django import modulestore
try:
if isinstance(self.course_id, CourseKey):
course = modulestore().get_course(self.course_id)
closed_date = (
course.end + self.graceperiod if self.graceperiod is not None else course.end
)
if closed_date and datetime.datetime.now(utc) > closed_date:
return True
except AttributeError:
pass
Copy link
Contributor

@arslanashraf7 arslanashraf7 Jun 11, 2024

Choose a reason for hiding this comment

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

I think we might have other solutions to this problem. e.g. How Open edX is checking for archived courses in other places. I also think this is something that would need a product review.

However, What I would try to do here is:

Option 1:

  • Check how archived courses are being detected in other places, One example is HomePage Course View that uses some functionality to check for archived courses. The API eventually ends up checking course.has_ended() to check for an archived course.
    • If we go for this solution, We should also use that same has_ended method instead of writing our own code
    • If we need to add the grace period as well, We should ideally move that to has_ended method. However, All the places I see that check for grace period are related to grading only.

Option 2:

If we can't go with option#1, We should move this code into another function and call it here just like how we are using self.is_past_due(): below. This new function can check both has_ended from the course and graceperiod if needed.

@pdpinch
Copy link
Contributor

pdpinch commented Jun 12, 2024

We need to give some consideration to how this interacts with the past_due function. Based on what I understand from the course authors, they expect that a user who has been granted an extension on a problem due date would still be able to submit after the course end date.

@pdpinch
Copy link
Contributor

pdpinch commented Jun 12, 2024

Will this change affect all xBlocks, or just capa problems?

@Anas12091101
Copy link
Contributor Author

Will this change affect all xBlocks, or just capa problems?

I believe it will only affect the capa problems

@pdpinch
Copy link
Contributor

pdpinch commented Jun 24, 2024

I've spoken with a number of experienced course authors and they all feel that this behavior is a bug that was introduced sometime in 2023. In the Olive release, learners could not submit answers after the course end date. Now in Quince they can.

Can you do some research in the git history and see if you can figure out when this change was introduced? Are there any tests for course end dates?

@Anas12091101
Copy link
Contributor Author

Anas12091101 commented Jul 3, 2024

@pdpinch, I set up Olive locally using Tutor and tested this. Olive is also allowing submissions for problems in archived courses, with the difference that the gradebook doesn't get updated. If a course becomes archived after a submission, the gradebook is updated on the next submission. This seems more like a bug than a feature. A similar behavior was observed previously for the restricted course blocks and was solved in this PR by Asad Ali. I tried to further debug this but couldn't due to several errors in the Tutor release for Olive. The devstack provision command for Olive is also not working.

@pdpinch
Copy link
Contributor

pdpinch commented Jul 11, 2024

I've spoken with a number of folks about this, and they all agree that it's a bug.

Another area we should examine: edx-when. My understanding after discussing with @ormsbee is that the edx-when application manages a cached, customized version of course dates for users, particularly for self-paced courses where deadlines are shifted based on when the user starts the course.

@Anas12091101 Anas12091101 force-pushed the anas/disable-archive-course-submit branch from 0a5e269 to 148c141 Compare July 22, 2024 08:02
Copy link
Contributor

@ziafazal ziafazal left a comment

Choose a reason for hiding this comment

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

@Anas12091101 thanks for these improvements. I have couple of suggestions could you please take care of those?

@@ -795,12 +795,21 @@ def generate_report_data(self, user_state_iterator, limit_responses=None):
}
yield (user_state.username, report)

def get_course_end_date(self):
Copy link
Contributor

Choose a reason for hiding this comment

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

could you please change this to a property eg. course_end_date

@property
def close_date(self):
"""
Return the date submissions should be closed from.
"""
due_date = self.due
try:
Copy link
Contributor

Choose a reason for hiding this comment

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

Please move this try-except block in course_end_date property as suggested above

@Anas12091101 Anas12091101 requested a review from ziafazal July 22, 2024 12:34
@Anas12091101 Anas12091101 force-pushed the anas/disable-archive-course-submit branch 2 times, most recently from 4503def to 8a7bd18 Compare July 24, 2024 14:08
Copy link
Contributor

@ziafazal ziafazal left a comment

Choose a reason for hiding this comment

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

LGTM

@ziafazal ziafazal merged commit 3b8973a into openedx:master Jul 26, 2024
49 checks passed
@openedx-webhooks
Copy link

@Anas12091101 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

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

Anas12091101 added a commit to mitodl/edx-platform that referenced this pull request Aug 5, 2024
* fix: disable submit button for archived courses
ziafazal pushed a commit that referenced this pull request Aug 7, 2024
…quince (#35225)

* fix: disable submit button for archived courses (#34920)
Anas12091101 added a commit to mitodl/edx-platform that referenced this pull request Aug 7, 2024
* fix: disable submit button for archived courses
ziafazal pushed a commit that referenced this pull request Aug 8, 2024
…redwood (#35248)

* fix: disable submit button for archived courses (#34920)
ghassanmas pushed a commit to Abstract-Tech/edx-platform that referenced this pull request Oct 30, 2024
…) to quince (openedx#35225)

* fix: disable submit button for archived courses (openedx#34920)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants