creevey 0.10.0-beta.2 → 0.10.0-beta.20

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 (176) hide show
  1. package/dist/client/addon/components/Addon.js +17 -7
  2. package/dist/client/addon/components/Addon.js.map +1 -1
  3. package/dist/client/addon/components/Panel.js +2 -2
  4. package/dist/client/addon/components/Panel.js.map +1 -1
  5. package/dist/client/addon/components/Tools.js +17 -7
  6. package/dist/client/addon/components/Tools.js.map +1 -1
  7. package/dist/client/addon/controller.js +4 -5
  8. package/dist/client/addon/controller.js.map +1 -1
  9. package/dist/client/addon/withCreevey.d.ts +1 -0
  10. package/dist/client/addon/withCreevey.js +19 -34
  11. package/dist/client/addon/withCreevey.js.map +1 -1
  12. package/dist/client/shared/components/ImagesView/BlendView.js +17 -7
  13. package/dist/client/shared/components/ImagesView/BlendView.js.map +1 -1
  14. package/dist/client/shared/components/ImagesView/SideBySideView.js +17 -7
  15. package/dist/client/shared/components/ImagesView/SideBySideView.js.map +1 -1
  16. package/dist/client/shared/components/ImagesView/SlideView.js +17 -7
  17. package/dist/client/shared/components/ImagesView/SlideView.js.map +1 -1
  18. package/dist/client/shared/components/ImagesView/SwapView.js +29 -7
  19. package/dist/client/shared/components/ImagesView/SwapView.js.map +1 -1
  20. package/dist/client/shared/components/PageHeader/ImagePreview.js +1 -0
  21. package/dist/client/shared/components/PageHeader/ImagePreview.js.map +1 -1
  22. package/dist/client/shared/components/PageHeader/PageHeader.js +17 -7
  23. package/dist/client/shared/components/PageHeader/PageHeader.js.map +1 -1
  24. package/dist/client/shared/components/ResultsPage.js +40 -12
  25. package/dist/client/shared/components/ResultsPage.js.map +1 -1
  26. package/dist/client/shared/helpers.d.ts +0 -2
  27. package/dist/client/shared/helpers.js +0 -17
  28. package/dist/client/shared/helpers.js.map +1 -1
  29. package/dist/client/web/CreeveyApp.js +41 -14
  30. package/dist/client/web/CreeveyApp.js.map +1 -1
  31. package/dist/client/web/CreeveyContext.d.ts +5 -0
  32. package/dist/client/web/CreeveyContext.js +20 -7
  33. package/dist/client/web/CreeveyContext.js.map +1 -1
  34. package/dist/client/web/CreeveyLoader.js +2 -2
  35. package/dist/client/web/CreeveyLoader.js.map +1 -1
  36. package/dist/client/web/CreeveyView/SideBar/Search.js +19 -9
  37. package/dist/client/web/CreeveyView/SideBar/Search.js.map +1 -1
  38. package/dist/client/web/CreeveyView/SideBar/SideBar.js +18 -7
  39. package/dist/client/web/CreeveyView/SideBar/SideBar.js.map +1 -1
  40. package/dist/client/web/CreeveyView/SideBar/SideBarFooter.js +60 -7
  41. package/dist/client/web/CreeveyView/SideBar/SideBarFooter.js.map +1 -1
  42. package/dist/client/web/CreeveyView/SideBar/SideBarHeader.js +17 -7
  43. package/dist/client/web/CreeveyView/SideBar/SideBarHeader.js.map +1 -1
  44. package/dist/client/web/CreeveyView/SideBar/SuiteLink.js +18 -10
  45. package/dist/client/web/CreeveyView/SideBar/SuiteLink.js.map +1 -1
  46. package/dist/client/web/CreeveyView/SideBar/TestLink.js +18 -10
  47. package/dist/client/web/CreeveyView/SideBar/TestLink.js.map +1 -1
  48. package/dist/client/web/KeyboardEventsContext.d.ts +1 -8
  49. package/dist/client/web/KeyboardEventsContext.js +79 -64
  50. package/dist/client/web/KeyboardEventsContext.js.map +1 -1
  51. package/dist/client/web/assets/{index-DkmZfG9C.js → index-BZNmck5a.js} +104 -104
  52. package/dist/client/web/index.html +1 -1
  53. package/dist/client/web/index.js +17 -7
  54. package/dist/client/web/index.js.map +1 -1
  55. package/dist/client/web/themes.d.ts +2 -0
  56. package/dist/client/web/themes.js +22 -0
  57. package/dist/client/web/themes.js.map +1 -0
  58. package/dist/creevey.js +13 -5
  59. package/dist/creevey.js.map +1 -1
  60. package/dist/index.d.ts +1 -0
  61. package/dist/server/config.js +5 -4
  62. package/dist/server/config.js.map +1 -1
  63. package/dist/server/docker.js +37 -20
  64. package/dist/server/docker.js.map +1 -1
  65. package/dist/server/index.js +33 -7
  66. package/dist/server/index.js.map +1 -1
  67. package/dist/server/logger.d.ts +2 -1
  68. package/dist/server/logger.js +7 -3
  69. package/dist/server/logger.js.map +1 -1
  70. package/dist/server/master/api.js +1 -1
  71. package/dist/server/master/api.js.map +1 -1
  72. package/dist/server/master/pool.d.ts +3 -3
  73. package/dist/server/master/pool.js +10 -63
  74. package/dist/server/master/pool.js.map +1 -1
  75. package/dist/server/master/queue.d.ts +13 -0
  76. package/dist/server/master/queue.js +64 -0
  77. package/dist/server/master/queue.js.map +1 -0
  78. package/dist/server/master/runner.d.ts +1 -0
  79. package/dist/server/master/runner.js +4 -1
  80. package/dist/server/master/runner.js.map +1 -1
  81. package/dist/server/master/server.js +1 -1
  82. package/dist/server/master/server.js.map +1 -1
  83. package/dist/server/master/start.js +10 -9
  84. package/dist/server/master/start.js.map +1 -1
  85. package/dist/server/playwright/docker-file.d.ts +2 -1
  86. package/dist/server/playwright/docker-file.js +17 -4
  87. package/dist/server/playwright/docker-file.js.map +1 -1
  88. package/dist/server/playwright/internal.d.ts +2 -2
  89. package/dist/server/playwright/internal.js +57 -44
  90. package/dist/server/playwright/internal.js.map +1 -1
  91. package/dist/server/playwright/webdriver.d.ts +1 -1
  92. package/dist/server/playwright/webdriver.js +1 -1
  93. package/dist/server/playwright/webdriver.js.map +1 -1
  94. package/dist/server/providers/browser.js +6 -4
  95. package/dist/server/providers/browser.js.map +1 -1
  96. package/dist/server/providers/hybrid.js +1 -1
  97. package/dist/server/providers/hybrid.js.map +1 -1
  98. package/dist/server/reporter.js +13 -9
  99. package/dist/server/reporter.js.map +1 -1
  100. package/dist/server/selenium/internal.d.ts +3 -4
  101. package/dist/server/selenium/internal.js +127 -91
  102. package/dist/server/selenium/internal.js.map +1 -1
  103. package/dist/server/selenium/selenoid.js +2 -2
  104. package/dist/server/selenium/selenoid.js.map +1 -1
  105. package/dist/server/selenium/webdriver.d.ts +1 -1
  106. package/dist/server/selenium/webdriver.js +1 -1
  107. package/dist/server/selenium/webdriver.js.map +1 -1
  108. package/dist/server/telemetry.js +7 -3
  109. package/dist/server/telemetry.js.map +1 -1
  110. package/dist/server/utils.d.ts +2 -1
  111. package/dist/server/utils.js +13 -3
  112. package/dist/server/utils.js.map +1 -1
  113. package/dist/server/webdriver.d.ts +3 -4
  114. package/dist/server/webdriver.js +10 -9
  115. package/dist/server/webdriver.js.map +1 -1
  116. package/dist/server/worker/chai-image.d.ts +1 -2
  117. package/dist/server/worker/chai-image.js +4 -3
  118. package/dist/server/worker/chai-image.js.map +1 -1
  119. package/dist/server/worker/match-image.d.ts +4 -4
  120. package/dist/server/worker/match-image.js +7 -4
  121. package/dist/server/worker/match-image.js.map +1 -1
  122. package/dist/server/worker/start.js +24 -14
  123. package/dist/server/worker/start.js.map +1 -1
  124. package/dist/shared/index.d.ts +1 -1
  125. package/dist/types.d.ts +32 -13
  126. package/dist/types.js +13 -1
  127. package/dist/types.js.map +1 -1
  128. package/package.json +55 -59
  129. package/src/client/addon/components/Panel.tsx +2 -2
  130. package/src/client/addon/controller.ts +13 -6
  131. package/src/client/addon/withCreevey.ts +27 -13
  132. package/src/client/shared/components/ImagesView/SwapView.tsx +18 -0
  133. package/src/client/shared/components/PageHeader/ImagePreview.tsx +1 -0
  134. package/src/client/shared/components/ResultsPage.tsx +28 -7
  135. package/src/client/shared/helpers.ts +0 -22
  136. package/src/client/web/CreeveyApp.tsx +26 -8
  137. package/src/client/web/CreeveyContext.tsx +9 -0
  138. package/src/client/web/CreeveyLoader.tsx +1 -1
  139. package/src/client/web/CreeveyView/SideBar/Search.tsx +3 -3
  140. package/src/client/web/CreeveyView/SideBar/SideBar.tsx +1 -0
  141. package/src/client/web/CreeveyView/SideBar/SideBarFooter.tsx +37 -6
  142. package/src/client/web/CreeveyView/SideBar/SuiteLink.tsx +3 -5
  143. package/src/client/web/CreeveyView/SideBar/TestLink.tsx +2 -4
  144. package/src/client/web/KeyboardEventsContext.tsx +61 -73
  145. package/src/client/web/themes.ts +24 -0
  146. package/src/creevey.ts +13 -6
  147. package/src/server/config.ts +5 -4
  148. package/src/server/docker.ts +41 -23
  149. package/src/server/index.ts +35 -9
  150. package/src/server/logger.ts +6 -2
  151. package/src/server/master/api.ts +1 -1
  152. package/src/server/master/pool.ts +18 -56
  153. package/src/server/master/queue.ts +64 -0
  154. package/src/server/master/runner.ts +4 -1
  155. package/src/server/master/server.ts +1 -1
  156. package/src/server/master/start.ts +13 -9
  157. package/src/server/playwright/docker-file.ts +19 -4
  158. package/src/server/playwright/internal.ts +77 -49
  159. package/src/server/playwright/webdriver.ts +2 -2
  160. package/src/server/providers/browser.ts +6 -4
  161. package/src/server/providers/hybrid.ts +1 -1
  162. package/src/server/reporter.ts +15 -9
  163. package/src/server/selenium/internal.ts +133 -96
  164. package/src/server/selenium/selenoid.ts +2 -2
  165. package/src/server/selenium/webdriver.ts +2 -2
  166. package/src/server/telemetry.ts +7 -3
  167. package/src/server/utils.ts +14 -4
  168. package/src/server/webdriver.ts +11 -16
  169. package/src/server/worker/chai-image.ts +4 -4
  170. package/src/server/worker/match-image.ts +12 -8
  171. package/src/server/worker/start.ts +25 -16
  172. package/src/shared/index.ts +1 -1
  173. package/src/types.ts +35 -15
  174. package/types/global.d.ts +1 -0
  175. package/.yarnrc.yml +0 -1
  176. package/chromatic.config.json +0 -5
@@ -11,17 +11,17 @@ import {
11
11
  getTestByPath,
12
12
  removeTests,
13
13
  getTestPath,
14
- useTheme,
15
14
  setSearchParams,
16
15
  getTestPathFromSearch,
17
16
  CreeveyViewFilter,
18
17
  getFailedTests,
19
18
  } from '../shared/helpers.js';
20
- import { CreeveyContext } from './CreeveyContext.js';
19
+ import { CreeveyContext, FocusableItem } from './CreeveyContext.js';
21
20
  import { KeyboardEvents } from './KeyboardEventsContext.js';
22
21
  import { SideBar } from './CreeveyView/SideBar/index.js';
23
22
  import { ResultsPage } from '../shared/components/ResultsPage.js';
24
23
  import { Toggle } from './CreeveyView/SideBar/Toggle.js';
24
+ import { useTheme } from './themes.js';
25
25
 
26
26
  export interface CreeveyAppProps {
27
27
  api?: CreeveyClientApi;
@@ -59,8 +59,9 @@ export function CreeveyApp({ api, initialState }: CreeveyAppProps): JSX.Element
59
59
  const failedTests = useMemo(() => getFailedTests(tests), [tests]);
60
60
 
61
61
  const [retry, setRetry] = useState(openedTest?.results?.length ?? 0);
62
- const result = openedTest?.results?.[retry - 1] ?? { images: {} };
63
- const [imageName, setImageName] = useState(Object.keys(result.images ?? {})[0] ?? '');
62
+ const result = useMemo(() => openedTest?.results?.[retry - 1], [openedTest, retry]);
63
+ const [imageName, setImageName] = useState(Object.keys(result?.images ?? {})[0] ?? '');
64
+ const [sidebarFocusedItem, setSidebarFocusedItem] = useState<FocusableItem>([]);
64
65
  const canApprove = useMemo(
65
66
  () =>
66
67
  Boolean(
@@ -94,6 +95,7 @@ export function CreeveyApp({ api, initialState }: CreeveyAppProps): JSX.Element
94
95
  (test: CreeveyTest): void => {
95
96
  const testPath = getTestPath(test);
96
97
  setSearchParams(testPath);
98
+ setSidebarFocusedItem(testPath);
97
99
  updateTests((draft) => {
98
100
  openSuite(draft, testPath, true);
99
101
  openTest(testPath);
@@ -103,11 +105,24 @@ export function CreeveyApp({ api, initialState }: CreeveyAppProps): JSX.Element
103
105
  );
104
106
 
105
107
  const handleGoToNextFailedTest = useCallback(() => {
106
- if (failedTests.length <= 1) return;
108
+ if (failedTests.length == 0) return;
107
109
  const currentTest = failedTests.findIndex((t) => t.id === openedTest?.id);
108
- const nextFailedTest = failedTests[currentTest + 1] || failedTests[0];
109
- handleOpenTest(nextFailedTest);
110
- }, [failedTests, handleOpenTest, openedTest?.id]);
110
+ const failedImages = Object.entries(result?.images ?? {})
111
+ .filter(([name, image]) =>
112
+ // TODO Move to helpers, it duplicates in a few places
113
+ Boolean(image?.error != null && openedTest?.approved?.[name] != retry - 1 && result?.status != 'success'),
114
+ )
115
+ .map(([name]) => name);
116
+ if (
117
+ failedImages.length > 1 &&
118
+ (failedTests.length == 1 || failedImages.indexOf(imageName) < failedImages.length - 1)
119
+ ) {
120
+ setImageName((name) => failedImages[failedImages.indexOf(name) + 1] ?? failedImages[0]);
121
+ } else {
122
+ const nextFailedTest = failedTests[currentTest + 1] ?? failedTests[0];
123
+ handleOpenTest(nextFailedTest);
124
+ }
125
+ }, [failedTests, handleOpenTest, openedTest, retry, result, imageName]);
111
126
 
112
127
  const handleImageApproveNew = useCallback((): void => {
113
128
  const id = openedTest?.id;
@@ -189,12 +204,15 @@ export function CreeveyApp({ api, initialState }: CreeveyAppProps): JSX.Element
189
204
  value={{
190
205
  isReport: initialState.isReport,
191
206
  isRunning,
207
+ onImageNext: canApprove ? handleGoToNextFailedTest : undefined,
192
208
  onImageApprove: canApprove ? handleImageApproveAndGoNext : undefined,
193
209
  onApproveAll: handleApproveAll,
194
210
  onStart: handleStart,
195
211
  onStop: handleStop,
196
212
  onSuiteOpen: handleSuiteOpen,
197
213
  onSuiteToggle: handleSuiteToggle,
214
+ sidebarFocusedItem,
215
+ setSidebarFocusedItem,
198
216
  }}
199
217
  >
200
218
  <ThemeProvider theme={ensure(themes[theme])}>
@@ -1,26 +1,35 @@
1
1
  import React, { useContext } from 'react';
2
2
  import { CreeveySuite, noop } from '../../types.js';
3
3
 
4
+ export type SuitePath = string[];
5
+ export type FocusableItem = null | SuitePath;
6
+
4
7
  export interface CreeveyContextType {
5
8
  isReport: boolean;
6
9
  isRunning: boolean;
7
10
  onStop: () => void;
11
+ onImageNext?: () => void;
8
12
  onImageApprove?: () => void;
9
13
  onApproveAll: () => void;
10
14
  onStart: (rootSuite: CreeveySuite) => void;
11
15
  onSuiteOpen: (path: string[], opened: boolean) => void;
12
16
  onSuiteToggle: (path: string[], checked: boolean) => void;
17
+ sidebarFocusedItem: FocusableItem;
18
+ setSidebarFocusedItem: (item: FocusableItem) => void;
13
19
  }
14
20
 
15
21
  export const CreeveyContext = React.createContext<CreeveyContextType>({
16
22
  isReport: true,
17
23
  isRunning: false,
24
+ onImageNext: noop,
18
25
  onImageApprove: noop,
19
26
  onApproveAll: noop,
20
27
  onStop: noop,
21
28
  onStart: noop,
22
29
  onSuiteOpen: noop,
23
30
  onSuiteToggle: noop,
31
+ sidebarFocusedItem: [],
32
+ setSidebarFocusedItem: noop,
24
33
  });
25
34
 
26
35
  export const useCreeveyContext = () => useContext(CreeveyContext);
@@ -1,6 +1,6 @@
1
1
  import React, { JSX } from 'react';
2
2
  import { styled, withTheme, Theme, keyframes, ensure, ThemeProvider, themes, Keyframes } from '@storybook/theming';
3
- import { useTheme } from '../shared/helpers.js';
3
+ import { useTheme } from './themes.js';
4
4
 
5
5
  const Container = withTheme(
6
6
  styled.div(({ theme }) => ({
@@ -1,7 +1,7 @@
1
- import React, { JSX, ChangeEvent, useContext, useRef, useState } from 'react';
1
+ import React, { JSX, ChangeEvent, useRef, useState } from 'react';
2
2
  import { SearchIcon, CloseAltIcon } from '@storybook/icons';
3
3
  import { styled, Theme, withTheme } from '@storybook/theming';
4
- import { KeyboardEventsContext } from '../../KeyboardEventsContext.js';
4
+ import { useCreeveyContext } from '../../CreeveyContext.js';
5
5
 
6
6
  interface SearchProps {
7
7
  onChange: (arg: string) => void;
@@ -100,7 +100,7 @@ const FilterForm = withTheme(
100
100
  );
101
101
 
102
102
  export const Search = ({ onChange, value }: SearchProps): JSX.Element => {
103
- const { setSidebarFocusedItem } = useContext(KeyboardEventsContext);
103
+ const { setSidebarFocusedItem } = useCreeveyContext();
104
104
  const [focussed, onSetFocussed] = useState(false);
105
105
  const searchRef = useRef<HTMLInputElement>(null);
106
106
 
@@ -62,6 +62,7 @@ const SelectAllContainer = styled.div({
62
62
  });
63
63
 
64
64
  const TestsContainer = styled.div({
65
+ marginBottom: '8px',
65
66
  position: 'relative',
66
67
  height: '100%',
67
68
  });
@@ -1,4 +1,4 @@
1
- import React, { JSX } from 'react';
1
+ import React, { JSX, useCallback, useEffect, useState } from 'react';
2
2
  import { styled, withTheme } from '@storybook/theming';
3
3
  import { Button } from '@storybook/components';
4
4
  import { ChevronRightIcon } from '@storybook/icons';
@@ -21,15 +21,46 @@ const Container = styled.div({
21
21
  });
22
22
 
23
23
  export function SideBarFooter(): JSX.Element {
24
- const { onApproveAll, onImageApprove } = useCreeveyContext();
24
+ const { onApproveAll, onImageApprove, onImageNext } = useCreeveyContext();
25
+ const [isAlt, setIsAlt] = useState(false);
26
+
27
+ const handleKeyDown = useCallback((e: KeyboardEvent) => {
28
+ if (e.code === 'AltLeft') {
29
+ e.preventDefault();
30
+ setIsAlt(true);
31
+ }
32
+ }, []);
33
+ const handleKeyUp = useCallback((e: KeyboardEvent) => {
34
+ if (e.code === 'AltLeft') {
35
+ e.preventDefault();
36
+ setIsAlt(false);
37
+ }
38
+ }, []);
39
+
40
+ useEffect(() => {
41
+ document.addEventListener('keydown', handleKeyDown, false);
42
+ document.addEventListener('keyup', handleKeyUp, false);
43
+
44
+ return () => {
45
+ document.removeEventListener('keydown', handleKeyDown, false);
46
+ document.removeEventListener('keyup', handleKeyUp, false);
47
+ };
48
+ }, [handleKeyDown, handleKeyUp]);
25
49
 
26
50
  return (
27
51
  <Sticky>
28
52
  <Container>
29
- <Button variant="solid" size="medium" onClick={onImageApprove} disabled={!onImageApprove}>
30
- Approve
31
- <ChevronRightIcon />
32
- </Button>
53
+ {isAlt ? (
54
+ <Button variant="outline" size="medium" onClick={onImageNext} disabled={!onImageApprove}>
55
+ Next
56
+ <ChevronRightIcon />
57
+ </Button>
58
+ ) : (
59
+ <Button variant="solid" size="medium" onClick={onImageApprove} disabled={!onImageApprove}>
60
+ Approve
61
+ <ChevronRightIcon />
62
+ </Button>
63
+ )}
33
64
  <Button variant="outline" size="medium" onClick={onApproveAll}>
34
65
  Approve all
35
66
  </Button>
@@ -1,11 +1,10 @@
1
- import React, { JSX, useRef, useContext, useEffect, useMemo } from 'react';
1
+ import React, { JSX, useRef, useEffect, useMemo } from 'react';
2
2
  import { ChevronDownIcon, ChevronRightIcon } from '@storybook/icons';
3
3
  import { styled, withTheme, Theme } from '@storybook/theming';
4
4
  import { Checkbox, CheckboxContainer } from './Checkbox.js';
5
5
  import { TestStatusIcon } from './TestStatusIcon.js';
6
6
  import { CreeveySuite, isTest } from '../../../../types.js';
7
- import { CreeveyContext } from '../../CreeveyContext.js';
8
- import { KeyboardEventsContext } from '../../KeyboardEventsContext.js';
7
+ import { useCreeveyContext } from '../../CreeveyContext.js';
9
8
 
10
9
  export interface SuiteLinkProps {
11
10
  title: string;
@@ -79,8 +78,7 @@ export const SuiteTitle = styled.span({
79
78
  });
80
79
 
81
80
  export function SuiteLink({ title, suite, 'data-testid': dataTid }: SuiteLinkProps): JSX.Element {
82
- const { onSuiteOpen, onSuiteToggle } = useContext(CreeveyContext);
83
- const { sidebarFocusedItem, setSidebarFocusedItem } = useContext(KeyboardEventsContext);
81
+ const { onSuiteOpen, onSuiteToggle, sidebarFocusedItem, setSidebarFocusedItem } = useCreeveyContext();
84
82
  const checkboxRef = useRef<Checkbox>(null);
85
83
  const buttonRef = useRef<HTMLButtonElement | null>(null);
86
84
 
@@ -1,9 +1,8 @@
1
1
  import React, { JSX, useEffect, useCallback, useContext, useMemo, useRef } from 'react';
2
2
  import { CreeveyTest } from '../../../../types.js';
3
3
  import { TestStatusIcon } from './TestStatusIcon.js';
4
- import { CreeveyContext } from '../../CreeveyContext.js';
4
+ import { useCreeveyContext } from '../../CreeveyContext.js';
5
5
  import { SideBarContext } from './SideBar.js';
6
- import { KeyboardEventsContext } from '../../KeyboardEventsContext.js';
7
6
  import { Button, Container, SuiteContainer, SuiteTitle } from './SuiteLink.js';
8
7
  import { Checkbox, CheckboxContainer } from './Checkbox.js';
9
8
  import { getTestPath } from '../../../shared/helpers.js';
@@ -20,9 +19,8 @@ const TestContainer = styled(SuiteContainer)({
20
19
  });
21
20
 
22
21
  export function TestLink({ title, opened, test }: TestLinkProps): JSX.Element {
23
- const { onSuiteToggle } = useContext(CreeveyContext);
22
+ const { onSuiteToggle, sidebarFocusedItem, setSidebarFocusedItem } = useCreeveyContext();
24
23
  const { onOpenTest } = useContext(SideBarContext);
25
- const { sidebarFocusedItem, setSidebarFocusedItem } = useContext(KeyboardEventsContext);
26
24
  const buttonRef = useRef<HTMLButtonElement | null>(null);
27
25
 
28
26
  const emptyResults = (test.results?.length ?? 0) == 0;
@@ -1,20 +1,7 @@
1
- import React, { JSX, useState, useEffect, useCallback, useContext, PropsWithChildren } from 'react';
2
- import { CreeveySuite, isTest, noop } from '../../types.js';
1
+ import React, { JSX, useEffect, useCallback, PropsWithChildren } from 'react';
2
+ import { CreeveySuite, isTest } from '../../types.js';
3
3
  import { CreeveyViewFilter, filterTests, flattenSuite, getSuiteByPath, getTestPath } from '../shared/helpers.js';
4
- import { CreeveyContext } from './CreeveyContext.js';
5
-
6
- export type SuitePath = string[];
7
- export type FocusableItem = null | SuitePath;
8
-
9
- export interface KeyboardEventsContextType {
10
- sidebarFocusedItem: FocusableItem;
11
- setSidebarFocusedItem: (item: FocusableItem) => void;
12
- }
13
-
14
- export const KeyboardEventsContext = React.createContext<KeyboardEventsContextType>({
15
- sidebarFocusedItem: [],
16
- setSidebarFocusedItem: noop,
17
- });
4
+ import { useCreeveyContext } from './CreeveyContext.js';
18
5
 
19
6
  export const KeyboardEvents = ({
20
7
  children,
@@ -24,9 +11,7 @@ export const KeyboardEvents = ({
24
11
  rootSuite: CreeveySuite;
25
12
  filter: CreeveyViewFilter;
26
13
  }>): JSX.Element => {
27
- const [sidebarFocusedItem, setSidebarFocusedItem] = useState<FocusableItem>([]);
28
-
29
- const { onSuiteOpen, onSuiteToggle } = useContext(CreeveyContext);
14
+ const { onSuiteOpen, onSuiteToggle, sidebarFocusedItem, setSidebarFocusedItem } = useCreeveyContext();
30
15
 
31
16
  const suiteList = flattenSuite(filterTests(rootSuite, filter));
32
17
 
@@ -45,63 +30,70 @@ export const KeyboardEvents = ({
45
30
  (e: KeyboardEvent) => {
46
31
  if (sidebarFocusedItem === null) return;
47
32
 
48
- if (e.code === 'Enter') {
49
- if (sidebarFocusedItem.length === 0) return;
50
-
51
- const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
52
- if (!focusedSuite) return;
53
- if (!isTest(focusedSuite)) {
54
- e.preventDefault();
55
- onSuiteOpen(focusedSuite.path, !focusedSuite.opened);
33
+ switch (e.code) {
34
+ case 'Enter': {
35
+ if (sidebarFocusedItem.length === 0) return;
36
+
37
+ const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
38
+ if (!focusedSuite) return;
39
+ if (!isTest(focusedSuite)) {
40
+ e.preventDefault();
41
+ onSuiteOpen(focusedSuite.path, !focusedSuite.opened);
42
+ }
43
+ if (isTest(focusedSuite) && focusedSuite.results?.length == 0) {
44
+ e.preventDefault();
45
+ }
46
+ return;
56
47
  }
57
- if (isTest(focusedSuite) && focusedSuite.results?.length == 0) {
48
+ case 'Space': {
58
49
  e.preventDefault();
50
+ // TODO handle keys in one place
51
+ if (e.altKey) return;
52
+ const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
53
+ if (!focusedSuite) return;
54
+ const path = isTest(focusedSuite) ? getTestPath(focusedSuite) : focusedSuite.path;
55
+ onSuiteToggle(path, !focusedSuite.checked);
56
+ return;
59
57
  }
60
- return;
61
- }
62
- if (e.code === 'Space') {
63
- e.preventDefault();
64
- const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
65
- if (!focusedSuite) return;
66
- const path = isTest(focusedSuite) ? getTestPath(focusedSuite) : focusedSuite.path;
67
- onSuiteToggle(path, !focusedSuite.checked);
68
- }
69
- if (e.code === 'ArrowDown') {
70
- const currentIndex = sidebarFocusedItem.length === 0 ? -1 : getFocusedItemIndex(sidebarFocusedItem);
71
- if (currentIndex === suiteList.length - 1) return;
72
- const nextSuite = suiteList[currentIndex + 1];
73
- const nextPath = isTest(nextSuite.suite) ? getTestPath(nextSuite.suite) : nextSuite.suite.path;
74
- setSidebarFocusedItem(nextPath);
75
- }
76
- if (e.code === 'ArrowUp') {
77
- const currentIndex = sidebarFocusedItem.length === 0 ? 0 : getFocusedItemIndex(sidebarFocusedItem);
78
- const nextSuite = currentIndex > 0 ? suiteList[currentIndex - 1].suite : rootSuite;
79
- const nextPath = isTest(nextSuite) ? getTestPath(nextSuite) : nextSuite.path;
80
- setSidebarFocusedItem(nextPath);
81
- }
82
-
83
- if (e.code === 'ArrowRight') {
84
- if (sidebarFocusedItem.length === 0) return;
85
- const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
86
-
87
- if (!focusedSuite || isTest(focusedSuite)) return;
88
- onSuiteOpen(focusedSuite.path, true);
89
- }
90
-
91
- if (e.code === 'ArrowLeft') {
92
- if (sidebarFocusedItem.length === 0) return;
93
- const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
94
- if (!focusedSuite) return;
95
- if (!isTest(focusedSuite) && focusedSuite.opened) {
96
- onSuiteOpen(focusedSuite.path, false);
58
+ case 'ArrowDown': {
59
+ const currentIndex = sidebarFocusedItem.length === 0 ? -1 : getFocusedItemIndex(sidebarFocusedItem);
60
+ if (currentIndex === suiteList.length - 1) return;
61
+ const nextSuite = suiteList[currentIndex + 1];
62
+ const nextPath = isTest(nextSuite.suite) ? getTestPath(nextSuite.suite) : nextSuite.suite.path;
63
+ setSidebarFocusedItem(nextPath);
64
+ return;
65
+ }
66
+ case 'ArrowUp': {
67
+ const currentIndex = sidebarFocusedItem.length === 0 ? 0 : getFocusedItemIndex(sidebarFocusedItem);
68
+ const nextSuite = currentIndex > 0 ? suiteList[currentIndex - 1].suite : rootSuite;
69
+ const nextPath = isTest(nextSuite) ? getTestPath(nextSuite) : nextSuite.path;
70
+ setSidebarFocusedItem(nextPath);
97
71
  return;
98
72
  }
73
+ case 'ArrowRight': {
74
+ if (sidebarFocusedItem.length === 0) return;
75
+ const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
99
76
 
100
- const path = isTest(focusedSuite) ? getTestPath(focusedSuite) : focusedSuite.path;
101
- setSidebarFocusedItem(path.slice(0, -1));
77
+ if (!focusedSuite || isTest(focusedSuite)) return;
78
+ onSuiteOpen(focusedSuite.path, true);
79
+ return;
80
+ }
81
+ case 'ArrowLeft': {
82
+ if (sidebarFocusedItem.length === 0) return;
83
+ const focusedSuite = getSuiteByPath(rootSuite, sidebarFocusedItem);
84
+ if (!focusedSuite) return;
85
+ if (!isTest(focusedSuite) && focusedSuite.opened) {
86
+ onSuiteOpen(focusedSuite.path, false);
87
+ return;
88
+ }
89
+
90
+ const path = isTest(focusedSuite) ? getTestPath(focusedSuite) : focusedSuite.path;
91
+ setSidebarFocusedItem(path.slice(0, -1));
92
+ return;
93
+ }
102
94
  }
103
95
  },
104
- [onSuiteOpen, onSuiteToggle, rootSuite, suiteList, getFocusedItemIndex, sidebarFocusedItem],
96
+ [onSuiteOpen, onSuiteToggle, rootSuite, suiteList, getFocusedItemIndex, sidebarFocusedItem, setSidebarFocusedItem],
105
97
  );
106
98
 
107
99
  useEffect(() => {
@@ -112,9 +104,5 @@ export const KeyboardEvents = ({
112
104
  };
113
105
  }, [handleKeyDown]);
114
106
 
115
- return (
116
- <KeyboardEventsContext.Provider value={{ sidebarFocusedItem, setSidebarFocusedItem }}>
117
- {children}
118
- </KeyboardEventsContext.Provider>
119
- );
107
+ return <>{children}</>;
120
108
  };
@@ -0,0 +1,24 @@
1
+ import { useEffect, useState } from 'react';
2
+ import { themes, ThemeVars } from '@storybook/theming';
3
+ import { isDefined } from '../../types.js';
4
+
5
+ const CREEVEY_THEME = 'Creevey_theme';
6
+
7
+ function isTheme(theme?: string | null): theme is ThemeVars['base'] {
8
+ return isDefined(theme) && Object.prototype.hasOwnProperty.call(themes, theme);
9
+ }
10
+
11
+ function initialTheme(): ThemeVars['base'] {
12
+ const theme = localStorage.getItem(CREEVEY_THEME);
13
+ return isTheme(theme) ? theme : 'light';
14
+ }
15
+
16
+ export function useTheme(): [ThemeVars['base'], (theme: ThemeVars['base']) => void] {
17
+ const [theme, setTheme] = useState<ThemeVars['base']>(initialTheme());
18
+
19
+ useEffect(() => {
20
+ localStorage.setItem(CREEVEY_THEME, theme);
21
+ }, [theme]);
22
+
23
+ return [theme, setTheme];
24
+ }
package/src/creevey.ts CHANGED
@@ -5,14 +5,14 @@ import { Options } from './types.js';
5
5
  import { emitWorkerMessage } from './server/messages.js';
6
6
  import { isShuttingDown, shutdownWorkers } from './server/utils.js';
7
7
  import Logger from 'loglevel';
8
- import { logger } from './server/logger.js';
8
+ import { logger, setRootName } from './server/logger.js';
9
9
 
10
10
  function shutdownOnException(reason: unknown): void {
11
11
  if (isShuttingDown.current) return;
12
12
 
13
13
  const error = reason instanceof Error ? (reason.stack ?? reason.message) : (reason as string);
14
14
 
15
- logger.error(error);
15
+ logger().error(error);
16
16
 
17
17
  process.exitCode = -1;
18
18
  if (cluster.isWorker) emitWorkerMessage({ type: 'error', payload: { subtype: 'unknown', error } });
@@ -21,7 +21,11 @@ function shutdownOnException(reason: unknown): void {
21
21
 
22
22
  process.on('uncaughtException', shutdownOnException);
23
23
  process.on('unhandledRejection', shutdownOnException);
24
+ // TODO SIGINT Stuck with selenium
24
25
  process.on('SIGINT', () => {
26
+ if (isShuttingDown.current) {
27
+ process.exit(-1);
28
+ }
25
29
  isShuttingDown.current = true;
26
30
  });
27
31
 
@@ -32,9 +36,12 @@ const argv = minimist<Options>(process.argv.slice(2), {
32
36
  alias: { port: 'p', config: 'c', debug: 'd', update: 'u' },
33
37
  });
34
38
 
39
+ if ('port' in argv && !isNaN(argv.port)) argv.port = Number(argv.port);
40
+ if ('browser' in argv && argv.browser) setRootName(argv.browser);
41
+
35
42
  // eslint-disable-next-line @typescript-eslint/no-deprecated
36
43
  if (cluster.isPrimary && argv.reporter) {
37
- logger.warn(`--reporter option has been removed please describe reporter in config file:
44
+ logger().warn(`--reporter option has been removed please describe reporter in config file:
38
45
  import { reporters } from 'mocha';
39
46
 
40
47
  const config = {
@@ -51,13 +58,13 @@ if (cluster.isPrimary && argv.reporter) {
51
58
  // @ts-expect-error: define log level for storybook
52
59
  global.LOGLEVEL = argv.trace ? 'trace' : argv.debug ? 'debug' : 'warn';
53
60
  if (argv.trace) {
54
- logger.setDefaultLevel(Logger.levels.TRACE);
61
+ logger().setDefaultLevel(Logger.levels.TRACE);
55
62
  Logger.setDefaultLevel(Logger.levels.TRACE);
56
63
  } else if (argv.debug) {
57
- logger.setDefaultLevel(Logger.levels.DEBUG);
64
+ logger().setDefaultLevel(Logger.levels.DEBUG);
58
65
  Logger.setDefaultLevel(Logger.levels.DEBUG);
59
66
  } else {
60
- logger.setDefaultLevel(Logger.levels.INFO);
67
+ logger().setDefaultLevel(Logger.levels.INFO);
61
68
  Logger.setDefaultLevel(Logger.levels.INFO);
62
69
  }
63
70
 
@@ -11,6 +11,7 @@ export const defaultBrowser = 'chrome';
11
11
 
12
12
  export const defaultConfig: Omit<Config, 'gridUrl' | 'testsDir' | 'tsConfig' | 'webdriver'> = {
13
13
  disableTelemetry: false,
14
+ useWorkerQueue: false,
14
15
  useDocker: true,
15
16
  dockerImage: 'aerokube/selenoid:latest-release',
16
17
  dockerImagePlatform: '',
@@ -23,11 +24,11 @@ export const defaultConfig: Omit<Config, 'gridUrl' | 'testsDir' | 'tsConfig' | '
23
24
  storiesProvider: browserStoriesProvider,
24
25
  maxRetries: 0,
25
26
  testTimeout: 30000,
26
- diffOptions: { threshold: 0.05, includeAA: false },
27
- odiffOptions: { threshold: 0.05, antialiasing: true },
27
+ diffOptions: { threshold: 0.1, includeAA: false },
28
+ odiffOptions: { threshold: 0.1, antialiasing: true },
28
29
  browsers: { [defaultBrowser]: true },
29
30
  hooks: {},
30
- testsRegex: /\.creevey\.(t|j)s$/,
31
+ testsRegex: /\.creevey\.(m|c)?(t|j)s$/,
31
32
  };
32
33
 
33
34
  function normalizeBrowserConfig(name: string, config: BrowserConfig): BrowserConfigObject {
@@ -73,7 +74,7 @@ export async function readConfig(options: Options): Promise<Config> {
73
74
 
74
75
  if (!configData.webdriver) {
75
76
  const { SeleniumWebdriver } = await import('./selenium/webdriver.js');
76
- logger.warn(
77
+ logger().warn(
77
78
  "Creevey supports `Selenium` and `Playwright` webdrivers. For backward compatibility `Selenium` is used by default, but it might changed in the future. Please explicitly specify one of webdrivers in your Creevey's config",
78
79
  );
79
80
  configData.webdriver = SeleniumWebdriver;
@@ -1,4 +1,5 @@
1
1
  import tar from 'tar-stream';
2
+ import Logger from 'loglevel';
2
3
  import { Writable } from 'stream';
3
4
  import Dockerode, { Container } from 'dockerode';
4
5
  import { DockerAuth } from '../types.js';
@@ -21,7 +22,7 @@ export async function pullImages(
21
22
  if (auth) args.authconfig = auth;
22
23
  if (platform) args.platform = platform;
23
24
 
24
- logger.info('Pull docker images');
25
+ logger().info('Pull docker images');
25
26
  // TODO Replace with `import from`
26
27
  const { default: yoctoSpinner } = await import('yocto-spinner');
27
28
  for (const image of images) {
@@ -61,7 +62,17 @@ export async function buildImage(imageName: string, dockerfile: string): Promise
61
62
  const images = await docker.listImages({ filters: { label: [`creevey=${imageName}`] } });
62
63
 
63
64
  if (images.at(0)) {
64
- logger.info(`Image ${imageName} already exists`);
65
+ await Promise.all(
66
+ (await docker.listContainers({ all: true, filters: { label: [`creevey=${imageName}`] } })).map(async (info) => {
67
+ const container = docker.getContainer(info.Id);
68
+ try {
69
+ await container.remove({ force: true });
70
+ } catch {
71
+ /* noop */
72
+ }
73
+ }),
74
+ );
75
+ logger().info(`Image ${imageName} already exists`);
65
76
  return;
66
77
  }
67
78
 
@@ -70,15 +81,20 @@ export async function buildImage(imageName: string, dockerfile: string): Promise
70
81
  pack.finalize();
71
82
 
72
83
  const { default: yoctoSpinner } = await import('yocto-spinner');
73
- const spinner = yoctoSpinner({ text: `${imageName}: Build start` }).start();
84
+ const spinner = yoctoSpinner({ text: `${imageName}: Build start` });
85
+ if (logger().getLevel() > Logger.levels.DEBUG) {
86
+ spinner.start();
87
+ }
88
+ let isFailed = false;
74
89
  await new Promise<void>((resolve, reject) => {
75
90
  void docker.buildImage(
76
91
  // @ts-expect-error Type incompatibility AsyncIterator and AsyncIterableIterator
77
92
  pack,
78
- { t: imageName, labels: { creevey: imageName } },
93
+ // TODO Support buildkit decode grpc (version: '2')
94
+ { t: imageName, labels: { creevey: imageName }, version: '1' },
79
95
  (buildError: Error | null, stream) => {
80
96
  if (buildError || !stream) {
81
- spinner.error(buildError?.message);
97
+ // spinner.error(buildError?.message);
82
98
  reject(buildError ?? new Error('Unknown error'));
83
99
  return;
84
100
  }
@@ -86,6 +102,8 @@ export async function buildImage(imageName: string, dockerfile: string): Promise
86
102
  docker.modem.followProgress(stream, onFinished, onProgress);
87
103
 
88
104
  function onFinished(error: Error | null): void {
105
+ if (isFailed) return;
106
+
89
107
  if (error) {
90
108
  spinner.error(error.message);
91
109
  reject(error);
@@ -95,10 +113,23 @@ export async function buildImage(imageName: string, dockerfile: string): Promise
95
113
  resolve();
96
114
  }
97
115
 
98
- function onProgress(event: { id: string; status: string; progress?: string }): void {
99
- if (!/^[a-z0-9]{12}$/i.test(event.id)) return;
100
-
101
- spinner.text = `${imageName}: [${event.id}] ${event.status} ${event.progress ? event.progress : ''}`;
116
+ function onProgress(
117
+ event:
118
+ | { stream: string }
119
+ | { errorDetail: { code: number; message: string }; error: string }
120
+ | { id: string; aux: string }, // NOTE: Only with `version: '2'`
121
+ ): void {
122
+ if ('stream' in event) {
123
+ if (logger().getLevel() <= Logger.levels.DEBUG) {
124
+ logger().debug(event.stream.trim());
125
+ } else {
126
+ spinner.text = `${imageName}: [Build] - ${event.stream}`;
127
+ }
128
+ } else if ('errorDetail' in event) {
129
+ isFailed = true;
130
+ spinner.error(event.error);
131
+ reject(new Error(event.error));
132
+ }
102
133
  }
103
134
  },
104
135
  );
@@ -111,18 +142,6 @@ export async function runImage(
111
142
  options: Record<string, unknown>,
112
143
  debug: boolean,
113
144
  ): Promise<string> {
114
- await Promise.all(
115
- (await docker.listContainers({ all: true, filters: { ancestor: [image] } })).map(async (info) => {
116
- const container = docker.getContainer(info.Id);
117
- try {
118
- await container.stop();
119
- } catch {
120
- /* noop */
121
- }
122
- await container.remove();
123
- }),
124
- );
125
-
126
145
  const hub = docker.run(image, args, debug ? process.stdout : new DevNull(), options, (error) => {
127
146
  if (error) throw error;
128
147
  });
@@ -132,8 +151,7 @@ export async function runImage(
132
151
  // eslint-disable-next-line @typescript-eslint/no-misused-promises
133
152
  subscribeOn('shutdown', async () => {
134
153
  try {
135
- await container.stop();
136
- await container.remove();
154
+ await container.remove({ force: true });
137
155
  } catch {
138
156
  /* noop */
139
157
  }