1894968 - Bugzilla - Bug Reminder System

Status: RESOLVED FIXED

(bugzilla.mozilla.org :: General, enhancement)

Description

[David Lawrence [:dkl]]

Overview

Develop a system that allows empowered users to request that Bugzilla reminds them about bugs at a specified point in time in the future.
Use Cases

• An automatic reminder for the following actions
  • security bugs should be made public a period of time after the fix has been deployed
  • test cases for security bugs should land a period of time after the fix has been deployed
  • removal of deprecated features
  • deferred landing of accepted changes (eg. coordinated landing of security bugs)
  • remove a preference after letting it ride the trains
  • personal reminders for administrative bugs that need to be actions on a particular date
• Some engineers are leaving needinfo requests open for significant periods of time as a means to "bookmark" a bug for later attention. This works against the core goal of the needinfo system, which is used to request information required to move the bug forward, and has a negative impact on a Web-Platform OKR to reduce the number of open needinfos

Deprecation of BugBot's Reminder System

BugBot currently implements a reminder system that uses the whiteboard field; this work productionises and deprecates BugBot's implementation for the following reasons:

• modifications to the whiteboard field notifies everyone on the bug or watching the component (on average 40 people)
• the whiteboard field is freeform text, which can and has been problematic to parse and update in automation
• the whiteboard field isn't indexed, and is a text field (64k chars) so it's slow and expensive server-side to search
• building it into Bugzilla makes the reminder system discoverable, and consumable via a performant API
  Note this only replaces BugBot's whiteboard driven reminders; other features such as in-bug notifications if a bug hasn't been landed in time will continue to remain in BugBot.

User Experience

• Add a "Reminder" button to the top of show_bug, gated on group membership
  • Clicking on the button takes the user to the Reminders preferences panel with the bug number pre-populated
  • If the preferences panel is opened with a bug-id specified and there's a needinfo request targeting the current user, pre-populate the notes field with needinfo from <requestee's name>
• Add a Reminders preferences panel; rough mock up:

Remind me about bug [number]:
(o) In [integer] days
( ) In [integer] months
( ) On [date picker] (UTC-8)
Note: [optional single line note]
(Create Reminder)
---
Current reminders:
       | When     | Created    | Bug                                                     | Note | 
(edit) | tomorrow | 6 days ago | Bug 1217443 - using the skip feature is quite confusing | …    |

• Sort reminders by when, soonest first
• the edit screen is self-explanatory; and would include an option to delete the reminder
• Add a panel to the header requests dropdown
  • the number of open reminders will not impact the number visible in the badge
  • just a panel at the bottom with the number of pending reminders, which links to the user preference panel
  • if the user has no reminders, don't show the panel

API

• Add API endpoints to List, Add, Delete, and Update the authenticated user's reminders

Emails

• A cron job running once per day will generate and send html+text emails
• Reminders set by users that are currently disabled or are no longer in the required group should be marked as completed without sending an email
• Reminders will be marked as completed once the email has been successfully submitted for delivery
  • We don't need to expose sent reminders in the UI; they will be effectively deleted from the user's perspective
• No changes will be made to the associated bug; it would be detrimental to notify everyone following the bug that a reminder has been triggered

Comment 1

[BMO Github Automation]

Attachment: [mozilla-bteam/bmo] Bug 1894968 - Bugzilla - Bug Reminder System (#2245)

Comment 2

[David Lawrence [:dkl]]

Merged
https://github.com/mozilla-bteam/bmo/commit/04f1216f7682568cf4d544951cdb032ee7111f1e