Skip to content

fix(hooks): add null check to data before further deserialization #1822

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

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Oct 31, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the unmarshal function in two files: index.ts and common.ts. Both changes enhance type safety by adjusting the conditions that check the structure of the parsed object. The new conditions ensure that parsed is an object before accessing its properties, which helps prevent potential runtime errors. Additionally, minor formatting changes, such as whitespace adjustments, were made, but these do not impact the functionality of the code.

Changes

File Path Change Summary
packages/plugins/swr/src/runtime/index.ts Modified unmarshal function to check if parsed is an object before accessing parsed.data and parsed.meta?.serialization. Minor whitespace adjustments made.
packages/plugins/tanstack-query/src/runtime/common.ts Modified unmarshal function to ensure parsed is an object before accessing parsed.data and parsed.meta?.serialization. No other significant changes.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant SWR
    participant TanstackQuery

    Caller->>SWR: Call unmarshal
    SWR->>SWR: Check if parsed is an object
    alt parsed is an object
        SWR->>SWR: Access parsed.data and parsed.meta?.serialization
    else parsed is not an object
        SWR->>Caller: Return error or handle case
    end

    Caller->>TanstackQuery: Call unmarshal
    TanstackQuery->>TanstackQuery: Check if parsed is an object
    alt parsed is an object
        TanstackQuery->>TanstackQuery: Access parsed.data and parsed.meta?.serialization
    else parsed is not an object
        TanstackQuery->>Caller: Return error or handle case
    end
Loading

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

@ymc9 ymc9 marked this pull request as ready for review October 31, 2024 23:08
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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2bb8970 and 5c828c5.

📒 Files selected for processing (2)
  • packages/plugins/swr/src/runtime/index.ts (1 hunks)
  • packages/plugins/tanstack-query/src/runtime/common.ts (1 hunks)
🔇 Additional comments (1)
packages/plugins/swr/src/runtime/index.ts (1)

Line range hint 423-428: LGTM! Good improvement in type safety.

The change enhances the robustness of data deserialization by adding proper type checking before accessing object properties. This helps prevent potential runtime errors when handling API responses.

@ymc9 ymc9 merged commit 00ecb2a into dev Oct 31, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/unmarshal-null-check branch October 31, 2024 23:19
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.

1 participant