feat: mobile-sidbar-sync-with-desktop

[AkshayBandi027]

What does this PR do?

Fixes #2171

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

• Go to dashboard
• open menu to see changes.

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• [] Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR

unkey-sidebar.mp4

Summary by CodeRabbit

• New Features
  • Enhanced sidebar navigation with dynamic workspace-based links.
  • Introduced a Feedback component in the mobile sidebar.
  • Added a new template for "Protecting Digital Content Access" in the templates collection.
• Improvements
  • Streamlined navigation setup for better maintainability.
  • Updated MobileSideBar to utilize workspace data for rendering links.
  • Enhanced audit log data retrieval and presentation logic.
• Bug Fixes
  • Removed unused components to clean up the codebase.
  • Improved rendering logic for handling empty states in audit logs.

[changeset-bot]

⚠️ No Changeset found

Latest commit: e71a256

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

[vercel]

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	Oct 5, 2024 10:36am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2024 10:36am
planetfall	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2024 10:36am
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2024 10:36am
unkey-engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2024 10:36am
workflows	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2024 10:36am
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2024 10:36am

[vercel]

@AkshayBandi027 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Warning

Rate limit exceeded

@AkshayBandi027 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 42 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 31165df and e71a256.

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request introduces significant modifications to the sidebar navigation components within the dashboard application. Key changes include the restructuring of the desktop-sidebar.tsx to utilize dynamic navigation generation through the createWorkspaceNavigation function, replacing hardcoded items. The MobileSideBar component is updated to accept a workspace prop, enhancing its functionality. Additionally, a new constants file, workspace-navigations.tsx, is created to manage navigation items and their properties. Unused components, such as DiscordIcon and Tag, have been removed to streamline the codebase.

Changes

File Path	Change Summary
apps/dashboard/app/(app)/desktop-sidebar.tsx	Removed unused components; redefined navigation using createWorkspaceNavigation and updated imports.
apps/dashboard/app/(app)/layout.tsx	Added workspace prop to MobileSideBar component.
apps/dashboard/app/(app)/mobile-sidebar.tsx	Updated to use workspace prop; replaced hardcoded links with dynamic navigation mapping.
apps/dashboard/lib/constants/workspace-navigations.tsx	Introduced constants and functions for workspace navigation; defined NavItem type and created createWorkspaceNavigation function.

Assessment against linked issues

Objective	Addressed	Explanation
Feedback / Discord buttons are not available on mobile nav (#2171)	✅

Possibly related PRs

• feat: Added support to sidebar #2119: Involves the addition of the DiscordIcon component, which is relevant to the navigation changes in desktop-sidebar.tsx.
• refactor: query audit logs from planetscale #2181: Refactors the AuditPage component related to audit logs, which may connect to the navigation updates.
• fix: revalidate /apis after creating new API #2183: Changes in CreateApiButton include a revalidation step, potentially improving user experience in the dashboard.
• chore: Unkey PDF Viewer template [SIDE QUEST] #2191: Introduction of a new template for protecting digital content, related to improvements in overall dashboard functionality.

Suggested labels

🕹️ 750 points, Good first issue

Suggested reviewers

• mcstepp
• chronark
• 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

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

[coderabbitai]

Actionable comments posted: 6

🧹 Outside diff range and nitpick comments (2)

apps/dashboard/app/(app)/layout.tsx (1)

35-35: Consider adding a comment for clarity.

To improve code readability and maintain context for future developers, consider adding a brief comment explaining the purpose of passing the workspace prop to MobileSideBar. This can help clarify the intent behind this change, especially in relation to the new Feedback and Discord buttons.

Here's a suggested comment you could add above the MobileSideBar component:

+      {/* Passing workspace to MobileSideBar to enable Feedback and Discord buttons */}
       <MobileSideBar className="lg:hidden" workspace={workspace} />

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

64-64: Include rel="noopener noreferrer" when using target="_blank.

When using target="_blank" in links, it's recommended to include rel="noopener noreferrer" for security reasons. This prevents the new page from accessing the window.opener property, mitigating security risks like tab-nabbing.

Apply this diff:

<Link href={`${item.href}`} target="_blank" key={item.label}>
+  rel="noopener noreferrer"

🧰 Tools

🪛 Biome

[error] 64-64: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e7ac47f and dd7ca0e.

📒 Files selected for processing (4)

• apps/dashboard/app/(app)/desktop-sidebar.tsx (2 hunks)
• apps/dashboard/app/(app)/layout.tsx (1 hunks)
• apps/dashboard/app/(app)/mobile-sidebar.tsx (2 hunks)
• apps/dashboard/lib/constants/workspace-navigations.tsx (1 hunks)

🧰 Additional context used

🪛 Biome

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

[error] 49-49: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

---

[error] 64-64: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

🔇 Additional comments (4)

apps/dashboard/app/(app)/layout.tsx (1)

35-35: LGTM! Verify MobileSideBar implementation for new buttons.

The addition of the workspace prop to the MobileSideBar component is consistent with the PR objectives and aligns with how the DesktopSidebar is implemented. This change should enable the addition of Feedback and Discord buttons to the mobile navigation.

To ensure the PR objectives are fully met, please verify the implementation of the MobileSideBar component:

apps/dashboard/lib/constants/workspace-navigations.tsx (1)

129-129: Verify the Discord URL for accuracy

Ensure that the Discord URL "https://www.unkey.com/discord" is correct and directs users to the intended destination. If the correct URL is "https://unkey.dev/discord" or another address, please update it accordingly.

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

5-8: Imports navigation constants to centralize definitions

Great job importing createWorkspaceNavigation and resourcesNavigation from @/lib/constants/workspace-navigations. This promotes maintainability by centralizing navigation definitions and reduces redundancy.

---

47-47: Dynamically generates workspace navigation

Using createWorkspaceNavigation(workspace, segments) to generate workspaceNavigation enhances flexibility and keeps the navigation consistent with the workspace context and current segments.

[oss-gg]

Awarding AkshayBandi027: 300 points 🕹️ Well done! Check out your new contribution on oss.gg/AkshayBandi027