creevey 0.9.0-beta.1 → 0.9.0-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (221) hide show
  1. package/CHANGELOG.md +51 -0
  2. package/README.md +9 -1
  3. package/addon/README.md +3 -0
  4. package/addon/package.json +5 -0
  5. package/docs/config.md +29 -26
  6. package/jest.config.js +6 -0
  7. package/lib/cjs/cli.js +5 -0
  8. package/lib/cjs/client/addon/Manager.js +264 -0
  9. package/lib/cjs/client/addon/components/Addon.js +55 -0
  10. package/lib/cjs/client/addon/components/Icons.js +46 -0
  11. package/lib/cjs/client/addon/components/Panel.js +72 -0
  12. package/lib/cjs/client/addon/components/TestSelect.js +65 -0
  13. package/lib/cjs/client/addon/components/Tools.js +95 -0
  14. package/lib/cjs/client/addon/decorator.js +11 -0
  15. package/lib/cjs/client/addon/index.js +31 -0
  16. package/lib/cjs/client/addon/preset.ie11.js +74 -0
  17. package/lib/cjs/client/addon/preset.js +17 -0
  18. package/lib/cjs/client/addon/preset.sb7.js +19 -0
  19. package/lib/cjs/client/addon/preview.js +14 -0
  20. package/lib/cjs/client/addon/readyForCapture.js +12 -0
  21. package/lib/cjs/client/addon/register.js +72 -0
  22. package/lib/cjs/client/addon/utils.js +42 -0
  23. package/lib/cjs/client/addon/withCreevey.js +351 -0
  24. package/lib/cjs/client/shared/components/ImagesView/BlendView.js +87 -0
  25. package/lib/cjs/client/shared/components/ImagesView/ImagesView.js +92 -0
  26. package/lib/cjs/client/shared/components/ImagesView/SideBySideView.js +154 -0
  27. package/lib/cjs/client/shared/components/ImagesView/SlideView.js +166 -0
  28. package/lib/cjs/client/shared/components/ImagesView/SwapView.js +91 -0
  29. package/lib/cjs/client/shared/components/ImagesView/index.js +45 -0
  30. package/lib/cjs/client/shared/components/PageFooter/PageFooter.js +50 -0
  31. package/lib/cjs/client/shared/components/PageFooter/Paging.js +94 -0
  32. package/lib/cjs/client/shared/components/PageHeader/ImagePreview.js +82 -0
  33. package/lib/cjs/client/shared/components/PageHeader/PageHeader.js +119 -0
  34. package/lib/cjs/client/shared/components/ResultsPage.js +143 -0
  35. package/lib/cjs/client/shared/creeveyClientApi.js +76 -0
  36. package/lib/cjs/client/shared/helpers.js +411 -0
  37. package/lib/cjs/client/shared/viewMode.js +17 -0
  38. package/lib/cjs/client/web/142.js +2 -0
  39. package/lib/cjs/client/web/142.js.LICENSE.txt +12 -0
  40. package/lib/cjs/client/web/32.js +1 -0
  41. package/lib/cjs/client/web/551.js +1 -0
  42. package/lib/cjs/client/web/566.js +2 -0
  43. package/lib/cjs/client/web/566.js.LICENSE.txt +31 -0
  44. package/lib/cjs/client/web/691.js +2 -0
  45. package/lib/cjs/client/web/691.js.LICENSE.txt +8 -0
  46. package/lib/cjs/client/web/725.js +1 -0
  47. package/lib/cjs/client/web/index.html +19 -0
  48. package/lib/cjs/client/web/main.js +2 -38
  49. package/lib/cjs/client/web/main.js.LICENSE.txt +49 -0
  50. package/lib/cjs/creevey.js +69 -0
  51. package/lib/cjs/index.js +62 -0
  52. package/lib/cjs/server/config.js +94 -0
  53. package/lib/cjs/server/docker.js +146 -0
  54. package/lib/cjs/server/extract.js +46 -0
  55. package/lib/cjs/server/index.js +83 -0
  56. package/lib/cjs/server/loaders/babel/creevey-plugin.js +86 -0
  57. package/lib/cjs/server/loaders/babel/helpers.js +469 -0
  58. package/lib/cjs/server/loaders/babel/register.js +124 -0
  59. package/lib/cjs/server/loaders/hooks/mdx.js +30 -0
  60. package/lib/cjs/server/loaders/hooks/svelte.js +65 -0
  61. package/lib/cjs/server/loaders/webpack/compile.js +269 -0
  62. package/lib/cjs/server/loaders/webpack/creevey-loader.js +172 -0
  63. package/lib/cjs/server/loaders/webpack/dummy-hmr.js +39 -0
  64. package/lib/cjs/server/loaders/webpack/mdx-loader.js +72 -0
  65. package/lib/cjs/server/loaders/webpack/start.js +41 -0
  66. package/lib/cjs/server/logger.js +48 -0
  67. package/lib/cjs/server/master/api.js +71 -0
  68. package/lib/cjs/server/master/index.js +146 -0
  69. package/lib/cjs/server/master/master.js +57 -0
  70. package/lib/cjs/server/master/pool.js +197 -0
  71. package/lib/cjs/server/master/runner.js +281 -0
  72. package/lib/cjs/server/master/server.js +131 -0
  73. package/lib/cjs/server/messages.js +264 -0
  74. package/lib/cjs/server/selenium/browser.js +668 -0
  75. package/lib/cjs/server/selenium/index.js +31 -0
  76. package/lib/cjs/server/selenium/selenoid.js +172 -0
  77. package/lib/cjs/server/stories.js +153 -0
  78. package/lib/cjs/server/storybook/entry.js +53 -0
  79. package/lib/cjs/server/storybook/helpers.js +158 -0
  80. package/lib/cjs/server/storybook/providers/browser.js +74 -0
  81. package/lib/cjs/server/storybook/providers/hybrid.js +82 -0
  82. package/lib/cjs/server/storybook/providers/nodejs.js +239 -0
  83. package/lib/cjs/server/testsFiles/parser.js +72 -0
  84. package/lib/cjs/server/testsFiles/register.js +44 -0
  85. package/lib/cjs/server/update.js +79 -0
  86. package/lib/cjs/server/utils.js +176 -0
  87. package/lib/cjs/server/worker/chai-image.js +142 -0
  88. package/lib/cjs/server/worker/helpers.js +69 -0
  89. package/lib/cjs/server/worker/index.js +15 -0
  90. package/lib/cjs/server/worker/reporter.js +108 -0
  91. package/lib/cjs/server/worker/worker.js +268 -0
  92. package/lib/cjs/shared/index.js +101 -0
  93. package/lib/cjs/shared/serializeRegExp.js +42 -0
  94. package/lib/cjs/types.js +75 -0
  95. package/lib/esm/cli.js +4 -0
  96. package/lib/esm/client/addon/Manager.js +248 -0
  97. package/lib/esm/client/addon/components/Addon.js +39 -0
  98. package/lib/esm/client/addon/components/Icons.js +31 -0
  99. package/lib/esm/client/addon/components/Panel.js +53 -0
  100. package/lib/esm/client/addon/components/TestSelect.js +51 -0
  101. package/lib/esm/client/addon/components/Tools.js +74 -0
  102. package/lib/esm/client/addon/decorator.js +2 -0
  103. package/lib/esm/client/addon/index.js +2 -0
  104. package/lib/esm/client/addon/preset.ie11.js +59 -0
  105. package/lib/esm/client/addon/preset.js +8 -0
  106. package/lib/esm/client/addon/preset.sb7.js +8 -0
  107. package/lib/esm/client/addon/preview.js +5 -0
  108. package/lib/esm/client/addon/readyForCapture.js +5 -0
  109. package/lib/esm/client/addon/register.js +51 -0
  110. package/lib/esm/client/addon/utils.js +32 -0
  111. package/lib/esm/client/addon/withCreevey.js +325 -0
  112. package/lib/esm/client/shared/components/ImagesView/BlendView.js +67 -0
  113. package/lib/esm/client/shared/components/ImagesView/ImagesView.js +69 -0
  114. package/lib/esm/client/shared/components/ImagesView/SideBySideView.js +131 -0
  115. package/lib/esm/client/shared/components/ImagesView/SlideView.js +143 -0
  116. package/lib/esm/client/shared/components/ImagesView/SwapView.js +71 -0
  117. package/lib/esm/client/shared/components/ImagesView/index.js +5 -0
  118. package/lib/esm/client/shared/components/PageFooter/PageFooter.js +36 -0
  119. package/lib/esm/client/shared/components/PageFooter/Paging.js +80 -0
  120. package/lib/esm/client/shared/components/PageHeader/ImagePreview.js +68 -0
  121. package/lib/esm/client/shared/components/PageHeader/PageHeader.js +97 -0
  122. package/lib/esm/client/shared/components/ResultsPage.js +115 -0
  123. package/lib/esm/client/shared/creeveyClientApi.js +67 -0
  124. package/lib/esm/client/shared/helpers.js +353 -0
  125. package/lib/esm/client/shared/viewMode.js +6 -0
  126. package/lib/esm/creevey.js +54 -0
  127. package/lib/esm/index.js +5 -0
  128. package/lib/esm/server/config.js +71 -0
  129. package/lib/esm/server/docker.js +123 -0
  130. package/lib/esm/server/extract.js +32 -0
  131. package/lib/esm/server/index.js +64 -0
  132. package/lib/esm/server/loaders/babel/creevey-plugin.js +72 -0
  133. package/lib/esm/server/loaders/babel/helpers.js +452 -0
  134. package/lib/esm/server/loaders/babel/register.js +103 -0
  135. package/lib/esm/server/loaders/hooks/mdx.js +15 -0
  136. package/lib/esm/server/loaders/hooks/svelte.js +49 -0
  137. package/lib/esm/server/loaders/webpack/compile.js +246 -0
  138. package/lib/esm/server/loaders/webpack/creevey-loader.js +152 -0
  139. package/lib/esm/server/loaders/webpack/dummy-hmr.js +32 -0
  140. package/lib/esm/server/loaders/webpack/mdx-loader.js +58 -0
  141. package/lib/esm/server/loaders/webpack/start.js +27 -0
  142. package/lib/esm/server/logger.js +20 -0
  143. package/lib/esm/server/master/api.js +60 -0
  144. package/lib/esm/server/master/index.js +125 -0
  145. package/lib/esm/server/master/master.js +38 -0
  146. package/lib/esm/server/master/pool.js +176 -0
  147. package/lib/esm/server/master/runner.js +259 -0
  148. package/lib/esm/server/master/server.js +107 -0
  149. package/lib/esm/server/messages.js +232 -0
  150. package/lib/esm/server/selenium/browser.js +635 -0
  151. package/lib/esm/server/selenium/index.js +2 -0
  152. package/lib/esm/server/selenium/selenoid.js +149 -0
  153. package/lib/esm/server/stories.js +135 -0
  154. package/lib/esm/server/storybook/entry.js +27 -0
  155. package/lib/esm/server/storybook/helpers.js +97 -0
  156. package/lib/esm/server/storybook/providers/browser.js +58 -0
  157. package/lib/esm/server/storybook/providers/hybrid.js +60 -0
  158. package/lib/esm/server/storybook/providers/nodejs.js +216 -0
  159. package/lib/esm/server/testsFiles/parser.js +50 -0
  160. package/lib/esm/server/testsFiles/register.js +31 -0
  161. package/lib/esm/server/update.js +61 -0
  162. package/lib/esm/server/utils.js +133 -0
  163. package/lib/esm/server/worker/chai-image.js +130 -0
  164. package/lib/esm/server/worker/helpers.js +60 -0
  165. package/lib/esm/server/worker/index.js +1 -0
  166. package/lib/esm/server/worker/reporter.js +86 -0
  167. package/lib/esm/server/worker/worker.js +238 -0
  168. package/lib/esm/shared/index.js +78 -0
  169. package/lib/esm/shared/serializeRegExp.js +24 -0
  170. package/lib/esm/types.js +44 -0
  171. package/lib/types/client/addon/Manager.d.ts +2 -2
  172. package/lib/types/client/addon/components/TestSelect.d.ts +0 -1
  173. package/lib/types/client/addon/index.d.ts +2 -0
  174. package/lib/types/client/addon/preset.d.ts +0 -22
  175. package/lib/types/client/addon/preset.ie11.d.ts +10 -0
  176. package/lib/types/client/addon/preset.sb7.d.ts +2 -0
  177. package/lib/types/client/addon/preview.d.ts +4 -0
  178. package/lib/types/client/addon/utils.d.ts +1 -0
  179. package/lib/types/client/addon/withCreevey.d.ts +1 -1
  180. package/lib/types/client/shared/components/ImagesView/BlendView.d.ts +1 -1
  181. package/lib/types/client/shared/components/ImagesView/ImagesView.d.ts +0 -1
  182. package/lib/types/client/shared/components/ImagesView/SideBySideView.d.ts +1 -1
  183. package/lib/types/client/shared/components/ImagesView/SlideView.d.ts +1 -1
  184. package/lib/types/client/shared/components/ImagesView/SwapView.d.ts +1 -1
  185. package/lib/types/client/shared/components/PageFooter/PageFooter.d.ts +0 -1
  186. package/lib/types/client/shared/components/PageFooter/Paging.d.ts +0 -1
  187. package/lib/types/client/shared/components/PageHeader/ImagePreview.d.ts +1 -1
  188. package/lib/types/client/shared/components/PageHeader/PageHeader.d.ts +0 -1
  189. package/lib/types/client/shared/components/ResultsPage.d.ts +1 -1
  190. package/lib/types/client/web/CreeveyApp.d.ts +0 -1
  191. package/lib/types/client/web/CreeveyLoader.d.ts +1 -2
  192. package/lib/types/client/web/CreeveyView/SideBar/Checkbox.d.ts +1 -1
  193. package/lib/types/client/web/CreeveyView/SideBar/SideBarHeader.d.ts +0 -1
  194. package/lib/types/client/web/CreeveyView/SideBar/SuiteLink.d.ts +4 -4
  195. package/lib/types/client/web/CreeveyView/SideBar/TestLink.d.ts +0 -1
  196. package/lib/types/client/web/CreeveyView/SideBar/TestStatusIcon.d.ts +1 -1
  197. package/lib/types/client/web/CreeveyView/SideBar/TestsStatus.d.ts +1 -1
  198. package/lib/types/index.d.ts +1 -0
  199. package/lib/types/server/loaders/babel/register.d.ts +1 -1
  200. package/lib/types/server/loaders/webpack/creevey-loader.d.ts +4 -2
  201. package/lib/types/server/logger.d.ts +6 -2
  202. package/lib/types/server/messages.d.ts +14 -12
  203. package/lib/types/server/selenium/browser.d.ts +5 -3
  204. package/lib/types/server/storybook/entry.d.ts +2 -3
  205. package/lib/types/server/storybook/helpers.d.ts +1 -1
  206. package/lib/types/server/storybook/providers/browser.d.ts +2 -4
  207. package/lib/types/server/storybook/providers/hybrid.d.ts +2 -4
  208. package/lib/types/server/storybook/providers/nodejs.d.ts +3 -3
  209. package/lib/types/server/utils.d.ts +5 -1
  210. package/lib/types/{shared.d.ts → shared/index.d.ts} +1 -10
  211. package/lib/types/shared/serializeRegExp.d.ts +9 -0
  212. package/lib/types/types.d.ts +4 -7
  213. package/package.json +117 -103
  214. package/preset/ie11.js +5 -0
  215. package/{preset.js → preset/index.js} +2 -2
  216. package/preset/sb7.js +5 -0
  217. package/types/global.d.ts +5 -0
  218. package/types/mdx.d.ts +3 -2
  219. package/lib/cjs/client/web/1.js +0 -13
  220. package/lib/cjs/client/web/2.js +0 -1
  221. package/storybook-static/stories.json +0 -21
package/lib/cjs/server/selenium/browser.js ADDED
@@ -0,0 +1,668 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.closeBrowser = closeBrowser;
7
+ exports.getBrowser = getBrowser;
8
+ exports.loadStoriesFromBrowser = loadStoriesFromBrowser;
9
+ exports.switchStory = switchStory;
10
+ exports.takeScreenshot = takeScreenshot;
11
+ exports.updateStorybookGlobals = updateStorybookGlobals;
12
+
13
+ var _chalk = _interopRequireDefault(require("chalk"));
14
+
15
+ var _http = _interopRequireDefault(require("http"));
16
+
17
+ var _https = _interopRequireDefault(require("https"));
18
+
19
+ var _loglevel = require("loglevel");
20
+
21
+ var _loglevelPluginPrefix = _interopRequireDefault(require("loglevel-plugin-prefix"));
22
+
23
+ var _os = require("os");
24
+
25
+ var _pngjs = require("pngjs");
26
+
27
+ var _seleniumWebdriver = require("selenium-webdriver");
28
+
29
+ var _capabilities = require("selenium-webdriver/lib/capabilities");
30
+
31
+ var _types = require("../../types");
32
+
33
+ var _logger = require("../logger");
34
+
35
+ var _messages = require("../messages");
36
+
37
+ var _helpers = require("../storybook/helpers");
38
+
39
+ var _utils = require("../utils");
40
+
41
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
42
+
43
+ const storybookRootID = (0, _helpers.isStorybookVersionLessThan)(7) ? 'root' : 'storybook-root';
44
+ const DOCKER_INTERNAL = 'host.docker.internal';
45
+ let browserLogger = _logger.logger;
46
+ let browserName = '';
47
+ let browser = null;
48
+ let creeveyServerHost = null;
49
+
50
+ function getSessionData(grid, sessionId = '') {
51
+ const gridUrl = new URL(grid);
52
+ gridUrl.pathname = `/host/${sessionId}`;
53
+ return new Promise((resolve, reject) => (gridUrl.protocol == 'https:' ? _https.default : _http.default).get(gridUrl.toString(), res => {
54
+ if (res.statusCode !== 200) {
55
+ return reject(new Error(`Couldn't get session data for ${sessionId}. Status code: ${res.statusCode ?? 'Unknown'}`));
56
+ }
57
+
58
+ let data = '';
59
+ res.setEncoding('utf8');
60
+ res.on('data', chunk => data += chunk);
61
+ res.on('end', () => {
62
+ try {
63
+ resolve(JSON.parse(data));
64
+ } catch (error) {
65
+ reject(new Error(`Couldn't get session data for ${sessionId}. ${error instanceof Error ? error.stack ?? error.message : error}`));
66
+ }
67
+ });
68
+ }));
69
+ }
70
+
71
+ function getAddresses() {
72
+ return [DOCKER_INTERNAL].concat(...Object.values((0, _os.networkInterfaces)()).filter(_types.isDefined).map(network => network.filter(info => info.family == 'IPv4').map(info => info.address)));
73
+ }
74
+
75
+ async function resolveStorybookUrl(storybookUrl, checkUrl) {
76
+ browserLogger.debug('Resolving storybook url');
77
+ const addresses = getAddresses();
78
+
79
+ for (const ip of addresses) {
80
+ const resolvedUrl = storybookUrl.replace(_utils.LOCALHOST_REGEXP, ip);
81
+ browserLogger.debug(`Checking storybook availability on ${_chalk.default.magenta(resolvedUrl)}`);
82
+
83
+ if (await checkUrl(resolvedUrl)) {
84
+ browserLogger.debug(`Resolved storybook url ${_chalk.default.magenta(resolvedUrl)}`);
85
+ return resolvedUrl;
86
+ }
87
+ }
88
+
89
+ const error = new Error('Please specify `storybookUrl` with IP address that accessible from remote browser');
90
+ error.name = 'ResolveUrlError';
91
+ throw error;
92
+ }
93
+
94
+ async function openUrlAndWaitForPageSource(browser, url, predicate) {
95
+ let source = '';
96
+ await browser.get(url);
97
+
98
+ do {
99
+ try {
100
+ source = await browser.getPageSource();
101
+ } catch (_) {// NOTE: Firefox can raise exception "curContainer.frame.document.documentElement is null"
102
+ }
103
+ } while (predicate(source));
104
+
105
+ return source;
106
+ }
107
+
108
+ function getUrlChecker(browser) {
109
+ return async url => {
110
+ try {
111
+ // NOTE: Before trying a new url, reset the current one
112
+ browserLogger.debug(`Opening ${_chalk.default.magenta('about:blank')} page`);
113
+ await openUrlAndWaitForPageSource(browser, 'about:blank', source => !source.includes('<body></body>'));
114
+ browserLogger.debug(`Opening ${_chalk.default.magenta(url)} and checking the page source`);
115
+ const source = await openUrlAndWaitForPageSource(browser, url, // NOTE: IE11 can return only `head` without body
116
+ source => source.length == 0 || !/<body([^>]*>).+<\/body>/s.test(source)); // NOTE: This is the most optimal way to check if we in storybook or not
117
+ // We don't use any page load strategies except `NONE`
118
+ // because other add significant delay and some of them don't work in earlier chrome versions
119
+ // Browsers always load page successful even it's failed
120
+ // So we just check `root` element
121
+
122
+ browserLogger.debug(`Checking ${_chalk.default.cyan(`#${storybookRootID}`)} existence on ${_chalk.default.magenta(url)}`);
123
+ return source.includes(`id="${storybookRootID}"`);
124
+ } catch (error) {
125
+ return false;
126
+ }
127
+ };
128
+ }
129
+
130
+ async function waitForStorybook(browser) {
131
+ browserLogger.debug('Waiting for `setStories` event to make sure that storybook is initiated');
132
+ let wait = true;
133
+ let isTimeout = false;
134
+ const Events = await (0, _helpers.importStorybookCoreEvents)();
135
+ const initiateTimeout = setTimeout(() => {
136
+ wait = false;
137
+ isTimeout = true;
138
+ }, 60000);
139
+
140
+ while (wait !== false) {
141
+ if ((0, _helpers.isStorybookVersionLessThan)(7)) {
142
+ wait = await browser.executeAsyncScript(function (SET_STORIES, callback) {
143
+ if (typeof window.__STORYBOOK_ADDONS_CHANNEL__ == 'undefined') return callback(true);
144
+ if (window.__STORYBOOK_ADDONS_CHANNEL__.last(SET_STORIES) == undefined) return callback(true);
145
+ return callback(false);
146
+ }, Events.SET_STORIES);
147
+ } else {
148
+ wait = await browser.executeScript(function (SET_GLOBALS) {
149
+ if (typeof window.__STORYBOOK_ADDONS_CHANNEL__ == 'undefined') return true;
150
+ if (window.__STORYBOOK_ADDONS_CHANNEL__.last(SET_GLOBALS) == undefined) return true;
151
+ return false;
152
+ }, Events.SET_GLOBALS);
153
+ }
154
+
155
+ if (!wait) clearTimeout(initiateTimeout);
156
+ }
157
+
158
+ if (isTimeout) throw new Error('Failed to wait `setStories` event');
159
+ }
160
+
161
+ async function resetMousePosition(browser) {
162
+ var _await$browser$getCap, _await$browser$getCap2;
163
+
164
+ browserLogger.debug('Resetting mouse position to the top-left corner');
165
+ const browserName = (await browser.getCapabilities()).getBrowserName();
166
+ const [browserVersion] = ((_await$browser$getCap = (await browser.getCapabilities()).getBrowserVersion()) === null || _await$browser$getCap === void 0 ? void 0 : _await$browser$getCap.split('.')) ?? ((_await$browser$getCap2 = (await browser.getCapabilities()).get('version')) === null || _await$browser$getCap2 === void 0 ? void 0 : _await$browser$getCap2.split('.')) ?? []; // NOTE Reset mouse position to support keweb selenium grid browser versions
167
+
168
+ if (browserName == 'chrome' && browserVersion == '70') {
169
+ const {
170
+ top,
171
+ left,
172
+ width,
173
+ height
174
+ } = await browser.executeScript(function () {
175
+ const bodyRect = document.body.getBoundingClientRect();
176
+ return {
177
+ top: bodyRect.top,
178
+ left: bodyRect.left,
179
+ width: bodyRect.width,
180
+ height: bodyRect.height
181
+ };
182
+ }); // NOTE Bridge mode doesn't support `Origin.VIEWPORT`, move mouse relative
183
+
184
+ await browser.actions({
185
+ bridge: true
186
+ }).move({
187
+ origin: browser.findElement(_seleniumWebdriver.By.css('body')),
188
+ x: Math.ceil(-1 * width / 2) - left,
189
+ y: Math.ceil(-1 * height / 2) - top
190
+ }).perform();
191
+ } else if (browserName == 'firefox' && browserVersion == '61') {
192
+ // NOTE Firefox for some reason moving by 0 x 0 move cursor in bottom left corner :sad:
193
+ await browser.actions().move({
194
+ origin: _seleniumWebdriver.Origin.VIEWPORT,
195
+ x: 0,
196
+ y: 1
197
+ }).perform();
198
+ } else {
199
+ // NOTE IE don't emit move events until force window focus or connect by RDP on virtual machine
200
+ await browser.actions().move({
201
+ origin: _seleniumWebdriver.Origin.VIEWPORT,
202
+ x: 0,
203
+ y: 0
204
+ }).perform();
205
+ }
206
+ }
207
+
208
+ async function resizeViewport(browser, viewport) {
209
+ const windowRect = await browser.manage().window().getRect();
210
+ const {
211
+ innerWidth,
212
+ innerHeight
213
+ } = await browser.executeScript(function () {
214
+ return {
215
+ innerWidth: window.innerWidth,
216
+ innerHeight: window.innerHeight
217
+ };
218
+ });
219
+ browserLogger.debug(`Resizing viewport from ${innerWidth}x${innerHeight} to ${viewport.width}x${viewport.height}`);
220
+ const dWidth = windowRect.width - innerWidth;
221
+ const dHeight = windowRect.height - innerHeight;
222
+ await browser.manage().window().setRect({
223
+ width: viewport.width + dWidth,
224
+ height: viewport.height + dHeight
225
+ });
226
+ }
227
+
228
+ const getScrollBarWidth = (() => {
229
+ let scrollBarWidth = null;
230
+ return async browser => {
231
+ if (scrollBarWidth != null) return Promise.resolve(scrollBarWidth);
232
+ scrollBarWidth = await browser.executeScript(function () {
233
+ // eslint-disable-next-line no-var
234
+ var div = document.createElement('div');
235
+ div.innerHTML = 'a'; // NOTE: In IE clientWidth is 0 if this div is empty.
236
+
237
+ div.style.overflowY = 'scroll';
238
+ document.body.appendChild(div); // eslint-disable-next-line no-var
239
+
240
+ var widthDiff = div.offsetWidth - div.clientWidth;
241
+ document.body.removeChild(div);
242
+ return widthDiff;
243
+ });
244
+ return scrollBarWidth;
245
+ };
246
+ })(); // NOTE Firefox and Safari take viewport screenshot without scrollbars
247
+
248
+
249
+ async function hasScrollBar(browser) {
250
+ var _await$browser$getCap3;
251
+
252
+ const browserName = (await browser.getCapabilities()).getBrowserName();
253
+ const [browserVersion] = ((_await$browser$getCap3 = (await browser.getCapabilities()).getBrowserVersion()) === null || _await$browser$getCap3 === void 0 ? void 0 : _await$browser$getCap3.split('.')) ?? [];
254
+ return browserName != 'Safari' && // NOTE This need to work with keweb selenium grid
255
+ !(browserName == 'firefox' && browserVersion == '61');
256
+ }
257
+
258
+ async function takeCompositeScreenshot(browser, windowRect, elementRect) {
259
+ const screens = [];
260
+ const isScreenshotWithoutScrollBar = !(await hasScrollBar(browser));
261
+ const scrollBarWidth = await getScrollBarWidth(browser); // NOTE Sometimes viewport has been scrolled somewhere
262
+
263
+ const normalizedElementRect = {
264
+ left: elementRect.left - windowRect.left,
265
+ right: elementRect.left + elementRect.width - windowRect.left,
266
+ top: elementRect.top - windowRect.top,
267
+ bottom: elementRect.top + elementRect.height - windowRect.top
268
+ };
269
+ const isFitHorizontally = windowRect.width >= elementRect.width + normalizedElementRect.left;
270
+ const isFitVertically = windowRect.height >= elementRect.height + normalizedElementRect.top;
271
+ const viewportWidth = windowRect.width - (isFitVertically ? 0 : scrollBarWidth);
272
+ const viewportHeight = windowRect.height - (isFitHorizontally ? 0 : scrollBarWidth);
273
+ const cols = Math.ceil(elementRect.width / viewportWidth);
274
+ const rows = Math.ceil(elementRect.height / viewportHeight);
275
+ const xOffset = Math.round(isFitHorizontally ? normalizedElementRect.left : Math.max(0, cols * viewportWidth - elementRect.width));
276
+ const yOffset = Math.round(isFitVertically ? normalizedElementRect.top : Math.max(0, rows * viewportHeight - elementRect.height));
277
+
278
+ for (let row = 0; row < rows; row += 1) {
279
+ for (let col = 0; col < cols; col += 1) {
280
+ const dx = Math.min(viewportWidth * col + normalizedElementRect.left, Math.max(0, normalizedElementRect.right - viewportWidth));
281
+ const dy = Math.min(viewportHeight * row + normalizedElementRect.top, Math.max(0, normalizedElementRect.bottom - viewportHeight));
282
+ await browser.executeScript(function (x, y) {
283
+ window.scrollTo(x, y);
284
+ }, dx, dy);
285
+ screens.push(await browser.takeScreenshot());
286
+ }
287
+ }
288
+
289
+ const images = screens.map(s => Buffer.from(s, 'base64')).map(b => _pngjs.PNG.sync.read(b));
290
+ const compositeImage = new _pngjs.PNG({
291
+ width: Math.round(elementRect.width),
292
+ height: Math.round(elementRect.height)
293
+ });
294
+
295
+ for (let y = 0; y < compositeImage.height; y += 1) {
296
+ for (let x = 0; x < compositeImage.width; x += 1) {
297
+ const col = Math.floor(x / viewportWidth);
298
+ const row = Math.floor(y / viewportHeight);
299
+ const isLastCol = cols - col == 1;
300
+ const isLastRow = rows - row == 1;
301
+ const scrollOffset = isFitVertically || isScreenshotWithoutScrollBar ? 0 : scrollBarWidth;
302
+ const i = (y * compositeImage.width + x) * 4;
303
+ const j = // NOTE compositeImage(x, y) => image(x, y)
304
+ (y % viewportHeight * (viewportWidth + scrollOffset) + x % viewportWidth) * 4 + ( // NOTE Offset for last row/col image
305
+ isLastRow ? yOffset * (viewportWidth + scrollOffset) * 4 : 0) + (isLastCol ? xOffset * 4 : 0);
306
+ const image = images[row * cols + col];
307
+ compositeImage.data[i + 0] = image.data[j + 0];
308
+ compositeImage.data[i + 1] = image.data[j + 1];
309
+ compositeImage.data[i + 2] = image.data[j + 2];
310
+ compositeImage.data[i + 3] = image.data[j + 3];
311
+ }
312
+ }
313
+
314
+ return _pngjs.PNG.sync.write(compositeImage).toString('base64');
315
+ }
316
+
317
+ async function takeScreenshot(browser, captureElement, ignoreElements) {
318
+ let screenshot;
319
+ const ignoreStyles = await insertIgnoreStyles(browser, ignoreElements);
320
+
321
+ try {
322
+ if (!captureElement) {
323
+ browserLogger.debug('Capturing viewport screenshot');
324
+ screenshot = await browser.takeScreenshot();
325
+ browserLogger.debug('Viewport screenshot is captured');
326
+ } else {
327
+ browserLogger.debug(`Checking is element ${_chalk.default.cyan(captureElement)} fit into viewport`);
328
+ const rects = await browser.executeScript(function (selector) {
329
+ window.scrollTo(0, 0); // TODO Maybe we should remove same code from `resetMousePosition`
330
+ // eslint-disable-next-line no-var
331
+
332
+ var element = document.querySelector(selector);
333
+ if (!element) return; // eslint-disable-next-line no-var
334
+
335
+ var elementRect = element.getBoundingClientRect();
336
+ return {
337
+ elementRect: {
338
+ top: elementRect.top,
339
+ left: elementRect.left,
340
+ width: elementRect.width,
341
+ height: elementRect.height
342
+ },
343
+ windowRect: {
344
+ top: Math.round(window.scrollY || window.pageYOffset),
345
+ left: Math.round(window.scrollX || window.pageXOffset),
346
+ width: window.innerWidth,
347
+ height: window.innerHeight
348
+ }
349
+ };
350
+ }, captureElement);
351
+ const {
352
+ elementRect,
353
+ windowRect
354
+ } = rects ?? {};
355
+ if (!elementRect || !windowRect) throw new Error(`Couldn't find element with selector: '${captureElement}'`);
356
+ const isFitIntoViewport = elementRect.width + elementRect.left <= windowRect.width && elementRect.height + elementRect.top <= windowRect.height;
357
+ if (isFitIntoViewport) browserLogger.debug(`Capturing ${_chalk.default.cyan(captureElement)}`);else browserLogger.debug(`Capturing composite screenshot image of ${_chalk.default.cyan(captureElement)}`);
358
+ screenshot = isFitIntoViewport ? await browser.findElement(_seleniumWebdriver.By.css(captureElement)).takeScreenshot() : // TODO pointer-events: none, need to research
359
+ await takeCompositeScreenshot(browser, windowRect, elementRect);
360
+ browserLogger.debug(`${_chalk.default.cyan(captureElement)} is captured`);
361
+ }
362
+ } finally {
363
+ await removeIgnoreStyles(browser, ignoreStyles);
364
+ }
365
+
366
+ return screenshot;
367
+ }
368
+
369
+ async function selectStory(browser, {
370
+ id,
371
+ kind,
372
+ name
373
+ }, waitForReady = false) {
374
+ browserLogger.debug(`Triggering 'SetCurrentStory' event with storyId ${_chalk.default.magenta(id)}`);
375
+ const result = await browser.executeAsyncScript(function (id, kind, name, shouldWaitForReady, callback) {
376
+ if (typeof window.__CREEVEY_SELECT_STORY__ == 'undefined') {
377
+ return callback(["Creevey can't switch story. This may happened if forget to add `creevey` addon to your storybook config, or storybook not loaded in browser due syntax error."]);
378
+ }
379
+
380
+ void window.__CREEVEY_SELECT_STORY__(id, kind, name, shouldWaitForReady, callback);
381
+ }, id, kind, name, waitForReady);
382
+ const [errorMessage, isCaptureCalled = false] = result ?? [];
383
+ if (errorMessage) throw new Error(errorMessage);
384
+ return isCaptureCalled;
385
+ }
386
+
387
+ async function updateStorybookGlobals(browser, globals) {
388
+ browserLogger.debug('Applying storybook globals');
389
+ await browser.executeScript(function (globals) {
390
+ window.__CREEVEY_UPDATE_GLOBALS__(globals);
391
+ }, globals);
392
+ }
393
+
394
+ function appendIframePath(url) {
395
+ return `${url.replace(/\/$/, '')}/iframe.html`;
396
+ }
397
+
398
+ async function openStorybookPage(browser, storybookUrl, resolver) {
399
+ if (!_utils.LOCALHOST_REGEXP.test(storybookUrl)) {
400
+ return browser === null || browser === void 0 ? void 0 : browser.get(appendIframePath(storybookUrl));
401
+ }
402
+
403
+ try {
404
+ if (resolver) {
405
+ browserLogger.debug('Resolving storybook url with custom resolver');
406
+ const resolvedUrl = await resolver();
407
+ browserLogger.debug(`Resolver storybook url ${resolvedUrl}`);
408
+ return browser.get(appendIframePath(resolvedUrl));
409
+ } // NOTE: getUrlChecker already calls `browser.get` so we don't need another one
410
+
411
+
412
+ return void (await resolveStorybookUrl(appendIframePath(storybookUrl), getUrlChecker(browser)));
413
+ } catch (error) {
414
+ browserLogger.error('Failed to resolve storybook URL', error instanceof Error ? error.message : '');
415
+ throw error;
416
+ }
417
+ }
418
+
419
+ async function resolveCreeveyHost(browser, port) {
420
+ if (creeveyServerHost != null) return creeveyServerHost;
421
+ const addresses = getAddresses();
422
+ creeveyServerHost = await browser.executeAsyncScript(function (hosts, port, callback) {
423
+ void Promise.all(hosts.map(function (host) {
424
+ return Promise.race([// eslint-disable-next-line @typescript-eslint/restrict-plus-operands
425
+ fetch('http://' + host + ':' + port + '/ping').then(function (response) {
426
+ return response.text();
427
+ }), new Promise((_resolve, reject) => {
428
+ setTimeout(reject, 5000);
429
+ })]).then(function (pong) {
430
+ return pong == 'pong' ? host : null;
431
+ }).catch(function () {
432
+ return null;
433
+ });
434
+ })).then(function (hosts) {
435
+ callback(hosts.find(function (host) {
436
+ return host != null;
437
+ }));
438
+ });
439
+ }, addresses, port);
440
+ if (creeveyServerHost == null) throw new Error("Can't reach creevey server from a browser");
441
+ return creeveyServerHost;
442
+ }
443
+
444
+ async function loadStoriesFromBrowser() {
445
+ if (!browser) throw new Error("Can't get stories from browser if webdriver isn't connected");
446
+ const stories = await browser.executeAsyncScript(function (callback) {
447
+ void window.__CREEVEY_GET_STORIES__().then(callback);
448
+ });
449
+ if (!stories) throw new Error("Can't get stories, it seems creevey or storybook API isn't available");
450
+ return stories;
451
+ }
452
+
453
+ async function getBrowser(config, options) {
454
+ if (browser) return browser;
455
+ browserName = options.browser;
456
+ const browserConfig = config.browsers[browserName];
457
+ const {
458
+ gridUrl = config.gridUrl,
459
+ storybookUrl: address = config.storybookUrl,
460
+ limit,
461
+ viewport,
462
+ _storybookGlobals,
463
+ ...userCapabilities
464
+ } = browserConfig;
465
+ void limit;
466
+ const realAddress = address; // TODO Define some capabilities explicitly and define typings
467
+
468
+ const capabilities = new _seleniumWebdriver.Capabilities({ ...userCapabilities,
469
+ pageLoadStrategy: _capabilities.PageLoadStrategy.NONE
470
+ });
471
+ (0, _messages.subscribeOn)('shutdown', () => {
472
+ var _browser;
473
+
474
+ (_browser = browser) === null || _browser === void 0 ? void 0 : _browser.quit().finally(() => // eslint-disable-next-line no-process-exit
475
+ process.exit());
476
+ browser = null;
477
+ });
478
+
479
+ try {
480
+ var _await$browser$getSes;
481
+
482
+ const url = new URL(gridUrl);
483
+ url.username = url.username ? '********' : '';
484
+ url.password = url.password ? '********' : '';
485
+ browserLogger.debug(`(${browserName}) Connecting to Selenium ${_chalk.default.magenta(url.toString())}`);
486
+ browser = await new _seleniumWebdriver.Builder().usingServer(gridUrl).withCapabilities(capabilities).build();
487
+ const sessionId = (_await$browser$getSes = await browser.getSession()) === null || _await$browser$getSes === void 0 ? void 0 : _await$browser$getSes.getId();
488
+ let browserHost = '';
489
+
490
+ try {
491
+ const {
492
+ Name
493
+ } = await getSessionData(gridUrl, sessionId);
494
+ if (typeof Name == 'string') browserHost = Name;
495
+ } catch (_) {
496
+ /* noop */
497
+ }
498
+
499
+ browserLogger.debug(`(${browserName}) Connected successful with ${[_chalk.default.green(browserHost), _chalk.default.magenta(sessionId)].filter(Boolean).join(':')}`);
500
+ browserLogger = (0, _loglevel.getLogger)(sessionId);
501
+
502
+ _loglevelPluginPrefix.default.apply(browserLogger, {
503
+ format(level) {
504
+ const levelColor = _logger.colors[level.toUpperCase()];
505
+
506
+ return `[${browserName}:${_chalk.default.gray(sessionId)}] ${levelColor(level)} =>`;
507
+ }
508
+
509
+ });
510
+
511
+ await (0, _utils.runSequence)([() => {
512
+ var _browser2;
513
+
514
+ return (_browser2 = browser) === null || _browser2 === void 0 ? void 0 : _browser2.manage().setTimeouts({
515
+ pageLoad: 5000,
516
+ script: 60000
517
+ });
518
+ }, () => viewport && browser && resizeViewport(browser, viewport), () => browser && openStorybookPage(browser, realAddress, config.resolveStorybookUrl), () => browser && waitForStorybook(browser)], () => !_utils.isShuttingDown.current);
519
+ } catch (originalError) {
520
+ var _browser4;
521
+
522
+ if (_utils.isShuttingDown.current) {
523
+ var _browser3;
524
+
525
+ (_browser3 = browser) === null || _browser3 === void 0 ? void 0 : _browser3.quit().catch(_types.noop);
526
+ browser = null;
527
+ return null;
528
+ }
529
+
530
+ if (originalError instanceof Error && originalError.name == 'ResolveUrlError') throw originalError;
531
+ const error = new Error(`Can't load storybook root page by URL ${(await ((_browser4 = browser) === null || _browser4 === void 0 ? void 0 : _browser4.getCurrentUrl())) ?? realAddress}`);
532
+ if (originalError instanceof Error) error.stack = originalError.stack;
533
+ throw error;
534
+ }
535
+
536
+ if (_storybookGlobals) {
537
+ await updateStorybookGlobals(browser, _storybookGlobals);
538
+ }
539
+
540
+ const creeveyHost = await resolveCreeveyHost(browser, options.port);
541
+ await browser.executeScript(function (workerId, creeveyHost, creeveyPort) {
542
+ window.__CREEVEY_WORKER_ID__ = workerId;
543
+ window.__CREEVEY_SERVER_HOST__ = creeveyHost;
544
+ window.__CREEVEY_SERVER_PORT__ = creeveyPort;
545
+ }, process.pid, creeveyHost, options.port);
546
+ return browser;
547
+ }
548
+
549
+ async function updateStoryArgs(browser, story, updatedArgs) {
550
+ const Events = await (0, _helpers.importStorybookCoreEvents)();
551
+ await browser.executeAsyncScript(function (storyId, updatedArgs, UPDATE_STORY_ARGS, STORY_RENDERED, callback) {
552
+ window.__STORYBOOK_ADDONS_CHANNEL__.once(STORY_RENDERED, callback);
553
+
554
+ window.__STORYBOOK_ADDONS_CHANNEL__.emit(UPDATE_STORY_ARGS, {
555
+ storyId,
556
+ updatedArgs
557
+ });
558
+ }, story.id, updatedArgs, Events.UPDATE_STORY_ARGS, Events.STORY_RENDERED);
559
+ }
560
+
561
+ async function closeBrowser() {
562
+ if (!browser) return;
563
+
564
+ try {
565
+ await browser.quit();
566
+ } finally {
567
+ browser = null;
568
+ }
569
+ }
570
+
571
+ async function switchStory() {
572
+ var _this$currentTest, _this$currentTest$ctx;
573
+
574
+ let testOrSuite = this.currentTest;
575
+ if (!testOrSuite) throw new Error("Can't switch story, because test context doesn't have 'currentTest' field");
576
+ this.testScope.length = 0;
577
+ this.screenshots.length = 0;
578
+ this.testScope.push(this.browserName);
579
+
580
+ while ((_testOrSuite = testOrSuite) !== null && _testOrSuite !== void 0 && _testOrSuite.title) {
581
+ var _testOrSuite;
582
+
583
+ this.testScope.push(testOrSuite.title);
584
+ testOrSuite = testOrSuite.parent;
585
+ }
586
+
587
+ const story = (_this$currentTest = this.currentTest) === null || _this$currentTest === void 0 ? void 0 : (_this$currentTest$ctx = _this$currentTest.ctx) === null || _this$currentTest$ctx === void 0 ? void 0 : _this$currentTest$ctx.story;
588
+ if (!story) throw new Error(`Current test '${this.testScope.join('/')}' context doesn't have 'story' field`);
589
+ const {
590
+ id,
591
+ kind,
592
+ name,
593
+ parameters
594
+ } = story;
595
+ const {
596
+ captureElement = `#${storybookRootID}`,
597
+ waitForReady,
598
+ ignoreElements
599
+ } = parameters.creevey ?? {};
600
+ browserLogger.debug(`Switching to story ${_chalk.default.cyan(kind)}/${_chalk.default.cyan(name)} by id ${_chalk.default.magenta(id)}`);
601
+ if (captureElement) Object.defineProperty(this, 'captureElement', {
602
+ enumerable: true,
603
+ configurable: true,
604
+ get: () => this.browser.findElement(_seleniumWebdriver.By.css(captureElement))
605
+ });else Reflect.deleteProperty(this, 'captureElement');
606
+
607
+ this.takeScreenshot = () => takeScreenshot(this.browser, captureElement, ignoreElements);
608
+
609
+ this.updateStoryArgs = updatedArgs => updateStoryArgs(this.browser, story, updatedArgs);
610
+
611
+ this.testScope.reverse();
612
+ let storyPlayResolver;
613
+ let waitForComplete = new Promise(resolve => storyPlayResolver = resolve);
614
+ const unsubscribe = (0, _messages.subscribeOn)('stories', message => {
615
+ if (message.type != 'capture') return;
616
+ const {
617
+ payload = {},
618
+ payload: {
619
+ imageName
620
+ } = {}
621
+ } = message;
622
+ void takeScreenshot(this.browser, payload.captureElement ?? captureElement, payload.ignoreElements ?? ignoreElements).then(screenshot => {
623
+ this.screenshots.push({
624
+ imageName,
625
+ screenshot
626
+ });
627
+ void this.browser.executeAsyncScript(function (callback) {
628
+ window.__CREEVEY_HAS_PLAY_COMPLETED_YET__(callback);
629
+ }).then(isCompleted => storyPlayResolver(isCompleted));
630
+ (0, _messages.emitStoriesMessage)({
631
+ type: 'capture'
632
+ });
633
+ });
634
+ });
635
+ await resetMousePosition(this.browser);
636
+ const isCaptureCalled = await selectStory(this.browser, {
637
+ id,
638
+ kind,
639
+ name
640
+ }, waitForReady);
641
+
642
+ if (isCaptureCalled) {
643
+ while (!(await waitForComplete)) {
644
+ waitForComplete = new Promise(resolve => storyPlayResolver = resolve);
645
+ }
646
+ }
647
+
648
+ unsubscribe();
649
+ browserLogger.debug(`Story ${_chalk.default.magenta(id)} ready for capturing`);
650
+ }
651
+
652
+ async function insertIgnoreStyles(browser, ignoreElements) {
653
+ const ignoreSelectors = Array.prototype.concat(ignoreElements).filter(Boolean);
654
+ if (!ignoreSelectors.length) return null;
655
+ browserLogger.debug('Hiding ignored elements before capturing');
656
+ return await browser.executeScript(function (ignoreSelectors) {
657
+ return window.__CREEVEY_INSERT_IGNORE_STYLES__(ignoreSelectors);
658
+ }, ignoreSelectors);
659
+ }
660
+
661
+ async function removeIgnoreStyles(browser, ignoreStyles) {
662
+ if (ignoreStyles) {
663
+ browserLogger.debug('Revert hiding ignored elements');
664
+ await browser.executeScript(function (ignoreStyles) {
665
+ window.__CREEVEY_REMOVE_IGNORE_STYLES__(ignoreStyles);
666
+ }, ignoreStyles);
667
+ }
668
+ }
package/lib/cjs/server/selenium/index.js ADDED
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+
7
+ var _browser = require("./browser");
8
+
9
+ Object.keys(_browser).forEach(function (key) {
10
+ if (key === "default" || key === "__esModule") return;
11
+ if (key in exports && exports[key] === _browser[key]) return;
12
+ Object.defineProperty(exports, key, {
13
+ enumerable: true,
14
+ get: function () {
15
+ return _browser[key];
16
+ }
17
+ });
18
+ });
19
+
20
+ var _selenoid = require("./selenoid");
21
+
22
+ Object.keys(_selenoid).forEach(function (key) {
23
+ if (key === "default" || key === "__esModule") return;
24
+ if (key in exports && exports[key] === _selenoid[key]) return;
25
+ Object.defineProperty(exports, key, {
26
+ enumerable: true,
27
+ get: function () {
28
+ return _selenoid[key];
29
+ }
30
+ });
31
+ });