Merge pull request #126 from brizental/reproducible-docs

Use lists instead of sets in Labeled types labels

HISTORY.rst

@@ -5,6 +5,14 @@ History
 Unreleased
 ----------
 
+1.9.4 (2019-10-16)
+------------------
+
+* Use lists instead of sets in Labeled types labels to ensure that
+  the order of the labels passed to the `metrics.yaml` is kept.
+
+* `glinter` will now check for duplicate labels and error if there are any.
+
 1.9.3 (2019-10-09)
 ------------------
 

glean_parser/metrics.py

@@ -303,7 +303,7 @@ class Uuid(Metric):
 
 @dataclass
 class Labeled(Metric):
-    labels: Set[str] = None
+    labels: List[str] = None
     labeled = True
 
 

glean_parser/schemas/metrics.1-0-0.schema.yaml

@@ -323,6 +323,7 @@ definitions:
           Valid with any of the labeled metric types.
         anyOf:
           - type: array
+            uniqueItems: true
             items:
               $ref: "#/definitions/labeled_metric_id"
             maxItems: 16

tests/test_parser.py

@@ -35,7 +35,7 @@ def test_parser():
             assert isinstance(metric_val, metrics.Metric)
             assert isinstance(metric_val.lifetime, metrics.Lifetime)
             if getattr(metric_val, "labels", None) is not None:
-                assert isinstance(metric_val.labels, set)
+                assert isinstance(metric_val.labels, list)
 
     pings = all_metrics.value["pings"]
     assert pings["custom_ping"].name == "custom_ping"