michael@0: /* Any copyright is dedicated to the Public Domain.
michael@0:  * http://creativecommons.org/publicdomain/zero/1.0/ */
michael@0: 
michael@0: "use strict";
michael@0: 
michael@0: const {classes: Cc, interfaces: Ci, utils: Cu} = Components;
michael@0: 
michael@0: let bsp = Cu.import("resource://gre/modules/CrashManager.jsm", this);
michael@0: Cu.import("resource://gre/modules/Promise.jsm", this);
michael@0: Cu.import("resource://gre/modules/Task.jsm", this);
michael@0: Cu.import("resource://gre/modules/osfile.jsm", this);
michael@0: 
michael@0: Cu.import("resource://testing-common/CrashManagerTest.jsm", this);
michael@0: 
michael@0: const DUMMY_DATE = new Date(Date.now() - 10 * 24 * 60 * 60 * 1000);
michael@0: DUMMY_DATE.setMilliseconds(0);
michael@0: 
michael@0: function run_test() {
michael@0:   do_get_profile();
michael@0:   configureLogging();
michael@0:   run_next_test();
michael@0: }
michael@0: 
michael@0: add_task(function* test_constructor_ok() {
michael@0:   let m = new CrashManager({
michael@0:     pendingDumpsDir: "/foo",
michael@0:     submittedDumpsDir: "/bar",
michael@0:     eventsDirs: [],
michael@0:     storeDir: "/baz",
michael@0:   });
michael@0:   Assert.ok(m, "CrashManager can be created.");
michael@0: });
michael@0: 
michael@0: add_task(function* test_constructor_invalid() {
michael@0:   Assert.throws(() => {
michael@0:     new CrashManager({foo: true});
michael@0:   });
michael@0: });
michael@0: 
michael@0: add_task(function* test_get_manager() {
michael@0:   let m = yield getManager();
michael@0:   Assert.ok(m, "CrashManager obtained.");
michael@0: 
michael@0:   yield m.createDummyDump(true);
michael@0:   yield m.createDummyDump(false);
michael@0: });
michael@0: 
michael@0: // Unsubmitted dump files on disk are detected properly.
michael@0: add_task(function* test_pending_dumps() {
michael@0:   let m = yield getManager();
michael@0:   let now = Date.now();
michael@0:   let ids = [];
michael@0:   const COUNT = 5;
michael@0: 
michael@0:   for (let i = 0; i < COUNT; i++) {
michael@0:     ids.push(yield m.createDummyDump(false, new Date(now - i * 86400000)));
michael@0:   }
michael@0:   yield m.createIgnoredDumpFile("ignored", false);
michael@0: 
michael@0:   let entries = yield m.pendingDumps();
michael@0:   Assert.equal(entries.length, COUNT, "proper number detected.");
michael@0: 
michael@0:   for (let entry of entries) {
michael@0:     Assert.equal(typeof(entry), "object", "entry is an object");
michael@0:     Assert.ok("id" in entry, "id in entry");
michael@0:     Assert.ok("path" in entry, "path in entry");
michael@0:     Assert.ok("date" in entry, "date in entry");
michael@0:     Assert.notEqual(ids.indexOf(entry.id), -1, "ID is known");
michael@0:   }
michael@0: 
michael@0:   for (let i = 0; i < COUNT; i++) {
michael@0:     Assert.equal(entries[i].id, ids[COUNT-i-1], "Entries sorted by mtime");
michael@0:   }
michael@0: });
michael@0: 
michael@0: // Submitted dump files on disk are detected properly.
michael@0: add_task(function* test_submitted_dumps() {
michael@0:   let m = yield getManager();
michael@0:   let COUNT = 5;
michael@0: 
michael@0:   for (let i = 0; i < COUNT; i++) {
michael@0:     yield m.createDummyDump(true);
michael@0:   }
michael@0:   yield m.createIgnoredDumpFile("ignored", true);
michael@0: 
michael@0:   let entries = yield m.submittedDumps();
michael@0:   Assert.equal(entries.length, COUNT, "proper number detected.");
michael@0: 
michael@0:   let hrID = yield m.createDummyDump(true, new Date(), true);
michael@0:   entries = yield m.submittedDumps();
michael@0:   Assert.equal(entries.length, COUNT + 1, "hr- in filename detected.");
michael@0: 
michael@0:   let gotIDs = new Set([e.id for (e of entries)]);
michael@0:   Assert.ok(gotIDs.has(hrID));
michael@0: });
michael@0: 
michael@0: // The store should expire after inactivity.
michael@0: add_task(function* test_store_expires() {
michael@0:   let m = yield getManager();
michael@0: 
michael@0:   Object.defineProperty(m, "STORE_EXPIRATION_MS", {
michael@0:     value: 250,
michael@0:   });
michael@0: 
michael@0:   let store = yield m._getStore();
michael@0:   Assert.ok(store);
michael@0:   Assert.equal(store, m._store);
michael@0: 
michael@0:   yield sleep(300);
michael@0:   Assert.ok(!m._store, "Store has gone away.");
michael@0: });
michael@0: 
michael@0: // Ensure discovery of unprocessed events files works.
michael@0: add_task(function* test_unprocessed_events_files() {
michael@0:   let m = yield getManager();
michael@0:   yield m.createEventsFile("1", "test.1", new Date(), "foo", 0);
michael@0:   yield m.createEventsFile("2", "test.1", new Date(), "bar", 0);
michael@0:   yield m.createEventsFile("1", "test.1", new Date(), "baz", 1);
michael@0: 
michael@0:   let paths = yield m._getUnprocessedEventsFiles();
michael@0:   Assert.equal(paths.length, 3);
michael@0: });
michael@0: 
michael@0: // Ensure only 1 aggregateEventsFiles() is allowed at a time.
michael@0: add_task(function* test_aggregate_events_locking() {
michael@0:   let m = yield getManager();
michael@0: 
michael@0:   let p1 = m.aggregateEventsFiles();
michael@0:   let p2 = m.aggregateEventsFiles();
michael@0: 
michael@0:   Assert.strictEqual(p1, p2, "Same promise should be returned.");
michael@0: });
michael@0: 
michael@0: // Malformed events files should be deleted.
michael@0: add_task(function* test_malformed_files_deleted() {
michael@0:   let m = yield getManager();
michael@0: 
michael@0:   yield m.createEventsFile("1", "crash.main.1", new Date(), "foo\nbar");
michael@0: 
michael@0:   let count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 1);
michael@0:   let crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 0);
michael@0: 
michael@0:   count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 0);
michael@0: });
michael@0: 
michael@0: // Unknown event types should be ignored.
michael@0: add_task(function* test_aggregate_ignore_unknown_events() {
michael@0:   let m = yield getManager();
michael@0: 
michael@0:   yield m.createEventsFile("1", "crash.main.1", DUMMY_DATE, "id1");
michael@0:   yield m.createEventsFile("2", "foobar.1", new Date(), "dummy");
michael@0: 
michael@0:   let count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 2);
michael@0: 
michael@0:   count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 1);
michael@0: 
michael@0:   count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 1);
michael@0: });
michael@0: 
michael@0: add_task(function* test_prune_old() {
michael@0:   let m = yield getManager();
michael@0:   let oldDate = new Date(Date.now() - 86400000);
michael@0:   let newDate = new Date(Date.now() - 10000);
michael@0:   yield m.createEventsFile("1", "crash.main.1", oldDate, "id1");
michael@0:   yield m.createEventsFile("2", "crash.plugin.1", newDate, "id2");
michael@0: 
michael@0:   yield m.aggregateEventsFiles();
michael@0: 
michael@0:   let crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 2);
michael@0: 
michael@0:   yield m.pruneOldCrashes(new Date(oldDate.getTime() + 10000));
michael@0: 
michael@0:   crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 1, "Old crash has been pruned.");
michael@0: 
michael@0:   let c = crashes[0];
michael@0:   Assert.equal(c.id, "id2", "Proper crash was pruned.");
michael@0: 
michael@0:   // We can't test exact boundary conditions because dates from filesystem
michael@0:   // don't have same guarantees as JS dates.
michael@0:   yield m.pruneOldCrashes(new Date(newDate.getTime() + 5000));
michael@0:   crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 0);
michael@0: });
michael@0: 
michael@0: add_task(function* test_schedule_maintenance() {
michael@0:   let m = yield getManager();
michael@0:   yield m.createEventsFile("1", "crash.main.1", DUMMY_DATE, "id1");
michael@0: 
michael@0:   let oldDate = new Date(Date.now() - m.PURGE_OLDER_THAN_DAYS * 2 * 24 * 60 * 60 * 1000);
michael@0:   yield m.createEventsFile("2", "crash.main.1", oldDate, "id2");
michael@0: 
michael@0:   yield m.scheduleMaintenance(25);
michael@0:   let crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 1);
michael@0:   Assert.equal(crashes[0].id, "id1");
michael@0: });
michael@0: 
michael@0: add_task(function* test_main_crash_event_file() {
michael@0:   let m = yield getManager();
michael@0:   yield m.createEventsFile("1", "crash.main.1", DUMMY_DATE, "id1");
michael@0:   let count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 1);
michael@0: 
michael@0:   let crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 1);
michael@0:   Assert.equal(crashes[0].id, "id1");
michael@0:   Assert.equal(crashes[0].type, "main-crash");
michael@0:   Assert.deepEqual(crashes[0].crashDate, DUMMY_DATE);
michael@0: 
michael@0:   count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 0);
michael@0: });
michael@0: 
michael@0: add_task(function* test_multiline_crash_id_rejected() {
michael@0:   let m = yield getManager();
michael@0:   yield m.createEventsFile("1", "crash.main.1", DUMMY_DATE, "id1\nid2");
michael@0:   yield m.aggregateEventsFiles();
michael@0:   let crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 0);
michael@0: });
michael@0: 
michael@0: add_task(function* test_plugin_crash_event_file() {
michael@0:   let m = yield getManager();
michael@0:   yield m.createEventsFile("1", "crash.plugin.1", DUMMY_DATE, "id1");
michael@0:   let count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 1);
michael@0: 
michael@0:   let crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 1);
michael@0:   Assert.equal(crashes[0].id, "id1");
michael@0:   Assert.equal(crashes[0].type, "plugin-crash");
michael@0:   Assert.deepEqual(crashes[0].crashDate, DUMMY_DATE);
michael@0: 
michael@0:   count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 0);
michael@0: });
michael@0: 
michael@0: add_task(function* test_plugin_hang_event_file() {
michael@0:   let m = yield getManager();
michael@0:   yield m.createEventsFile("1", "hang.plugin.1", DUMMY_DATE, "id1");
michael@0:   let count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 1);
michael@0: 
michael@0:   let crashes = yield m.getCrashes();
michael@0:   Assert.equal(crashes.length, 1);
michael@0:   Assert.equal(crashes[0].id, "id1");
michael@0:   Assert.equal(crashes[0].type, "plugin-hang");
michael@0:   Assert.deepEqual(crashes[0].crashDate, DUMMY_DATE);
michael@0: 
michael@0:   count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 0);
michael@0: });
michael@0: 
michael@0: // Excessive amounts of files should be processed properly.
michael@0: add_task(function* test_high_water_mark() {
michael@0:   let m = yield getManager();
michael@0: 
michael@0:   let store = yield m._getStore();
michael@0: 
michael@0:   for (let i = 0; i < store.HIGH_WATER_DAILY_THRESHOLD + 1; i++) {
michael@0:     yield m.createEventsFile("m" + i, "crash.main.1", DUMMY_DATE, "m" + i);
michael@0:     yield m.createEventsFile("pc" + i, "crash.plugin.1", DUMMY_DATE, "pc" + i);
michael@0:     yield m.createEventsFile("ph" + i, "hang.plugin.1", DUMMY_DATE, "ph" + i);
michael@0:   }
michael@0: 
michael@0:   let count = yield m.aggregateEventsFiles();
michael@0:   Assert.equal(count, 3 * bsp.CrashStore.prototype.HIGH_WATER_DAILY_THRESHOLD + 3);
michael@0: 
michael@0:   // Need to fetch again in case the first one was garbage collected.
michael@0:   store = yield m._getStore();
michael@0:   // +1 is for preserved main process crash.
michael@0:   Assert.equal(store.crashesCount, 3 * store.HIGH_WATER_DAILY_THRESHOLD + 1);
michael@0: });