716 archived field cc group models by ufedaseyeuconsultant · Pull Request #857 · openedx/openedx-core

ufedaseyeuconsultant · 2026-10-09T14:27:14Z

Description

Adds archived = models.BooleanField(default=False) to CompetencyCriteriaGroup and
CompetencyCriterion, in one migration, per ADR-0002
Decision 7's archive-only retirement rule (a group or criterion referenced by learner status is
retired by archiving, never hard-deleted). No archived_at companion field: django-simple-history
(ADR-0003) already tracks both models, covering the "when" without a separate timestamp.

This PR makes no behavior changes. Nothing here sets, reads, or filters on archived; that's
downstream tickets' scope (#674, #675, #681). Both models' existing .. no_pii: class-level
docstring annotation already covers the new field, matching CompetencyRuleProfile.archived's
existing non-PII precedent, so no separate PII registry change was needed.

Impacted roles: Developer only. This is a schema-only change with no reachable behavior yet;
no Course Author, Learner, or Operator-facing effect until a downstream ticket starts using the
field.

Supporting information

Closes [BE] Add archived field to Competency Criteria & Group models #716
Blocked by [BE] Implement CBE core data models (CompetencyTaxonomy, criteria, learner status) #613 (the CBE data model this PR adds a field to)
Unblocks [BE] Delete Competency Criterion #674, [BE] Build endpoint for removing a Competency Criteria Group #675, and [BE] GET Competency Criteria & Groups #681, which were drafted assuming this field would exist ("whichever
lands first adds it" language in their own tickets)
This work was originally implemented inline as part of [BE] GET Competency Criteria & Groups #681's own branch, then split out into
its own branch/PR so the model change lands and reviews independently of [BE] GET Competency Criteria & Groups #681's endpoint logic

Testing instructions

Apply the migration: python manage.py migrate openedx_learning
Confirm no missing migrations: python manage.py makemigrations --check --dry-run (should
report nothing pending for openedx_learning)
Run the new/updated model tests:
pytest tests/openedx_learning/applets/cbe/test_criteria_group.py tests/openedx_learning/applets/cbe/test_criterion.py --no-cov
— includes test_group_archived_defaults_to_false and test_criterion_archived_defaults_to_false,
pinning the same "defaults to False" contract CompetencyRuleProfile.archived already has a test
for
Run the full CBE suite to confirm nothing else broke:
pytest tests/openedx_learning/applets/cbe/ --no-cov
Run PII annotation coverage: tox -e pii_check (or directly:
code_annotations django_find_annotations --config_file .pii_annotations.yml --report --coverage)
and confirm CompetencyCriteriaGroup/CompetencyCriterion are not listed among uncovered models

Other information

Migration rollback: trivially reversible (AddField on four tables — the two models plus their
django-simple-history historical counterparts); no data migration involved.

🤖 Generated with Claude Code

openedx-webhooks · 2026-10-09T14:27:21Z

Thanks for the pull request, @ufedaseyeuconsultant!

This repository is currently maintained by @axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.

Details

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.

ufedaseyeuconsultant · 2026-10-09T14:28:46Z

@tbain Same as PR before
alezconsultant#5

tbain

One minor comment from me:

tests/openedx_learning/applets/cbe/test_criteria_group.py: 32 and tests/openedx_learning/applets/cbe/test_criterion.py:35 These docstrings are unnecessary, we can remove them to reduce the noise

Otherwise nothing from Codex

Details

## Verdict

No actionable bugs found in PR #857 against issue #716.

The PR correctly:

Adds archived = BooleanField(default=False) to both models.
Adds one migration covering live and historical tables.
Omits archived_at.
Preserves existing PII annotations and history tracking.
Adds no runtime archive behavior, as required.

Verification:

Targeted tests: 19 passed.
Full CBE suite: 144 passed.
Migration drift check: passed.
git diff --check: passed.
PII check is blocked by pre-existing repository-wide safelist/coverage issues unrelated to this PR.

One non-blocking question: the new help_text says the field hides rows from a criteria-tree read endpoint, although no such filtering exists yet. This appears intended as documentation for downstream work, but may be worth confirming.

…terion (openedx#716) Adds archived = models.BooleanField(default=False) to both models, in one migration, per ADR 0002 Decision 7's archive-only retirement rule. No archived_at companion field: django-simple-history (ADR 0003) already tracks both models, covering the "when" without a separate timestamp. Both models' existing `.. no_pii:` class-level docstring annotation already covers the new field, matching CompetencyRuleProfile.archived's existing non-PII precedent; no separate registry change needed. This ticket makes no behavior changes: nothing here sets, reads, or filters on the field. That is downstream tickets' scope (openedx#674, openedx#675, openedx#681). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Pins the same contract CompetencyRuleProfile.archived already has a test for (test_rule_profile.py's test_creating_a_rule_profile_persists_its_columns): a freshly created row is not archived unless told otherwise. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Cherry-picked 39561a6 and 0e9513b (openedx#716: add archived field to CompetencyCriteriaGroup and CompetencyCriterion) onto upstream/main to open a direct PR there instead of against this fork's lagging main. The original migration depended on 0008_criteria_group_unique_constraints, a migration from an unrelated, unmerged branch that doesn't exist on upstream/main. Deletes it and regenerates via makemigrations against upstream's current tip (0012_studentcompetencycriteriagroupstatus, from 48a04ee and 5984e3e), landing as 0013 with the identical field operations, just renumbered and re-based. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Review nit: test_group_archived_defaults_to_false and test_criterion_archived_defaults_to_false's docstrings add no information the function name doesn't already give. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Rebased onto upstream/main, which merged openedx#853 since this branch was last renumbered, adding its own 0013 migration depending on the same 0012_studentcompetencycriteriagroupstatus this branch's migration also depended on. Deletes the old 0013 and regenerates via makemigrations, landing as 0014; the field operations are otherwise identical to the deleted file. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

ufedaseyeuconsultant · 2026-10-09T17:52:00Z

@tbain Done

tbain · 2026-10-09T18:16:09Z

Approved, thanks :)

ormsbee

Minor requests around help text, and a nit about the migration naming. I'll be good to squash and merge after that.

Claude drafted the first pass of this review and ran the CBE tests, makemigrations --check, and the PII coverage report for me on this branch.

ormsbee · 2026-10-09T19:03:35Z

+    archived = models.BooleanField(
+        default=False,
+        help_text=_("Hides this row from the criteria-tree read endpoint by default, without removing it."),
+    )


Please describe what the flag means for the row rather than what one endpoint does with it. The "criteria-tree read endpoint" is #681, which doesn't exist yet, and it's one consumer among several: #674 and #675 are what set this, and #847's create_leaf_group() is going to have to care about it too. ADR-0002 Decision 2 already has the words, and CompetencyRuleProfile.archived below uses them. Maybe something like:

Suggested change

archived = models.BooleanField(

default=False,

help_text=_("Hides this row from the criteria-tree read endpoint by default, without removing it."),

)

archived = models.BooleanField(

default=False,

help_text=_(

"Set instead of deleting this group once learner status exists for it or anything beneath "

"it. Hides the group from authoring and new associations while keeping it queryable, so its "

"criteria and existing learner status rows stay resolvable."

),

)

Django bakes help_text into the migration, so 0014 needs regenerating after this. FYI @tbain: the same note applies to the archived fields in #856.

ormsbee · 2026-10-09T19:03:35Z

+    archived = models.BooleanField(
+        default=False,
+        help_text=_("Hides this row from the criteria-tree read endpoint by default, without removing it."),
+    )


Likewise here. Maybe:

Suggested change

archived = models.BooleanField(

default=False,

help_text=_("Hides this row from the criteria-tree read endpoint by default, without removing it."),

)

archived = models.BooleanField(

default=False,

help_text=_(

"Set instead of deleting this criterion once learner status exists for it. Hides the "

"criterion from authoring and new associations while keeping it queryable, so existing "

"learner status rows stay resolvable."

),

)

ormsbee · 2026-10-09T19:03:35Z

@@ -0,0 +1,48 @@
+# Generated by Django 5.2.17 on 2026-10-09 17:50


Nit (optional): Since this gets regenerated for the help_text change anyway, please give it a name that says what it does, e.g. makemigrations openedx_learning -n add_archived_to_criteria_group_and_criterion (--name).

The help_text on CompetencyCriteriaGroup.archived and CompetencyCriterion.archived named "the criteria-tree read endpoint" (openedx#681, not yet built) as if it were the only consumer, when openedx#674 and openedx#675 are what actually set the flag and openedx#847's create_leaf_group() will need to read it too. Reworded both to match CompetencyRuleProfile.archived's existing convention (ADR-0002 Decision 2): describe what archiving means for the row itself, not what one downstream endpoint does with it. Regenerates the migration (Django bakes help_text into it) with a descriptive name instead of the auto-generated "_and_more" one. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

ufedaseyeuconsultant · 2026-10-12T14:56:14Z

@ormsbee Done

ufedaseyeuconsultant · 2026-10-12T14:56:21Z

@ormsbee Done

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 9, 2026

openedx-webhooks added this to Contributions Oct 9, 2026

ufedaseyeuconsultant requested a review from tbain October 9, 2026 14:28

tbain suggested changes Oct 9, 2026

View reviewed changes

ufedaseyeuconsultant and others added 5 commits October 9, 2026 20:49

test: drop two docstrings that just restate the test name

ae5a420

Review nit: test_group_archived_defaults_to_false and test_criterion_archived_defaults_to_false's docstrings add no information the function name doesn't already give. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

ufedaseyeuconsultant force-pushed the ufedaseyeu/716-archived-field-onto-upstream branch from 70421ca to a684d66 Compare October 9, 2026 17:51

ufedaseyeuconsultant requested a review from tbain October 9, 2026 17:52

tbain approved these changes Oct 9, 2026

View reviewed changes

ormsbee requested changes Oct 12, 2026

View reviewed changes

ufedaseyeuconsultant requested a review from ormsbee October 12, 2026 14:56

ormsbee approved these changes Oct 12, 2026

View reviewed changes

ormsbee merged commit afce3e7 into openedx:main Oct 12, 2026
7 checks passed

github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 12, 2026

This was referenced Oct 14, 2026

Alezconsultant/665 criterion endpoint on 846 #847

Open

feat: evaluate and record a learner's leaf competency status for a grade #862

Open

Navigation Menu

Repository navigation

716 archived field cc group models - #857

716 archived field cc group models#857
ormsbee merged 6 commits into
openedx:mainfrom
ufedaseyeuconsultant:ufedaseyeu/716-archived-field-onto-upstream

ufedaseyeuconsultant commented Oct 9, 2026

Uh oh!

openedx-webhooks commented Oct 9, 2026

Uh oh!

ufedaseyeuconsultant commented Oct 9, 2026

Uh oh!

tbain left a comment

Uh oh!

ufedaseyeuconsultant commented Oct 9, 2026

Uh oh!

tbain commented Oct 9, 2026

Uh oh!

ormsbee left a comment

Uh oh!

ormsbee Oct 9, 2026

Uh oh!

ormsbee Oct 9, 2026

Uh oh!

ormsbee Oct 9, 2026

Uh oh!

ufedaseyeuconsultant commented Oct 12, 2026

Uh oh!

ufedaseyeuconsultant commented Oct 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -0,0 +1,48 @@
		# Generated by Django 5.2.17 on 2026-10-09 17:50

Conversation

ufedaseyeuconsultant commented Oct 9, 2026

Description

Supporting information

Testing instructions

Other information

Uh oh!

openedx-webhooks commented Oct 9, 2026

Uh oh!

ufedaseyeuconsultant commented Oct 9, 2026

Uh oh!

tbain left a comment

Choose a reason for hiding this comment

Uh oh!

ufedaseyeuconsultant commented Oct 9, 2026

Uh oh!

tbain commented Oct 9, 2026

Uh oh!

ormsbee left a comment

Choose a reason for hiding this comment

Uh oh!

ormsbee Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

ormsbee Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

ormsbee Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

ufedaseyeuconsultant commented Oct 12, 2026

Uh oh!

ufedaseyeuconsultant commented Oct 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants