mozilla_schema_generator.common_ping

View Source

  1# -*- coding: utf-8 -*-
  2
  3# This Source Code Form is subject to the terms of the Mozilla Public
  4# License, v. 2.0. If a copy of the MPL was not distributed with this
  5# file, You can obtain one at http://mozilla.org/MPL/2.0/.
  6
  7import json
  8from typing import List
  9
 10from .generic_ping import GenericPing
 11from .probes import MainProbe
 12from .schema import Schema
 13from .utils import prepend_properties
 14
 15
 16class CommonPing(GenericPing):
 17    # Only includes probes that have been available at some point past
 18    # this version.
 19    # ONLY DECREMENT, or the schema will change in an incompatible way!
 20    MIN_FX_VERSION = 30
 21
 22    env_url = (
 23        "https://raw.githubusercontent.com/mozilla-services/mozilla-pipeline-schemas"
 24        "/{branch}/templates/include/telemetry/environment.1.schema.json"
 25    )
 26    probes_url = GenericPing.probe_info_base_url + "/firefox/all/main/all_probes"
 27
 28    def __init__(self, schema_url, **kwargs):
 29        super().__init__(schema_url, self.env_url, self.probes_url, **kwargs)
 30
 31    def get_schema(self):
 32        schema = super().get_schema()
 33
 34        try:
 35            schema.get(prepend_properties(("environment",)))
 36            return self._update_env(schema)
 37        except KeyError:
 38            return schema
 39
 40    def _update_env(self, schema):
 41        integer = {"type": "integer"}
 42        string = {"type": "string"}
 43        string_map = {"type": "object", "additionalProperties": string}
 44
 45        def with_description(dtype: dict, comment: str) -> dict:
 46            """Add a description to the types defined above."""
 47            return {**dtype, **dict(description=comment)}
 48
 49        if schema.property_exists(prepend_properties(("environment", "addons"))):
 50            active_addons = prepend_properties(
 51                ("environment", "addons", "activeAddons")
 52            ) + ("additionalProperties", "properties")
 53            schema.set_schema_elem(active_addons + ("foreignInstall",), integer)
 54            schema.set_schema_elem(active_addons + ("version",), string)
 55            schema.set_schema_elem(active_addons + ("userDisabled",), integer)
 56            schema.set_schema_elem(
 57                prepend_properties(
 58                    ("environment", "addons", "theme", "foreignInstall")
 59                ),
 60                integer,
 61            )
 62            schema.set_schema_elem(
 63                prepend_properties(("environment", "addons", "activeGMPlugins"))
 64                + ("additionalProperties", "properties", "applyBackgroundUpdates"),
 65                with_description(
 66                    integer,
 67                    "Cast into an integer via mozilla-schema-generator. See bug 1611027.",
 68                ),
 69            )
 70
 71        user_prefs = prepend_properties(("environment", "settings", "userPrefs"))
 72        if schema.property_exists(user_prefs):
 73            desc = (
 74                "User preferences - limited to an allowlist defined in "
 75                "`toolkit/components/telemetry/app/TelemetryEnvironment.jsm`"
 76            )
 77            schema.set_schema_elem(user_prefs, with_description(string_map, desc))
 78
 79        return schema
 80
 81    def get_env(self):
 82        env_property = json.loads("{" + self._get_json_str(self.env_url) + "}")
 83        env = {"type": "object", "properties": env_property}
 84
 85        return self._update_env(Schema(env))
 86
 87    def get_probes(self) -> List[MainProbe]:
 88        probes = self._get_json(self.probes_url)
 89
 90        filtered = {
 91            pname: pdef
 92            for pname, pdef in probes.items()
 93            if "nightly" in pdef["first_added"]
 94        }
 95
 96        # This will be made much better with PEP 572
 97        main_probes = [MainProbe(_id, defn) for _id, defn in filtered.items()]
 98        return [
 99            p
100            for p in main_probes
101            if int(p.definition["versions"]["last"]) > self.MIN_FX_VERSION
102        ]

class CommonPing(mozilla_schema_generator.generic_ping.GenericPing): View Source

 17class CommonPing(GenericPing):
 18    # Only includes probes that have been available at some point past
 19    # this version.
 20    # ONLY DECREMENT, or the schema will change in an incompatible way!
 21    MIN_FX_VERSION = 30
 22
 23    env_url = (
 24        "https://raw.githubusercontent.com/mozilla-services/mozilla-pipeline-schemas"
 25        "/{branch}/templates/include/telemetry/environment.1.schema.json"
 26    )
 27    probes_url = GenericPing.probe_info_base_url + "/firefox/all/main/all_probes"
 28
 29    def __init__(self, schema_url, **kwargs):
 30        super().__init__(schema_url, self.env_url, self.probes_url, **kwargs)
 31
 32    def get_schema(self):
 33        schema = super().get_schema()
 34
 35        try:
 36            schema.get(prepend_properties(("environment",)))
 37            return self._update_env(schema)
 38        except KeyError:
 39            return schema
 40
 41    def _update_env(self, schema):
 42        integer = {"type": "integer"}
 43        string = {"type": "string"}
 44        string_map = {"type": "object", "additionalProperties": string}
 45
 46        def with_description(dtype: dict, comment: str) -> dict:
 47            """Add a description to the types defined above."""
 48            return {**dtype, **dict(description=comment)}
 49
 50        if schema.property_exists(prepend_properties(("environment", "addons"))):
 51            active_addons = prepend_properties(
 52                ("environment", "addons", "activeAddons")
 53            ) + ("additionalProperties", "properties")
 54            schema.set_schema_elem(active_addons + ("foreignInstall",), integer)
 55            schema.set_schema_elem(active_addons + ("version",), string)
 56            schema.set_schema_elem(active_addons + ("userDisabled",), integer)
 57            schema.set_schema_elem(
 58                prepend_properties(
 59                    ("environment", "addons", "theme", "foreignInstall")
 60                ),
 61                integer,
 62            )
 63            schema.set_schema_elem(
 64                prepend_properties(("environment", "addons", "activeGMPlugins"))
 65                + ("additionalProperties", "properties", "applyBackgroundUpdates"),
 66                with_description(
 67                    integer,
 68                    "Cast into an integer via mozilla-schema-generator. See bug 1611027.",
 69                ),
 70            )
 71
 72        user_prefs = prepend_properties(("environment", "settings", "userPrefs"))
 73        if schema.property_exists(user_prefs):
 74            desc = (
 75                "User preferences - limited to an allowlist defined in "
 76                "`toolkit/components/telemetry/app/TelemetryEnvironment.jsm`"
 77            )
 78            schema.set_schema_elem(user_prefs, with_description(string_map, desc))
 79
 80        return schema
 81
 82    def get_env(self):
 83        env_property = json.loads("{" + self._get_json_str(self.env_url) + "}")
 84        env = {"type": "object", "properties": env_property}
 85
 86        return self._update_env(Schema(env))
 87
 88    def get_probes(self) -> List[MainProbe]:
 89        probes = self._get_json(self.probes_url)
 90
 91        filtered = {
 92            pname: pdef
 93            for pname, pdef in probes.items()
 94            if "nightly" in pdef["first_added"]
 95        }
 96
 97        # This will be made much better with PEP 572
 98        main_probes = [MainProbe(_id, defn) for _id, defn in filtered.items()]
 99        return [
100            p
101            for p in main_probes
102            if int(p.definition["versions"]["last"]) > self.MIN_FX_VERSION
103        ]

CommonPing(schema_url, **kwargs) View Source

29    def __init__(self, schema_url, **kwargs):
30        super().__init__(schema_url, self.env_url, self.probes_url, **kwargs)

MIN_FX_VERSION = 30

env_url = 'https://raw.githubusercontent.com/mozilla-services/mozilla-pipeline-schemas/{branch}/templates/include/telemetry/environment.1.schema.json'

probes_url = 'https://probeinfo.telemetry.mozilla.org/firefox/all/main/all_probes'

def get_schema(self): View Source

32    def get_schema(self):
33        schema = super().get_schema()
34
35        try:
36            schema.get(prepend_properties(("environment",)))
37            return self._update_env(schema)
38        except KeyError:
39            return schema

def get_env(self): View Source

82    def get_env(self):
83        env_property = json.loads("{" + self._get_json_str(self.env_url) + "}")
84        env = {"type": "object", "properties": env_property}
85
86        return self._update_env(Schema(env))

def get_probes(self) -> List[mozilla_schema_generator.probes.MainProbe]: View Source

 88    def get_probes(self) -> List[MainProbe]:
 89        probes = self._get_json(self.probes_url)
 90
 91        filtered = {
 92            pname: pdef
 93            for pname, pdef in probes.items()
 94            if "nightly" in pdef["first_added"]
 95        }
 96
 97        # This will be made much better with PEP 572
 98        main_probes = [MainProbe(_id, defn) for _id, defn in filtered.items()]
 99        return [
100            p
101            for p in main_probes
102            if int(p.definition["versions"]["last"]) > self.MIN_FX_VERSION
103        ]

Inherited Members

mozilla_schema_generator.generic_ping.GenericPing: probe_info_base_url; default_encoding; default_max_size; cache_dir; branch_name; schema_url; generate_schema; make_schema