Migrate cookie-test.js's httpRedirectCookieTest to test_driver.delete_all_cookies

arichiv · pull[bot] · commit 12993513928f · 2023-11-18T11:36:54.000Z
Now that we have a JS function within testdriver to delete all cookies we should use it instead of the one-off helpers. Bug: 1233305 Change-Id: Ib0ee77a51a3b1bea9d48549a309fdba8116461bb Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3116120 Reviewed-by: Steven Bingler <bingler@chromium.org> Auto-Submit: Ari Chivukula <arichiv@chromium.org> Commit-Queue: Ari Chivukula <arichiv@chromium.org> Cr-Commit-Position: refs/heads/main@{#951023}
diff --git a/cookies/attributes/domain.sub.html b/cookies/attributes/domain.sub.html
@@ -7,7 +7,8 @@
     <meta name="timeout" content="long">
     <script src="/resources/testharness.js"></script>
     <script src="/resources/testharnessreport.js"></script>
-    <script src="/cookies/resources/cookie-test.js"></script>
+    <script src="/resources/testdriver.js"></script>
+    <script src="/resources/testdriver-vendor.js"></script>
   </head>
   <body>
     <script>
diff --git a/cookies/attributes/path-redirect.html b/cookies/attributes/path-redirect.html
@@ -7,6 +7,8 @@
     <meta name="timeout" content="long">
     <script src="/resources/testharness.js"></script>
     <script src="/resources/testharnessreport.js"></script>
+    <script src="/resources/testdriver.js"></script>
+    <script src="/resources/testdriver-vendor.js"></script>
     <script src="/cookies/resources/cookie-test.js"></script>
   </head>
   <body>
diff --git a/cookies/attributes/resources/domain-child.sub.html b/cookies/attributes/resources/domain-child.sub.html
@@ -6,6 +6,8 @@
     <meta name=help href="https://tools.ietf.org/html/rfc6265#section-5.2.3">
     <meta name="timeout" content="long">
     <script src="/resources/testharness.js"></script>
+    <script src="/resources/testdriver.js"></script>
+    <script src="/resources/testdriver-vendor.js"></script>
     <script src="/cookies/resources/cookie-test.js"></script>
   </head>
   <body>
diff --git a/cookies/attributes/resources/path-redirect-shared.js b/cookies/attributes/resources/path-redirect-shared.js
@@ -1,22 +1,15 @@
-function expireCookie(cookie) {
-  const cookies = Array.isArray(cookie) ? cookie : [cookie];
-  for (let c of cookies) {
-    document.cookie = c += "; max-age=0";
-  }
-}
-
-function getCookies() {
-  return document.cookie;
-}
-
+// Note: this function has a dependency on testdriver.js. Any test files calling
+// it should include testdriver.js and testdriver-vendor.js
 window.addEventListener("message", (e) => {
-  if (e.data == "getCookies") {
-    const cookies = getCookies();
-    e.source.postMessage({"cookies": cookies}, '*');
+  let test_window = window.top;
+  while (test_window.opener && !test_window.opener.closed) {
+    test_window = test_window.opener.top;
   }
-
-  if (typeof e.data == "object" && 'expireCookie' in e.data) {
-    expireCookie(e.data.expireCookie);
-    e.source.postMessage("expired", '*');
+  test_driver.set_test_context(test_window);
+  if (e.data == "getAndExpireCookiesForRedirectTest") {
+    const cookies = document.cookie;
+    test_driver.delete_all_cookies().then(() => {
+      e.source.postMessage({"cookies": cookies}, '*');
+    });
   }
 });
diff --git a/cookies/attributes/resources/path.html b/cookies/attributes/resources/path.html
@@ -6,6 +6,8 @@
   <meta name=help href="http://tools.ietf.org/html/rfc6265#section-5.1.4">
 </head>
 <body>
+  <script src="/resources/testdriver.js"></script>
+  <script src="/resources/testdriver-vendor.js"></script>
   <script src="/cookies/attributes/resources/path-redirect-shared.js"></script>
 </body>
 </html>
diff --git a/cookies/attributes/resources/path/one.html b/cookies/attributes/resources/path/one.html
@@ -6,6 +6,8 @@
   <meta name=help href="http://tools.ietf.org/html/rfc6265#section-5.1.4">
 </head>
 <body>
+  <script src="/resources/testdriver.js"></script>
+  <script src="/resources/testdriver-vendor.js"></script>
   <script src="/cookies/attributes/resources/path-redirect-shared.js"></script>
 </body>
 </html>
diff --git a/cookies/attributes/resources/path/three.html b/cookies/attributes/resources/path/three.html
@@ -6,6 +6,8 @@
   <meta name=help href="http://tools.ietf.org/html/rfc6265#section-5.1.4">
 </head>
 <body>
+  <script src="/resources/testdriver.js"></script>
+  <script src="/resources/testdriver-vendor.js"></script>
   <script src="/cookies/attributes/resources/path-redirect-shared.js"></script>
 </body>
 </html>
diff --git a/cookies/attributes/resources/path/two.html b/cookies/attributes/resources/path/two.html
@@ -6,6 +6,8 @@
   <meta name=help href="http://tools.ietf.org/html/rfc6265#section-5.1.4">
 </head>
 <body>
+  <script src="/resources/testdriver.js"></script>
+  <script src="/resources/testdriver-vendor.js"></script>
   <script src="/cookies/attributes/resources/path-redirect-shared.js"></script>
 </body>
 </html>
diff --git a/cookies/attributes/resources/pathfakeout.html b/cookies/attributes/resources/pathfakeout.html
@@ -6,6 +6,8 @@
   <meta name=help href="http://tools.ietf.org/html/rfc6265#section-5.1.4">
 </head>
 <body>
+  <script src="/resources/testdriver.js"></script>
+  <script src="/resources/testdriver-vendor.js"></script>
   <script src="/cookies/attributes/resources/path-redirect-shared.js"></script>
 </body>
 </html>
diff --git a/cookies/attributes/resources/pathfakeout/one.html b/cookies/attributes/resources/pathfakeout/one.html
@@ -6,6 +6,8 @@
   <meta name=help href="http://tools.ietf.org/html/rfc6265#section-5.1.4">
 </head>
 <body>
+  <script src="/resources/testdriver.js"></script>
+  <script src="/resources/testdriver-vendor.js"></script>
   <script src="/cookies/attributes/resources/path-redirect-shared.js"></script>
 </body>
 </html>
diff --git a/cookies/ordering/ordering.sub.html b/cookies/ordering/ordering.sub.html
@@ -7,7 +7,8 @@
     <meta name="timeout" content="long">
     <script src="/resources/testharness.js"></script>
     <script src="/resources/testharnessreport.js"></script>
-    <script src="/cookies/resources/cookie-test.js"></script>
+    <script src="/resources/testdriver.js"></script>
+    <script src="/resources/testdriver-vendor.js"></script>
   </head>
   </head>
   <body>
diff --git a/cookies/ordering/resources/ordering-child.sub.html b/cookies/ordering/resources/ordering-child.sub.html
@@ -6,6 +6,8 @@
     <meta name=help href="https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-07#section-5.5">
     <meta name="timeout" content="long">
     <script src="/resources/testharness.js"></script>
+    <script src="/resources/testdriver.js"></script>
+    <script src="/resources/testdriver-vendor.js"></script>
     <script src="/cookies/resources/cookie-test.js"></script>
   </head>
   <body>
diff --git a/cookies/resources/cookie-test.js b/cookies/resources/cookie-test.js
@@ -21,37 +21,25 @@ async function getAndExpireCookiesForDefaultPathTest() {
   });
 }
 
-// getRedirectedCookies is a helper method to get and delete cookies that
-// were set from a Location header redirect.
-async function getRedirectedCookies(location, cookie) {
+// getAndExpireCookiesForRedirectTest is a helper method to get and delete
+// cookies that were set from a Location header redirect.
+async function getAndExpireCookiesForRedirectTest(location) {
   return new Promise((resolve, reject) => {
     try {
       const iframe = document.createElement('iframe');
       iframe.style = 'display: none';
       iframe.src = location;
-
+      const listener = (e) => {
+        if (typeof e.data == 'object' && 'cookies' in e.data) {
+          window.removeEventListener('message', listener);
+          document.documentElement.removeChild(iframe);
+          resolve(e.data.cookies);
+        }
+      };
+      window.addEventListener('message', listener);
       iframe.addEventListener('load', (e) => {
-        const win = e.target.contentWindow;
-        let iframeCookie;
-        // go ask for the cookie
-        win.postMessage('getCookies', '*');
-
-        // once we get it, send a message to delete on the other
-        // side, then resolve the cookie back to httpRedirectCookieTest
-        window.addEventListener('message', (e) => {
-          if (typeof e.data == 'object' && 'cookies' in e.data) {
-            iframeCookie = e.data.cookies;
-            e.source.postMessage({'expireCookie': cookie}, '*');
-          }
-
-          // wait on the iframe to tell us it deleted the cookies before
-          // resolving, to avoid any state race conditions.
-          if (e.data == 'expired') {
-            resolve(iframeCookie);
-          }
-        });
+        e.target.contentWindow.postMessage('getAndExpireCookiesForRedirectTest', '*');
       }, {once: true});
-
       document.documentElement.appendChild(iframe);
     } catch (e) {
       reject(e);
@@ -96,21 +84,26 @@ function httpCookieTest(cookie, expectedValue, name, defaultPath = true) {
 // This is a variation on httpCookieTest, where a redirect happens via
 // the Location header and we check to see if cookies are sent via
 // getRedirectedCookies
+//
+// Note: the locations targeted by this function have a dependency on
+// path-redirect-shared.js and should be sure to include it.
 function httpRedirectCookieTest(cookie, expectedValue, name, location) {
   return promise_test(async (t) => {
+    // The result is ignored as we're expiring cookies for cleaning here.
+    await getAndExpireCookiesForRedirectTest(location);
+
     const encodedCookie = encodeURIComponent(JSON.stringify(cookie));
     const encodedLocation = encodeURIComponent(location);
     const setParams = `?set=${encodedCookie}&location=${encodedLocation}`;
     await fetch(`/cookies/resources/cookie.py${setParams}`);
     // for the tests where a redirect happens, we need to head
     // to that URI to get the cookies (and then delete them there)
-    const cookies = await getRedirectedCookies(location, cookie);
+    const cookies = await getAndExpireCookiesForRedirectTest(location);
     if (Boolean(expectedValue)) {
       assert_equals(cookies, expectedValue, 'The cookie was set as expected.');
     } else {
       assert_equals(cookies, expectedValue, 'The cookie was rejected.');
     }
-    await fetch(`/cookies/resources/cookie.py?drop=${encodedCookie}`);
   }, name);
 }
 
