Bug 1889114 - Add 'enabled' property to pings

This is enabled initially for Swift, Kotlin, and Rust
mozilla · Apr 2, 2024 · 6739957 · 6739957
1 parent be54910
commit 6739957
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/glean_parser/pings.py b/glean_parser/pings.py
@@ -31,6 +31,7 @@ def __init__(
         reasons: Optional[Dict[str, str]] = None,
         defined_in: Optional[Dict] = None,
         no_lint: Optional[List[str]] = None,
+        enabled: Optional[bool] = True,
         _validated: bool = False,
     ):
         # Avoid cyclical import
@@ -46,6 +47,7 @@ def __init__(
         self.metadata = metadata
         self.precise_timestamps = self.metadata.get("precise_timestamps", True)
         self.include_info_sections = self.metadata.get("include_info_sections", True)
+        self.enabled = enabled
         if data_reviews is None:
             data_reviews = []
         self.data_reviews = data_reviews

diff --git a/glean_parser/schemas/pings.2-0-0.schema.yaml b/glean_parser/schemas/pings.2-0-0.schema.yaml
@@ -175,6 +175,14 @@ additionalProperties:
       additionalProperties:
         type: string
 
+    enabled:
+      title: Whether or not this ping is enabled
+      description: |
+        When `true`, the ping will be sent as usual.
+        When `false`, the ping will not be sent, but the data will continue to
+        be collected but will not be cleared when the ping is submitted.
+      type: boolean
+
     no_lint:
       title: Lint checks to skip
       description: |

diff --git a/glean_parser/templates/rust.jinja2 b/glean_parser/templates/rust.jinja2
@@ -87,7 +87,7 @@ impl ExtraKeys for {{ obj.name|Camelize }}{{ suffix }} {
 /// {{ obj.description|wordwrap() | replace('\n', '\n/// ') }}
 #[rustfmt::skip]
 pub static {{ obj.name|snake_case }}: ::glean::private::__export::Lazy<::glean::private::PingType> =
-    ::glean::private::__export::Lazy::new(|| ::glean::private::PingType::new("{{ obj.name }}", {{ obj.include_client_id|rust }}, {{ obj.send_if_empty|rust }}, {{ obj.precise_timestamps|rust }}, {{ obj.include_info_sections|rust }}, {{ obj.reason_codes|rust }}));
+    ::glean::private::__export::Lazy::new(|| ::glean::private::PingType::new("{{ obj.name }}", {{ obj.include_client_id|rust }}, {{ obj.send_if_empty|rust }}, {{ obj.precise_timestamps|rust }}, {{ obj.include_info_sections|rust }}, {{ obj.reason_codes|rust }}, {{ obj.enabled|rust}}));
 {% endfor %}
 {% else %}
 pub mod {{ category.name|snake_case }} {

diff --git a/glean_parser/templates/swift.jinja2 b/glean_parser/templates/swift.jinja2
@@ -97,7 +97,8 @@ extension {{ namespace }} {
             sendIfEmpty: {{obj.send_if_empty|swift}},
             preciseTimestamps: {{obj.precise_timestamps|swift}},
             includeInfoSections: {{obj.include_info_sections|swift}},
-            reasonCodes: {{obj.reason_codes|swift}}
+            reasonCodes: {{obj.reason_codes|swift}},
+            enabled: {{obj.enabled|swift}}
         )
 
       {% endfor %}