Skip to content

Run page improvements #1874

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
Apr 2, 2025
Merged

Run page improvements #1874

merged 2 commits into from
Apr 2, 2025

Conversation

matt-aitken
Copy link
Member

@matt-aitken matt-aitken commented Apr 2, 2025

Two run page improvements

  1. When selecting spans (with the mouse or keyboard), it won't add to the browser history.
  2. Debug logs (only admins can see these), don't extend the period that the run timeline shows.

Summary by CodeRabbit

  • New Features
    • Enhanced URL parameter handling now supports additional navigation options, offering smoother browser history management.
  • Bug Fixes
    • Improved runtime calculations by ensuring only non-debug events contribute to total duration, resulting in more accurate display timings.

Copy link

changeset-bot bot commented Apr 2, 2025

⚠️ No Changeset found

Latest commit: 367d538

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

Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Walkthrough

This pull request updates three files. In the hooks module, a new type (NavigateOptions) is defined and the replaceSearchParam function is extended to accept an additional parameter for navigation options. In the route component, a call to this function is updated to include "{ replace: true }", ensuring that URL updates do not add a new history entry. Separately, the RunPresenter now conditionally skips duration accumulation for debug events, ensuring that only non-debug events affect the overall duration calculation.

Changes

File(s) Change Summary
apps/webapp/app/hooks/useReplaceSearchParams.ts
apps/webapp/app/routes/.../route.tsx
Updated replaceSearchParam to accept an additional navigateOpts parameter (of type NavigateOptions) and modified its usage in the TraceView component to include options such as { replace: true }.
apps/webapp/app/presenters/v3/RunPresenter.server.ts Added a conditional check to skip updating totalDuration when the event's isDebug flag is true, ensuring only non-debug event durations are accumulated.

Sequence Diagram(s)

sequenceDiagram
    participant TraceView
    participant ReplaceSearchHook
    participant setSearchParams
    TraceView->>ReplaceSearchHook: replaceSearchParam("span", selectedSpan, { replace: true })
    ReplaceSearchHook->>setSearchParams: setSearchParams(newParams, { replace: true })
Loading
sequenceDiagram
    participant RunPresenter
    participant EventData
    RunPresenter->>EventData: Process event n
    alt n.data.isDebug is false
        RunPresenter->>RunPresenter: totalDuration = max(current, offset + n.data.duration)
    else
        RunPresenter->>RunPresenter: Skip updating totalDuration
    end
Loading

Possibly related PRs

Suggested reviewers

  • ericallam

Poem

I’m a coding rabbit, hopping through the code,
With new options to navigate each node.
Search params now dance with a clever new twist,
And debug events are gently dismissed.
I hop with joy, keeping our routes ever bright!
🐇✨

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/webapp/app/hooks/useReplaceSearchParams.ts (1)

23-23: Consider removing searchParams from the dependency array.

The callback doesn't use the searchParams value internally, so including it in the dependency array may cause unnecessary re-renders.

-  [searchParams]
+  [setSearchParams]
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7591b6e and 367d538.

📒 Files selected for processing (3)
  • apps/webapp/app/hooks/useReplaceSearchParams.ts (1 hunks)
  • apps/webapp/app/presenters/v3/RunPresenter.server.ts (1 hunks)
  • apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.runs.$runParam/route.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
🔇 Additional comments (5)
apps/webapp/app/hooks/useReplaceSearchParams.ts (3)

4-7: Well-structured type definition for navigation options.

The NavigateOptions type correctly defines optional properties that match React Router's navigation options, providing type safety for the new parameter.


13-13: Function signature updated to support navigation options.

The updated function signature allows clients to specify how navigation should behave when replacing search parameters.


21-21: Navigation options correctly passed to setSearchParams.

This change properly forwards the navigation options to the underlying React Router function.

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

309-309: Prevent span selection from adding browser history entries.

This change ensures that when a user selects a span (via mouse or keyboard), it doesn't add a new entry to the browser history, improving navigation experience as specified in the PR objectives.

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

162-165: Prevent debug logs from extending timeline duration.

This change ensures that debug logs (visible only to admins) don't artificially extend the duration of the run timeline, which directly addresses the second objective of the PR. The clear comment also helps explain the purpose of this conditional check.

@matt-aitken matt-aitken merged commit 5bdbf47 into main Apr 2, 2025
11 of 12 checks passed
@matt-aitken matt-aitken deleted the run-page-improvements branch April 2, 2025 18:51
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