Skip to content

fix: sidebar revalidation#3243

Merged
chronark merged 1 commit intomainfrom
fix-sidebar-revalidation
May 12, 2025
Merged

fix: sidebar revalidation#3243
chronark merged 1 commit intomainfrom
fix-sidebar-revalidation

Conversation

@ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented May 12, 2025

What does this PR do?

Revalidates sidebar queries when changing workspacex

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

  • Bug Fixes
    • Improved data accuracy after switching workspaces by ensuring overview and rate limit information are refreshed automatically.

@changeset-bot
Copy link

changeset-bot bot commented May 12, 2025

⚠️ No Changeset found

Latest commit: 71f012f

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
Copy link

vercel bot commented May 12, 2025

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 May 12, 2025 6:23pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 12, 2025 6:23pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 12, 2025

📝 Walkthrough

Walkthrough

The update enhances the cache invalidation logic in the workspace switcher component. Now, in addition to invalidating the current user's organization data, it also invalidates the overview and rate limit namespace queries upon a successful workspace change, ensuring these caches are refreshed before the page reloads.

Changes

File(s) Change Summary
apps/dashboard/components/navigation/sidebar/team-switcher.tsx Added cache invalidation for overview and rate limit namespace queries in the workspace switch success callback.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI (team-switcher)
    participant changeWorkspace Mutation
    participant Cache (utils)
    participant Router

    User->>UI (team-switcher): Selects new workspace
    UI (team-switcher)->>changeWorkspace Mutation: Trigger mutation
    changeWorkspace Mutation-->>UI (team-switcher): onSuccess
    UI (team-switcher)->>Cache (utils): Invalidate user.getCurrentUser
    UI (team-switcher)->>Cache (utils): Invalidate api.overview.query
    UI (team-switcher)->>Cache (utils): Invalidate ratelimit.namespace.query
    UI (team-switcher)->>Router: Reload page
Loading

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@github-actions
Copy link
Contributor

github-actions bot commented May 12, 2025

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

@vercel vercel bot temporarily deployed to Preview – dashboard May 12, 2025 18:23 Inactive
@mcstepp mcstepp self-assigned this May 12, 2025
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

🧹 Nitpick comments (1)
apps/dashboard/components/navigation/sidebar/team-switcher.tsx (1)

65-67: Looks good, consider adding a more descriptive comment

The added cache invalidations correctly address the issue of ensuring sidebar data is refreshed when changing workspaces. Adding these invalidations before the page reload ensures the sidebar queries will have fresh data.

Consider updating the comment to be more comprehensive about why all these invalidations are needed:

- // refresh the check mark by invalidating the current user's org data
+ // Invalidate workspace-dependent queries to ensure fresh data after workspace switch
  utils.user.getCurrentUser.invalidate();
  utils.api.overview.query.invalidate();
  utils.ratelimit.namespace.query.invalidate();
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c824e5f and 71f012f.

📒 Files selected for processing (1)
  • apps/dashboard/components/navigation/sidebar/team-switcher.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • GitHub Check: Test Packages / Test ./apps/dashboard
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test Packages / Test ./internal/id
  • GitHub Check: Test Packages / Test ./packages/api
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test Packages / Test ./internal/keys
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)

Copy link
Collaborator

it crashes when I switch workspace
CleanShot 2025-05-12 at 20.29.13@2x.png

Copy link
Collaborator

@mcstepp mcstepp left a comment

Choose a reason for hiding this comment

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

Tested in vercel with multiple workspaces and APIs. Looks good

Copy link
Contributor Author

@chronark hmm locally I didn't have that lemme chekc preview again

Copy link
Contributor Author

works fine for me

Copy link
Collaborator

mcstepp commented May 12, 2025

It didn't crash for me, and I created multiple new workspaces and APIs

Copy link
Contributor Author

I need to check Vercel logs

Copy link
Collaborator

TypeError: Cannot read properties of null (reading ‘requestsPerMonth’)

Copy link
Collaborator

ah might be cause the Unkey workspace is special

Copy link
Contributor Author

offf billing

Copy link
Collaborator

it doesn’t have a quota

Copy link
Contributor Author

yeah

Copy link
Collaborator

in staging anyways

Copy link
Collaborator

:ship-it:

Copy link
Contributor Author

gotcha. I'll check this tomorrow 🫡

@chronark chronark added this pull request to the merge queue May 12, 2025
Copy link
Collaborator

mcstepp commented May 12, 2025

I noticed the DB mismatch on the slug-based API route in the logs... you're on api_xyz owned by org_1, switch to org_2, and api_xyz route throws the error. Doesn't seem to be a redirect off that page when you're not on the same workspace

Merged via the queue into main with commit 1cc0e60 May 12, 2025
32 checks passed
@chronark chronark deleted the fix-sidebar-revalidation branch May 12, 2025 18:37
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.

3 participants