Feature #15912

Allow some reentrancy during TracePoint events

Added by deivid (David Rodríguez) over 1 year ago. Updated about 1 year ago.

Target version:


I got a report in byebug about byebug being incompatible with zeitwerk. This one: This is a problem because zeitwerk is the default Rails code loader, and byebug is the default Rails debugger.

Both of these tools rely on the TracePoint API:

  • Byebug uses a bunch of TracePoint events to stop execution at certain points in your program.
  • Zeitwek uses :class events to be able to resolve some circular edge cases.

I investigated the problem and I think the issue is that while stopped at the byebug prompt, we're actually in the middle of processing a TracePoint event. That means that further TracePoint events triggered at the byebug's prompt will be ignored, because otherwise we could get into an infinite loop where the handling of events would trigger more events that trigger themselves the execution of handlers again.

I understand why the TracePoint API does this, but if we could allow some level of reentrancy here, we could probably make these tools play nice together. I figure if we kept a stack of TracePoint event handlers being run, and check that the current event type is not already in the stack, we would allow :class events to be triggered from :line events, and I think that would allow Zeitwerk to work within byebug.

What do you think about this, ko1 (Koichi Sasada)?

Also available in: Atom PDF