Skip to content

docs(bun): note WebSocket limitation with remote browser connections#3537

Merged
matt-aitken merged 2 commits intomainfrom
docs/bun-websocket-remote-browser-limitation
May 8, 2026
Merged

docs(bun): note WebSocket limitation with remote browser connections#3537
matt-aitken merged 2 commits intomainfrom
docs/bun-websocket-remote-browser-limitation

Conversation

@isshaddad
Copy link
Copy Markdown
Collaborator

No description provided.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 8, 2026

⚠️ No Changeset found

Latest commit: 76fc202

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 8, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trigger 🟢 Ready View Preview May 8, 2026, 12:31 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 8, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e5de736c-771d-488c-87c9-a4c4da4f25d4

📥 Commits

Reviewing files that changed from the base of the PR and between 749dc46 and 76fc202.

📒 Files selected for processing (1)
  • docs/guides/frameworks/bun.mdx
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.mdx

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from @trigger.dev/sdk in code examples (never from @trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences: typescript, bash, json

Files:

  • docs/guides/frameworks/bun.mdx
🧠 Learnings (3)
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.

Applied to files:

  • docs/guides/frameworks/bun.mdx
📚 Learning: 2026-04-30T20:30:29.458Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3226
File: docs/ai-chat/quick-start.mdx:13-13
Timestamp: 2026-04-30T20:30:29.458Z
Learning: In this repo’s documentation MDX files (`docs/**/*.mdx`), use `ts` and `tsx` (not `typescript`) as the code-fence language tags for TypeScript/TSX snippets. Do not flag `ts`/`tsx` code-fence language tags as incorrect in any docs MDX file, since this is the site-wide Mintlify-compatible convention.

Applied to files:

  • docs/guides/frameworks/bun.mdx
📚 Learning: 2026-03-25T00:18:24.123Z
Learnt from: isshaddad
Repo: triggerdotdev/trigger.dev PR: 3262
File: docs/guides/frameworks/nango.mdx:71-71
Timestamp: 2026-03-25T00:18:24.123Z
Learning: In trigger.dev framework guide MDX files under docs/guides/frameworks/**, when you include TypeScript code snippets, use the code-fence language tag `ts` (not `typescript`) for the opening ``` fence. Keep this consistent across all framework guides so syntax highlighting works uniformly (e.g., Next.js, Sequin, Prisma, Remix, Drizzle).

Applied to files:

  • docs/guides/frameworks/bun.mdx
🔇 Additional comments (3)
docs/guides/frameworks/bun.mdx (3)

13-14: Clear warning wording and formatting.

Good clarification that Node.js is only needed for CLI execution while Bun still runs tasks in dev.


18-19: Helpful version compatibility note.

This is specific and practical for avoiding local-vs-deploy mismatch issues.


31-31: Great addition to Known issues with an actionable workaround.

Calling out the failure symptom and exact mitigation should save significant debugging time for users.


Walkthrough

This change updates the Bun framework documentation guide to clarify CLI and runtime constraints. The existing warning text about the Trigger.dev CLI requiring Node.js is reformatted across multiple lines while preserving its meaning. A new Known Issues section documents a Bun WebSocket client problem affecting remote browser connections via puppeteer.connect() and playwright.connectOverCDP(), with a workaround recommending runtime: "node" configuration in trigger.config.ts for affected tasks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is missing entirely. No testing, changelog, or checklist information was provided despite the repository template requirements. Add a complete pull request description following the repository template, including testing steps, changelog entry, and a completed checklist.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main documentation change: adding a note about WebSocket limitations with remote browser connections in Bun.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/bun-websocket-remote-browser-limitation

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@isshaddad isshaddad marked this pull request as ready for review May 8, 2026 12:35
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@matt-aitken matt-aitken merged commit 3cb6b5e into main May 8, 2026
11 checks passed
@matt-aitken matt-aitken deleted the docs/bun-websocket-remote-browser-limitation branch May 8, 2026 16:25
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