Skip to content

feat: support role assignment for scopes that don't exist yet - #369

Draft
efortish wants to merge 1 commit into
openedx:mainfrom
eduNEXT:ks/issue#352
Draft

feat: support role assignment for scopes that don't exist yet#369
efortish wants to merge 1 commit into
openedx:mainfrom
eduNEXT:ks/issue#352

Conversation

@efortish

Copy link
Copy Markdown

Description

During course rerun, edx-platform needs to grant a user the instructor/staff role on the destination course key before that course's CourseOverview exists yet (the clone happens after role assignment would ideally occur). Today openedx-authz crashes in that case, so edx-platform (PR #38840) works around it with authz-specific branching that defers role assignment until after the course is cloned, plus a fallback check elsewhere in the meantime.

The actual crash: CourseScope.get_or_create_for_external_key() / ContentLibraryScope.get_or_create_for_external_key() call CourseOverview.get_from_id() / ContentLibrary.objects.get_by_key(), both of which raise DoesNotExist when the course/library isn't created yet.

This PR makes role assignment tolerant of that: the Scope row is created with its object FK left None, and gets linked up automatically once the real CourseOverview/ContentLibrary is saved.

Out of scope

Reverting the edx-platform PR #38840 workaround is explicit follow-up called out in the issue thread, not part of this change. The REST API's scope.exists() validation (rest_api/v1/serializers.py) is untouched — it's an intentional, separate guard for untrusted HTTP callers; this fix only affects the internal Python API path used directly by trusted platform code (e.g. student/roles.py's authz_add_role).

Solves #352

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 28, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @efortish!

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants