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: The XBlock should work even when max_attempts is null #155

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

xitij2000
Copy link

@xitij2000 xitij2000 commented Jan 24, 2024

Overview

This change allows the XBlock to continue working in cases where max_attempts is set to null. Currently Studio and LMS will throw an error in such a case due to a number of places where max_attempts is compared to count_attempts without testing for None first.

Test Instructions

  • Set up this XBlock in a course
  • Set the max_attempts in course advanced setting to 1, save, and then set it to null and save
  • Test that the XBlock is working

TODO

  • Compile static assets
  • Lint all files
  • Pass all tests
  • Bump the version number in setup.py
  • Attach screenshots?
  • Code Reviewer 1:
  • Code Reviewer 2:
  • Submit PR against edx-platform to bump the version
  • Upload to PyPi

@openedx-webhooks
Copy link

openedx-webhooks commented Jan 24, 2024

Thanks for the pull request, @xitij2000!

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

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 24, 2024
@xitij2000 xitij2000 force-pushed the kshitij/fix-max-attempts-null branch from 7452d76 to 0758b56 Compare January 24, 2024 08:05
@mphilbrick211 mphilbrick211 requested a review from a team January 24, 2024 18:07
@mphilbrick211
Copy link

mphilbrick211 commented Jan 24, 2024

Hi @openedx/2u-arbi-bom! Would someone be able to please review / merge this for us? Thanks!

Copy link

@mavidser mavidser left a comment

Choose a reason for hiding this comment

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

👍

  • I tested this: Empty max_attempts is working
  • I read through the code

@xitij2000 xitij2000 force-pushed the kshitij/fix-max-attempts-null branch from 0758b56 to c9f583f Compare January 30, 2024 03:18
@awais786
Copy link

You need to fix the commit message.

 input: fixup: Update tests
✖   type must be one of [revert, feat, fix, perf, docs, test, build, refactor, style, chore, temp] [type-enum]

@xitij2000 xitij2000 force-pushed the kshitij/fix-max-attempts-null branch from f8ff4aa to bd9937c Compare January 30, 2024 14:51
@xitij2000
Copy link
Author

You need to fix the commit message.

 input: fixup: Update tests
✖   type must be one of [revert, feat, fix, perf, docs, test, build, refactor, style, chore, temp] [type-enum]

Done!

@xitij2000
Copy link
Author

You need to fix the commit message.

 input: fixup: Update tests
✖   type must be one of [revert, feat, fix, perf, docs, test, build, refactor, style, chore, temp] [type-enum]

Is this good to merge?

@xitij2000 xitij2000 force-pushed the kshitij/fix-max-attempts-null branch from bd9937c to 6388a54 Compare April 30, 2024 12:21
@mphilbrick211
Copy link

@openedx/2u-arbi-bom hi there! is someone able to take a look at this for us?

@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Jul 16, 2024
@mphilbrick211
Copy link

Once someone assigns themselves for review, we can resolve conflicts.

@xitij2000
Copy link
Author

@itsjeyd @mphilbrick211 Just checking on this, how can we push this forward?

@itsjeyd
Copy link

itsjeyd commented Nov 14, 2024

@xitij2000 @mphilbrick211 It looks like arbi-bom was reviewing this earlier: #155 (review). How about re-requesting a review from awais786?

@xitij2000
Copy link
Author

@awais786 Could you have another look at this PR since you reviewed it a while back?

@xitij2000
Copy link
Author

@itsjeyd The PR has already been reviewed and approved by him, it just needs a quick review and approval from someone with merge rights as well.

This change allows the XBlock to continue working in cases where max_attempts is
set to null. Currently Studio and LMS will throw an error in such a case due
to a number of places where max_attempts is compared to count_attempts without
testing for None first.
@itsjeyd
Copy link

itsjeyd commented Nov 15, 2024

@xitij2000 Ah right, I was assuming that awais786 would have merge rights, but perhaps that's not the case. Since this repo is unmaintained, you could try pinging @openedx/axim-engineering if needed.

CC @mphilbrick211

@awais786
Copy link

@xitij2000 I don't have merging rights. Also few jobs are failing in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

6 participants