1266264 - Pass UITour Variables to surveys

Status: RESOLVED FIXED

(Shield :: Actions, defect)

Description

[Matt Grimes [:Matt_G]]

In the current self repair we pass information from UITour as variables into our surveys. This provides additional data for analysis. Even though this is only temporary, we should pass EVERYTHING from UITour into the surveys until we are done with UITour completely.

Gregg has the full list of what is available from UITour.

Comment 1

[Gregg Lind (Fx Strategy and Insights - Shield - Heartbeat )]

0.  These change *all the time*, and i haven't explored recent additions *at all*

1.  UITour offers:  (per https://dxr.mozilla.org/mozilla-central/source/browser/components/uitour/UITour.jsm#1868-1946)


highlights:
```
  getConfiguration: function(aMessageManager, aWindow, aConfiguration, aCallbackID) {
    switch (aConfiguration) {
      // 1. appinfo
      case "appinfo":
        let props = ["defaultUpdateChannel", "version"];
        appinfo["defaultBrowser"] = isDefaultBrowser;
        appinfo["canSetDefaultBrowserInBackground"] =
          canSetDefaultBrowserInBackground;
      // 2. UNUSED roughly, which UI elements can be highlighted by tour
      case "availableTargets":  
      // 3. UNUSED: loop
      case "loop":
          gettingStartedSeen: (Services.prefs.getIntPref("loop.gettingStarted.latestFTUVersion") >= FTU_VERSION),
      // 4.  search and search engines.
      case "search":
      case "selectedSearchEngine":
            let engines = Services.search.getVisibleEngines();
            data = {
              searchEngineIdentifier: Services.search.defaultEngine.identifier,
              engines: engines.filter((engine) => engine.identifier)
                              .map((engine) => TARGET_SEARCHENGINE_PREFIX + engine.identifier)
            data = {engines: [], searchEngineIdentifier: ""};
          }
      // 5.  Sync
      case "sync":
          setup: Services.prefs.prefHasUserValue("services.sync.username"),
  },
```

2.  Claim:  defaultness, current search engine are the main ones that should come along, or be able to come along.

3.  How we did this before:

https://github.com/mozilla/self-repair-server/blob/master/src/common/personinfo.js#L63 .  

GL

Comment 2

[Matt Grimes [:Matt_G]]

I say we pass it all until we get the system add-on landed. We have a few studies coming up (search, accounts, etc) and I think most of this will be useful for one of those studies.

Comment 3

[Osmose [:osmose, :mkelly]]

Merged in https://github.com/mozilla/normandy-actions/commit/6eea8a8337a570c539af0edf0ac0910d87382c59, will be included in the deploy next Tuesday.

With minimal changes I was able to include three new fields:

isDefaultBrowser - 0 if Firefox isn't set as the default, 1 if it is
searchEngine - The search engine that the user has set as their default.
syncSetup - 1 if Firefox Sync has been set up, 0 if it hasn't.

The rest would've required deploying new service code, which I'd like to avoid.

I _think_ this will do until the system add-on lands, but feel free to reopen if it won't.

Comment 4

[Matt Grimes [:Matt_G]]

This looks great. Thanks for picking up!

Comment 5

[[github robot]]

Commit pushed to master at https://github.com/mozilla/normandy

https://github.com/mozilla/normandy/commit/702ba4d6a2388e3f7ca598a4c004926b15e633c2
Annotate the post-answer URL in show-heart with more data.

This is a port of the fixes for bug 1266264 that were originally made
to the normandy-actions repo after the actions were moved to this
repo instead. Also includes a fix for empty post-answer URLs.