microsoft / vscode-js-debug

A DAP-compatible JavaScript debugger. Used in VS Code, VS, + more
MIT License
1.66k stars 278 forks source link

Custom toString causes non observable side effects when debugging #2011

Open robbiespeed opened 4 months ago

robbiespeed commented 4 months ago

Describe the bug If a object has a toString method that produces side effects, the debugger triggers those side effects in a non observable way.

Seems related to #1296

To Reproduce Place a breakpoint in the following code:

export class Foo {
  #counter = 0;
  get() {
    console.log("Some side effects happen here");
    // ^--- add breakpoint here
    return this.#counter += 1;
  }
  toString () {
    return String(this.get());
  }
}

const foo = new Foo();

foo.get();

By the time the debugger stops at the breakpoint (before log should run), one log has already happened and the counter has increased.

VS Code Version: 1.89.1

connor4312 commented 3 months ago

Yea, this is as-designed, we assume that toString() does not have side effects.

robbiespeed commented 3 months ago

That's not a great assumption to make for something that's not opt-in. It makes the VS Code debugger unusable for any library that doesn't have an entirely pure toString, like preact/signals where it calls the getter for the value prop which on Computed signals will automatically recompute any value the debugger comes across.