[ServiceWorker] Tests for Cache

LayoutTests/http/tests/serviceworker/resources/cache-match-worker.js

+importScripts('worker-test-harness.js');
+//
+// Variations:
+//   - ignoreSearch : Ignores search parameter.
+//   - prefixMatch : only matches a prefix of the URL.
+//   - ignoreVary : ignores a 'Vary' header if there is one.
+var simple_entries = {
+  a: {
+    request: new Request('http://example.com/a'),
+    response: new Response('')
+  },
+
+  b: {
+    request: new Request('http://example.com/b'),
+    response: new Response('')
+  },
+
+  a_with_query: {
+    request: new Request('http://example.com/a?q=r'),
+    response: new Response('')
+  },
+
+  A: {
+    request: new Request('http://example.com/A'),
+    response: new Response('')
+  },
+
+  a_https: {
+    request: new Request('https://example.com/a'),
+    response: new Response('')
+  },
+
+  a_org: {
+    request: new Request('http://example.org/a'),
+    response: new Response('')
+  },
+
+  cat: {
+    request: new Request('http://example.com/cat'),
+    response: new Response('')
+  },
+
+  cat_with_fragment: {
+    request: new Request('http://example.com/cat#mouse'),
+    response: new Response('')
+  },
+
+  cat_in_the_hat: {
+    request: new Request('http://example.com/cat/in/the/hat'),
+    response: new Response('')
+  }
+};
+
+var vary_entries = {
+  no_vary_header: {
+    request: new Request('http://example.com/c'),
+    response: new Response('')
+  },
+
+  vary_cookie_is_cookie: {
+    request: new Request('http://example.com/c',
+                         {headers: {'Cookies': 'is-for-cookie'}}),
+    response: new Response('',
+                           {headers: {'Vary': 'Cookies'}})
+  },
+
+  vary_cookie_is_good: {
+    request: new Request('http://example.com/c',
+                         {headers: {'Cookies': 'is-good-enough-for-me'}}),
+    response: new Response('',
+                           {headers: {'Vary': 'Cookies'}})
+  },
+
+  vary_cookie_absent: {
+    request: new Request('http://example.com/c'),
+    response: new Response('',
+                           {headers: {'Vary': 'Cookies'}})
+  },
+
+  vary_wildcard: {
+    request: new Request('http://example.com/c',
+                         {headers: {'Cookies': 'x', 'X-Key': '1'}}),
+    response: new Response('',
+                           {headers: {'Vary': '*'}})
+  }
+};
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll(simple_entries.a.request.url);
+        })
+      .then(function(result) {
+          assert_array_equals(result, [simple_entries.a.response],
+                              'Cache.matchAll should match by URL.');
+        });
+  }, 'Cache.matchAll with URL');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.match(simple_entries.a.request.url);
+        })
+      .then(function(result) {
+          assert_equals(result, simple_entries.a.response,
+                        'Cache.match should match by URL.');
+        });
+  }, 'Cache.match with URL');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll(simple_entries.a.request);
+        })
+      .then(function(result) {
+          assert_array_equals(result, [simple_entries.a.response],
+                              'Cache.matchAll should match by Request.');
+        });
+  }, 'Cache.matchAll with Request');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.match(simple_entries.a.request);
+        })
+      .then(function(result) {
+          assert_equals(result, simple_entries.a.response,
+                        'Cache.match should match by Request.');
+        });
+  }, 'Cache.match with Request');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll(new Request(simple_entries.a.request.url));
+        })
+      .then(function(result) {
+          assert_array_equals(result, [simple_entries.a.response],
+                              'Cache.matchAll should match by Request.');
+        });
+  }, 'Cache.matchAll with new Request');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.match(new Request(simple_entries.a.request.url));
+        })
+      .then(function(result) {
+          assert_equals(result, simple_entries.a.response,
+                        'Cache.match should match by Request.');
+        });
+  }, 'Cache.match with new Request');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll(simple_entries.a.request,
+                                {ignoreSearch: true});
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result,
+            [
+              simple_entries.a.response,
+              simple_entries.a_with_query.response
+            ],
+            'Cache.matchAll with ignoreSearch should ignore the ' +
+            'search parameters of cached request.');
+        });
+  },
+  'Cache.matchAll with ignoreSearch option (request with no search ' +
+  'parameters)');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll(simple_entries.a_with_query.request,
+                                {ignoreSearch: true});
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result,
+            [
+              simple_entries.a.response,
+              simple_entries.a_with_query.response
+            ],
+            'Cache.matchAll with ignoreSearch should ignore the ' +
+            'search parameters of request.');
+        });
+  },
+  'Cache.matchAll with ignoreSearch option (request with search parameter)');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll(simple_entries.cat.request);
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result,
+            [
+              simple_entries.cat.response,
+              simple_entries.cat_with_fragment.response
+            ],
+            'Cache.matchAll should ignore URL hash.');
+        });
+  }, 'Cache.matchAll with request containing hash');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll('http');
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result, [],
+            'Cache.matchAll should treat query as a URL and not ' +
+            'just a string fragment.');
+        });
+  }, 'Cache.matchAll with string fragment \'http\' as query');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll('http://example.com/cat',
+                                {prefixMatch: true});
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result,
+            [
+              simple_entries.cat.response,
+              simple_entries.cat_with_fragment.response,
+              simple_entries.cat_in_the_hat.response
+            ],
+            'Cache.matchAll should honor prefixMatch.');
+        });
+  }, 'Cache.matchAll with prefixMatch option');
+
+promise_test(function(t) {
+    return create_populated_cache(t, simple_entries)
+      .then(function(cache) {
+          return cache.matchAll('http://example.com/cat/',
+                                {prefixMatch: true});
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result, [simple_entries.cat_in_the_hat.response],
+            'Cache.matchAll should honor prefixMatch.');
+        });
+  }, 'Cache.matchAll with prefixMatch option');
+
+promise_test(function(t) {
+    var cache;
+    return create_populated_cache(t, vary_entries)
+      .then(function(populated_cache) {
+          cache = populated_cache;
+          return cache.matchAll('http://example.com/c');
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result,
+            [
+              vary_entries.no_vary_header.response,
+              vary_entries.vary_wildcard.response,
+              vary_entries.vary_cookie_absent.response
+            ],
+            'Cache.matchAll should exclude matches if a vary header is ' +
+            'missing in the query request, but is present in the cached ' +
+            'request.');
+        })
+
+      .then(function() {
+          return cache.matchAll(
+            new Request('http://example.com/c',
+                        {headers: {'Cookies': 'none-of-the-above'}}));
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result,
+            [
+              vary_entries.no_vary_header.response,
+              vary_entries.vary_wildcard.response
+            ],
+            'Cache.matchAll should exclude matches if a vary header is ' +
+            'missing in the cached request, but is present in the query ' +
+            'request.');
+        })
+
+      .then(function() {
+          return cache.matchAll(
+            new Request('http://example.com/c',
+                        {headers: {'Cookies': 'is-for-cookie'}}));
+        })
+      .then(function(result) {
+          assert_array_equals(
+            result,
+            [vary_entries.vary_cookie_is_cookie.response],
+            'Cache.matchAll should match the entire header if a vary header ' +
+            'is present in both the query and cached requests.');
+        });
+  }, 'Cache.matchAll with responses containing \'Vary\' header');
+
+promise_test(function(t) {
+    return create_populated_cache(t, vary_entries)
+      .then(function(cache) {
+          return cache.match('http://example.com/c');
+        })
+      .then(function(result) {
+          assert_in_array(
+            result,
+            [
+              vary_entries.no_vary_header.response,
+              vary_entries.vary_wildcard.response,
+              vary_entries.vary_cookie_absent.response
+            ],
+            'Cache.match should honor \'Vary\' header.');
+        });
+  }, 'Cache.match with responses containing \'Vary\' header');
+
+promise_test(function(t) {
+    return create_populated_cache(t, vary_entries)
+      .then(function(cache) {
+          return cache.matchAll('http://example.com/c',
+                                {ignoreVary: true});
+        })
+      .then(function(result) {
+          assert_array_equivalent(
+            result,
+            [
+              vary_entries.no_vary_header.response,
+              vary_entries.vary_cookie_is_cookie.response,
+              vary_entries.vary_cookie_is_good.response,
+              vary_entries.vary_cookie_absent.response,
+              vary_entries.vary_wildcard.response
+            ],
+            'Cache.matchAll should honor \'ignoreVary\' parameter.');
+        });
+  }, 'Cache.matchAll with \'ignoreVary\' parameter');
+
+// Helpers ---
+
+// Create a new Cache and populate it with requests from |entries|. The latter
+// is expected to be an Object mapping arbitrary keys to objects of the form
+// {request: <Request object>, response: <Response object>}.
+//
+// The return value is a Promise that resolves to the populated Cache. The
+// lifetime of the Cache is bound to the duration of |test|.
+function create_populated_cache(test, entries) {
+  var cache;
+  return create_temporary_cache(test)
+    .then(function(result) {
+        cache = result;
+        return Promise.all(Object.keys(entries).map(function(k) {
+            return cache.put(entries[k].request, entries[k].response);
+          }));
+      })
+    .then(function() {
+        return Promise.resolve(cache);
+      });
+}
+
+// Assert that the two arrays |actual| and |expected| contain the same set of
+// elements ignoring order. This is necessary because the result array returned
+// by Cache.matchAll() does not guarantee any specific ordering.
+//
+// |expected| is assumed to not contain any duplicates.
+function assert_array_equivalent(actual, expected, description) {
+  assert_true(Array.isArray(actual), description);
+  assert_equals(actual.length, expected.length, description);
+  expected.forEach(function(expected_element) {
+      // assert_in_array treats the first argument as being 'actual', and the
+      // second as being 'expected array'. We are switching them around becaus
+      // we want to be resilient against the |actual| array containing
+      // duplicates.
+      assert_in_array(expected_element, actual, description);
+    });
+}