Do not reset favicon for same document navigations

Fixes: QTBUG-103735
Change-Id: Iee0c09cde16a825097b7c1c014655476989922c0
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
(cherry picked from commit c5de1b21232c7114b27e42fa8c15cb323d256e47)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>

3 files changed, 73 insertions, 4 deletions

diff --git a/src/core/favicon_driver_qt.cpp b/src/core/favicon_driver_qt.cpp
index efc52cb0e..2539a513a 100644
--- a/src/core/favicon_driver_qt.cpp
+++ b/src/core/favicon_driver_qt.cpp
@@ -300,15 +300,15 @@ void FaviconDriverQt::DidStartNavigation(content::NavigationHandle *navigation_h
         return;
 
     m_faviconUrls.reset();
-    m_completedHandlersCount = 0;
-    m_latestFavicon = FaviconStatusQt();
 
     if (!navigation_handle->IsSameDocument()) {
+        m_completedHandlersCount = 0;
+        m_latestFavicon = FaviconStatusQt();
         m_documentOnLoadCompleted = false;
         m_manifestUrl = GURL();
-    }
 
-    m_viewClient->iconChanged(QUrl());
+        m_viewClient->iconChanged(QUrl());
+    }
 
     content::ReloadType reload_type = navigation_handle->GetReloadType();
     if (reload_type == content::ReloadType::NONE || IsOffTheRecord())
diff --git a/tests/auto/quick/qmltests/data/tst_favicon.qml b/tests/auto/quick/qmltests/data/tst_favicon.qml
index 79c835c70..ce4a2aa3c 100644
--- a/tests/auto/quick/qmltests/data/tst_favicon.qml
+++ b/tests/auto/quick/qmltests/data/tst_favicon.qml
@@ -165,6 +165,38 @@ TestWebEngineView {
             compare(iconUrl, Qt.resolvedUrl("icons/qt32.ico"))
         }
 
+        function test_faviconLoadPushState_data() {
+            return [
+                   { tag: "OTR", profile: defaultProfile },
+                   { tag: "non-OTR", profile: nonOTRProfile },
+            ];
+        }
+
+        function test_faviconLoadPushState(row) {
+            webEngineView.profile = row.profile;
+            compare(iconChangedSpy.count, 0);
+
+            var iconUrl;
+
+            webEngineView.url = Qt.resolvedUrl("favicon.html");
+            verify(webEngineView.waitForLoadSucceeded());
+            tryCompare(iconChangedSpy, "count", 1);
+            iconUrl = removeFaviconProviderPrefix(webEngineView.icon);
+            compare(iconUrl, Qt.resolvedUrl("icons/favicon.png"));
+
+            iconChangedSpy.clear();
+
+            // pushState() is a same document navigation and should not reset or
+            // update favicon.
+            compare(webEngineView.history.items.rowCount(), 1);
+            runJavaScript("history.pushState('', '')");
+            tryVerify(function() { return webEngineView.history.items.rowCount() === 2; });
+
+            // Favicon change is not expected.
+            compare(iconChangedSpy.count, 0);
+            iconUrl = removeFaviconProviderPrefix(webEngineView.icon);
+            compare(iconUrl, Qt.resolvedUrl("icons/favicon.png"));
+        }
 
         function test_noFavicon_data() {
             return [
diff --git a/tests/auto/widgets/favicon/tst_favicon.cpp b/tests/auto/widgets/favicon/tst_favicon.cpp
index d8b4803c0..6b5ae3c02 100644
--- a/tests/auto/widgets/favicon/tst_favicon.cpp
+++ b/tests/auto/widgets/favicon/tst_favicon.cpp
@@ -29,6 +29,7 @@
 #include <QtTest/QtTest>
 #include <util.h>
 
+#include <QWebEngineHistory>
 #include <QWebEnginePage>
 #include <QWebEngineProfile>
 #include <QWebEngineSettings>
@@ -49,6 +50,7 @@ private Q_SLOTS:
     void faviconLoadFromResources();
     void faviconLoadEncodedUrl();
     void faviconLoadAfterHistoryNavigation();
+    void faviconLoadPushState();
     void noFavicon();
     void aboutBlank();
     void unavailableFavicon();
@@ -222,6 +224,41 @@ void tst_Favicon::faviconLoadAfterHistoryNavigation()
     QCOMPARE(m_page->iconUrl(), QUrl("qrc:/resources/icons/qtmulti.ico"));
 }
 
+void tst_Favicon::faviconLoadPushState()
+{
+    QSignalSpy loadFinishedSpy(m_page, SIGNAL(loadFinished(bool)));
+    QSignalSpy iconUrlChangedSpy(m_page, SIGNAL(iconUrlChanged(QUrl)));
+    QSignalSpy iconChangedSpy(m_page, SIGNAL(iconChanged(QIcon)));
+
+    QUrl url("qrc:/resources/favicon-single.html");
+    m_page->load(url);
+
+    QTRY_COMPARE_WITH_TIMEOUT(loadFinishedSpy.count(), 1, 30000);
+    QTRY_COMPARE(iconUrlChangedSpy.count(), 1);
+    QTRY_COMPARE(iconChangedSpy.count(), 1);
+
+    QUrl iconUrl = iconUrlChangedSpy.at(0).at(0).toString();
+    QCOMPARE(iconUrl, m_page->iconUrl());
+    QCOMPARE(iconUrl, QUrl("qrc:/resources/icons/qt32.ico"));
+
+    const QIcon &icon = m_page->icon();
+    QVERIFY(!icon.isNull());
+
+    iconUrlChangedSpy.clear();
+    iconChangedSpy.clear();
+
+    // pushState() is a same document navigation and should not reset or
+    // update favicon.
+    QCOMPARE(m_page->history()->count(), 1);
+    evaluateJavaScriptSync(m_page, "history.pushState('', '')");
+    QTRY_COMPARE(m_page->history()->count(), 2);
+
+    // Favicon change is not expected.
+    QCOMPARE(iconUrlChangedSpy.count(), 0);
+    QCOMPARE(iconChangedSpy.count(), 0);
+    QCOMPARE(m_page->iconUrl(), QUrl("qrc:/resources/icons/qt32.ico"));
+}
+
 void tst_Favicon::noFavicon()
 {
     if (!QDir(QDir(QT_TESTCASE_SOURCEDIR).canonicalPath()).exists())