creevey 0.8.1-beta.1 → 0.8.1-sb7.1

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