glean-parser 20.1.0__tar.gz → 21.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. {glean_parser-20.1.0 → glean_parser-21.0.0}/PKG-INFO +1 -1
  2. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/metrics.py +18 -5
  3. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/schemas/metrics.2-0-0.schema.yaml +1 -1
  4. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/kotlin.jinja2 +56 -5
  5. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/swift.jinja2 +55 -5
  6. glean_parser-21.0.0/tests/data/categories.yaml +28 -0
  7. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/schema-violation.yaml +4 -1
  8. glean_parser-21.0.0/tests/data/single_labeled.yaml +67 -0
  9. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_kotlin.py +32 -0
  10. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_parser.py +113 -0
  11. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_swift.py +30 -0
  12. glean_parser-20.1.0/tests/data/single_labeled.yaml +0 -21
  13. {glean_parser-20.1.0 → glean_parser-21.0.0}/.gitignore +0 -0
  14. {glean_parser-20.1.0 → glean_parser-21.0.0}/AUTHORS.md +0 -0
  15. {glean_parser-20.1.0 → glean_parser-21.0.0}/LICENSE +0 -0
  16. {glean_parser-20.1.0 → glean_parser-21.0.0}/README.md +0 -0
  17. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/__init__.py +0 -0
  18. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/__main__.py +0 -0
  19. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/data_review.py +0 -0
  20. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/go_server.py +0 -0
  21. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/javascript.py +0 -0
  22. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/javascript_server.py +0 -0
  23. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/kotlin.py +0 -0
  24. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/lint.py +0 -0
  25. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/markdown.py +0 -0
  26. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/parser.py +0 -0
  27. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/pings.py +0 -0
  28. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/python_server.py +0 -0
  29. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/ruby_server.py +0 -0
  30. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/rust.py +0 -0
  31. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/rust_server.py +0 -0
  32. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/rust_sym.py +0 -0
  33. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/schemas/metrics.1-0-0.schema.yaml +0 -0
  34. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/schemas/pings.1-0-0.schema.yaml +0 -0
  35. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/schemas/pings.2-0-0.schema.yaml +0 -0
  36. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/schemas/tags.1-0-0.schema.yaml +0 -0
  37. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/swift.py +0 -0
  38. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/tags.py +0 -0
  39. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/data_review.jinja2 +0 -0
  40. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/go_server.jinja2 +0 -0
  41. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/javascript.buildinfo.jinja2 +0 -0
  42. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/javascript.jinja2 +0 -0
  43. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/javascript_server.jinja2 +0 -0
  44. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/kotlin.buildinfo.jinja2 +0 -0
  45. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/markdown.jinja2 +0 -0
  46. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/python_server.jinja2 +0 -0
  47. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/qmldir.jinja2 +0 -0
  48. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/ruby_server.jinja2 +0 -0
  49. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/rust.jinja2 +0 -0
  50. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/rust_server.jinja2 +0 -0
  51. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/templates/rust_sym.jinja2 +0 -0
  52. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/translate.py +0 -0
  53. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/translation_options.py +0 -0
  54. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/util.py +0 -0
  55. {glean_parser-20.1.0 → glean_parser-21.0.0}/glean_parser/validate_ping.py +0 -0
  56. {glean_parser-20.1.0 → glean_parser-21.0.0}/pyproject.toml +0 -0
  57. {glean_parser-20.1.0 → glean_parser-21.0.0}/server_telemetry/sdk-metrics-compat.yaml +0 -0
  58. {glean_parser-20.1.0 → glean_parser-21.0.0}/server_telemetry/server-side-pings.yaml +0 -0
  59. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/conftest.py +0 -0
  60. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/all_metrics.yaml +0 -0
  61. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/all_pings.yaml +0 -0
  62. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/attribution.yaml +0 -0
  63. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/bad_attribution.yamlx +0 -0
  64. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/bad_ping.yamlx +0 -0
  65. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/core.yaml +0 -0
  66. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/custom_ping_no_event_metrics.yaml +0 -0
  67. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/custom_ping_no_event_pings.yaml +0 -0
  68. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/dual_labeled.yaml +0 -0
  69. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/dual_labeled_invalid.yaml +0 -0
  70. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/duplicate_labeled.yaml +0 -0
  71. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/duplicate_send_in_ping.yaml +0 -0
  72. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/empty.yaml +0 -0
  73. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/event_key_ordering.yaml +0 -0
  74. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/events_data_sensitivity.yaml +0 -0
  75. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/events_with_types.yaml +0 -0
  76. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/fxa-server-metrics.yaml +0 -0
  77. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/fxa-server-pings.yaml +0 -0
  78. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/go_server_custom_ping_only_metrics.yaml +0 -0
  79. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/go_server_custom_ping_only_pings.yaml +0 -0
  80. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/go_server_events_and_custom_ping_metrics.yaml +0 -0
  81. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/go_server_events_and_custom_ping_pings.yaml +0 -0
  82. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/go_server_events_only_metrics.yaml +0 -0
  83. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/go_server_labeled_boolean_metrics.yaml +0 -0
  84. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/go_server_metrics_unsupported.yaml +0 -0
  85. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/invalid-ping-names.yaml +0 -0
  86. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/invalid.yamlx +0 -0
  87. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/jwe.yaml +0 -0
  88. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/metric-with-tags.yaml +0 -0
  89. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/mixed-expirations.yaml +0 -0
  90. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/name_too_similar.yaml +0 -0
  91. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/object.yaml +0 -0
  92. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/old_event_api.yamlx +0 -0
  93. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/ordering.yaml +0 -0
  94. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/pings.yaml +0 -0
  95. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/python_server_metrics_unsupported.yaml +0 -0
  96. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/rate.yaml +0 -0
  97. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/redefined_category.yamlx +0 -0
  98. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/redefined_metric.yamlx +0 -0
  99. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/redefined_ping.yamlx +0 -0
  100. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/reserved_categories.yamlx +0 -0
  101. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/ruby_server_metrics_unsupported.yaml +0 -0
  102. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/ruby_server_pings_unsupported.yaml +0 -0
  103. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/rust_server_custom_ping_only_metrics.yaml +0 -0
  104. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/rust_server_custom_ping_only_pings.yaml +0 -0
  105. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/rust_server_events_and_custom_ping_metrics.yaml +0 -0
  106. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/rust_server_events_and_custom_ping_pings.yaml +0 -0
  107. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/rust_server_events_only_metrics.yaml +0 -0
  108. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/rust_server_metrics_unsupported.yaml +0 -0
  109. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/same_name_different_category.yaml +0 -0
  110. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/send_if_empty_with_metrics.yaml +0 -0
  111. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_custom_ping_only_compare.go +0 -0
  112. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_custom_ping_only_compare.rs +0 -0
  113. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_events_and_custom_ping_compare.go +0 -0
  114. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_events_and_custom_ping_compare.rs +0 -0
  115. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_events_compare.rb +0 -0
  116. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_events_only_compare.go +0 -0
  117. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_events_only_compare.rs +0 -0
  118. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_metrics_no_events_no_pings.yaml +0 -0
  119. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_metrics_with_event.yaml +0 -0
  120. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/server_pings.yaml +0 -0
  121. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/smaller.yaml +0 -0
  122. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/tags.yaml +0 -0
  123. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/telemetry_mirror.yaml +0 -0
  124. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/text.yaml +0 -0
  125. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/text_invalid.yaml +0 -0
  126. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/unknown_ping_used.yaml +0 -0
  127. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/wrong_key.yamlx +0 -0
  128. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/data/yaml_nits.yamlx +0 -0
  129. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/detekt.yml +0 -0
  130. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test-go/test.go.tmpl +0 -0
  131. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test-go/test_publisher.go.tmpl +0 -0
  132. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test-js/package.json +0 -0
  133. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test-js/test.js.tmpl +0 -0
  134. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test-py/test.py +0 -0
  135. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test-rb/test.rb.tmpl +0 -0
  136. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test-rs/test.rs.tmpl +0 -0
  137. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_cli.py +0 -0
  138. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_go_server.py +0 -0
  139. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_go_server_pubsub.py +0 -0
  140. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_javascript.py +0 -0
  141. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_javascript_server.py +0 -0
  142. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_lint.py +0 -0
  143. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_markdown.py +0 -0
  144. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_metrics.py +0 -0
  145. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_pings.py +0 -0
  146. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_python_server.py +0 -0
  147. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_ruby_server.py +0 -0
  148. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_rust.py +0 -0
  149. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_rust_server.py +0 -0
  150. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_rust_sym.py +0 -0
  151. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_tags.py +0 -0
  152. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_translate.py +0 -0
  153. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_utils.py +0 -0
  154. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/test_validate_ping.py +0 -0
  155. {glean_parser-20.1.0 → glean_parser-21.0.0}/tests/util.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: glean-parser
3
- Version: 20.1.0
3
+ Version: 21.0.0
4
4
  Summary: Parser tools for Mozilla's Glean telemetry
5
5
  Project-URL: Homepage, https://mozilla.github.io/glean
6
6
  Project-URL: Repository, https://github.com/mozilla/glean_parser
@@ -165,7 +165,9 @@ class Metric:
165
165
  **metric_info,
166
166
  )
167
167
 
168
- def serialize(self) -> Dict[str, util.JSONType]:
168
+ def serialize(
169
+ self, rename_fields: Optional[Dict[str, str]] = None
170
+ ) -> Dict[str, util.JSONType]:
169
171
  """
170
172
  Serialize the metric back to JSON object model.
171
173
  """
@@ -178,6 +180,13 @@ class Metric:
178
180
  d[key] = sorted(list(val))
179
181
  if isinstance(val, list) and len(val) and isinstance(val[0], enum.Enum):
180
182
  d[key] = [x.name for x in val]
183
+
184
+ if rename_fields is not None:
185
+ for key, val in rename_fields.items():
186
+ if key in d:
187
+ d[val] = d[key]
188
+ del d[key]
189
+
181
190
  del d["name"]
182
191
  del d["category"]
183
192
  if not d["unit"]:
@@ -399,11 +408,13 @@ class Labeled(Metric):
399
408
  self.labels = None
400
409
  super().__init__(*args, **kwargs)
401
410
 
402
- def serialize(self) -> Dict[str, util.JSONType]:
411
+ def serialize(
412
+ self, rename_fields: Optional[Dict[str, str]] = None
413
+ ) -> Dict[str, util.JSONType]:
403
414
  """
404
415
  Serialize the metric back to JSON object model.
405
416
  """
406
- d = super().serialize()
417
+ d = super().serialize(rename_fields=rename_fields)
407
418
  d["labels"] = self.ordered_labels
408
419
  del d["ordered_labels"]
409
420
  return d
@@ -604,11 +615,13 @@ class DualLabeledCounter(Metric):
604
615
  self.categories = None
605
616
  super().__init__(*args, **kwargs)
606
617
 
607
- def serialize(self) -> Dict[str, util.JSONType]:
618
+ def serialize(
619
+ self, rename_fields: Optional[Dict[str, str]] = None
620
+ ) -> Dict[str, util.JSONType]:
608
621
  """
609
622
  Serialize the metric back to JSON object model.
610
623
  """
611
- d = super().serialize()
624
+ d = super().serialize(rename_fields=rename_fields)
612
625
  d["keys"] = self.ordered_keys
613
626
  d["categories"] = self.ordered_categories
614
627
  del d["ordered_keys"]
@@ -21,7 +21,7 @@ definitions:
21
21
 
22
22
  dotted_snake_case:
23
23
  type: string
24
- pattern: "^[a-z_][a-z0-9_]{0,29}(\\.[a-z_][a-z0-9_]{0,29})*$"
24
+ pattern: "^[a-z_][a-z0-9_]*(\\.[a-z_][a-z0-9_]*)*$"
25
25
  maxLength: 40
26
26
 
27
27
  event_extra_key:
@@ -289,6 +289,10 @@ import {{ glean_namespace }}.private.{{ obj_type }} // ktlint-disable import-ord
289
289
  {% endfor %}
290
290
  {% if has_labeled_metrics %}
291
291
  import {{ glean_namespace }}.private.LabeledMetricType // ktlint-disable import-ordering
292
+ import {{ glean_namespace }}.private.CommonLabeledMetricData // ktlint-disable import-ordering no-unused-imports
293
+ import {{ glean_namespace }}.private.CustomDistributionLabeledMetricData // ktlint-disable import-ordering no-unused-imports
294
+ import {{ glean_namespace }}.private.MemoryDistributionLabeledMetricData // ktlint-disable import-ordering no-unused-imports
295
+ import {{ glean_namespace }}.private.TimingDistributionLabeledMetricData // ktlint-disable import-ordering no-unused-imports
292
296
  {% endif %}
293
297
  {% if has_object_metrics %}
294
298
  import {{ glean_namespace }}.private.intoSerializedObject
@@ -344,12 +348,59 @@ internal object {{ category_name|Camelize }} {
344
348
  */
345
349
  val {{ obj.name|camelize }}: LabeledMetricType<{{ obj|type_name }}> by lazy { // generated from {{ obj.identifier() }}
346
350
  LabeledMetricType(
347
- category = {{ obj.category|kotlin }},
348
- name = {{ obj.name|kotlin }},
351
+ {% if obj.type == "labeled_custom_distribution" %}
352
+ CustomDistributionLabeledMetricData(
353
+ cmd = CommonMetricData(
354
+ category = {{ obj.category|kotlin }},
355
+ name = {{ obj.name|kotlin }},
356
+ disabled = {{ obj.is_disabled()|kotlin }},
357
+ lifetime = {{ obj.lifetime|kotlin }},
358
+ sendInPings = {{ obj.send_in_pings|kotlin }}
359
+ )
360
+ {%- for arg_name in extra_metric_args if obj[arg_name] is defined -%}
361
+ , {{ arg_name|camelize }} = {{ obj[arg_name]|kotlin }}
362
+ {%- endfor -%}
363
+ ),
364
+ {% elif obj.type == "labeled_memory_distribution" %}
365
+ MemoryDistributionLabeledMetricData(
366
+ cmd = CommonMetricData(
367
+ category = {{ obj.category|kotlin }},
368
+ name = {{ obj.name|kotlin }},
369
+ disabled = {{ obj.is_disabled()|kotlin }},
370
+ lifetime = {{ obj.lifetime|kotlin }},
371
+ sendInPings = {{ obj.send_in_pings|kotlin }}
372
+ )
373
+ {%- for arg_name in extra_metric_args if obj[arg_name] is defined -%}
374
+ , {{ arg_name|camelize }} = {{ obj[arg_name]|kotlin }}
375
+ {%- endfor -%}
376
+ ),
377
+ {% elif obj.type == "labeled_timing_distribution" %}
378
+ TimingDistributionLabeledMetricData(
379
+ cmd = CommonMetricData(
380
+ category = {{ obj.category|kotlin }},
381
+ name = {{ obj.name|kotlin }},
382
+ disabled = {{ obj.is_disabled()|kotlin }},
383
+ lifetime = {{ obj.lifetime|kotlin }},
384
+ sendInPings = {{ obj.send_in_pings|kotlin }}
385
+ )
386
+ {%- for arg_name in extra_metric_args if obj[arg_name] is defined -%}
387
+ , {{ arg_name|camelize }} = {{ obj[arg_name]|kotlin }}
388
+ {%- endfor -%}
389
+ ),
390
+ {% elif obj.labeled %}
391
+ CommonLabeledMetricData(
392
+ cmd = CommonMetricData(
393
+ category = {{ obj.category|kotlin }},
394
+ name = {{ obj.name|kotlin }},
395
+ disabled = {{ obj.is_disabled()|kotlin }},
396
+ lifetime = {{ obj.lifetime|kotlin }},
397
+ sendInPings = {{ obj.send_in_pings|kotlin }}
398
+ )
399
+ ),
400
+ {% else %}
401
+ UNKNOWN
402
+ {% endif %}
349
403
  subMetric = {{ obj.name|camelize }}Label,
350
- disabled = {{ obj.is_disabled()|kotlin }},
351
- lifetime = {{ obj.lifetime|kotlin }},
352
- sendInPings = {{ obj.send_in_pings|kotlin }},
353
404
  labels = {{ obj.labels|kotlin }}
354
405
  )
355
406
  }
@@ -217,11 +217,61 @@ extension {{ namespace }} {
217
217
  {{ obj_declaration(obj, 'Label', 'private ') | indent }}
218
218
  /// {{ obj.description|wordwrap() | replace('\n', '\n /// ') }}
219
219
  static let {{ obj.name|camelize|variable_name }} = try! LabeledMetricType<{{ obj|type_name }}>( // generated from {{ obj.identifier() }}
220
- category: {{ obj.category|swift }},
221
- name: {{ obj.name|swift }},
222
- sendInPings: {{ obj.send_in_pings|swift }},
223
- lifetime: {{ obj.lifetime|swift }},
224
- disabled: {{ obj.is_disabled()|swift }},
220
+ {% if obj.type == "labeled_custom_distribution" %}
221
+ .customDistribution(
222
+ cmd: CommonMetricData(
223
+ category: {{ obj.category|swift }},
224
+ name: {{ obj.name|swift }},
225
+ sendInPings: {{ obj.send_in_pings|swift }},
226
+ lifetime: {{ obj.lifetime|swift }},
227
+ disabled: {{ obj.is_disabled()|swift }},
228
+ )
229
+ {% for arg_name in extra_metric_args if obj[arg_name] is defined %}
230
+ , {{ obj[arg_name]|swift }}
231
+ {% endfor %}
232
+ ),
233
+ {% elif obj.type == "labeled_memory_distribution" %}
234
+ .memoryDistribution(
235
+ cmd: CommonMetricData(
236
+ category: {{ obj.category|swift }},
237
+ name: {{ obj.name|swift }},
238
+ sendInPings: {{ obj.send_in_pings|swift }},
239
+ lifetime: {{ obj.lifetime|swift }},
240
+ disabled: {{ obj.is_disabled()|swift }},
241
+ )
242
+ {% for arg_name in extra_metric_args if obj[arg_name] is defined %}
243
+ , {{ obj[arg_name]|swift }}
244
+ {% endfor %}
245
+ ),
246
+ {% elif obj.type == "labeled_timing_distribution" %}
247
+ .timingDistribution(
248
+ cmd: CommonMetricData(
249
+ category: {{ obj.category|swift }},
250
+ name: {{ obj.name|swift }},
251
+ sendInPings: {{ obj.send_in_pings|swift }},
252
+ lifetime: {{ obj.lifetime|swift }},
253
+ disabled: {{ obj.is_disabled()|swift }},
254
+ )
255
+ {% for arg_name in extra_metric_args if obj[arg_name] is defined %}
256
+ , {{ obj[arg_name]|swift }}
257
+ {% endfor %}
258
+ ),
259
+ {% elif obj.labeled %}
260
+ .common(
261
+ cmd: CommonMetricData(
262
+ category: {{ obj.category|swift }},
263
+ name: {{ obj.name|swift }},
264
+ sendInPings: {{ obj.send_in_pings|swift }},
265
+ lifetime: {{ obj.lifetime|swift }},
266
+ disabled: {{ obj.is_disabled()|swift }},
267
+ )
268
+ {% for arg_name in extra_metric_args if obj[arg_name] is defined %}
269
+ , {{ obj[arg_name]|swift }}
270
+ {% endfor %}
271
+ ),
272
+ {% else %}
273
+ UNKNOWN
274
+ {% endif %}
225
275
  subMetric: {{ obj.name|camelize }}Label,
226
276
  labels: {{ obj.labels|swift }}
227
277
  )
@@ -0,0 +1,28 @@
1
+ # Any copyright is dedicated to the Public Domain.
2
+ # https://creativecommons.org/publicdomain/zero/1.0/
3
+
4
+ ---
5
+ $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
6
+
7
+
8
+ we_used_to_have_subcategory_length:
9
+ but_we_dont_any_more: &defaults
10
+ type: counter
11
+ expires: never
12
+ description: A test metric
13
+ bugs: [https://bugzil.la/2062403]
14
+ data_reviews: [https://www.example.com]
15
+ notification_emails: [glean-team@mozilla.com]
16
+
17
+ it.may_matter_that_theres_a_dot_here:
18
+ so_we_will_test_that_too:
19
+ <<: *defaults
20
+
21
+ # Subcategory length 30, Category length 40
22
+ start.abcdefghijklmnopqrstuvwxyzabcd.end:
23
+ no_problem:
24
+ <<: *defaults
25
+
26
+ a.b:
27
+ really_short_categories_are_allowed:
28
+ <<: *defaults
@@ -19,7 +19,7 @@ gleantest.lifetime:
19
19
  expires: never
20
20
  data_reviews: ['http://example.com']
21
21
  gleantest.with.way.too.long.category.name:
22
- test_event_inv_lt:
22
+ test_event_inv_lt: &valid_metric
23
23
  description: A test metric
24
24
  type: boolean
25
25
  bugs:
@@ -27,6 +27,9 @@ gleantest.with.way.too.long.category.name:
27
27
  notification_emails: ['nobody@example.com']
28
28
  expires: never
29
29
  data_reviews: ['http://example.com']
30
+ gleantest_with_way_too_long_category_name_and_no_subcategories:
31
+ test_metric:
32
+ <<: *valid_metric
30
33
  gleantest.short.category:
31
34
  very_long_metric_name_this_is_too_long_as_well_since_it_has_sooooo_many_characters:
32
35
  description: A test metric
@@ -0,0 +1,67 @@
1
+ # Any copyright is dedicated to the Public Domain.
2
+ # https://creativecommons.org/publicdomain/zero/1.0/
3
+
4
+ ---
5
+ $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
6
+
7
+ no_lint:
8
+ - EXPIRATION_DATE_TOO_FAR
9
+
10
+ category:
11
+ labeled_counter: &defaults
12
+ type: labeled_counter
13
+ lifetime: ping
14
+ description: >
15
+ Foo
16
+ bugs:
17
+ - https://bugzilla.mozilla.org/11137353
18
+ data_reviews:
19
+ - http://example.com/reviews
20
+ notification_emails:
21
+ - CHANGE-ME@example.com
22
+ send_in_pings:
23
+ - core
24
+ expires: 2100-01-01
25
+
26
+ labeled_boolean:
27
+ <<: *defaults
28
+ type: labeled_boolean
29
+
30
+ labeled_string:
31
+ <<: *defaults
32
+ type: labeled_string
33
+
34
+ labeled_custom_distribution:
35
+ <<: *defaults
36
+ type: labeled_custom_distribution
37
+ range_min: 0
38
+ range_max: 100
39
+ bucket_count: 10
40
+ histogram_type: linear
41
+ labels:
42
+ - aLabel
43
+ - 2label
44
+
45
+ labeled_memory_distribution:
46
+ <<: *defaults
47
+ type: labeled_memory_distribution
48
+ memory_unit: kilobyte
49
+ labels:
50
+ - aLabel
51
+ - 2label
52
+
53
+ labeled_timing_distribution:
54
+ <<: *defaults
55
+ type: labeled_timing_distribution
56
+ time_unit: millisecond
57
+ labels:
58
+ - aLabel
59
+ - 2label
60
+
61
+ labeled_quantity:
62
+ <<: *defaults
63
+ type: labeled_quantity
64
+ unit: tabs
65
+ labels:
66
+ - aLabel
67
+ - 2label
@@ -411,3 +411,35 @@ def test_object_metric(tmp_path):
411
411
  assert "var moduleIndex: Int? = null," in content
412
412
  assert "var ip: String? = null," in content
413
413
  assert "var trust: String? = null," in content
414
+
415
+
416
+ def test_labeled_metrics(tmp_path):
417
+ """
418
+ Assert that labeled metrics are created.
419
+ """
420
+ translate.translate(
421
+ ROOT / "data" / "single_labeled.yaml",
422
+ "kotlin",
423
+ tmp_path,
424
+ {"namespace": "Foo"},
425
+ )
426
+
427
+ assert set(x.name for x in tmp_path.iterdir()) == set(
428
+ ["Category.kt", "GleanBuildInfo.kt"]
429
+ )
430
+
431
+ with (tmp_path / "Category.kt").open("r", encoding="utf-8") as fd:
432
+ content = fd.read()
433
+ content = " ".join(content.split())
434
+
435
+ assert "LabeledMetricType<BooleanMetricType>" in content
436
+ assert "CommonMetricData(" in content
437
+ assert "LabeledMetricType<CounterMetricType>" in content
438
+ assert "LabeledMetricType<StringMetricType>" in content
439
+ assert "LabeledMetricType<QuantityMetricType>" in content
440
+ assert "LabeledMetricType<CustomDistributionMetricType>" in content
441
+ assert "CustomDistributionLabeledMetricData(" in content
442
+ assert "LabeledMetricType<TimingDistributionMetricType>" in content
443
+ assert "TimingDistributionLabeledMetricData(" in content
444
+ assert "LabeledMetricType<MemoryDistributionMetricType>" in content
445
+ assert "MemoryDistributionLabeledMetricData(" in content
@@ -357,6 +357,18 @@ def test_parser_schema_violation():
357
357
  - `description`: **Required.** A description of the key.
358
358
  Valid when `type`_ is `event`.
359
359
  """,
360
+ """
361
+ ```
362
+ gleantest_with_way_too_long_category_name_and_no_subcategories
363
+ ...
364
+ ```
365
+
366
+ 'gleantest_with_way_too_long_category_name_and_no_subcategories' is not valid under any of
367
+ the given schemas
368
+ 'gleantest_with_way_too_long_category_name_and_no_subcategories' is too long
369
+ 'gleantest_with_way_too_long_category_name_and_no_subcategories' is not one of
370
+ ['$schema', '$tags']
371
+ """,
360
372
  ]
361
373
 
362
374
  expected_errors = set(
@@ -371,6 +383,14 @@ def test_parser_schema_violation():
371
383
  for found_error, expected_error in zip(found, expected):
372
384
  assert found_error == expected_error
373
385
 
386
+ # If there are new errors and they're sorted after the expected list,
387
+ # the above checks won't find them. Log 'em, then assert 'em.
388
+ if len(found) > len(expected):
389
+ for i in range(len(expected), len(found)):
390
+ print(f"Unexpected error: {found[i]}")
391
+
392
+ assert len(found) == len(expected)
393
+
374
394
 
375
395
  def test_parser_empty():
376
396
  """1507792: Get a good error message if the metrics.yaml file is empty."""
@@ -1136,6 +1156,88 @@ def test_no_lint_sorted():
1136
1156
  assert all_objects.value["tags"]["tag"].no_lint == ["lint1", "lint2"]
1137
1157
 
1138
1158
 
1159
+ def test_allow_renaming_of_fields():
1160
+ results = parser.parse_objects(
1161
+ [
1162
+ util.add_required(
1163
+ {
1164
+ "category": {
1165
+ "metric": {
1166
+ "type": "object",
1167
+ "structure": {
1168
+ "type": "array",
1169
+ "items": {
1170
+ "type": "object",
1171
+ "properties": {
1172
+ "prop_a": {
1173
+ "type": "string",
1174
+ },
1175
+ "prop_b": {
1176
+ "type": "boolean",
1177
+ },
1178
+ },
1179
+ },
1180
+ },
1181
+ },
1182
+ },
1183
+ }
1184
+ ),
1185
+ ]
1186
+ )
1187
+ errs = list(results)
1188
+ assert len(errs) == 0
1189
+
1190
+ metrics = {
1191
+ metric.identifier(): metric.serialize(
1192
+ rename_fields={"_generate_structure": "structure"}
1193
+ )
1194
+ for category, probes in results.value.items()
1195
+ for probe_name, metric in probes.items()
1196
+ }
1197
+
1198
+ expected = {
1199
+ "category.metric": {
1200
+ "bugs": ["http://bugzilla.mozilla.org/12345678"],
1201
+ "data_reviews": ["https://example.com/review/"],
1202
+ "defined_in": {"line": 3},
1203
+ "description": "DESCRIPTION...",
1204
+ "disabled": False,
1205
+ "expires": "never",
1206
+ "gecko_datapoint": "",
1207
+ "in_session": False,
1208
+ "lifetime": "ping",
1209
+ "metadata": {},
1210
+ "no_lint": [],
1211
+ "notification_emails": ["nobody@example.com"],
1212
+ "send_in_pings": ["metrics"],
1213
+ "type": "object",
1214
+ "version": 0,
1215
+ "structure": {
1216
+ "type": "array",
1217
+ "items": {
1218
+ "type": "object",
1219
+ "properties": {
1220
+ "prop_a": {
1221
+ "type": "string",
1222
+ },
1223
+ "prop_b": {
1224
+ "type": "boolean",
1225
+ },
1226
+ },
1227
+ },
1228
+ },
1229
+ },
1230
+ }
1231
+ expected_json = json.dumps(expected, sort_keys=True, indent=2)
1232
+
1233
+ out_json = json.dumps(
1234
+ metrics,
1235
+ sort_keys=True,
1236
+ indent=2,
1237
+ )
1238
+ assert expected_json == out_json
1239
+
1240
+
1139
1241
  def test_no_internal_fields_exposed():
1140
1242
  """
1141
1243
  We accidentally exposed fields like `_config` and `_generate_enums` before.
@@ -1511,3 +1613,14 @@ def test_overriden_expire_epoch_must_be_valid(invalid_epoch):
1511
1613
  list(all_metrics)
1512
1614
 
1513
1615
  del os.environ["SOURCE_DATE_EPOCH"]
1616
+
1617
+
1618
+ def test_categories():
1619
+ """Test the basics of parsing oddly-named-or-structured categories."""
1620
+ all_metrics = parser.parse_objects(
1621
+ [ROOT / "data" / "categories.yaml"],
1622
+ config={"allow_reserved": False},
1623
+ )
1624
+
1625
+ errs = list(all_metrics)
1626
+ assert len(errs) == 0
@@ -380,3 +380,33 @@ def test_object_metric(tmp_path):
380
380
  assert "var moduleIndex: Int64?" in content
381
381
  assert "var ip: String?" in content
382
382
  assert "var trust: String?" in content
383
+
384
+
385
+ def test_labeled_metrics(tmp_path):
386
+ """
387
+ Assert that labeled metrics are created.
388
+ """
389
+ translate.translate(
390
+ ROOT / "data" / "single_labeled.yaml",
391
+ "swift",
392
+ tmp_path,
393
+ {"namespace": "Foo"},
394
+ )
395
+
396
+ assert set(x.name for x in tmp_path.iterdir()) == set(["Metrics.swift"])
397
+
398
+ with (tmp_path / "Metrics.swift").open("r", encoding="utf-8") as fd:
399
+ content = fd.read()
400
+ content = " ".join(content.split())
401
+
402
+ assert "LabeledMetricType<BooleanMetricType>" in content
403
+ assert ".common(" in content
404
+ assert "LabeledMetricType<CounterMetricType>" in content
405
+ assert "LabeledMetricType<StringMetricType>" in content
406
+ assert "LabeledMetricType<QuantityMetricType>" in content
407
+ assert "LabeledMetricType<CustomDistributionMetricType>" in content
408
+ assert ".customDistribution(" in content
409
+ assert "LabeledMetricType<TimingDistributionMetricType>" in content
410
+ assert ".timingDistribution(" in content
411
+ assert "LabeledMetricType<MemoryDistributionMetricType>" in content
412
+ assert ".memoryDistribution(" in content
@@ -1,21 +0,0 @@
1
- # Any copyright is dedicated to the Public Domain.
2
- # https://creativecommons.org/publicdomain/zero/1.0/
3
-
4
- ---
5
- $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
6
-
7
- category:
8
- labeled_counter:
9
- type: labeled_counter
10
- lifetime: user
11
- description: >
12
- Foo
13
- bugs:
14
- - https://bugzilla.mozilla.org/11137353
15
- data_reviews:
16
- - http://example.com/reviews
17
- notification_emails:
18
- - CHANGE-ME@example.com
19
- send_in_pings:
20
- - core
21
- expires: 2100-01-01
File without changes
File without changes
File without changes
File without changes