feat: include authz course + org role grants in Meilisearch access filter - #39073
feat: include authz course + org role grants in Meilisearch access filter#39073wgu-taylor-payne wants to merge 1 commit into
Conversation
|
Thanks for the pull request, @wgu-taylor-payne! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf 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 PRYour 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
66be8d2 to
5d245c8
Compare
…lter get_access_ids_for_request built the Meilisearch tenant-token filter from legacy CourseStaffRole/CourseInstructorRole only, so users holding an authz-only course role (course_editor / course_auditor with no legacy twin) were excluded from the search access filter. Their courses returned zero results in the global Studio search modal and the Library Updates "Review Content Updates" tab. This is openedx-authz#417. Add _get_authz_course_keys to union the user's per-course authz role assignments (CourseOverviewData scope) into the access_id filter clause, gated per-course on AUTHZ_COURSE_AUTHORING_FLAG so global-off deployments with per-course/org overrides still resolve correctly. Also handle org-wide (glob) authz grants, e.g. course-v1:Org+*, which surface as an OrgCourseOverviewGlobData scope rather than a per-course scope and so were missed by both filter clauses -- the same openedx#417 gap for the org case. Add get_authz_org_keys to resolve org-glob grants to org short_names and union them into _get_user_orgs, landing them in the org IN [...] clause (one entry per org, mirroring legacy org staff roles and avoiding per-course access_id fan-out against the JWT size cap). Gate each org on the flag's org-override-or-global resolution, since a per-course override cannot gate an org-wide grant. The authz lookups fail open on a DatabaseError (logged, empty set) so search degrades to legacy access rather than 500-ing; any other error propagates. Scope parsing is narrowed to InvalidKeyError so a non-course authz scope (e.g. a library) is skipped rather than mishandled. Closes: openedx/openedx-authz#417
5d245c8 to
a65995b
Compare
Description
Studio search is powered by Meilisearch. On each request to the Studio search token endpoint (
GET /api/content_search/v2/studio/),get_access_ids_for_request/_get_meili_access_filterbuild the per-user tenant-token filter that Meilisearch enforces server-side. The filter has two clauses:org IN [<org short_names>] OR access_id IN [<SearchAccess ids>]. Until now both clauses were built from legacy roles only —CourseStaffRole/CourseInstructorRolefor theaccess_id(per-course) clause, andOrgStaffRole/OrgInstructorRolefor theorgclause.Users who hold an authz-only course role —
course_editororcourse_auditorgranted through openedx-authz, with no corresponding legacyCourseAccessRolerow — were therefore invisible to the filter, and their courses returned zero results in the global Studio search modal (search icon / Cmd+K) and the "Review Content Updates" tab on the Library Updates page (/course/{id}/libraries), which uses Meilisearch to look up component details.This change fixes both clauses:
Per-course grants (
access_idclause): a new_get_authz_course_keyshelper unions the user's per-course authz role assignments (CourseOverviewDatascope) into theaccess_idfilter whenAUTHZ_COURSE_AUTHORING_FLAGis enabled. The flag is aCourseWaffleFlag, so the check is applied per course — a deployment running the flag globally-off with per-course or per-org overrides still resolves correctly.Org-wide (glob) grants (
orgclause): an authz course role can also be granted at an org-wide scope, e.g.course-v1:Org+*, which surfaces as anOrgCourseOverviewGlobDatascope rather than a per-courseCourseOverviewDatascope. That grant means "all courses in this org", so it was missed by both clauses — the per-course helper only looks atCourseOverviewData, and the legacy org clause only knows legacy org roles. A newget_authz_org_keyshelper resolves these glob grants to orgshort_names and unions them into_get_user_orgs, so they land in theorg IN [...]clause — one entry per org, mirroring how legacy org staff roles are handled and avoiding a per-courseaccess_idfan-out that would burn slots against the JWT size cap (MAX_ACCESS_IDS_IN_FILTER). Because an org-wide grant is not tied to a single course, its flag gate is resolved at the org tier: an org override (force-on/force-off) takes precedence, otherwise the global switch — a per-course override cannot gate an org-wide grant.Note that the authz→legacy compat layer already bridges
course_staff→staffandcourse_admin→instructor(roles with a legacy twin), so those grants were already reaching the filter; the load-bearing cases here arecourse_editor/course_auditor, which have no legacy twin and are dropped by compat. Both helpers query purely by scope type and are role-agnostic — inclusion is pure widening into anORfilter (you can only gain search on a course/org you already hold a role on), the same safety posture as the fail-open behavior below.Both lookups fail open: a
DatabaseErrorfrom the authz/Casbin backend is logged and degrades to legacy-role access rather than returning a 500, while any unexpected exception propagates so real bugs surface. A non-course scope key (e.g. a library scope) appearing in the per-course query is skipped viaInvalidKeyError.Impacted user roles: Course Author (editors/auditors who rely on authz roles, at course or org scope), Operator (behavior is gated behind
AUTHZ_COURSE_AUTHORING_FLAG).Supporting information
view_library_updatesenforcement work in Addcourses.view_library_updatesenforcement in openedx-platform openedx-authz#398 and PR feat: split read vs write authz checks for library updates #39009.Testing instructions
AUTHZ_COURSE_AUTHORING_FLAG(globally, or as a per-course / per-org override for the course/org under test).course_editor(orcourse_auditor) role on a course, and no legacyCourseStaffRole/CourseInstructorRoleon it.course_editor/course_auditorat an org-glob scope (e.g.course-v1:Org+*), enable the flag for that org, and confirm search returns that org's content via theorg IN [...]clause (previously: zero results).pytest openedx/core/djangoapps/content/search/tests/test_models.py openedx/core/djangoapps/content/search/tests/test_views.py— seeStudioSearchAuthzAccessTest(per-course: authz-only user sees courses with flag on,omit_orgsapplies, flag-off excludes,DatabaseErrorswallowed, unexpected error propagates, unparseable scope skipped, legacy+authz de-duplicate) andStudioSearchAuthzOrgAccessTest(org-glob: org grant lands in theorgclause, org-override forces on when the flag is globally off).Deadline
None.
Other information
AUTHZ_COURSE_AUTHORING_FLAGresolves enabled for a given course or org; with the flag off everywhere and no overrides, the filter is unchanged from today.get_user_role_assignments_per_scope_typeeagerly expands each role's implicit permissions, but these helpers only readscope.external_key/scope.organd discard the permissions — wasted work for users with many assignments. The computation runs once per token fetch (not per keystroke — the frontend reuses the minted tenant token for subsequent queries). A scopes-only authz API, and/or caching the computed access set with an explicit invalidation contract on role/flag change, would be the clean optimization; both are intentionally left out of this correctness fix.CourseWaffleFlag.is_enabledhas no public org-only entry point, soget_authz_org_keysreads the org override directly (WaffleFlagOrgOverrideModel.override_value) and falls back to the global switch. If an org-only public flag API is added later, this direct read should be migrated to it.