firefox-main/toolkit/components/telemetry/tests/marionette/tests/client/test_fog_user_activity.py (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from telemetry_harness.fog_testcase import FOGTestCase
class BaselineRidealongFilter:
"""Expecting a `baseline` ping and one more ping"""
def __init__(self, other_ping):
self.expected_pings = ["baseline", other_ping]
def __call__(self, ping):
doc_type = ping["request_url"]["doc_type"]
return doc_type in self.expected_pings
DauReportFilter = BaselineRidealongFilter("usage-reporting")
class TestClientActivity(FOGTestCase):
"""
Tests for client activity and FOG's scheduling of the "baseline" ping.
For every `baseline` ping we also expect a `usage-reporting` ping.
"""
def test_user_activity(self):
# We might still get those pings in an unexpected order.
# Let's check we get both.
expected_pings = ["baseline", "usage-reporting"]
# Restarting the browser could send multiple "baseline" pings
# (e.g. there could be some pending, or some triggered near shutdown.)
# So only accept the "baseline" ping sent near startup.
# We identify this ping as the one that has seen an "events" ping being sent,
# since one of those is submitted during startup due to events being present.
def is_startup_baseline_ping(ping):
return (
ping["request_url"]["doc_type"] == "baseline"
and ping["payload"]["metrics"]
.get("labeled_counter", {})
.get("glean.validation.pings_submitted", {})
.get("events")
== 1
)
[ping0, ping1] = self.wait_for_pings(
self.restart_browser,
lambda ping: is_startup_baseline_ping(ping)
or ping["request_url"]["doc_type"] == "usage-reporting",
2,
ping_server=self.fog_ping_server,
)
# First test that restarting the browser sends a "active" ping
received_pings = sorted(
[
ping0["request_url"]["doc_type"],
ping1["request_url"]["doc_type"],
]
)
self.assertEqual(expected_pings, received_pings)
if ping0["request_url"]["doc_type"] == "baseline":
self.assertEqual("active", ping0["payload"]["ping_info"]["reason"])
if ping1["request_url"]["doc_type"] == "baseline":
self.assertEqual("active", ping1["payload"]["ping_info"]["reason"])
with self.marionette.using_context(self.marionette.CONTEXT_CHROME):
zero_prefs_script = """\
Services.prefs.setIntPref("telemetry.fog.test.inactivity_limit", 0);
Services.prefs.setIntPref("telemetry.fog.test.activity_limit", 0);
"""
self.marionette.execute_script(zero_prefs_script)
def user_active(active, marionette):
script = "Services.obs.notifyObservers(null, 'user-interaction-{}active')".format(
"" if active else "in"
)
with marionette.using_context(marionette.CONTEXT_CHROME):
marionette.execute_script(script)
[ping2, ping3] = self.wait_for_pings(
lambda: user_active(True, self.marionette),
DauReportFilter,
2,
ping_server=self.fog_ping_server,
)
[ping4, ping5] = self.wait_for_pings(
lambda: user_active(False, self.marionette),
DauReportFilter,
2,
ping_server=self.fog_ping_server,
)
received_pings = sorted(
[
ping2["request_url"]["doc_type"],
ping3["request_url"]["doc_type"],
]
)
self.assertEqual(expected_pings, received_pings)
if ping2["request_url"]["doc_type"] == "baseline":
self.assertEqual("active", ping2["payload"]["ping_info"]["reason"])
if ping3["request_url"]["doc_type"] == "baseline":
self.assertEqual("active", ping3["payload"]["ping_info"]["reason"])
received_pings = sorted(
[
ping4["request_url"]["doc_type"],
ping5["request_url"]["doc_type"],
]
)
self.assertEqual(expected_pings, received_pings)
if ping4["request_url"]["doc_type"] == "baseline":
self.assertEqual("inactive", ping4["payload"]["ping_info"]["reason"])
if ping5["request_url"]["doc_type"] == "baseline":
self.assertEqual("inactive", ping5["payload"]["ping_info"]["reason"])