Skip to content

fix: rootkey name fails on update#3030

Merged
chronark merged 1 commit intomainfrom
name-change-on-rootkey-fails
Mar 25, 2025
Merged

fix: rootkey name fails on update#3030
chronark merged 1 commit intomainfrom
name-change-on-rootkey-fails

Conversation

@MichaelUnkey
Copy link
Collaborator

@MichaelUnkey MichaelUnkey commented Mar 25, 2025

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

  • Bug Fixes
    • Enhanced the workspace key update process to ensure correct and consistent behavior when associating keys with the appropriate workspace.

@changeset-bot
Copy link

changeset-bot bot commented Mar 25, 2025

⚠️ No Changeset found

Latest commit: e26ec85

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 Mar 25, 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 Mar 25, 2025 8:17pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 25, 2025 8:17pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 25, 2025 8:17pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 25, 2025 8:17pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 25, 2025

📝 Walkthrough

Walkthrough

This change updates the query condition in the updateRootKeyName function. The query now uses table.forWorkspaceId instead of the previous table.workspaceId field to compare against the context's workspace ID. No changes were made to error handling, transaction logic, or the exported entities.

Changes

File(s) Summary
apps/dashboard/.../updateRootKeyName.ts Updated the query condition from table.workspaceId to table.forWorkspaceId for proper workspace ID matching in the update function.

Possibly related PRs

Suggested labels

Bug, Good first issue

Suggested reviewers

  • mcstepp
  • perkinsjr
  • chronark
  • ogzhanolguncu

📜 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 a2340bf and e26ec85.

📒 Files selected for processing (1)
  • apps/dashboard/lib/trpc/routers/key/updateRootKeyName.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: Test Go API Local / Test (Shard 4/8)
  • GitHub Check: Test Go API Local / Test (Shard 6/8)
  • GitHub Check: Test Go API Local / Test (Shard 3/8)
  • GitHub Check: Test Go API Local / Test (Shard 7/8)
  • GitHub Check: Test Go API Local / Test (Shard 8/8)
  • GitHub Check: Test Go API Local / Test (Shard 5/8)
  • GitHub Check: Test Packages / Test ./packages/rbac
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Test Go API Local / Test (Shard 2/8)
  • GitHub Check: Test Go API Local / Test (Shard 1/8)
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Build / Build
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
apps/dashboard/lib/trpc/routers/key/updateRootKeyName.ts (1)

18-18:

Details

✅ Verification successful

Fixed schema field reference for workspace validation.

This change addresses the issue where root key name updates were failing. By changing from workspaceId to forWorkspaceId, the query now correctly identifies keys that belong to the current workspace, allowing the update operation to proceed as expected.


🏁 Script executed:

#!/bin/bash
# Verify consistency with other workspace ID references in the codebase
# This helps confirm we're using the correct field name across related queries

echo "Checking for other occurrences of keys table with workspace references:"
rg "forWorkspaceId|workspaceId" --type ts -A 2 -B 2 "query.keys"

Length of output: 268


I'll run another script to search the whole repository for occurrences of both table.forWorkspaceId and table.workspaceId to verify consistency across related queries. This should help confirm that the change to forWorkspaceId is correct and consistently applied.


🏁 Script executed:

#!/bin/bash
echo "Searching for occurrences of 'table.forWorkspaceId'..."
rg "table\.forWorkspaceId" -t ts

echo "Searching for occurrences of 'table.workspaceId'..."
rg "table\.workspaceId" -t ts

Length of output: 14113


Verified: Workspace Field Update Consistency Confirmed

The change from workspaceId to forWorkspaceId in apps/dashboard/lib/trpc/routers/key/updateRootKeyName.ts has been verified. Searches across the repository confirm that:

  • The keys table and its related queries correctly use table.forWorkspaceId (e.g., in update and delete operations).
  • Other parts of the codebase still intentionally use table.workspaceId where applicable.

This confirms that the update correctly targets only the keys operations, ensuring that the root key name updates use the intended workspace validation field.

✨ 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 Mar 25, 2025

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

@chronark chronark added this pull request to the merge queue Mar 25, 2025
Merged via the queue into main with commit adc5475 Mar 25, 2025
37 of 38 checks passed
@chronark chronark deleted the name-change-on-rootkey-fails branch March 25, 2025 20:27
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