test_persist.js - mozsearch

Enable keyboard shortcuts

/**

 * Any copyright is dedicated to the Public Domain.

 * http://creativecommons.org/publicdomain/zero/1.0/

*/

function* testSteps() {

  const origin = {

    url: "http://default.test.persist",

    path: "storage/default/http+++default.test.persist",

    persistence: "default",

};

  const metadataFileName = ".metadata-v2";

  let principal = getPrincipal(origin.url);

  info("Persisting an uninitialized origin");

  // Origin directory doesn't exist yet, so only check the result for

  // persisted().

  let request = persisted(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persisted() succeeded");

  ok(!request.result, "The origin is not persisted");

  info("Verifying persist() does update the metadata");

  request = persist(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persist() succeeded");

  let originDir = getRelativeFile(origin.path);

  let exists = originDir.exists();

  ok(exists, "Origin directory does exist");

  info("Reading out contents of metadata file");

  let metadataFile = originDir.clone();

  metadataFile.append(metadataFileName);

  File.createFromNsIFile(metadataFile).then(grabArgAndContinueHandler);

  let file = yield undefined;

  let fileReader = new FileReader();

  fileReader.onload = continueToNextStepSync;

  fileReader.readAsArrayBuffer(file);

  yield undefined;

  let originPersisted = getPersistedFromMetadata(fileReader.result);

  ok(originPersisted, "The origin is persisted");

  info("Verifying persisted()");

  request = persisted(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persisted() succeeded");

  Assert.strictEqual(

    request.result,

    originPersisted,

    "Persisted() concurs with metadata"

);

  info("Clearing the origin");

  // Clear the origin since we'll test the same directory again under different

  // circumstances.

  clearOrigin(principal, origin.persistence, continueToNextStepSync);

  yield undefined;

  info("Persisting an already initialized origin");

  initTemporaryStorage(continueToNextStepSync);

  yield undefined;

  initTemporaryOrigin(

    origin.persistence,

    principal,

    /* createIfNonExistent */ true,

    continueToNextStepSync

);

  yield undefined;

  info("Reading out contents of metadata file");

  fileReader = new FileReader();

  fileReader.onload = continueToNextStepSync;

  fileReader.readAsArrayBuffer(file);

  yield undefined;

  originPersisted = getPersistedFromMetadata(fileReader.result);

  ok(!originPersisted, "The origin isn't persisted after clearing");

  info("Verifying persisted()");

  request = persisted(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persisted() succeeded");

  Assert.strictEqual(

    request.result,

    originPersisted,

    "Persisted() concurs with metadata"

);

  info("Verifying persist() does update the metadata");

  request = persist(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persist() succeeded");

  info("Reading out contents of metadata file");

  fileReader = new FileReader();

  fileReader.onload = continueToNextStepSync;

  fileReader.readAsArrayBuffer(file);

  yield undefined;

  originPersisted = getPersistedFromMetadata(fileReader.result);

  ok(originPersisted, "The origin is persisted");

  info("Verifying persisted()");

  request = persisted(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persisted() succeeded");

  Assert.strictEqual(

    request.result,

    originPersisted,

    "Persisted() concurs with metadata"

);

  info("Clearing the origin");

  // Clear the origin since we'll test the same directory again under different

  // circumstances.

  clearOrigin(principal, origin.persistence, continueToNextStepSync);

  yield undefined;

  info(

    "Persisting an uninitialized origin when temporary storage is already initialized"

);

  initTemporaryStorage(continueToNextStepSync);

  yield undefined;

  exists = originDir.exists();

  ok(!exists, "Origin directory does not exist");

  exists = metadataFile.exists();

  ok(!exists, "Metadata file does not exist");

  info("Verifying persisted()");

  request = persisted(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persisted() succeeded");

  ok(!request.result, "Persisted() concurs with metadata");

  info("Verifying persist() does update the metadata");

  request = persist(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persist() succeeded");

  info("Reading out contents of metadata file");

  fileReader = new FileReader();

  fileReader.onload = continueToNextStepSync;

  fileReader.readAsArrayBuffer(file);

  yield undefined;

  originPersisted = getPersistedFromMetadata(fileReader.result);

  ok(originPersisted, "The origin is persisted");

  info("Verifying persisted()");

  request = persisted(principal, continueToNextStepSync);

  yield undefined;

  Assert.strictEqual(request.resultCode, NS_OK, "Persisted() succeeded");

  Assert.strictEqual(

    request.result,

    originPersisted,

    "Persisted() concurs with metadata"

);

  finishTest();