Skip to content

Bug 1883428 - Improve the needinfo email situation - #2698

Open
Xzzz wants to merge 26 commits into
mozilla:masterfrom
Xzzz:bug-1883428
Open

Xzzz wants to merge 26 commits into
mozilla:masterfrom
Xzzz:bug-1883428

Conversation

@Xzzz

@Xzzz Xzzz commented Aug 12, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Needinfo and other flag notifications (request/grant/deny/clear) were previously sent as a separate email via Flag::notify(). This decouples that: flag events are now rendered as a section inside the normal bugmail, sent through Bugzilla/BugMail.pm, instead of a standalone notify() email.

  • Bugzilla/BugMail.pm: _get_flag_mail_events() gathers flag activity (requested/answered, including needinfo auto-clear on reply - status X, which the old notify()-based flow handled but was initially missed here) and resolves the related attachment so templates can check can_review / external_redirect
  • Core template/en/default/email/bugmail.{txt,html}.tmpl and the BMO override extensions/BMO/template/en/default/email/bugmail.{txt,html}.tmpl render a flag_events section, with a Hook.process('flag_event', ...) extension point
  • extensions/BMO fully overrides the core bugmail templates on this instance, so the flag-event content is ported into both
  • Needinfo and Splinter hook fragments (reporter-aware wording + user-guide link; review-tool link) are re-added under the new flag_event hook, replacing the ones orphaned by the earlier removal of request/email.txt.tmpl. Splinter's review link now gates on attachment.can_review instead of ispatch, so it also covers GitHub PR/Phabricator attachments, matching other call sites in the codebase
  • BMO's own external-redirect attachment link is inlined directly in the BMO templates rather than hooked, since TT's TRIM strips each hook fragment's edges independently and concatenating BMO's + Splinter's fragments with no separator produced garbled text when both fire on the same event

Test plan

  • Verified end-to-end on a local instance: needinfo request, needinfo auto-clear (reply), needinfo requested-from-reporter wording, plain review flag (Splinter link), review flag on a GitHub PR attachment (both BMO and Splinter links render, correctly separated), both text and HTML bugmail formats
  • perl -c on modified Perl files
  • Grepped the repo for orphaned references to the removed Flag::notify/hook fragments

References

Xzzz added 3 commits August 12, 2026 15:48
…necessary emails)

Remove Flag::notify()'s separate text-only flag emails and instead add flag requestee/requester
and per-flagtype cc_list addresses to the recipient list built by BugMail.pm, so
flag grant/deny/needinfo notices ride along with the normal bug-change email instead of
arriving as a second, plaintext-only message (also fixes bug 1410772).

- Add REL_FLAG_REQUESTEE/REL_FLAG_REQUESTER/REL_FLAG_TYPE_CC relationships; requestee/requester
  respect the existing EVT_FLAG_REQUESTED/EVT_REQUESTED_FLAG opt-in, type_cc is unconditional
  (matches notify()'s prior behavior)
- Add a flag-events section to bugmail.txt.tmpl/bugmail.html.tmpl, with more descriptive wording
  for the needinfo requestee
- Preserve cc_list addresses with no Bugzilla account via a small side path (bugmail-flagtype-cc.txt.tmpl)
  sent directly through MessageToMTA
…templates

The previous commit added a flag-event section to the core bugmail templates, but
extensions/BMO/template/.../email/bugmail.{txt,html}.tmpl fully overrides those
core templates, so the new section was never executed. Also fixes a real gap the
core-only version missed: needinfo's normal resolution (auto-clear to flag status 'X'
when the requestee replies) wasn't handled (only +/- were) so the single most common
needinfo outcome silently produced no "your request was answered" notice. notify()
covered this case; now BugMail.pm does too, with matching "cleared" wording alongside
"granted" and "denied".

- Port the flag-event section into the BMO override templates (txt + html), with
  a Hook.process('flag_event', ...) extension point mirroring the old request/email.txt.tmpl
  hook mechanism
- Add Needinfo and Splinter hook fragments preserving their previous content
  (reporter-aware wording + wiki guide link; Splinter review-tool link, now gated
  on attachment.can_review so it also covers GitHub PR/Phabricator attachments,
  not just ispatch)
- Inline BMO's own external-redirect (GitHub PR) attachment link directly in the
  BMO templates rather than hooking it: hooking it caused two fragments (BMO + Splinter)
  to concatenate with no separator when both fire for the same event, since TT's TRIM
  strips whitespace at each independently compiled hook fragment's own edges.
  The original design avoided this by having the parent template render that piece
  directly instead of through the shared print-hook slot
- Resolve the attachment object in _get_flag_mail_events() so hooks can check
  can_review/external_redirect
- Remove the three hook fragments orphaned by the previous commit's deletion of
  request/email.txt.tmpl
Comment thread Bugzilla/BugMail.pm Outdated
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/BugMail.pm
Comment thread template/en/default/email/bugmail-flagtype-cc.txt.tmpl
Comment thread Bugzilla/BugMail.pm Outdated
Comment thread template/en/default/global/reason-descs.none.tmpl
Xzzz added 6 commits August 19, 2026 17:12
…g X status wording and missing body-headers

- terms was never defined: added `[% PROCESS global/variables.none.tmpl %]` to fix it
- status 'X' (cleared) rendered as "denied": now render as "cleared" (like the other templates)
- added missing `@@body-headers@@` placeholder: without it, BMO's `_replace_placeholder_in_part` got nothing to substitute and these mails lose the body headers the old request/email.txt.tmpl carried
…achment visibility at dequeue

- enqueue(): flatten flag_events before it hits the job queue
- dequeue(): inflate flag_events and re-check attachment visibility at send time
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/BugMail.pm
Comment thread template/en/default/request/email.txt.tmpl
Comment thread Bugzilla/BugMail.pm Outdated
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/BugMail.pm
Xzzz added 2 commits August 21, 2026 18:12
- don't add the requester as recipient when they cleared their own request
- give flag-type cc_list account holders the actual event content
- don't drop flag-only bugmail when there are no diffs/comments
- restore X-Bugzilla-Flag-Requestee header, carrying requestee/requester through the mailer-queue flatten/inflate cycle
- break same-second ties on id when resolving a flag's previous status
- don't credit a watcher with a role that was never actually inherited
@Xzzz
Xzzz requested a review from dklawren August 21, 2026 16:16
- Added `package main;` at top of file
- Added `## no critic (Variables::ProtectPrivateVars)` before the private-sub reference
Comment thread Bugzilla/BugMail.pm Outdated
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/Constants.pm
Comment thread template/en/default/email/bugmail-flagtype-cc.txt.tmpl
Comment thread Bugzilla/BugMail.pm
@Xzzz
Xzzz requested a review from dklawren September 8, 2026 16:42
Comment thread Bugzilla/Flag.pm
Comment thread Bugzilla/BugMail.pm Outdated
Comment thread template/en/default/email/bugmail.txt.tmpl Outdated
@Xzzz
Xzzz requested a review from dklawren September 24, 2026 15:53
Comment thread Bugzilla/BugMail.pm
Comment thread Bugzilla/FlagType.pm Outdated
Comment thread t/bugmail-flag-events.t
@Xzzz
Xzzz requested a review from dklawren September 28, 2026 13:12
[%+ INCLUDE "email/header-common.txt.tmpl" %]
[% FOREACH event = flag_events %]
[% NEXT UNLESS event.action == 'requested' %]
X-Bugzilla-Flag-Requestee: [% event.requestee.email %]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

request mails used to have their own subject and X-Bugzilla-Type: request, now they come in as changed so existing filters stop matching. granted/denied/cleared events get no marker header at all since this is only written for requested. worth keeping a header that marks all flag events

What if just add 'requested' to the previous X-Bugzilla-Type if a flag is requested. For users who do exact string matches they will need to change their filter rules but for those who substring matches, the old rule will still work.

Comment thread Bugzilla/BugMail.pm
= $relationship == REL_FLAG_REQUESTEE
|| $relationship == REL_FLAG_REQUESTER
|| $relationship == REL_FLAG_TYPE_CC;
next if $is_bug_ignored && !$is_flag_relationship;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

flag roles skip the ignore list (and BugmailFilter, since wants_bug_mail() isn't called for them) but the person still gets the full bugmail with every diff and comment. maybe send only the flag section when a flag role is their only reason

# high (below the MEDIUMINT limit) to stay clear of real flags.
my $window_start = '2000-01-01 00:00:00';
my $window_end = '2000-01-01 01:00:00';
my $next_flag_id = 8_000_000;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed flag ids starting at 8_000_000 clash with rows left from an earlier run, since the look-back query in BugMail.pm only filters by flag_id. on a second run the old '+' row becomes the previous row and the grant is classed as set instead of answered. pick ids above MAX(flag_id) or add a bug_id condition

[% USE Bugzilla %]
[% RETURN UNLESS event.action == 'requested'
&& (event.type.name == 'review' || event.type.name == 'feedback')
&& event.attachment && event.attachment.can_review %]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can_review is also true for phabricator attachments, which splinter can't review, so this sends a broken review link. the old check used ispatch, maybe ispatch || contenttype == 'text/x-github-pull-request' (same in the html template)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants