msw 0.38.2 → 0.39.2

package/lib/iife/mockServiceWorker.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (0.38.2).
+ * Mock Service Worker (0.39.2).
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.

package/lib/types/setupWorker/glossary.d.ts

@@ -85,20 +85,26 @@ export declare type ServiceWorkerInstanceTuple = [
 export declare type FindWorker = (scriptUrl: string, mockServiceWorkerUrl: string) => boolean;
 export interface StartOptions extends SharedOptions {
     /**
-     * Service Worker instance options.
+     * Service Worker registration options.
      */
     serviceWorker?: {
+        /**
+         * Custom url to the worker script.
+         * @default "./mockServiceWorker.js"
+         */
         url?: string;
         options?: RegistrationOptions;
     };
     /**
      * Disables the logging of captured requests
      * into browser's console.
+     * @default false
      */
     quiet?: boolean;
     /**
      * Defers any network requests until the Service Worker
-     * instance is ready. Defaults to `true`.
+     * instance is activated.
+     * @default true
      */
     waitUntilReady?: boolean;
     /**

package/lib/types/utils/request/setRequestCookies.d.ts

@@ -1,2 +1,9 @@
 import { MockedRequest } from '../../handlers/RequestHandler';
+/**
+ * Sets relevant cookies on the request.
+ * Request cookies are taken from the following sources:
+ * - Immediate (own) request cookies (those in the "Cookie" request header);
+ * - From the `document.cookie` based on the request's `credentials` value;
+ * - From the internal cookie store that persists/hydrates cookies in Node.js
+ */
 export declare function setRequestCookies(request: MockedRequest): void;

package/lib/umd/index.js

@@ -2463,13 +2463,36 @@ Invalid value has been removed from localStorage to prevent subsequent failed pa
       }
   }
 
+  /**
+   * Sets relevant cookies on the request.
+   * Request cookies are taken from the following sources:
+   * - Immediate (own) request cookies (those in the "Cookie" request header);
+   * - From the `document.cookie` based on the request's `credentials` value;
+   * - From the internal cookie store that persists/hydrates cookies in Node.js
+   */
   function setRequestCookies(request) {
       var _a;
+      // Set mocked request cookies from the `cookie` header of the original request.
+      // No need to take `credentials` into account, because in Node.js requests are intercepted
+      // _after_ they happen. Request issuer should have already taken care of sending relevant cookies.
+      // Unlike browser, where interception is on the worker level, _before_ the request happens.
+      const requestCookiesString = request.headers.get('cookie');
       lib$2.store.hydrate();
-      request.cookies = Object.assign(Object.assign({}, getRequestCookies(request)), Array.from((_a = lib$2.store.get(Object.assign(Object.assign({}, request), { url: request.url.toString() }))) === null || _a === void 0 ? void 0 : _a.entries()).reduce((cookies, [name, { value }]) => Object.assign(cookies, { [name]: value }), {}));
-      request.headers.set('cookie', Object.entries(request.cookies)
-          .map(([name, value]) => `${name}=${value}`)
-          .join('; '));
+      const cookiesFromStore = Array.from((_a = lib$2.store.get(Object.assign(Object.assign({}, request), { url: request.url.toString() }))) === null || _a === void 0 ? void 0 : _a.entries()).reduce((cookies, [name, { value }]) => {
+          return Object.assign(cookies, { [name.trim()]: value });
+      }, {});
+      const cookiesFromDocument = getRequestCookies(request);
+      const forwardedCookies = Object.assign(Object.assign({}, cookiesFromDocument), cookiesFromStore);
+      // Ensure the persisted (document) cookies are propagated to the request.
+      // Propagated the cookies persisted in the Cookuie Store to the request headers.
+      // This forwards relevant request cookies based on the request's credentials.
+      for (const [name, value] of Object.entries(forwardedCookies)) {
+          request.headers.append('cookie', `${name}=${value}`);
+      }
+      const ownCookies = requestCookiesString
+          ? parse_1(requestCookiesString)
+          : {};
+      request.cookies = Object.assign(Object.assign(Object.assign({}, request.cookies), forwardedCookies), ownCookies);
   }
 
   function parseContentHeaders(headersString) {
@@ -26536,16 +26559,32 @@ This is necessary to ensure that the Service Worker is in sync with the library
 If this message still persists after updating, please report an issue: https://github.com/open-draft/msw/issues\
       `);
               }
-              yield enableMocking(context, options).catch((err) => {
-                  throw new Error(`Failed to enable mocking: ${err === null || err === void 0 ? void 0 : err.message}`);
-              });
               context.keepAliveInterval = window.setInterval(() => context.workerChannel.send('KEEPALIVE_REQUEST'), 5000);
               // Warn the user when loading the page that lies outside
               // of the worker's scope.
               validateWorkerScope(registration, context.startOptions);
               return registration;
           });
-          const workerRegistration = startWorkerInstance();
+          const workerRegistration = startWorkerInstance().then((registration) => __awaiter$3(this, void 0, void 0, function* () {
+              const pendingInstance = registration.installing || registration.waiting;
+              // Wait until the worker is activated.
+              // Assume the worker is already activated if there's no pending registration
+              // (i.e. when reloading the page after a successful activation).
+              if (pendingInstance) {
+                  yield new Promise((resolve) => {
+                      pendingInstance.addEventListener('statechange', () => {
+                          if (pendingInstance.state === 'activated') {
+                              return resolve();
+                          }
+                      });
+                  });
+              }
+              // Print the activation message only after the worker has been activated.
+              yield enableMocking(context, options).catch((error) => {
+                  throw new Error(`Failed to enable mocking: ${error === null || error === void 0 ? void 0 : error.message}`);
+              });
+              return registration;
+          }));
           // Defer any network requests until the Service Worker instance is ready.
           // This prevents a race condition between the Service Worker registration
           // and application's runtime requests (i.e. requests on mount).
@@ -31217,6 +31256,7 @@ If this message still persists after updating, please report an issue: https://g
           url: request.url,
           method: request.method,
           body: parseBody(request.body, request.headers),
+          credentials: request.credentials || 'same-origin',
           headers: request.headers,
           cookies: {},
           redirect: 'manual',
@@ -31228,21 +31268,9 @@ If this message still persists after updating, please report an issue: https://g
           integrity: '',
           destination: 'document',
           bodyUsed: false,
-          credentials: 'same-origin',
       };
-      // Set mocked request cookies from the `cookie` header of the original request.
-      // No need to take `credentials` into account, because in Node.js requests are intercepted
-      // _after_ they happen. Request issuer should have already taken care of sending relevant cookies.
-      // Unlike browser, where interception is on the worker level, _before_ the request happens.
-      const requestCookiesString = request.headers.get('cookie');
       // Attach all the cookies from the virtual cookie store.
       setRequestCookies(mockedRequest);
-      const requestCookies = requestCookiesString
-          ? parse_1(requestCookiesString)
-          : {};
-      // Merge both direct request cookies and the cookies inherited
-      // from other same-origin requests in the cookie store.
-      mockedRequest.cookies = Object.assign(Object.assign({}, mockedRequest.cookies), requestCookies);
       return mockedRequest;
   }
 

package/lib/umd/mockServiceWorker.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (0.38.2).
+ * Mock Service Worker (0.39.2).
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.

package/native/lib/index.js

@@ -161,207 +161,6 @@ function resetHandlers(initialHandlers, ...nextHandlers) {
     return nextHandlers.length > 0 ? [...nextHandlers] : [...initialHandlers];
 }
 
-/*!
- * cookie
- * Copyright(c) 2012-2014 Roman Shtylman
- * Copyright(c) 2015 Douglas Christopher Wilson
- * MIT Licensed
- */
-
-/**
- * Module exports.
- * @public
- */
-
-var parse_1 = parse$2;
-var serialize_1 = serialize;
-
-/**
- * Module variables.
- * @private
- */
-
-var decode = decodeURIComponent;
-var encode = encodeURIComponent;
-
-/**
- * RegExp to match field-content in RFC 7230 sec 3.2
- *
- * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
- * field-vchar   = VCHAR / obs-text
- * obs-text      = %x80-FF
- */
-
-var fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/;
-
-/**
- * Parse a cookie header.
- *
- * Parse the given cookie header string into an object
- * The object has the various cookies as keys(names) => values
- *
- * @param {string} str
- * @param {object} [options]
- * @return {object}
- * @public
- */
-
-function parse$2(str, options) {
-  if (typeof str !== 'string') {
-    throw new TypeError('argument str must be a string');
-  }
-
-  var obj = {};
-  var opt = options || {};
-  var pairs = str.split(';');
-  var dec = opt.decode || decode;
-
-  for (var i = 0; i < pairs.length; i++) {
-    var pair = pairs[i];
-    var index = pair.indexOf('=');
-
-    // skip things that don't look like key=value
-    if (index < 0) {
-      continue;
-    }
-
-    var key = pair.substring(0, index).trim();
-
-    // only assign once
-    if (undefined == obj[key]) {
-      var val = pair.substring(index + 1, pair.length).trim();
-
-      // quoted values
-      if (val[0] === '"') {
-        val = val.slice(1, -1);
-      }
-
-      obj[key] = tryDecode(val, dec);
-    }
-  }
-
-  return obj;
-}
-
-/**
- * Serialize data into a cookie header.
- *
- * Serialize the a name value pair into a cookie string suitable for
- * http headers. An optional options object specified cookie parameters.
- *
- * serialize('foo', 'bar', { httpOnly: true })
- *   => "foo=bar; httpOnly"
- *
- * @param {string} name
- * @param {string} val
- * @param {object} [options]
- * @return {string}
- * @public
- */
-
-function serialize(name, val, options) {
-  var opt = options || {};
-  var enc = opt.encode || encode;
-
-  if (typeof enc !== 'function') {
-    throw new TypeError('option encode is invalid');
-  }
-
-  if (!fieldContentRegExp.test(name)) {
-    throw new TypeError('argument name is invalid');
-  }
-
-  var value = enc(val);
-
-  if (value && !fieldContentRegExp.test(value)) {
-    throw new TypeError('argument val is invalid');
-  }
-
-  var str = name + '=' + value;
-
-  if (null != opt.maxAge) {
-    var maxAge = opt.maxAge - 0;
-
-    if (isNaN(maxAge) || !isFinite(maxAge)) {
-      throw new TypeError('option maxAge is invalid')
-    }
-
-    str += '; Max-Age=' + Math.floor(maxAge);
-  }
-
-  if (opt.domain) {
-    if (!fieldContentRegExp.test(opt.domain)) {
-      throw new TypeError('option domain is invalid');
-    }
-
-    str += '; Domain=' + opt.domain;
-  }
-
-  if (opt.path) {
-    if (!fieldContentRegExp.test(opt.path)) {
-      throw new TypeError('option path is invalid');
-    }
-
-    str += '; Path=' + opt.path;
-  }
-
-  if (opt.expires) {
-    if (typeof opt.expires.toUTCString !== 'function') {
-      throw new TypeError('option expires is invalid');
-    }
-
-    str += '; Expires=' + opt.expires.toUTCString();
-  }
-
-  if (opt.httpOnly) {
-    str += '; HttpOnly';
-  }
-
-  if (opt.secure) {
-    str += '; Secure';
-  }
-
-  if (opt.sameSite) {
-    var sameSite = typeof opt.sameSite === 'string'
-      ? opt.sameSite.toLowerCase() : opt.sameSite;
-
-    switch (sameSite) {
-      case true:
-        str += '; SameSite=Strict';
-        break;
-      case 'lax':
-        str += '; SameSite=Lax';
-        break;
-      case 'strict':
-        str += '; SameSite=Strict';
-        break;
-      case 'none':
-        str += '; SameSite=None';
-        break;
-      default:
-        throw new TypeError('option sameSite is invalid');
-    }
-  }
-
-  return str;
-}
-
-/**
- * Try decoding a string using a decoding function.
- *
- * @param {string} str
- * @param {function} decode
- * @private
- */
-
-function tryDecode(str, decode) {
-  try {
-    return decode(str);
-  } catch (e) {
-    return str;
-  }
-}
-
 /**
  * Parses a given value into a JSON.
  * Does not throw an exception on an invalid JSON string.
@@ -1002,6 +801,207 @@ function parseBody(body, headers) {
     return body;
 }
 
+/*!
+ * cookie
+ * Copyright(c) 2012-2014 Roman Shtylman
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/**
+ * Module exports.
+ * @public
+ */
+
+var parse_1 = parse$2;
+var serialize_1 = serialize;
+
+/**
+ * Module variables.
+ * @private
+ */
+
+var decode = decodeURIComponent;
+var encode = encodeURIComponent;
+
+/**
+ * RegExp to match field-content in RFC 7230 sec 3.2
+ *
+ * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
+ * field-vchar   = VCHAR / obs-text
+ * obs-text      = %x80-FF
+ */
+
+var fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/;
+
+/**
+ * Parse a cookie header.
+ *
+ * Parse the given cookie header string into an object
+ * The object has the various cookies as keys(names) => values
+ *
+ * @param {string} str
+ * @param {object} [options]
+ * @return {object}
+ * @public
+ */
+
+function parse$2(str, options) {
+  if (typeof str !== 'string') {
+    throw new TypeError('argument str must be a string');
+  }
+
+  var obj = {};
+  var opt = options || {};
+  var pairs = str.split(';');
+  var dec = opt.decode || decode;
+
+  for (var i = 0; i < pairs.length; i++) {
+    var pair = pairs[i];
+    var index = pair.indexOf('=');
+
+    // skip things that don't look like key=value
+    if (index < 0) {
+      continue;
+    }
+
+    var key = pair.substring(0, index).trim();
+
+    // only assign once
+    if (undefined == obj[key]) {
+      var val = pair.substring(index + 1, pair.length).trim();
+
+      // quoted values
+      if (val[0] === '"') {
+        val = val.slice(1, -1);
+      }
+
+      obj[key] = tryDecode(val, dec);
+    }
+  }
+
+  return obj;
+}
+
+/**
+ * Serialize data into a cookie header.
+ *
+ * Serialize the a name value pair into a cookie string suitable for
+ * http headers. An optional options object specified cookie parameters.
+ *
+ * serialize('foo', 'bar', { httpOnly: true })
+ *   => "foo=bar; httpOnly"
+ *
+ * @param {string} name
+ * @param {string} val
+ * @param {object} [options]
+ * @return {string}
+ * @public
+ */
+
+function serialize(name, val, options) {
+  var opt = options || {};
+  var enc = opt.encode || encode;
+
+  if (typeof enc !== 'function') {
+    throw new TypeError('option encode is invalid');
+  }
+
+  if (!fieldContentRegExp.test(name)) {
+    throw new TypeError('argument name is invalid');
+  }
+
+  var value = enc(val);
+
+  if (value && !fieldContentRegExp.test(value)) {
+    throw new TypeError('argument val is invalid');
+  }
+
+  var str = name + '=' + value;
+
+  if (null != opt.maxAge) {
+    var maxAge = opt.maxAge - 0;
+
+    if (isNaN(maxAge) || !isFinite(maxAge)) {
+      throw new TypeError('option maxAge is invalid')
+    }
+
+    str += '; Max-Age=' + Math.floor(maxAge);
+  }
+
+  if (opt.domain) {
+    if (!fieldContentRegExp.test(opt.domain)) {
+      throw new TypeError('option domain is invalid');
+    }
+
+    str += '; Domain=' + opt.domain;
+  }
+
+  if (opt.path) {
+    if (!fieldContentRegExp.test(opt.path)) {
+      throw new TypeError('option path is invalid');
+    }
+
+    str += '; Path=' + opt.path;
+  }
+
+  if (opt.expires) {
+    if (typeof opt.expires.toUTCString !== 'function') {
+      throw new TypeError('option expires is invalid');
+    }
+
+    str += '; Expires=' + opt.expires.toUTCString();
+  }
+
+  if (opt.httpOnly) {
+    str += '; HttpOnly';
+  }
+
+  if (opt.secure) {
+    str += '; Secure';
+  }
+
+  if (opt.sameSite) {
+    var sameSite = typeof opt.sameSite === 'string'
+      ? opt.sameSite.toLowerCase() : opt.sameSite;
+
+    switch (sameSite) {
+      case true:
+        str += '; SameSite=Strict';
+        break;
+      case 'lax':
+        str += '; SameSite=Lax';
+        break;
+      case 'strict':
+        str += '; SameSite=Strict';
+        break;
+      case 'none':
+        str += '; SameSite=None';
+        break;
+      default:
+        throw new TypeError('option sameSite is invalid');
+    }
+  }
+
+  return str;
+}
+
+/**
+ * Try decoding a string using a decoding function.
+ *
+ * @param {string} str
+ * @param {function} decode
+ * @private
+ */
+
+function tryDecode(str, decode) {
+  try {
+    return decode(str);
+  } catch (e) {
+    return str;
+  }
+}
+
 function getAllCookies() {
     return parse_1(document.cookie);
 }
@@ -1031,13 +1031,36 @@ function getRequestCookies(request) {
     }
 }
 
+/**
+ * Sets relevant cookies on the request.
+ * Request cookies are taken from the following sources:
+ * - Immediate (own) request cookies (those in the "Cookie" request header);
+ * - From the `document.cookie` based on the request's `credentials` value;
+ * - From the internal cookie store that persists/hydrates cookies in Node.js
+ */
 function setRequestCookies(request) {
     var _a;
+    // Set mocked request cookies from the `cookie` header of the original request.
+    // No need to take `credentials` into account, because in Node.js requests are intercepted
+    // _after_ they happen. Request issuer should have already taken care of sending relevant cookies.
+    // Unlike browser, where interception is on the worker level, _before_ the request happens.
+    const requestCookiesString = request.headers.get('cookie');
     cookies.store.hydrate();
-    request.cookies = Object.assign(Object.assign({}, getRequestCookies(request)), Array.from((_a = cookies.store.get(Object.assign(Object.assign({}, request), { url: request.url.toString() }))) === null || _a === void 0 ? void 0 : _a.entries()).reduce((cookies, [name, { value }]) => Object.assign(cookies, { [name]: value }), {}));
-    request.headers.set('cookie', Object.entries(request.cookies)
-        .map(([name, value]) => `${name}=${value}`)
-        .join('; '));
+    const cookiesFromStore = Array.from((_a = cookies.store.get(Object.assign(Object.assign({}, request), { url: request.url.toString() }))) === null || _a === void 0 ? void 0 : _a.entries()).reduce((cookies, [name, { value }]) => {
+        return Object.assign(cookies, { [name.trim()]: value });
+    }, {});
+    const cookiesFromDocument = getRequestCookies(request);
+    const forwardedCookies = Object.assign(Object.assign({}, cookiesFromDocument), cookiesFromStore);
+    // Ensure the persisted (document) cookies are propagated to the request.
+    // Propagated the cookies persisted in the Cookuie Store to the request headers.
+    // This forwards relevant request cookies based on the request's credentials.
+    for (const [name, value] of Object.entries(forwardedCookies)) {
+        request.headers.append('cookie', `${name}=${value}`);
+    }
+    const ownCookies = requestCookiesString
+        ? parse_1(requestCookiesString)
+        : {};
+    request.cookies = Object.assign(Object.assign(Object.assign({}, request.cookies), forwardedCookies), ownCookies);
 }
 
 /**
@@ -1049,6 +1072,7 @@ function parseIsomorphicRequest(request) {
         url: request.url,
         method: request.method,
         body: parseBody(request.body, request.headers),
+        credentials: request.credentials || 'same-origin',
         headers: request.headers,
         cookies: {},
         redirect: 'manual',
@@ -1060,21 +1084,9 @@ function parseIsomorphicRequest(request) {
         integrity: '',
         destination: 'document',
         bodyUsed: false,
-        credentials: 'same-origin',
     };
-    // Set mocked request cookies from the `cookie` header of the original request.
-    // No need to take `credentials` into account, because in Node.js requests are intercepted
-    // _after_ they happen. Request issuer should have already taken care of sending relevant cookies.
-    // Unlike browser, where interception is on the worker level, _before_ the request happens.
-    const requestCookiesString = request.headers.get('cookie');
     // Attach all the cookies from the virtual cookie store.
     setRequestCookies(mockedRequest);
-    const requestCookies = requestCookiesString
-        ? parse_1(requestCookiesString)
-        : {};
-    // Merge both direct request cookies and the cookies inherited
-    // from other same-origin requests in the cookie store.
-    mockedRequest.cookies = Object.assign(Object.assign({}, mockedRequest.cookies), requestCookies);
     return mockedRequest;
 }