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

@trigger.dev/react-hooks now works with React 19 #1559

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Dec 13, 2024

For full compat we will need to update swr to 2.2.6 when it's released: vercel/swr#3051

Summary by CodeRabbit

  • New Features

    • Updated the @trigger.dev/react-hooks package for compatibility with React 19.
    • Expanded exports to include specific paths for import and require scenarios.
  • Bug Fixes

    • Adjusted peer dependency versions for react and react-dom to ensure compatibility with newer versions.

Copy link

changeset-bot bot commented Dec 13, 2024

🦋 Changeset detected

Latest commit: d99d6a1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages
Name Type
@trigger.dev/react-hooks Patch
references-nextjs-realtime Patch
@trigger.dev/build Patch
@trigger.dev/core Patch
@trigger.dev/rsc Patch
@trigger.dev/sdk Patch
@trigger.dev/database Patch
@trigger.dev/otlp-importer Patch
trigger.dev Patch
@internal/redis-worker Patch
@internal/zod-worker Patch
@internal/testcontainers Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request introduces updates to the @trigger.dev/react-hooks package, ensuring compatibility with React version 19. Modifications include changes to the peerDependencies in the package.json file, which now specifies a caret range for React and React DOM versions. Additionally, the exports field has been expanded to clarify paths for both import and require scenarios, enhancing the package's usability across different module formats.

Changes

File Path Change Summary
.changeset/fuzzy-coins-cross.md Updated package compatibility for @trigger.dev/react-hooks to support React 19.
packages/react-hooks/package.json Modified peerDependencies for react and react-dom to use caret range format. Expanded exports field to include specific paths for import and require.

Poem

In the garden of code where the rabbits play,
React 19 hops in, brightening the day.
With hooks that now dance in perfect sync,
Our packages bloom, don’t you think?
So let’s celebrate with a joyful cheer,
For updates like these bring us all near! 🐇✨


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.

Copy link

pkg-pr-new bot commented Dec 13, 2024

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1559

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1559

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1559

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1559

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1559

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1559

commit: d99d6a1

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

🧹 Outside diff range and nitpick comments (1)
packages/react-hooks/package.json (1)

Line range hint 1-77: Package structure follows best practices

The package configuration is well structured with:

  • Proper dual package hazard handling via exports field
  • Clear type definitions for both ESM and CommonJS
  • Appropriate engine requirements

Consider adding "sideEffects": false to enable better tree-shaking in webpack and other bundlers, if this package is indeed side-effect free.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6b355ab and d99d6a1.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • .changeset/fuzzy-coins-cross.md (1 hunks)
  • packages/react-hooks/package.json (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/fuzzy-coins-cross.md
🔇 Additional comments (1)
packages/react-hooks/package.json (1)

54-55: LGTM! Peer dependencies correctly updated for React 19

The peer dependency version range ^18.0 || ^19.0 || ^19.0.0-rc is appropriate as it:

  • Maintains compatibility with React 18
  • Adds support for stable React 19
  • Explicitly supports RC versions of React 19

Let's verify this matches React's recommended peer dependency pattern:

✅ Verification successful

Peer dependency pattern for React 19 is correctly implemented

The verification confirms that:

  1. The peer dependency pattern ^18.0 || ^19.0 || ^19.0.0-rc is unique to the react-hooks package
  2. It follows a standard semver range format with the caret operator
  3. The explicit inclusion of RC versions is appropriate for early React 19 support
  4. The same pattern is consistently applied to both react and react-dom dependencies
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check other popular React packages for their peer dependency patterns
# This helps verify we're following community standards

# Search for react peer dependencies in the repository
rg -U "peerDependencies[^\}]+react[^\}]+" --type json

# Check some popular React packages from node_modules
fd -t f "package.json" -x sh -c 'echo "=== $1 ==="; cat "$1" | jq -r ".peerDependencies?.react // empty"' sh {} \;

Length of output: 2080

@ericallam ericallam merged commit 7077dbf into main Dec 13, 2024
9 checks passed
@ericallam ericallam deleted the react-hooks-19 branch December 13, 2024 13:31
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