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

glean_parser-14.3.0/.github/CODEOWNERS

@@ -0,0 +1,12 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# This CODEOWNERS file defines individuals or teams that are responsible
+# for code in this repository.
+# See https://help.github.com/articles/about-codeowners/ for details.
+
+* @mozilla/glean
+glean_parser/*_server.py @akkomar
+tests/*_server.py @akkomar
+server_telemetry/* @akkomar

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

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 14.3.0
+
+- Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))
+- BUGFIX: Fix the Rust codegen for changes to how `labeled_*` metrics are constructed ([bug 1909244](https://bugzilla.mozilla.org/show_bug.cgi?id=1909244))
+- Generate a serializer for array wrappers ([bug 1908157](https://bugzilla.mozilla.org/show_bug.cgi?id=1908157))
+
 ## 14.2.0
 
 - New Metric Types: `labeled_{custom|memory|timing}_distribution` ([bug 1657947](https://bugzilla.mozilla.org/show_bug.cgi?id=1657947))

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: glean_parser
-Version: 14.2.0
+Version: 14.3.0
 Summary: Parser tools for Mozilla's Glean telemetry
 Home-page: https://github.com/mozilla/glean_parser
 Author: The Glean Team
@@ -79,6 +79,12 @@ $ glean_parser check < ping.json
 
 ## Unreleased
 
+## 14.3.0
+
+- Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))
+- BUGFIX: Fix the Rust codegen for changes to how `labeled_*` metrics are constructed ([bug 1909244](https://bugzilla.mozilla.org/show_bug.cgi?id=1909244))
+- Generate a serializer for array wrappers ([bug 1908157](https://bugzilla.mozilla.org/show_bug.cgi?id=1908157))
+
 ## 14.2.0
 
 - New Metric Types: `labeled_{custom|memory|timing}_distribution` ([bug 1657947](https://bugzilla.mozilla.org/show_bug.cgi?id=1657947))

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

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 14.3.0
+
+- Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))
+- BUGFIX: Fix the Rust codegen for changes to how `labeled_*` metrics are constructed ([bug 1909244](https://bugzilla.mozilla.org/show_bug.cgi?id=1909244))
+- Generate a serializer for array wrappers ([bug 1908157](https://bugzilla.mozilla.org/show_bug.cgi?id=1908157))
+
 ## 14.2.0
 
 - New Metric Types: `labeled_{custom|memory|timing}_distribution` ([bug 1657947](https://bugzilla.mozilla.org/show_bug.cgi?id=1657947))

{glean_parser-14.2.0 → glean_parser-14.3.0}/glean_parser/javascript_server.py

@@ -87,6 +87,7 @@ def output(
     lang: str,
     objs: metrics.ObjectTree,
     output_dir: Path,
+    options: Optional[Dict[str, Any]] = None,
 ) -> None:
     """
     Given a tree of objects, output Javascript or Typescript code to `output_dir`.
@@ -100,6 +101,16 @@ def output(
     :param output_dir: Path to an output directory to write to.
     """
 
+    if options is None:
+        options = {}
+
+    module_spec = options.get("module_spec", "es")
+    accepted_module_specs = ["es", "commonjs"]
+    if module_spec not in accepted_module_specs:
+        raise ValueError(
+            f"Unknown module_spec: {module_spec}. Accepted specs are: {accepted_module_specs}."  # noqa
+        )
+
     template = util.get_jinja2_template(
         "javascript_server.jinja2",
         filters=(
@@ -184,6 +195,7 @@ def output(
                 parser_version=__version__,
                 pings=ping_to_metrics,
                 event_metric_exists=event_metric_exists,
+                module_spec=module_spec,
                 lang=lang,
             )
         )
@@ -198,9 +210,13 @@ def output_javascript(
     :param objects: A tree of objects (metrics and pings) as returned from
         `parser.parse_objects`.
     :param output_dir: Path to an output directory to write to.
+    :param options: options dictionary, with the following optional keys:
+
+        - `module_spec`: Module specification to use. Options are `es`, `commonjs`.
+                        Default is `es`.
     """
 
-    output("javascript", objs, output_dir)
+    output("javascript", objs, output_dir, options)
 
 
 def output_typescript(
@@ -214,4 +230,4 @@ def output_typescript(
     :param output_dir: Path to an output directory to write to.
     """
 
-    output("typescript", objs, output_dir)
+    output("typescript", objs, output_dir, options)

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

@@ -11,8 +11,13 @@ Jinja2 template is not. Please file bugs! #}
 // @types/uuid and mozlog types definitions are required in devDependencies
 // for the latter see https://github.com/mozilla/fxa/blob/85bda71cda376c417b8c850ba82aa14252208c3c/types/mozlog/index.d.ts
 {% endif %}
+{% if module_spec == "commonjs" %}
+const uuidv4 = require('uuid').v4;
+const mozlog = require('mozlog');
+{% else %}
 import { v4 as uuidv4 } from 'uuid';
 import mozlog{% if lang == "typescript" %}, { Logger }{% endif %} from 'mozlog';
+{% endif %}
 
 const GLEAN_EVENT_MOZLOG_TYPE = 'glean-server-event';
 {% if lang == "typescript" %}
@@ -262,7 +267,11 @@ class {{ ping|event_class_name(metrics_by_type) }} {
  * @param {Object} logger_options - The logger options.
  * @returns {EventsServerEventLogger} An instance of EventsServerEventLogger.
  */
+{% if module_spec == "commonjs" %}
+module.exports.{{ ping|factory_method(metrics_by_type) }} = function ({
+{% else %}
 export const {{ ping|factory_method(metrics_by_type) }} = function ({
+{% endif %}
   applicationId,
   appDisplayVersion,
   channel,

{glean_parser-14.2.0 → glean_parser-14.3.0}/glean_parser/templates/kotlin.jinja2

@@ -68,7 +68,7 @@ data class {{ obj.name|Camelize }}{{ suffix }}(
 
 {%- macro generate_structure(name, struct) %}
 {%- if struct.type == "array" -%}
-    @Serializable
+    @Serializable(with = {{name}}.Serializer::class)
     data class {{ name }}(var items: MutableList<{{ name }}Item> = mutableListOf()) : ObjectSerialize {
         fun add(elem: {{ name }}Item) = items.add(elem)
 
@@ -85,6 +85,20 @@ data class {{ obj.name|Camelize }}{{ suffix }}(
         override fun intoSerializedObject(): String {
             return Json.encodeToString(items)
         }
+
+        internal object Serializer : KSerializer<{{name}}> {
+            @OptIn(kotlinx.serialization.ExperimentalSerializationApi::class)
+            override val descriptor = listSerialDescriptor<String>()
+
+            override fun deserialize(decoder: Decoder): {{ name }} {
+                val list = decoder.decodeSerializableValue(ListSerializer(serializer<{{name}}Item>()))
+                return {{name}}(items = list.toMutableList())
+            }
+
+            override fun serialize(encoder: Encoder, value: {{name}}) {
+                encoder.encodeSerializableValue(ListSerializer(serializer<{{name}}Item>()), value.items)
+            }
+        }
     }
 
     {{ generate_structure(name ~ "Item", struct["items"]) }}
@@ -93,10 +107,10 @@ data class {{ obj.name|Camelize }}{{ suffix }}(
     @Serializable
     data class {{ name }}(
         {% for itemname, val in struct.properties.items() %}
-          {% if val.type == "object" %}
+          {% if val.type == "array" %}
+          var {{itemname|camelize}}: {{ name ~ itemname|Camelize }} = {{ name ~ itemname|Camelize }}(),
+          {% elif val.type == "object" %}
           var {{itemname|camelize}}: {{ name ~ "Item" ~ itemname|Camelize ~ "Object" }}? = null,
-          {% elif val.type == "array" %}
-          var {{itemname|camelize}}: {{ name ~ "Item" ~ itemname|Camelize }} = {{ name ~ "Item" ~ itemname|Camelize }}(),
           {% else %}
           var {{itemname|camelize}}: {{val.type|structure_type_name}}? = null,
           {% endif %}
@@ -109,7 +123,7 @@ data class {{ obj.name|Camelize }}{{ suffix }}(
 
     {% for itemname, val in struct.properties.items() %}
         {% if val.type == "array" %}
-        {% set nested_name = name ~ "Item" ~ itemname|Camelize %}
+        {% set nested_name = name ~ itemname|Camelize %}
         {{ generate_structure(nested_name, val) }}
         {% elif val.type == "object" %}
         {% set nested_name = name ~ "Item" ~ itemname|Camelize ~ "Object" %}
@@ -127,7 +141,7 @@ data class {{ obj.name|Camelize }}{{ suffix }}(
 {%- elif struct.type == "object" -%}
     {% for itemname, val in struct.properties.items() %}
         {% if val.type == "array" %}
-        {% set nested_name = name ~ "Item" ~ itemname|Camelize %}
+        {% set nested_name = name ~ itemname|Camelize %}
         {{ generate_structure_typealias(nested_name, val) }}
         {% elif val.type == "object" %}
         {% set nested_name = name ~ "Item" ~ itemname|Camelize ~ "Object" %}
@@ -160,9 +174,15 @@ import {{ glean_namespace }}.private.{{ obj_type }} // ktlint-disable import-ord
 import {{ glean_namespace }}.private.LabeledMetricType // ktlint-disable import-ordering
 {% endif %}
 {% if has_object_metrics %}
+import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
+import kotlinx.serialization.builtins.ListSerializer
+import kotlinx.serialization.descriptors.listSerialDescriptor
 import kotlinx.serialization.encodeToString
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.json.Json
+import kotlinx.serialization.serializer
 {% endif %}
 
 {# HACK HACK HACK -- typealiases MUST BE top-level #}

{glean_parser-14.2.0 → glean_parser-14.3.0}/glean_parser/templates/rust.jinja2

@@ -20,12 +20,12 @@ Jinja2 template is not. Please file bugs! #}
     #[serde(deny_unknown_fields)]
     pub struct {{ name }} {
         {% for itemname, val in struct.properties.items() %}
-          {% if val.type == "object" %}
+          {% if val.type == "array" %}
+          #[serde(skip_serializing_if = "Vec::is_empty", default = "Vec::new")]
+          pub {{itemname|snake_case}}: {{ name ~ itemname|Camelize }},
+          {% elif val.type == "object" %}
           #[serde(skip_serializing_if = "Option::is_none")]
           pub {{itemname|snake_case}}: Option<{{ name ~ "Item" ~ itemname|Camelize ~ "Object" }}>,
-          {% elif val.type == "array" %}
-          #[serde(skip_serializing_if = "Vec::is_empty", default = "Vec::new")]
-          pub {{itemname|snake_case}}: {{ name ~ "Item" ~ itemname|Camelize }},
           {% else %}
           #[serde(skip_serializing_if = "Option::is_none")]
           pub {{itemname|snake_case}}: Option<{{val.type|structure_type_name}}>,
@@ -35,7 +35,7 @@ Jinja2 template is not. Please file bugs! #}
 
     {% for itemname, val in struct.properties.items() %}
         {% if val.type == "array" %}
-        {% set nested_name = name ~ "Item" ~ itemname|Camelize %}
+        {% set nested_name = name ~ itemname|Camelize %}
         {{ generate_structure(nested_name, val) }}
         {% elif val.type == "object" %}
         {% set nested_name = name ~ "Item" ~ itemname|Camelize ~ "Object" %}
@@ -80,6 +80,16 @@ impl ExtraKeys for {{ obj.name|Camelize }}{{ suffix }} {
     }
 }
 {% endmacro %}
+{% macro common_metric_data(obj) %}
+CommonMetricData {
+    category: {{ obj.category|rust }},
+    name: {{ obj.name|rust }},
+    send_in_pings: {{ obj.send_in_pings|rust }},
+    lifetime: {{ obj.lifetime|rust }},
+    disabled: {{ obj.is_disabled()|rust }},
+    ..Default::default()
+}
+{% endmacro %}
 {% for category in categories %}
 {% if category.contains_pings %}
 {% for obj in category.objs.values() %}
@@ -92,7 +102,7 @@ pub static {{ obj.name|snake_case }}: ::glean::private::__export::Lazy<::glean::
 {% else %}
 pub mod {{ category.name|snake_case }} {
     #[allow(unused_imports)] // HistogramType might be unusued, let's avoid warnings
-    use glean::{private::*, traits::ExtraKeys, traits::NoExtraKeys, CommonMetricData, HistogramType, Lifetime, TimeUnit, MemoryUnit};
+    use glean::{private::*, traits::ExtraKeys, traits::NoExtraKeys, CommonMetricData, HistogramType, LabeledMetricData, Lifetime, TimeUnit, MemoryUnit};
     {% for obj in category.objs.values() %}
 
     {% if obj|attr("_generate_structure") %}
@@ -107,15 +117,37 @@ pub mod {{ category.name|snake_case }} {
     ///
     /// {{ obj.description|wordwrap() | replace('\n', '\n    /// ') }}
     pub static {{ obj.name|snake_case }}: ::glean::private::__export::Lazy<{{ obj|type_name }}> = ::glean::private::__export::Lazy::new(|| {
-        {{ obj|ctor }}(CommonMetricData {
-            category: {{ obj.category|rust }},
-            name: {{ obj.name|rust }},
-            send_in_pings: {{ obj.send_in_pings|rust }},
-            lifetime: {{ obj.lifetime|rust }},
-            disabled: {{ obj.is_disabled()|rust }},
-            ..Default::default()
-        }
-        {%- for arg_name in extra_metric_args if obj[arg_name] is defined and arg_name != 'allowed_extra_keys' -%}
+        let meta =
+            {% if obj.type == "labeled_custom_distribution" %}
+            LabeledMetricData::CustomDistribution {
+                cmd: {{ common_metric_data(obj)|indent(16) }}
+                {%- for arg_name in extra_metric_args if obj[arg_name] is defined and arg_name != 'allowed_extra_keys' -%}
+                    , {{ arg_name }}: {{ obj[arg_name]|rust }}
+                {%- endfor -%}
+            };
+            {% elif obj.type == "labeled_memory_distribution" %}
+            LabeledMetricData::MemoryDistribution {
+                cmd: {{ common_metric_data(obj)|indent(16) }}
+                {%- for arg_name in extra_metric_args if obj[arg_name] is defined and arg_name != 'allowed_extra_keys' -%}
+                    , {{ "unit" if arg_name == "memory_unit" else arg_name }}: {{ obj[arg_name]|rust }}
+                {%- endfor -%}
+            };
+            {% elif obj.type == "labeled_timing_distribution" %}
+            LabeledMetricData::TimingDistribution {
+                cmd: {{ common_metric_data(obj)|indent(16) }}
+                {%- for arg_name in extra_metric_args if obj[arg_name] is defined and arg_name != 'allowed_extra_keys' -%}
+                    , {{ "unit" if arg_name == "time_unit" else arg_name }}: {{ obj[arg_name]|rust }}
+                {%- endfor -%}
+            };
+            {% elif obj.labeled %}
+            LabeledMetricData::Common {
+                cmd: {{common_metric_data(obj)|indent(16) }},
+            };
+            {% else %}
+            {{ common_metric_data(obj)|indent(12) }};
+            {% endif %}
+        {{ obj|ctor }}(meta
+        {%- for arg_name in extra_metric_args if not obj.labeled and obj[arg_name] is defined and arg_name != 'allowed_extra_keys' -%}
             , {{ obj[arg_name]|rust }}
         {%- endfor -%}
         {{ ", " if obj.labeled else ")\n" }}

{glean_parser-14.2.0 → glean_parser-14.3.0}/glean_parser/templates/swift.jinja2

@@ -53,10 +53,10 @@ struct {{ obj.name|Camelize }}{{ suffix }}: EventExtras {
 {%- elif struct.type == "object" -%}
     struct {{ name }}: Codable, Equatable, ObjectSerialize {
         {% for itemname, val in struct.properties.items() %}
-          {% if val.type == "object" %}
+          {% if val.type == "array" %}
+          var {{itemname|camelize|variable_name}}: {{ name ~ itemname|Camelize }} = []
+          {% elif val.type == "object" %}
           var {{itemname|camelize|variable_name}}: {{ name ~ "Item" ~ itemname|Camelize ~ "Object" }}?
-          {% elif val.type == "array" %}
-          var {{itemname|camelize|variable_name}}: {{ name ~ "Item" ~ itemname|Camelize }}
           {% else %}
           var {{itemname|camelize|variable_name}}: {{val.type|structure_type_name}}?
           {% endif %}
@@ -72,7 +72,7 @@ struct {{ obj.name|Camelize }}{{ suffix }}: EventExtras {
 
     {% for itemname, val in struct.properties.items() %}
         {% if val.type == "array" %}
-        {% set nested_name = name ~ "Item" ~ itemname|Camelize %}
+        {% set nested_name = name ~ itemname|Camelize %}
         {{ generate_structure(nested_name, val) }}
         {% elif val.type == "object" %}
         {% set nested_name = name ~ "Item" ~ itemname|Camelize ~ "Object" %}

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: glean_parser
-Version: 14.2.0
+Version: 14.3.0
 Summary: Parser tools for Mozilla's Glean telemetry
 Home-page: https://github.com/mozilla/glean_parser
 Author: The Glean Team
@@ -79,6 +79,12 @@ $ glean_parser check < ping.json
 
 ## Unreleased
 
+## 14.3.0
+
+- Add the `module_spec` option to the javascript_server outputter ([#726](https://github.com/mozilla/glean_parser/pull/726))
+- BUGFIX: Fix the Rust codegen for changes to how `labeled_*` metrics are constructed ([bug 1909244](https://bugzilla.mozilla.org/show_bug.cgi?id=1909244))
+- Generate a serializer for array wrappers ([bug 1908157](https://bugzilla.mozilla.org/show_bug.cgi?id=1908157))
+
 ## 14.2.0
 
 - New Metric Types: `labeled_{custom|memory|timing}_distribution` ([bug 1657947](https://bugzilla.mozilla.org/show_bug.cgi?id=1657947))

{glean_parser-14.2.0 → glean_parser-14.3.0}/glean_parser.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ requirements_dev.txt
 setup.cfg
 setup.py
 .circleci/config.yml
+.github/CODEOWNERS
 .github/ISSUE_TEMPLATE.md
 .github/dependabot.yml
 .github/pull_request_template.md

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

@@ -487,11 +487,11 @@ def test_object_metric(tmp_path):
         assert "data class ThreadsObject(" in content
         assert "data class ThreadsObjectItem(" in content
         assert (
-            "var frames: ThreadsObjectItemItemFrames = ThreadsObjectItemItemFrames"
+            "var frames: ThreadsObjectItemFrames = ThreadsObjectItemFrames"
             in content
         )
 
-        assert "data class ThreadsObjectItemItemFramesItem(" in content
+        assert "data class ThreadsObjectItemFramesItem(" in content
         assert "var moduleIndex: Int? = null," in content
         assert "var ip: String? = null," in content
         assert "var trust: String? = null," in content

{glean_parser-14.2.0 → glean_parser-14.3.0}/tests/test_rust.py

@@ -276,13 +276,13 @@ def test_object_metric(tmp_path):
 
         assert "ObjectMetric<ThreadsObject>" in content
         assert "pub struct ThreadsObjectItem { " in content
-        assert "frames: ThreadsObjectItemItemFrames, }" in content
+        assert "frames: ThreadsObjectItemFrames, }" in content
         assert (
-            "pub type ThreadsObjectItemItemFrames = "
-            "Vec<ThreadsObjectItemItemFramesItem>;" in content
+            "pub type ThreadsObjectItemFrames = "
+            "Vec<ThreadsObjectItemFramesItem>;" in content
         )
 
-        assert "pub struct ThreadsObjectItemItemFramesItem { " in content
+        assert "pub struct ThreadsObjectItemFramesItem { " in content
         assert "module_index: Option<i64>, " in content
         assert "ip: Option<String>, " in content
         assert "trust: Option<String>, " in content

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

@@ -370,11 +370,11 @@ def test_object_metric(tmp_path):
         assert "typealias ThreadsObject = [ThreadsObjectItem]" in content
         assert "struct ThreadsObjectItem: Codable, Equatable, ObjectSerialize {" in content
         assert (
-            "var frames: ThreadsObjectItemItemFrames"
+            "var frames: ThreadsObjectItemFrames"
             in content
         )
 
-        assert "struct ThreadsObjectItemItemFramesItem: Codable, Equatable, ObjectSerialize {" in content
+        assert "struct ThreadsObjectItemFramesItem: Codable, Equatable, ObjectSerialize {" in content
         assert "var moduleIndex: Int64?" in content
         assert "var ip: String?" in content
         assert "var trust: String?" in content