openedx / openedx/openedx-platform

Remove "evil modulestore magic" in content_highlights

Open
#37,659 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.2k
Forks
4.4k
Avg merge
6d 18h
Merged PRs (30d)
42

Description

https://github.com/openedx/edx-platform/blob/41acf0eb520a4401577c7b49638ca955d52aa201/openedx/core/djangoapps/schedules/content_highlights.py#L140

Reasons to refactor:

  • it creates an dependency from shared code (openedx) to service-specific code (lms)
  • it looks like it might break the modulestore abstraction and be an issue during the LC modulestore shift?
  • it's confusing. why not just use get_block / get_item?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at openedx/core/djangoapps/schedules/content_highlights.py around line 140 and inspect the modulestore access used there. Trace the dependency between shared openedx code and lms-specific code, and compare the existing get_block/get_item paths. Done means the refactor removes the service-specific dependency without breaking the modulestore abstraction.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.