Skip to content

fix: only display active keys#2727

Merged
chronark merged 1 commit intomainfrom
filter-deleted-keys
Dec 10, 2024
Merged

fix: only display active keys#2727
chronark merged 1 commit intomainfrom
filter-deleted-keys

Conversation

@chronark
Copy link
Collaborator

@chronark chronark commented Dec 9, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced identity key retrieval to exclude deleted keys, ensuring cleaner data display.
  • Bug Fixes

    • Maintained error handling for identity not found scenarios, ensuring consistent user experience.

@vercel
Copy link

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

@changeset-bot
Copy link

changeset-bot bot commented Dec 9, 2024

⚠️ No Changeset found

Latest commit: 82ff9a3

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request modify the query logic within the Page component of the identity management system. A new condition is added to filter out deleted identity keys by checking if the deletedAt field is null. This ensures that only active keys are retrieved while maintaining the existing rendering and error handling logic. The overall structure and control flow of the component remain unchanged, focusing solely on the inclusion of the new filtering condition.

Changes

File Change Summary
apps/dashboard/app/(app)/identities/[identityId]/page.tsx Modified the query in the Page component to include a filter for non-deleted keys by adding a where clause that checks if table.deletedAt is null. Updated method signature to reflect this change.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PageComponent
    participant Database

    User->>PageComponent: Request identity details
    PageComponent->>Database: Query for identity keys (filtering deleted keys)
    Database-->>PageComponent: Return non-deleted identity keys
    PageComponent-->>User: Display identity details and keys
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4f26420 and 82ff9a3.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/identities/[identityId]/page.tsx (1 hunks)
🔇 Additional comments (2)
apps/dashboard/app/(app)/identities/[identityId]/page.tsx (2)

39-39: LGTM! Good security improvement.

The added filter ensures that only active keys are displayed by excluding soft-deleted records. This is a security enhancement that prevents accidentally exposing deleted keys.


39-39: Verify consistent handling of deleted keys across the codebase.

Let's ensure this fix is applied consistently wherever identity keys are queried.

✅ Verification successful

The deletedAt filter is consistently applied across key queries in the codebase

Based on the search results, I can confirm that the deletedAt filter is properly implemented in all relevant key queries:

  • In v1_apis_listKeys.ts: isNull(table.deletedAt) is applied
  • In v1_identities_updateIdentity.ts: isNull(table.deletedAt) is used
  • In count_keys_per_keyspace.ts: isNull(schema.keys.deletedAt) is included
  • In legacy_apis_listKeys.ts: isNull(schema.keys.deletedAt) is present
  • In v1_apis_deleteKeys.ts: Keys are properly marked with deletedAt timestamp when deleted

The implementation in the file under review matches the pattern used consistently throughout the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other queries that might need the same deletedAt filter
# Look for patterns that query the keys table without checking deletedAt

# Search for key queries that might need the same protection
rg -l "keys.*where.*table" --type typescript

# Search specifically for identity key related queries
ast-grep --pattern 'keys: {
  $$$
}'

Length of output: 120


Script:

#!/bin/bash
# Search for queries involving keys table with different approaches
rg -l "keys.*where.*table"

# Look for Prisma query patterns involving the keys table
rg -A 5 "keys\s*:\s*{" 

# Search for deletedAt conditions in queries
rg -A 2 "deletedAt.*where"

# Look for table definitions or schemas involving keys
rg -A 5 "model\s+Key"

Length of output: 1024


Script:

#!/bin/bash
# Search for Prisma queries with fixed regex
rg -A 5 "keys:\s*\{"

# Look for key-related queries in the codebase
rg -A 5 "from\(.*keys\)"

# Search for schema definitions
fd "schema.(ts|prisma)" --exec cat {}

# Look for where conditions in key queries
rg -A 5 "keys.*select|select.*keys"

Length of output: 19962


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.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2024

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

@vercel vercel bot temporarily deployed to Preview – www December 9, 2024 18:56 Inactive
@vercel vercel bot temporarily deployed to Preview – engineering December 9, 2024 18:56 Inactive
@vercel vercel bot temporarily deployed to Preview – play December 9, 2024 18:57 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard December 9, 2024 19:01 Inactive
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