From ec65bf7c3b3e5eb0852a325c9050c372c33527ec Mon Sep 17 00:00:00 2001
From: bwu <bewu@mozilla.com>
Date: Tue, 30 Jul 2024 11:39:03 -0400
Subject: [PATCH] Bug 1910462 - Add msstoresignedin to legacy telemetry
 environment

---
 schemas/telemetry/bhr/bhr.4.schema.json                      | 4 ++++
 schemas/telemetry/crash/crash.4.schema.json                  | 4 ++++
 .../telemetry/dnssec-study-v1/dnssec-study-v1.4.schema.json  | 4 ++++
 schemas/telemetry/event/event.4.schema.json                  | 4 ++++
 .../telemetry/first-shutdown/first-shutdown.4.schema.json    | 4 ++++
 schemas/telemetry/heartbeat/heartbeat.4.schema.json          | 4 ++++
 schemas/telemetry/main/main.4.schema.json                    | 4 ++++
 schemas/telemetry/modules/modules.4.schema.json              | 4 ++++
 schemas/telemetry/new-profile/new-profile.4.schema.json      | 4 ++++
 schemas/telemetry/saved-session/saved-session.4.schema.json  | 4 ++++
 schemas/telemetry/shield-icq-v1/shield-icq-v1.4.schema.json  | 4 ++++
 schemas/telemetry/testpilot/testpilot.4.schema.json          | 4 ++++
 .../third-party-modules/third-party-modules.4.schema.json    | 4 ++++
 schemas/telemetry/uninstall/uninstall.4.schema.json          | 4 ++++
 .../untrusted-modules/untrusted-modules.4.schema.json        | 4 ++++
 schemas/telemetry/update/update.4.schema.json                | 4 ++++
 schemas/telemetry/voice/voice.4.schema.json                  | 4 ++++
 templates/include/telemetry/environment.1.schema.json        | 4 ++++
 validation/telemetry/event.4.sample.pass.json                | 5 ++++-
 19 files changed, 76 insertions(+), 1 deletion(-)

diff --git a/schemas/telemetry/bhr/bhr.4.schema.json b/schemas/telemetry/bhr/bhr.4.schema.json
index 315d89bf0..d82e27b6d 100644
--- a/schemas/telemetry/bhr/bhr.4.schema.json
+++ b/schemas/telemetry/bhr/bhr.4.schema.json
@@ -529,6 +529,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/crash/crash.4.schema.json b/schemas/telemetry/crash/crash.4.schema.json
index 35a7c29d2..f128f95ca 100644
--- a/schemas/telemetry/crash/crash.4.schema.json
+++ b/schemas/telemetry/crash/crash.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/dnssec-study-v1/dnssec-study-v1.4.schema.json b/schemas/telemetry/dnssec-study-v1/dnssec-study-v1.4.schema.json
index 424aae73b..f43b7469f 100644
--- a/schemas/telemetry/dnssec-study-v1/dnssec-study-v1.4.schema.json
+++ b/schemas/telemetry/dnssec-study-v1/dnssec-study-v1.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/event/event.4.schema.json b/schemas/telemetry/event/event.4.schema.json
index c15427b73..d77733ad0 100644
--- a/schemas/telemetry/event/event.4.schema.json
+++ b/schemas/telemetry/event/event.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/first-shutdown/first-shutdown.4.schema.json b/schemas/telemetry/first-shutdown/first-shutdown.4.schema.json
index 1fef744ed..f85b32a5b 100644
--- a/schemas/telemetry/first-shutdown/first-shutdown.4.schema.json
+++ b/schemas/telemetry/first-shutdown/first-shutdown.4.schema.json
@@ -542,6 +542,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/heartbeat/heartbeat.4.schema.json b/schemas/telemetry/heartbeat/heartbeat.4.schema.json
index b2f7d1838..3f8bffd64 100644
--- a/schemas/telemetry/heartbeat/heartbeat.4.schema.json
+++ b/schemas/telemetry/heartbeat/heartbeat.4.schema.json
@@ -536,6 +536,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/main/main.4.schema.json b/schemas/telemetry/main/main.4.schema.json
index 32569991c..05de09c79 100644
--- a/schemas/telemetry/main/main.4.schema.json
+++ b/schemas/telemetry/main/main.4.schema.json
@@ -542,6 +542,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/modules/modules.4.schema.json b/schemas/telemetry/modules/modules.4.schema.json
index 0a6045a71..ed155f8a2 100644
--- a/schemas/telemetry/modules/modules.4.schema.json
+++ b/schemas/telemetry/modules/modules.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/new-profile/new-profile.4.schema.json b/schemas/telemetry/new-profile/new-profile.4.schema.json
index 682e0a251..81c3c2edf 100644
--- a/schemas/telemetry/new-profile/new-profile.4.schema.json
+++ b/schemas/telemetry/new-profile/new-profile.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/saved-session/saved-session.4.schema.json b/schemas/telemetry/saved-session/saved-session.4.schema.json
index 9d57bbf54..6c7cf2c55 100644
--- a/schemas/telemetry/saved-session/saved-session.4.schema.json
+++ b/schemas/telemetry/saved-session/saved-session.4.schema.json
@@ -542,6 +542,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/shield-icq-v1/shield-icq-v1.4.schema.json b/schemas/telemetry/shield-icq-v1/shield-icq-v1.4.schema.json
index e0bed7739..2b4b80449 100644
--- a/schemas/telemetry/shield-icq-v1/shield-icq-v1.4.schema.json
+++ b/schemas/telemetry/shield-icq-v1/shield-icq-v1.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/testpilot/testpilot.4.schema.json b/schemas/telemetry/testpilot/testpilot.4.schema.json
index b213b9cf4..2e3af6134 100644
--- a/schemas/telemetry/testpilot/testpilot.4.schema.json
+++ b/schemas/telemetry/testpilot/testpilot.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/third-party-modules/third-party-modules.4.schema.json b/schemas/telemetry/third-party-modules/third-party-modules.4.schema.json
index a3cfa20aa..b6c9b904d 100644
--- a/schemas/telemetry/third-party-modules/third-party-modules.4.schema.json
+++ b/schemas/telemetry/third-party-modules/third-party-modules.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/uninstall/uninstall.4.schema.json b/schemas/telemetry/uninstall/uninstall.4.schema.json
index 593a0f407..a42c50c83 100644
--- a/schemas/telemetry/uninstall/uninstall.4.schema.json
+++ b/schemas/telemetry/uninstall/uninstall.4.schema.json
@@ -529,6 +529,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/untrusted-modules/untrusted-modules.4.schema.json b/schemas/telemetry/untrusted-modules/untrusted-modules.4.schema.json
index 4cae63ba9..3b891a37a 100644
--- a/schemas/telemetry/untrusted-modules/untrusted-modules.4.schema.json
+++ b/schemas/telemetry/untrusted-modules/untrusted-modules.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/update/update.4.schema.json b/schemas/telemetry/update/update.4.schema.json
index d63a94f3c..0616c484e 100644
--- a/schemas/telemetry/update/update.4.schema.json
+++ b/schemas/telemetry/update/update.4.schema.json
@@ -525,6 +525,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/schemas/telemetry/voice/voice.4.schema.json b/schemas/telemetry/voice/voice.4.schema.json
index 59679d60c..0acc99b7a 100644
--- a/schemas/telemetry/voice/voice.4.schema.json
+++ b/schemas/telemetry/voice/voice.4.schema.json
@@ -528,6 +528,10 @@
                   "description": "Category of the source, such as 'organic' for a search engine.",
                   "type": "string"
                 },
+                "msstoresignedin": {
+                  "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise.",
+                  "type": "boolean"
+                },
                 "source": {
                   "description": "Referring partner domain, when install happens via a known partner.",
                   "type": "string"
diff --git a/templates/include/telemetry/environment.1.schema.json b/templates/include/telemetry/environment.1.schema.json
index b6bd2021a..356ae0546 100644
--- a/templates/include/telemetry/environment.1.schema.json
+++ b/templates/include/telemetry/environment.1.schema.json
@@ -465,6 +465,10 @@
             "dlsource": {
               "type": "string",
               "description": "Identifier that indicates where installations of Firefox originate, see bug 1827233"
+            },
+            "msstoresignedin": {
+              "type": "boolean",
+              "description": " Optional, only present if the installation was done through the Microsoft Store, and was able to retrieve the \"campaign ID\" it was first installed with. This value is \"true\" if the user was signed into the Microsoft Store when they first installed, and false otherwise."
             }
           }
         },
diff --git a/validation/telemetry/event.4.sample.pass.json b/validation/telemetry/event.4.sample.pass.json
index 7d47b9056..910fce74b 100644
--- a/validation/telemetry/event.4.sample.pass.json
+++ b/validation/telemetry/event.4.sample.pass.json
@@ -195,7 +195,10 @@
         "origin": "default",
         "submissionURL": "https://www.google.com/search?q=&ie=utf-8&oe=utf-8&client=firefox-b"
       },
-      "searchCohort": "nov17-2"
+      "searchCohort": "nov17-2",
+      "attribution": {
+        "msstoresignedin": false
+      }
     },
     "profile": {
       "creationDate": 17660