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

refactor: hide switch dashboard option behind flag #237

Merged
merged 5 commits into from
Dec 7, 2023

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Nov 7, 2023

Description

This PR adds a flag to turn on/off Switch Dashboard from the authenticated user dropdown with hard-coded references to edX. This change is temporary while maintainers determine how the switch dashboard feature can look to the community.

Testing instructions

You can follow these instructions for the tutor setup: #238
But use these configurations instead:

MFE_CONFIG_OVERRIDES = {
    "learner-dashboard": {
        "ENABLE_EDX_PERSONAL_DASHBOARD": False,
    }
}

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 7, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 7, 2023

Thanks for the pull request, @mariajgrimaldi! 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.

@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review November 7, 2023 17:15
@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Nov 8, 2023
@itsjeyd
Copy link

itsjeyd commented Nov 8, 2023

Hey @mariajgrimaldi, thanks for the PR!

It looks like there are some test failures. Would you mind fixing those before engineering review starts?

@itsjeyd itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Nov 8, 2023
@mariajgrimaldi
Copy link
Member Author

@itsjeyd: of course! Thanks

@mariajgrimaldi
Copy link
Member Author

mariajgrimaldi commented Nov 8, 2023

@itsjeyd: this is the error message
image
I'm not sure what it means. Can we rerun the tests? I tried closing and then re-opening the PR but it didn't work.

@arbrandes
Copy link
Contributor

@mariajgrimaldi, the email error is a red herring (I'm not sure why we have this turned on in the first place). The actual problem is just two snapshot failures in src/containers/LearnerDashboardHeader/ExpandedHeader/AuthenticatedUserDropdown.test.jsx. Mind regenerating them?

@itsjeyd
Copy link

itsjeyd commented Nov 17, 2023

@mariajgrimaldi It looks like @arbrandes answered your question. (Thanks!) Let me know when you've had a chance to follow up on his suggestion and the build is green.

@hurtstotouchfire hurtstotouchfire added the needs maintainer attention Issue or PR specifically needs the attention of the maintainer. label Nov 20, 2023
@justinhynes
Copy link
Contributor

@mariajgrimaldi -- did you see the latest comment on the test failures (and possibly needing to update the snapshots)?

Additionally, I'll be creating a backlog ticket for getting this in front of someone on our team. I could possibly prioritize getting this reviewed and merged this week if we can fix the test failures.

Thanks!

@mariajgrimaldi
Copy link
Member Author

@arbrandes @justinhynes @itsjeyd: on it! Thanks

@mariajgrimaldi mariajgrimaldi force-pushed the MJG/hide-personal-edx-dashboard branch from fced969 to 021e7cd Compare November 29, 2023 17:04
@mariajgrimaldi
Copy link
Member Author

@arbrandes @justinhynes @itsjeyd: tests updated and checks green! Thank you

Copy link

codecov bot commented Nov 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (edc4afe) 96.36% compared to head (06b1759) 96.46%.
Report is 2 commits behind head on master.

❗ Current head 06b1759 differs from pull request most recent head 5d17c0e. Consider uploading reports for the commit 5d17c0e to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #237      +/-   ##
==========================================
+ Coverage   96.36%   96.46%   +0.10%     
==========================================
  Files         194      194              
  Lines        1841     1838       -3     
  Branches      324      325       +1     
==========================================
- Hits         1774     1773       -1     
+ Misses         62       60       -2     
  Partials        5        5              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mariajgrimaldi
Copy link
Member Author

Question: should we turn off the personal dashboard by default? 🤔

@justinhynes
Copy link
Contributor

If it's a 2U/edX.org feature, having it disabled by default seems totally reasonable!

@justinhynes justinhynes removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Nov 30, 2023
Copy link
Contributor

@justinhynes justinhynes left a comment

Choose a reason for hiding this comment

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

LGTM

@justinhynes
Copy link
Contributor

@mariajgrimaldi ugh, sorry to bug you again -- could you rebase this whenever you get a chance?

I was going to merge it but realized this branch is out of date with main again.

@jsnwesson
Copy link
Contributor

Hi @mariajgrimaldi ! I am taking over for Aperture's on-call this week, so I'll keep an eye on this and #238 for merging whenever you rebase them.

@mariajgrimaldi mariajgrimaldi force-pushed the MJG/hide-personal-edx-dashboard branch from 06b1759 to d5c5bc4 Compare December 7, 2023 05:02
@mariajgrimaldi
Copy link
Member Author

Hi folks @itsjeyd @arbrandes @justinhynes.

I just rebased the branch with the latest changes in master and turned off the personal dashboard by default, so it can only be turned on using the MFE config or the MFE env.

Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@justinhynes
Copy link
Contributor

@mariajgrimaldi Thanks for your patience on the rebase(s). Looks good, I'll merge this shortly to ensure we don't need you to go through it again. :)

@justinhynes justinhynes merged commit bed2c34 into openedx:master Dec 7, 2023
4 checks passed
@openedx-webhooks
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). needs maintainer attention Issue or PR specifically needs the attention of the maintainer. open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Archived in project
Development

Successfully merging this pull request may close these issues.

Authenticated user dropdown personal dashboard redirects to hardcoded edX reference
7 participants