1733395 - Don't include "OrderedDict" in schema validation error messages in glean_parser

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, defect, P3)

Description

[Michael Droettboom [:mdroettboom]]

We currently use "OrderedDict" to load the schemas in glean_parser so the order of elements in the original file is preserved. Unfortunately, when the jsonschema library prints validation error messages, these messages have explicit OrderedDict([('foo', 'bar')]) reprs rather than the JSON-like {'foo': 'bar'} that our users would expect.

Besides being confusing, this bloats the error messages and makes our unit tests more susceptible to breakage across different versions of jsonschema.

This OrderedDict workaround is only required on Python 3.6 and earlier, since in Python 3.7, dicts are order-preserving by default. Since Python 3.6 is rather far in the past now, it probably makes sense to only do this workaround there, which would improve the error messages on newer Python versions.

Comment 1

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/glean_parser/pull/394

Comment 2

[Jan-Erik Rediger [:janerik]]

badboy merged PR #394: "Bug 1733395: Improve schema validation error messages" in 3ce17cc.