@khanacademy/wonder-blocks-testing-core 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @khanacademy/wonder-blocks-testing-core
 
+## 2.2.0
+
+### Minor Changes
+
+- eb47d37: Improve error messaging for the router test harness adapter
+
+## 2.1.1
+
+### Patch Changes
+
+- ee8d95a: Rollback rollup version from v4 to v2 to prevent an issue with CJS builds in unit tests
+
 ## 2.1.0
 
 ### Minor Changes

package/dist/es/index.js

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { action } from '@storybook/addon-actions';
-import { StaticRouter, MemoryRouter, Switch, Route } from 'react-router-dom';
+import { StaticRouter, MemoryRouter, useLocation, Switch, Route } from 'react-router-dom';
 import _extends from '@babel/runtime/helpers/extends';
 import * as ReactDOMServer from 'react-dom/server';
 
@@ -213,8 +213,8 @@ class SettleSignal extends EventTarget {
 
 class SettleController {
   constructor() {
-    this._settleFn = undefined;
-    this._signal = undefined;
+    this._settleFn = void 0;
+    this._signal = void 0;
     this._signal = new SettleSignal(settleFn => this._settleFn = settleFn);
   }
   get signal() {
@@ -300,7 +300,13 @@ const adapter$1 = (children, config) => React.createElement(React.Fragment, null
 const defaultConfig = {
   location: "/"
 };
-const maybeWithRoute = (children, path) => {
+const MaybeWithRoute = ({
+  children,
+  path,
+  configLocation
+}) => {
+  const actualLocation = useLocation();
+  const configuredLocation = typeof configLocation === "string" ? configLocation : configLocation.pathname;
   if (path == null) {
     return React.createElement(React.Fragment, null, children);
   }
@@ -310,27 +316,33 @@ const maybeWithRoute = (children, path) => {
   }, children), React.createElement(Route, {
     path: "*",
     render: () => {
-      throw new Error("The configured path must match the configured location or your harnessed component will not render.");
+      throw new Error(`The current location '${actualLocation.pathname}' ` + `does not match the configured path '${path}'. ` + `Did you provide the correct configured ` + `location, '${configuredLocation}', or did the ` + `routing lead to a different place than you ` + `expected?`);
     }
   }));
 };
 const adapter = (children, config) => {
+  var _config$initialIndex;
   if (typeof config === "string") {
     config = {
       location: config
     };
   }
-  const wrappedWithRoute = maybeWithRoute(children, config.path);
   if ("forceStatic" in config && config.forceStatic) {
     return React.createElement(StaticRouter, {
       location: config.location,
       context: {}
-    }, wrappedWithRoute);
+    }, React.createElement(MaybeWithRoute, {
+      path: config.path,
+      configLocation: config.location
+    }, children));
   }
   if ("location" in config && config.location !== undefined) {
     return React.createElement(MemoryRouter, {
       initialEntries: [config.location]
-    }, wrappedWithRoute);
+    }, React.createElement(MaybeWithRoute, {
+      path: config.path,
+      configLocation: config.location
+    }, children));
   }
   if (!("initialEntries" in config) || config.initialEntries === undefined) {
     throw new Error("A location or initial history entries must be provided.");
@@ -345,7 +357,10 @@ const adapter = (children, config) => {
   if (config.getUserConfirmation != null) {
     routerProps.getUserConfirmation = config.getUserConfirmation;
   }
-  return React.createElement(MemoryRouter, routerProps, wrappedWithRoute);
+  return React.createElement(MemoryRouter, routerProps, React.createElement(MaybeWithRoute, {
+    path: config.path,
+    configLocation: entries[(_config$initialIndex = config.initialIndex) != null ? _config$initialIndex : 0]
+  }, children));
 };
 
 const DefaultAdapters = {

package/dist/index.js

@@ -1,12 +1,17 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var React = require('react');
 var addonActions = require('@storybook/addon-actions');
 var reactRouterDom = require('react-router-dom');
 var _extends = require('@babel/runtime/helpers/extends');
 var ReactDOMServer = require('react-dom/server');
 
-function _interopNamespaceDefault(e) {
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
     var n = Object.create(null);
     if (e) {
         Object.keys(e).forEach(function (k) {
@@ -19,12 +24,13 @@ function _interopNamespaceDefault(e) {
             }
         });
     }
-    n.default = e;
+    n["default"] = e;
     return Object.freeze(n);
 }
 
-var React__namespace = /*#__PURE__*/_interopNamespaceDefault(React);
-var ReactDOMServer__namespace = /*#__PURE__*/_interopNamespaceDefault(ReactDOMServer);
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+var _extends__default = /*#__PURE__*/_interopDefaultLegacy(_extends);
+var ReactDOMServer__namespace = /*#__PURE__*/_interopNamespace(ReactDOMServer);
 
 const fixtures = Component => {
   const templateMap = new WeakMap();
@@ -235,8 +241,8 @@ class SettleSignal extends EventTarget {
 
 class SettleController {
   constructor() {
-    this._settleFn = undefined;
-    this._signal = undefined;
+    this._settleFn = void 0;
+    this._signal = void 0;
     this._signal = new SettleSignal(settleFn => this._settleFn = settleFn);
   }
   get signal() {
@@ -322,7 +328,13 @@ const adapter$1 = (children, config) => React__namespace.createElement(React__na
 const defaultConfig = {
   location: "/"
 };
-const maybeWithRoute = (children, path) => {
+const MaybeWithRoute = ({
+  children,
+  path,
+  configLocation
+}) => {
+  const actualLocation = reactRouterDom.useLocation();
+  const configuredLocation = typeof configLocation === "string" ? configLocation : configLocation.pathname;
   if (path == null) {
     return React__namespace.createElement(React__namespace.Fragment, null, children);
   }
@@ -332,27 +344,33 @@ const maybeWithRoute = (children, path) => {
   }, children), React__namespace.createElement(reactRouterDom.Route, {
     path: "*",
     render: () => {
-      throw new Error("The configured path must match the configured location or your harnessed component will not render.");
+      throw new Error(`The current location '${actualLocation.pathname}' ` + `does not match the configured path '${path}'. ` + `Did you provide the correct configured ` + `location, '${configuredLocation}', or did the ` + `routing lead to a different place than you ` + `expected?`);
     }
   }));
 };
 const adapter = (children, config) => {
+  var _config$initialIndex;
   if (typeof config === "string") {
     config = {
       location: config
     };
   }
-  const wrappedWithRoute = maybeWithRoute(children, config.path);
   if ("forceStatic" in config && config.forceStatic) {
     return React__namespace.createElement(reactRouterDom.StaticRouter, {
       location: config.location,
       context: {}
-    }, wrappedWithRoute);
+    }, React__namespace.createElement(MaybeWithRoute, {
+      path: config.path,
+      configLocation: config.location
+    }, children));
   }
   if ("location" in config && config.location !== undefined) {
     return React__namespace.createElement(reactRouterDom.MemoryRouter, {
       initialEntries: [config.location]
-    }, wrappedWithRoute);
+    }, React__namespace.createElement(MaybeWithRoute, {
+      path: config.path,
+      configLocation: config.location
+    }, children));
   }
   if (!("initialEntries" in config) || config.initialEntries === undefined) {
     throw new Error("A location or initial history entries must be provided.");
@@ -367,7 +385,10 @@ const adapter = (children, config) => {
   if (config.getUserConfirmation != null) {
     routerProps.getUserConfirmation = config.getUserConfirmation;
   }
-  return React__namespace.createElement(reactRouterDom.MemoryRouter, routerProps, wrappedWithRoute);
+  return React__namespace.createElement(reactRouterDom.MemoryRouter, routerProps, React__namespace.createElement(MaybeWithRoute, {
+    path: config.path,
+    configLocation: entries[(_config$initialIndex = config.initialIndex) != null ? _config$initialIndex : 0]
+  }, children));
 };
 
 const DefaultAdapters = {
@@ -426,11 +447,11 @@ const Adapt = ({
 
 const makeTestHarness = (adapters, defaultConfigs) => {
   return (Component, configs) => {
-    const fullConfig = _extends({}, defaultConfigs, configs);
+    const fullConfig = _extends__default["default"]({}, defaultConfigs, configs);
     const harnessedComponent = React__namespace.forwardRef((props, ref) => React__namespace.createElement(Adapt, {
       adapters: adapters,
       configs: fullConfig
-    }, React__namespace.createElement(Component, _extends({}, props, {
+    }, React__namespace.createElement(Component, _extends__default["default"]({}, props, {
       ref: ref
     }))));
     harnessedComponent.displayName = `testHarness(${Component.displayName || Component.name || "Component"})`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khanacademy/wonder-blocks-testing-core",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "design": "v1",
   "publishConfig": {
     "access": "public"
@@ -23,7 +23,7 @@
   },
   "devDependencies": {
     "@khanacademy/wonder-stuff-testing": "^3.0.1",
-    "@khanacademy/wb-dev-build-settings": "2.1.0"
+    "@khanacademy/wb-dev-build-settings": "2.1.1"
   },
   "author": "",
   "license": "MIT",