creevey 0.8.0-beta.0 → 0.8.0

package/lib/esm/client/addon/withCreevey.js

@@ -1,67 +1,45 @@
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
 import * as Events from '@storybook/core-events';
 import * as polyfill from 'event-source-polyfill';
+import { buildQueries, within } from '@storybook/testing-library';
 import { addons, makeDecorator } from '@storybook/addons';
 import { isObject, noop } from '../../types';
+import { denormalizeStoryParameters, serializeRawStories } from '../../shared';
+import { getConnectionUrl } from '../shared/helpers';
+import { isInternetExplorer } from './utils';
 
-if ((typeof process === "undefined" ? "undefined" : _typeof(process)) != 'object' || typeof process.version != 'string') {
+if (typeof process != 'object' || typeof process.version != 'string') {
   // NOTE If you don't use babel-polyfill or any other polyfills that add EventSource for IE11
   // You don't get hot reload in IE11. So put polyfill for that to better UX
   // Don't load in nodejs environment
   // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-  var NativeEventSource = polyfill.NativeEventSource,
-      EventSourcePolyfill = polyfill.EventSourcePolyfill; // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const {
+    NativeEventSource,
+    EventSourcePolyfill
+  } = polyfill; // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 
   window.EventSource = NativeEventSource || EventSourcePolyfill;
 }
 
-var disableAnimationsStyles = "\n*,\n*:hover,\n*::before,\n*::after {\n  animation-delay: -0.0001ms !important;\n  animation-duration: 0s !important;\n  animation-play-state: paused !important;\n  cursor: none !important;\n  caret-color: transparent !important;\n  transition: 0s !important;\n}\n";
-
-function resetCurrentStory(_x) {
-  return _resetCurrentStory.apply(this, arguments);
-}
+const disableAnimationsStyles = "\n*,\n*:hover,\n*::before,\n*::after {\n  animation-delay: -0.0001ms !important;\n  animation-duration: 0s !important;\n  animation-play-state: paused !important;\n  cursor: none !important;\n  caret-color: transparent !important;\n  transition: 0s !important;\n}\n";
 
-function _resetCurrentStory() {
-  _resetCurrentStory = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3(channel) {
-    return regeneratorRuntime.wrap(function _callee3$(_context3) {
-      while (1) {
-        switch (_context3.prev = _context3.next) {
-          case 0:
-            setTimeout(function () {
-              return channel.emit(Events.SET_CURRENT_STORY, {
-                storyId: true,
-                name: '',
-                kind: ''
-              });
-            }, 0);
-            return _context3.abrupt("return", new Promise(function (resolve) {
-              return channel.once(Events.STORY_MISSING, resolve);
-            }));
-
-          case 2:
-          case "end":
-            return _context3.stop();
-        }
-      }
-    }, _callee3);
-  }));
-  return _resetCurrentStory.apply(this, arguments);
+async function resetCurrentStory(channel) {
+  setTimeout(() => channel.emit(Events.SET_CURRENT_STORY, {
+    storyId: true,
+    name: '',
+    kind: ''
+  }), 0);
+  return new Promise(resolve => channel.once(Events.STORY_MISSING, resolve));
 }
 
 function catchRenderError(channel) {
-  var rejectCallback;
-  var promise = new Promise(function (_resolve, reject) {
-    return rejectCallback = reject;
-  });
+  let rejectCallback;
+  const promise = new Promise((_resolve, reject) => rejectCallback = reject);
 
   function errorHandler(_ref) {
-    var title = _ref.title,
-        description = _ref.description;
+    let {
+      title,
+      description
+    } = _ref;
     rejectCallback({
       message: title,
       stack: description
@@ -85,10 +63,8 @@ function catchRenderError(channel) {
 }
 
 function waitForStoryRendered(channel) {
-  var resolveCallback;
-  var promise = new Promise(function (resolve) {
-    return resolveCallback = resolve;
-  });
+  let resolveCallback;
+  const promise = new Promise(resolve => resolveCallback = resolve);
 
   function renderHandler() {
     resolveCallback();
@@ -106,13 +82,11 @@ function waitForStoryRendered(channel) {
 
 function waitForFontsLoaded() {
   if (!document.fonts) return;
-  var areFontsLoading = Array.from(document.fonts).some(function (font) {
-    return font.status == 'loading';
-  });
+  const areFontsLoading = Array.from(document.fonts).some(font => font.status == 'loading');
 
   if (areFontsLoading) {
-    return new Promise(function (resolve) {
-      var fontsLoadedHandler = function fontsLoadedHandler() {
+    return new Promise(resolve => {
+      const fontsLoadedHandler = () => {
         document.fonts.removeEventListener('loadingdone', fontsLoadedHandler);
         resolve();
       };
@@ -122,128 +96,129 @@ function waitForFontsLoaded() {
   }
 }
 
+function waitForCaptureCall() {
+  return new Promise(resolve => captureResolver = resolve);
+}
+
+function initCreeveyState() {
+  var _window$localStorage$;
+
+  const prevState = JSON.parse((_window$localStorage$ = window.localStorage.getItem('Creevey_Tests')) !== null && _window$localStorage$ !== void 0 ? _window$localStorage$ : '{}');
+  if (prevState.creeveyHost) window.__CREEVEY_SERVER_HOST__ = prevState.creeveyHost;
+  if (prevState.creeveyPort) window.__CREEVEY_SERVER_PORT__ = prevState.creeveyPort;
+  if (prevState.setStoriesCounter) setStoriesCounter = prevState.setStoriesCounter;
+  if (prevState.isTestBrowser) isTestBrowser = prevState.isTestBrowser;
+  window.addEventListener('beforeunload', () => {
+    window.localStorage.setItem('Creevey_Tests', JSON.stringify({
+      creeveyHost: window.__CREEVEY_SERVER_HOST__,
+      creeveyPort: window.__CREEVEY_SERVER_PORT__,
+      setStoriesCounter,
+      isTestBrowser
+    }));
+  });
+}
+
+let isTestBrowser = false;
+let captureResolver;
+let waitForCreevey;
+let creeveyReady;
+let setStoriesCounter = 0;
 export function withCreevey() {
-  var currentStory = '';
-  var isAnimationDisabled = false;
+  let currentStory = '';
+  let isAnimationDisabled = false;
+  initCreeveyState();
 
   function disableAnimation() {
     isAnimationDisabled = true;
-    var style = document.createElement('style');
-    var textNode = document.createTextNode(disableAnimationsStyles);
+    const style = document.createElement('style');
+    const textNode = document.createTextNode(disableAnimationsStyles);
     style.setAttribute('type', 'text/css');
     style.appendChild(textNode);
     document.head.appendChild(style);
   }
 
-  function selectStory(_x2, _x3, _x4, _x5, _x6) {
-    return _selectStory.apply(this, arguments);
+  async function getStories() {
+    var _window$__STORYBOOK_S;
+
+    const storiesPromise = new Promise(resolve => addons.getChannel().once(Events.SET_STORIES, data => resolve(serializeRawStories(denormalizeStoryParameters(data)))));
+    const store = (_window$__STORYBOOK_S = window.__STORYBOOK_STORY_STORE__) !== null && _window$__STORYBOOK_S !== void 0 ? _window$__STORYBOOK_S : {};
+
+    if (store.cacheAllCSFFiles) {
+      await store.cacheAllCSFFiles();
+      addons.getChannel().emit(Events.SET_STORIES, store.getSetStoriesPayload());
+    } else return;
+
+    addons.getChannel().on(Events.SET_STORIES, data => {
+      // TODO Figure out how to get only updated stories
+      // TODO Subscribe on hmr? like use dummy-hmr
+      setStoriesCounter += 1;
+      const stories = serializeRawStories(denormalizeStoryParameters(data));
+      const storiesByFiles = new Map();
+      Object.values(stories).forEach(story => {
+        const storiesFromFile = storiesByFiles.get(story.parameters.fileName);
+        if (storiesFromFile) storiesFromFile.push(story);else storiesByFiles.set(story.parameters.fileName, [story]);
+      });
+      void fetch("http://".concat(getConnectionUrl(), "/stories"), {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+          setStoriesCounter,
+          stories: [...storiesByFiles.entries()]
+        })
+      });
+    });
+    return storiesPromise;
   }
 
-  function _selectStory() {
-    _selectStory = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(storyId, kind, name, shouldWaitForReady, callback) {
-      var channel, waitForReady, renderPromise, errorPromise, _reason$stack, errorMessage;
-
-      return regeneratorRuntime.wrap(function _callee2$(_context2) {
-        while (1) {
-          switch (_context2.prev = _context2.next) {
-            case 0:
-              if (!isAnimationDisabled) disableAnimation();
-              channel = addons.getChannel();
-              waitForReady = shouldWaitForReady ? new Promise(function (resolve) {
-                return window.__CREEVEY_SET_READY_FOR_CAPTURE__ = resolve;
-              }) : Promise.resolve();
-
-              if (!(storyId == currentStory)) {
-                _context2.next = 8;
-                break;
-              }
-
-              _context2.next = 6;
-              return resetCurrentStory(channel);
-
-            case 6:
-              _context2.next = 9;
-              break;
-
-            case 8:
-              currentStory = storyId;
-
-            case 9:
-              renderPromise = waitForStoryRendered(channel);
-              errorPromise = catchRenderError(channel);
-              setTimeout(function () {
-                return channel.emit(Events.SET_CURRENT_STORY, {
-                  storyId: storyId,
-                  name: name,
-                  kind: kind
-                });
-              }, 0);
-              _context2.prev = 12;
-              _context2.next = 15;
-              return Promise.race([_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
-                return regeneratorRuntime.wrap(function _callee$(_context) {
-                  while (1) {
-                    switch (_context.prev = _context.next) {
-                      case 0:
-                        _context.next = 2;
-                        return renderPromise;
-
-                      case 2:
-                        _context.next = 4;
-                        return waitForFontsLoaded();
-
-                      case 4:
-                        _context.next = 6;
-                        return waitForReady;
-
-                      case 6:
-                      case "end":
-                        return _context.stop();
-                    }
-                  }
-                }, _callee);
-              }))(), errorPromise]);
-
-            case 15:
-              callback();
-              _context2.next = 22;
-              break;
-
-            case 18:
-              _context2.prev = 18;
-              _context2.t0 = _context2["catch"](12);
-              // NOTE Event `STORY_THREW_EXCEPTION` triggered only in react and vue frameworks and return Error instance
-              // NOTE Event `STORY_ERRORED` return error-like object without `name` field
-              errorMessage = _context2.t0 instanceof Error ? (_reason$stack = _context2.t0.stack) !== null && _reason$stack !== void 0 ? _reason$stack : _context2.t0.message : isObject(_context2.t0) ? "".concat(_context2.t0.message, "\n    ").concat(_context2.t0.stack) : _context2.t0;
-              callback(errorMessage);
-
-            case 22:
-              _context2.prev = 22;
-              renderPromise.cancel();
-              errorPromise.cancel();
-              return _context2.finish(22);
-
-            case 26:
-            case "end":
-              return _context2.stop();
-          }
-        }
-      }, _callee2, null, [[12, 18, 22, 26]]);
-    }));
-    return _selectStory.apply(this, arguments);
+  async function selectStory(storyId, kind, name, shouldWaitForReady, callback) {
+    if (!isAnimationDisabled) disableAnimation();
+    isTestBrowser = true;
+    const channel = addons.getChannel();
+    const waitForReady = shouldWaitForReady ? new Promise(resolve => window.__CREEVEY_SET_READY_FOR_CAPTURE__ = resolve) : Promise.resolve();
+    if (storyId == currentStory) await resetCurrentStory(channel);else currentStory = storyId;
+    let isCaptureCalled = false;
+    const renderPromise = waitForStoryRendered(channel);
+    const errorPromise = catchRenderError(channel);
+    const capturePromise = waitForCaptureCall().then(() => isCaptureCalled = true);
+    setTimeout(() => channel.emit(Events.SET_CURRENT_STORY, {
+      storyId,
+      name,
+      kind
+    }), 0);
+
+    try {
+      await Promise.race([(async () => {
+        await Promise.race([renderPromise, capturePromise]);
+        await waitForFontsLoaded();
+        await waitForReady;
+      })(), errorPromise]);
+      callback([null, isCaptureCalled]);
+    } catch (reason) {
+      var _reason$stack;
+
+      // NOTE Event `STORY_THREW_EXCEPTION` triggered only in react and vue frameworks and return Error instance
+      // NOTE Event `STORY_ERRORED` return error-like object without `name` field
+      const errorMessage = reason instanceof Error ? (_reason$stack = reason.stack) !== null && _reason$stack !== void 0 ? _reason$stack : reason.message : isObject(reason) ? "".concat(reason.message, "\n    ").concat(reason.stack) : reason;
+      callback([errorMessage]);
+    } finally {
+      renderPromise.cancel();
+      errorPromise.cancel();
+    }
   }
 
   function updateGlobals(globals) {
     addons.getChannel().emit(Events.UPDATE_GLOBALS, {
-      globals: globals
+      globals
     });
   }
 
   function insertIgnoreStyles(ignoreSelectors) {
-    var stylesElement = document.createElement('style');
+    const stylesElement = document.createElement('style');
     stylesElement.setAttribute('type', 'text/css');
     document.head.appendChild(stylesElement);
-    ignoreSelectors.forEach(function (selector) {
+    ignoreSelectors.forEach(selector => {
       stylesElement.innerHTML += "\n        ".concat(selector, " {\n          background: #000 !important;\n          box-shadow: none !important;\n          text-shadow: none !important;\n          outline: 0 !important;\n          color: rgba(0,0,0,0) !important;\n        }\n        ").concat(selector, " *, ").concat(selector, "::before, ").concat(selector, "::after {\n          visibility: hidden !important;\n        }\n      ");
     });
     return stylesElement;
@@ -255,16 +230,94 @@ export function withCreevey() {
     (_ignoreStyles$parentN = ignoreStyles.parentNode) === null || _ignoreStyles$parentN === void 0 ? void 0 : _ignoreStyles$parentN.removeChild(ignoreStyles);
   }
 
+  function hasPlayCompletedYet(callback) {
+    creeveyReady();
+    let isCaptureCalled = false;
+    let isPlayCompleted = false;
+    const channel = addons.getChannel();
+    void waitForStoryRendered(channel).then(() => {
+      if (isCaptureCalled) return;
+      isPlayCompleted = true;
+      callback(true);
+    });
+    void waitForCaptureCall().then(() => {
+      if (isPlayCompleted) return;
+      isCaptureCalled = true;
+      callback(false);
+    });
+  }
+
+  window.__CREEVEY_GET_STORIES__ = getStories;
   window.__CREEVEY_SELECT_STORY__ = selectStory;
   window.__CREEVEY_UPDATE_GLOBALS__ = updateGlobals;
   window.__CREEVEY_INSERT_IGNORE_STYLES__ = insertIgnoreStyles;
   window.__CREEVEY_REMOVE_IGNORE_STYLES__ = removeIgnoreStyles;
+  window.__CREEVEY_HAS_PLAY_COMPLETED_YET__ = hasPlayCompletedYet;
   window.__CREEVEY_SET_READY_FOR_CAPTURE__ = noop;
+
+  const queryAllByQuery = (container, query) => [...container.querySelectorAll(query)].filter(e => e instanceof HTMLElement);
+
+  const getMultipleError = (_, query) => "Found multiple elements by query: ".concat(query);
+
+  const getMissingError = (_, query) => "Unable to find an element by query: ".concat(query);
+
+  const [queryByQuery, getAllByQuery, getByQuery, findAllByQuery, findByQuery] = buildQueries(queryAllByQuery, getMultipleError, getMissingError);
+  const queries = {
+    queryByQuery,
+    getAllByQuery,
+    getByQuery,
+    findAllByQuery,
+    findByQuery
+  };
   return makeDecorator({
     name: 'withCreevey',
     parameterName: 'creevey',
-    wrapper: function wrapper(getStory, context) {
+    wrapper: (getStory, context) => {
+      var _ref2;
+
+      // TODO Define proper types, like captureElement is a promise
+      const {
+        captureElement
+      } = context.parameters.creevey = (_ref2 = context.parameters.creevey) !== null && _ref2 !== void 0 ? _ref2 : {};
+      Object.defineProperty(context.parameters.creevey, 'captureElement', {
+        get() {
+          switch (true) {
+            case captureElement === undefined:
+              return Promise.resolve(context.canvasElement);
+
+            case captureElement === null:
+              return Promise.resolve(document.documentElement);
+
+            case typeof captureElement == 'string':
+              return isInternetExplorer // some code from testing-library makes IE hang
+              ? Promise.resolve(context.canvasElement.querySelector(captureElement)) : within(context.canvasElement, queries).findByQuery(captureElement);
+
+            case typeof captureElement == 'function':
+              // TODO Define type for it
+              return Promise.resolve(captureElement(context));
+          }
+        },
+
+        enumerable: true,
+        configurable: true
+      });
       return getStory(context);
     }
   });
+}
+export async function capture(options) {
+  if (!isTestBrowser) return;
+  captureResolver();
+  waitForCreevey = new Promise(resolve => creeveyReady = resolve);
+  await fetch("http://".concat(getConnectionUrl(), "/capture"), {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      workerId: window.__CREEVEY_WORKER_ID__,
+      options
+    })
+  });
+  await waitForCreevey;
 }

package/lib/esm/client/shared/components/ImagesView/BlendView.js

@@ -2,19 +2,22 @@ import React, { useEffect, useRef } from 'react';
 import { getBorderColor, themeBorderColors } from './ImagesView';
 import { styled, withTheme } from '@storybook/theming';
 import { useApplyScale, useCalcScale, useLoadImages } from '../../helpers';
-var Container = styled.div({
+import { readyForCapture } from '../../../addon/readyForCapture';
+const Container = styled.div({
   position: 'relative',
   display: 'flex',
   filter: 'invert(100%)'
 });
-var ImageContainer = styled.div({
+const ImageContainer = styled.div({
   position: 'absolute',
   width: '100%',
   height: '100%',
   display: 'flex'
 });
-var Image = styled.img(function (_ref) {
-  var borderColor = _ref.borderColor;
+const Image = styled.img(_ref => {
+  let {
+    borderColor
+  } = _ref;
   return {
     boxSizing: 'border-box',
     border: "1px solid ".concat(borderColor),
@@ -22,28 +25,28 @@ var Image = styled.img(function (_ref) {
     filter: 'invert(100%)'
   };
 });
-var ActualImage = styled(Image)({
+const ActualImage = styled(Image)({
   mixBlendMode: 'difference'
 });
-var DiffImage = styled(Image)({
+const DiffImage = styled(Image)({
   opacity: '0'
 });
-export var BlendView = withTheme(function (_ref2) {
-  var actual = _ref2.actual,
-      diff = _ref2.diff,
-      expect = _ref2.expect,
-      theme = _ref2.theme;
-  var expectImageRef = useRef(null);
-  var diffImageRef = useRef(null);
-  var actualImageRef = useRef(null);
-  var loaded = useLoadImages(expect, diff, actual);
-  var scale = useCalcScale(diffImageRef, loaded);
+export const BlendView = withTheme(_ref2 => {
+  let {
+    actual,
+    diff,
+    expect,
+    theme
+  } = _ref2;
+  const expectImageRef = useRef(null);
+  const diffImageRef = useRef(null);
+  const actualImageRef = useRef(null);
+  const loaded = useLoadImages(expect, diff, actual);
+  const scale = useCalcScale(diffImageRef, loaded);
   useApplyScale(expectImageRef, scale, loaded);
   useApplyScale(actualImageRef, scale, loaded);
-  useEffect(function () {
-    var _window$__CREEVEY_SET, _window;
-
-    if (loaded) (_window$__CREEVEY_SET = (_window = window).__CREEVEY_SET_READY_FOR_CAPTURE__) === null || _window$__CREEVEY_SET === void 0 ? void 0 : _window$__CREEVEY_SET.call(_window);
+  useEffect(() => {
+    if (loaded) readyForCapture();
   }, [loaded]);
   return /*#__PURE__*/React.createElement(Container, null, /*#__PURE__*/React.createElement(ImageContainer, null, /*#__PURE__*/React.createElement(Image, {
     ref: expectImageRef,

package/lib/esm/client/shared/components/ImagesView/ImagesView.js

@@ -4,26 +4,24 @@ import { SwapView } from './SwapView';
 import { SlideView } from './SlideView';
 import { BlendView } from './BlendView';
 import { styled, withTheme } from '@storybook/theming';
-export var themeBorderColors = {
+export const themeBorderColors = {
   actual: 'negative',
   expect: 'positive',
   diff: 'secondary'
 };
 
-var isColor = function isColor(theme, color) {
-  return color in theme.color;
-};
+const isColor = (theme, color) => color in theme.color;
 
 export function getBorderColor(theme, color) {
   return isColor(theme, color) ? theme.color[color] : color;
 }
-var views = {
+const views = {
   'side-by-side': SideBySideView,
   swap: SwapView,
   slide: SlideView,
   blend: BlendView
 };
-var Container = styled.div({
+const Container = styled.div({
   height: '100%',
   display: 'flex',
   textAlign: 'center',
@@ -31,25 +29,31 @@ var Container = styled.div({
   justifyContent: 'center',
   padding: '0 20px'
 });
-var ImageLink = styled.a({
+const ImageLink = styled.a({
   lineHeight: 0
 });
-var ActualImage = withTheme(styled.img(function (_ref) {
-  var theme = _ref.theme;
+const ActualImage = withTheme(styled.img(_ref => {
+  let {
+    theme
+  } = _ref;
   return {
     border: "1px solid ".concat(getBorderColor(theme, themeBorderColors.expect)),
     maxWidth: '100%'
   };
 }));
 export function ImagesView(_ref2) {
-  var url = _ref2.url,
-      image = _ref2.image,
-      canApprove = _ref2.canApprove,
-      mode = _ref2.mode;
-  var ViewComponent = views[mode];
-  var actual = image.actual,
-      diff = image.diff,
-      expect = image.expect;
+  let {
+    url,
+    image,
+    canApprove,
+    mode
+  } = _ref2;
+  const ViewComponent = views[mode];
+  const {
+    actual,
+    diff,
+    expect
+  } = image;
   return /*#__PURE__*/React.createElement(Container, null, canApprove && diff && expect ? /*#__PURE__*/React.createElement(ViewComponent, {
     actual: "".concat(url, "/").concat(actual),
     diff: "".concat(url, "/").concat(diff),