Skip to content

Fix init.ts detection for sentry plugin users #2051

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

Merged
merged 2 commits into from
May 14, 2025
Merged

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented May 14, 2025

We had to strip the suffix that the sentry plugin adds before comparing potential init filenames.

Summary by CodeRabbit

  • Bug Fixes
    • Improved detection of initialization files when using the Sentry esbuild plugin, ensuring more accurate handling of init files in project directories.
  • Documentation
    • Added a changeset describing the fix for initialization file detection.

Copy link

changeset-bot bot commented May 14, 2025

🦋 Changeset detected

Latest commit: 811c130

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

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 May 14, 2025

Walkthrough

This change centralizes and updates the logic for detecting init.ts entry points in the build process. A new isInitEntryPoint function is added and exported, replacing a previous local implementation. Imports and function calls are updated to use this shared logic, and a changeset documents the fix for Sentry esbuild plugin integration.

Changes

File(s) Change Summary
.changeset/orange-rocks-grow.md Adds a changeset documenting the fix for init.ts detection with the Sentry esbuild plugin.
packages/cli-v3/src/build/bundle.ts Removes local isInitEntryPoint, imports the new shared version, updates usage to pass trigger directories as argument.
packages/cli-v3/src/build/packageModules.ts Adds and exports isInitEntryPoint function for detecting init entry points; updates imports to support new logic.

Sequence Diagram(s)

sequenceDiagram
    participant BuildProcess
    participant Config
    participant PackageModules

    BuildProcess->>Config: Get triggerDirs from resolved config
    BuildProcess->>PackageModules: isInitEntryPoint(entryPoint, triggerDirs)
    PackageModules-->>BuildProcess: true/false (is init entry point?)
    BuildProcess->>BuildProcess: Use result in build output processing
Loading

Possibly related PRs

  • triggerdotdev/trigger.dev#2041: Refactors and centralizes init.ts entry point detection, while this PR fixes init.ts import for deployed workers and improves error handling; both address init.ts handling but in different contexts.

Suggested reviewers

  • ericallam

Poem

A rabbit hopped through code today,
To find where init files should stay.
With logic shared and paths made clear,
The build now finds them, far and near.
Sentry smiles, the bugs are gone—
The patch is in, let's hop along! 🐇

Tip

⚡️ 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 0661ee5 and 811c130.

📒 Files selected for processing (3)
  • .changeset/orange-rocks-grow.md (1 hunks)
  • packages/cli-v3/src/build/bundle.ts (3 hunks)
  • packages/cli-v3/src/build/packageModules.ts (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/cli-v3/src/build/bundle.ts (1)
packages/cli-v3/src/build/packageModules.ts (1)
  • isInitEntryPoint (240-261)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (6)
packages/cli-v3/src/build/packageModules.ts (2)

2-2: Appropriate addition of path utilities.

The import statement is expanded to include basename, dirname, and resolve from node:path, which are needed for the new isInitEntryPoint function.


239-261: Well-structured implementation for init file detection.

This new function properly handles the Sentry plugin's behavior of adding query string suffixes to filenames. The implementation:

  1. Normalizes paths for exact directory matching
  2. Strips query string suffixes (e.g., ?sentryProxyModule=true)
  3. Checks against a comprehensive list of valid init file extensions

The approach is robust and addresses the core issue mentioned in the PR objectives.

One note on line 255-257: The check for !entryPointWithoutSuffix seems unnecessary since splitting a string on "?" will always return at least one element, even if it's an empty string. However, it adds extra safety, so it's acceptable.

packages/cli-v3/src/build/bundle.ts (3)

6-6: Clean up of unused path utilities.

The import statement has been simplified to remove unused basename and dirname imports, which are now only needed in the centralized isInitEntryPoint function.


20-20: Adding import for the centralized function.

Importing the newly created isInitEntryPoint function from packageModules.js supports the code refactoring pattern by centralizing this logic.


270-270: Updated function call with proper arguments.

The call to isInitEntryPoint now correctly passes both the entry point and trigger directories, aligning with the function signature in packageModules.ts.

.changeset/orange-rocks-grow.md (1)

1-5: Clear and concise changeset description.

The changeset correctly identifies this as a patch version change and clearly states the purpose: fixing init.ts detection when using the Sentry esbuild plugin. This aligns perfectly with the code changes implemented.

✨ 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.

@nicktrn nicktrn merged commit 206a2c3 into main May 14, 2025
12 checks passed
@nicktrn nicktrn deleted the fix/sentry+init.ts branch May 14, 2025 15:20
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