Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Unreleased

- Go server: Add support for `labeled_boolean` metrics with static labels ([AE-1250](https://mozilla-hub.atlassian.net/browse/AE-1250))
- BUGFIX: Go server: Serialize nil `string_list` metrics as empty arrays instead of null ([#837](https://github.com/mozilla/glean_parser/pull/837))

## 19.0.0

Expand Down
8 changes: 8 additions & 0 deletions glean_parser/templates/go_server.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,14 @@ func (g GleanEventsLogger) Record{{ ping|ping_type_name }}(
requestInfo RequestInfo,
params {{ ping|ping_type_name }},
) error {
{% if metrics_by_type['string_list'] %}
{% for metric in metrics_by_type['string_list'] %}
// Ensure nil string_list metrics serialize as empty arrays, not null
if params.{{ metric|metric_argument_name }} == nil {
params.{{ metric|metric_argument_name }} = []string{}
}
{% endfor %}
{% endif %}
metrics := metrics{
{% for metric_type, metrics in metrics_by_type.items() %}
{% if metric_type != 'event' %}
Expand Down
4 changes: 4 additions & 0 deletions tests/data/server_custom_ping_only_compare.go
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ func (g GleanEventsLogger) RecordServerTelemetryScenarioOnePing(
requestInfo RequestInfo,
params ServerTelemetryScenarioOnePing,
) error {
// Ensure nil string_list metrics serialize as empty arrays, not null
if params.MetricRequestStringList == nil {
params.MetricRequestStringList = []string{}
}
metrics := metrics{
"string": {
"metric.name": params.MetricName,
Expand Down
8 changes: 8 additions & 0 deletions tests/data/server_events_and_custom_ping_compare.go
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ func (g GleanEventsLogger) RecordEventsPing(
requestInfo RequestInfo,
params EventsPing,
) error {
// Ensure nil string_list metrics serialize as empty arrays, not null
if params.MetricRequestStringList == nil {
params.MetricRequestStringList = []string{}
}
metrics := metrics{
"string": {
"metric.name": params.MetricName,
Expand Down Expand Up @@ -272,6 +276,10 @@ func (g GleanEventsLogger) RecordServerTelemetryScenarioOnePing(
requestInfo RequestInfo,
params ServerTelemetryScenarioOnePing,
) error {
// Ensure nil string_list metrics serialize as empty arrays, not null
if params.MetricRequestStringList == nil {
params.MetricRequestStringList = []string{}
}
metrics := metrics{
"string": {
"metric.name": params.MetricName,
Expand Down
4 changes: 4 additions & 0 deletions tests/data/server_events_only_compare.go
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ func (g GleanEventsLogger) RecordEventsPing(
requestInfo RequestInfo,
params EventsPing,
) error {
// Ensure nil string_list metrics serialize as empty arrays, not null
if params.MetricRequestStringList == nil {
params.MetricRequestStringList = []string{}
}
metrics := metrics{
"string": {
"metric.name": params.MetricName,
Expand Down
61 changes: 61 additions & 0 deletions tests/test_go_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,67 @@ def test_run_logging_labeled_boolean(tmp_path):
assert feature_flags.get("feature_four") is None


@pytest.mark.go_dependency
def test_run_logging_nil_string_list(tmp_path):
"""Test that nil string_list metrics serialize as empty arrays, not null."""
glean_module_path = tmp_path / "glean"

translate.translate(
[
ROOT / "data" / "go_server_events_and_custom_ping_metrics.yaml",
ROOT / "data" / "go_server_events_and_custom_ping_pings.yaml",
],
"go_server",
glean_module_path,
)

code = """
logger.RecordEventsPing(
glean.RequestInfo{
UserAgent: "glean-test/1.0",
IpAddress: "127.0.0.1",
},
glean.EventsPing{
MetricName: "string value",
MetricRequestBool: true,
MetricRequestCount: 10,
MetricRequestDatetime: time.Now(),
// MetricRequestStringList intentionally omitted (nil)
Event: glean.BackendTestEventEvent{
EventFieldString: "event extra string value",
EventFieldQuantity: 100,
EventFieldBool: false,
},
},
)
"""

logged_output = run_logger(tmp_path, code)
logged_output = json.loads(logged_output)
fields = logged_output["Fields"]
payload_str = fields["payload"]
payload = json.loads(payload_str)

# Verify string_list is an empty array, not null
string_list_value = payload["metrics"]["string_list"]["metric.request_string_list"]
assert string_list_value == [], (
f"Expected empty array for nil string_list, got: {string_list_value}"
)

# Validate payload against Glean schema
schema_url = (
"https://raw.githubusercontent.com/mozilla-services/"
"mozilla-pipeline-schemas/main/"
"schemas/glean/glean/glean.1.schema.json"
)

input = io.StringIO(payload_str)
output = io.StringIO()
assert validate_ping.validate_ping(input, output, schema_url=schema_url) == 0, (
output.getvalue()
)


@pytest.mark.go_dependency
def test_run_logging_custom_ping_with_event(tmp_path):
glean_module_path = tmp_path / "glean"
Expand Down