Declarative Web Request: firstPartyForCookiesUrl

chrome/test/data/extensions/api_test/webrequest/test_declarative.js

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 var onRequest = chrome.declarativeWebRequest.onRequest;
 var AddResponseHeader =
     chrome.declarativeWebRequest.AddResponseHeader;
 var RequestMatcher = chrome.declarativeWebRequest.RequestMatcher;
 var CancelRequest = chrome.declarativeWebRequest.CancelRequest;
 var RedirectByRegEx = chrome.declarativeWebRequest.RedirectByRegEx;
@@ skipping 259 matching lines @@
         },
         {'priority': 1,
          'conditions': [new RequestMatcher({})],
          'actions': [new chrome.declarativeWebRequest.CancelRequest()]
         },
       ],
       function() {navigateAndWait(getURLThirdParty());}
     );
   },
 
+  // Tests "firstPartyForCookiesUrl" by using it to override a cancelling rule.
+  function testFirstPartyForCookiesUrl() {
+    ignoreUnexpected = false;
+    expect(

[Jeffrey Yasskin, 2012/12/18 03:09:58]

Where is expect() defined? What do its parameters mean?

Which parts of this assertion were affected by the rule, and which weren't? I
don't feel like I can read the test as it currently stands and become confident
that the rules are matching as you expect. It might work better to run the test
twice, once with the firstPartyForCookiesUrl and once without, and show the
difference in behavior by modifying the "expected events" list.

[vabr (Chromium), 2013/01/21 10:57:48]

The function expect is part of the test framework:
https://cs.corp.google.com/#chrome/src/chrome/test/data/extensions/api_test/w...
I did not want to run the test twice, the tests take too long already. But I did
my best with adding comments about the important places in the event list.

+      [
+        { label: "onBeforeRequest",
+          event: "onBeforeRequest",
+          details: {
+            url: getURLThirdParty(),
+            frameUrl: getURLThirdParty()
+          }
+        },
+        { label: "onBeforeSendHeaders",

[Jeffrey Yasskin, 2012/12/18 03:09:58]

If the label is the same as the event in almost all cases, that's a sign that
expect() isn't defined quite right. Perhaps make label optional, use the event
as the default, and then show both the event and label when 'label' is present.

[vabr (Chromium), 2013/01/21 10:57:48]

I can understand your concerns, but I believe those are beyond this CL. I did
not introduce "expect", and I'm using it in a way similar to the rest of the
existing test.

Please file a crbug ticket if you want the implementation of expect improved.

On 2012/12/18 03:09:58, Jeffrey Yasskin wrote:

+          event: "onBeforeSendHeaders",
+          details: {url: getURLThirdParty()}
+        },
+        { label: "onSendHeaders",
+          event: "onSendHeaders",
+          details: {url: getURLThirdParty()}
+        },
+        { label: "onHeadersReceived",
+          event: "onHeadersReceived",
+          details: {
+            url: getURLThirdParty(),
+            statusLine: "HTTP/1.0 200 OK"
+          }
+        },
+        { label: "onResponseStarted",
+          event: "onResponseStarted",
+          details: {
+            url: getURLThirdParty(),
+            fromCache: false,
+            ip: "127.0.0.1",
+            statusCode: 200,
+            statusLine: "HTTP/1.0 200 OK"
+          }
+        },
+        { label: "onCompleted",
+          event: "onCompleted",
+          details: {
+            fromCache: false,
+            ip: "127.0.0.1",
+            url: getURLThirdParty(),
+            statusCode: 200,
+            statusLine: "HTTP/1.0 200 OK"
+          }
+        },
+        { label: "img-onBeforeRequest",
+          event: "onBeforeRequest",
+          details: {
+            type: "image",
+            url: "http://non_existing_third_party.com/image.png",
+            frameUrl: getURLThirdParty()
+          }
+        },
+        { label: "img-onBeforeSendHeaders",
+          event: "onBeforeSendHeaders",
+          details: {
+            type: "image",
+            url: "http://non_existing_third_party.com/image.png",
+          }
+        },
+        { label: "img-onErrorOccurred",
+          event: "onErrorOccurred",
+          details: {
+            url: "http://non_existing_third_party.com/image.png",
+            type: "image",
+            fromCache: false,
+            error: "net::ERR_BLOCKED_BY_CLIENT"
+          }
+        },
+      ],
+      [ ["onBeforeRequest", "onBeforeSendHeaders", "onSendHeaders",
+         "onHeadersReceived", "onResponseStarted", "onCompleted"],
+        ["img-onBeforeRequest", "img-onBeforeSendHeaders",
+         "img-onErrorOccurred"] ]);
+    onRequest.addRules(
+      [ // This rule cancels the request with a 3rd party URL just before it is
+        // sent. This is necessary, because sending it would generate different
+        // HTTP 4xx codes on different platforms, making it impossible to
+        // present a single list of expected events.
+        {'priority': 3,
+         'conditions': [new RequestMatcher({
+           'url': { 'hostEquals': 'non_existing_third_party.com' },
+           'stages': ["onBeforeSendHeaders"]
+         })],
+         'actions': [new chrome.declarativeWebRequest.CancelRequest()]
+        },
+        {'priority': 2,
+         'conditions': [
+           new RequestMatcher({
+             firstPartyForCookiesUrl: {
+               hostEquals: testServer
+             }
+           })
+         ],
+         'actions': [
+           new chrome.declarativeWebRequest.IgnoreRules({
+              lowerPriorityThan: 2 })
+         ]
+        },
+        // This rule cancels everyhting, and sooner that the very first rule

[Jeffrey Yasskin, 2012/12/18 03:09:58]

sp: everyhting. s/that/than/

[vabr (Chromium), 2013/01/21 10:57:48]

Done.

+        // would. The test is reduced to making sure this (3rd) rule was ignored
+        // as a consequence of the 2nd rule.
+        {'priority': 1,
+         'conditions': [new RequestMatcher({
+           'stages': ["onBeforeRequest"]
+         })],
+         'actions': [new chrome.declarativeWebRequest.CancelRequest()]
+        },
+      ],
+      function() {navigateAndWait(getURLThirdParty());}
+    );
+  },
+
   function testRedirectRequest() {
     ignoreUnexpected = true;
     expect(
       [
         { label: "onBeforeRequest-a",
           event: "onBeforeRequest",
           details: {
             type: "main_frame",
             url: getURLHttpComplex(),
             frameUrl: getURLHttpComplex()
@@ skipping 404 matching lines @@
              },
              'requestHeaders': [{ nameContains: "" }],
              'excludeRequestHeaders': [{ valueContains: ["", "value123"] }]
               })],
          'actions': [new CancelRequest()]}
       ],
       function() {navigateAndWait(getURLHttpSimple());}
     );
   },
   ]);