Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add has_course_author_access to CourseHomeMetadataView response [BB-9082] #35313

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

0x29a
Copy link
Contributor

@0x29a 0x29a commented Aug 14, 2024

Description

Adds has_course_author_access boolean to CourseHomeMetadataView. Currently it's used to control visibility of the "View as Staff" button here: openedx/frontend-app-learning#1436

Testing

Open any unit in frontend-app-learning, open Network tab in your browser console, and search for meta there. There will be a single request, and its JSON response should contain has_course_author_access key. It should be False for all users that don't have access to Studio, especially those having the "Limited Staff" course team role.

@openedx-webhooks
Copy link

Thanks for the pull request, @0x29a!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 14, 2024
@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Aug 15, 2024
@0x29a 0x29a force-pushed the 0x29a/BB-9082/add-roles-to-course-metadata branch 2 times, most recently from 99ae09f to a961d8f Compare September 5, 2024 10:22
@0x29a 0x29a changed the title feat: add user_roles to CourseHomeMetadataView response [BB-9082] feat: add has_course_author_access to CourseHomeMetadataView response [BB-9082] Sep 5, 2024
@0x29a 0x29a force-pushed the 0x29a/BB-9082/add-roles-to-course-metadata branch from a961d8f to d75051e Compare September 5, 2024 11:21
@@ -139,6 +140,7 @@ def get(self, request, *args, **kwargs):
'can_view_certificate': certificates_viewable_for_course(course),
'course_modes': course_modes,
'is_new_discussion_sidebar_view_enabled': new_discussion_sidebar_view_is_enabled(course_key),
'has_course_author_access': has_course_author_access(request.user, course_key, 'cms'),
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should leave a comment here explaining why we had to pass cms as the service variant here, even though the API might have been called from the LMS

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, @kaustavb12

Copy link
Contributor

@kaustavb12 kaustavb12 left a comment

Choose a reason for hiding this comment

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

Perhaps add some tests here to make sure the correct value for has_course_author_access for full staff/limited staff roles

Copy link
Contributor

@kaustavb12 kaustavb12 left a comment

Choose a reason for hiding this comment

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

@0x29a Left a couple of small comments, but otherwise the changes looks good.

👍

  • I tested this: Tested in local devstack
  • I read through the code

@itsjeyd itsjeyd added product review PR requires product review before merging and removed needs reviewer assigned PR needs to be (re-)assigned a new reviewer labels Sep 7, 2024
@itsjeyd
Copy link
Contributor

itsjeyd commented Sep 7, 2024

OSPR management note: User-facing change, so will likely need product approval before we can move forward with engineering review and merge.

Marking as blocked for now.

CC @mphilbrick211

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 product review PR requires product review before merging
Projects
Status: Blocked
Development

Successfully merging this pull request may close these issues.

5 participants