feat: migrate org scope access forward and rollback from/to authz policies by mariajgrimaldi · Pull Request #249 · openedx/openedx-authz

mariajgrimaldi · 2026-04-07T14:58:26Z

Description

Resolves: #222

This PR adds org-level support to the forward and rollback migration scripts.

Forward migration

The previous implementation filtered out course access roles with an empty course_id, which excluded org-level roles entirely. Changes:

Removed that filter to include org-level roles.
Scope external key is resolved per role in priority order:
1. course_id if non-empty (course-level scope, most restrictive)
2. org if non-empty (org-glob external key)
3. Neither defined: instance-level role, not yet supported.

Rollback migration

The rollback got a bit more complex. The previous approach queried the Casbin table through scope model relationships, but org-level roles have no associated scope, so they'd be excluded.

I went a different route: fetch all valid role assignments (course or org level), filter by course_id or org_id, then recreate the corresponding course access roles. I found it easier to use API calls here rather than ORM queries, though the tradeoff is that filtering moves from the DB to runtime. Open to suggestions since it's the biggest refactor in the PR.

How to test

I put together some scripts to test this. Download them and follow the instructions in the README:

scripts-migrations-testing.zip

Merge checklist:
Check off if complete or not applicable:

Version bumped
Changelog record added
Documentation updated (not only docstrings)
Fixup commits are squashed away
Unit tests added/updated
Manual testing instructions provided
Noted any: Concerns, dependencies, migration issues, deadlines, tickets

openedx-webhooks · 2026-04-07T14:58:34Z

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

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.

openedx_authz/engine/utils.py

openedx_authz/api/roles.py

openedx_authz/engine/utils.py

dwong2708 · 2026-04-08T18:47:10Z

openedx_authz/engine/utils.py

-        "course_id__startswith": "course-v1:",
-    }
+
+    # TODO: not sure if we should keep the startswith here


My Course Access Role data looks like this:

It seems we need this filter, at least in the case where an org is provided but the course_id_list parameter is not.

I think those are legacy libraries, right? In that case, it makes sense to keep that filter

Very interesting. Thanks for raising it! I'll work on this.

I was thinking about excluding any course_id different than empty (org-wide) or starting with course-v1 (course-level). What do you think?

Sounds good. I was going to suggest adding another condition to handle NULL values, but since it doesn’t accept them, it’s all good.

Implemented here: 7ad67d0

openedx_authz/engine/utils.py

rodmgwgu

Code is looking good, apart from the existing comments. Also I see that there is a coverage issue.

openedx_authz/api/roles.py

dwong2708 · 2026-04-09T18:12:04Z

@mariajgrimaldi just a minor comment, could you add something like the following to the PR description?

Resolves: #222

This helps link the task to the PR.

…ew model

…lob or specific key)

… roles

… if compatible

…mments

BryanttV · 2026-04-10T13:50:36Z

openedx_authz/engine/utils.py

+        course_access_role_model.objects.filter(**course_access_role_filter)
+        .filter(Q(course_id=CourseKeyField.Empty) | Q(course_id__startswith=CourseOverviewData.NAMESPACE))
+        .select_related("user")
+        .all()


Why do we need .all()?

It looks like when using select_related on a queryset, the latter operation is not actually needed. Thanks for noticing!

BryanttV · 2026-04-10T14:19:41Z

openedx_authz/engine/utils.py

    if course_id_list and not org_id:
-        # Only filter by course_id if org_id is not provided,
-        # otherwise we will filter by org_id which is more efficient
-        course_subject_filter["casbin_rules__scope__coursescope__course_overview__id__in"] = course_id_list
-
-    course_subjects = user_subject_model.objects.filter(**course_subject_filter).select_related("user").distinct()
+        role_assignments = [
+            role_assignment
+            for role_assignment in role_assignments
+            if role_assignment.scope.course_id in course_id_list
+        ]


I was running some tests, and the previous isinstance check is indeed necessary. For example, when migrating a specific course, there may also be org-level global assignments.

If I run:

python manage.py lms authz_rollback_course_authoring --course-id-list course-v1:SeedOrg+CS101+2024 --delete

We get the following error:

Rollback failed due to unexpected error: 'OrgCourseOverviewGlobData' object has no attribute 'course_id' Traceback (most recent call last): File "/openedx/edx-platform/manage.py", line 93, in <module> execute_from_command_line([sys.argv[0]] + django_args) File "/openedx/venv/lib/python3.12/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line utility.execute() File "/openedx/venv/lib/python3.12/site-packages/django/core/management/__init__.py", line 436, in execute self.fetch_command(subcommand).run_from_argv(self.argv) File "/openedx/venv/lib/python3.12/site-packages/django/core/management/base.py", line 420, in run_from_argv self.execute(*args, **cmd_options) File "/openedx/venv/lib/python3.12/site-packages/django/core/management/base.py", line 464, in execute output = self.handle(*args, **options) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/openedx/extra-deps/openedx-authz/openedx_authz/management/commands/authz_rollback_course_authoring.py", line 69, in handle errors, success = migrate_authz_to_legacy_course_roles( ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/openedx/extra-deps/openedx-authz/openedx_authz/engine/utils.py", line 345, in migrate_authz_to_legacy_course_roles if role_assignment.scope.course_id in course_id_list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AttributeError: 'OrgCourseOverviewGlobData' object has no attribute 'course_id'

Can we include a unit test to verify this?

Yes! I completely missed this. Thanks

It looks this part is untested, adding tests now

dwong2708

LGTM! Just a non-blocking comment

dwong2708 · 2026-04-10T18:36:34Z

openedx_authz/api/roles.py

+    """
+    return [
+        role_assignment for role_assignment in get_role_assignments()
+        if isinstance(role_assignment.scope, tuple(scope_types))


nit: I think the tuple cast could be moved above the return to avoid casting on each iteration. Alternatively, this function could accept a tuple directly, and the caller would pass it as such.

MaferMazu

@mariajgrimaldi, thanks for this PR.
Thanks for the helpers added in the api, and kudos for the script for testing, it makes it easy to try this out quickly. ✨

Migration and rollback results:
=== Summary ===
✅ PASS All checks passed.

And it looks good in the Casbin table and the course role access table.

A minor thing I found is in the migration messages: if the registry already exists, the message shows an error (the command didn't create it because it already exists). I'm not sure we should show an error when the registry is there.

Examples:

Here I was playing, and I got the error because a rollback entry already exists.

Here, I ran the migration script with the delete flag, immediately after running it without it.

... I don't think it is a blocker, but it is something I found.

openedx_authz/api/data.py

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Apr 7, 2026

openedx-webhooks added this to Contributions Apr 7, 2026

github-project-automation bot moved this to Needs Triage in Contributions Apr 7, 2026

mariajgrimaldi force-pushed the MJG/migration-script-org-level branch from cf6f212 to 749754c Compare April 7, 2026 16:19

mariajgrimaldi commented Apr 8, 2026

View reviewed changes

openedx_authz/engine/utils.py Outdated Show resolved Hide resolved

mariajgrimaldi force-pushed the MJG/migration-script-org-level branch from 39591db to 2375588 Compare April 8, 2026 09:17

mariajgrimaldi changed the title ~~Mjg/migration script org level~~ feat: migrate org scope access forward and rollback from/to authz policies Apr 8, 2026

mariajgrimaldi marked this pull request as ready for review April 8, 2026 15:58

mariajgrimaldi requested review from BryanttV, MaferMazu, bmtcril, ccantillo, dwong2708, rodmgwgu and wgu-taylor-payne April 8, 2026 15:58

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Apr 8, 2026

BryanttV reviewed Apr 8, 2026

View reviewed changes

openedx_authz/api/roles.py Outdated Show resolved Hide resolved

BryanttV reviewed Apr 8, 2026

View reviewed changes

openedx_authz/engine/utils.py Outdated Show resolved Hide resolved

dwong2708 suggested changes Apr 8, 2026

View reviewed changes

rodmgwgu reviewed Apr 8, 2026

View reviewed changes

mariajgrimaldi commented Apr 9, 2026

View reviewed changes

openedx_authz/api/roles.py Show resolved Hide resolved

mariajgrimaldi added 6 commits April 10, 2026 11:54

feat: consider org-level - org scope match access when migrating to n…

6da5271

…ew model

refactor: use only runtime utilities to filter by course namespace (g…

3251754

…lob or specific key)

refactor: go back to previous tests

543c3d2

refactor: consider course_id when migrating backward for course-level…

ba20d27

… roles

test: include test cases for org-level migrations

d369fe0

refactor: revert to previous tests that MUST pass with latest changes…

e255e0d

… if compatible

mariajgrimaldi added 6 commits April 10, 2026 11:54

refactor: address quality issues

9f0a35c

fix: address quality errors

e4b50c3

refactor: index users to avoid additional queries & improve inline co…

10b7c53

…mments

refactor: address PR reviews

28791a6

refactor: use is instance instead of matching per namespace

666629f

refactor: address PR reviews to inlcude only org/course wide access

7ad67d0

mariajgrimaldi force-pushed the MJG/migration-script-org-level branch from f099f26 to 7ad67d0 Compare April 10, 2026 09:55

mariajgrimaldi added 2 commits April 10, 2026 11:59

fix: address quality issues

e4f4eee

test: include test case for instance wide cases

df9f70f

mariajgrimaldi requested review from BryanttV, dwong2708 and rodmgwgu April 10, 2026 11:29

BryanttV suggested changes Apr 10, 2026

View reviewed changes

dwong2708 approved these changes Apr 10, 2026

View reviewed changes

MaferMazu reviewed Apr 11, 2026

View reviewed changes

openedx_authz/api/data.py Show resolved Hide resolved

Conversation

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

Uh oh!

Description

How to test

Uh oh!

openedx-webhooks commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Apr 9, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rodmgwgu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dwong2708 commented Apr 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dwong2708 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MaferMazu left a comment • 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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mariajgrimaldi commented Apr 7, 2026 •

edited

Loading

openedx-webhooks commented Apr 7, 2026 •

edited

Loading

mariajgrimaldi Apr 9, 2026 •

edited

Loading

MaferMazu left a comment •

edited

Loading