Skip to content

feat(standard-server): support React Native by explicitly checking body#445

Merged
dinwwwh merged 1 commit intomainfrom
feat/standard-server/support-native
Apr 22, 2025
Merged

feat(standard-server): support React Native by explicitly checking body#445
dinwwwh merged 1 commit intomainfrom
feat/standard-server/support-native

Conversation

@dinwwwh
Copy link
Copy Markdown
Member

@dinwwwh dinwwwh commented Apr 22, 2025

By explicitly check for null to indicate an intentionally empty body instead of relying on a truthy body check.

Summary by CodeRabbit

  • New Features

    • Added documentation for integrating oRPC with React Native, including usage examples and notes on supported features.
    • Updated the sidebar to include React Native in the list of integrations.
  • Bug Fixes

    • Improved handling of empty request bodies to better support native environments like React Native.

…r null body

By explicitly check for `null` to indicate an intentionally empty body instead of relying on a truthy body check.
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orpc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 3:18am

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2025

Walkthrough

A new documentation page was added to describe integrating oRPC with React Native, and the Vitepress configuration was updated to include this integration in the sidebar. The documentation outlines usage instructions, limitations, and provides a TypeScript example. Additionally, the toStandardBody function in the server-fetch package was updated to explicitly check for null bodies, clarifying behavior in environments like React Native where the body may be undefined.

Changes

File(s) Change Summary
apps/content/.vitepress/config.ts Added "React Native" to the Integrations section of the Vitepress sidebar, linking to the new documentation page.
apps/content/docs/integrations/react-native.md Introduced a new documentation page explaining oRPC integration with React Native, including usage, limitations, and a TypeScript example.
packages/standard-server-fetch/src/body.ts Refined the empty body check in toStandardBody to distinguish between null (intentional empty body) and undefined (e.g., lack of streaming support), with an explanatory comment added.

Poem

In docs, a new path for React Native appears,
With guidance for links and some caveats clear.
The server-fetch body now checks with more care,
For null and undefined—no confusion to bear.
With each little hop, our code grows more bright,
As rabbits and devs make integrations just right! 🐇✨


📜 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 4c2a250 and dea4cb6.

📒 Files selected for processing (3)
  • apps/content/.vitepress/config.ts (1 hunks)
  • apps/content/docs/integrations/react-native.md (1 hunks)
  • packages/standard-server-fetch/src/body.ts (1 hunks)
🔇 Additional comments (7)
packages/standard-server-fetch/src/body.ts (2)

8-12: Good explanation in the comments about the behavior change.

The comment clearly explains why this change is necessary for React Native support, helping future maintainers understand the reasoning behind the explicit null check.


12-14: Improved cross-platform compatibility with explicit null check.

Changing from a falsy check to an explicit null check correctly distinguishes between intentionally empty bodies (null) and bodies that are undefined due to React Native's lack of streaming support.

This change precisely addresses the PR objective to "support React Native by explicitly checking body" while maintaining backward compatibility with existing implementations.

apps/content/.vitepress/config.ts (1)

104-104: Correctly integrated React Native documentation in sidebar.

The React Native integration is appropriately added to the Integrations section of the sidebar, making it discoverable for users.

apps/content/docs/integrations/react-native.md (4)

1-7: Well-structured documentation with clear metadata.

The title and description are concise and effectively communicate the purpose of this integration page.


14-16: Important limitations clearly highlighted.

The warning callout appropriately highlights the limitations of React Native's Fetch API with respect to oRPC features, and provides a reference to the GitHub issue for future updates.


18-28: Clear and practical code example for implementation.

The TypeScript example demonstrates how to create an RPCLink with a URL and dynamic headers based on context, providing a good starting point for users.

I appreciate the commented fetch option which hints at potential polyfill use without overcomplicating the example.


30-32: Helpful information about link flexibility.

The info callout about link compatibility provides valuable context for users who might need to use different types of links.

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

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 22, 2025

More templates

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@445

@orpc/client

npm i https://pkg.pr.new/@orpc/client@445

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@445

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@445

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@445

@orpc/react

npm i https://pkg.pr.new/@orpc/react@445

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@445

@orpc/server

npm i https://pkg.pr.new/@orpc/server@445

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@445

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@445

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@445

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@445

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@445

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@445

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@445

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@445

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@445

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@445

commit: dea4cb6

@dinwwwh dinwwwh merged commit 4163101 into main Apr 22, 2025
8 checks passed
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