Skip to content

Always find debug logs when in the span sidebar #2093

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 1 commit into from
May 22, 2025
Merged

Conversation

ericallam
Copy link
Member

No description provided.

Copy link

changeset-bot bot commented May 22, 2025

⚠️ No Changeset found

Latest commit: 3a010e4

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

Copy link
Contributor

coderabbitai bot commented May 22, 2025

Walkthrough

The changes introduce an optional parameter, includeDebugLogs, to the findMany method in the TaskEventStore class, the getSpan and #getSpanEvent methods in the EventRepository class, and their related call sites. This parameter allows callers to specify whether debug log events (of kind "LOG") should be included in query results. The filtering logic in findMany is updated to conditionally exclude or include "LOG" events based on this parameter. The SpanPresenter.server.ts file is updated to pass { includeDebugLogs: true } when fetching span data, enabling the inclusion of debug logs in the retrieved span. No other logic or public API changes are made.


📜 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 1bb1fc4 and 3a010e4.

📒 Files selected for processing (3)
  • apps/webapp/app/presenters/v3/SpanPresenter.server.ts (1 hunks)
  • apps/webapp/app/v3/eventRepository.server.ts (3 hunks)
  • apps/webapp/app/v3/taskEventStore.server.ts (3 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: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (9)
apps/webapp/app/presenters/v3/SpanPresenter.server.ts (1)

425-427: Well implemented: Now including debug logs in span data

The addition of { includeDebugLogs: true } parameter to the eventRepository.getSpan call ensures that debug logs (of kind "LOG") will now be included in the span data retrieved for the sidebar, which directly addresses the PR objective.

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

79-80: Clean method signature extension for includeDebugLogs option

The parameter addition follows TypeScript best practices by using an options object for extensibility.


103-104: Clear default behavior for includeDebugLogs flag

Good implementation of the default behavior - debug logs are filtered out unless explicitly included. The conditional is well-written and handles both undefined and false values correctly.


110-111: Consistent implementation for taskEventPartitioned table

The conditional filtering using the spread operator is clean and efficient.


120-121: Consistent implementation for taskEvent table

The same filtering logic is correctly applied to both table types, maintaining consistency across the codebase.

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

579-580: Good parameter propagation in getSpan method

The optional parameter for debug log inclusion is correctly added to the method signature.


583-589: Proper forwarding of options to getSpanEvent

The options parameter is correctly passed down to the underlying method.


797-798: Consistent parameter in private getSpanEvent method

The parameter signature matches the public method and follows the same pattern.


809-810: Complete implementation with options passed to taskEventStore

The options are correctly forwarded to the underlying taskEventStore.findMany call, completing the chain of parameter propagation.

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

@ericallam ericallam merged commit a306545 into main May 22, 2025
12 checks passed
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