Skip to content

Dashboard: Org menu improvements for admins #1969

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

samejr
Copy link
Member

@samejr samejr commented Apr 23, 2025

Only show the "Switch organization" menu when you have multiple orgs, otherwise show a "New organization" button

CleanShot 2025-04-23 at 16 22 14

Adds a button to get back to the admin dashboard if you're an admin

CleanShot 2025-04-23 at 16 08 38

No buttons visible if you're not an admin

CleanShot 2025-04-23 at 16 08 24

Moves impersonation link from the menu dropdown to the main side menu

CleanShot 2025-04-23 at 16 08 48

Summary by CodeRabbit

  • New Features
    • Added an admin dashboard link to the side menu for users with admin access, accessible via a tooltip and cog icon.
  • Improvements
    • Updated impersonation banner to display a tooltip on hover instead of visible text, with enhanced styling and placement in the header area.
    • Refined organization switcher to improve menu labeling and display based on the number of organizations.
    • Adjusted visual cues for impersonation status in the side menu header.

Copy link

changeset-bot bot commented Apr 23, 2025

⚠️ No Changeset found

Latest commit: 5e2a96e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Apr 23, 2025

Walkthrough

This update modifies the user interface for admin and impersonation features in the web application. The ImpersonationBanner button is now wrapped in a tooltip, with the button's text hidden and shown only on hover. The side menu gains a conditional admin dashboard link, visible to users with admin access, and moves the impersonation banner to a more prominent location. Organization switching is refined for clarity, and a new utility function for the admin path is introduced. No exported function signatures are changed, except for the addition of the new adminPath function.

Changes

File(s) Change Summary
apps/webapp/app/components/ImpersonationBanner.tsx The impersonation stop button is now wrapped in a tooltip, hiding its text and displaying it on hover. The button's styling is updated, and unnecessary wrappers are removed.
apps/webapp/app/components/navigation/SideMenu.tsx Adds an admin dashboard link visible to admins, moves the impersonation banner to the header, updates visual cues for impersonation, and refines organization switching and menu item labeling. Removes some conditional border stylings and adjusts menu structure.
apps/webapp/app/utils/pathBuilder.ts Adds a new exported function adminPath that returns the admin dashboard path string (/@). No changes to existing functions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SideMenu
    participant useHasAdminAccess
    participant ImpersonationBanner
    participant Tooltip
    participant pathBuilder

    User->>SideMenu: Render side menu
    SideMenu->>useHasAdminAccess: Check admin access
    useHasAdminAccess-->>SideMenu: Return access status
    alt User is admin
        SideMenu->>pathBuilder: Get admin path
        SideMenu->>Tooltip: Wrap admin dashboard link in tooltip
    end
    SideMenu->>ImpersonationBanner: Render impersonation banner (with tooltip)
Loading

Possibly related PRs

  • triggerdotdev/trigger.dev#1801: Also modifies the ImpersonationBanner component, focusing on button styling and structure, indicating closely related changes to the same UI element.

Suggested reviewers

  • matt-aitken

Poem

A button now hides its amber glow,
Revealed by a tooltip’s gentle show.
The admin cog spins for those with the key,
While banners and borders dance with glee.
New paths are forged, selectors refined—
In this webby warren, improvements aligned!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0726620 and 5e2a96e.

📒 Files selected for processing (3)
  • apps/webapp/app/components/ImpersonationBanner.tsx (1 hunks)
  • apps/webapp/app/components/navigation/SideMenu.tsx (8 hunks)
  • apps/webapp/app/utils/pathBuilder.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (9)
apps/webapp/app/utils/pathBuilder.ts (1)

433-436: LGTM: New admin path function added.

The addition of the adminPath function follows the pattern of other path utilities in this file and centralizes the admin dashboard path in a single location. This supports the new admin dashboard link in the side menu.

apps/webapp/app/components/ImpersonationBanner.tsx (2)

4-4: LGTM: Required tooltip imports added.

Appropriate imports added to support the updated component UI.


8-26: Clean UI improvement for impersonation control.

The refactoring of the impersonation banner improves the UI by:

  1. Making the control more compact with an icon-only button
  2. Using a tooltip to display the action text on hover
  3. Providing better visual affordance with amber background

This change aligns with the PR objective of improving impersonation UI and makes the control more consistent with other UI elements.

apps/webapp/app/components/navigation/SideMenu.tsx (6)

36-36: LGTM: Required imports added.

Appropriate imports added for the admin path and user permission hook to support new functionality.

Also applies to: 80-80


111-111: LGTM: Admin access check added.

Adding the admin access check with the useHasAdminAccess hook properly implements permission-based UI.


137-138: Improved visual indication for impersonation state.

The conditional styling with amber dashed border provides a clear visual indication of the impersonation status, enhancing user awareness during impersonation sessions.


146-162: Admin dashboard access added per requirements.

This implementation satisfies the PR objective by adding a quick access button for admin users to navigate to the admin dashboard. The tooltip provides clear context for the icon button, and the conditional rendering ensures the button is only visible to users with admin access.

The impersonation banner is now prominently placed in the header area, making it more accessible as specified in the PR objectives.


427-436: Improved organization menu UX.

This change implements the PR objective to display the "Switch organization" menu only when multiple organizations exist, and show a "New organization" button when the user has a single organization. The implementation is clean and improves the user experience by simplifying the UI when only one organization is available.


539-539: LGTM: Consistent terminology.

Using lowercase "organization" in the menu item title maintains consistent terminology throughout the application.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant