Skip to content

fix(graphql-request): use same version in all packages #1623

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

alexandre-abrioux
Copy link
Member

@alexandre-abrioux alexandre-abrioux commented May 15, 2025

Description of the changes

Use the same version of graphql-request in all packages.

This PR removes all Babel config used in Jest that is not needed anymore, and centralizes the exception to transform the graphql-request with ts-jest.

Summary by CodeRabbit

  • Bug Fixes

    • Improved detection of Ethereum providers in browser and non-browser environments for payment processing.
  • Chores

    • Updated the version of the graphql-request dependency.
    • Removed unnecessary Babel-related dependencies and configuration files from multiple packages.
    • Simplified Jest testing configurations for easier maintenance.

Copy link
Contributor

coderabbitai bot commented May 15, 2025

Walkthrough

The changes update Jest configuration to better handle mixed JavaScript and TypeScript files, specifically ensuring transformation of certain ES modules. Babel configurations and related dependencies are removed from multiple packages, simplifying the build and test setup. The graphql-request dependency is upgraded in relevant packages, and provider detection logic is updated to use globalThis.

Changes

File(s) Change Summary
jest.config.js Changed Jest preset to 'ts-jest/presets/js-with-ts', removed explicit testEnvironment, and adjusted transformIgnorePatterns to allow transformation of graphql-request and @superfluid-finance/sdk-core.
packages/integration-test/babel.config.js
packages/request-node/babel.config.js
Deleted Babel configuration files, removing explicit transpilation setup for these packages.
packages/integration-test/jest.config.js
packages/request-node/jest.config.js
Simplified Jest configs by removing custom transform, module mapping, and environment setup; now only extend the common Jest config.
packages/integration-test/package.json
packages/request-node/package.json
Removed Babel-related devDependencies and babel-jest; upgraded graphql-request from 6.1.0 to 7.1.2 in dependencies.
packages/payment-detection/package.json Upgraded graphql-request from 6.1.0 to 7.1.2; removed @babel/helper-get-function-arity from devDependencies.
packages/payment-processor/src/payment/utils.ts Changed provider detection from checking window.ethereum to globalThis.ethereum for broader environment compatibility.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant App
  participant globalThis
  participant ethers

  User->>App: Calls getProvider()
  App->>globalThis: Checks for ethereum
  alt ethereum exists
    App->>ethers: Create new Web3Provider(globalThis.ethereum)
    App-->>User: Returns provider
  else ethereum missing
    App-->>User: Throws error "Ethereum provider not found"
  end
Loading

Possibly related PRs

Suggested reviewers

  • aimensahnoun
  • kevindavee
  • leoslr

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 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 d999342 and 1d44d9c.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (9)
  • jest.config.js (1 hunks)
  • packages/integration-test/babel.config.js (0 hunks)
  • packages/integration-test/jest.config.js (0 hunks)
  • packages/integration-test/package.json (0 hunks)
  • packages/payment-detection/package.json (1 hunks)
  • packages/payment-processor/src/payment/utils.ts (1 hunks)
  • packages/request-node/babel.config.js (0 hunks)
  • packages/request-node/jest.config.js (0 hunks)
  • packages/request-node/package.json (1 hunks)
💤 Files with no reviewable changes (5)
  • packages/request-node/babel.config.js
  • packages/integration-test/package.json
  • packages/request-node/jest.config.js
  • packages/integration-test/jest.config.js
  • packages/integration-test/babel.config.js
🔇 Additional comments (4)
packages/payment-processor/src/payment/utils.ts (1)

31-32: Good improvement with the switch to globalThis

This update makes the code environment-agnostic by using globalThis instead of window, resolving the build error mentioned in the previous review. The approach correctly checks for the existence of ethereum before trying to use it, making the code more robust across different JavaScript environments.

packages/payment-detection/package.json (1)

50-50: The graphql-request version upgrade looks good.

The update to version 7.1.2 aligns with the PR objective to standardize this dependency's version across all packages.

packages/request-node/package.json (1)

63-63: The graphql-request version update is consistent with other packages.

The update to version 7.1.2 matches the version used in other packages, achieving the standardization goal. The removed Babel-related dependencies (not shown in the diff) also align with the PR objective to simplify the testing configuration.

jest.config.js (1)

3-4: The Jest configuration changes effectively support mixed JS/TS files and centralize package transformations.

The changes serve two important purposes:

  1. Switching to ts-jest/presets/js-with-ts preset provides better support for projects with mixed JavaScript and TypeScript files
  2. Adding transformIgnorePatterns that specifically excludes graphql-request from being ignored ensures this package gets properly transformed during tests, which is necessary for the upgraded version 7.1.2

This centralized configuration allows individual package Jest configurations to be simplified, supporting the PR's objective of removing unnecessary Babel configurations and centralizing the transformation rules.

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Comment on lines -31 to 33
if (typeof window !== 'undefined' && 'ethereum' in window) {
return new ethers.providers.Web3Provider((window as any).ethereum);
if ('ethereum' in globalThis) {
return new ethers.providers.Web3Provider((globalThis as any).ethereum);
}
Copy link
Member Author

@alexandre-abrioux alexandre-abrioux May 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without this change, we would get the following error during build:

✖  @requestnetwork/payment-processor:build
$ tsc -b tsconfig.build.json
       src/payment/utils.ts(31,14): error TS2304: Cannot find name 'window'.

I'm guessing it worked before because graphql-request v6 was declaring a window type globally.

@alexandre-abrioux alexandre-abrioux marked this pull request as ready for review May 20, 2025 10:01
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