cli: adds support for source-maps

[jaipaljadeja]

• this enables support for source-maps, so error traces can be more readable.
• also replaces node-fetch with encoding in runtimeDependencies, as running build file like dev.mjs directly with node would throw errors for node-fetch.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces a new JSON metadata file for a prerelease version of the "apibara" package that contains fields for type, comment, package name, email, and dependent change type. It also adds source map support to the CLI by modifying the createApibara function to update the NODE_OPTIONS environment variable, and it revises the runtime dependencies by replacing "node-fetch" with "encoding" in the configuration file.

Changes

File(s)	Change Summary
change/apibara-72dcbda1-4e3a-4509-a2a0-3575ed36626f.json	New JSON metadata file for prerelease version including type, comment, packageName, email, and dependentChangeType.
packages/cli/src/core/apibara.ts	Modified the createApibara function to append or initialize --enable-source-maps in process.env.NODE_OPTIONS for source map support.
packages/cli/src/rolldown/config.ts	Updated the runtimeDependencies array by removing "node-fetch" and adding "encoding" with an explanatory comment.

Sequence Diagram(s)

sequenceDiagram
    participant C as CLI
    participant A as createApibara Function
    participant E as Environment (NODE_OPTIONS)

    C->>A: Call createApibara()
    A->>E: Check NODE_OPTIONS variable
    alt NODE_OPTIONS exists
        A->>E: Append '--enable-source-maps'
    else NODE_OPTIONS not set
        A->>E: Set NODE_OPTIONS = '--enable-source-maps'
    end
    A-->>C: Continue with function execution

Loading

Possibly related PRs

• cli: include runtime-meta in package #114: Introduces similar JSON metadata files with fields like type, comment, package name, email, and dependent change type.
• cli: bump @electric-sql/pglite version #145: Adds a new JSON file for prerelease metadata, closely related to this PR’s prerelease version bump.
• cli: add instrumentation for side effects #158: Also introduces JSON files specifying metadata for prerelease versions of the "apibara" package.

Suggested reviewers

• fracek

Poem

I’m a rabbit in the codefield,
Hopping through changes with a happy yield,
Metadata set and source maps in play,
CLI hops along in a joyful way,
In lines of code I dance and run,
Celebrating changes under the coding sun! 🐇
Cheers to tweaks and bugs undone!

---

📜 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 2e4055b and e1e52a1.

📒 Files selected for processing (3)

• change/apibara-72dcbda1-4e3a-4509-a2a0-3575ed36626f.json (1 hunks)
• packages/cli/src/core/apibara.ts (1 hunks)
• packages/cli/src/rolldown/config.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test

🔇 Additional comments (3)

packages/cli/src/core/apibara.ts (1)

20-24: Good addition of source map support for better debugging!

This change enhances error traceability by enabling source maps in Node.js. The implementation correctly preserves any existing NODE_OPTIONS while adding the new flag.

change/apibara-72dcbda1-4e3a-4509-a2a0-3575ed36626f.json (1)

1-7: Change management file looks good

The change file correctly documents the source map addition as a patch-level change, which is appropriate for this type of non-breaking enhancement.

packages/cli/src/rolldown/config.ts (1)

23-24: Dependency change matches PR objective

Replacing node-fetch with encoding addresses the issue described in the PR objectives where running dev.mjs directly with Node would result in errors. The comment clearly explains the reasoning.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.