1311827 - Highlight modifications more in change notifier emails

Status: RESOLVED FIXED

(Release Engineering Graveyard :: Applications: Balrog (backend), defect, P3)

Description

[Nick Thomas [:nthomas] (UTC+12)]

For rule changes, we're sending text/plain emails with content like this:

Changed by: ffxbld
Row(s) to be updated as follows:
{'alias': 'firefox-release' (unchanged),
 'backgroundRate': 100L (unchanged),
 'buildID': None (unchanged),
 'buildTarget': None (unchanged),
 'channel': 'release' (unchanged),
 'comment': 'default release rule updated by buildbot, DO NOT DELETE' (unchanged),
 'data_version': 96L ---> 97L,
 'distVersion': None (unchanged),
 'distribution': None (unchanged),
 'headerArchitecture': None (unchanged),
 'locale': None (unchanged),
 'mapping': 'Firefox-49.0.1-build3' ---> u'Firefox-49.0.2-build2',
 'osVersion': None (unchanged),
 'priority': 90L (unchanged),
 'product': 'Firefox' (unchanged),
 'rule_id': 145L (unchanged),
 'systemCapabilities': None (unchanged),
 'update_type': 'minor' (unchanged),
 'version': None (unchanged),
 'whitelist': None (unchanged)}

Everything is there, but you have to know to look for the lines with '--->' to get the gist of it. If we added an text/html part to the email, we could draw attention to changes using text in bold or a different colour.

Comment 1

[Simon Fraser [:sfraser] ⌚️GMT]

In the text/plain part, could we start the email with a diff, so that the changes are up-front? Or even just the current text `|grep -v unchanged`

How about counting the number of changes in the subject line, for example: "UPDATE to rules: 3 changes"

Comment 2

[Chris AtLee [:catlee]]

is data version important to highlight?

Comment 3

[Nick Thomas [:nthomas] (UTC+12)]

Attachment: Separate out the changing values and show them first

Just enough to scratch the itch.

Comment 4

[[github robot]]

Commit pushed to master at https://github.com/mozilla/balrog

https://github.com/mozilla/balrog/commit/61594203a717cad9e5558e6dba1ca32af2c1ed82
bug 1311827: Highlight modifications more in change notifier emails (#172). r=bhearsum

Comment 5

[[e-mail] (:bhearsum)]

Looks like this is working well in stage:
Changed by: [e-mail]
Row(s) to be updated as follows:
Changed values:
{'data_version': 165L ---> 166L,
 'mapping': 'Firefox-44.0b2-build1' ---> u'Firefox-49.0.1-build3'}

Unchanged:
{'alias': None,
 'backgroundRate': 100L,
 'buildID': None,
 'buildTarget': None,
 'channel': 'beta',
 'comment': None,
 'distVersion': None,
 'distribution': None,
 'fallbackMapping': None,
 'headerArchitecture': None,
 'locale': None,
 'osVersion': None,
 'priority': 90L,
 'product': 'Firefox',
 'rule_id': 32L,
 'systemCapabilities': None,
 'update_type': 'minor',
 'version': None,
 'whitelist': None}

Comment 6

[[e-mail] (:bhearsum)]

In production. Were you planning to leave this open for other improvements, Nick?

Comment 7

[Nick Thomas [:nthomas] (UTC+12)]

The text changes are enough for me so FIXED would be OK. If you would like to keep it open for contributors to work on that's fine too.

Comment 8

[[e-mail] (:bhearsum)]

I'm going to close this as fixed, we can file bugs for specific follow-ups.