Bug 1915774: Remove setFaviconForPage() in head_common r=places-reviewers,mak

Differential Revision: https://phabricator.services.mozilla.com/D241887

Author: Daisuke Akatsuka

toolkit/components/places/tests/PlacesTestUtils.sys.mjs

@@ -183,11 +183,13 @@ export var PlacesTestUtils = Object.freeze({
   /**
    * Get favicon data for given URL from database.
    *
-   * @param {nsIURI} faviconURI
-   *        nsIURI for the favicon
+   * @param {string or nsIURI} faviconURI
+   *        uri for the favicon
    * @return {nsIURI} data URL
    */
   async getFaviconDataURLFromDB(faviconURI) {
+    faviconURI = lazy.PlacesUtils.toURI(faviconURI);
+
     const db = await lazy.PlacesUtils.promiseDBConnection();
     const rows = await db.executeCached(
       `SELECT data, width
@@ -218,7 +220,7 @@ export var PlacesTestUtils = Object.freeze({
   /**
    * Get favicon data for given URL from network.
    *
-   * @param {nsIURI} faviconURI
+   * @param {string or nsIURI} faviconURI
    *        nsIURI for the favicon.
    * @param {nsIPrincipal} [optional] loadingPrincipal
    *        The principal to load from network. If no, use system principal.
@@ -232,6 +234,7 @@ export var PlacesTestUtils = Object.freeze({
     faviconURI,
     loadingPrincipal = Services.scriptSecurityManager.getSystemPrincipal()
   ) {
+    faviconURI = lazy.PlacesUtils.toURI(faviconURI);
     if (faviconURI.schemeIs("data")) {
       return faviconURI;
     }

toolkit/components/places/tests/favicons/test_copyFavicons.js

@@ -72,7 +72,11 @@ add_task(async function test_copyFavicons_noop() {
   );
 
   info("Unknown dest uri, source has icon");
-  await setFaviconForPage(TEST_URI1, SMALLPNG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_URI1,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
   Assert.equal(
     await copyFavicons(TEST_URI1, TEST_URI2, false),
     null,
@@ -94,8 +98,16 @@ add_task(async function test_copyFavicons_noop() {
 add_task(async function test_copyFavicons() {
   info("Normal copy across 2 pages");
   await PlacesTestUtils.addVisits(TEST_URI1);
-  await setFaviconForPage(TEST_URI1, SMALLPNG_DATA_URI);
-  await setFaviconForPage(TEST_URI1, SMALLSVG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_URI1,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_URI1,
+    SMALLSVG_DATA_URI,
+    SMALLSVG_DATA_URI
+  );
   await PlacesTestUtils.addVisits(TEST_URI2);
   let promiseChange = promisePageChanged(TEST_URI2.spec);
   Assert.equal(
@@ -145,10 +157,22 @@ add_task(async function test_copyFavicons() {
 add_task(async function test_copyFavicons_overlap() {
   info("Copy to a page that has one of the favicons already");
   await PlacesTestUtils.addVisits(TEST_URI1);
-  await setFaviconForPage(TEST_URI1, SMALLPNG_DATA_URI);
-  await setFaviconForPage(TEST_URI1, SMALLSVG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_URI1,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_URI1,
+    SMALLSVG_DATA_URI,
+    SMALLSVG_DATA_URI
+  );
   await PlacesTestUtils.addVisits(TEST_URI2);
-  await setFaviconForPage(TEST_URI2, SMALLPNG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_URI2,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
   let promiseChange = promisePageChanged(TEST_URI2.spec);
   Assert.equal(
     (await copyFavicons(TEST_URI1, TEST_URI2, false)).spec,
@@ -170,7 +194,11 @@ add_task(async function test_copyFavicons_overlap() {
 
 add_task(async function test_copyFavicons_local_uri() {
   await PlacesTestUtils.addVisits(TEST_URI1);
-  await setFaviconForPage(TEST_URI1, SMALLPNG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_URI1,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
 
   Assert.throws(
     () => PlacesUtils.favicons.copyFavicons(TEST_URI1, TEST_LOCAL_URI, false),

toolkit/components/places/tests/favicons/test_expireAllFavicons.js

@@ -15,7 +15,11 @@ add_task(async function test_expireAllFavicons() {
   });
 
   // Set a favicon for our test page.
-  await setFaviconForPage(TEST_PAGE_URI, SMALLPNG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    TEST_PAGE_URI,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
 
   // Add a page with a bookmark.
   await PlacesUtils.bookmarks.insert({
@@ -25,7 +29,11 @@ add_task(async function test_expireAllFavicons() {
   });
 
   // Set a favicon for our bookmark.
-  await setFaviconForPage(BOOKMARKED_PAGE_URI, SMALLPNG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    BOOKMARKED_PAGE_URI,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
 
   // Start expiration only after data has been saved in the database.
   let promise = promiseTopicObserved(PlacesUtils.TOPIC_FAVICONS_EXPIRED);

toolkit/components/places/tests/favicons/test_favicons_protocols_ref.js

@@ -67,8 +67,16 @@ add_task(async function () {
 
   // Add the icon also for the page with ref.
   await PlacesTestUtils.addVisits(PAGE_URL + "#other§=12");
-  await setFaviconForPage(PAGE_URL + "#other§=12", ICON16_URL, false);
-  await setFaviconForPage(PAGE_URL + "#other§=12", ICON32_URL, false);
+  await PlacesTestUtils.setFaviconForPage(
+    PAGE_URL + "#other§=12",
+    ICON16_URL,
+    await PlacesTestUtils.getFaviconDataURLFromDB(ICON16_URL)
+  );
+  await PlacesTestUtils.setFaviconForPage(
+    PAGE_URL + "#other§=12",
+    ICON32_URL,
+    await PlacesTestUtils.getFaviconDataURLFromDB(ICON32_URL)
+  );
   await compareFavicons(
     PlacesUtils.urlWithSizeRef(win, PAGE_ICON_URL + "#other§=12", 16),
     PlacesUtils.favicons.getFaviconLinkForIcon(Services.io.newURI(ICON16_URL)),

toolkit/components/places/tests/favicons/test_page-icon_protocol.js

@@ -157,7 +157,11 @@ add_task(async function page_with_ref() {
     "http://places.test.ref/#",
   ]) {
     await PlacesTestUtils.addVisits(url);
-    await setFaviconForPage(url, ICON_URI, false);
+    await PlacesTestUtils.setFaviconForPage(
+      url,
+      ICON_URI,
+      await PlacesTestUtils.getFaviconDataURLFromDB(ICON_URI)
+    );
     let { data, contentType } = await fetchIconForSpec("page-icon:" + url);
     Assert.equal(contentType, gFavicon.contentType);
     Assert.deepEqual(data, gFavicon.data, "Got the favicon data");

toolkit/components/places/tests/head_common.js

@@ -734,32 +734,6 @@ function sortBy(array, prop) {
   return array.sort((a, b) => compareAscending(a[prop], b[prop]));
 }
 
-/**
- * Asynchronously set the favicon associated with a page.
- * @param page
- *        The page's URL
- * @param icon
- *        The URL of the favicon to be set.
- * @param [optional] forceReload
- *        Whether to enforce reloading the icon.
- */
-async function setFaviconForPage(page, icon, forceReload = true) {
-  let pageURI =
-    page instanceof Ci.nsIURI ? page : NetUtil.newURI(new URL(page).href);
-  let iconURI =
-    icon instanceof Ci.nsIURI ? icon : NetUtil.newURI(new URL(icon).href);
-
-  let dataURL;
-  if (!forceReload) {
-    dataURL = await PlacesTestUtils.getFaviconDataURLFromDB(iconURI);
-  }
-  if (!dataURL) {
-    dataURL = await PlacesTestUtils.getFaviconDataURLFromNetwork(iconURI);
-  }
-
-  await PlacesUtils.favicons.setFaviconForPage(pageURI, iconURI, dataURL);
-}
-
 function getFaviconUrlForPage(page, width = 0) {
   let pageURI =
     page instanceof Ci.nsIURI ? page : NetUtil.newURI(new URL(page).href);

toolkit/components/places/tests/unit/test_promiseBookmarksTree.js

@@ -253,7 +253,11 @@ add_task(async function () {
     url: urlWithCharsetAndFavicon,
     annotations: new Map([[PlacesUtils.CHARSET_ANNO, "UTF-16"]]),
   });
-  await setFaviconForPage(urlWithCharsetAndFavicon, SMALLPNG_DATA_URI);
+  await PlacesTestUtils.setFaviconForPage(
+    urlWithCharsetAndFavicon,
+    SMALLPNG_DATA_URI,
+    SMALLPNG_DATA_URI
+  );
   // Test the default places root without specifying it.
   await test_promiseBookmarksTreeAgainstResult();