michael@0: // -*- Mode: js2; tab-width: 2; indent-tabs-mode: nil; js2-basic-offset: 2; js2-skip-preprocessor-directives: t; -*-
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: Components.utils.import("resource://gre/modules/SharedPreferences.jsm");
michael@0: Components.utils.import("resource://gre/modules/Promise.jsm");
michael@0: 
michael@0: let _observerId = 0;
michael@0: 
michael@0: function makeObserver() {
michael@0:   let deferred = Promise.defer();
michael@0: 
michael@0:   let ret = {
michael@0:     id: _observerId++,
michael@0:     count: 0,
michael@0:     promise: deferred.promise,
michael@0:     observe: function (subject, topic, data) {
michael@0:       ret.count += 1;
michael@0:       let msg = { subject: subject,
michael@0:                   topic: topic,
michael@0:                   data: data };
michael@0:       deferred.resolve(msg);
michael@0:     },
michael@0:   };
michael@0: 
michael@0:   return ret;
michael@0: };
michael@0: 
michael@0: add_task(function test_get_set() {
michael@0:   let branch = new SharedPreferences("test");
michael@0: 
michael@0:   branch.setBoolPref("boolKey", true);
michael@0:   branch.setCharPref("charKey", "string value");
michael@0:   branch.setIntPref("intKey", 1000);
michael@0: 
michael@0:   do_check_eq(branch.getBoolPref("boolKey"), true);
michael@0:   do_check_eq(branch.getCharPref("charKey"), "string value");
michael@0:   do_check_eq(branch.getIntPref("intKey"), 1000);
michael@0: 
michael@0:   branch.setBoolPref("boolKey", false);
michael@0:   branch.setCharPref("charKey", "different string value");
michael@0:   branch.setIntPref("intKey", -2000);
michael@0: 
michael@0:   do_check_eq(branch.getBoolPref("boolKey"), false);
michael@0:   do_check_eq(branch.getCharPref("charKey"), "different string value");
michael@0:   do_check_eq(branch.getIntPref("intKey"), -2000);
michael@0: 
michael@0:   do_check_eq(typeof(branch.getBoolPref("boolKey")), "boolean");
michael@0:   do_check_eq(typeof(branch.getCharPref("charKey")), "string");
michael@0:   do_check_eq(typeof(branch.getIntPref("intKey")), "number");
michael@0: });
michael@0: 
michael@0: add_task(function test_default() {
michael@0:   let branch = new SharedPreferences();
michael@0: 
michael@0:   branch.setBoolPref("boolKey", true);
michael@0:   branch.setCharPref("charKey", "string value");
michael@0:   branch.setIntPref("intKey", 1000);
michael@0: 
michael@0:   do_check_eq(branch.getBoolPref("boolKey"), true);
michael@0:   do_check_eq(branch.getCharPref("charKey"), "string value");
michael@0:   do_check_eq(branch.getIntPref("intKey"), 1000);
michael@0: 
michael@0:   branch.setBoolPref("boolKey", false);
michael@0:   branch.setCharPref("charKey", "different string value");
michael@0:   branch.setIntPref("intKey", -2000);
michael@0: 
michael@0:   do_check_eq(branch.getBoolPref("boolKey"), false);
michael@0:   do_check_eq(branch.getCharPref("charKey"), "different string value");
michael@0:   do_check_eq(branch.getIntPref("intKey"), -2000);
michael@0: 
michael@0:   do_check_eq(typeof(branch.getBoolPref("boolKey")), "boolean");
michael@0:   do_check_eq(typeof(branch.getCharPref("charKey")), "string");
michael@0:   do_check_eq(typeof(branch.getIntPref("intKey")), "number");
michael@0: });
michael@0: 
michael@0: add_task(function test_multiple_branches() {
michael@0:   let branch1 = new SharedPreferences("test1");
michael@0:   let branch2 = new SharedPreferences("test2");
michael@0: 
michael@0:   branch1.setBoolPref("boolKey", true);
michael@0:   branch2.setBoolPref("boolKey", false);
michael@0: 
michael@0:   do_check_eq(branch1.getBoolPref("boolKey"), true);
michael@0:   do_check_eq(branch2.getBoolPref("boolKey"), false);
michael@0: 
michael@0:   branch1.setCharPref("charKey", "a value");
michael@0:   branch2.setCharPref("charKey", "a different value");
michael@0: 
michael@0:   do_check_eq(branch1.getCharPref("charKey"), "a value");
michael@0:   do_check_eq(branch2.getCharPref("charKey"), "a different value");
michael@0: });
michael@0: 
michael@0: add_task(function test_add_remove_observer() {
michael@0:   let branch = new SharedPreferences("test");
michael@0: 
michael@0:   branch.setBoolPref("boolKey", false);
michael@0:   do_check_eq(branch.getBoolPref("boolKey"), false);
michael@0: 
michael@0:   let obs1 = makeObserver();
michael@0:   branch.addObserver("boolKey", obs1);
michael@0: 
michael@0:   try {
michael@0:     branch.setBoolPref("boolKey", true);
michael@0:     do_check_eq(branch.getBoolPref("boolKey"), true);
michael@0: 
michael@0:     let value1 = yield obs1.promise;
michael@0:     do_check_eq(obs1.count, 1);
michael@0: 
michael@0:     do_check_eq(value1.subject, obs1);
michael@0:     do_check_eq(value1.topic, "boolKey");
michael@0:     do_check_eq(typeof(value1.data), "boolean");
michael@0:     do_check_eq(value1.data, true);
michael@0:   } finally {
michael@0:     branch.removeObserver("boolKey", obs1);
michael@0:   }
michael@0: 
michael@0:   // Make sure the original observer is really gone, or as close as
michael@0:   // we: install a second observer, wait for it to be notified, and
michael@0:   // then verify the original observer was *not* notified.  This
michael@0:   // depends, of course, on the order that observers are notified, but
michael@0:   // is better than nothing.
michael@0: 
michael@0:   let obs2 = makeObserver();
michael@0:   branch.addObserver("boolKey", obs2);
michael@0: 
michael@0:   try {
michael@0:     branch.setBoolPref("boolKey", false);
michael@0:     do_check_eq(branch.getBoolPref("boolKey"), false);
michael@0: 
michael@0:     let value2 = yield obs2.promise;
michael@0:     do_check_eq(obs2.count, 1);
michael@0: 
michael@0:     do_check_eq(value2.subject, obs2);
michael@0:     do_check_eq(value2.topic, "boolKey");
michael@0:     do_check_eq(typeof(value2.data), "boolean");
michael@0:     do_check_eq(value2.data, false);
michael@0: 
michael@0:     // Original observer count is preserved.
michael@0:     do_check_eq(obs1.count, 1);
michael@0:   } finally {
michael@0:     branch.removeObserver("boolKey", obs2);
michael@0:   }
michael@0: });
michael@0: 
michael@0: add_task(function test_observer_ignores() {
michael@0:   let branch = new SharedPreferences("test");
michael@0: 
michael@0:   branch.setCharPref("charKey", "first value");
michael@0:   do_check_eq(branch.getCharPref("charKey"), "first value");
michael@0: 
michael@0:   let obs = makeObserver();
michael@0:   branch.addObserver("charKey", obs);
michael@0: 
michael@0:   try {
michael@0:     // These should all be ignored.
michael@0:     branch.setBoolPref("boolKey", true);
michael@0:     branch.setBoolPref("boolKey", false);
michael@0:     branch.setIntPref("intKey", -3000);
michael@0:     branch.setIntPref("intKey", 4000);
michael@0: 
michael@0:     branch.setCharPref("charKey", "a value");
michael@0:     let value = yield obs.promise;
michael@0: 
michael@0:     // Observer should have been notified exactly once.
michael@0:     do_check_eq(obs.count, 1);
michael@0: 
michael@0:     do_check_eq(value.subject, obs);
michael@0:     do_check_eq(value.topic, "charKey");
michael@0:     do_check_eq(typeof(value.data), "string");
michael@0:     do_check_eq(value.data, "a value");
michael@0:   } finally {
michael@0:     branch.removeObserver("charKey", obs);
michael@0:   }
michael@0: });
michael@0: 
michael@0: add_task(function test_observer_ignores_branches() {
michael@0:   let branch = new SharedPreferences("test");
michael@0: 
michael@0:   branch.setCharPref("charKey", "first value");
michael@0:   do_check_eq(branch.getCharPref("charKey"), "first value");
michael@0: 
michael@0:   let obs = makeObserver();
michael@0:   branch.addObserver("charKey", obs);
michael@0: 
michael@0:   try {
michael@0:     // These should all be ignored.
michael@0:     let branch2 = new SharedPreferences("test2");
michael@0:     branch2.setCharPref("charKey", "a wrong value");
michael@0:     let branch3 = new SharedPreferences("test.2");
michael@0:     branch3.setCharPref("charKey", "a different wrong value");
michael@0: 
michael@0:     // This should not be ignored.
michael@0:     branch.setCharPref("charKey", "a value");
michael@0: 
michael@0:     let value = yield obs.promise;
michael@0: 
michael@0:     // Observer should have been notified exactly once.
michael@0:     do_check_eq(obs.count, 1);
michael@0: 
michael@0:     do_check_eq(value.subject, obs);
michael@0:     do_check_eq(value.topic, "charKey");
michael@0:     do_check_eq(typeof(value.data), "string");
michael@0:     do_check_eq(value.data, "a value");
michael@0:   } finally {
michael@0:     branch.removeObserver("charKey", obs);
michael@0:   }
michael@0: });
michael@0: 
michael@0: run_next_test();