fix: insert valid verifications correctly

[chronark]

Summary by CodeRabbit

• New Features

  • Enhanced error logging capabilities in the key verification process.

• Bug Fixes

  • Improved error handling for analytics insertion failures.

• Documentation

  • Clarified descriptions for ratelimit and ratelimits fields in the request body schema.

• Refactor

  • Updated response structure to ensure consistency for valid key responses.

[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	Dec 10, 2024 2:38pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 2:38pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 2:38pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 2:38pm

[changeset-bot]

⚠️ No Changeset found

Latest commit: d155ddb

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]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the ValidResponse type in the service.ts file, making the code property required with the value "VALID". This change is reflected in the _verifyKey method, which now returns this required code upon successful key verification. Additionally, the v1_keys_verifyKey.ts file has been updated to include a logger service for improved error logging, alongside enhancements to error handling and descriptions in the request body schema.

Changes

File Path	Change Summary
apps/api/src/pkg/keys/service.ts	Updated ValidResponse type: code?: never → code: "VALID". Modified _verifyKey method to return code: "VALID" for valid responses.
apps/api/src/routes/v1_keys_verifyKey.ts	Added logger to destructured services in registerV1KeysVerifyKey. Enhanced error handling for analytics.insertKeyVerification. Clarified ratelimit and ratelimits descriptions. Streamlined handling of val.code.

Possibly related PRs

• chore: more logging and retries #2475: This PR modifies the verifyKey and _verifyKey methods in the KeyService class, which are directly related to the changes made in the main PR regarding the _verifyKey method's return structure and type definition for ValidResponse.

Suggested labels

🕹️ oss.gg, :joystick: 50 points

Suggested reviewers

• mcstepp
• perkinsjr
• MichaelUnkey

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fbfdf48 and d155ddb.

📒 Files selected for processing (2)

• apps/api/src/pkg/keys/service.ts (2 hunks)
• apps/api/src/routes/v1_keys_verifyKey.ts (2 hunks)

---

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 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]

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

[chronark]

ah rip, I accidentally merged using gh cli