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

FC-73 create pr for edx platform repository (Creating waffle flag for integration towards created_submission in the edx-submission repo) #36235

Closed
wants to merge 11 commits into from
Closed

FC-73 create pr for edx platform repository (Creating waffle flag for integration towards created_submission in the edx-submission repo) #36235

wants to merge 11 commits into from

Conversation

gabrielC1409
Copy link

@gabrielC1409 gabrielC1409 commented Feb 7, 2025 •
edited
Loading

Description

This pull request introduces several improvements and updates to the xmodule/layer module of the edx-platform repository. The main changes include:

Refactoring of xqueue_interface.py and xqueue_submission.py: The functions for sending and handling responses that a student sends within an exercise created in a course have been optimized. For this, the original functionality of sending the submission to Xqueue was maintained, but for this improvement a Waffle Switch was created, where within the LMS Administration it was possible to create and from the tutor env in the development.py file this environment variable is found pointing to the Switch created in the LMS Administration. This Switch was created within Xqueue_interfaces.py when you want to test or not this new functionality of sending the submit to created_submission.

Unit test update: The tests in test_xqueue_interface.py and test_xqueue_submission.py have been reviewed and updated to ensure compatibility with the new modifications and improve test coverage.

Improvements to helpers.py: Helper functions have been added to facilitate the creation of test environments and the simulation of specific scenarios.

Motivation:

These improvements aim to optimize the performance and maintainability of the XQueue-related code, ensuring a more robust and efficient integration into the evaluation workflow.

Tests performed:

All existing unit tests have been run and new tests have been added to cover the newly introduced cases. All tests have passed satisfactorily.

Additional considerations:

No negative impacts on other parts of the system are anticipated, as the changes are limited to the xmodule/layer module.

Recommendations for review:

A detailed review of the modified functions in xqueue_interface.py and xqueue_submission.py, as well as the new tests added in the corresponding files, is suggested.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 7, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 7, 2025 •
edited
Loading

Thanks for the pull request, @gabrielC1409!

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

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.

@sarina sarina added the FC Relates to an Axim Funded Contribution project label Feb 7, 2025
@sarina sarina changed the title Xqu 27 create pr for edx platform repository (Creating waffle flag for integration towards created_submission in the edx-submission repo) FC-73 create pr for edx platform repository (Creating waffle flag for integration towards created_submission in the edx-submission repo) Feb 7, 2025
sarina
sarina reviewed Feb 7, 2025
View reviewed changes
cms/envs/common.py Outdated
'username': 'lms',
'password': 'password'
'username': 'gabriel_admin',
'password': 'carvajal1407'
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this changing?

@sarina sarina closed this Feb 10, 2025
@sarina sarina reopened this Feb 10, 2025
sarina
sarina reviewed Feb 10, 2025
View reviewed changes
Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

Hi, I'm wondering why you're changing some defaults here

I also am not sure why the tests aren't running so maybe pushing another commit will help. You could resolve the conflicts in the PR.

lms/envs/common.py
'username': 'lms',
'password': 'password'
'username': 'gabriel_admin',
'password': 'carvajal1407'
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this changing?

cms/envs/common.py
@@ -878,7 +878,7 @@
CSRF_TRUSTED_ORIGINS_WITH_SCHEME = []

#################### CAPA External Code Evaluation #############################
XQUEUE_WAITTIME_BETWEEN_REQUESTS = 5 # seconds
XQUEUE_WAITTIME_BETWEEN_REQUESTS = 120 # seconds
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this changing?

@sarina
Copy link
Contributor

sarina commented Feb 10, 2025

@gabrielC1409 - your branch needs to be rebased on master, otherwise the tests will fail to run. Thanks.

@gabrielC1409
Copy link
Author

gabrielC1409 commented Feb 10, 2025 via email •
edited by sarina
Loading

@gabrielC1409 gabrielC1409 marked this pull request as draft February 10, 2025 20:51
@sarina
Copy link
Contributor

sarina commented Feb 11, 2025

@gabriel1407 could you please put the ADR in its own pull request? Thank you

@gabrielC1409
Copy link
Author

gabrielC1409 commented Feb 12, 2025 via email

@gabrielC1409 gabrielC1409 force-pushed the XQU-27-create-pr-for-edx-platform-repository branch from c892fb2 to 9a5a79c Compare February 12, 2025 20:19
@gabrielC1409
Copy link
Author

gabrielC1409 commented Feb 13, 2025 via email

@sarina
Copy link
Contributor

sarina commented Feb 13, 2025

Hi @gabrielC1409 - please use the GitHub UI - you can close your own pull requests and open new ones using the GitHub UI.

@sarina
Copy link
Contributor

sarina commented Feb 13, 2025

@gabriel1407 please read some guides we have about PRs to the project:

@gabrielC1409 gabrielC1409 deleted the XQU-27-create-pr-for-edx-platform-repository branch February 13, 2025 19:41
@gabrielC1409
Copy link
Author

gabrielC1409 commented Feb 14, 2025 via email

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

@sarina sarina sarina left review comments

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project 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.
4 participants
@gabrielC1409 @openedx-webhooks @sarina @gabriel1407