openedx / openedx/openedx-platform
Too many console warnings
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Many warnings routinely get logged when doing console operations in edx-platform. This is especially visible when provisioning a devstack installation (although the problem isn't limited to devstack). These warnings often indicate latent problems with the code that will cause headaches when attempting future upgrades, they distract developers when looking for the root cause of a problem, and some cause a disproportionate amount of log clutter because they reappear every time a management command is called. We should clean up as many of these as practical to improve the developer experience when working with the repository.
A/C:
- Enumerate all the warnings that appear when provisioning lms & cms in devstack (ideally also noting the number of times each one appears).
- Logs from recent provisioning runs can be found at https://github.com/openedx/devstack/actions/workflows/provisioning-tests.yml .
- While we also want to fix warnings that show up for other services, the scope of this issues is the ones generated from edx-platform.
- Create a separate GitHub Issue in this repository to resolve each warning. They should get the "maintenance" and "help wanted" labels.
- Create a tasklist in this issue collecting all the created issues.
Tasks
- https://github.com/openedx/edx-platform/issues/33571
- https://github.com/openedx/edx-platform/issues/33572
- https://github.com/openedx/XBlock/issues/641
- https://github.com/openedx/edx-toggles/issues/320
- https://github.com/openedx/edx-platform/issues/33573
- https://github.com/open-craft/xblock-poll/issues/114
- #33581
- #33582
- https://github.com/openedx/edx-enterprise/issues/1927
- #33583
- #33584
- https://github.com/openedx/edx-platform/issues/33585
- #33586
- #33587
- #33588
- https://github.com/openedx/edx-platform/issues/33592
- https://github.com/openedx/edx-platform/issues/31175
- #33589
- #33621
- #33622
- https://github.com/openedx/edx-platform/issues/35023
- https://github.com/openedx/edx-platform/issues/35044
- https://github.com/openedx/edx-platform/issues/35176
- https://github.com/openedx/edx-platform/issues/35175
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with recent lms and cms provisioning logs from the devstack provisioning-tests workflow and enumerate warnings originating in edx-platform, recording their frequency. For each warning, create a maintenance/help-wanted issue in the relevant repository and add its link to this issue's tasklist. Done means the edx-platform warnings are catalogued and the resulting issues are collected here.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100