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: display profile name in navbar if available #483

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

Conversation

navinkarkera
Copy link

@navinkarkera navinkarkera commented Apr 9, 2024

Display profile name if it is set, else fallback to username.

Test instructions:

  • Setup tutor-quince locally.
  • Create a plugin in your tutor plugins printroot directory called mfe_custom_header.
  • Add below content to the file (We have published the changes in npm with a new package)
from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
    (
        "mfe-dockerfile-post-npm-install",
        """
RUN --mount=type=cache,target=/root/.npm,sharing=shared echo "installing custom header" && npm install @edx/frontend-component-header@npm:@opencraft/frontend-component-header@~4.6.1 && echo "done"
""",
    )
)
  • Enable this plugin by running tutor plugins enable mfe_custom_header.
  • Save tutor config by running tutor config save.
  • Run tutor images build mfe.
  • And tutor dev launch -I.

Now the new header should be installed in all MFEs (except dashboard as it doesn't depend on header component). Login with any user and if the user profile name is not set in Account page, you will see username like before. Update profile name by in the account setting page and logout and login again to see the name appear in header right corner.

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

openedx-webhooks commented Apr 9, 2024

Thanks for the pull request, @navinkarkera!

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 unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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.

Copy link

@CefBoud CefBoud left a comment

Choose a reason for hiding this comment

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

Good job on this, @navinkarkera !
LGTM ✅

  • I tested this
  • I read through the code
  • Includes documentation (N/A)

@hurtstotouchfire
Copy link
Member

Probably going to close openedx/frontend-app-learner-dashboard#313 so I'm moving this over here:

we should incorporate this into the product convo around removing username from the header. I think we'd need to pick between this approach and #465 which puts username behind a flag.

FYI @arbrandes / @jmakowski1123

@@ -88,7 +89,7 @@ class DesktopHeader extends React.Component {
className="btn btn-outline-primary d-inline-flex align-items-center pl-2 pr-3"
>
<Avatar size="1.5em" src={avatar} alt="" className="mr-2" />
{username} <CaretIcon role="img" aria-hidden focusable="false" />
{name || username} <CaretIcon role="img" aria-hidden focusable="false" />
Copy link
Contributor

Choose a reason for hiding this comment

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

This would make so there's no longer a 1:1 relationship between the DesktopHeader props and what is actually shown. In other words, it's not immediately obvious without looking at the implementation what happens if you provide both username and name.

In other words, unless I'm missing something, DesktopHeader has no reason to distinguish between username and name. It should just use a single prop, and the business logic of what to actually put there should be up to the user of the component.

Copy link
Author

Choose a reason for hiding this comment

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

@arbrandes That makes sense. Updated!

@navinkarkera
Copy link
Author

@arbrandes Gentle reminder

@mphilbrick211
Copy link

Hi @arbrandes @navinkarkera is this still in progress?

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
Projects
Status: In Eng Review
Development

Successfully merging this pull request may close these issues.

6 participants