Bug 1405614 - Add 'displayVersion' to the update ping with reason 'ready'. r=chutten,mhowell

This is needed in addition to "version" as, for some channel, it will report
the release suffix.

MozReview-Commit-ID: BT2Vxm3Q2nK

--HG--
extra : rebase_source : 57572e0005f4f49c47813d87070a3aef4cab818a

toolkit/components/telemetry/UpdatePing.jsm

@@ -121,6 +121,7 @@ this.UpdatePing = {
       targetChannel: update.channel,
       targetVersion: update.appVersion,
       targetBuildId: update.buildID,
+      targetDisplayVersion: update.displayVersion,
     };
 
     const options = {

toolkit/components/telemetry/docs/data/update-ping.rst

@@ -16,10 +16,11 @@ Structure:
       payload: {
         reason: <string>, // "ready", "success"
         targetChannel: <string>, // "nightly" (only present for reason = "ready")
-        targetVersion: <string>, // "56.01a" (only present for reason = "ready")
+        targetVersion: <string>, // "56.0a1" (only present for reason = "ready")
         targetBuildId: <string>, // "20080811053724" (only present for reason = "ready")
+        targetDisplayVersion: <string>, // "56.0a1" (only present for reason = "ready")
         previousChannel: <string>, // "nightly" or null (only present for reason = "success")
-        previousVersion: <string>, // "55.01a" (only present for reason = "success")
+        previousVersion: <string>, // "55.0a1" (only present for reason = "success")
         previousBuildId: <string>, // "20080810053724" (only present for reason = "success")
       }
     }
@@ -43,6 +44,10 @@ payload.targetBuildId
 -----------------------
 The Firefox build id the browser is updating to. Follows the same format as application.buildId (only valid for pings with reason "ready").
 
+payload.targetDisplayVersion
+----------------------------
+The Firefox display version the browser is updating to. This may contain a different value than ``targetVersion``, e.g. for the ``Beta`` channel this field will report the beta suffix while ``targetVersion`` will only report the version number.
+
 payload.previousChannel
 -----------------------
 The Firefox channel the profile was on before the update was applied (only valid for pings with reason "success").

toolkit/mozapps/update/tests/browser/browser_TelemetryUpdatePing.js

@@ -58,7 +58,7 @@ add_task(async function testUpdatePingReady() {
 
   // We don't know the exact value for the other fields, so just check
   // that they're available.
-  for (let f of ["targetVersion", "targetChannel"]) {
+  for (let f of ["targetVersion", "targetChannel", "targetDisplayVersion"]) {
     ok(f in updatePing.payload,
        `${f} must be available in the update ping payload.`);
     ok(typeof(updatePing.payload[f]) == "string",