openedx / openedx/openedx-platform

Merge several outline processors in into UserPartitionOutlineProcessor

Open
#34,459 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

From this list of processors, the following processors wrap concepts which, under the hood, are implemented on the user_partitions framework:

  • ContentGatingOutlineProcessor
  • EnrollmentTrackPartitionGroupsOutlineProcessor
  • CohortPartitionGroupsOutlineProcessor
  • TeamPartitionGroupsOutlineProcessor (new as of this PR)

Theoretically, they could all be merged into a single UserPartitionOutlineProcessor, which would dedupe some business logic and ensure that any new user_partition schemes automatically work with learning_sequences.

Open questions:

  • is this as straightforward as I think it is, or are there leaky abstractions / edge cases we're going to hit?
  • performance regressions?
  • could the same refactoring be applied to block transformers?

CC @ormsbee

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 with the processor list in openedx/core/djangoapps/content/learning_sequences/api/outlines.py around line 324, then inspect the four named outline processors and the user_partitions framework they wrap. Investigate whether their logic can be unified without edge cases or performance regressions, and whether block transformers are affected. The issue does not define concrete acceptance criteria, so confirm the intended scope before starting.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.