summaryrefslogtreecommitdiffstats
path: root/services/sync/tests/unit/test_healthreport_migration.js
blob: 23f7567487054c0e8a98f1a4d47608401b5d24b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

Cu.import("resource://gre/modules/Metrics.jsm", this);
Cu.import("resource://gre/modules/Preferences.jsm", this);
Cu.import("resource://gre/modules/Promise.jsm", this);
Cu.import("resource://services-sync/healthreport.jsm", this);
Cu.import("resource://services-sync/FxaMigrator.jsm", this);
Cu.import("resource://testing-common/services/common/logging.js", this);
Cu.import("resource://testing-common/services/healthreport/utils.jsm", this);


function run_test() {
  initTestLogging();

  run_next_test();
}

add_task(function* test_no_data() {
  let storage = yield Metrics.Storage("collect");
  let provider = new SyncProvider();
  yield provider.init(storage);

  try {
    // Initially nothing should be configured.
    let now = new Date();
    yield provider.collectDailyData();

    let m = provider.getMeasurement("migration", 1);
    let values = yield m.getValues();
    Assert.equal(values.days.size, 0);
    Assert.ok(!values.days.hasDay(now));
  } finally {
    yield provider.shutdown();
    yield storage.close();
  }
});

function checkCorrectStateRecorded(provider, state) {
  // Wait for storage to complete.
  yield m.storage.enqueueOperation(() => {
    return Promise.resolve();
  });

  let m = provider.getMeasurement("migration", 1);
  let values = yield m.getValues();
  Assert.equal(values.days.size, 1);
  Assert.ok(values.days.hasDay(now));
  let day = values.days.getDay(now);

  Assert.ok(day.has("state"));
  Assert.equal(day.get("state"), state);
}

add_task(function* test_state() {
  let storage = yield Metrics.Storage("collect");
  let provider = new SyncProvider();
  yield provider.init(storage);

  try {
    // Initially nothing should be configured.
    let now = new Date();

    // We record both a "user" and "internal" state in the same field.
    // So simulate a "user" state first.
    Services.obs.notifyObservers(null, "fxa-migration:state-changed",
                                 fxaMigrator.STATE_USER_FXA_VERIFIED);
    checkCorrectStateRecorded(provider, fxaMigrator.STATE_USER_FXA_VERIFIED);

    // And an internal state.
    Services.obs.notifyObservers(null, "fxa-migration:internal-state-changed",
                                 fxaMigrator.STATE_INTERNAL_WAITING_SYNC_COMPLETE);
    checkCorrectStateRecorded(provider, fxaMigrator.STATE_INTERNAL_WAITING_SYNC_COMPLETE);
  } finally {
    yield provider.shutdown();
    yield storage.close();
  }
});

add_task(function* test_flags() {
  let storage = yield Metrics.Storage("collect");
  let provider = new SyncProvider();
  yield provider.init(storage);

  try {
    // Initially nothing should be configured.
    let now = new Date();

    let m = provider.getMeasurement("migration", 1);

    let record = function*(what) {
      Services.obs.notifyObservers(null, "fxa-migration:internal-telemetry", what);
      // Wait for storage to complete.
      yield m.storage.enqueueOperation(Promise.resolve);
      let values = yield m.getValues();
      Assert.equal(values.days.size, 1);
      return values.days.getDay(now);
    }

    let values = yield m.getValues();
    Assert.equal(values.days.size, 1);
    let day = values.days.getDay(now);
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_ACCEPTED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_DECLINED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_UNLINKED));

    // let's send an unknown value to ensure our error mitigation works.
    day = yield record("unknown");
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_ACCEPTED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_DECLINED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_UNLINKED));

    // record an fxaMigrator.TELEMETRY_ACCEPTED state.
    day = yield record(fxaMigrator.TELEMETRY_ACCEPTED);
    Assert.ok(day.has(fxaMigrator.TELEMETRY_ACCEPTED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_DECLINED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_UNLINKED));
    Assert.equal(day.get(fxaMigrator.TELEMETRY_ACCEPTED), 1);

    // and again - it should get 2.
    day = yield record(fxaMigrator.TELEMETRY_ACCEPTED);
    Assert.equal(day.get(fxaMigrator.TELEMETRY_ACCEPTED), 2);

    // record fxaMigrator.TELEMETRY_DECLINED - also a counter.
    day = yield record(fxaMigrator.TELEMETRY_DECLINED);
    Assert.ok(day.has(fxaMigrator.TELEMETRY_ACCEPTED));
    Assert.ok(day.has(fxaMigrator.TELEMETRY_DECLINED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_UNLINKED));
    Assert.equal(day.get(fxaMigrator.TELEMETRY_ACCEPTED), 2);
    Assert.equal(day.get(fxaMigrator.TELEMETRY_DECLINED), 1);

    day = yield record(fxaMigrator.TELEMETRY_DECLINED);
    Assert.ok(day.has(fxaMigrator.TELEMETRY_ACCEPTED));
    Assert.ok(day.has(fxaMigrator.TELEMETRY_DECLINED));
    Assert.ok(!day.has(fxaMigrator.TELEMETRY_UNLINKED));
    Assert.equal(day.get(fxaMigrator.TELEMETRY_ACCEPTED), 2);
    Assert.equal(day.get(fxaMigrator.TELEMETRY_DECLINED), 2);

    // and fxaMigrator.TELEMETRY_UNLINKED - this is conceptually a "daily bool".
    // (ie, it's DAILY_LAST_NUMERIC_FIELD and only ever has |1| written to it)
    day = yield record(fxaMigrator.TELEMETRY_UNLINKED);
    Assert.ok(day.has(fxaMigrator.TELEMETRY_ACCEPTED));
    Assert.ok(day.has(fxaMigrator.TELEMETRY_DECLINED));
    Assert.ok(day.has(fxaMigrator.TELEMETRY_UNLINKED));
    Assert.equal(day.get(fxaMigrator.TELEMETRY_UNLINKED), 1);
    // and doing it again still leaves us with |1|
    day = yield record(fxaMigrator.TELEMETRY_UNLINKED);
    Assert.equal(day.get(fxaMigrator.TELEMETRY_UNLINKED), 1);
  } finally {
    yield provider.shutdown();
    yield storage.close();
  }
});