Bug 1683335 - Add logging of the history tree to CanonicalBrowsingContext::SessionHistoryCommit. r=smaug

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

docshell/base/CanonicalBrowsingContext.cpp

@@ -579,6 +579,8 @@ void CanonicalBrowsingContext::SessionHistoryCommit(uint64_t aLoadId,
 
       HistoryCommitIndexAndLength(aChangeID, caller);
 
+      shistory->LogHistory();
+
       return;
     }
     // XXX Should the loading entries before [i] be removed?
@@ -697,6 +699,8 @@ void CanonicalBrowsingContext::SetActiveSessionHistoryEntry(
 
   // FIXME Need to do the equivalent of EvictContentViewersOrReplaceEntry.
   HistoryCommitIndexAndLength(aChangeID, caller);
+
+  static_cast<nsSHistory*>(shistory)->LogHistory();
 }
 
 void CanonicalBrowsingContext::ReplaceActiveSessionHistoryEntry(

docshell/shistory/nsSHEntry.h

@@ -31,12 +31,12 @@ class nsSHEntry : public nsISHEntry {
   static nsresult Startup();
   static void Shutdown();
 
+  nsSHEntryShared* GetState() { return mShared; }
+
  protected:
   explicit nsSHEntry(const nsSHEntry& aOther);
   virtual ~nsSHEntry();
 
-  nsSHEntryShared* GetState() { return mShared; }
-
   // We share the state in here with other SHEntries which correspond to the
   // same document.
   RefPtr<nsSHEntryShared> mShared;

docshell/shistory/nsSHistory.cpp

@@ -67,6 +67,8 @@ int32_t nsSHistory::sHistoryMaxTotalViewers = -1;
 // entries were touched, so that we can evict older entries first.
 static uint32_t gTouchCounter = 0;
 
+extern mozilla::LazyLogModule gSHLog;
+
 LazyLogModule gSHistoryLog("nsSHistory");
 
 #define LOG(format) MOZ_LOG(gSHistoryLog, mozilla::LogLevel::Debug, format)
@@ -902,33 +904,69 @@ nsSHistory::GetIndexOfEntry(nsISHEntry* aSHEntry) {
   return -1;
 }
 
-#ifdef DEBUG
-nsresult nsSHistory::PrintHistory() {
-  for (int32_t i = 0; i < Length(); i++) {
-    nsCOMPtr<nsISHEntry> entry = mEntries[i];
-    nsCOMPtr<nsILayoutHistoryState> layoutHistoryState =
-        entry->GetLayoutHistoryState();
-    nsCOMPtr<nsIURI> uri = entry->GetURI();
-    nsString title;
-    entry->GetTitle(title);
-
-#  if 0
-    nsAutoCString url;
-    if (uri) {
-      uri->GetSpec(url);
-    }
-
-    printf("**** SH Entry #%d: %x\n", i, entry.get());
-    printf("\t\t URL = %s\n", url.get());
-
-    printf("\t\t Title = %s\n", NS_LossyConvertUTF16toASCII(title).get());
-    printf("\t\t layout History Data = %x\n", layoutHistoryState.get());
-#  endif
+static void LogEntry(nsISHEntry* aEntry, int32_t aIndex, int32_t aTotal,
+                     const nsCString& aPrefix, bool aIsCurrent) {
+  if (!aEntry) {
+    MOZ_LOG(gSHLog, LogLevel::Debug,
+            (" %s+- %i SH Entry null\n", aPrefix.get(), aIndex));
+    return;
   }
 
-  return NS_OK;
+  nsCOMPtr<nsIURI> uri = aEntry->GetURI();
+  nsAutoString title;
+  aEntry->GetTitle(title);
+
+  SHEntrySharedParentState* shared;
+  if (mozilla::SessionHistoryInParent()) {
+    shared = static_cast<SessionHistoryEntry*>(aEntry)->SharedInfo();
+  } else {
+    shared = static_cast<nsSHEntry*>(aEntry)->GetState();
+  }
+
+  nsID docShellId;
+  aEntry->GetDocshellID(docShellId);
+
+  int32_t childCount = aEntry->GetChildCount();
+
+  MOZ_LOG(gSHLog, LogLevel::Debug,
+          ("%s%s+- %i SH Entry %p %" PRIu64 " %s\n", aIsCurrent ? ">" : " ",
+           aPrefix.get(), aIndex, aEntry, shared->GetId(),
+           nsIDToCString(docShellId).get()));
+
+  nsCString prefix(aPrefix);
+  if (aIndex < aTotal - 1) {
+    prefix.AppendLiteral("|   ");
+  } else {
+    prefix.AppendLiteral("    ");
+  }
+
+  MOZ_LOG(gSHLog, LogLevel::Debug,
+          (" %s%s  URL = %s\n", prefix.get(), childCount > 0 ? "|" : " ",
+           uri->GetSpecOrDefault().get()));
+  MOZ_LOG(gSHLog, LogLevel::Debug,
+          (" %s%s  Title = %s\n", prefix.get(), childCount > 0 ? "|" : " ",
+           NS_LossyConvertUTF16toASCII(title).get()));
+
+  nsCOMPtr<nsISHEntry> prevChild;
+  for (int32_t i = 0; i < childCount; ++i) {
+    nsCOMPtr<nsISHEntry> child;
+    aEntry->GetChildAt(i, getter_AddRefs(child));
+    LogEntry(child, i, childCount, prefix, false);
+    child.swap(prevChild);
+  }
+}
+
+void nsSHistory::LogHistory() {
+  if (!MOZ_LOG_TEST(gSHLog, LogLevel::Debug)) {
+    return;
+  }
+
+  MOZ_LOG(gSHLog, LogLevel::Debug, ("nsSHistory %p\n", this));
+  int32_t length = Length();
+  for (int32_t i = 0; i < length; i++) {
+    LogEntry(mEntries[i], i, length, EmptyCString(), i == mIndex);
+  }
 }
-#endif
 
 void nsSHistory::WindowIndices(int32_t aIndex, int32_t* aOutStartIndex,
                                int32_t* aOutEndIndex) {

docshell/shistory/nsSHistory.h

@@ -200,6 +200,8 @@ class nsSHistory : public mozilla::LinkedListElement<nsSHistory>,
     mEpochParentId = aId;
   }
 
+  void LogHistory();
+
  protected:
   virtual ~nsSHistory();
 
@@ -221,10 +223,6 @@ class nsSHistory : public mozilla::LinkedListElement<nsSHistory>,
                      nsTArray<LoadEntryResult>& aLoadResults,
                      bool aSameEpoch = false);
 
-#ifdef DEBUG
-  nsresult PrintHistory();
-#endif
-
   // Find the history entry for a given bfcache entry. It only looks up between
   // the range where alive viewers may exist (i.e nsSHistory::VIEWER_WINDOW).
   nsresult FindEntryForBFCache(nsIBFCacheEntry* aBFEntry, nsISHEntry** aResult,