1488923 - When notifying listeners that a study is ending, include the reason why the study is ending

Status: RESOLVED FIXED

(Firefox :: Normandy Client, enhancement)

Description

[Michael Cooper [:mythmon]]

In Bug 1481918, we added an event to notify study add-ons about their impending uninstallation. It does not, however tell the listeners *why* the study is ending. This makes it impossible to tell the difference between a user clicking unenroll in about:studies and the study ending naturally. We should pass the reason already provided for stopping a study down to the listener.

Comment 1

[Michael Cooper [:mythmon]]

Attachment: Bug 1488923 - When notifying listeners that a study is ending, include the reason why the study is ending

Comment 2

[Andrew Swan [:aswan]]

Comment on attachment 9010058 [details]
Bug 1488923 - When notifying listeners that a study is ending, include the reason why the study is ending

Andrew Swan [:aswan] has approved the revision.

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8281e74d9d7e
When notifying listeners that a study is ending, include the reason why the study is ending r=aswan

Comment 4

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/8281e74d9d7e

Comment 5

[Michael Cooper [:mythmon]]

Comment on attachment 9010058 [details]
Bug 1488923 - When notifying listeners that a study is ending, include the reason why the study is ending

Approval Request Comment
[Feature/Bug causing the regression]: Not a regression, but related to bug 1481918

[User impact if declined]: No user impact. Shield studies will be unable to distinguish between different reasons for a study ending.

[Is this code covered by automated tests?]: Yes

[Has the fix been verified in Nightly?]: No, the consumers of this API are waiting for this change.

[Needs manual test from QE? If yes, steps to reproduce]: No

[List of other uplifts needed for the feature/fix]: None

[Is the change risky?]: No

[Why is the change risky/not risky?]: The codes only consumers are Shield studies that have yet to be written, and they are waiting for this change.

[String changes made/needed]: None.

Comment 6

[Pascal Chevrel:pascalc (PTO until April 26)]

Comment on attachment 9010058 [details]
Bug 1488923 - When notifying listeners that a study is ending, include the reason why the study is ending

Minimal patch helping us getting better results from shield studies, uplift approved for 63 beta 8, thanks.

Comment 7

[Cristina Coroiu [:ccoroiu]]

https://hg.mozilla.org/releases/mozilla-beta/rev/93d45f9ae4c6