Add FilterOptions to performance.getEntries() behind a flag

This CL adds a new GetEntries(FilterOptions options) API. The FilterOptions consists of name, entryType and includeChildFrames on which performance entries can be filtered. The CL also removes the optional argument includeFrames from GetEntries, GetEntriesByName and GetEntriesByType. Change-Id: Ib4dcdba95268d873b86ce1dbd3a30ef29d09f5e0 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4188992 Reviewed-by: Yoav Weiss <[email protected]> Commit-Queue: Hao Liu <[email protected]> Reviewed-by: Ian Clelland <[email protected]> Cr-Commit-Position: refs/heads/main@{#1099995}
web-platform-tests · Feb 1, 2023 · 531d5a4 · 531d5a4
1 parent 6e081c8
commit 531d5a4
Show file tree

Hide file tree

Showing 10 changed files with 110 additions and 28 deletions.
diff --git a/performance-timeline/resources/include-frames-subframe.html b/performance-timeline/resources/include-frames-subframe.html
@@ -29,7 +29,7 @@
         const childFrame = document.createElement('iframe');
 
         childFrame.addEventListener('load', async () => {
-          const entries = performance.getEntries(true);
+          const entries = performance.getEntries({ includeChildFrames: true });
 
           // Report number of performance entries to the parent.
           window.parent.postMessage(entries.length, "*");

diff --git a/performance-timeline/tentative/detached-frame.html b/performance-timeline/tentative/detached-frame.html
@@ -21,8 +21,7 @@
   // Detach the child frame
   document.body.removeChild(childFrame);
 
-  const entries = childWindow.performance.getEntries(true);
-  const parent_entries = performance.getEntries(true);
+  const entries = childWindow.performance.getEntries({ includeChildFrames: true });
+  const parent_entries = performance.getEntries({ includeChildFrames: true });
 }, "GetEntries of a detached parent frame does not crash");
 </script>
-
diff --git a/performance-timeline/tentative/include-frames-originA-A-A.html b/performance-timeline/tentative/include-frames-originA-A-A.html
@@ -32,12 +32,12 @@
       // Verify the number of performance entries in the child frame.
       assert_equals(childFrameEntrySize, 6, 'Child Frame should have 6 entries.');
 
-      const entries = performance.getEntries(true);
+      const entries = performance.getEntries({ includeChildFrames: true });
 
-      const navigationEntries = performance.getEntriesByType('navigation', true);
-
-      const markedEntries = performance.getEntriesByName('entry-name', undefined, true);
+      const navigationEntries = performance.getEntries({ entryType: "navigation", includeChildFrames: true });
 
+      const markedEntries = performance.getEntries(
+        { name: 'entry-name', includeChildFrames: true });
 
       // 3 entries for parent, 4 for child, 2 for grandchild.
       assert_equals(entries.length, 9, 'Total entries should be 9.');
@@ -48,6 +48,31 @@
       // 1 entry for child, 1 for grandchild.
       assert_equals(markedEntries.length, 2, 'Mark entries should be 2.');
 
+      // Test cases where includeChildFrames is false.
+      const entriesWithNoFitlerOptions = performance.getEntries();
+
+      const entriesWithoutIncludingChildFrames = performance.getEntries({ includeChildFrames: false });
+
+      const navigationEntriesWithoutIncludingChildFrames = performance.getEntries({ entryType: "navigation", includeChildFrames: false });
+
+      const markedEntriesWithoutIncludingChildFrames = performance.getEntries(
+        { name: 'entry-name', includeChildFrames: false });
+
+      // 3 entries for parent.
+      assert_equals(entriesWithNoFitlerOptions.length, 3,
+        'Total entries without filter options should be 3 without filter options.');
+
+      assert_equals(entriesWithoutIncludingChildFrames.length, 3,
+        'Total entries with includeChildFrame being false should be 3.');
+
+      // 1 entry for parent.
+      assert_equals(navigationEntriesWithoutIncludingChildFrames.length, 1,
+        'Navigation entries with includeChildFrame being false should be 1.');
+
+      // 0 entry for child.
+      assert_equals(markedEntriesWithoutIncludingChildFrames.length, 0,
+        'Mark entries with includeChildFrame being false should be 0.');
+
     }, 'GetEntries of a document of origin A, its child frame of origin B and \
     its grandchild frame of origin A.');
   </script>

diff --git a/performance-timeline/tentative/include-frames-originA-A.html b/performance-timeline/tentative/include-frames-originA-A.html
@@ -28,11 +28,12 @@
     // Load a child frame.
     await loadSameOriginChildFrame();
 
-    const entries = performance.getEntries(true);
+    const entries = performance.getEntries({ includeChildFrames: true });
 
-    const navigationEntries = performance.getEntriesByType('navigation', true);
+    const navigationEntries = performance.getEntries({ entryType: "navigation", includeChildFrames: true });
 
-    const markedEntries = performance.getEntriesByName('entry-name', undefined, true);
+    const markedEntries = performance.getEntries(
+      { name: 'entry-name', includeChildFrames: true });
 
     // 3 entries for parent, 2 for child.
     assert_equals(entries.length, 5, 'Total entries should be 5.');
@@ -42,6 +43,32 @@
 
     // 1 entry for child.
     assert_equals(markedEntries.length, 1, 'Mark entries should be 1.');
+
+    // Test cases where includeChildFrames is false.
+    const entriesWithNoFitlerOptions = performance.getEntries();
+
+    const entriesWithoutIncludingChildFrames = performance.getEntries({ includeChildFrames: false });
+
+    const navigationEntriesWithoutIncludingChildFrames = performance.getEntries({ entryType: "navigation", includeChildFrames: false });
+
+    const markedEntriesWithoutIncludingChildFrames = performance.getEntries(
+      { name: 'entry-name', includeChildFrames: false });
+
+    // 3 entries for parent.
+    assert_equals(entriesWithNoFitlerOptions.length, 3,
+      'Total entries without filter options should be 3 without filter options.');
+
+    assert_equals(entriesWithoutIncludingChildFrames.length, 3,
+      'Total entries with includeChildFrame being false should be 3.');
+
+    // 1 entry for parent.
+    assert_equals(navigationEntriesWithoutIncludingChildFrames.length, 1,
+      'Navigation entries with includeChildFrame being false should be 1.');
+
+    // 0 entry for child.
+    assert_equals(markedEntriesWithoutIncludingChildFrames.length, 0,
+      'Mark entries with includeChildFrame being false should be 0.');
+
   }, 'GetEntries of a document of origin A and its child frame of origin A.');
 </script>
 </body>
diff --git a/performance-timeline/tentative/include-frames-originA-AA.html b/performance-timeline/tentative/include-frames-originA-AA.html
@@ -9,11 +9,12 @@
 <body>
 <script>
   const verifyPerformanceEntries = () => {
-    const entries = performance.getEntries(true);
+    const entries = performance.getEntries({ includeChildFrames: true });
 
-    const navigationEntries = performance.getEntriesByType( 'navigation', true);
+    const navigationEntries = performance.getEntries({ entryType: "navigation", includeChildFrames: true });
 
-    const markedEntries = performance.getEntriesByName('entry-name',  undefined, true );
+    const markedEntries = performance.getEntries(
+      { name: 'entry-name', includeChildFrames: true });
 
     // 4 entries for parent, 2 for each child
     assert_equals(entries.length, 8,'Total entries should be 8.');

diff --git a/performance-timeline/tentative/include-frames-originA-AB.html b/performance-timeline/tentative/include-frames-originA-AB.html
@@ -23,11 +23,12 @@
     }
 
     const verifyPerformanceEntries = () => {
-      const entries = performance.getEntries(true);
+      const entries = performance.getEntries({ includeChildFrames: true });
 
-      const navigationEntries = performance.getEntriesByType('navigation', true);
+      const navigationEntries = performance.getEntries({ entryType: "navigation", includeChildFrames: true });
 
-      const markedEntries = performance.getEntriesByName('entry-name', undefined, true);
+      const markedEntries = performance.getEntries(
+        { name: 'entry-name', includeChildFrames: true });
 
       // 4 entries for parent, 2 for local child, 0 for remote child.
       assert_equals(entries.length, 6, 'Total entries should 6.');

diff --git a/performance-timeline/tentative/include-frames-originA-B-A.html b/performance-timeline/tentative/include-frames-originA-B-A.html
@@ -36,12 +36,12 @@
       // Verify the number of performance entries in the child frame.
       assert_equals(childFrameEntrySize, 4, 'Child frame entries should be 4.');
 
-      const entries = performance.getEntries(true);
+      const entries = performance.getEntries({ includeChildFrames: true });
 
-      const navigationEntries = performance.getEntriesByType(
-        'navigation', true);
+      const navigationEntries = performance.getEntries({ entryType: "navigation", includeChildFrames: true });
 
-      const markedEntries = performance.getEntriesByName('entry-name', undefined, true);
+      const markedEntries = performance.getEntries(
+        { name: 'entry-name', includeChildFrames: true });
 
       // 3 entries for parent, 0 for child, 2 for grandchild.
       assert_equals(entries.length, 5, 'Total entries should be 5.');
@@ -51,6 +51,32 @@
 
       // 1 entry for grandchild.
       assert_equals(markedEntries.length, 1, 'Mark entries should be 1.');
+
+      // Test cases where includeChildFrames is false.
+      const entriesWithNoFitlerOptions = performance.getEntries();
+
+      const entriesWithoutIncludingChildFrames = performance.getEntries({ includeChildFrames: false });
+
+      const navigationEntriesWithoutIncludingChildFrames = performance.getEntries({ entryType: "navigation", includeChildFrames: false });
+
+      const markedEntriesWithoutIncludingChildFrames = performance.getEntries(
+        { name: 'entry-name', includeChildFrames: false });
+
+      // 3 entries for parent.
+      assert_equals(entriesWithNoFitlerOptions.length, 3,
+        'Total entries without filter options should be 3 without filter options.');
+
+      assert_equals(entriesWithoutIncludingChildFrames.length, 3,
+        'Total entries with includeChildFrame being false should be 3.');
+
+      // 1 entry for parent.
+      assert_equals(navigationEntriesWithoutIncludingChildFrames.length, 1,
+        'Navigation entries with includeChildFrame being false should be 1.');
+
+      // 1 entry for child.
+      assert_equals(markedEntriesWithoutIncludingChildFrames.length, 0,
+        'Mark entries with includeChildFrame being false should be 0.');
+
     }, 'GetEntries of a document of origin A, its child frame of origin B and \
     its grandchild frame of origin A.');
   </script>

diff --git a/performance-timeline/tentative/include-frames-originA-B-B.html b/performance-timeline/tentative/include-frames-originA-B-B.html
@@ -35,7 +35,7 @@
       // 4 for child, 2 for grandchild.
       assert_equals(childFrameEntrySize, 6, 'Child frame entries should be 6.');
 
-      const entries = performance.getEntries(true);
+      const entries = performance.getEntries({ includeChildFrames: true });
 
       // 3 entries for parent, 0 for child, 0 for grandchild.
       assert_equals(entries.length, 3, 'Total entries should be 3.');

diff --git a/performance-timeline/tentative/include-frames-originA-B.html b/performance-timeline/tentative/include-frames-originA-B.html
@@ -28,11 +28,12 @@
 
       await loadCrossOriginChildFrame();
 
-      const entries = performance.getEntries(true);
+      const entries = performance.getEntries({ includeChildFrames: true });
 
-      const navigationEntries = performance.getEntriesByType("navigation", true);
+      const navigationEntries = performance.getEntries({ entryType: "navigation", includeChildFrames: true });
 
-      const markedEntries = performance.getEntriesByName('entry-name', undefined, true);
+      const markedEntries = performance.getEntries(
+        { name: 'entry-name', includeChildFrames: true });
 
       // 3 entries for parent, 0 for child.
       assert_equals(entries.length, 3, 'Total entries should be 3.');

diff --git a/performance-timeline/tentative/performance-entry-source.html b/performance-timeline/tentative/performance-entry-source.html
@@ -8,7 +8,7 @@
 <script>
 promise_test(() => {
     return new Promise(resolve => {
-        const navigationEntries = performance.getEntriesByType("navigation")
+      const navigationEntries = performance.getEntries({ type: 'navigation' })
         const parentEntry = navigationEntries[0]
 
         // Parent NavigationTiming source is current window.
@@ -20,7 +20,9 @@
         document.body.appendChild(childFrame)
 
         childFrame.addEventListener('load', () => {
-            const markedEntries = performance.getEntriesByName("entry-name", undefined, true)
+          const markedEntries = performance.getEntries(
+            { name: 'entry-name', includeChildFrames: true });
+
             const childEntry = markedEntries[0]
 
             // Child PerformanceMark source is the child's Window.
@@ -30,4 +32,4 @@
         })
     })
 }, "PerformanceEntry source is equal to its respective Window")
-</script>
+</script>