janestreet / janestreet/magic-trace

Filter events from after the stop indicator

Open
#81 2 comments 0 reactions 0 assignees View on GitHub
enhancement ui
Dominant language
OCaml
Stars
6.3k
Forks
209
PR merge metrics
No merged PRs in 30d

Description

Magic-trace doesn't stop recording exactly when the stop indicator is hit. That can be quite confusing, especially if you get unlucky and the stop event is nowhere near the right hand side of the trace.

To fix this, let's filter out events from the trace that happen after the stop indicator returns.

It's conceivable that people will want the current behavior behind a flag, but I weakly think it's not worth the extra UI complexity.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating the stop-indicator handling and the trace event filtering path, then trace how events are retained after the indicator returns. Done means events occurring after the stop indicator are excluded from the displayed trace, with coverage for the trace ending at the indicator.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
performance
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.