Skip to content

feat: use authz permission checks for tagging in course authoring#38436

Open
wgu-taylor-payne wants to merge 4 commits intoopenedx:masterfrom
WGU-Open-edX:tpayne/authz-tagging
Open

feat: use authz permission checks for tagging in course authoring#38436
wgu-taylor-payne wants to merge 4 commits intoopenedx:masterfrom
WGU-Open-edX:tpayne/authz-tagging

Conversation

@wgu-taylor-payne
Copy link
Copy Markdown
Contributor

@wgu-taylor-payne wgu-taylor-payne commented Apr 23, 2026

Description

Use authz permission checks for tagging in course authoring when the AUTHZ_COURSE_AUTHORING_FLAG flag is enabled.

Reopens #38416 (auto-closed when base branch was merged).

Companion openedx-core PR: openedx/openedx-core#550.

Supporting information

Closes #38143.
Adjacent investigation into legacy permissions around tagging: #38222
Permission list: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/5528715266/openedx-authz+permission+list

Testing instructions

Automated tests

pytest --ds=cms.envs.test \
openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py::TestObjectTagOrgViewWithAuthz \
cms/djangoapps/contentstore/views/tests/test_block.py::TestXBlockOutlineHandlerAuthz

Manual tests

  • Enable the authz.enable_course_authoring flag.
  • Navigate to the course outline or block editor for a course where the flag is enabled.
  • Global staff/superusers: can view outline, add/remove tags, see edit/delete controls on tags.
  • Course staff role: can view outline, add/remove tags, see edit/delete controls on tags. Cannot tag other courses they don't have the role on.
  • Course auditor role: can view outline and see existing tags (read-only). Cannot add/remove tags (403).

Deadline

Verawood

Other information

GitHub Copilot with Claude Sonnet 4 was used to aid development.

@openedx-webhooks 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 23, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Apr 23, 2026

Thanks for the pull request, @wgu-taylor-payne!

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

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 23, 2026
@wgu-taylor-payne wgu-taylor-payne force-pushed the tpayne/authz-tagging branch 2 times, most recently from 469ddd3 to f2624a4 Compare April 24, 2026 17:24
Copilot AI reviewed Apr 24, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates course authoring tagging endpoints to use openedx-authz permission checks (behind AUTHZ_COURSE_AUTHORING_FLAG) while retaining legacy permission behavior for non-course objects, and aligns CMS outline access with AuthZ.

Changes:

  • Bump openedx-core to 0.45.0 and relax the corresponding constraints upper bound to <0.46.
  • Add conditional AuthZ-based permission enforcement for object tagging (view/manage) and serializer permission fields.
  • Switch xblock_outline_handler read-access checks to user_has_course_permission with legacy fallback when AuthZ is disabled, and add AuthZ-focused tests.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
requirements/edx/testing.txt Bumps openedx-core pin to 0.45.0.
requirements/edx/doc.txt Bumps openedx-core pin to 0.45.0.
requirements/edx/development.txt Bumps openedx-core pin to 0.45.0.
requirements/edx/base.txt Bumps openedx-core pin to 0.45.0.
requirements/constraints.txt Allows openedx-core up to <0.46.
openedx/core/djangoapps/content_tagging/rest_api/v1/views.py Adds AuthZ branching for course object tag view/manage permissions and permission classes.
openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py Adds AuthZ-backed serializer permission computations for tagging/deleting.
openedx/core/djangoapps/content_tagging/auth.py Adds helper to determine whether to use AuthZ for a given object id/context.
openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py Adds AuthZ tests for object tag endpoints and updates query-count expectations.
cms/djangoapps/contentstore/views/tests/test_block.py Adds AuthZ tests for outline handler access.
cms/djangoapps/contentstore/views/block.py Uses AuthZ permission check for outline handler, with legacy fallback when AuthZ is disabled.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py Outdated
Comment thread openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py
Comment thread openedx/core/djangoapps/content_tagging/rest_api/v1/views.py Outdated
Comment thread openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py Outdated
dwong2708
dwong2708 approved these changes Apr 24, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@dwong2708 dwong2708 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks.

@wgu-taylor-payne wgu-taylor-payne mentioned this pull request Apr 24, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@rodmgwgu rodmgwgu Awaiting requested review from rodmgwgu

@bmtcril bmtcril Awaiting requested review from bmtcril

@mariajgrimaldi mariajgrimaldi Awaiting requested review from mariajgrimaldi

@MaferMazu MaferMazu Awaiting requested review from MaferMazu

+1 more reviewer

@dwong2708 dwong2708 dwong2708 approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Status: Needs Triage

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Task - RBAC Authz - Implement new permissions for Tags and Taxonomies

4 participants

@wgu-taylor-payne @openedx-webhooks @dwong2708