glean-parser 14.3.0__tar.gz → 14.4.0__tar.gz

{glean_parser-14.3.0 → glean_parser-14.4.0}/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 14.4.0
+
+- Fix JS and Ruby server templates to correctly send event extra values as strings ([DENG-4405](https://mozilla-hub.atlassian.net/browse/DENG-4405))
+- ENHANCEMENT: Extra keys in `extra_keys:` fields may now contain any printable ASCII characters ([bug 1910976](https://bugzilla.mozilla.org/show_bug.cgi?id=1910976))
+
 ## 14.3.0
 
 - Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))

{glean_parser-14.3.0 → glean_parser-14.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: glean_parser
-Version: 14.3.0
+Version: 14.4.0
 Summary: Parser tools for Mozilla's Glean telemetry
 Home-page: https://github.com/mozilla/glean_parser
 Author: The Glean Team
@@ -79,6 +79,11 @@ $ glean_parser check < ping.json
 
 ## Unreleased
 
+## 14.4.0
+
+- Fix JS and Ruby server templates to correctly send event extra values as strings ([DENG-4405](https://mozilla-hub.atlassian.net/browse/DENG-4405))
+- ENHANCEMENT: Extra keys in `extra_keys:` fields may now contain any printable ASCII characters ([bug 1910976](https://bugzilla.mozilla.org/show_bug.cgi?id=1910976))
+
 ## 14.3.0
 
 - Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))

{glean_parser-14.3.0 → glean_parser-14.4.0}/docs/history.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 14.4.0
+
+- Fix JS and Ruby server templates to correctly send event extra values as strings ([DENG-4405](https://mozilla-hub.atlassian.net/browse/DENG-4405))
+- ENHANCEMENT: Extra keys in `extra_keys:` fields may now contain any printable ASCII characters ([bug 1910976](https://bugzilla.mozilla.org/show_bug.cgi?id=1910976))
+
 ## 14.3.0
 
 - Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))

{glean_parser-14.3.0 → glean_parser-14.4.0}/glean_parser/schemas/metrics.2-0-0.schema.yaml

@@ -28,6 +28,11 @@ definitions:
     pattern: "^[a-z_][a-z0-9_]{0,29}(\\.[a-z_][a-z0-9_]{0,29})*$"
     maxLength: 40
 
+  event_extra_key:
+    type: string
+    pattern: "^[ -~]+$"
+    maxLength: 40
+
   # Prior to version 2.0.0 of the schema, special ping names with underscores
   # were also supported.
   kebab_case:
@@ -385,7 +390,7 @@ definitions:
           Valid when `type`_ is `event`.
         type: object
         propertyNames:
-          $ref: "#/definitions/dotted_snake_case"
+          $ref: "#/definitions/event_extra_key"
         additionalProperties:
           type: object
           properties:

{glean_parser-14.3.0 → glean_parser-14.4.0}/glean_parser/templates/javascript_server.jinja2

@@ -234,7 +234,7 @@ class {{ ping|event_class_name(metrics_by_type) }} {
       {% if event.extra_keys %}
       extra: {
         {% for extra, metadata in event.extra_keys.items() %}
-        {{ extra }}: {{ extra }},
+        {{ extra }}: String({{ extra }}),
         {% endfor %}
       },
       {% endif %}

{glean_parser-14.3.0 → glean_parser-14.4.0}/glean_parser/templates/ruby_server.jinja2

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

{glean_parser-14.3.0 → glean_parser-14.4.0}/glean_parser.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: glean_parser
-Version: 14.3.0
+Version: 14.4.0
 Summary: Parser tools for Mozilla's Glean telemetry
 Home-page: https://github.com/mozilla/glean_parser
 Author: The Glean Team
@@ -79,6 +79,11 @@ $ glean_parser check < ping.json
 
 ## Unreleased
 
+## 14.4.0
+
+- Fix JS and Ruby server templates to correctly send event extra values as strings ([DENG-4405](https://mozilla-hub.atlassian.net/browse/DENG-4405))
+- ENHANCEMENT: Extra keys in `extra_keys:` fields may now contain any printable ASCII characters ([bug 1910976](https://bugzilla.mozilla.org/show_bug.cgi?id=1910976))
+
 ## 14.3.0
 
 - Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/data/all_metrics.yaml

@@ -96,6 +96,9 @@ all_metrics:
       source:
         description: Source of this event
         type: string
+      extraKeyNOTJUSTdotted.snake:
+        description: An extra key with an expressive name.
+        type: boolean
 
   quantity:
     <<: *defaults

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/data/event_key_ordering.yaml

@@ -27,4 +27,7 @@ event:
       bob:
         description: "three"
         type: string
+      And1WithExtraCasing:
+        description: "four"
+        type: boolean
     expires: 2100-01-01

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/data/server_events_compare.rb

@@ -103,6 +103,7 @@ module Glean
       # extras to pass into event detail
       object_type:,
       object_state:,
+      linking:,
       # The user's FxA account ID, if available.
       identifiers_fxa_account_id:,
       # full user_agent value from controller context
@@ -116,8 +117,9 @@ module Glean
           'name' => 'object_update',
           'timestamp' => (Time.now.utc.to_f * 1000).to_i,
           'extra' => [
-            ['object_type', object_type],
-            ['object_state', object_state],
+            ['object_type', object_type.to_s],
+            ['object_state', object_state.to_s],
+            ['linking', linking.to_s],
           ].to_h,
         }},
       ]

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/data/server_metrics_with_event.yaml

@@ -48,3 +48,8 @@ backend:
         description: >
           A JSON representation of the latest state of the object.
         type: string
+      linking:
+        description: >
+          Indicates the initial linking of the Mozilla account and
+          the third-party account.
+        type: boolean

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/test-py/test.py

@@ -13,4 +13,5 @@ logger.record_backend_object_update(
     identifiers_fxa_account_id="test-py-project",
     object_type="some_object_type",
     object_state="some_object_state",
+    linking=True,
 )

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/test_javascript.py

@@ -283,7 +283,7 @@ def test_event_extra_keys_in_correct_order(tmp_path):
     with (tmp_path / "event.js").open("r", encoding="utf-8") as fd:
         content = fd.read()
         content = " ".join(content.split())
-        assert '["alice", "bob", "charlie"]' in content
+        assert '["And1WithExtraCasing", "alice", "bob", "charlie"]' in content
 
 
 def test_arguments_are_generated_in_deterministic_order(tmp_path):
@@ -304,7 +304,7 @@ def test_arguments_are_generated_in_deterministic_order(tmp_path):
     with (tmp_path / "event.js").open("r", encoding="utf-8") as fd:
         content = fd.read()
         content = " ".join(content.split())
-        expected = 'export const example = new EventMetricType({ category: "event", name: "example", sendInPings: ["events"], lifetime: "ping", disabled: false, }, ["alice", "bob", "charlie"]);'  # noqa
+        expected = 'export const example = new EventMetricType({ category: "event", name: "example", sendInPings: ["events"], lifetime: "ping", disabled: false, }, ["And1WithExtraCasing", "alice", "bob", "charlie"]);'  # noqa
         assert expected in content
 
 

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/test_javascript_server.py

@@ -161,6 +161,7 @@ eventLogger.recordBackendObjectUpdate({
   identifiers_fxa_account_id: 'abc',
   object_type: 'unknown',
   object_state: 'great',
+  linking: true,
 });
     """
 

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/test_kotlin.py

@@ -365,11 +365,12 @@ def test_event_extra_keys_in_correct_order(tmp_path):
         content = fd.read()
         content = " ".join(content.split())
         assert "ExampleExtra(" in content
+        assert "and1withextracasing:" in content
         assert "alice:" in content
         assert "bob:" in content
         assert "charlie:" in content
         assert ": EventExtras" in content
-        assert 'allowedExtraKeys = listOf("alice", "bob", "charlie")' in content
+        assert 'allowedExtraKeys = listOf("And1WithExtraCasing", "alice", "bob", "charlie")' in content
 
 
 def test_arguments_are_generated_in_deterministic_order(tmp_path):
@@ -392,7 +393,7 @@ def test_arguments_are_generated_in_deterministic_order(tmp_path):
     with (tmp_path / "Event.kt").open("r", encoding="utf-8") as fd:
         content = fd.read()
         content = " ".join(content.split())
-        expected = 'EventMetricType<ExampleExtra> by lazy { // generated from event.example EventMetricType<ExampleExtra>( CommonMetricData( category = "event", name = "example", sendInPings = listOf("events"), lifetime = Lifetime.PING, disabled = false ), allowedExtraKeys = listOf("alice", "bob", "charlie")) } }'  # noqa
+        expected = 'EventMetricType<ExampleExtra> by lazy { // generated from event.example EventMetricType<ExampleExtra>( CommonMetricData( category = "event", name = "example", sendInPings = listOf("events"), lifetime = Lifetime.PING, disabled = false ), allowedExtraKeys = listOf("And1WithExtraCasing", "alice", "bob", "charlie")) } }'  # noqa
         assert expected in content
 
 

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/test_markdown.py

@@ -194,7 +194,8 @@ def test_event_extra_keys_in_correct_order(tmp_path):
         print(content)
         content = " ".join(content.split())
         assert (
-            r"<ul><li>alice: two</li>"
+            r"<ul><li>And1WithExtraCasing: four</li>"
+            r"<li>alice: two</li>"
             r"<li>bob: three</li>"
             r"<li>charlie: one</li></ul>" in content
         )

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/test_ruby_server.py

@@ -133,6 +133,7 @@ def test_run_logging(tmp_path):
 events.backend_object_update.record(
     object_type: "type",
     object_state: "state",
+    linking: true,
     identifiers_fxa_account_id: nil,
     user_agent: "glean-test/1.0",
     ip_address: "127.0.0.1"

{glean_parser-14.3.0 → glean_parser-14.4.0}/tests/test_swift.py

@@ -288,9 +288,9 @@ def test_event_extra_keys_in_correct_order(tmp_path):
         content = " ".join(content.split())
         assert (
             "struct ExampleExtra: EventExtras "
-            "{ var alice: String? var bob: String? var charlie: String?" in content
+            "{ var and1withextracasing: Bool? var alice: String? var bob: String? var charlie: String?" in content
         )
-        assert ', ["alice", "bob", "charlie"]' in content
+        assert ', ["And1WithExtraCasing", "alice", "bob", "charlie"]' in content
 
 
 def test_event_extra_keys_with_types(tmp_path):