fix: platform-wide glob role assignments crash get_orgs_for_user/has_org_for_user by efortish · Pull Request #38980 · openedx/openedx-platform

efortish · 2026-08-12T16:45:47Z

Description

RoleBase._authz_get_orgs_for_user() (common/djangoapps/student/roles.py) reads assignment.scope.org for every AuthZ assignment. However, PlatformGlobData (the course-v1:* / lib:* platform-wide scopes) does not have an .org attribute, unlike CourseOverviewData / OrgGlobData, where .org is a valid (possibly None) field.

As a result, any user with a role assigned at a platform-wide scope would cause get_orgs_for_user() / has_org_for_user() to fail with an AttributeError.

The fix handles platform-wide assignments before accessing .org. Since a platform-wide grant applies to every organization, the compatibility layer returns all registered organization short names instead of trying to derive them from individual assignments.

Testing Instructions

Enable the authz.enable_course_authoring flag globally.
Assign a user a role at the platform-wide glob scope (course-v1:*).
Call role.get_orgs_for_user(user) / role.has_org_for_user(user), or trigger any code path that uses them (e.g., the Studio course listing).
Verify that all organizations are returned and no AttributeError is raised.

Added test_get_orgs_for_user_authz_platform_glob in common/djangoapps/student/tests/test_roles.py to cover this case.

…org_for_user RoleBase._authz_get_orgs_for_user() read assignment.scope.org for every AuthZ assignment, but PlatformGlobData (course-v1:*, lib:*) has no .org attribute at all, unlike CourseOverviewData/OrgGlobData where it's a real (possibly None) field. Any user with a platform-wide role crashed get_orgs_for_user()/has_org_for_user() with an AttributeError. Special-case platform-wide assignments: since they cover every org, return all registered org short names instead of deriving them from individual assignments. Fixes openedx/openedx-authz#380

openedx-webhooks · 2026-08-12T16:45:53Z

Thanks for the pull request, @efortish!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

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.

BryanttV

LGTM! thanks

@BryanttV

Per review feedback from @BryanttV on openedx#38980, also applied to test_course_listing.py which had the same pattern in unrelated pre-existing tests.

…to ks/issue-380-platform-glob-org

@BryanttV

…ents Per review feedback from @BryanttV on openedx#38980: exercising the real Casbin policy assignment + get_orgs_for_user path is more faithful than mocking get_user_role_assignments_filtered directly, and it catches issues the mock papered over (the mocked RoleData had external_key=COURSE_STAFF, the RoleData object itself, instead of COURSE_STAFF.external_key).

@mariajgrimaldi

Per review feedback from @mariajgrimaldi on openedx#38980: registers a third org that's never assigned, then asserts an org-scoped grant returns only its own org while a platform-wide grant returns all three, against the same pool of registered orgs — so the two branches (roles.py L640 vs L641, both list[str]) are actually distinguished by the test instead of coincidentally matching.

@BryanttV

Per review feedback from @BryanttV on openedx#38986 (same feedback given earlier on openedx#38984/openedx#38980) — new test code in this repo should use plain assert, not unittest-style assertions with # noqa: PT009.

@BryanttV

* fix: Course Auditor gets 403 navigating to a course unit xblock_outline_handler (the course outline tree) was already migrated to the AuthZ-aware user_has_course_permission(..., COURSES_VIEW_COURSE, ..., LegacyAuthoringPermission.READ) check, so it correctly recognizes AuthZ- native roles that have no legacy equivalent, like course_auditor and course_editor. xblock_container_handler (the unit/container page — what's hit when navigating to a unit) and xblock_view_handler (renders each child block's preview fragment on that page), plus xblock_edit_view, were never migrated the same way: they still called the legacy-only has_studio_read_access directly, which only recognizes roles with a legacy equivalent (staff/instructor/limited_staff). A Course Auditor has none, so get_user_permissions() returned no permissions and these handlers raised PermissionDenied, even though the outline (using the correct pattern) let the same user in. Migrate the three remaining read checks in block.py to the same user_has_course_permission pattern xblock_outline_handler already uses. The xblock_handler/handle_xblock CRUD endpoint was already correctly AuthZ-aware (via _check_xblock_permission) and needed no change. Fixes openedx/openedx-authz#384 * fix: also fix the REST API v1 container view that the Authoring MFE actually uses Manual testing against a real devstack found that the block.py fix alone wasn't enough: the modern Authoring MFE calls the REST API v1 ContainerHandlerView (/api/contentstore/v1/container_handler/...), which still 403'd for course_auditor. That view (and container_handler/container_embed_handler/xblock_edit_view in the legacy views) all route through the shared _get_item_in_course() helper in component.py, which gated on has_course_author_access — a legacy-only *write* check — even though all four callers only need read access to render a view. course_auditor has no legacy role equivalent, so it never had write access and always got PermissionDenied here, regardless of the block.py fix. Migrate _get_item_in_course() to the same user_has_course_permission read check, fixing all four callers (including the REST API v1 view) at their single shared choke point instead of patching each call site. Verified locally end-to-end: mounted this branch into a real devstack, assigned course_auditor to a test user, confirmed the unit page 403'd before this commit and loads correctly after it. Also ran the full test_block.py + test_vertical_block.py suites against the same devstack (186 passed). * fix: sort imports (ruff I001) * refactor: use plain assert instead of self.assertEqual in new tests Per review feedback from @BryanttV on #38986 (same feedback given earlier on #38984/#38980) — new test code in this repo should use plain assert, not unittest-style assertions with # noqa: PT009.

mariajgrimaldi

LGTM! Only a few comments about testing :)

Addresses mariajgrimaldi's latest review comments on the platform-glob tests: use OrganizationFactory instead of calling add_organization by hand, and replace the assertCountEqual + noqa: PT009 pairs with plain assert. assertCountEqual ignores order, but a plain == on lists doesn't, so used sorted() on both sides instead of the literal suggested assert, to avoid coupling the test to the order get_organizations() happens to return rows in.

mariajgrimaldi · 2026-09-03T12:38:11Z

@efortish: can we please rebase with main to resolve conflicts? Thanks!

…rm-glob-org # Conflicts: # common/djangoapps/student/tests/test_roles.py

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

openedx-webhooks added this to Contributions Aug 12, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Aug 12, 2026

efortish requested a review from BryanttV August 12, 2026 17:29

chore: retrigger CI (flaky JS video-volume-control test)

526ea04

efortish mentioned this pull request Aug 12, 2026

get_orgs_for_user/has_org_for_user crash on platform-wide glob roles openedx/openedx-authz#380

Closed

Merge branch 'master' into ks/issue-380-platform-glob-org

8b92fc6

BryanttV requested a review from mariajgrimaldi August 13, 2026 21:40

BryanttV added a commit to eduNEXT/edx-platform that referenced this pull request Aug 14, 2026

chore: add changes PR openedx#38980

26d0908

BryanttV approved these changes Aug 14, 2026

View reviewed changes

BryanttV reviewed Aug 14, 2026

View reviewed changes

Comment thread common/djangoapps/student/tests/test_roles.py Outdated

efortish added 3 commits August 14, 2026 16:22

refactor: use build_external_key() instead of hardcoded glob key strings

ace8a06

Per review feedback from @BryanttV on openedx#38980, also applied to test_course_listing.py which had the same pattern in unrelated pre-existing tests.

Merge remote-tracking branch 'ednx/ks/issue-380-platform-glob-org' in…

d32aa52

…to ks/issue-380-platform-glob-org

mariajgrimaldi reviewed Aug 19, 2026

View reviewed changes

Comment thread common/djangoapps/student/roles.py

mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Aug 19, 2026

BryanttV added a commit to eduNEXT/edx-platform that referenced this pull request Aug 20, 2026

chore: add changes PR openedx#38980

34b7408

BryanttV added a commit to eduNEXT/edx-platform that referenced this pull request Aug 27, 2026

chore: add changes PR openedx#38980

ef6bde5

mariajgrimaldi approved these changes Aug 31, 2026

View reviewed changes

Comment thread common/djangoapps/student/tests/test_roles.py

Comment thread common/djangoapps/student/tests/test_roles.py Outdated

Comment thread common/djangoapps/student/tests/test_roles.py Outdated

Comment thread common/djangoapps/student/roles.py

Merge remote-tracking branch 'origin/master' into ks/issue-380-platfo…

b8c1a65

…rm-glob-org # Conflicts: # common/djangoapps/student/tests/test_roles.py

Navigation Menu

Uh oh!

fix: platform-wide glob role assignments crash get_orgs_for_user/has_org_for_user - #38980

fix: platform-wide glob role assignments crash get_orgs_for_user/has_org_for_user#38980
efortish wants to merge 9 commits into
openedx:masterfrom
eduNEXT:ks/issue-380-platform-glob-org

efortish commented Aug 12, 2026 •

edited

Loading

Uh oh!

openedx-webhooks commented Aug 12, 2026

Uh oh!

BryanttV left a comment

Uh oh!

Uh oh!

Uh oh!

mariajgrimaldi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mariajgrimaldi commented Sep 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

efortish commented Aug 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing Instructions

Uh oh!

openedx-webhooks commented Aug 12, 2026

Uh oh!

BryanttV left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mariajgrimaldi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mariajgrimaldi commented Sep 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

efortish commented Aug 12, 2026 •

edited

Loading