Bug 1364478 - Add edge case documentation for the 'new-profile' ping. r=gfritzsche,madalin.cotetiu+500525
authorAlessio Placitelli <alessio.placitelli@gmail.com>
Tue, 16 May 2017 09:37:12 +0200
changeset 409655 e517be6b801ea383e641047e2b6aa5035e46ca8c
parent 409654 ab73eb9aae41e81c35c5aefe5cb483c79dabcf43
child 409656 6d808a3a6463f01b53ec80cf4b0587e1743e701c
push id1490
push usermtabara@mozilla.com
push dateMon, 31 Jul 2017 14:08:16 +0000
treeherdermozilla-release@70e32e6bf15e [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgfritzsche, madalin
bugs1364478, 500525
milestone55.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1364478 - Add edge case documentation for the 'new-profile' ping. r=gfritzsche,madalin.cotetiu+500525 MozReview-Commit-ID: 2sJuJuLELf2
toolkit/components/telemetry/docs/data/new-profile-ping.rst
--- a/toolkit/components/telemetry/docs/data/new-profile-ping.rst
+++ b/toolkit/components/telemetry/docs/data/new-profile-ping.rst
@@ -32,8 +32,30 @@ startup. If it contains ``shutdown``, th
 ping was scheduled. In the latter case, the ping is generated during shutdown and sent
 using the :doc:`../internals/pingsender`.
 
 Duplicate pings
 ---------------
 We expect a low fraction of duplicates of this ping, mostly due to crashes happening
 right after sending the ping and before the telemetry state gets flushed to the disk. This should
 be fairly low in practice and manageable during the analysis phase.
+
+Expected behaviours
+-------------------
+The following is a list of conditions and expected behaviours for the ``new-profile`` ping:
+
+- **The ping is generated at the browser shutdown on a new profile, after the privacy policy is displayed:**
+
+  - *for an user initiated browser shutdown*, ``new-profile`` is sent immediately using the :doc:`../internals/pingsender`;
+  - *for a browser shutdown triggered by OS shutdown*, ``new-profile`` is saved to disk and sent next time the browser restarts.
+- **The ping is generated before the privacy policy is displayed**: ``new-profile`` is saved to disk and sent
+  next time the browser restarts.
+- **The ping is set to be generated and Telemetry is disabled**: ``new-profile`` is never sent, even if Telemetry is
+  turned back on later.
+- **Firefox crashes before the ping can be generated**: ``new-profile`` will be scheduled to be generated and
+  sent again on the next restart.
+- **User performs a profile refresh**:
+
+  - *the ping was already sent*: ``new-profile`` will not be sent again.
+  - *the ping was not sent*: ``new-profile`` will be generated and sent.
+  - *the refresh happens immediately after the profile creation, before the policy is shown*: ``new-profile`` will not be sent again.
+- **Firefox is run with an old profile that already sent Telemetry data**: ``new-profile`` will not be generated
+  nor sent.