1196102 - Heartbeat: Support heartbeat prompts without rating stars

Status: RESOLVED FIXED

(Firefox :: Tours, enhancement, P1)

Description

[Matthew N. [:MattN]]

We want to implement something like attachment 8649438 [details] which doesn't use star ratings.

Comment 1

[Matthew N. [:MattN]]

Attachment: MozReview Request: Bug 1196102 - Clean up unused Heartbeat UITour arguments and indentation. r=bgrins

Bug 1196102 - Clean up unused Heartbeat UITour arguments and indentation. r=bgrins

Comment 2

[Matthew N. [:MattN]]

Attachment: WIP using existing notification bar buttons

Comment 3

[Brian Grinstead [:bgrins]]

Comment on attachment 8649711 [details]
MozReview Request: Bug 1196102 - Clean up unused Heartbeat UITour arguments and indentation. r=bgrins

https://reviewboard.mozilla.org/r/16471/#review14783

Ship It!

Comment 4

[Matthew N. [:MattN]]

Attachment: MozReview Request: Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

Comment 5

[Matthew N. [:MattN]]

Note that this patch makes a change to the UITour library so heartbeat will need to make the equivalent change.

Code from a whitelisted domain can run: `
Mozilla.UITour.showHeartbeat("Would you like to share feedback with Mozilla? No information will be shared unless you take the survey.",
"Thank you!",
"myflowid",
"http://www.mozilla.org/?fake=bar", null, null, {
  engagementButtonLabel: "Take Survey",
});
`

From a Browser Console the equivalent is: `
UITour.showHeartbeat(window, {
  message: "Would you like to share feedback with Mozilla? No information will be shared unless you take the survey.",
  thankyouMessage: "Thank you!",
  flowId: "myflowid",
  engagementButtonLabel: "Take Survey",
  engagementURL: "http://www.mozilla.org/",
});
`

Comment 6

[Brian Grinstead [:bgrins]]

Comment on attachment 8651236 [details]
MozReview Request: Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

https://reviewboard.mozilla.org/r/16873/#review15019

::: browser/components/uitour/UITour.jsm:476
(Diff revision 1)
> +        if (data.engagementButtonText && typeof data.engagementButtonText != "string") {

Should this be `data.engagementButtonLabel`?  Don't see any othter references to `engagementButtonText`.  If so, please add a simple test case in the b-c test covering this.

Comment 7

[Matthew N. [:MattN]]

Comment on attachment 8651236 [details]
MozReview Request: Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

Comment 8

[Brian Grinstead [:bgrins]]

Comment on attachment 8651236 [details]
MozReview Request: Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

https://reviewboard.mozilla.org/r/16873/#review15025

Ship It!

Comment 9

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/09877fdd753a
https://hg.mozilla.org/integration/fx-team/rev/e0f2fd166388

Comment 10

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/09877fdd753a
https://hg.mozilla.org/mozilla-central/rev/e0f2fd166388

Comment 11

[Matthew N. [:MattN]]

Comment on attachment 8651236 [details]
MozReview Request: Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

Approval Request Comment
[Feature/regressing bug #]: Private Browsing with Tracking Protection measurements via HeartBeat (using UITour)
[User impact if declined]: No way to measure the (change in) user sentiment towards private browsing so we won't be able to address user concerns. Specifically this patch just allows using a survey button instead of stars (which may not give good results in PB). We want to get a baseline in 41 to measure 42 sentiment against.
[Describe test coverage new/current, TreeHerder]: Automated tests for the button behaviour.
[Risks and why]: Low risk since this is an isolated change only affecting UITour the heartbeat API. Worst case is that the heartbeat UI-only doesn't work which wouldn't be end of the world.
[String/UUID change made/needed]: None, the button string comes from the heartbeat webpage.

Comment 12

[Sylvestre Ledru [:Sylvestre]]

Comment on attachment 8651236 [details]
MozReview Request: Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

> Private Browsing with Tracking Protection
Hmm, this will arrive with 42 (aurora currently) and not 41 (beta
Why do you request the uplift now?
Thanks

Comment 13

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-aurora/rev/862be85efa14
https://hg.mozilla.org/releases/mozilla-aurora/rev/11a692963d19

Comment 14

[Matthew N. [:MattN]]

(In reply to Sylvestre Ledru [:sylvestre] from comment #12)
> > Private Browsing with Tracking Protection
> Hmm, this will arrive with 42 (aurora currently) and not 41 (beta
> Why do you request the uplift now?

I explained this: 
> We want to get a baseline in 41 to measure 42 sentiment against.

Comment 15

[Ritu Kothari (:ritu) (Inactive, please n-i to RyanVM, jcristau, or pascal)]

Matt, does this change the HB survey from star ratings to survey link in regular (non-PBM) mode too?

Comment 16

[Ritu Kothari (:ritu) (Inactive, please n-i to RyanVM, jcristau, or pascal)]

Comment on attachment 8651236 [details]
MozReview Request: Bug 1196102 - Heartbeat: Support prompts with a button instead of rating stars. r=bgrins

We need this patch in Beta41 in order to get baseline numbers. I would have preferred to stabilize this patch on Aurora channel but the sooner this gets uplifted to Beta, we can get more users to test it and identify regressions. Beta41+

Comment 17

[Matthew N. [:MattN]]

(In reply to Ritu Kothari (:ritu) from comment #15)
> Matt, does this change the HB survey from star ratings to survey link in
> regular (non-PBM) mode too?

No, this provides a new option to use a button instead of stars. If they new option isn't used the existing stars should continue to work the same.

Comment 18

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/0d6d24118f11
https://hg.mozilla.org/releases/mozilla-beta/rev/dbaea17aee2b