feat: [FC-0056] Waffle flag for opening discussions/notifications by default #34650

NiedielnitsevIvan · 2024-04-29T07:36:08Z

Settings

COURSEWARE_WAFFLE_FLAGS:
  - name: courseware.enable_navigation_sidebar
    everyone: true
  - name: courseware.always_open_auxiliary_sidebar
    everyone: true

Description

This PR adding a waffle toggles for the Navigation and auxiliary sidebar features within the learning MFE.
The main goal is to implement two WaffleFlags and create an endpoint to get the enabled status for them.

GH ticket for tracking - openedx/platform-roadmap#329

How to configure waffle flag:

Go to /admin/waffle/flag/.
Add courseware.enable_navigation_sidebar waffle flag
Add courseware.always_open_auxiliary_sidebar waffle flag

API to get waffle flag state:

{LMS_DOMAIN}/courses/{course_id}/courseware-navigation-sidebar/toggles/

Testing API instructions:

Set waffle flags as described in "How to configure waffle flag"
Go to the API endpoint /courses/{course_id}/courseware-navigation-sidebar/toggles/
Assess the returned result. The API endpoint should return the correct WaffleFlags statuses.

openedx-webhooks · 2024-04-29T07:36:13Z

Thanks for the pull request, @NiedielnitsevIvan! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

arbrandes · 2024-04-30T14:27:19Z

Wasn't this just added via #34561?

GlugovGrGlib · 2024-04-30T15:44:34Z

Wasn't this just added via #34561?

I don't think so, the work from referenced PR is not related to the scope of FC-0056, #34561 PR contains an additional configuration for fully new functionality of the discussions on the course home page, this PR instead adds waffle flag for logic control on unit page only.

arbrandes

Aside from the comments below, I have one question regarding performance: was there no way to return the state of these new flags via an existing request that the MFE already makes? It would be great not to add another server request unless there's no other (clean) way.

arbrandes · 2024-05-01T15:01:37Z

lms/djangoapps/courseware/toggles.py

+# .. toggle_description: If waffle flag disabled
+# Discussions or Notifications sidebar shouldn't be displayed at all on Learning MFE.
+# If waffle flag enabled - Discussions opens always on the pages with discussions,
+# if user is in Audit and course has verified mode - show Notifications.# .. toggle_use_cases: temporary


As discussed with @GlugovGrGlib yesterday, we're going to need a more extensive description of what happens when this flag is toggled.

arbrandes · 2024-05-01T15:05:08Z

lms/djangoapps/courseware/toggles.py

+# .. toggle_tickets: FC-0056
+# .. toggle_warning: None.
+COURSEWARE_SHOW_DEFAULT_RIGHT_SIDEBAR = CourseWaffleFlag(
+    f'{WAFFLE_FLAG_NAMESPACE}.show_default_right_sidebar', __name__


To be honest, I think assuming this will be on the right is a mistake: it might not be on the right in all circumstances. We should come up with a more semantic name for it. If we're calling the other one the navigation sidebar, we could maybe call this one the "notification" one. Or something even more generic, like "auxiliary" sidebar. @jmakowski1123, thoughts?

Oh, and we should call it something more immediately descriptive like always_open_auxiliary_sidebar.

Thanks for the suggestions, I agree that generic name is more suitable for this

lms/djangoapps/courseware/toggles.py

lms/urls.py

GlugovGrGlib · 2024-05-02T22:09:21Z

lms/djangoapps/courseware/toggles.py

+# .. toggle_name: courseware.always_open_auxiliary_sidebar
+# .. toggle_implementation: WaffleFlag
+# .. toggle_default: True
+# .. toggle_description: TBD


TODO: @GlugovGrGlib to finalize description for toggle

… by default

Co-authored-by: Adolfo R. Brandes <[email protected]>

GlugovGrGlib · 2024-05-03T19:31:46Z

I can't update description, I'll ask @NiedielnitsevIvan as he back in office, for now I will put the latest description there.

The updated PR description:

Settings

COURSEWARE_WAFFLE_FLAGS:
  - name: courseware.enable_navigation_sidebar
    everyone: true
  - name: courseware.always_open_auxiliary_sidebar
    everyone: true

Description

This PR adding a waffle toggles for the Navigation and auxiliary sidebar features within the learning MFE.
The main goal is to implement two WaffleFlags and create an endpoint to get the enabled status for them.

How to configure waffle flag:

Go to /admin/waffle/flag/.
Add courseware.enable_navigation_sidebar waffle flag
Add courseware.always_open_auxiliary_sidebar waffle flag

API to get waffle flag state:

{LMS_DOMAIN}/courses/{course_id}/courseware-navigation-sidebar/toggles/

Testing API instructions:

Set waffle flags as described in "How to configure waffle flag"
Go to the API endpoint /courses/{course_id}/courseware-navigation-sidebar/toggles/
Assess the returned result. The API endpoint should return the correct WaffleFlags statuses.

arbrandes

Looks good, thanks!

openedx-webhooks · 2024-05-06T14:04:54Z

@NiedielnitsevIvan 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-pipeline-bot · 2024-05-06T15:41:16Z

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

edx-pipeline-bot · 2024-05-06T16:06:32Z

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

edx-pipeline-bot · 2024-05-06T16:06:32Z

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

edx-pipeline-bot · 2024-05-06T16:25:32Z

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

edx-pipeline-bot · 2024-05-06T16:45:56Z

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

edx-pipeline-bot · 2024-05-06T16:45:56Z

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

GlugovGrGlib · 2024-05-09T05:33:39Z

This PR is the part of - openedx/platform-roadmap#329

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

ihor-romaniuk mentioned this pull request Apr 30, 2024

[FC-0056] Course outline sidebar openedx/frontend-app-learning#1375

Merged

arbrandes requested changes May 1, 2024

View reviewed changes

GlugovGrGlib reviewed May 2, 2024

View reviewed changes

GlugovGrGlib requested a review from arbrandes May 3, 2024 19:18

NiedielnitsevIvan and others added 5 commits May 3, 2024 22:21

feat: [FC-0056] add waffle flag for opening discussions/notifications…

85c11ce

… by default

test: [FC-0056] add tests for new waffle flag view

12832f1

feat: add waffle flag to disable naigation sidebar

dfb9c0d

refactor: apply suggestions to rename waffle toggles

dea9d47

Co-authored-by: Adolfo R. Brandes <[email protected]>

refactor: use single view for both flags

5b94ae3

GlugovGrGlib force-pushed the NiedielnitsevIvan/FC-0056/feature/waffle-flag-for-displaying-discussions-tab branch from 5db8b8e to f4763a3 Compare May 3, 2024 19:21

docs: add description for the auxiliary sidebar waffle

956e59e

GlugovGrGlib force-pushed the NiedielnitsevIvan/FC-0056/feature/waffle-flag-for-displaying-discussions-tab branch from f4763a3 to 956e59e Compare May 3, 2024 19:33

arbrandes approved these changes May 6, 2024

View reviewed changes

arbrandes merged commit 333f1ff into openedx:master May 6, 2024
45 of 109 checks passed

GlugovGrGlib mentioned this pull request Jun 14, 2024

Reintroduce left-sidebar navigation openedx/platform-roadmap#329

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [FC-0056] Waffle flag for opening discussions/notifications by default #34650

feat: [FC-0056] Waffle flag for opening discussions/notifications by default #34650

NiedielnitsevIvan commented Apr 29, 2024 •

edited

Loading

openedx-webhooks commented Apr 29, 2024

arbrandes commented Apr 30, 2024

GlugovGrGlib commented Apr 30, 2024 •

edited

Loading

arbrandes left a comment

arbrandes May 1, 2024

GlugovGrGlib May 3, 2024

arbrandes May 1, 2024

arbrandes May 1, 2024

GlugovGrGlib May 2, 2024

GlugovGrGlib May 3, 2024

GlugovGrGlib May 2, 2024

GlugovGrGlib May 3, 2024

GlugovGrGlib commented May 3, 2024 •

edited

Loading

arbrandes left a comment

openedx-webhooks commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

GlugovGrGlib commented May 9, 2024

feat: [FC-0056] Waffle flag for opening discussions/notifications by default #34650

feat: [FC-0056] Waffle flag for opening discussions/notifications by default #34650

Conversation

NiedielnitsevIvan commented Apr 29, 2024 • edited Loading

Settings

Description

How to configure waffle flag:

API to get waffle flag state:

Testing API instructions:

openedx-webhooks commented Apr 29, 2024

arbrandes commented Apr 30, 2024

GlugovGrGlib commented Apr 30, 2024 • edited Loading

arbrandes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GlugovGrGlib commented May 3, 2024 • edited Loading

Settings

Description

How to configure waffle flag:

API to get waffle flag state:

Testing API instructions:

arbrandes left a comment

Choose a reason for hiding this comment

openedx-webhooks commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

edx-pipeline-bot commented May 6, 2024

GlugovGrGlib commented May 9, 2024

NiedielnitsevIvan commented Apr 29, 2024 •

edited

Loading

GlugovGrGlib commented Apr 30, 2024 •

edited

Loading

GlugovGrGlib commented May 3, 2024 •

edited

Loading