v4 run engine debug logs now filtered out in SQL by default

[ericallam]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c29dbd9

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.

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

[coderabbitai]

Walkthrough

The changes introduce a mechanism to control the inclusion of debug log events in the application's run trace views via a new showDebug boolean parameter. This parameter is now propagated from the URL search parameters in the frontend route, through the loader, and down to the backend data retrieval methods. The method signatures for retrieving trace summaries and events are updated to accept an includeDebugLogs option, which determines whether debug logs are included in the results. The frontend now synchronizes the debug view state with the URL, allowing for shareable and bookmarkable debug views.

---

📜 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 c8d252e and c29dbd9.

📒 Files selected for processing (4)

• apps/webapp/app/presenters/v3/RunPresenter.server.ts (2 hunks)
• apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.runs.$runParam/route.tsx (5 hunks)
• apps/webapp/app/v3/eventRepository.server.ts (1 hunks)
• apps/webapp/app/v3/taskEventStore.server.ts (5 hunks)

⏰ 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: units / 🧪 Unit Tests
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
• GitHub Check: typecheck / typecheck
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (17)

apps/webapp/app/v3/taskEventStore.server.ts (6)

2-2: Import changed from type-only to value import

The import of Prisma and TaskEvent from @trigger.dev/database has been changed from a type-only import to a value import, which is necessary for using Prisma's SQL templating features.

---

104-109: Adding consistent filtering for LOG events in taskEventPartitioned table

The query is now filtering out events with kind: "LOG" by default, which aligns with the goal of hiding debug logs by default.

---

116-121: Adding consistent filtering for LOG events in taskEvent table

The same filtering logic is applied here for the non-partitioned table, ensuring consistent behavior across both tables.

---

132-137: Added configurable debug log filtering

The findTraceEvents method now accepts an options parameter with includeDebugLogs flag, allowing the caller to control whether debug logs should be included in the results.

---

164-168: Implemented conditional SQL filtering for debug logs in partitioned table

The SQL query now conditionally includes a filter to exclude LOG events based on the includeDebugLogs option. This is a clean implementation using Prisma's SQL templating.

---

193-197: Implemented conditional SQL filtering for debug logs in standard table

The same conditional filtering logic is applied to the standard table query, ensuring consistent behavior across both storage types.

apps/webapp/app/presenters/v3/RunPresenter.server.ts (3)

35-35: Added showDebug parameter to RunPresenter.call

This parameter allows the caller to control whether debug logs should be included in the trace results.

---

43-43: Added type annotation for showDebug parameter

The type annotation ensures type safety for the new parameter.

---

136-137: Propagating debug flag to event repository

The showDebug parameter is now passed to the eventRepository.getTraceSummary method as includeDebugLogs, ensuring the filter setting is propagated through the application stack.

apps/webapp/app/v3/eventRepository.server.ts (2)

436-437: Added options parameter with includeDebugLogs to getTraceSummary

This change allows the method to receive the debug logs filtering preference from higher layers.

---

444-445: Propagating includeDebugLogs option to taskEventStore

The debug logs filtering preference is now passed down to the underlying findTraceEvents method, completing the chain from UI to database query.

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.runs.$runParam/route.tsx (6)

98-98: Added useSearchParams hook import

This hook allows reading and updating URL search parameters for state management.

---

137-139: Reading showDebug from URL search parameters

The code now extracts the showDebug flag from the URL search parameters, enabling shareable and bookmarkable debug views.

---

149-149: Passing showDebug parameter to RunPresenter.call

The URL-derived showDebug parameter is now passed to the presenter, enabling debug logs filtering to be controlled via URL.

---

519-523: Replaced local state with URL search parameters for debug view toggle

State management for the debug toggle has been moved from local component state to URL search parameters, which is a better approach for shareable state.

---

524-524: Simplified events filtering logic

The client-side filtering of debug events has been removed since the filtering is now handled at the database level, which is more efficient.

---

571-575: Updated debug toggle to modify URL search parameters

The toggle now updates the URL search parameters instead of local state, ensuring the UI reflects the current filter state and enables sharing exact views.

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