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

fix: structure error returned without nested errors #2629

Merged
merged 4 commits into from
Nov 1, 2024

Conversation

MichaelUnkey
Copy link
Collaborator

@MichaelUnkey MichaelUnkey commented Oct 31, 2024

What does this PR do?

Fixes # (issue)
#2387
eng-1447
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, Check to make sure error messages are not nested anymore { error: { error: {}} }
  • 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

Summary by CodeRabbit

  • New Features

    • Enhanced error reporting with a detailed error object structure, providing code, message, docs, and requestId for improved clarity.
  • Bug Fixes

    • Updated error handling logic for the fetch method to align with the new error structure, ensuring more comprehensive feedback during failures.

Copy link

changeset-bot bot commented Oct 31, 2024

⚠️ No Changeset found

Latest commit: ef19ec4

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 Oct 31, 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 Oct 31, 2024 5:29pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 5:29pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 5:29pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 5:29pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
workflows ⬜️ Ignored (Inspect) Visit Preview Oct 31, 2024 5:29pm

Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the Result<R> type definition in the client.ts file, enhancing the error reporting mechanism. The error property is transformed from a simple structure to a detailed object containing code, message, docs, and requestId. This change necessitates updates to the fetch<TResult> method's error handling logic, which now constructs a more informative error object based on the new structure. The overall control flow remains similar, but the error handling provides more comprehensive feedback for API users.

Changes

File Change Summary
packages/api/src/client.ts Updated Result<R> type definition to include detailed error object with specific fields. Modified fetch<TResult> method to construct and return the new error object format.

Possibly related PRs

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 21d6352 and 23cbea0.

📒 Files selected for processing (1)
  • packages/api/src/client.ts (2 hunks)
🔇 Additional comments (3)
packages/api/src/client.ts (3)

99-104: LGTM: Improved error type definition

The new error structure is more explicit and type-safe, properly defining all required fields. This change successfully addresses the nested error structure issue.


198-201: LGTM: Clean error handling implementation

The implementation correctly aligns with the new error structure and uses clean destructuring pattern.


198-201: Verify consistent error structure usage

Let's verify that there are no remaining nested error structures in the codebase.

✅ Verification successful

Based on the comprehensive search results, I can now provide a final response:

Error structure is consistently implemented across the codebase

The error handling follows a consistent pattern throughout the codebase:

  • All API errors use the standardized ErrorResponse type with code, message, docs, and requestId fields
  • No nested error structures were found (no error: { error: ... } patterns)
  • Error responses are properly typed and validated using Zod schemas
  • Error handling is centralized through the openApiErrorResponses and errorSchemaFactory utilities
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential nested error structures
ast-grep --pattern 'error: { error: $_ }'

# Search for direct error assignments that might not follow the new structure
rg 'error:\s*{(?![^}]*code:)' -g '*.ts'

Length of output: 202


Script:

#!/bin/bash
# Search for error object structures in TypeScript files
ast-grep --pattern 'error: { $$ }'

# Also search for error response type definitions
ast-grep --pattern 'type ErrorResponse = { $$ }'

# Search for error-related return statements
ast-grep --pattern 'return { error: $$ }'

Length of output: 131


Script:

#!/bin/bash
# Search for files containing error-related code with context
rg -A 2 -B 2 'error:' --type ts

# Search for ErrorResponse type usage
rg 'ErrorResponse' --type ts

# Look for error handling patterns
rg 'return.*error' --type ts

Length of output: 67227


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 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 Oct 31, 2024

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

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c531755 and 21d6352.

📒 Files selected for processing (1)
  • packages/api/src/client.ts (2 hunks)
🔇 Additional comments (1)
packages/api/src/client.ts (1)

99-104: LGTM: Improved error structure with explicit typing

The new error structure properly flattens the error object and explicitly types all required properties. This change aligns well with the PR objective to eliminate nested errors.

packages/api/src/client.ts Outdated Show resolved Hide resolved
simplify

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@MichaelUnkey MichaelUnkey added this pull request to the merge queue Nov 1, 2024
Merged via the queue into main with commit c09c526 Nov 1, 2024
25 of 27 checks passed
@MichaelUnkey MichaelUnkey deleted the api-response-error-msg-undefined branch November 1, 2024 15:25
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