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(hooks): prefer to use global fetch when available #1826

Merged
merged 2 commits into from
Nov 3, 2024
Merged

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Nov 2, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Nov 2, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request includes updates to multiple files across different packages. The build.gradle.kts file for the JetBrains plugin has its version number incremented from 2.7.4 to 2.7.5. In the index.ts file of the SWR plugin, the fetcher function's parameter has been renamed to customFetch, enhancing flexibility in fetch handling. Additionally, error handling and logging have been improved. Similar changes are reflected in the common.ts file of the TanStack Query package, where the fetch function parameter is also renamed to customFetch, with enhanced logging for optimistic updates.

Changes

File Path Change Summary
packages/ide/jetbrains/build.gradle.kts Version updated from 2.7.4 to 2.7.5.
packages/plugins/swr/src/runtime/index.ts Updated fetcher function parameter from fetch to customFetch; improved error handling and logging; modified optimisticUpdate function for better logging.
packages/plugins/tanstack-query/src/runtime/common.ts Updated fetcher function parameter from fetch to customFetch; enhanced comments and logging for error handling and optimistic updates.

Possibly related PRs

  • chore: bump version #1459: This PR involves a version bump in the same build.gradle.kts file for the JetBrains IDE plugin, updating the version from 2.1.1 to 2.1.2.
  • chore: bump version #1481: Similar to the main PR, this PR updates the version number in the build.gradle.kts file for the JetBrains IDE plugin, changing it from 2.1.2 to 2.2.0.
  • chore: bump version #1729: This PR also updates the version in the build.gradle.kts file for the JetBrains plugin, changing it from 2.5.2 to 2.6.0.
  • merge dev to main (v2.6.2) #1752: This PR reflects a version update in the build.gradle.kts file for the JetBrains plugin, changing the version from 2.6.1 to 2.6.2.
  • chore: bump version #1778: This PR updates the version in the build.gradle.kts file for the JetBrains plugin, changing it from 2.6.2 to 2.7.0.
  • chore: bump version #1788: This PR updates the version in the build.gradle.kts file for the JetBrains plugin, changing it from 2.7.0 to 2.7.1.
  • chore: bump version #1792: This PR updates the version in the build.gradle.kts file for the JetBrains plugin, changing it from 2.7.1 to 2.7.2.
  • merge dev to main (v2.7.2) #1793: This PR updates the version in the build.gradle.kts file for the JetBrains plugin, changing it from 2.7.1 to 2.7.2.
  • merge dev to main (v2.7.3) #1800: This PR updates the version in the build.gradle.kts file for the JetBrains plugin, changing it from 2.7.2 to 2.7.3.
  • chore: bump version #1807: This PR updates the version in the build.gradle.kts file for the JetBrains plugin, changing it from 2.7.3 to 2.7.4.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3ed1614 and 55c6fd6.

📒 Files selected for processing (2)
  • packages/plugins/swr/src/runtime/index.ts (1 hunks)
  • packages/plugins/tanstack-query/src/runtime/common.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/plugins/tanstack-query/src/runtime/common.ts
🔇 Additional comments (2)
packages/plugins/swr/src/runtime/index.ts (2)

378-381: LGTM! Parameter rename and fetch prioritization

The rename to customFetch and the prioritization of global fetch when available is a good improvement that enhances compatibility with different environments.


381-389: ⚠️ Potential issue

Add error handling for cross-fetch import

While the comment about Cloudflare Workers compatibility is helpful, the cross-fetch import still needs proper error handling to prevent runtime issues if the module is not available.

Apply this diff to add error handling:

 const _fetch =
     customFetch ??
     // check if fetch is available globally
     (typeof fetch === 'function'
         ? fetch
         : // fallback to 'cross-fetch' if otherwise
-          (await import('cross-fetch')).default);
+          await import('cross-fetch')
+              .then((module) => module.default)
+              .catch((error) => {
+                  console.error('Failed to import cross-fetch:', error);
+                  throw new Error('No fetch implementation available. Please provide a custom fetch function.');
+              }));

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.

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

🧹 Outside diff range and nitpick comments (2)
packages/plugins/tanstack-query/src/runtime/common.ts (1)

138-146: LGTM! Consider enhancing error handling for dynamic import.

The implementation correctly prioritizes fetch sources and includes helpful compatibility notes. The logic is clean and well-structured.

Consider wrapping the dynamic import in a try-catch to handle potential module loading failures:

 const _fetch =
     customFetch ??
     // check if fetch is available globally
     (typeof fetch === 'function'
         ? fetch
         : // fallback to 'cross-fetch' if otherwise
-          (await import('cross-fetch')).fetch);
+          // Safely handle dynamic import failures
+          await import('cross-fetch').catch(err => {
+              console.error('Failed to load cross-fetch:', err);
+              throw new Error('No fetch implementation available');
+          }).then(mod => mod.fetch));
packages/plugins/swr/src/runtime/index.ts (1)

378-390: Optimize performance by caching the imported 'cross-fetch' module

The dynamic import of 'cross-fetch' within the fetcher function may introduce performance overhead if invoked multiple times. Consider caching the imported module to avoid repeated dynamic imports.

Apply this diff to cache the imported module:

+let cachedCrossFetch: FetchFn | null = null;

 export async function fetcher<R, C extends boolean>(
     url: string,
     options?: RequestInit,
     customFetch?: FetchFn,
     checkReadBack?: C
 ): Promise<C extends true ? R | undefined : R> {
     const _fetch =
         customFetch ??
         // check if fetch is available globally
         (typeof fetch === 'function'
             ? fetch
             : // fallback to 'cross-fetch' if otherwise
-            await import('cross-fetch')
-                .then((module) => module.default)
-                .catch((error) => {
-                    console.error('Failed to import cross-fetch:', error);
-                    throw new Error('No fetch implementation available. Please provide a custom fetch function.');
-                }));
+            cachedCrossFetch ??
+            (cachedCrossFetch = await import('cross-fetch')
+                .then((module) => module.default)
+                .catch((error) => {
+                    console.error('Failed to import cross-fetch:', error);
+                    throw new Error('No fetch implementation available. Please provide a custom fetch function.');
+                })));

     const res = await _fetch(url, options);
     // ... rest of the function ...
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between df9b0ff and 3ed1614.

⛔ Files ignored due to path filters (13)
  • package.json is excluded by !**/*.json
  • packages/ide/jetbrains/package.json is excluded by !**/*.json
  • packages/language/package.json is excluded by !**/*.json
  • packages/misc/redwood/package.json is excluded by !**/*.json
  • packages/plugins/openapi/package.json is excluded by !**/*.json
  • packages/plugins/swr/package.json is excluded by !**/*.json
  • packages/plugins/tanstack-query/package.json is excluded by !**/*.json
  • packages/plugins/trpc/package.json is excluded by !**/*.json
  • packages/runtime/package.json is excluded by !**/*.json
  • packages/schema/package.json is excluded by !**/*.json
  • packages/sdk/package.json is excluded by !**/*.json
  • packages/server/package.json is excluded by !**/*.json
  • packages/testtools/package.json is excluded by !**/*.json
📒 Files selected for processing (3)
  • packages/ide/jetbrains/build.gradle.kts (1 hunks)
  • packages/plugins/swr/src/runtime/index.ts (1 hunks)
  • packages/plugins/tanstack-query/src/runtime/common.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/ide/jetbrains/build.gradle.kts
🔇 Additional comments (1)
packages/plugins/tanstack-query/src/runtime/common.ts (1)

135-135: LGTM! Note: Breaking change in parameter name.

Good rename from fetch to customFetch to avoid shadowing the global fetch. However, this is a breaking change that should be noted in the changelog.

Let's verify the impact of this breaking change:

packages/plugins/swr/src/runtime/index.ts Outdated Show resolved Hide resolved
@ymc9 ymc9 merged commit 9eb241f into main Nov 3, 2024
16 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