Add UMA for popup overlays removed from saved MHTML page

third_party/WebKit/Source/web/WebFrameSerializer.cpp

 /*
  * Copyright (C) 2009 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 87 matching lines @@
  private:
   bool ShouldIgnoreHiddenElement(const Element&);
   bool ShouldIgnoreMetaElement(const Element&);
   bool ShouldIgnorePopupOverlayElement(const Element&);
   void GetCustomAttributesForImageElement(const HTMLImageElement&,
                                           Vector<Attribute>*);
   void GetCustomAttributesForFormControlElement(const Element&,
                                                 Vector<Attribute>*);
 
   WebFrameSerializer::MHTMLPartsGenerationDelegate& web_delegate_;
+  bool has_popup_overlays_skipped_;
 };
 
 MHTMLFrameSerializerDelegate::MHTMLFrameSerializerDelegate(
     WebFrameSerializer::MHTMLPartsGenerationDelegate& web_delegate)
-    : web_delegate_(web_delegate) {}
+    : web_delegate_(web_delegate), has_popup_overlays_skipped_(false) {}
 
 bool MHTMLFrameSerializerDelegate::ShouldIgnoreElement(const Element& element) {
   if (ShouldIgnoreHiddenElement(element))
     return true;
   if (ShouldIgnoreMetaElement(element))
     return true;
   if (web_delegate_.RemovePopupOverlay() &&
       ShouldIgnorePopupOverlayElement(element)) {
     return true;
   }
@@ skipping 40 matching lines @@
   LocalDOMWindow* window = element.GetDocument().domWindow();
   DCHECK(window);
   LayoutPoint center_point(window->innerWidth() / 2, window->innerHeight() / 2);
   if (!box->FrameRect().Contains(center_point))
     return false;
 
   // The z-index should be greater than the threshold.
   if (box->Style()->ZIndex() < kPopupOverlayZIndexThreshold)
     return false;
 
+  if (!has_popup_overlays_skipped_) {
+    has_popup_overlays_skipped_ = true;
+    UMA_HISTOGRAM_BOOLEAN(
+        "PageSerialization.MhtmlGeneration.PopupOverlaySkippedCount", true);

[Steven Holte, 2017/04/27 23:41:53]

Actually the name of this histogram and how you are recording it are a bit
strange.  Count in the name implies that this histogram would be recording the
number of times this was skipped, but you are instead recording that it was
skipped.

I'd suggest changing the name to
PageSerialization.MhtmlGeneration.PopupOverlaySkipped and probably recording a
False case for a reasonable baseline.

[jianli, 2017/04/28 00:52:07]

Done.

+  }
+
   return true;
 }
 
 bool MHTMLFrameSerializerDelegate::ShouldIgnoreAttribute(
     const Element& element,
     const Attribute& attribute) {
   // TODO(fgorski): Presence of srcset attribute causes MHTML to not display
   // images, as only the value of src is pulled into the archive. Discarding
   // srcset prevents the problem. Long term we should make sure to MHTML plays
   // nicely with srcset.
@@ skipping 277 matching lines @@
     const WebString& base_target) {
   // TODO(yosin) We should call |FrameSerializer::baseTagDeclarationOf()|.
   if (base_target.IsEmpty())
     return String("<base href=\".\">");
   String base_string = "<base href=\".\" target=\"" +
                        static_cast<const String&>(base_target) + "\">";
   return base_string;
 }
 
 }  // namespace blink