fix: drop sameOrigin but move to same origin default;

- update tests & readme
- 726 gz / 592 br

Author: lukeed

README.md

@@ -80,8 +80,7 @@ The above options are best for multi-page sites. Single-page apps have a few opt
 * `timeout`: Integer for the `requestIdleCallback` timeout. A time in milliseconds by which the browser must execute prefetching. Defaults to 2 seconds.
 * `timeoutFn`: Function for specifying a timeout. Defaults to `requestIdleCallback`. Can also be swapped out for a custom function like [networkIdleCallback](https://github.com/pastelsky/network-idle-callback) (see demos)
 * `priority`: Boolean specifying preferred priority for fetches. Defaults to `false`. `true` will attempt to use the `fetch()` API where supported (rather than rel=prefetch)
-* `sameOrigin`: Restricts prefetching to URLs of the same origin. Defaults to `false`. Any truthy value will ensure no cross-domain requests are sent & will override/ignore any `options.origins` value.
-* `origins`: Static array of URL hostname strings that are allowed to be prefetched. Defaults to an empty array, which _allows all_ URLs to be prefetched.
+* `origins`: Static array of URL hostname strings that are allowed to be prefetched. Defaults to the same domain origin, which prevents _any_ cross-origin requests.
 
 TODO:
 * Explore detecting file-extension of resources and using [rel=preload](https://w3c.github.io/preload/) for high priority fetches
@@ -141,17 +140,9 @@ Defaults to low-priority (`rel=prefetch` or XHR). For high-priority (`priority:
 quicklink({ priority: true });
 ```
 
-**Allow same-origin requests only**
-
-Forcibly disables all cross-domain requests. All domains are allowed by default.
-
-```js
-quicklink({ sameOrigin: true });
-```
-
 **Specify a custom list of allowed origins**
 
-Provide a list of hostnames that should be prefetch-able. All domains are allowed by default.
+Provide a list of hostnames that should be prefetch-able. Only the same origin is allowed by default.
 
 > **Important:** You must also include your own hostname!
 

src/index.mjs

@@ -48,7 +48,6 @@ function prefetcher(url) {
  * @param {Array} options.urls - Array of URLs to prefetch (override)
  * @param {Object} options.el - DOM element to prefetch in-viewport links of
  * @param {Boolean} options.priority - Attempt higher priority fetch (low or high)
- * @param {Boolean} options.sameOrigin - If truthy, restricts prefetching to assets with same origin.
  * @param {Array} options.origins - Allowed origins to prefetch (empty allows all)
  * @param {Number} options.timeout - Timeout after which prefetching will occur
  * @param {Function} options.timeoutFn - Custom timeout function
@@ -63,7 +62,7 @@ export default function (options) {
 
   observer.priority = options.priority;
 
-  const allowed = options.sameOrigin ? [location.hostname] : options.origins || [];
+  const allowed = options.origins || [location.hostname];
 
   options.timeoutFn(() => {
     // If URLs are given, prefetch them.

test/quicklink.spec.js

@@ -96,7 +96,8 @@ describe('quicklink tests', function () {
     expect(responseURLs).to.include('https://github.githubassets.com/images/spinners/octocat-spinner-32.gif');
   });
 
-  it('should only prefetch links of same origin', async function () {
+
+  it('should only prefetch links of same origin (default)', async function () {
     const responseURLs = [];
     page.on('response', resp => {
       responseURLs.push(resp.url());
@@ -105,7 +106,7 @@ describe('quicklink tests', function () {
 
     await page.waitFor(1000);
     expect(responseURLs).to.be.an('array');
-    //=> sameOrigin: true
+    //=> origins: [location.hostname] (default)
     expect(responseURLs).to.include(`${server}/2.html`);
     expect(responseURLs).to.not.include('https://example.com/1.html');
     expect(responseURLs).to.not.include('https://github.githubassets.com/images/spinners/octocat-spinner-32.gif');

test/test-same-origin.html

@@ -18,9 +18,7 @@
     <a href="4.html" style="position:absolute;margin-top:900px;">Link 4</a>
     <script src="../dist/quicklink.umd.js"></script>
     <script>
-        quicklink({
-            sameOrigin: true
-        });
+        quicklink();
     </script>
 </body>
 </html>