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: Don't add x-is-pointer-node attribute to Capa problem XML on paste [FC-0062] #35701

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Oct 22, 2024

Description

When a problem component is pasted from a library into a course, we use a hack that adds a "temporary" x-is-pointer-node attribute to the XML to prevent XmlMixin from looking for more XML data in a place that doesn't exist (the filesystem). However, this somehow causes the temporary x-is-pointer-node attribute to end up in the capa problem's data (string) attribute, and authors would see that if they use the advanced editor mode.

This PR fixes that by explicitly removing the attribute in cases where it persists.

Supporting information

Relates to openedx/frontend-app-authoring#1377 - this was one of the contributing causes.

Testing instructions

Paste a capa problem component from a library into a course, then open its advanced editor and verify that it doesn't have this attribute in its OLX.

Deadline

Not urgent.

Private ref: FAL-3873

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

Thanks for the pull request, @bradenmacdonald!

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.

@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Oct 22, 2024
@farhaanbukhsh farhaanbukhsh self-requested a review November 13, 2024 07:33
@bradenmacdonald bradenmacdonald changed the title fix: Don't add x-is-pointer-node attribute to Capa problem XML on paste fix: Don't add x-is-pointer-node attribute to Capa problem XML on paste [FC-0062] Nov 18, 2024
@bradenmacdonald bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Nov 18, 2024
Copy link
Member

@farhaanbukhsh farhaanbukhsh 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: on Tutor devstack with and without using the code.
  • ✅ I read through the code
  • ❌ I checked for accessibility issues
  • ❌ Includes documentation
  • ❌ I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

@farhaanbukhsh farhaanbukhsh force-pushed the braden/x-is-pointer-node branch from c5221b5 to de21b82 Compare November 28, 2024 18:34
@farhaanbukhsh farhaanbukhsh merged commit 919cc78 into openedx:master Nov 28, 2024
51 checks passed
@farhaanbukhsh farhaanbukhsh deleted the braden/x-is-pointer-node branch November 28, 2024 18:57
@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.

@itsjeyd itsjeyd removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project 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