869989 - Add X-Bugzilla-Mentors field to bugmail headers and an indication to mentors in bugmail body

Status: RESOLVED FIXED

(bugzilla.mozilla.org :: Extensions, defect)

Comment 1

[Mike Hoye [:mhoye]]

(Wat? I just hit "enter" when I put in a title, and it ships an empty bug? Well I'll file _another_ bug! So there!) 

ON TO THE ACTUAL TOPIC:

A specific piece of bugmail should be provided to mentors - either a searchable, a nag or a summary - notifying people with mentored bugs of the current state of mentored bugs, and of any recent activity.

A small number of developers have expressed interest in this, to prevent mentored bugs (and their mentored contributors!) from getting lost in the Bugmail Deluge.

Thanks!

- mhoye

Comment 2

[:glob ✱]

i suspect this can be achieved by having the mentors themselves set up a whine -- https://bugzilla.mozilla.org/editwhines.cgi

would this be suitable, or are you after something else?

it isn't clear from your description what your bug selection criteria would be, nor what the contents of this email should contain.

Comment 3

[Liz Henry (:lizzard) (relman/hg->git project)]

Maybe adding the whiteboard tags into the X-Bugzilla headers would be useful. Then people could filter the existing bugmail based on that.

Comment 4

[Mike Hoye [:mhoye]]

Sorry, let me clarify - 

What I actually want is for bugs that somebody has agreed to mentor have some Special Quality to them such that the mentor can see or search for at a glance to see what questions need answering, what bugs are getting old and/or quiet (and who needs to be ping about that) so forth.

Adding the Whiteboard tags to the X-Bugzilla headers would probably address the problem, without impacting anyone disinterested.

Comment 5

[David Lawrence [:dkl]]

(In reply to Mike Hoye [:mhoye] from comment #4)
> Sorry, let me clarify - 
> 
> What I actually want is for bugs that somebody has agreed to mentor have
> some Special Quality to them such that the mentor can see or search for at a
> glance to see what questions need answering, what bugs are getting old
> and/or quiet (and who needs to be ping about that) so forth.
> 
> Adding the Whiteboard tags to the X-Bugzilla headers would probably address
> the problem, without impacting anyone disinterested.

I am fine with doing that as long as there are no issues with having a free form text field as an email header. We would need to take precautions with how we encode it.

glob, objections?

dkl

Comment 6

[Josh Matthews [:jdm]]

I would prefer to not limit this to adding more headers, since as discussed previously those aren't available to Gmail users.

Comment 7

[:glob ✱]

(In reply to David Lawrence [:dkl] from comment #5)
> glob, objections?

the whiteboard field is mediumtext and can contain a massive amount of data, including possibly sensitive information.  it should not be put into the header.

(In reply to Josh Matthews [:jdm] from comment #6)
> I would prefer to not limit this to adding more headers, since as discussed
> previously those aren't available to Gmail users.

likewise i'm against adding more crud into the bugmail body to work around gmail's draconian limitations :)


i don't see how adding something to bugmail will help mentors identify bugs which have stalled. i can see how it would help them filter bugmail for active mentored bugs, but it wouldn't alert them to bugs which aren't triggering bugmail.

i can't help but feel it would be easier for mentors to create a saved search which lists their open mentored bugs, and either set up a whine to have that list automatically emailed to them for auditing, or add that search to the dashboard.

Comment 8

[Reed Loden [:reed]]

(In reply to Byron Jones ‹:glob› from comment #7)
> (In reply to David Lawrence [:dkl] from comment #5)
> > glob, objections?
> 
> the whiteboard field is mediumtext and can contain a massive amount of data,
> including possibly sensitive information.  it should not be put into the
> header.

We've already discussed this before (in bug 803102). Agree with glob here. Definitely should not include the contents of the whiteboard in an e-mail header.

Comment 9

[:glob ✱]

this can be addressed by adding a real mentor field (bug 649691) and making sure that that it's included in the x-headers.  gmail using mentors will be able to use search/whine/dashboard against this field instead.

Comment 10

[:glob ✱]

while discussing this bug with dkl, i realised that the Review extension already parses the whiteboard field for displaying review suggestions, so we can add the x-header now.

i'll also see if it's viable to include something in the bugmail footer for bugs which you're the mentor of.

Comment 11

[:glob ✱]

Attachment: 869989_1.patch

requires the patch from bug 942029

adds X- header:
> X-Bugzilla-Mentors: [e-mail], [e-mail]

adds a note for gmail users:
> -------------------------------
> Product/Component: Core :: Layout: HTML Frames
> You are mentoring this Bug

Comment 12

[David Lawrence [:dkl]]

Comment on attachment 8336608 [details] [diff] [review]
869989_1.patch

Review of attachment 8336608 [details] [diff] [review]:
-----------------------------------------------------------------

r=dkl

::: extensions/BMO/template/en/default/email/bugmail.txt.tmpl
@@ +38,4 @@
>  
>  -------------------------------
>  Product/Component: [%+ bug.product +%] :: [%+ bug.component %]
> +[%+ "You are mentoring this " _ terms.Bug IF bug.is_mentor(to_user) %]

nit: terms.bug

Comment 13

[:glob ✱]

Committing to: bzr+ssh://[e-mail]/bmo/4.2/
modified extensions/BMO/Extension.pm
modified extensions/BMO/template/en/default/email/bugmail.html.tmpl
modified extensions/BMO/template/en/default/email/bugmail.txt.tmpl
modified extensions/Review/Extension.pm
Committed revision 9170.

Comment 14

[Magnus Melin [:mkmelin]]

This sounds very useful, but it doesn't seem to work. I'd assume I would get the header e.g. for bug 707489 because I'm in mentoring in the white board. Is there anything else one have to do?

Comment 15

[Josh Matthews [:jdm]]

I, too, have not been receiving any messages containing the expected footer addition; bug 946897 should have triggered, I'm pretty sure. I know of other people who have the same complaint as well.

Comment 16

[David Lawrence [:dkl]]

(In reply to Josh Matthews [:jdm] from comment #15)
> I, too, have not been receiving any messages containing the expected footer
> addition; bug 946897 should have triggered, I'm pretty sure. I know of other
> people who have the same complaint as well.

It is tricky. For yours I can understand it not adding the header. The code works by looking at [mentor=XXX] and doing a look up of XXX. If more than one user matches the query, it will not add the header. In your case you have 'jdm' which has multiple user matches. If you change it however to ':jdm' instead, it will work as only one user matches that string. 

However, mkmelin should work as it only matches one user anyway. I am looking into why that is not working right now.

Once we switch over to a normal custom field in the near future this won't be as much of an issue but as long as we use the whiteboard, we need to adhere to a specific format.

dkl

Comment 17

[David Lawrence [:dkl]]

(In reply to David Lawrence [:dkl] from comment #16) 
> However, mkmelin should work as it only matches one user anyway. I am
> looking into why that is not working right now.

I have tried to reproduce this locally and am unable to do so. I see the proper header and footer text properly when duplicating the whiteboard and making sure mkmelin is in the cc list of a bug after making a change. Can
you provide an attachment with a recent raw email that you have received which should have had the header?

glob, do you have an idea on what may be causing this as well?

dkl

Comment 18

[David Lawrence [:dkl]]

(In reply to David Lawrence [:dkl] from comment #16)
> It is tricky. For yours I can understand it not adding the header. The code
> works by looking at [mentor=XXX] and doing a look up of XXX. If more than
> one user matches the query, it will not add the header. In your case you
> have 'jdm' which has multiple user matches. If you change it however to
> ':jdm' instead, it will work as only one user matches that string. 

Actually I resend this answer as I looked at code once more and it actually does create an alternate query by prepending a ':' in from of the mentor value. It tries '*:XXX*' and '*XXX*' both so 'jdm' should have been added if it matched a single value for either of those cases. Gmail should not be altering the body text so you should at least see the footer. I will talk to glob tomorrow about what may be causing this. A sample email notification would be helpful as well.

dkl

Comment 19

[Josh Matthews [:jdm]]

Attachment: raw email from bug 946897

Notice that there's no X-Bugzilla-Mentor header either.

Comment 20

[David Lawrence [:dkl]]

(In reply to Josh Matthews [:jdm] from comment #19)
> Created attachment 8348351 [details]
> raw email from bug 946897
> 
> Notice that there's no X-Bugzilla-Mentor header either.

It would be X-Bugzilla-Mentors to be exact but yes I do not see them in your attachment. On my test instance, it displays below the MIME-Version line:

[...]
Auto-Submitted: auto-generated
MIME-Version: 1.0
X-Bugzilla-Mentors: [e-mail]
X-Bugzilla-Tracking: status-firefox25:unaffected status-firefox26:unaffected
[...]

and then further down I see:

[...]
-- 
Configure bugmail: http://bzweb/stable/userprefs.cgi?tab=email

-------------------------------
Product/Component: Core :: Build Config
You are mentoring this bug
[...]

Glob are you able to reproduce this locally?

dkl

Comment 21

[:glob ✱]

i've filed bug 951016 to track this; let's move the discussion there please.