gecko-dev/storage/test/unit/test_storage_progresshandler.js

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

// This file tests the custom progress handlers

function setup() {
  var msc = getOpenedDatabase();
  msc.createTable("handler_tests", "id INTEGER PRIMARY KEY, num INTEGER");
  msc.beginTransaction();

  var stmt = createStatement("INSERT INTO handler_tests (id, num) VALUES(?1, ?2)");
  for (let i = 0; i < 100; ++i) {
    stmt.bindByIndex(0, i);
    stmt.bindByIndex(1, Math.floor(Math.random() * 1000));
    stmt.execute();
  }
  stmt.reset();
  msc.commitTransaction();
  stmt.finalize();
}

var testProgressHandler = {
  calls: 0,
  abort: false,

  onProgress(comm) {
    ++this.calls;
    return this.abort;
  },
};

function test_handler_registration() {
  var msc = getOpenedDatabase();
  msc.setProgressHandler(10, testProgressHandler);
}

function test_handler_return() {
  var msc = getOpenedDatabase();
  var oldH = msc.setProgressHandler(5, testProgressHandler);
  Assert.ok(oldH instanceof Ci.mozIStorageProgressHandler);
}

function test_handler_removal() {
  var msc = getOpenedDatabase();
  msc.removeProgressHandler();
  var oldH = msc.removeProgressHandler();
  Assert.equal(oldH, null);
}

function test_handler_call() {
  var msc = getOpenedDatabase();
  msc.setProgressHandler(50, testProgressHandler);
  // Some long-executing request
  var stmt = createStatement(
    "SELECT SUM(t1.num * t2.num) FROM handler_tests AS t1, handler_tests AS t2");
  while (stmt.executeStep()) {
    // Do nothing.
  }
  Assert.ok(testProgressHandler.calls > 0);
  stmt.finalize();
}

function test_handler_abort() {
  var msc = getOpenedDatabase();
  testProgressHandler.abort = true;
  msc.setProgressHandler(50, testProgressHandler);
  // Some long-executing request
  var stmt = createStatement(
    "SELECT SUM(t1.num * t2.num) FROM handler_tests AS t1, handler_tests AS t2");

  const SQLITE_INTERRUPT = 9;
  try {
    while (stmt.executeStep()) {
      // Do nothing.
    }
    do_throw("We shouldn't get here!");
  } catch (e) {
    Assert.equal(Cr.NS_ERROR_ABORT, e.result);
    Assert.equal(SQLITE_INTERRUPT, msc.lastError);
  }
  try {
    stmt.finalize();
    do_throw("We shouldn't get here!");
  } catch (e) {
    // finalize should return the error code since we encountered an error
    Assert.equal(Cr.NS_ERROR_ABORT, e.result);
    Assert.equal(SQLITE_INTERRUPT, msc.lastError);
  }
}

var tests = [test_handler_registration, test_handler_return,
             test_handler_removal, test_handler_call,
             test_handler_abort];

function run_test() {
  setup();

  for (var i = 0; i < tests.length; i++) {
    tests[i]();
  }

  cleanup();
}