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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glean-parser
-Version: 18.2.0
+Version: 19.0.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
@@ -34,7 +34,7 @@ Parser tools for Mozilla's Glean telemetry.
 
 Contains various utilities for handling `metrics.yaml` and `pings.yaml` for [the
 Glean SDKs](https://mozilla.github.io/glean). This includes producing generated
-code for various integrations, linting and coverage testing.
+code for various integrations and linting.
 
 ## Documentation
 

{glean_parser-18.2.0 → glean_parser-19.0.0}/README.md

@@ -6,7 +6,7 @@ Parser tools for Mozilla's Glean telemetry.
 
 Contains various utilities for handling `metrics.yaml` and `pings.yaml` for [the
 Glean SDKs](https://mozilla.github.io/glean). This includes producing generated
-code for various integrations, linting and coverage testing.
+code for various integrations and linting.
 
 ## Documentation
 

{glean_parser-18.2.0 → glean_parser-19.0.0}/glean_parser/__main__.py

@@ -18,7 +18,6 @@ import json
 import glean_parser
 
 
-from . import coverage as mod_coverage
 from . import data_review as mod_data_review
 from . import lint
 from . import translate as mod_translate
@@ -172,7 +171,9 @@ def check(schema):
     type=click.INT,
     required=False,
 )
-def glinter(input, allow_reserved, allow_missing_files, require_tags, expire_by_version):
+def glinter(
+    input, allow_reserved, allow_missing_files, require_tags, expire_by_version
+):
     """
     Runs a linter over the metrics.
     """
@@ -250,57 +251,6 @@ def dump(input, allow_reserved, allow_missing_files, require_tags):
     )
 
 
-@click.command()
-@click.option(
-    "-c",
-    "--coverage_file",
-    type=click.Path(exists=True, dir_okay=False, file_okay=True, readable=True),
-    required=True,
-    multiple=True,
-)
-@click.argument(
-    "metrics_files",
-    type=click.Path(exists=True, dir_okay=False, file_okay=True, readable=True),
-    nargs=-1,
-)
-@click.option(
-    "-o",
-    "--output",
-    type=click.Path(exists=False, dir_okay=False, file_okay=True, writable=True),
-    required=True,
-)
-@click.option(
-    "--format",
-    "-f",
-    type=click.Choice(list(mod_coverage.OUTPUTTERS.keys())),
-    required=True,
-)
-@click.option(
-    "--allow-reserved",
-    is_flag=True,
-    help=(
-        "If provided, allow the use of reserved fields. "
-        "Should only be set when building the Glean library itself."
-    ),
-)
-def coverage(coverage_file, metrics_files, format, output, allow_reserved):
-    """
-    Produce a coverage analysis file given raw coverage output and a set of
-    metrics.yaml files.
-    """
-    sys.exit(
-        mod_coverage.coverage(
-            [Path(x) for x in coverage_file],
-            [Path(x) for x in metrics_files],
-            format,
-            Path(output),
-            {
-                "allow_reserved": allow_reserved,
-            },
-        )
-    )
-
-
 @click.command()
 @click.argument("bug", type=str)
 @click.argument(
@@ -334,7 +284,6 @@ main.add_command(translate)
 main.add_command(check)
 main.add_command(glinter)
 main.add_command(dump)
-main.add_command(coverage)
 main.add_command(data_review_request, "data-review")
 
 

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

@@ -32,7 +32,14 @@ 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", "string_list"]
+SUPPORTED_METRIC_TYPES = [
+    "string",
+    "quantity",
+    "event",
+    "datetime",
+    "boolean",
+    "string_list",
+]
 
 
 def generate_ping_type_name(ping_name: str) -> str:

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

@@ -35,7 +35,7 @@ NitGenerator = Generator["GlinterNit", None, None]
 
 
 def noop(*args):
-    """ A noop `LintGenerator`. Never yields a GlinterNit."""
+    """A noop `LintGenerator`. Never yields a GlinterNit."""
     return
     yield
 
@@ -307,8 +307,12 @@ def check_event_on_non_events_ping(
     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]):
+    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."
@@ -709,7 +713,11 @@ def lint_metrics(
 
             for check_name, (check_func, check_type) in METRIC_CHECKS.items():
                 new_nits = list(check_func(metric, parser_config))
-                if check_unused_lints and check_name in metric.no_lint and not len(new_nits):
+                if (
+                    check_unused_lints
+                    and check_name in metric.no_lint
+                    and not len(new_nits)
+                ):
                     nits.append(
                         GlinterNit(
                             "UNUSED_NO_LINT",

{glean_parser-18.2.0 → glean_parser-19.0.0}/glean_parser/schemas/metrics.2-0-0.schema.yaml

@@ -254,7 +254,7 @@ definitions:
 
           A list of bug URLs (e.g. Bugzilla and Github) that are relevant to
           this metric, e.g., tracking its original implementation or later
-          changes to it.
+          changes to it, including renewals.
 
           Prior to version 2.0.0 of the schema, bugs could also be integers.
         type: array
@@ -268,7 +268,8 @@ definitions:
         description: |
           **Required.**
 
-          A list of URIs to any data collection reviews relevant to the metric.
+          A list of URLs to any data collection reviews relevant to the metric.
+          This should also include links to data reviews for renewals.
         type: array
         items:
           type: string

{glean_parser-18.2.0 → glean_parser-19.0.0}/glean_parser/schemas/pings.2-0-0.schema.yaml

@@ -168,7 +168,7 @@ additionalProperties:
         ping, e.g., tracking its original implementation or later changes to
         it.
 
-        It must be a URI to a bug page in a tracker.
+        It must be a URL to a bug page in a tracker.
 
         Prior to version 2.0.0 of the schema, bugs could also be integers.
       type: array
@@ -182,7 +182,7 @@ additionalProperties:
       description: |
         **Required.**
 
-        A list of URIs to any data collection reviews relevant to the ping.
+        A list of URLs to any data collection reviews relevant to the ping.
       type: array
       items:
         type: string

{glean_parser-18.2.0 → glean_parser-19.0.0}/glean_parser/templates/go_server.jinja2

@@ -187,7 +187,7 @@ func newGleanEvent(category, name string, extra map[string]string) gleanEvent {
     return gleanEvent{
         Category:  category,
         Name:      name,
-        Timestamp: time.Now().UnixMilli(),
+        Timestamp: 0,
         Extra: extra,
     }
 }

{glean_parser-18.2.0 → glean_parser-19.0.0}/glean_parser/templates/javascript_server.jinja2

@@ -126,7 +126,7 @@ class {{ ping|event_class_name(metrics_by_type) }} {
     const now = new Date();
     const timestamp = now.toISOString();
     {% if 'event' in metrics_by_type %}
-    event.timestamp = now.getTime();
+    event.timestamp = 0;
     {% endif %}
     const eventPayload = {
       metrics: {

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

@@ -35,29 +35,34 @@ class {{ ping|camelize }}ServerEventLogger:
 
     def record(
         self,
-        user_agent: str,
-        ip_address: str,
+        user_agent: str | None = None,
+        ip_address: str | None = None,
         {% for metric_type, metrics in metrics_by_type.items() %}
         {% if metric_type != 'event' %}
         {% for metric in metrics %}
-        {{ metric.category }}_{{ metric.name }}: {{ metric.type|py_metric_type }},
+        {{ metric.category }}_{{ metric.name }}: {{ metric.type|py_metric_type }} | None = None,
         {% endfor %}
         {% endif %}
         {% endfor %}
-        events: list[dict[str, Any]]
+        events: list[dict[str, Any]] | None = None,
     ) -> None:
         now = datetime.now(timezone.utc)
         timestamp = now.isoformat()
+        events = [] if events is None else events
         for event in events:
-            event["timestamp"] = int(1000.0 * now.timestamp())  # Milliseconds since epoch
+            event["timestamp"] = 0
         event_payload = {
             "metrics": {
                 {% for metric_type, metrics in metrics_by_type.items() %}
                 {% if metric_type != 'event' %}
                 "{{ metric_type }}": {
-                    {% for metric in metrics %}
-                    "{{ metric.category }}.{{ metric.name }}": {{ metric.category }}_{{ metric.name }},
-                    {% endfor %}
+                    key: value
+                    for key, value in [
+                        {% for metric in metrics %}
+                        ("{{ metric.category }}.{{ metric.name }}", {{ metric.category }}_{{ metric.name }}),
+                        {% endfor %}
+                    ]
+                    if value is not None
                 },
                 {% endif %}
                 {% endfor %}
@@ -117,17 +122,17 @@ class {{ ping|camelize }}ServerEventLogger:
     {% for event in metrics_by_type["event"] %}
     def {{ event|record_event_function_name }}(
         self,
-        user_agent: str,
-        ip_address: str,
+        user_agent: str | None = None,
+        ip_address: str | None = None,
         {% for metric_type, metrics in metrics_by_type.items() %}
         {% if metric_type != 'event' %}
         {% for metric in metrics %}
-        {{ metric.category }}_{{ metric.name }}: {{ metric.type|py_metric_type }},
+        {{ metric.category }}_{{ metric.name }}: {{ metric.type|py_metric_type }} | None = None,
         {% endfor %}
         {% endif %}
         {% endfor %}
         {% for extra, metadata in event.extra_keys.items() %}
-        {{ extra }}: {{ metadata.type|py_metric_type }},
+        {{ extra }}: {{ metadata.type|py_metric_type }} | None = None,
         {% endfor %}
     ) -> None:
         """
@@ -156,9 +161,13 @@ class {{ ping|camelize }}ServerEventLogger:
             "name": "{{ event.name }}",
             {% if event.extra_keys %}
             "extra": {
-                {% for extra, metadata in event.extra_keys.items() %}
-                "{{ extra }}": str({{ extra }}){% if 'bool' == metadata.type|py_metric_type %}.lower(){% endif %},
-                {% endfor %}
+                key: value
+                for key, value in [
+                    {% for extra, metadata in event.extra_keys.items() %}
+                    ("{{ extra }}", str({{ extra }}){% if 'bool' == metadata.type|py_metric_type %}.lower(){% endif %}),
+                    {% endfor %}
+                ]
+                if value is not None
             },
             {% endif %}
         }

{glean_parser-18.2.0 → glean_parser-19.0.0}/glean_parser/templates/ruby_server.jinja2

@@ -152,7 +152,7 @@ module Glean
         {
           'category' => '{{ event.category }}',
           'name' => '{{ event.name }}',
-          'timestamp' => (Time.now.utc.to_f * 1000).to_i,
+          'timestamp' => 0,
           'extra' => [
             {% for extra, metadata in event.extra_keys.items() %}
             ['{{ extra }}', {{ extra }}.to_s],

{glean_parser-18.2.0 → glean_parser-19.0.0}/glean_parser/templates/rust_server.jinja2

@@ -108,7 +108,7 @@ pub fn new_glean_event(
     GleanEvent {
         category: category.to_owned(),
         name: name.to_owned(),
-        timestamp: Utc::now().timestamp_millis(),
+        timestamp: 0,
         extra,
     }
 }
@@ -227,7 +227,7 @@ impl {{ ping|ping_events_type_name }} for {{ event|event_type_name }} {
     /// Create a GleanEvent for the above-defined Event struct ({{ event|event_type_name }}).
     /// Any metadata `extra` values are passed into the extra HashMap.
     fn glean_event(&self) -> GleanEvent {
-        // Any `extra_keys` will be output below to be inserted into `extra`. 
+        // Any `extra_keys` will be output below to be inserted into `extra`.
         // If there are none, an empty, immutable HashMap is created.
         {% if event.extra_keys.items()|length == 0 %}
         let extra: HashMap<String, String> = HashMap::new();
@@ -323,7 +323,7 @@ impl GleanEventsLogger {
         if let Some(event) = &params.event {
             events.push(event.glean_event());
         }
-        
+
         {% else %}
         let events: Vec<GleanEvent> = Vec::new();
         {% endif %}

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

@@ -50,7 +50,9 @@ def pytest_collection_modifyitems(config, items):
     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()
+        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:

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

@@ -183,7 +183,7 @@ func newGleanEvent(category, name string, extra map[string]string) gleanEvent {
     return gleanEvent{
         Category:  category,
         Name:      name,
-        Timestamp: time.Now().UnixMilli(),
+        Timestamp: 0,
         Extra: extra,
     }
 }

{glean_parser-18.2.0 → glean_parser-19.0.0}/tests/data/server_custom_ping_only_compare.rs

@@ -107,7 +107,7 @@ pub fn new_glean_event(
     GleanEvent {
         category: category.to_owned(),
         name: name.to_owned(),
-        timestamp: Utc::now().timestamp_millis(),
+        timestamp: 0,
         extra,
     }
 }
@@ -217,7 +217,7 @@ impl ServerTelemetryScenarioOnePingEvent for BackendSpecialEventEvent {
     /// Create a GleanEvent for the above-defined Event struct (BackendSpecialEventEvent).
     /// Any metadata `extra` values are passed into the extra HashMap.
     fn glean_event(&self) -> GleanEvent {
-        // Any `extra_keys` will be output below to be inserted into `extra`. 
+        // Any `extra_keys` will be output below to be inserted into `extra`.
         // If there are none, an empty, immutable HashMap is created.
         let mut extra: HashMap<String, String> = HashMap::new();
 
@@ -295,7 +295,7 @@ impl GleanEventsLogger {
         if let Some(event) = &params.event {
             events.push(event.glean_event());
         }
-        
+
         self.record("server-telemetry-scenario-one", request_info, metrics, events);
     }
 }

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

@@ -183,7 +183,7 @@ func newGleanEvent(category, name string, extra map[string]string) gleanEvent {
     return gleanEvent{
         Category:  category,
         Name:      name,
-        Timestamp: time.Now().UnixMilli(),
+        Timestamp: 0,
         Extra: extra,
     }
 }

{glean_parser-18.2.0 → glean_parser-19.0.0}/tests/data/server_events_and_custom_ping_compare.rs

@@ -107,7 +107,7 @@ pub fn new_glean_event(
     GleanEvent {
         category: category.to_owned(),
         name: name.to_owned(),
-        timestamp: Utc::now().timestamp_millis(),
+        timestamp: 0,
         extra,
     }
 }
@@ -217,7 +217,7 @@ impl EventsPingEvent for BackendTestEventEvent {
     /// Create a GleanEvent for the above-defined Event struct (BackendTestEventEvent).
     /// Any metadata `extra` values are passed into the extra HashMap.
     fn glean_event(&self) -> GleanEvent {
-        // Any `extra_keys` will be output below to be inserted into `extra`. 
+        // Any `extra_keys` will be output below to be inserted into `extra`.
         // If there are none, an empty, immutable HashMap is created.
         let mut extra: HashMap<String, String> = HashMap::new();
 
@@ -295,7 +295,7 @@ impl GleanEventsLogger {
         if let Some(event) = &params.event {
             events.push(event.glean_event());
         }
-        
+
         self.record("events", request_info, metrics, events);
     }
 }

{glean_parser-18.2.0 → glean_parser-19.0.0}/tests/data/server_events_compare.rb

@@ -115,7 +115,7 @@ module Glean
         {{
           'category' => 'backend',
           'name' => 'object_update',
-          'timestamp' => (Time.now.utc.to_f * 1000).to_i,
+          'timestamp' => 0,
           'extra' => [
             ['object_type', object_type.to_s],
             ['object_state', object_state.to_s],

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

@@ -183,7 +183,7 @@ func newGleanEvent(category, name string, extra map[string]string) gleanEvent {
     return gleanEvent{
         Category:  category,
         Name:      name,
-        Timestamp: time.Now().UnixMilli(),
+        Timestamp: 0,
         Extra: extra,
     }
 }

{glean_parser-18.2.0 → glean_parser-19.0.0}/tests/data/server_events_only_compare.rs

@@ -107,7 +107,7 @@ pub fn new_glean_event(
     GleanEvent {
         category: category.to_owned(),
         name: name.to_owned(),
-        timestamp: Utc::now().timestamp_millis(),
+        timestamp: 0,
         extra,
     }
 }
@@ -217,7 +217,7 @@ impl EventsPingEvent for BackendTestEventEvent {
     /// Create a GleanEvent for the above-defined Event struct (BackendTestEventEvent).
     /// Any metadata `extra` values are passed into the extra HashMap.
     fn glean_event(&self) -> GleanEvent {
-        // Any `extra_keys` will be output below to be inserted into `extra`. 
+        // Any `extra_keys` will be output below to be inserted into `extra`.
         // If there are none, an empty, immutable HashMap is created.
         let mut extra: HashMap<String, String> = HashMap::new();
 
@@ -295,7 +295,7 @@ impl GleanEventsLogger {
         if let Some(event) = &params.event {
             events.push(event.glean_event());
         }
-        
+
         self.record("events", request_info, metrics, events);
     }
 }

{glean_parser-18.2.0 → glean_parser-19.0.0}/tests/test-py/test.py

@@ -15,3 +15,7 @@ logger.record_backend_object_update(
     object_state="some_object_state",
     linking=True,
 )
+
+logger.record_backend_object_update()
+
+logger.record()

{glean_parser-18.2.0 → glean_parser-19.0.0}/tests/test_kotlin.py

@@ -334,9 +334,9 @@ def test_event_extra_keys_with_types(tmp_path):
         assert (
             'allowedExtraKeys = listOf("enabled", "preference", "swapped")' in content
         )
-        assert "map.put(\"enabled\", it.toString())" in content
-        assert "map.put(\"preference\", it)" in content
-        assert "map.put(\"swapped\", it.toString())" in content
+        assert 'map.put("enabled", it.toString())' in content
+        assert 'map.put("preference", it)' in content
+        assert 'map.put("swapped", it.toString())' in content
 
 
 def test_reasons(tmp_path):

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

@@ -774,7 +774,11 @@ def test_events_data_sensitivity_from_file():
                 "too_many_no_lints": {
                     "type": "counter",
                     "expires": "2100-01-01",
-                    "no_lint": ["EXPIRATION_DATE_TOO_FAR", "UNIT_IN_NAME", "UNUSED_NO_LINT"],
+                    "no_lint": [
+                        "EXPIRATION_DATE_TOO_FAR",
+                        "UNIT_IN_NAME",
+                        "UNUSED_NO_LINT",
+                    ],
                 }
             },
             0,
@@ -812,9 +816,8 @@ def test_unused_no_lint_warning(content, num_nits):
     nits = lint.lint_metrics(all_metrics.value)
     assert len(nits) == num_nits
     if num_nits > 0:
-        assert set(["UNUSED_NO_LINT"]) == set(
-            v.check_name for v in nits
-        )
+        assert set(["UNUSED_NO_LINT"]) == set(v.check_name for v in nits)
+
 
 @pytest.mark.parametrize(
     "content,num_nits",
@@ -824,7 +827,11 @@ def test_unused_no_lint_warning(content, num_nits):
                 "unknown_lint": {
                     "type": "counter",
                     "expires": "2100-01-01",
-                    "no_lint": ["EXPIRATION_DATE_TOO_FAR", "DOES_NOT_EXIST", "UNKNOWN_LINT"],
+                    "no_lint": [
+                        "EXPIRATION_DATE_TOO_FAR",
+                        "DOES_NOT_EXIST",
+                        "UNKNOWN_LINT",
+                    ],
                 }
             },
             0,
@@ -872,9 +879,7 @@ def test_unknown_lint_warning(content, num_nits):
     nits = lint.lint_metrics(all_metrics.value)
     assert len(nits) == num_nits
     if num_nits > 0:
-        assert set(["UNKNOWN_LINT"]) == set(
-            v.check_name for v in nits
-        )
+        assert set(["UNKNOWN_LINT"]) == set(v.check_name for v in nits)
 
 
 @pytest.mark.parametrize(
@@ -958,6 +963,4 @@ def test_events_on_metrics_ping(content, num_nits):
     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
-        )
+        assert set(["EVENT_ON_NON_EVENTS_PING"]) == set(v.check_name for v in nits)

{glean_parser-18.2.0 → glean_parser-19.0.0}/tests/test_parser.py

@@ -1299,28 +1299,40 @@ def test_object_invalid():
         (
             {
                 "type": "object",
-                "properties": {"key": {"type": "string"}, "value": {"oneOf": [ { "type": "object" } ]}},
+                "properties": {
+                    "key": {"type": "string"},
+                    "value": {"oneOf": [{"type": "object"}]},
+                },
             },
             1,
         ),
         (
             {
                 "type": "object",
-                "properties": {"key": {"type": "string"}, "value": {"oneOf": [ { "type": "number", "other": "unsupported" } ]}},
+                "properties": {
+                    "key": {"type": "string"},
+                    "value": {"oneOf": [{"type": "number", "other": "unsupported"}]},
+                },
             },
             1,
         ),
         (
             {
                 "type": "object",
-                "properties": {"key": {"type": "string"}, "value": {"oneOf": [ { "type": "number" } ]}},
+                "properties": {
+                    "key": {"type": "string"},
+                    "value": {"oneOf": [{"type": "number"}]},
+                },
             },
             0,
         ),
         (
             {
                 "type": "object",
-                "properties": {"key": {"type": "string"}, "value": {"oneOf": [ { "type": "number", "description": "desc" } ]}},
+                "properties": {
+                    "key": {"type": "string"},
+                    "value": {"oneOf": [{"type": "number", "description": "desc"}]},
+                },
             },
             0,
         ),