1900085 - Disable submission of buitlin pings during tests

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P1)

Description

[Chris H-C :chutten]

bug 1898598 found that we're sending an "events" ping due to "user inactivity" which was getting in the way of being able to test events (because the events were gobbled up by the "events" ping).

It's kinda amazing this doesn't happen more often. I guess the 2min/20min (in)activity windows are usually broad enough for test runs. But that's pure luck. I mean, tests could run near the 4am "metrics" ping submission trigger which would cause the exact same problem, but for all metric types that aren't event.

We need to default in Firefox Desktop test suites to not submit builtin pings. We still want the option so that FOG can test itself. But the default configuration should support instrumentation tests for metrics riding on the default transports to run reliably no matter how long the test takes and what time the test runs.

Comment 1

[Chris H-C :chutten]

Oh, I was cleverer in the past than I am today, as I noticed I already implemented preferences to control FOG's activity timings. This would give us control over "events" and "baseline" pings at the very least, so let's default these to very large values (or implement sentinel values for "not ever, nuh-uh") for test suites.

Comment 2

[Chris H-C :chutten]

And once again I've forgotten the cleverness of past-chutten. The "metrics" ping should actually already be handled as, if we're in automation, we disable the "metrics" ping scheduler entirely.

Comment 3

[Chris H-C :chutten]

Attachment: Bug 1900085 - Disable builtin Glean pings during tests r?TravisLong!

This patch specifically disables "baseline" and "events" pings through not
telling Glean about user (in)activity, which triggers their submission.
"baseline" should matter less, but if an "events" ping is submitted during a
test it could contain a test's recorded events that it will later want to
assert are present.

"metrics" pings are already suppressed in automation via the MOZ_AUTOMATION
envvar. So update the docs to note that.

"deletion-request" pings are permitted at all times for all reasons and are not
included in the builtin pings we're disabling.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f5c177cd9071
Disable builtin Glean pings during tests r=TravisLong,perftest-reviewers,sparky,search-reviewers,jteow

Comment 5

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/f5c177cd9071