edx-platform icon indicating copy to clipboard operation
edx-platform copied to clipboard
verified publisher icon openedx

fix: unhide discussion tab when enabling it (#677)

Open viadanna opened this issue 1 year ago • 2 comments

Description

Update the is_hidden property in the modulestore to store the visibility of the discussions tab properly.

Supporting information

  • https://github.com/open-craft/edx-platform/pull/677

Testing instructions

  1. Create a course in a Palm devstack/sandbox.
  2. Set the discussion tab to hidden.
  3. Export the course.
  4. Import the course in a Redwood devstack/sandbox.
  5. Create a Course Update
  6. Verify the discussion tab disappears in the LMS.
  7. Apply this change to the devstack/sandbox.
  8. Enable the discussions in Studio Pages & Resources.
  9. Create a Course Update.
  10. Verify the discussion tab does not disappear this time.

Deadline

None

viadanna avatar Sep 04 '24 19:09 viadanna

Thanks for the pull request, @viadanna!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

:radio_button: 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.
:radio_button: 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
:radio_button: 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.

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

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.

openedx-webhooks avatar Sep 04 '24 19:09 openedx-webhooks

@viadanna I have seen a similar problem with the Progress page as well. Maybe this is related to all the pages which were once managed through legacy Studio (Pages) and are now managed by Authoring MFE's (Pages & Resources)

arslanashraf7 avatar Sep 11 '24 15:09 arslanashraf7

@arslanashraf7 I haven't seen this issue with the progress page yet. I'd look into the endpoint handler view to check if the problem has the same cause as this one.

viadanna avatar Sep 12 '24 13:09 viadanna

Thanks @xitij2000

viadanna avatar Sep 12 '24 13:09 viadanna

@arslanashraf7 I haven't seen this issue with the progress page yet. I'd look into the endpoint handler view to check if the problem has the same cause as this one.

@viadanna Thanks.

For me, the steps were almost identical to yours and they are as follows:

  1. Disable Authoring MFE (Disable discussions.pages_and_resources_mfe waffle flag)
  2. Open the Pages page for a course in the studio from course settings
  3. Hide the progress page & save
  4. Re-enable the Authoring MFE (Enable discussions.pages_and_resources_mfe waffle flag)
  5. Export the course, And re-import
  6. Open Pages & Resources from the authoring MFE settings menu and Toggle the switch on the Progress card through
  7. The progress pages in the LMS/LearningMFE would stay hidden even if the switch for the progress page is On.

arslanashraf7 avatar Sep 13 '24 08:09 arslanashraf7

Hi @viadanna! Apologies for the delay in getting reviews. I've put this out to the community to help get it looked at.

In the meantime, would you be able to run the new tests that have popped up?

mphilbrick211 avatar Oct 30 '24 19:10 mphilbrick211

Sure thing, done @mphilbrick211

viadanna avatar Nov 14 '24 16:11 viadanna

Sure thing, done @mphilbrick211

Hi @viadanna - apologies, but another test has popped up. Would you mind running it when you get a moment? Thanks!

mphilbrick211 avatar Dec 10 '24 21:12 mphilbrick211

@viadanna I don't think I fully understand the problem here based on your description. What was the previous behavior this is trying to fix?

sarina avatar May 29 '25 15:05 sarina

@sarina Redwood changed how discussions are hidden or disabled, which didn't unhide courses previously hidden on Palm.

viadanna avatar May 30 '25 15:05 viadanna

I still don't think I understand, I'm sorry. Could you describe:

  • Previous behavior (pre-palm)
  • Current behavior (on master)
  • What problem this fix solves?

I am not really familiar with discussions, this problem, and the code comments don't help me. aton.

sarina avatar Jun 02 '25 14:06 sarina

Sorry for not being clear, Sarina. There are currently two mechanisms for hiding the discussions tab in Open edX:

  1. Pre-palm, we would mark the discussion tab with the is_hidden property.
  2. Redwood and later, we disable discussions entirely by toggling the discussion configuration enabled property.

The problem is that these properties aren't kept in sync when disabling discussions in master.

So a course that had its discussions hidden pre-Palm would feature the is_hidden property. If that course is loaded into a master instance, it will never change that property when enabling discussions, leading to the discussions tab being hidden.

With this PR, whenever the discussions configuration is updated, the is_hidden property on the discussion tab will be set to match the enabled state, so enabling discussions will always unhide the tab, and disabling will hide it. This ensures that older courses with is_hidden set will behave consistently with newer courses using the enabled flag.

viadanna avatar Jun 17 '25 12:06 viadanna

Thanks for the recommendations @sarina

viadanna avatar Jun 24 '25 12:06 viadanna

@viadanna apologies but could you kindly address the failing test?

sarina avatar Jun 24 '25 13:06 sarina

Sure, done @sarina

viadanna avatar Jun 24 '25 18:06 viadanna

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

edx-pipeline-bot avatar Jun 25 '25 14:06 edx-pipeline-bot

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

edx-pipeline-bot avatar Jun 25 '25 16:06 edx-pipeline-bot

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

edx-pipeline-bot avatar Jun 25 '25 16:06 edx-pipeline-bot

Thank you, Sarina!

viadanna avatar Jun 27 '25 11:06 viadanna