# -*- coding: utf-8 -*-
# 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/.
"""
Outputter to generate server Go code for collecting events.
This outputter is different from the rest of the outputters in that the code it
generates does not use the Glean SDK. It is meant to be used to collect events
in server-side environments. In these environments SDK assumptions to measurement
window and connectivity don't hold.
Generated code takes care of assembling pings with metrics, and serializing to messages
conforming to Glean schema.
Warning: this outputter supports limited set of metrics,
see `SUPPORTED_METRIC_TYPES` below.
Generated code creates two methods for each ping (`RecordPingX` and `RecordPingXWithoutUserInfo`)
that are used for submitting (logging) them.
If pings have `event` metrics assigned, they can be passed to these methods.
"""
from collections import defaultdict
from pathlib import Path
from typing import Any, Dict, Optional, List
from . import __version__
from . import metrics
from . import util
# Adding a metric here will require updating the `generate_metric_type` function
# and require adjustments to `metrics` variables the the template.
SUPPORTED_METRIC_TYPES = ["string", "quantity", "event", "datetime", "boolean"]
[docs]
def generate_ping_type_name(ping_name: str) -> str:
return f"{util.Camelize(ping_name)}Ping"
[docs]
def generate_ping_events_type_name(ping_name: str) -> str:
return f"{util.Camelize(ping_name)}PingEvent"
[docs]
def generate_event_type_name(metric: metrics.Metric) -> str:
return f"{util.Camelize(metric.category)}{util.Camelize(metric.name)}Event"
[docs]
def generate_metric_name(metric: metrics.Metric) -> str:
return f"{metric.category}.{metric.name}"
[docs]
def generate_metric_argument_name(metric: metrics.Metric) -> str:
return f"{util.Camelize(metric.category)}{util.Camelize(metric.name)}"
[docs]
def generate_metric_type(metric_type: str) -> str:
if metric_type == "quantity":
return "int64"
elif metric_type == "string":
return "string"
elif metric_type == "boolean":
return "bool"
elif metric_type == "datetime":
return "time.Time"
else:
print("❌ Unable to generate Go type from metric type: " + metric_type)
exit
return "NONE"
[docs]
def clean_string(s: str) -> str:
return s.replace("\n", " ").rstrip()
[docs]
def output_go(
objs: metrics.ObjectTree, output_dir: Path, options: Optional[Dict[str, Any]]
) -> None:
"""
Given a tree of objects, output Go code to `output_dir`.
The output is a single file containing all the code for assembling pings with
metrics, serializing, and submitting.
: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.
"""
template = util.get_jinja2_template(
"go_server.jinja2",
filters=(
("ping_type_name", generate_ping_type_name),
("ping_events_type_name", generate_ping_events_type_name),
("event_type_name", generate_event_type_name),
("event_extra_name", generate_extra_name),
("metric_name", generate_metric_name),
("metric_argument_name", generate_metric_argument_name),
("go_metric_type", generate_metric_type),
("clean_string", clean_string),
),
)
# unique list of event metrics used in any ping
event_metrics: List[metrics.Metric] = []
# Go through all metrics in objs and build a map of
# ping->list of metric categories->list of metrics
# for easier processing in the template.
ping_to_metrics: Dict[str, Dict[str, List[metrics.Metric]]] = defaultdict(dict)
for _category_key, category_val in objs.items():
for _metric_name, metric in category_val.items():
if isinstance(metric, metrics.Metric):
if metric.type not in SUPPORTED_METRIC_TYPES:
print(
"❌ Ignoring unsupported metric type: "
+ f"{metric.type}:{metric.name}."
+ " Reach out to Glean team to add support for this"
+ " metric type."
)
continue
for ping in metric.send_in_pings:
if metric.type == "event" and metric not in event_metrics:
event_metrics.append(metric)
metrics_by_type = ping_to_metrics[ping]
metrics_list = metrics_by_type.setdefault(metric.type, [])
metrics_list.append(metric)
PING_METRIC_ERROR_MSG = (
" Server-side environment is simplified and this"
+ " parser doesn't generate individual metric files. Make sure to pass all"
+ " your ping and metric definitions in a single invocation of the parser."
)
if not ping_to_metrics:
print("❌ No pings with metrics found." + PING_METRIC_ERROR_MSG)
return
extension = ".go"
filepath = output_dir / ("server_events" + extension)
with filepath.open("w", encoding="utf-8") as fd:
fd.write(
template.render(
parser_version=__version__,
pings=ping_to_metrics,
events=event_metrics
)
)