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

Replace breadcrumbs #2749

Closed
wants to merge 11 commits into from
Closed

Replace breadcrumbs #2749

wants to merge 11 commits into from

Conversation

ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Dec 13, 2024

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

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?

  • Test A
  • Test B

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
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Introduced a navigation constant for APIs and settings, enhancing navigation structure.
    • Added new components like Navbar, PageContent, and various icons to improve UI layout and user interaction.
    • Implemented breadcrumb navigation across multiple pages for better user orientation.
  • Bug Fixes

    • Enhanced loading states and error handling for various components, ensuring smoother user experience.
  • Refactor

    • Restructured multiple components to adopt a more modular design, improving readability and maintainability.
  • Documentation

    • Updated comments and type definitions for clarity, particularly around navigation and component props.
  • Chores

    • Removed redundant components and imports to streamline the codebase.

Copy link

changeset-bot bot commented Dec 13, 2024

⚠️ No Changeset found

Latest commit: 81c5893

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

vercel bot commented Dec 13, 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 13, 2024 8:45pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 8:45pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 8:45pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 8:45pm

Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request involves the deletion of multiple React components across the dashboard application, primarily focusing on breadcrumb navigation for various API and settings pages. The deleted components included asynchronous functions for data fetching and rendering breadcrumb structures that facilitated user navigation. Additionally, new constants and components were introduced to enhance navigation capabilities, including a new navigation constant for API and authorization sections. The changes streamline the user interface and improve the organization of the navigation elements within the application.

Changes

File Path Change Summary
apps/dashboard/app/(app)/@breadcrumb/apis/[apiId]/keys/[keyAuthId]/[keyId]/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/apis/[apiId]/keys/[keyAuthId]/settings/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/apis/[apiId]/keys/[keyAuthId]/new/page.tsx Removed CreateKeyPage and associated functions.
apps/dashboard/app/(app)/@breadcrumb/apis/[apiId]/keys/[keyAuthId]/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/apis/[apiId]/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/apis/[apiId]/settings/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/audit/[...path]/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/audit/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/authorization/permissions/[permissionId]/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/authorization/permissions/page.tsx Removed PageBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/authorization/roles/[roleId]/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/authorization/roles/page.tsx Removed PageBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/debug/[...path]/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/debug/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/logs/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/monitors/[...path]/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/monitors/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/overview/[...path]/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/overview/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/ratelimits/[namespaceId]/logs/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/ratelimits/[namespaceId]/overrides/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/ratelimits/[namespaceId]/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/ratelimits/[namespaceId]/settings/page.tsx Removed PageBreadcrumb, AsyncPageBreadcrumb, and PageProps type.
apps/dashboard/app/(app)/@breadcrumb/ratelimits/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/secrets/[...path]/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/secrets/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/settings/[...path]/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/settings/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/@breadcrumb/success/page.tsx Removed NoBreadcrumb component.
apps/dashboard/app/(app)/apis/[apiId]/constants.ts Added new constant navigation for API navigation.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/page.tsx Updated APIKeyDetailPage with new components and layout changes.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/page.tsx Updated SettingsPage with new components and layout changes.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/page.tsx Updated CreateKeyPage with new components and layout changes.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/page.tsx Updated APIKeysPage with new components and layout changes.
apps/dashboard/app/(app)/apis/[apiId]/layout.tsx Simplified layout by removing navigation elements.
apps/dashboard/app/(app)/apis/[apiId]/loading.tsx Updated Loading component structure.
apps/dashboard/app/(app)/apis/[apiId]/page.tsx Updated ApiPage component structure and layout.
apps/dashboard/app/(app)/apis/[apiId]/settings/page.tsx Updated SettingsPage with new components and layout changes.
apps/dashboard/app/(app)/apis/client.tsx Streamlined component logic by removing redundancy.
apps/dashboard/app/(app)/apis/loading.tsx Updated Loading component structure.
apps/dashboard/app/(app)/apis/page.tsx Updated ApisOverviewPage structure and layout.
apps/dashboard/app/(app)/audit/[bucket]/page.tsx Updated AuditPage component structure.
apps/dashboard/app/(app)/authorization/constants.ts Added new constant navigation for authorization navigation.
apps/dashboard/app/(app)/authorization/layout.tsx Simplified layout by removing navigation elements.
apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx Updated RolesPage component structure and layout.
apps/dashboard/app/(app)/authorization/permissions/page.tsx Updated RolesPage component structure and layout.
apps/dashboard/app/(app)/authorization/roles/[roleId]/page.tsx Updated RolesPage component structure and layout.
apps/dashboard/app/(app)/authorization/roles/page.tsx Updated RolesPage component structure and layout.
apps/dashboard/app/(app)/layout.tsx Modified layout structure for the dashboard.
apps/dashboard/app/(app)/logs/logs-page.tsx Updated LogsPage component structure and layout.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/constants.ts Added new constant navigation for rate limits navigation.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/layout.tsx Simplified layout by removing navigation elements.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx Updated LogsPage component structure and layout.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/overrides/[overrideId]/page.tsx Updated OverrideSettings component structure and layout.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/overrides/page.tsx Updated OverridePage component structure and layout.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/page.tsx Updated RatelimitNamespacePage component structure and layout.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/settings/page.tsx Updated SettingsPage component structure and layout.
apps/dashboard/app/(app)/ratelimits/loading.tsx Updated Loading component structure.
apps/dashboard/app/(app)/ratelimits/page.tsx Updated RatelimitOverviewPage component structure and layout.
apps/dashboard/app/(app)/settings/constants.ts Added new constant navigation for settings navigation.
apps/dashboard/app/(app)/settings/general/page.tsx Updated SettingsPage component structure and layout.
apps/dashboard/app/(app)/settings/layout.tsx Removed SettingsLayout component and associated constants.
apps/dashboard/app/(app)/settings/loading.tsx Updated Loading component structure.
apps/dashboard/app/(app)/settings/root-keys/[keyId]/history/loading.tsx Removed Loading component.
apps/dashboard/app/(app)/settings/root-keys/[keyId]/history/page.tsx Removed HistoryPage component.
apps/dashboard/app/(app)/settings/root-keys/[keyId]/page.tsx Updated RootKeyPage component structure and layout.
apps/dashboard/app/(app)/settings/root-keys/[keyId]/permissions/loading.tsx Removed Loading component.
apps/dashboard/app/(app)/settings/root-keys/new/page.tsx Updated SettingsKeysPage component structure and layout.
apps/dashboard/app/(app)/settings/root-keys/page.tsx Updated SettingsKeysPage component structure and layout.
apps/dashboard/app/(app)/settings/team/page.tsx Updated TeamPage component structure and layout.
apps/dashboard/components/dashboard/navbar.tsx Updated Navbar component to include new properties for active state.
apps/dashboard/components/dashboard/page-header.tsx Added className prop to PageHeader for additional styling.
apps/dashboard/components/dashboard/root-key-table/index.tsx Updated RootKeyTable component for improved dropdown functionality.
apps/dashboard/components/navbar.tsx Updated LinkProps type for clarity.
apps/dashboard/components/page-content.tsx Modified PageContent component to change outer div class.
apps/dashboard/components/ui/metric.tsx Added className prop to Metric for additional styling.
internal/icons/src/icons/gauge.tsx Added new Gauge icon component.
internal/icons/src/icons/gear.tsx Added new Gear icon component.
internal/icons/src/icons/input-search.tsx Added new InputSearch icon component.
internal/icons/src/icons/shield-key.tsx Added new ShieldKey icon component.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant Navigation

    User->>Navigation: Navigate to API Key Page
    Navigation->>API: Fetch API Key Data
    API-->>Navigation: Return API Key Data
    Navigation-->>User: Render API Key Page with Breadcrumbs
Loading

Possibly related PRs

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
🪧 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. (Experiment)
  • @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 13, 2024

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.
Here is an example:

<type>[optional scope]: <description>
fix: I fixed something for Unkey

Details:

No release type found in pull request title "Replace breadcrumbs". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

Copy link

pullflow-com bot commented Dec 13, 2024

From Oz ‣ disregard that I forgot to open it as draft

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