glean-parser 18.1.0__tar.gz → 18.2.0__tar.gz

{glean_parser-18.1.0 → glean_parser-18.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glean-parser
-Version: 18.1.0
+Version: 18.2.0
 Summary: Parser tools for Mozilla's Glean telemetry
 Project-URL: Homepage, https://mozilla.github.io/glean
 Project-URL: Repository, https://github.com/mozilla/glean_parser

{glean_parser-18.1.0 → glean_parser-18.2.0}/glean_parser/go_server.py

@@ -32,7 +32,7 @@ from . import util
 
 # Adding a metric here will require updating the `generate_metric_type` function
 # and require adjustments to `metrics` variables the the template.
-SUPPORTED_METRIC_TYPES = ["string", "quantity", "event", "datetime", "boolean"]
+SUPPORTED_METRIC_TYPES = ["string", "quantity", "event", "datetime", "boolean", "string_list"]
 
 
 def generate_ping_type_name(ping_name: str) -> str:
@@ -68,6 +68,8 @@ def generate_metric_type(metric_type: str) -> str:
         return "bool"
     elif metric_type == "datetime":
         return "time.Time"
+    elif metric_type == "string_list":
+        return "[]string"
     else:
         print("❌ Unable to generate Go type from metric type: " + metric_type)
         exit

{glean_parser-18.1.0 → glean_parser-18.2.0}/glean_parser/lint.py

@@ -300,6 +300,21 @@ def check_metric_on_events_lifetime(
         )
 
 
+def check_event_on_non_events_ping(
+    metric: metrics.Metric, parser_config: Dict[str, Any]
+) -> LintGenerator:
+    """
+    An event metric should usually go on the `events` ping or a custom ping,
+    not on a builtin ping.
+    """
+    disallowed_pings = set(pings.RESERVED_PING_NAMES) - {"default", "events"} | {"health"}
+    if metric.type == "event" and any([ping in disallowed_pings for ping in metric.send_in_pings]):
+        yield (
+            "An event metric should usually go on the `events` ping or a custom ping, "
+            + "not on a builtin ping."
+        )
+
+
 def check_unexpected_unit(
     metric: metrics.Metric, parser_config: Dict[str, Any]
 ) -> LintGenerator:
@@ -466,6 +481,7 @@ METRIC_CHECKS: Dict[
     "EXPIRED": (check_expired_metric, CheckType.warning),
     "OLD_EVENT_API": (check_old_event_api, CheckType.warning),
     "METRIC_ON_EVENTS_LIFETIME": (check_metric_on_events_lifetime, CheckType.error),
+    "EVENT_ON_NON_EVENTS_PING": (check_event_on_non_events_ping, CheckType.warning),
     "UNEXPECTED_UNIT": (check_unexpected_unit, CheckType.warning),
     "EMPTY_DATAREVIEW": (check_empty_datareview, CheckType.warning),
     "HIGHER_DATA_SENSITIVITY_REQUIRED": (

{glean_parser-18.1.0 → glean_parser-18.2.0}/glean_parser/templates/python_server.jinja2

@@ -12,6 +12,7 @@ from datetime import datetime, timezone
 from typing import Any
 from uuid import uuid4
 import json
+import sys
 
 GLEAN_EVENT_MOZLOG_TYPE = "glean-server-event"
 
@@ -111,7 +112,7 @@ class {{ ping|camelize }}ServerEventLogger:
         }
         ping_envelope_serialized = json.dumps(ping_envelope)
 
-        print(ping_envelope_serialized)
+        sys.stdout.write(f"{ping_envelope_serialized}\n")
 
     {% for event in metrics_by_type["event"] %}
     def {{ event|record_event_function_name }}(
@@ -132,7 +133,7 @@ class {{ ping|camelize }}ServerEventLogger:
         """
         Record and submit a {{ event.category }}_{{ event.name }} event:
         {{ event.description|clean_string }}
-        Event is logged to STDOUT via `print`.
+        Event is logged to STDOUT via `sys.stdout.write`.
 
         :param str user_agent: The user agent.
         :param str ip_address: The IP address. Will be used to decode Geo information

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/conftest.py

@@ -1,4 +1,5 @@
 import pytest
+import subprocess
 
 
 def pytest_addoption(parser):
@@ -46,6 +47,17 @@ def pytest_collection_modifyitems(config, items):
         for item in items:
             if "node_dependency" in item.keywords:
                 item.add_marker(skip_node)
+    else:
+        # Node.js removed some deprecated items currently in use by dependencies of mozlog.
+        # We can't fix that.
+        node_version = subprocess.check_output(["node", "--version"]).decode("utf-8").strip()
+        major_version = int(node_version[1:].split(".")[0])
+        print(f"jer. {node_version=}, {major_version=}")
+        if major_version >= 24:
+            skip_node = pytest.mark.skip(reason="Node.js < v24 required")
+            for item in items:
+                if "node_dependency" in item.keywords:
+                    item.add_marker(skip_node)
 
     if not config.getoption("--run-ruby-tests"):
         skip_ruby = pytest.mark.skip(reason="Need --run-ruby-tests option to run")

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/data/go_server_custom_ping_only_metrics.yaml

@@ -66,6 +66,21 @@ metric:
       - TBD
     expires: never
 
+  request_string_list:
+    type: string_list
+    description: >
+      Test string_list metric
+    lifetime: application
+    send_in_pings:
+      - server-telemetry-scenario-one
+    notification_emails:
+      - CHANGE-ME@example.com
+    bugs:
+      - TBD
+    data_reviews:
+      - TBD
+    expires: never
+
 backend:
   special_event:
     type: event

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/data/go_server_events_and_custom_ping_metrics.yaml

@@ -70,6 +70,22 @@ metric:
       - TBD
     expires: never
 
+  request_string_list:
+    type: string_list
+    description: >
+      Test string_list metric
+    lifetime: application
+    send_in_pings:
+      - events
+      - server-telemetry-scenario-one
+    notification_emails:
+      - CHANGE-ME@example.com
+    bugs:
+      - TBD
+    data_reviews:
+      - TBD
+    expires: never
+
 backend:
   test_event:
     type: event

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/data/go_server_events_only_metrics.yaml

@@ -66,6 +66,21 @@ metric:
       - TBD
     expires: never
 
+  request_string_list:
+    type: string_list
+    description: >
+      Test string_list metric
+    lifetime: application
+    send_in_pings:
+      - events
+    notification_emails:
+      - CHANGE-ME@example.com
+    bugs:
+      - TBD
+    data_reviews:
+      - TBD
+    expires: never
+
 backend:
   test_event:
     type: event

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/data/go_server_metrics_unsupported.yaml

@@ -60,21 +60,6 @@ metric:
           attribute_two:
             type: number
 
-  string_list:
-    type: string_list
-    description: >
-      string list
-    bugs:
-      - TBD
-    data_reviews:
-      - TBD
-    notification_emails:
-      - CHANGE-ME@example.com
-    lifetime: application
-    expires: never
-    send_in_pings:
-      - events
-
   timespan:
     type: timespan
     description: >

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/data/server_custom_ping_only_compare.go

@@ -218,6 +218,7 @@ type ServerTelemetryScenarioOnePing struct {
     MetricRequestBool bool // boolean
     MetricRequestCount int64 // Test quantity metric
     MetricRequestDatetime time.Time // Test datetime metric
+    MetricRequestStringList []string // Test string_list metric
     Event ServerTelemetryScenarioOnePingEvent // valid event for this ping
 }
 
@@ -239,6 +240,9 @@ func (g GleanEventsLogger) RecordServerTelemetryScenarioOnePing(
         "datetime": {
             "metric.request_datetime": params.MetricRequestDatetime.Format("2006-01-02T15:04:05.000Z"),
         },
+        "string_list": {
+            "metric.request_string_list": params.MetricRequestStringList,
+        },
     }
 
     events := []gleanEvent{}

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/data/server_events_and_custom_ping_compare.go

@@ -218,6 +218,7 @@ type EventsPing struct {
     MetricRequestBool bool // boolean
     MetricRequestCount int64 // Test quantity metric
     MetricRequestDatetime time.Time // Test datetime metric
+    MetricRequestStringList []string // Test string_list metric
     Event EventsPingEvent // valid event for this ping
 }
 
@@ -239,6 +240,9 @@ func (g GleanEventsLogger) RecordEventsPing(
         "datetime": {
             "metric.request_datetime": params.MetricRequestDatetime.Format("2006-01-02T15:04:05.000Z"),
         },
+        "string_list": {
+            "metric.request_string_list": params.MetricRequestStringList,
+        },
     }
 
     events := []gleanEvent{}
@@ -260,6 +264,7 @@ type ServerTelemetryScenarioOnePing struct {
     MetricRequestBool bool // boolean
     MetricRequestCount int64 // Test quantity metric
     MetricRequestDatetime time.Time // Test datetime metric
+    MetricRequestStringList []string // Test string_list metric
 }
 
 // Record and submit `server-telemetry-scenario-one` ping
@@ -280,6 +285,9 @@ func (g GleanEventsLogger) RecordServerTelemetryScenarioOnePing(
         "datetime": {
             "metric.request_datetime": params.MetricRequestDatetime.Format("2006-01-02T15:04:05.000Z"),
         },
+        "string_list": {
+            "metric.request_string_list": params.MetricRequestStringList,
+        },
     }
 
     events := []gleanEvent{}

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/data/server_events_only_compare.go

@@ -218,6 +218,7 @@ type EventsPing struct {
     MetricRequestBool bool // boolean
     MetricRequestCount int64 // Test quantity metric
     MetricRequestDatetime time.Time // Test datetime metric
+    MetricRequestStringList []string // Test string_list metric
     Event EventsPingEvent // valid event for this ping
 }
 
@@ -239,6 +240,9 @@ func (g GleanEventsLogger) RecordEventsPing(
         "datetime": {
             "metric.request_datetime": params.MetricRequestDatetime.Format("2006-01-02T15:04:05.000Z"),
         },
+        "string_list": {
+            "metric.request_string_list": params.MetricRequestStringList,
+        },
     }
 
     events := []gleanEvent{}

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/test_go_server.py

@@ -42,7 +42,6 @@ def test_parser_go_server_metrics_unsupported_type(tmp_path, capsys):
         "boolean",
         "labeled_boolean",
         "labeled_string",
-        "string_list",
         "timespan",
         "uuid",
         "url",
@@ -102,7 +101,7 @@ def test_parser_go_server_events_and_custom_ping(tmp_path):
     assert content == compare
 
 
-def test_parser_go_server_custon_ping_only(tmp_path):
+def test_parser_go_server_custom_ping_only(tmp_path):
     """Test that parser works for definitions that only use custom pings"""
     translate.translate(
         [
@@ -170,10 +169,11 @@ def test_run_logging_events_ping(tmp_path):
             IpAddress: "127.0.0.1",
         },
         glean.EventsPing{
-            MetricName:            "string value",
-            MetricRequestBool:     true,
-            MetricRequestCount:    10,
-            MetricRequestDatetime: time.Now(),
+            MetricName:              "string value",
+            MetricRequestBool:       true,
+            MetricRequestCount:      10,
+            MetricRequestDatetime:   time.Now(),
+            MetricRequestStringList: []string{"list", "of", "strings"},
             Event: glean.BackendTestEventEvent{
                 EventFieldString:      "event extra string value",
                 EventFieldQuantity:    100,
@@ -227,10 +227,11 @@ def test_run_logging_custom_ping_without_event(tmp_path):
             IpAddress: "127.0.0.1",
         },
         glean.ServerTelemetryScenarioOnePing{
-            MetricName:            "string value",
-            MetricRequestBool:     true,
-            MetricRequestCount:    20,
-            MetricRequestDatetime: time.Now(),
+            MetricName:             "string value",
+            MetricRequestBool:       true,
+            MetricRequestCount:      20,
+            MetricRequestDatetime:   time.Now(),
+            MetricRequestStringList: []string{"list", "of", "strings"},
         },
     )
     """
@@ -285,10 +286,11 @@ def test_run_logging_discard_writer(tmp_path):
             IpAddress: "127.0.0.1",
         },
         glean.ServerTelemetryScenarioOnePing{
-            MetricName:            "string value",
-            MetricRequestBool:     true,
-            MetricRequestCount:    20,
-            MetricRequestDatetime: time.Now(),
+            MetricName:             "string value",
+            MetricRequestBool:       true,
+            MetricRequestCount:      20,
+            MetricRequestDatetime:   time.Now(),
+            MetricRequestStringList: []string{"list", "of", "strings"},
         },
     )
     if err != nil {
@@ -362,10 +364,11 @@ def test_run_logging_custom_ping_with_event(tmp_path):
             IpAddress: "127.0.0.1",
         },
         glean.ServerTelemetryScenarioOnePing{
-            MetricName:            "string value",
-            MetricRequestBool:     true,
-            MetricRequestCount:    20,
-            MetricRequestDatetime: time.Now(),
+            MetricName:              "string value",
+            MetricRequestBool:       true,
+            MetricRequestCount:      20,
+            MetricRequestDatetime:   time.Now(),
+            MetricRequestStringList: []string{"list", "of", "strings"},
             Event: glean.BackendSpecialEventEvent{
                 EventFieldString: "exta value string",
                 EventFieldQuantity: 30,

{glean_parser-18.1.0 → glean_parser-18.2.0}/tests/test_lint.py

@@ -875,3 +875,89 @@ def test_unknown_lint_warning(content, num_nits):
         assert set(["UNKNOWN_LINT"]) == set(
             v.check_name for v in nits
         )
+
+
+@pytest.mark.parametrize(
+    "content,num_nits",
+    [
+        (
+            {
+                "plain_event": {
+                    "type": "event",
+                }
+            },
+            0,
+        ),
+        (
+            {
+                "event_on_metrics": {
+                    "type": "event",
+                    "send_in_pings": ["metrics"],
+                }
+            },
+            1,
+        ),
+        (
+            {
+                "event_on_metrics_and_events": {
+                    "type": "event",
+                    "send_in_pings": ["metrics", "events"],
+                }
+            },
+            1,
+        ),
+        (
+            {
+                "event_on_baseline": {
+                    "type": "event",
+                    "send_in_pings": ["baseline"],
+                    "no_lint": ["BASELINE_PING"],
+                }
+            },
+            1,
+        ),
+        (
+            {
+                "event_on_baseline_and_metrics": {
+                    "type": "event",
+                    "send_in_pings": ["baseline", "metrics"],
+                    "no_lint": ["BASELINE_PING"],
+                }
+            },
+            1,
+        ),
+        (
+            {
+                "no_lint_events_on_metrics": {
+                    "type": "event",
+                    "send_in_pings": ["metrics", "events"],
+                    "no_lint": ["EVENT_ON_NON_EVENTS_PING"],
+                }
+            },
+            0,
+        ),
+        (
+            {
+                "default_ping": {
+                    "type": "event",
+                    "send_in_pings": ["default"],
+                }
+            },
+            0,
+        ),
+    ],
+)
+def test_events_on_metrics_ping(content, num_nits):
+    content = {"cat": content}
+    content = util.add_required(content)
+    all_metrics = parser.parse_objects(content)
+
+    errs = list(all_metrics)
+    assert len(errs) == 0
+
+    nits = lint.lint_metrics(all_metrics.value)
+    assert len(nits) == num_nits
+    if num_nits > 0:
+        assert set(["EVENT_ON_NON_EVENTS_PING"]) == set(
+            v.check_name for v in nits
+        )