Skip to content

Conversation

@janb87
Copy link
Contributor

@janb87 janb87 commented May 22, 2025

Summary by Sourcery

Update IPFS client schema comments, strengthen restart-resources e2e test with an unauthorized status check, and add Node Gyp installation to the CI e2e workflow

CI:

  • Install Node Gyp in e2e GitHub Actions workflow

Tests:

  • Add unauthorized status assertion to restart-resources e2e test

Chores:

  • Correct schema comments to reference the IPFS client

Summary by CodeRabbit

  • Documentation

    • Updated comments in the IPFS client options schema for improved accuracy.
  • Chores

    • Changed editor settings to always organize imports automatically on save.
    • Modified GitHub Actions workflow to globally install node-gyp during E2E tests.
  • Tests

    • Enhanced E2E test to verify service availability and authentication requirements after a restart.

@janb87 janb87 added the e2e label May 22, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 22, 2025

Reviewer's Guide

This PR fixes end-to-end tests by correcting schema documentation to reference the IPFS client, adding a post-restart health check in the restart-resources test to assert an unauthorized response without a token, and installing node-gyp globally in the CI workflow to support native dependencies.

File-Level Changes

Change Details Files
Correct schema documentation comments to reference the IPFS client
  • Updated ClientOptionsSchema comment
  • Updated ServerClientOptionsSchema comment
sdk/ipfs/src/helpers/client-options.schema.ts
Add post-restart health check in e2e test
  • Loaded environment variables
  • Fetched endpoint with retry
  • Asserted 401 status without token
test/restart-resources.e2e.test.ts
Install node-gyp globally in CI workflow
  • Added “Install Node Gyp” step in e2e job
.github/workflows/e2e.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link

coderabbitai bot commented May 22, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update GitHub Actions to install node-gyp globally in the E2E workflow, adjust VSCode settings to always organize imports on save, correct schema documentation in the IPFS client options, and enhance an end-to-end test to verify service authentication after a restart by performing an HTTP request and checking for a 401 response.

Changes

File(s) Change Summary
.github/workflows/e2e.yml Added a workflow step to globally install node-gyp using Bun after setting up Foundry and before installing dependencies.
.vscode/settings.json Changed editor setting to always organize imports on save by updating "source.organizeImports" from "never" to "always".
sdk/ipfs/src/helpers/client-options.schema.ts Updated documentation comments to refer to the IPFS client instead of the Portal client; no code or logic changes.
test/restart-resources.e2e.test.ts Enhanced test to load environment variables and perform an authenticated HTTP request, asserting a 401 response to verify middleware.

Sequence Diagram(s)

sequenceDiagram
    participant Test as E2E Test
    participant Env as Env Loader
    participant Portal as Portal REST Endpoint

    Test->>Env: loadEnv()
    Test->>Portal: fetchWithRetry(REST endpoint)
    Portal-->>Test: HTTP 401 Unauthorized
    Test->>Test: Assert response status is 401
Loading

Poem

In the warren, code hops anew,
Imports now tidy, as rabbits do!
Node-gyp joins the E2E race,
Docs corrected in schema’s place.
Tests sniff the portal’s guarded door—
401 found, security’s sure!
🐇✨


📜 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 23cb35b and b31c3ca.

📒 Files selected for processing (4)
  • .github/workflows/e2e.yml (1 hunks)
  • .vscode/settings.json (1 hunks)
  • sdk/ipfs/src/helpers/client-options.schema.ts (2 hunks)
  • test/restart-resources.e2e.test.ts (2 hunks)
✨ 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.

@github-actions github-actions bot added the fix Bug fix label May 22, 2025
@github-actions
Copy link

📦 Packages

Package NPM Docker
SDK Cli @settlemint/sdk-cli@2.3.2-pref75df5f
SDK The Graph @settlemint/sdk-thegraph@2.3.2-pref75df5f
SDK Portal @settlemint/sdk-portal@2.3.2-pref75df5f
SDK Hasura @settlemint/sdk-hasura@2.3.2-pref75df5f
SDK JS @settlemint/sdk-js@2.3.2-pref75df5f
SDK Utils @settlemint/sdk-utils@2.3.2-pref75df5f
SDK Next @settlemint/sdk-next@2.3.2-pref75df5f
SDK Minio @settlemint/sdk-minio@2.3.2-pref75df5f
SDK IPFS @settlemint/sdk-ipfs@2.3.2-pref75df5f
SDK Blockscout @settlemint/sdk-blockscout@2.3.2-pref75df5f
SDK MCP @settlemint/sdk-mcp@2.3.2-pref75df5f

@janb87 janb87 marked this pull request as ready for review May 22, 2025 11:36
@janb87 janb87 merged commit 63abfe2 into main May 22, 2025
8 checks passed
@janb87 janb87 deleted the jan/fix-e2e-issues2 branch May 22, 2025 11:36
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @janb87 - I've reviewed your changes - here's some feedback:

  • The e2e restart test only asserts a 401 on an unauthenticated request—consider also adding a successful request with a valid token to verify the service is fully operational after restart.
  • Installing node-gyp globally via bun install -g can lead to version drift; consider moving it into your devDependencies or using a reproducible install step to ensure native modules build consistently in CI.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +67 to +68
- name: Install Node Gyp
run: bun install -g node-gyp
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (bug_risk): Using bun install -g for global installation may not work

Bun does not handle the -g flag like npm. Use npm install -g node-gyp or add node-gyp as a devDependency and run bun install instead.

Suggested change
- name: Install Node Gyp
run: bun install -g node-gyp
- name: Install Node Gyp
run: npm install -g node-gyp

snigdha920 added a commit that referenced this pull request May 23, 2025
…orkflows-on-events

* main:
  chore(deps): update dependency knip to v5.57.2 (#1037)
  chore(deps): update dependency @modelcontextprotocol/sdk to v1.12.0 (#1038)
  chore(deps): update dependency @types/bun to v1.2.14 (#1036)
  fix: e2e tests (#1034)
  chore(deps): update dependency knip to v5.57.1 (#1032)
  chore(deps): update node.js to v22.16.0 (#1033)
  chore(deps): update dependency @modelcontextprotocol/sdk to v1.11.5 (#1030)
  chore(deps): update dependency bun to v1.2.14 (#1031)
@coderabbitai coderabbitai bot mentioned this pull request Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

e2e fix Bug fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants