Skip to content

[FC-0099] refactor: update content library permissions to use namespaced identifiers#142

Merged
mariajgrimaldi merged 5 commits intoopenedx:mainfrom
eduNEXT:bav/add-namespace-in-permissions
Nov 14, 2025
Merged

[FC-0099] refactor: update content library permissions to use namespaced identifiers#142
mariajgrimaldi merged 5 commits intoopenedx:mainfrom
eduNEXT:bav/add-namespace-in-permissions

Conversation

@BryanttV
Copy link
Copy Markdown
Contributor

@BryanttV BryanttV commented Nov 13, 2025 •
edited
Loading

Description

BREAKING CHANGE: This PR updates the current content library permissions to include the app_name as a prefix. All future permissions should follow this convention.

Example:

- act^view_library
+ act^content_libraries.view_library

The above indicates that the view_library permission is associated with the content_libraries app.

Related Issues

Dependencies

Important

We need to update the permissions on the frontend (MFE) for the changes to work correctly on the platform.

Testing Instructions

  1. Install the plugin and test the functionality (endpoints, commands, etc.)
  2. All should work correctly.

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 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 Nov 13, 2025
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Nov 13, 2025 •
edited
Loading

Thanks for the pull request, @BryanttV!

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Nov 13, 2025
@BryanttV BryanttV changed the title refactor: update content library permissions to use namespaced identifiers [FC-0099] refactor: update content library permissions to use namespaced identifiers Nov 13, 2025
@BryanttV BryanttV marked this pull request as ready for review November 13, 2025 15:55
@BryanttV BryanttV mentioned this pull request Nov 13, 2025
Closed
@mariajgrimaldi
Copy link
Copy Markdown
Member

mariajgrimaldi commented Nov 13, 2025

@BryanttV: Is the change in the MFE something we can do? Or could we ask for support? I think @jacobo-dominguez-wgu could give us a hand :)

Let me know!

@BryanttV
Copy link
Copy Markdown
Contributor Author

BryanttV commented Nov 13, 2025

@mariajgrimaldi, I think the changes aren’t many; in theory, it would just be a matter of renaming the permissions. But if @jacobo-dominguez-wgu could help us, that would be ideal!, Especially since I’m not really sure how to test the MFE locally.

@BryanttV BryanttV force-pushed the bav/add-namespace-in-permissions branch from 4073698 to 520a3ea Compare November 13, 2025 17:59
@bmtcril
Copy link
Copy Markdown
Contributor

bmtcril commented Nov 13, 2025

Will this need a migration to convert from the old names?

@jacobo-dominguez-wgu jacobo-dominguez-wgu mentioned this pull request Nov 13, 2025
Closed
@jacobo-dominguez-wgu
Copy link
Copy Markdown
Contributor

jacobo-dominguez-wgu commented Nov 13, 2025

@mariajgrimaldi, I think the changes aren’t many; in theory, it would just be a matter of renaming the permissions. But if @jacobo-dominguez-wgu could help us, that would be ideal!, Especially since I’m not really sure how to test the MFE locally.

@BryanttV, @mariajgrimaldi I created this issue openedx/frontend-app-admin-console#35 to track the work on the MFE

@mariajgrimaldi mariajgrimaldi linked an issue Nov 13, 2025 that may be closed by this pull request
Namespace or app names in our permissions #136
Closed
bmtcril
bmtcril approved these changes Nov 13, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

Looks good to me as long as we can figure out merge order with the front end. Just one nit.

Comment thread openedx_authz/api/data.py Outdated
@property
def name(self) -> str:
"""The human-readable name of the action (e.g., 'Delete Library', 'Edit Content').
"""The human-readable name of the action (e.g., 'Content Libraries.Delete Library').
Copy link
Copy Markdown
Contributor

@bmtcril bmtcril Nov 13, 2025

Choose a reason for hiding this comment

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

Do these actually need the .?

Copy link
Copy Markdown
Contributor Author

@BryanttV BryanttV Nov 13, 2025

Choose a reason for hiding this comment

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

Maybe the . is not needed. I was looking into it, and I think a more human-readable structure with this new convention could be:

content_libraries.view_library → Content Libraries > View Library

What do you think? This is the commit: 108378f

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Nov 13, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Nov 13, 2025
@BryanttV
Copy link
Copy Markdown
Contributor Author

BryanttV commented Nov 13, 2025

Will this need a migration to convert from the old names?

@bmtcril, we can just run the load_policies --clear-existing command to empty the database and upload the new permissions. What do you think?

@BryanttV BryanttV requested a review from bmtcril November 13, 2025 23:01
mariajgrimaldi
mariajgrimaldi approved these changes Nov 14, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

LGTM!

Hope we can backport with this version so we don't need any other migration. Thanks!

@bmtcril
Copy link
Copy Markdown
Contributor

bmtcril commented Nov 14, 2025

Will this need a migration to convert from the old names?

@bmtcril, we can just run the load_policies --clear-existing command to empty the database and upload the new permissions. What do you think?

That won't handle any manually added permissions via the UI, but I think if we get this on edx-platform master very soon it shouldn't matter.

@bmtcril bmtcril mentioned this pull request Nov 14, 2025
Merged
7 tasks
@mariajgrimaldi mariajgrimaldi merged commit 5564afd into openedx:main Nov 14, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Nov 14, 2025
This was referenced Nov 14, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MaferMazu MaferMazu MaferMazu approved these changes

@mariajgrimaldi mariajgrimaldi mariajgrimaldi approved these changes

@bmtcril bmtcril bmtcril approved these changes

Assignees

No one assigned

Labels

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

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Namespace or app names in our permissions

7 participants

@BryanttV @openedx-webhooks @mariajgrimaldi @bmtcril @jacobo-dominguez-wgu @MaferMazu @mphilbrick211