Skip to content

feat: make PermissionValidationMeView aware of the course-authoring flag#361

Draft
mariajgrimaldi wants to merge 1 commit into
mainfrom
MJG/endpoints-flag-aware
Draft

feat: make PermissionValidationMeView aware of the course-authoring flag#361
mariajgrimaldi wants to merge 1 commit into
mainfrom
MJG/endpoints-flag-aware

Conversation

@mariajgrimaldi

@mariajgrimaldi mariajgrimaldi commented Jul 13, 2026

Copy link
Copy Markdown
Member

Description

Currently, the validate/me endpoint only checks Casbin permissions, so it could say a user is allowed on a course whose waffle flag is off. An additional check was implemented to validate whether the scope is visible at the platform (site-wide), org, or course level, meaning the waffle flag actually resolves to on for that scope (see ADR 0015).

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 Jul 13, 2026
@openedx-webhooks

Copy link
Copy Markdown

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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.

The validate/me endpoint only checked Casbin permissions, so it could say
a user is allowed on a course whose waffle flag is off. An additional
check is needed: whether the scope is visible at the platform (site-wide),
org, or course level, meaning the waffle flag actually resolves to on for
that scope (see ADR 0015).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/endpoints-flag-aware branch from 7d9f971 to 1f1f1dd Compare July 13, 2026 12:41
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jul 13, 2026
@mariajgrimaldi

mariajgrimaldi commented Jul 14, 2026

Copy link
Copy Markdown
Member Author

This PR was meant to partially solve #340 & #341 by supporting the proposal made here openedx/frontend-app-admin-console#176 (comment) for the Verawood release - returning False for scopes based on the waffle flag state. But the approach still needs to address other dimensions, such as the performance and correctness of the entire framework, especially since these issues are release blockers and the modified endpoints are critical to the system's functionality. Internally, we discussed the best solution moving forward, given that we shouldn't introduce big changes that put the framework's correctness at risk, and went ahead with #358 and supporting filtering via the admin-console MFE. This will definitely introduce complexity to the MFE logic, which will be addressed in the next release cycle.

mariajgrimaldi added a commit that referenced this pull request Jul 14, 2026
- get_waffle_flag_states used a manual Flag query for the global tier
instead of enable_authz_course_authoring, and returned flat booleans for
org/course overrides instead of the actual affected orgs/courses, split
by whether the override forces the flag on or off.

- Adds test coverage for get_waffle_flag_states and WaffleFlagStatesAPIView,
and an ADR documenting why this endpoint (issue #358) supersedes PR #361's
approach of enforcing the flag cascade inside release-blocking endpoints.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
mariajgrimaldi added a commit that referenced this pull request Jul 14, 2026
- get_waffle_flag_states used a manual Flag query for the global tier
instead of enable_authz_course_authoring, and returned flat booleans for
org/course overrides instead of the actual affected orgs/courses, split
by whether the override forces the flag on or off.

- Adds test coverage for get_waffle_flag_states and WaffleFlagStatesAPIView,
and an ADR documenting why this endpoint (issue #358) supersedes PR #361's
approach of enforcing the flag cascade inside release-blocking endpoints.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
MaferMazu pushed a commit to eduNEXT/openedx-authz that referenced this pull request Jul 14, 2026
- get_waffle_flag_states used a manual Flag query for the global tier
instead of enable_authz_course_authoring, and returned flat booleans for
org/course overrides instead of the actual affected orgs/courses, split
by whether the override forces the flag on or off.

- Adds test coverage for get_waffle_flag_states and WaffleFlagStatesAPIView,
and an ADR documenting why this endpoint (issue openedx#358) supersedes PR openedx#361's
approach of enforcing the flag cascade inside release-blocking endpoints.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
MaferMazu added a commit that referenced this pull request Jul 15, 2026
* feat: add waffle flag states rest api and util

* fix: address PR #358 review comments on get_waffle_flag_states

- get_waffle_flag_states used a manual Flag query for the global tier
instead of enable_authz_course_authoring, and returned flat booleans for
org/course overrides instead of the actual affected orgs/courses, split
by whether the override forces the flag on or off.

- Adds test coverage for get_waffle_flag_states and WaffleFlagStatesAPIView,
and an ADR documenting why this endpoint (issue #358) supersedes PR #361's
approach of enforcing the flag cascade inside release-blocking endpoints.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix: rollback to use Flag instead of enable_authz_course_authoring,
because that needs an argument

* fix: quality tests

* docs: bumpversion to 1.21.0

* docs: update the adr

---------

Co-authored-by: Maria Grimaldi <maria.grimaldi@edunext.co>
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
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

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants