summaryrefslogtreecommitdiffstats
path: root/toolkit/components/search/tests/xpcshell/test_settings.js
blob: 33995b49fd49a099b3028f97e1b5511c867279ad (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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

/*
 * Test initializing from the search settings.
 */

"use strict";

const legacyUseSavedOrderPrefName =
  SearchUtils.BROWSER_SEARCH_PREF + "useDBForOrder";

var settingsTemplate;

/**
 * Test reading from search.json.mozlz4
 */
add_setup(async function () {
  await SearchTestUtils.useTestEngines("data1");
  await AddonTestUtils.promiseStartupManager();
  await Services.search.init();
});

async function loadSettingsFile(settingsFile, setVersion, setHashes) {
  settingsTemplate = await readJSONFile(do_get_file(settingsFile));
  if (setVersion) {
    settingsTemplate.version = SearchUtils.SETTINGS_VERSION;
  }

  if (setHashes) {
    settingsTemplate.metaData.hash = SearchUtils.getVerificationHash(
      settingsTemplate.metaData.current
    );
    settingsTemplate.metaData.privateHash = SearchUtils.getVerificationHash(
      settingsTemplate.metaData.private
    );
  }

  delete settingsTemplate.visibleDefaultEngines;

  await promiseSaveSettingsData(settingsTemplate);
}

/**
 * Start the search service and confirm the engine properties match the expected values.
 *
 * @param {string} settingsFile
 *   The path to the settings file to use.
 * @param {boolean} setVersion
 *   True if to set the version in the copied settings file.
 * @param {boolean} expectedUseDBValue
 *   The value expected for the `useSavedOrder` metadata attribute.
 */
async function checkLoadSettingProperties(
  settingsFile,
  setVersion,
  expectedUseDBValue
) {
  info("init search service");
  let ss = Services.search.wrappedJSObject;

  await loadSettingsFile(settingsFile, setVersion);

  const settingsFileWritten = promiseAfterSettings();

  await ss.reset();
  await Services.search.init();

  await settingsFileWritten;

  let engines = await ss.getEngines();

  Assert.equal(
    engines[0].name,
    "engine1",
    "Should have loaded the correct first engine"
  );
  Assert.equal(engines[0].alias, "testAlias", "Should have set the alias");
  Assert.equal(engines[0].hidden, false, "Should have not hidden the engine");
  Assert.equal(engines[0].id, "engine1@search.mozilla.orgdefault");

  Assert.equal(
    engines[1].name,
    "engine2",
    "Should have loaded the correct second engine"
  );
  Assert.equal(engines[1].alias, "", "Should have not set the alias");
  Assert.equal(engines[1].hidden, true, "Should have hidden the engine");
  Assert.equal(engines[1].id, "engine2@search.mozilla.orgdefault");

  // The extra engine is the second in the list.
  isSubObjectOf(EXPECTED_ENGINE.engine, engines[2]);
  Assert.ok(engines[2].id, "test-addon-id@mozilla.orgdefault");

  let engineFromSS = ss.getEngineByName(EXPECTED_ENGINE.engine.name);
  Assert.ok(!!engineFromSS);
  isSubObjectOf(EXPECTED_ENGINE.engine, engineFromSS);

  Assert.equal(
    engineFromSS.getSubmission("foo").uri.spec,
    "http://www.google.com/search?q=foo",
    "Should have the correct URL with no mozparams"
  );

  Assert.equal(
    ss._settings.getMetaDataAttribute("useSavedOrder"),
    expectedUseDBValue,
    "Should have set the useSavedOrder metadata correctly."
  );

  let migratedSettingsFile = await promiseSettingsData();

  Assert.equal(
    migratedSettingsFile.engines[0].id,
    "engine1@search.mozilla.orgdefault"
  );

  removeSettingsFile();
}

add_task(async function test_legacy_setting_engine_properties() {
  Services.prefs.setBoolPref(legacyUseSavedOrderPrefName, true);

  let legacySettings = await readJSONFile(
    do_get_file("data/search-legacy.json")
  );

  // Assert the engine ids have not been migrated yet
  for (let engine of legacySettings.engines) {
    Assert.ok(!("id" in engine));
  }
  Assert.ok(!("defaultEngineId" in legacySettings.metaData));
  Assert.ok(!("privateDefaultEngineId" in legacySettings.metaData));

  await checkLoadSettingProperties("data/search-legacy.json", false, true);

  Assert.ok(
    !Services.prefs.prefHasUserValue(legacyUseSavedOrderPrefName),
    "Should have cleared the legacy pref."
  );
});

add_task(
  async function test_legacy_setting_migration_with_undefined_metaData_current_and_private() {
    let ss = Services.search.wrappedJSObject;

    await loadSettingsFile("data/search-legacy.json", false);
    const settingsFileWritten = promiseAfterSettings();

    await ss.reset();
    await Services.search.init();

    await settingsFileWritten;

    let migratedSettingsFile = await promiseSettingsData();

    Assert.equal(
      migratedSettingsFile.metaData.defaultEngineId,
      "",
      "When there is no metaData.current attribute in settings file, the migration should set the defaultEngineId to an empty string."
    );
    Assert.equal(
      migratedSettingsFile.metaData.privateDefaultEngineId,
      "",
      "When there is no metaData.private attribute in settings file, the migration should set the privateDefaultEngineId to an empty string."
    );

    removeSettingsFile();
  }
);

add_task(
  async function test_legacy_setting_migration_with_correct_metaData_current_and_private_hashes() {
    let ss = Services.search.wrappedJSObject;

    await loadSettingsFile(
      "data/search-legacy-correct-default-engine-hashes.json",
      false,
      true
    );
    const settingsFileWritten = promiseAfterSettings();

    await ss.reset();
    await Services.search.init();

    await settingsFileWritten;

    let migratedSettingsFile = await promiseSettingsData();

    Assert.equal(
      migratedSettingsFile.metaData.defaultEngineId,
      "engine2@search.mozilla.orgdefault",
      "When the metaData.current and associated hash are correct, the migration should set the defaultEngineId to the engine id."
    );
    Assert.equal(
      migratedSettingsFile.metaData.privateDefaultEngineId,
      "engine2@search.mozilla.orgdefault",
      "When the metaData.private and associated hash are correct, the migration should set the privateDefaultEngineId to the private engine id."
    );

    removeSettingsFile();
  }
);

add_task(
  async function test_legacy_setting_migration_with_incorrect_metaData_current_and_private_hashes_app_provided() {
    let ss = Services.search.wrappedJSObject;

    // Here we are testing correct migration for the case that a user has set
    // their default engine to an application provided engine (but not the app
    // default).
    //
    // In this case we should ignore invalid hashes for the default engines,
    // and allow the select default to remain. This covers the case where
    // a user has copied a profile from a different directory.
    // See SearchService._getEngineDefault for more details.

    await loadSettingsFile(
      "data/search-legacy-wrong-default-engine-hashes.json",
      false,
      false
    );
    const settingsFileWritten = promiseAfterSettings();

    await ss.reset();
    await Services.search.init();

    await settingsFileWritten;

    let migratedSettingsFile = await promiseSettingsData();

    Assert.equal(
      migratedSettingsFile.metaData.defaultEngineId,
      "engine2@search.mozilla.orgdefault",
      "Should ignore invalid metaData.hash when the default engine is application provided."
    );
    Assert.equal(
      Services.search.defaultEngine.name,
      "engine2",
      "Should have the correct engine set as default"
    );

    Assert.equal(
      migratedSettingsFile.metaData.privateDefaultEngineId,
      "engine2@search.mozilla.orgdefault",
      "Should ignore invalid metaData.privateHash when the default private engine is application provided."
    );
    Assert.equal(
      Services.search.defaultPrivateEngine.name,
      "engine2",
      "Should have the correct engine set as default private"
    );

    removeSettingsFile();
  }
);

add_task(
  async function test_legacy_setting_migration_with_incorrect_metaData_current_and_private_hashes_third_party() {
    let ss = Services.search.wrappedJSObject;

    // This test is checking that if the user has set a third-party engine as
    // default, and the verification hash is invalid, then we do not copy
    // the default engine setting.

    await loadSettingsFile(
      "data/search-legacy-wrong-third-party-engine-hashes.json",
      false,
      false
    );
    const settingsFileWritten = promiseAfterSettings();

    await ss.reset();
    await Services.search.init();

    await settingsFileWritten;

    let migratedSettingsFile = await promiseSettingsData();

    Assert.equal(
      migratedSettingsFile.metaData.defaultEngineId,
      "",
      "Should reset the default engine when metaData.hash is invalid and the engine is not application provided."
    );
    Assert.equal(
      Services.search.defaultEngine.name,
      "engine1",
      "Should have reset the default engine"
    );

    Assert.equal(
      migratedSettingsFile.metaData.privateDefaultEngineId,
      "",
      "Should reset the default engine when metaData.privateHash is invalid and the engine is not application provided."
    );
    Assert.equal(
      Services.search.defaultPrivateEngine.name,
      "engine1",
      "Should have reset the default private engine"
    );

    removeSettingsFile();
  }
);

add_task(async function test_current_setting_engine_properties() {
  await checkLoadSettingProperties("data/search.json", true, false);
});

add_task(async function test_settings_metadata_properties() {
  let ss = Services.search.wrappedJSObject;

  await loadSettingsFile("data/search.json");

  const settingsFileWritten = promiseAfterSettings();
  await ss.reset();
  await Services.search.init();

  await settingsFileWritten;

  let metaDataProperties = [
    "locale",
    "region",
    "channel",
    "experiment",
    "distroID",
  ];

  for (let name of metaDataProperties) {
    Assert.notEqual(
      ss._settings.getMetaDataAttribute(`${name}`),
      undefined,
      `Search settings should have ${name} property defined.`
    );
  }

  removeSettingsFile();
});

add_task(async function test_settings_write_when_settings_changed() {
  let ss = Services.search.wrappedJSObject;
  await loadSettingsFile("data/search.json");

  const settingsFileWritten = promiseAfterSettings();
  await ss.reset();
  await Services.search.init();
  await settingsFileWritten;

  Assert.ok(
    ss._settings.isCurrentAndCachedSettingsEqual(),
    "Settings and cached settings should be the same after search service initializaiton."
  );

  const settingsFileWritten2 = promiseAfterSettings();
  ss._settings.setMetaDataAttribute("value", "test");

  Assert.ok(
    !ss._settings.isCurrentAndCachedSettingsEqual(),
    "Settings should differ from cached settings after a new attribute is set."
  );

  await settingsFileWritten2;
  info("Settings write complete");

  Assert.ok(
    ss._settings.isCurrentAndCachedSettingsEqual(),
    "Settings and cached settings should be the same after new attribte on settings is written."
  );

  removeSettingsFile();
});

add_task(async function test_set_and_get_engine_metadata_attribute() {
  let ss = Services.search.wrappedJSObject;
  await loadSettingsFile("data/search.json");

  const settingsFileWritten = promiseAfterSettings();
  await ss.reset();
  await Services.search.init();
  await settingsFileWritten;

  let engines = await ss.getEngines();
  const settingsFileWritten2 = promiseAfterSettings();
  ss._settings.setEngineMetaDataAttribute(engines[0].name, "value", "test");
  await settingsFileWritten2;

  Assert.equal(
    "test",
    ss._settings.getEngineMetaDataAttribute(engines[0].name, "value"),
    `${engines[0].name}'s metadata property "value" should be set as "test" after calling getEngineMetaDataAttribute.`
  );

  let userSettings = await ss._settings.get();
  let engine = userSettings.engines.find(e => e._name == engines[0].name);

  Assert.equal(
    "test",
    engine._metaData.value,
    `${engines[0].name}'s metadata property "value" should be set as "test" from settings file.`
  );

  removeSettingsFile();
});

add_task(
  async function test_settings_write_prevented_when_settings_unchanged() {
    let ss = Services.search.wrappedJSObject;
    await loadSettingsFile("data/search.json");

    const settingsFileWritten = promiseAfterSettings();
    await ss.reset();
    await Services.search.init();
    await settingsFileWritten;

    Assert.ok(
      ss._settings.isCurrentAndCachedSettingsEqual(),
      "Settings and cached settings should be the same after search service initializaiton."
    );

    // Update settings.
    const settingsFileWritten2 = promiseAfterSettings();
    ss._settings.setMetaDataAttribute("value", "test");

    Assert.ok(
      !ss._settings.isCurrentAndCachedSettingsEqual(),
      "Settings should differ from cached settings after a new attribute is set."
    );
    await settingsFileWritten2;

    // Set the same attribute as before to ensure there was no change.
    // Settings write should be prevented.
    let promiseWritePrevented = SearchTestUtils.promiseSearchNotification(
      "write-prevented-when-settings-unchanged"
    );
    ss._settings.setMetaDataAttribute("value", "test");

    Assert.ok(
      ss._settings.isCurrentAndCachedSettingsEqual(),
      "Settings and cached settings should be the same."
    );
    await promiseWritePrevented;

    removeSettingsFile();
  }
);

/**
 * Test that the JSON settings written in the profile is correct.
 */
add_task(async function test_settings_write() {
  let ss = Services.search.wrappedJSObject;
  info("test settings writing");

  await loadSettingsFile("data/search.json");

  const settingsFileWritten = promiseAfterSettings();
  await ss.reset();
  await Services.search.init();
  await settingsFileWritten;

  let settingsData = await promiseSettingsData();

  // Remove buildID and locale, as they are no longer used.
  delete settingsTemplate.buildID;
  delete settingsTemplate.locale;

  for (let engine of settingsTemplate.engines) {
    // Remove _shortName from the settings template, as it is no longer supported,
    // but older settings used to have it, so we keep it in the template as an
    // example.
    if ("_shortName" in engine) {
      delete engine._shortName;
    }
    if ("_urls" in engine) {
      // Only app-provided engines support purpose, others do not,
      // so filter them out of the expected template.
      for (let urls of engine._urls) {
        urls.params = urls.params.filter(p => !p.purpose);
        // resultDomain is also no longer supported.
        if ("resultDomain" in urls) {
          delete urls.resultDomain;
        }
      }
    }
    // Remove queryCharset, if it is the same as the default, as we don't save
    // it in that case.
    if (engine?.queryCharset == SearchUtils.DEFAULT_QUERY_CHARSET) {
      delete engine.queryCharset;
    }
  }

  // Note: the file is copied with an old version number, which should have
  // been updated on write.
  settingsTemplate.version = SearchUtils.SETTINGS_VERSION;

  isSubObjectOf(settingsTemplate, settingsData, (prop, value) => {
    if (prop != "_iconURL" && prop != "{}") {
      return false;
    }
    // Skip items that are to do with icons for extensions, as we can't
    // control the uuid.
    return value.startsWith("moz-extension://");
  });
});

async function settings_write_check(disableFn) {
  let ss = Services.search.wrappedJSObject;

  sinon.stub(ss._settings, "_write").returns(Promise.resolve());

  // Simulate the search service being initialized.
  disableFn(true);

  ss._settings.setMetaDataAttribute("value", "test");

  Assert.ok(
    ss._settings._write.notCalled,
    "Should not have attempted to _write"
  );

  // Wait for two periods of the normal delay to ensure we still do not write.
  await new Promise(r =>
    // eslint-disable-next-line mozilla/no-arbitrary-setTimeout
    setTimeout(r, SearchSettings.SETTNGS_INVALIDATION_DELAY * 2)
  );

  Assert.ok(
    ss._settings._write.notCalled,
    "Should not have attempted to _write"
  );

  disableFn(false);

  await TestUtils.waitForCondition(
    () => ss._settings._write.calledOnce,
    "Should attempt to write the settings."
  );

  sinon.restore();
}

add_task(async function test_settings_write_prevented_during_init() {
  await settings_write_check(disable => {
    let status = disable ? "success" : "failed";
    Services.search.wrappedJSObject.forceInitializationStatusForTests(status);
  });
});

add_task(async function test_settings_write_prevented_during_reload() {
  await settings_write_check(
    disable => (Services.search.wrappedJSObject._reloadingEngines = disable)
  );
});

var EXPECTED_ENGINE = {
  engine: {
    name: "Test search engine",
    alias: "",
    description: "A test search engine (based on Google search)",
    searchForm: "http://www.google.com/",
    wrappedJSObject: {
      _extensionID: "test-addon-id@mozilla.org",
      _iconURL:
        "data:image/png;base64,AAABAAEAEBAAAAEAGABoAwAAFgAAACgAAAAQAAA" +
        "AIAAAAAEAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADs9Pt8xetPtu9F" +
        "sfFNtu%2BTzvb2%2B%2Fne4dFJeBw0egA%2FfAJAfAA8ewBBegAAAAD%2B%2F" +
        "Ptft98Mp%2BwWsfAVsvEbs%2FQeqvF8xO7%2F%2F%2F63yqkxdgM7gwE%2Fgg" +
        "M%2BfQA%2BegBDeQDe7PIbotgQufcMufEPtfIPsvAbs%2FQvq%2Bfz%2Bf%2F" +
        "%2B%2B%2FZKhR05hgBBhQI8hgBAgAI9ewD0%2B%2Fg3pswAtO8Cxf4Kw%2FsJ" +
        "vvYAqupKsNv%2B%2Fv7%2F%2FP5VkSU0iQA7jQA9hgBDgQU%2BfQH%2F%2Ff%" +
        "2FQ6fM4sM4KsN8AteMCruIqqdbZ7PH8%2Fv%2Fg6Nc%2Fhg05kAA8jAM9iQI%" +
        "2BhQA%2BgQDQu6b97uv%2F%2F%2F7V8Pqw3eiWz97q8%2Ff%2F%2F%2F%2F7%" +
        "2FPptpkkqjQE4kwA7kAA5iwI8iAA8hQCOSSKdXjiyflbAkG7u2s%2F%2B%2F%" +
        "2F39%2F%2F7r8utrqEYtjQE8lgA7kwA7kwA9jwA9igA9hACiWSekVRyeSgiYS" +
        "BHx6N%2F%2B%2Fv7k7OFRmiYtlAA5lwI7lwI4lAA7kgI9jwE9iwI4iQCoVhWc" +
        "TxCmb0K%2BooT8%2Fv%2F7%2F%2F%2FJ2r8fdwI1mwA3mQA3mgA8lAE8lAE4j" +
        "wA9iwE%2BhwGfXifWvqz%2B%2Ff%2F58u%2Fev6Dt4tr%2B%2F%2F2ZuIUsgg" +
        "A7mgM6mAM3lgA5lgA6kQE%2FkwBChwHt4dv%2F%2F%2F728ei1bCi7VAC5XQ7" +
        "kz7n%2F%2F%2F6bsZkgcB03lQA9lgM7kwA2iQktZToPK4r9%2F%2F%2F9%2F%" +
        "2F%2FSqYK5UwDKZAS9WALIkFn%2B%2F%2F3%2F%2BP8oKccGGcIRJrERILYFE" +
        "MwAAuEAAdX%2F%2Ff7%2F%2FP%2B%2BfDvGXQLIZgLEWgLOjlf7%2F%2F%2F%" +
        "2F%2F%2F9QU90EAPQAAf8DAP0AAfMAAOUDAtr%2F%2F%2F%2F7%2B%2Fu2bCT" +
        "IYwDPZgDBWQDSr4P%2F%2Fv%2F%2F%2FP5GRuABAPkAA%2FwBAfkDAPAAAesA" +
        "AN%2F%2F%2B%2Fz%2F%2F%2F64g1C5VwDMYwK8Yg7y5tz8%2Fv%2FV1PYKDOc" +
        "AAP0DAf4AAf0AAfYEAOwAAuAAAAD%2F%2FPvi28ymXyChTATRrIb8%2F%2F3v" +
        "8fk6P8MAAdUCAvoAAP0CAP0AAfYAAO4AAACAAQAAAAAAAAAAAAAAAAAAAAAAA" +
        "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAAQAA",
      _urls: [
        {
          type: "application/x-suggestions+json",
          method: "GET",
          template:
            "http://suggestqueries.google.com/complete/search?output=firefox&client=firefox" +
            "&hl={moz:locale}&q={searchTerms}",
          params: "",
        },
        {
          type: "text/html",
          method: "GET",
          template: "http://www.google.com/search",
          params: [
            {
              name: "q",
              value: "{searchTerms}",
              purpose: undefined,
            },
          ],
        },
      ],
    },
  },
};