feat: add has_course_author_access to CourseHomeMetadataView response [BB-9082] by 0x29a · Pull Request #35313 · openedx/openedx-platform

0x29a · 2024-08-14T16:41:02Z

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 · 2024-08-14T16:41:06Z

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.

lms/djangoapps/course_home_api/course_metadata/views.py

kaustavb12

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

kaustavb12

@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 · 2024-09-07T09:15:41Z

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

Cherry-picked from openedx#35313

…#682) Cherry-picked from openedx#35313

itsjeyd · 2024-10-24T08:44:18Z

OSPR management note: Product review complete, see openedx/platform-roadmap#361 (comment).

farhaanbukhsh · 2024-10-25T17:55:02Z

@0x29a Can you please rebase the PR?

0x29a · 2024-10-29T11:56:08Z

@farhaanbukhsh, done.

farhaanbukhsh

@0x29a Thank you for the work here I have tested this and all works well I have add few nit picks once done we will be in a good place to merge this.

common/djangoapps/student/auth.py

farhaanbukhsh · 2024-11-09T11:58:28Z

common/djangoapps/student/auth.py

    Old name for has_studio_write_access
    """
-    return has_studio_write_access(user, course_key)
+    return has_studio_write_access(user, course_key, service_variant)


Suggested change

return has_studio_write_access(user, course_key, service_variant)

return has_studio_write_access(user, course_key, service_variant=service_variant)

farhaanbukhsh

👍

✅ I tested this on Tutor devstack and check the testcases.
✅ I read through the code
❌ I checked for accessibility issues
✅ Includes documentation
❌ I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

edx-pipeline-bot · 2024-11-28T20:47:35Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-12-02T14:30:41Z

2U Release Notice: This PR has been deployed to the edX production environment.

…#682) Cherry-picked from openedx#35313 (cherry picked from commit 50470c1)

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 14, 2024

0x29a mentioned this pull request Aug 15, 2024

feat: hide studio button for limited staff [BB-9082] openedx/frontend-app-learning#1436

Merged

mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Aug 15, 2024

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 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 force-pushed the 0x29a/BB-9082/add-roles-to-course-metadata branch from a961d8f to d75051e Compare September 5, 2024 11:21

kaustavb12 reviewed Sep 6, 2024

View reviewed changes

lms/djangoapps/course_home_api/course_metadata/views.py Show resolved Hide resolved

kaustavb12 suggested changes Sep 6, 2024

View reviewed changes

kaustavb12 approved these changes Sep 6, 2024

View reviewed changes

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 mentioned this pull request Sep 7, 2024

Improvements to the Limited Staff role experience openedx/platform-roadmap#361

Closed

0x29a added a commit to open-craft/openedx-platform that referenced this pull request Sep 9, 2024

feat: add has_course_author_access to CourseHomeMetadataView response

bc10352

Cherry-picked from openedx#35313

0x29a mentioned this pull request Sep 9, 2024

feat: add has_course_author_access to CourseHomeMetadataView response [BACKPORT][BB-9082] open-craft/openedx-platform#682

Merged

kaustavb12 pushed a commit to open-craft/openedx-platform that referenced this pull request Sep 10, 2024

feat: add has_course_author_access to CourseHomeMetadataView response (…

50470c1

…#682) Cherry-picked from openedx#35313

itsjeyd added the product review complete PR has gone through product review label Oct 24, 2024

itsjeyd added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Oct 24, 2024

0x29a force-pushed the 0x29a/BB-9082/add-roles-to-course-metadata branch from d43841d to e35c057 Compare October 25, 2024 17:56

itsjeyd requested a review from farhaanbukhsh October 29, 2024 14:47

mphilbrick211 removed the product review PR requires product review before merging label Oct 30, 2024

farhaanbukhsh requested changes Nov 9, 2024

View reviewed changes

itsjeyd added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Nov 14, 2024

feat: add has_course_author_access to CourseHomeMetadataView response

a3323c6

0x29a added 2 commits November 25, 2024 18:30

docs: explain why specifying 'cms' service

c0cf2aa

test: has_course_author_access correctness

daa14f1

0x29a force-pushed the 0x29a/BB-9082/add-roles-to-course-metadata branch from e35c057 to daa14f1 Compare November 25, 2024 17:30

farhaanbukhsh approved these changes Nov 28, 2024

View reviewed changes

farhaanbukhsh merged commit 69216e5 into openedx:master Nov 28, 2024

farhaanbukhsh deleted the 0x29a/BB-9082/add-roles-to-course-metadata branch November 28, 2024 19:10

itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Dec 2, 2024

Cup0fCoffee pushed a commit to open-craft/openedx-platform that referenced this pull request Mar 2, 2025

feat: add has_course_author_access to CourseHomeMetadataView response (…

7fcc1ad

…#682) Cherry-picked from openedx#35313 (cherry picked from commit 50470c1)

Cup0fCoffee pushed a commit to open-craft/openedx-platform that referenced this pull request Mar 10, 2025

feat: add has_course_author_access to CourseHomeMetadataView response (…

6e4d412

…#682) Cherry-picked from openedx#35313 (cherry picked from commit 50470c1)

	return has_studio_write_access(user, course_key, service_variant)
	return has_studio_write_access(user, course_key, service_variant=service_variant)

Conversation

0x29a commented Aug 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Uh oh!

openedx-webhooks commented Aug 14, 2024

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

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

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

Uh oh!

Uh oh!

kaustavb12 left a comment

Choose a reason for hiding this comment

Uh oh!

kaustavb12 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

itsjeyd commented Sep 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

itsjeyd commented Oct 24, 2024

Uh oh!

farhaanbukhsh commented Oct 25, 2024

Uh oh!

0x29a commented Oct 29, 2024

Uh oh!

farhaanbukhsh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

farhaanbukhsh Nov 9, 2024

Choose a reason for hiding this comment

Uh oh!

farhaanbukhsh left a comment

Choose a reason for hiding this comment

Uh oh!

edx-pipeline-bot commented Nov 28, 2024

Uh oh!

edx-pipeline-bot commented Dec 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

0x29a commented Aug 14, 2024 •

edited

Loading

kaustavb12 left a comment •

edited

Loading

itsjeyd commented Sep 7, 2024 •

edited

Loading