Skip to content

[FC-0099] feat: use synced enforcer#103

Merged
mariajgrimaldi merged 10 commits intoopenedx:mainfrom
eduNEXT:bav/synced-enforcer
Oct 22, 2025
Merged

[FC-0099] feat: use synced enforcer#103
mariajgrimaldi merged 10 commits intoopenedx:mainfrom
eduNEXT:bav/synced-enforcer

Conversation

@BryanttV
Copy link
Copy Markdown
Contributor

@BryanttV BryanttV commented Oct 17, 2025

Description

This PR replaces the use of FastEnforcer with SyncEnforcer. The SyncedEnforcer is based on the Enforcer and provides synchronized access. It is thread-safe. With this new enforcer, the entire policy is automatically loaded every X amount of time, configurable using the CASBIN_AUTO_LOAD_POLICY_INTERVAL setting.

Supporting Information

Testing Instructions

Using Tutor:

  1. Install this plugin with the changes in this PR.
  2. Run the migrations by running tutor dev exec lms python manage.py lms migrate
  3. Load the default policies by running tutor dev exec lms python manage.py lms load_policies
  4. Test all REST API endpoints in {lms-domain}/api-docs/#/authz

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

openedx-webhooks commented Oct 17, 2025

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 Oct 17, 2025
@BryanttV BryanttV marked this pull request as ready for review October 20, 2025 20:57
@BryanttV BryanttV changed the title feat: use synced enforcer [FC-0099] feat: use synced enforcer Oct 20, 2025
@BryanttV
Copy link
Copy Markdown
Contributor Author

I also evaluated adding a cache to the /permissions/validate/me view to avoid so many repetitive requests. Here’s what I found:

  • Since it’s a POST method, the cache_page decorator doesn’t work, so the caching would have to be done manually.
  • Caching the entire response may not be very effective, as multiple permissions are validated. A more granular approach might be better, caching each combination. Sometimes the validation could come from the cache, and other times from the enforcer itself.

My main concern with caching is how long we consider it acceptable to store the data. I initially set a default of 5 seconds (configurable with the PERMISSION_VALIDATION_CACHE_TIMEOUT setting), aligned with the interval used by the SyncEnforcer to load the policy, but I’d like to hear your thoughts on this.

@mariajgrimaldi @bmtcril

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.

Overall looks good, can you add a test that confirms the policy changes show up without a reload? Something that sets the reload time to like 1 second, and makes a change, then confirms the change appears?

@BryanttV BryanttV force-pushed the bav/synced-enforcer branch from ee1d150 to 6a73b4d Compare October 22, 2025 00:44
@BryanttV
Copy link
Copy Markdown
Contributor Author

Thanks for your suggestion @bmtcril, I added a new unit test to check the auto-load policy: b882525

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, thanks!

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, thank you!

Comment thread openedx_authz/settings/common.py Outdated
@BryanttV BryanttV force-pushed the bav/synced-enforcer branch from 6a73b4d to 83a5c30 Compare October 22, 2025 16:10
@BryanttV BryanttV force-pushed the bav/synced-enforcer branch from 6c6e0e3 to 467f8e3 Compare October 22, 2025 16:21
@BryanttV BryanttV force-pushed the bav/synced-enforcer branch from 6913a7b to 73f7d51 Compare October 22, 2025 16:27
@mariajgrimaldi mariajgrimaldi merged commit 1a2207a into openedx:main Oct 22, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants