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: removing deprecated XBlock from reququirements #31158

Merged
merged 5 commits into from
Oct 18, 2022

Conversation

e0d
Copy link
Contributor

@e0d e0d commented Oct 14, 2022

Description

This PR removes a dependency that has been deprecated and move to openedx-unsupported.

Redirects will work in the meantime, but we should remove the reference here to the deprecated XBlock.

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

Thanks for the PR Ed. In order to apply these changes to the .txt, files, can you either:

  • run tutor dev run --mount=path/to/edx-platform lms make upgrade and commit the result, or
  • just update the requirements/edx/*.txt files by hand to remove RateXBlock?

Technically, we could just merge this as-is and let the requirements bot update the .txt files automatically, but that makes change tracing a bit more difficult, since the removal would occur not under this commit message but under an inconspicuous "chore: upgrade requirements" commit message.

@kdmccormick
Copy link
Member

Oh, and to indicate the breaking change, please use the feat!: ... commit type.

@Cup0fCoffee
Copy link
Contributor

Please ignore the mention, I tagged a wrong PR by mistake. Sorry for the noise.

kdmccormick
kdmccormick previously approved these changes Oct 17, 2022
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

🔥

# This is a temporary solution to override the real common_constraints.txt
# In edx-lint, until the pyjwt constraint in edx-lint has been removed.
# See BOM-2721 for more details.
# Below is the copied and edited version of common_constraints
Copy link
Contributor

Choose a reason for hiding this comment

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

Spurious addition?

Copy link
Member

Choose a reason for hiding this comment

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

I bet make upgrade pulled this in. I have the same change on another PR of mine that involved running make upgrade.

@timmc-edx
Copy link
Contributor

There's also a make compile-requirements for applying small changes without including upgrades. I think it would work here and make a more focused diff.

@kdmccormick
Copy link
Member

There's also a make compile-requirements for applying small changes without including upgrades.

🤯

@timmc-edx
Copy link
Contributor

Alternatively, you can remove the --upgrade from the Makefile, run make upgrade, and add it back in again before committing. :-D

Comment on lines -15 to -16
-e git+https://github.com/openedx/RateXBlock.git@2.0.1#egg=rate-xblock
# via -r requirements/edx/github.in
Copy link
Member

Choose a reason for hiding this comment

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

You'll also want to remove this from testing.txt and development.txt.

@timmc-edx
Copy link
Contributor

Hmm, it looks like there might still be a couple instances of this on edx.org -- need to check on that before merging.

@e0d
Copy link
Contributor Author

e0d commented Oct 17, 2022

There's also a make compile-requirements for applying small changes without including upgrades. I think it would work here and make a more focused diff.

make compile-requirements didn't work as hoped. It pulled in some additional deps and didn't remove the xblock from all the places.

@timmc-edx
Copy link
Contributor

I've found a couple of old course runs still using this. Any idea what happens if the XBlock is uninstalled and someone tries to interact with those courses?

@e0d
Copy link
Contributor Author

e0d commented Oct 17, 2022

@ormsbee Do you know the answer to Tim's question?

Copy link
Contributor

@timmc-edx timmc-edx left a comment

Choose a reason for hiding this comment

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

Looks like we're good to go on the edx.org side of things!

It's only used in a couple of courses, and even then only in a section hidden from students. My only concern was that it might break the learning or editing experience, but I did a test on devstack, and it's handled gracefully enough: The block is displayed as being in error in Studio (but the vertical can still be edited) and is simply not rendered on LMS.

image

@timmc-edx timmc-edx merged commit b6fb69f into openedx:master Oct 18, 2022
@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants