Writing an instrumentation log into the package directory causes spam

[natebosch]

1650992695603:Watch:<unknown>:/usr/local/google/home/nbosch/repos/dart_repro/instrumentation_log:modify
1650992695603:Watch:<unknown>:/usr/local/google/home/nbosch/repos/dart_repro/instrumentation_log:modify
1650992695604:Watch:<unknown>:/usr/local/google/home/nbosch/repos/dart_repro/instrumentation_log:modify
1650992695604:Watch:<unknown>:/usr/local/google/home/nbosch/repos/dart_repro/instrumentation_log:modify
1650992695604:Watch:<unknown>:/usr/local/google/home/nbosch/repos/dart_repro/instrumentation_log:modify
1650992695604:Watch:<unknown>:/usr/local/google/home/nbosch/repos/dart_repro/instrumentation_log:modify
1650992695605:Watch:<unknown>:/usr/local/google/home/nbosch/repos/dart_repro/instrumentation_log:modify

There is some useful logging at the beginning, but then the file just becomes neverending modifications because it logs each change it makes.

We should either warn when you use an instrumentation log argument where this will happen, or filter out these events from the log.

[bwilkerson]

@DanTup

[DanTup]

@bwilkerson I could detect/warn on this in the VS Code extension (or LSP server), but I suspect the same happens for the original protocol too (where I'm not sure we can easily get a warning to the user).

Filtering out watch events for the log itself seems seems sensible, although I think it means InstrumentationLogAdapter (created here) may need to also be given the path directly to exclude. WDYT?

[bwilkerson]

If we filter out any watch events for the log itself, then I'm not sure we need to warn the user. If we do need to notify them, then we can use the server.error notification to do so when using the legacy protocol.

Let's start by filtering. And I wasn't assigning this to you, so don't feel obligated to work on it.

[natebosch]

This does have an easy workaround so I would consider it low priority.

[DanTup]

I just (re)discovered this issue today... I thought we had fixed it previously, because I'm frequently writing instrumentation logs into my project folders and haven't seen it until today. However today I'm using a Docker container to debug a (suspected) Linux issue and saw this. I wonder if it's only happening on Linux (edit: that seems to be the case.. perhaps the way the log is flushed doesn't trigger these events on macOS?).

Anyway, I'll try to fix this, because logging outside of the workspace folder seems to fail when using a devcontainer and that's preventing debugging this other issue.