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

fix: use workspace name in team switcher #2719

Merged
merged 1 commit into from
Dec 7, 2024
Merged

fix: use workspace name in team switcher #2719

merged 1 commit into from
Dec 7, 2024

Conversation

chronark
Copy link
Collaborator

@chronark chronark commented Dec 7, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced WorkspaceSwitcher component in both DesktopSidebar and MobileSideBar to receive workspace context for improved functionality.
    • Updated rendering logic in WorkspaceSwitcher to consistently display the correct workspace name.
  • Bug Fixes

    • Corrected a typo in the tooltip content for the subscription downgrade notification.

These changes improve user experience by providing relevant workspace information and ensuring accurate messaging throughout the application.

Copy link

vercel bot commented Dec 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 7, 2024 6:17pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 7, 2024 6:17pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 7, 2024 6:17pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 7, 2024 6:17pm

Copy link

changeset-bot bot commented Dec 7, 2024

⚠️ No Changeset found

Latest commit: d283184

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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 Dec 7, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the DesktopSidebar, MobileSideBar, and WorkspaceSwitcher components. The primary enhancement is the addition of a workspace prop to the WorkspaceSwitcher, allowing it to receive and utilize workspace-specific data. Additionally, minor textual corrections have been made in tooltips. The overall structure and logic of the components remain intact, with no significant alterations to control flow or error handling.

Changes

File Change Summary
apps/dashboard/app/(app)/desktop-sidebar.tsx Added workspace prop to WorkspaceSwitcher. Corrected tooltip typo in subscription downgrade notification.
apps/dashboard/app/(app)/mobile-sidebar.tsx Added workspace prop to WorkspaceSwitcher, allowing it to receive workspace data.
apps/dashboard/app/(app)/team-switcher.tsx Introduced new Props type for WorkspaceSwitcher to include workspace object. Updated rendering logic to use props.workspace.name.

Possibly related PRs

  • feat: Added support to sidebar #2119: The changes in the DesktopSidebar component in both the main PR and this PR involve modifications to the WorkspaceSwitcher component, specifically the addition of a workspace prop, indicating a direct relationship in enhancing the sidebar functionality.
  • fix: Workspace Permissions overlaps with their descriptions on smaller windows #2127: This PR also involves changes to the MobileSideBar component, where the WorkspaceSwitcher receives a workspace prop, similar to the changes made in the main PR, establishing a connection in the enhancement of workspace context across sidebar components.
  • feat: Add profile on mobile top nav #2236: The modifications in the MobileSideBar component in this PR include the addition of a UserButton, which is relevant as it enhances user interaction in the sidebar, aligning with the overall goal of improving sidebar functionality seen in the main PR.
  • fix(dashboard): "No bucket found" message position on Audit Logs page #2413: The changes in the Row component related to rendering and layout improvements may not directly connect to the main PR's sidebar changes, but they reflect a broader effort to enhance user experience in the dashboard, which is a common theme across the PRs.
  • fix: resolve 16 of 54 lint warnings #2652: While this PR focuses on resolving lint warnings, it indicates ongoing efforts to maintain code quality across components, including those modified in the main PR, suggesting a shared commitment to improving the overall codebase.

Suggested labels

Bug, Feature, 🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

  • mcstepp
  • perkinsjr

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.

Copy link
Contributor

github-actions bot commented Dec 7, 2024

Thank you for following the naming conventions for pull request titles! 🙏

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/desktop-sidebar.tsx (1)

Line range hint 69-71: Fix typo in tooltip text

There's a spelling error in the tooltip text.

-              Your plan is schedueld to be downgraded to the {workspace.planDowngradeRequest} tier
+              Your plan is scheduled to be downgraded to the {workspace.planDowngradeRequest} tier
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 37c0959 and d283184.

📒 Files selected for processing (3)
  • apps/dashboard/app/(app)/desktop-sidebar.tsx (1 hunks)
  • apps/dashboard/app/(app)/mobile-sidebar.tsx (1 hunks)
  • apps/dashboard/app/(app)/team-switcher.tsx (3 hunks)
🔇 Additional comments (4)
apps/dashboard/app/(app)/team-switcher.tsx (2)

25-29: LGTM: Clean Props type definition

The Props type is well-defined and properly scoped to only include the required workspace name field.


71-71: Verify workspace name usage consistency

The workspace name is now consistently used across all display locations. However, let's verify there are no other instances of workspace name usage that might have been missed.

Also applies to: 79-79, 88-88, 92-92

✅ Verification successful

Workspace name usage is consistent across the codebase

The verification shows that workspace name is consistently used as props.workspace.name in team-switcher.tsx and workspace.name in the update form component. The only instance of currentOrg.name is in a different context (Vercel callback) where it's used appropriately as a fallback for the profile picture alt text. No inconsistencies were found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining instances of currentOrg.name or similar patterns
rg -A 2 "currentOrg\.(name|imageUrl)" apps/dashboard/

Length of output: 679


Script:

#!/bin/bash
# Let's check for all workspace name usages to ensure consistency
rg -A 2 "workspace\.name" apps/dashboard/

Length of output: 1682

apps/dashboard/app/(app)/desktop-sidebar.tsx (1)

57-57: LGTM: Proper workspace prop passing

The workspace prop is correctly passed to the WorkspaceSwitcher component.

apps/dashboard/app/(app)/mobile-sidebar.tsx (1)

38-38: LGTM: Proper workspace prop passing

The workspace prop is correctly passed to the WorkspaceSwitcher component, maintaining consistency with the DesktopSidebar implementation.

name: string;
};
};
export const WorkspaceSwitcher: React.FC<Props> = (props): JSX.Element => {
Copy link
Contributor

Choose a reason for hiding this comment

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

export const WorkspaceSwitcher: React.FC<Props> = (props): JSX.Element =>

It's a nitpick but maybe just this 👇🏻 ?
export const WorkspaceSwitcher = (props: Props) =>

@chronark chronark merged commit 5a307de into main Dec 7, 2024
28 checks passed
@chronark chronark deleted the workspace-name branch December 7, 2024 18:18
@coderabbitai coderabbitai bot mentioned this pull request Dec 11, 2024
@coderabbitai coderabbitai bot mentioned this pull request Jan 10, 2025
18 tasks
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.

2 participants