feat!: Collection.key -> Collection.collection_code by kdmccormick · Pull Request #542 · openedx/openedx-core

kdmccormick · 2026-04-15T03:49:23Z

Description

Also, standardize internal usage of collection_key to collection_code.
This helps clarify that Collection.key is not an OpaqueKey, but is rather
a local slug, which can be combined with other identifiers to form a fully-
qualified LibraryCollectionKey instance.

BREAKING CHANGE: Collection.key has been renamed to Collection.collection_code.

BREAKING CHANGE: Collection.collection_code now validates that its contents
matches '[A-Za-z0-9-_.]+'. This was already effectively true, because
LibraryCollectionKey can only be built with slug-like parts, but we now
we explicitly raise ValiationError from create_collection.

Backup-restore still write and reads the collection_code to/from TOML files as key for backwards compatibility. This may change in a future "v2" restore format.

Co-Authored-By: Claude Sonnet 4.6 noreply@anthropic.com

Part of:

Resolve Opaque Key coherency issues #322

Full series of PRs:

Testing, AI Usage, and Merge Considerations

See #322

Also, standardize internal usage of collection_key to collection_code. This helps clarify that Collection.key is *not* an OpaqueKey, but is rather a local slug, which can be combined with other identifiers to form a fully- qualified LibraryCollectionKey instance. BREAKING CHANGE: Collection.key has been renamed to Collection.collection_code. BREAKING CHANGE: Collection.collection_code now validates that its contents matches '[A-Za-z0-9\-\_\.]+'. This was already effectively true, because LibraryCollectionKey can only be built with slug-like parts, but we now we explicitly raise ValiationError from create_collection. Backup now writes both 'key' and 'collection_code' to collection TOML files, so older software (which only knows 'key') can still read new archives. Restore accepts either field, preferring 'collection_code' and falling back to the legacy 'key'. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Part of: #322

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…llection_code' The backup_restore archive format stays unchanged — collections are still serialized with "key". A comment notes the divergence from the model field name (collection_code) and that a future v2 format may align them. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Adds a code_field_check(field_name, name=...) companion to code_field() that returns a CheckConstraint using Django's Regex lookup. This enforces the code regex at the database level (not just via validators), and Django also runs it as a Python-level validator automatically. Applied to Collection.collection_code as the first usage. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…zer.validate() Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

ormsbee

Great stuff! Thank you!

bradenmacdonald · 2026-04-17T18:30:45Z

 def update_collection(
    learning_package_id: LearningPackage.ID,
-    key: str,
+    collection_code: str,


Not at all a blocker, but something to consider for the future: our APIs are a bit inconsistent about how we identify the "thing" we're modifying in each API call.

My preference is this style where you can pass in an instance or a primary key:

openedx-core/src/openedx_catalog/api_impl.py

Lines 63 to 64 in 10eae2d

def update_catalog_course(

catalog_course: CatalogCourse | CatalogCourse.ID,

openedx-core/src/openedx_content/applets/containers/api.py

Lines 454 to 455 in 10eae2d

def create_next_container_version(

container: Container | Container.ID,

But this collection API is now using a composite (lp_id, collection_code) pattern:

openedx-core/src/openedx_content/applets/collections/api.py

Lines 67 to 69 in 0614fcb

def update_collection(

learning_package_id: LearningPackage.ID,

collection_code: str,

And other APIs accept only an ID:

openedx-core/src/openedx_content/applets/components/api.py

Lines 155 to 156 in 10eae2d

def create_next_component_version(

component_id: Component.ID,

And other APIs accept only an instance:

openedx-core/src/openedx_tagging/api.py

Lines 436 to 437 in 10eae2d

def add_tag_to_taxonomy(

taxonomy: Taxonomy,

I agree, this would be great to fix soon

bradenmacdonald

I didn't test this but the code changes look great. Thanks!

bradenmacdonald · 2026-04-17T18:34:50Z

+
+    dependencies = [
+        ('openedx_content', '0007_publishlogrecord_direct'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),


This might be another Claude artifact. This migration does not actually depend on the AUTH_USER_MODEL.

I presume we only need it for migrations which touch an FK to User?

Yes, I looked and every migration in core that has this dependency has a reference to settings. AUTH_USER_MODEL elsewhere in the list of changes.

Noted on #322 for followup

kdmccormick force-pushed the kdmccormick/keys-collection branch from 1489024 to 9875433 Compare April 15, 2026 09:42

ormsbee reviewed Apr 15, 2026

View reviewed changes

Comment thread src/openedx_content/applets/components/models.py Outdated

ormsbee assigned ormsbee and unassigned ormsbee Apr 15, 2026

ormsbee requested changes Apr 15, 2026

View reviewed changes

Comment thread src/openedx_content/applets/units/models.py

Comment thread src/openedx_content/migrations/0008_rename_collection_key_to_code_in_db.py Outdated

Comment thread src/openedx_content/applets/backup_restore/toml.py Outdated

bradenmacdonald reviewed Apr 15, 2026

View reviewed changes

Comment thread src/openedx_django_lib/fields.py

ormsbee reviewed Apr 16, 2026

View reviewed changes

Comment thread src/openedx_django_lib/fields.py Outdated

kdmccormick force-pushed the kdmccormick/keys-collection branch from 7eb00fd to b3daece Compare April 16, 2026 15:27

kdmccormick and others added 8 commits April 16, 2026 12:49

temp: ignore .claude directory

39ce524

fix(squash): restore Content->Media docstring renames from 7cf1539

200f68b

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix(squash): squash migrations 0007-0010 into single migration

5e472a2

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix(squash): regex style; remove inaccurate migration comment

b7b9a4a

fix(squash): renumber migration 0007->0008 after upstream/main rebase

d55764c

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

kdmccormick force-pushed the kdmccormick/keys-collection branch from b3daece to d55764c Compare April 16, 2026 17:04

kdmccormick and others added 2 commits April 16, 2026 19:05

fix(squash): move key->collection_code mapping into CollectionSeriali…

97f850b

…zer.validate() Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix(squash): use source='collection_code' instead of validate() override

0614fcb

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

kdmccormick mentioned this pull request Apr 17, 2026

Resolve Opaque Key coherency issues #322

Open

kdmccormick marked this pull request as ready for review April 17, 2026 17:49

ormsbee approved these changes Apr 17, 2026

View reviewed changes

bradenmacdonald reviewed Apr 17, 2026

View reviewed changes

bradenmacdonald approved these changes Apr 17, 2026

View reviewed changes

kdmccormick merged commit 2d5a17b into main Apr 17, 2026
6 checks passed

kdmccormick deleted the kdmccormick/keys-collection branch April 17, 2026 18:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: Collection.key -> Collection.collection_code#542

feat!: Collection.key -> Collection.collection_code#542
kdmccormick merged 10 commits intomainfrom
kdmccormick/keys-collection

kdmccormick commented Apr 15, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ormsbee left a comment

Uh oh!

bradenmacdonald Apr 17, 2026

Uh oh!

kdmccormick Apr 17, 2026

Uh oh!

bradenmacdonald left a comment

Uh oh!

bradenmacdonald Apr 17, 2026

Uh oh!

kdmccormick Apr 17, 2026

Uh oh!

bradenmacdonald Apr 17, 2026 •

edited

Loading

Uh oh!

kdmccormick Apr 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	def update_catalog_course(
	catalog_course: CatalogCourse \| CatalogCourse.ID,

	def create_next_container_version(
	container: Container \| Container.ID,

	def update_collection(
	learning_package_id: LearningPackage.ID,
	collection_code: str,

	def create_next_component_version(
	component_id: Component.ID,

Conversation

kdmccormick commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing, AI Usage, and Merge Considerations

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ormsbee left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

kdmccormick Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kdmccormick Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kdmccormick commented Apr 15, 2026 •

edited

Loading

bradenmacdonald Apr 17, 2026 •

edited

Loading