test_import_mobile_bookmarks.js

async function importFromFixture(fixture, replace) {
  let cwd = await OS.File.getCurrentDirectory();
  let path = OS.Path.join(cwd, fixture);

  info(`Importing from ${path}`);
  await BookmarkJSONUtils.importFromFile(path, { replace });
  await PlacesTestUtils.promiseAsyncUpdates();
}

async function treeEquals(guid, expected, message) {
  let root = await PlacesUtils.promiseBookmarksTree(guid);
  let bookmarks = (function nodeToEntry(node) {
    let entry = { guid: node.guid, index: node.index };
    if (node.children) {
      entry.children = node.children.map(nodeToEntry);
    }
    return entry;
  })(root);

  info(`Checking if ${guid} tree matches ${JSON.stringify(expected)}`);
  info(`Got bookmarks tree for ${guid}: ${JSON.stringify(bookmarks)}`);

  deepEqual(bookmarks, expected, message);
}

add_task(async function test_restore_mobile_bookmarks_root() {
  await importFromFixture(
    "mobile_bookmarks_root_import.json",
    /* replace */ true
  );

  await treeEquals(
    PlacesUtils.bookmarks.rootGuid,
    {
      guid: PlacesUtils.bookmarks.rootGuid,
      index: 0,
      children: [
        {
          guid: PlacesUtils.bookmarks.menuGuid,
          index: 0,
          children: [{ guid: "X6lUyOspVYwi", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.toolbarGuid,
          index: 1,
        },
        {
          guid: PlacesUtils.bookmarks.unfiledGuid,
          index: 3,
        },
        {
          guid: PlacesUtils.bookmarks.mobileGuid,
          index: 4,
          children: [
            { guid: "_o8e1_zxTJFg", index: 0 },
            { guid: "QCtSqkVYUbXB", index: 1 },
          ],
        },
      ],
    },
    "Should restore mobile bookmarks from root"
  );

  await PlacesUtils.bookmarks.eraseEverything();
});

add_task(async function test_import_mobile_bookmarks_root() {
  await importFromFixture(
    "mobile_bookmarks_root_import.json",
    /* replace */ false
  );
  await importFromFixture(
    "mobile_bookmarks_root_merge.json",
    /* replace */ false
  );

  await treeEquals(
    PlacesUtils.bookmarks.rootGuid,
    {
      guid: PlacesUtils.bookmarks.rootGuid,
      index: 0,
      children: [
        {
          guid: PlacesUtils.bookmarks.menuGuid,
          index: 0,
          children: [
            { guid: "X6lUyOspVYwi", index: 0 },
            { guid: "Utodo9b0oVws", index: 1 },
          ],
        },
        {
          guid: PlacesUtils.bookmarks.toolbarGuid,
          index: 1,
        },
        {
          guid: PlacesUtils.bookmarks.unfiledGuid,
          index: 3,
        },
        {
          guid: PlacesUtils.bookmarks.mobileGuid,
          index: 4,
          children: [
            // The first two are in ..._import.json, the second two are in
            // ..._merge.json
            { guid: "_o8e1_zxTJFg", index: 0 },
            { guid: "QCtSqkVYUbXB", index: 1 },
            { guid: "a17yW6-nTxEJ", index: 2 },
            { guid: "xV10h9Wi3FBM", index: 3 },
          ],
        },
      ],
    },
    "Should merge bookmarks root contents"
  );

  await PlacesUtils.bookmarks.eraseEverything();
});

add_task(async function test_restore_mobile_bookmarks_folder() {
  // This tests importing a mobile bookmarks folder with the annotation,
  // and the old, random guid.
  await importFromFixture(
    "mobile_bookmarks_folder_import.json",
    /* replace */ true
  );

  await treeEquals(
    PlacesUtils.bookmarks.rootGuid,
    {
      guid: PlacesUtils.bookmarks.rootGuid,
      index: 0,
      children: [
        {
          guid: PlacesUtils.bookmarks.menuGuid,
          index: 0,
          children: [
            { guid: "X6lUyOspVYwi", index: 0 },
            { guid: "XF4yRP6bTuil", index: 1 },
          ],
        },
        {
          guid: PlacesUtils.bookmarks.toolbarGuid,
          index: 1,
          children: [{ guid: "buy7711R3ZgE", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.unfiledGuid,
          index: 3,
          children: [{ guid: "KIa9iKZab2Z5", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.mobileGuid,
          index: 4,
          children: [
            { guid: "_o8e1_zxTJFg", index: 0 },
            { guid: "QCtSqkVYUbXB", index: 1 },
          ],
        },
      ],
    },
    "Should restore mobile bookmark folder contents into mobile root"
  );

  let queryById = await PlacesUtils.bookmarks.fetch("XF4yRP6bTuil");
  equal(
    queryById.url.href,
    `place:parent=${PlacesUtils.bookmarks.mobileGuid}`,
    "Should rewrite mobile query to point to root GUID"
  );

  await PlacesUtils.bookmarks.eraseEverything();
});

add_task(async function test_import_mobile_bookmarks_folder() {
  await importFromFixture(
    "mobile_bookmarks_folder_import.json",
    /* replace */ false
  );
  await importFromFixture(
    "mobile_bookmarks_folder_merge.json",
    /* replace */ false
  );

  await treeEquals(
    PlacesUtils.bookmarks.rootGuid,
    {
      guid: PlacesUtils.bookmarks.rootGuid,
      index: 0,
      children: [
        {
          guid: PlacesUtils.bookmarks.menuGuid,
          index: 0,
          children: [
            { guid: "X6lUyOspVYwi", index: 0 },
            { guid: "XF4yRP6bTuil", index: 1 },
            { guid: "Utodo9b0oVws", index: 2 },
          ],
        },
        {
          guid: PlacesUtils.bookmarks.toolbarGuid,
          index: 1,
          children: [{ guid: "buy7711R3ZgE", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.unfiledGuid,
          index: 3,
          children: [{ guid: "KIa9iKZab2Z5", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.mobileGuid,
          index: 4,
          children: [
            { guid: "_o8e1_zxTJFg", index: 0 },
            { guid: "QCtSqkVYUbXB", index: 1 },
            { guid: "a17yW6-nTxEJ", index: 2 },
            { guid: "xV10h9Wi3FBM", index: 3 },
          ],
        },
      ],
    },
    "Should merge bookmarks folder contents into mobile root"
  );

  await PlacesUtils.bookmarks.eraseEverything();
});

add_task(async function test_restore_multiple_bookmarks_folders() {
  await importFromFixture(
    "mobile_bookmarks_multiple_folders.json",
    /* replace */ true
  );

  await treeEquals(
    PlacesUtils.bookmarks.rootGuid,
    {
      guid: PlacesUtils.bookmarks.rootGuid,
      index: 0,
      children: [
        {
          guid: PlacesUtils.bookmarks.menuGuid,
          index: 0,
          children: [
            { guid: "buy7711R3ZgE", index: 0 },
            { guid: "F_LBgd1fS_uQ", index: 1 },
            { guid: "oIpmQXMWsXvY", index: 2 },
          ],
        },
        {
          guid: PlacesUtils.bookmarks.toolbarGuid,
          index: 1,
          children: [{ guid: "Utodo9b0oVws", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.unfiledGuid,
          index: 3,
          children: [{ guid: "xV10h9Wi3FBM", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.mobileGuid,
          index: 4,
          children: [
            { guid: "a17yW6-nTxEJ", index: 0 },
            { guid: "sSZ86WT9WbN3", index: 1 },
          ],
        },
      ],
    },
    "Should restore multiple bookmarks folder contents into root"
  );

  await PlacesUtils.bookmarks.eraseEverything();
});

add_task(async function test_import_multiple_bookmarks_folders() {
  await importFromFixture(
    "mobile_bookmarks_root_import.json",
    /* replace */ false
  );
  await importFromFixture(
    "mobile_bookmarks_multiple_folders.json",
    /* replace */ false
  );

  await treeEquals(
    PlacesUtils.bookmarks.rootGuid,
    {
      guid: PlacesUtils.bookmarks.rootGuid,
      index: 0,
      children: [
        {
          guid: PlacesUtils.bookmarks.menuGuid,
          index: 0,
          children: [
            { guid: "X6lUyOspVYwi", index: 0 },
            { guid: "buy7711R3ZgE", index: 1 },
            { guid: "F_LBgd1fS_uQ", index: 2 },
            { guid: "oIpmQXMWsXvY", index: 3 },
          ],
        },
        {
          guid: PlacesUtils.bookmarks.toolbarGuid,
          index: 1,
          children: [{ guid: "Utodo9b0oVws", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.unfiledGuid,
          index: 3,
          children: [{ guid: "xV10h9Wi3FBM", index: 0 }],
        },
        {
          guid: PlacesUtils.bookmarks.mobileGuid,
          index: 4,
          children: [
            { guid: "_o8e1_zxTJFg", index: 0 },
            { guid: "QCtSqkVYUbXB", index: 1 },
            { guid: "a17yW6-nTxEJ", index: 2 },
            { guid: "sSZ86WT9WbN3", index: 3 },
          ],
        },
      ],
    },
    "Should merge multiple mobile folders into root"
  );

  await PlacesUtils.bookmarks.eraseEverything();
});