creevey 0.10.0-beta.0 → 0.10.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 (159) hide show
  1. package/dist/client/addon/components/Panel.js +2 -2
  2. package/dist/client/addon/components/Panel.js.map +1 -1
  3. package/dist/client/addon/controller.js +4 -5
  4. package/dist/client/addon/controller.js.map +1 -1
  5. package/dist/client/addon/withCreevey.js +18 -34
  6. package/dist/client/addon/withCreevey.js.map +1 -1
  7. package/dist/client/shared/components/ImagesView/SwapView.js +12 -0
  8. package/dist/client/shared/components/ImagesView/SwapView.js.map +1 -1
  9. package/dist/client/shared/components/PageHeader/ImagePreview.js +1 -0
  10. package/dist/client/shared/components/PageHeader/ImagePreview.js.map +1 -1
  11. package/dist/client/shared/components/ResultsPage.js +23 -5
  12. package/dist/client/shared/components/ResultsPage.js.map +1 -1
  13. package/dist/client/web/CreeveyApp.js +22 -6
  14. package/dist/client/web/CreeveyApp.js.map +1 -1
  15. package/dist/client/web/CreeveyContext.d.ts +5 -0
  16. package/dist/client/web/CreeveyContext.js +3 -0
  17. package/dist/client/web/CreeveyContext.js.map +1 -1
  18. package/dist/client/web/CreeveyView/SideBar/Search.js +2 -2
  19. package/dist/client/web/CreeveyView/SideBar/Search.js.map +1 -1
  20. package/dist/client/web/CreeveyView/SideBar/SideBar.js +1 -0
  21. package/dist/client/web/CreeveyView/SideBar/SideBar.js.map +1 -1
  22. package/dist/client/web/CreeveyView/SideBar/SideBarFooter.js +49 -6
  23. package/dist/client/web/CreeveyView/SideBar/SideBarFooter.js.map +1 -1
  24. package/dist/client/web/CreeveyView/SideBar/SuiteLink.js +1 -3
  25. package/dist/client/web/CreeveyView/SideBar/SuiteLink.js.map +1 -1
  26. package/dist/client/web/CreeveyView/SideBar/TestLink.js +1 -3
  27. package/dist/client/web/CreeveyView/SideBar/TestLink.js.map +1 -1
  28. package/dist/client/web/KeyboardEventsContext.d.ts +1 -8
  29. package/dist/client/web/KeyboardEventsContext.js +62 -57
  30. package/dist/client/web/KeyboardEventsContext.js.map +1 -1
  31. package/dist/client/web/assets/{index-DkmZfG9C.js → index-BE9CL5_G.js} +94 -94
  32. package/dist/client/web/index.html +1 -1
  33. package/dist/creevey.js +13 -5
  34. package/dist/creevey.js.map +1 -1
  35. package/dist/index.js +1 -5
  36. package/dist/index.js.map +1 -1
  37. package/dist/playwright.d.ts +2 -0
  38. package/dist/playwright.js +6 -0
  39. package/dist/playwright.js.map +1 -0
  40. package/dist/selenium.d.ts +2 -0
  41. package/dist/selenium.js +6 -0
  42. package/dist/selenium.js.map +1 -0
  43. package/dist/server/config.d.ts +1 -1
  44. package/dist/server/config.js +12 -5
  45. package/dist/server/config.js.map +1 -1
  46. package/dist/server/docker.js +2 -2
  47. package/dist/server/docker.js.map +1 -1
  48. package/dist/server/index.js +40 -4
  49. package/dist/server/index.js.map +1 -1
  50. package/dist/server/logger.d.ts +2 -1
  51. package/dist/server/logger.js +7 -3
  52. package/dist/server/logger.js.map +1 -1
  53. package/dist/server/master/api.js +1 -1
  54. package/dist/server/master/api.js.map +1 -1
  55. package/dist/server/master/pool.d.ts +3 -3
  56. package/dist/server/master/pool.js +10 -63
  57. package/dist/server/master/pool.js.map +1 -1
  58. package/dist/server/master/queue.d.ts +13 -0
  59. package/dist/server/master/queue.js +64 -0
  60. package/dist/server/master/queue.js.map +1 -0
  61. package/dist/server/master/runner.d.ts +1 -0
  62. package/dist/server/master/runner.js +4 -1
  63. package/dist/server/master/runner.js.map +1 -1
  64. package/dist/server/master/server.js +1 -1
  65. package/dist/server/master/server.js.map +1 -1
  66. package/dist/server/master/start.js +4 -4
  67. package/dist/server/master/start.js.map +1 -1
  68. package/dist/server/playwright/docker-file.js +12 -1
  69. package/dist/server/playwright/docker-file.js.map +1 -1
  70. package/dist/server/playwright/docker.d.ts +1 -1
  71. package/dist/server/playwright/docker.js +1 -6
  72. package/dist/server/playwright/docker.js.map +1 -1
  73. package/dist/server/playwright/internal.d.ts +2 -2
  74. package/dist/server/playwright/internal.js +56 -44
  75. package/dist/server/playwright/internal.js.map +1 -1
  76. package/dist/server/playwright/webdriver.d.ts +2 -1
  77. package/dist/server/playwright/webdriver.js +4 -1
  78. package/dist/server/playwright/webdriver.js.map +1 -1
  79. package/dist/server/providers/browser.js +2 -1
  80. package/dist/server/providers/browser.js.map +1 -1
  81. package/dist/server/providers/hybrid.js +1 -1
  82. package/dist/server/providers/hybrid.js.map +1 -1
  83. package/dist/server/reporter.js +4 -4
  84. package/dist/server/reporter.js.map +1 -1
  85. package/dist/server/selenium/internal.d.ts +3 -3
  86. package/dist/server/selenium/internal.js +126 -89
  87. package/dist/server/selenium/internal.js.map +1 -1
  88. package/dist/server/selenium/selenoid.js +2 -2
  89. package/dist/server/selenium/selenoid.js.map +1 -1
  90. package/dist/server/selenium/webdriver.d.ts +2 -1
  91. package/dist/server/selenium/webdriver.js +8 -1
  92. package/dist/server/selenium/webdriver.js.map +1 -1
  93. package/dist/server/telemetry.js +7 -3
  94. package/dist/server/telemetry.js.map +1 -1
  95. package/dist/server/utils.d.ts +2 -1
  96. package/dist/server/utils.js +13 -3
  97. package/dist/server/utils.js.map +1 -1
  98. package/dist/server/webdriver.d.ts +4 -4
  99. package/dist/server/webdriver.js +10 -9
  100. package/dist/server/webdriver.js.map +1 -1
  101. package/dist/server/worker/chai-image.d.ts +1 -2
  102. package/dist/server/worker/chai-image.js +4 -3
  103. package/dist/server/worker/chai-image.js.map +1 -1
  104. package/dist/server/worker/start.js +27 -39
  105. package/dist/server/worker/start.js.map +1 -1
  106. package/dist/types.d.ts +32 -21
  107. package/dist/types.js +13 -1
  108. package/dist/types.js.map +1 -1
  109. package/package.json +45 -38
  110. package/playwright.d.ts +2 -0
  111. package/selenium.d.ts +2 -0
  112. package/src/client/addon/components/Panel.tsx +2 -2
  113. package/src/client/addon/controller.ts +13 -6
  114. package/src/client/addon/withCreevey.ts +25 -13
  115. package/src/client/shared/components/ImagesView/SwapView.tsx +18 -0
  116. package/src/client/shared/components/PageHeader/ImagePreview.tsx +1 -0
  117. package/src/client/shared/components/ResultsPage.tsx +28 -7
  118. package/src/client/web/CreeveyApp.tsx +25 -7
  119. package/src/client/web/CreeveyContext.tsx +9 -0
  120. package/src/client/web/CreeveyView/SideBar/Search.tsx +3 -3
  121. package/src/client/web/CreeveyView/SideBar/SideBar.tsx +1 -0
  122. package/src/client/web/CreeveyView/SideBar/SideBarFooter.tsx +37 -6
  123. package/src/client/web/CreeveyView/SideBar/SuiteLink.tsx +3 -5
  124. package/src/client/web/CreeveyView/SideBar/TestLink.tsx +2 -4
  125. package/src/client/web/KeyboardEventsContext.tsx +61 -73
  126. package/src/creevey.ts +13 -6
  127. package/src/index.ts +0 -2
  128. package/src/playwright.ts +1 -0
  129. package/src/selenium.ts +1 -0
  130. package/src/server/config.ts +19 -7
  131. package/src/server/docker.ts +2 -2
  132. package/src/server/index.ts +45 -4
  133. package/src/server/logger.ts +6 -2
  134. package/src/server/master/api.ts +1 -1
  135. package/src/server/master/pool.ts +18 -56
  136. package/src/server/master/queue.ts +64 -0
  137. package/src/server/master/runner.ts +4 -1
  138. package/src/server/master/server.ts +1 -1
  139. package/src/server/master/start.ts +7 -4
  140. package/src/server/playwright/docker-file.ts +14 -1
  141. package/src/server/playwright/docker.ts +2 -12
  142. package/src/server/playwright/internal.ts +76 -49
  143. package/src/server/playwright/webdriver.ts +7 -2
  144. package/src/server/providers/browser.ts +2 -1
  145. package/src/server/providers/hybrid.ts +1 -1
  146. package/src/server/reporter.ts +4 -3
  147. package/src/server/selenium/internal.ts +147 -93
  148. package/src/server/selenium/selenoid.ts +2 -2
  149. package/src/server/selenium/webdriver.ts +12 -2
  150. package/src/server/telemetry.ts +7 -3
  151. package/src/server/utils.ts +14 -4
  152. package/src/server/webdriver.ts +13 -15
  153. package/src/server/worker/chai-image.ts +4 -4
  154. package/src/server/worker/start.ts +29 -48
  155. package/src/types.ts +35 -23
  156. package/types/playwright-context.d.ts +7 -0
  157. package/types/selenium-context.d.ts +7 -0
  158. package/.yarnrc.yml +0 -1
  159. package/chromatic.config.json +0 -5
@@ -1,10 +1,18 @@
1
- import * as Events from '@storybook/core-events';
2
1
  import type { Renderer, StoryContextForEnhancers } from '@storybook/csf';
3
2
  import { makeDecorator, PreviewWeb, StoryStore } from '@storybook/preview-api';
4
3
  import { Channel } from '@storybook/channels';
5
- import { CaptureOptions, CreeveyStoryParams, isObject, noop, StoriesRaw, StorybookGlobals } from '../../types.js';
4
+ import {
5
+ CaptureOptions,
6
+ CreeveyStoryParams,
7
+ isObject,
8
+ noop,
9
+ StoriesRaw,
10
+ StorybookEvents,
11
+ StorybookGlobals,
12
+ } from '../../types.js';
6
13
  import { serializeRawStories } from '../../shared/index.js';
7
14
  import { getConnectionUrl } from '../shared/helpers.js';
15
+ import isEqual from 'lodash/isEqual.js';
8
16
 
9
17
  declare global {
10
18
  interface Window {
@@ -62,12 +70,12 @@ function catchRenderError(channel: Channel): Promise<void> & { cancel: () => voi
62
70
  rejectCallback(exception);
63
71
  }
64
72
  function removeHandlers(): void {
65
- channel.off(Events.STORY_ERRORED, errorHandler);
66
- channel.off(Events.STORY_THREW_EXCEPTION, errorHandler);
73
+ channel.off(StorybookEvents.STORY_ERRORED, errorHandler);
74
+ channel.off(StorybookEvents.STORY_THREW_EXCEPTION, errorHandler);
67
75
  }
68
76
 
69
- channel.once(Events.STORY_ERRORED, errorHandler);
70
- channel.once(Events.STORY_THREW_EXCEPTION, exceptionHandler);
77
+ channel.once(StorybookEvents.STORY_ERRORED, errorHandler);
78
+ channel.once(StorybookEvents.STORY_THREW_EXCEPTION, exceptionHandler);
71
79
 
72
80
  return Object.assign(promise, { cancel: removeHandlers });
73
81
  }
@@ -79,10 +87,10 @@ function waitForStoryRendered(channel: Channel): Promise<void> & { cancel: () =>
79
87
  resolveCallback();
80
88
  }
81
89
  function removeHandlers(): void {
82
- channel.off(Events.STORY_RENDERED, renderHandler);
90
+ channel.off(StorybookEvents.STORY_RENDERED, renderHandler);
83
91
  }
84
92
 
85
- channel.once(Events.STORY_RENDERED, renderHandler);
93
+ channel.once(StorybookEvents.STORY_RENDERED, renderHandler);
86
94
 
87
95
  return Object.assign(promise, { cancel: removeHandlers });
88
96
  }
@@ -132,6 +140,7 @@ let captureResolver: () => void;
132
140
  let waitForCreevey: Promise<void>;
133
141
  let creeveyReady: () => void;
134
142
  let setStoriesCounter = 0;
143
+ let globals = {};
135
144
 
136
145
  export function withCreevey(): ReturnType<typeof makeDecorator> {
137
146
  const addonsChannel = (): Channel => window.__STORYBOOK_ADDONS_CHANNEL__;
@@ -166,7 +175,7 @@ export function withCreevey(): ReturnType<typeof makeDecorator> {
166
175
  return stories;
167
176
  }
168
177
 
169
- // TODO Use Events.STORY_RENDER_PHASE_CHANGED: `loading/rendering/completed` with storyId
178
+ // TODO Use StorybookEvents.STORY_RENDER_PHASE_CHANGED: `loading/rendering/completed` with storyId
170
179
  // TODO Check other statuses and statuses with play function
171
180
  async function selectStory(
172
181
  storyId: string,
@@ -188,8 +197,8 @@ export function withCreevey(): ReturnType<typeof makeDecorator> {
188
197
  const capturePromise = waitForCaptureCall().then(() => (isCaptureCalled = true));
189
198
 
190
199
  setTimeout(() => {
191
- if (storyId == currentStory) channel.emit(Events.FORCE_REMOUNT, { storyId });
192
- else channel.emit(Events.SET_CURRENT_STORY, { storyId });
200
+ if (storyId == currentStory) channel.emit(StorybookEvents.FORCE_REMOUNT, { storyId });
201
+ else channel.emit(StorybookEvents.SET_CURRENT_STORY, { storyId });
193
202
  }, 0);
194
203
 
195
204
  try {
@@ -218,8 +227,11 @@ export function withCreevey(): ReturnType<typeof makeDecorator> {
218
227
  }
219
228
  }
220
229
 
221
- function updateGlobals(globals: StorybookGlobals): void {
222
- addonsChannel().emit(Events.UPDATE_GLOBALS, { globals });
230
+ function updateGlobals(newGlobals: StorybookGlobals): void {
231
+ if (isEqual(globals, newGlobals)) return;
232
+
233
+ globals = newGlobals;
234
+ addonsChannel().emit(StorybookEvents.UPDATE_GLOBALS, { globals });
223
235
  }
224
236
 
225
237
  function insertIgnoreStyles(ignoreSelectors: string[]): HTMLStyleElement {
@@ -46,6 +46,24 @@ export const SwapView = withTheme(({ theme, expect, actual, diff }: ViewPropsWit
46
46
  setImage((prevImage) => (prevImage == 'actual' ? 'expect' : 'actual'));
47
47
  }, []);
48
48
 
49
+ const handleKeyDown = useCallback(
50
+ (e: KeyboardEvent) => {
51
+ if (e.code === 'Space' && e.altKey) {
52
+ e.preventDefault();
53
+ handleChangeView();
54
+ }
55
+ },
56
+ [handleChangeView],
57
+ );
58
+
59
+ useEffect(() => {
60
+ document.addEventListener('keydown', handleKeyDown, false);
61
+
62
+ return () => {
63
+ document.removeEventListener('keydown', handleKeyDown, false);
64
+ };
65
+ }, [handleKeyDown]);
66
+
49
67
  useEffect(() => {
50
68
  if (loaded) readyForCapture();
51
69
  }, [loaded]);
@@ -70,6 +70,7 @@ export const ImagePreview = withTheme(
70
70
  onClick(imageName);
71
71
  };
72
72
 
73
+ // TODO Add image name as a title
73
74
  return (
74
75
  <Button
75
76
  onClick={handleClick}
@@ -1,11 +1,11 @@
1
- import React, { JSX, useState } from 'react';
1
+ import React, { JSX, useCallback, useEffect, useState } from 'react';
2
2
  import { Placeholder, ScrollArea } from '@storybook/components';
3
3
  import { styled, withTheme, Theme } from '@storybook/theming';
4
4
  import { ImagesView } from './ImagesView/ImagesView.js';
5
5
  import { PageHeader } from './PageHeader/PageHeader.js';
6
6
  import { PageFooter } from './PageFooter/PageFooter.js';
7
7
  import { getImageUrl } from '../helpers.js';
8
- import { getViewMode, VIEW_MODE_KEY } from '../viewMode.js';
8
+ import { getViewMode, VIEW_MODE_KEY, viewModes } from '../viewMode.js';
9
9
  import { ImagesViewMode, TestResult } from '../../../types.js';
10
10
 
11
11
  interface ResultsPageProps {
@@ -77,10 +77,31 @@ export function ResultsPageInternal({
77
77
  )
78
78
  : [];
79
79
 
80
- const handleChangeViewMode = (mode: ImagesViewMode): void => {
81
- localStorage.setItem(VIEW_MODE_KEY, mode);
82
- setViewMode(mode);
83
- };
80
+ const handleKeyDown = useCallback(
81
+ (e: KeyboardEvent) => {
82
+ if (!canApprove) return;
83
+ if (e.code === 'Tab') {
84
+ e.preventDefault();
85
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
86
+ if (e.shiftKey) setViewMode((mode) => viewModes.at((viewModes.indexOf(mode) - 1) % viewModes.length)!);
87
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
88
+ else setViewMode((mode) => viewModes.at((viewModes.indexOf(mode) + 1) % viewModes.length)!);
89
+ }
90
+ },
91
+ [canApprove],
92
+ );
93
+
94
+ useEffect(() => {
95
+ localStorage.setItem(VIEW_MODE_KEY, viewMode);
96
+ }, [viewMode]);
97
+
98
+ useEffect(() => {
99
+ document.addEventListener('keydown', handleKeyDown, false);
100
+
101
+ return () => {
102
+ document.removeEventListener('keydown', handleKeyDown, false);
103
+ };
104
+ }, [handleKeyDown]);
84
105
 
85
106
  return (
86
107
  <Container height={height}>
@@ -92,7 +113,7 @@ export function ResultsPageInternal({
92
113
  errorMessage={result.error}
93
114
  showViewModes={hasDiffAndExpect}
94
115
  viewMode={viewMode}
95
- onViewModeChange={handleChangeViewMode}
116
+ onViewModeChange={setViewMode}
96
117
  onImageChange={onImageChange}
97
118
  imagesWithError={imagesWithError}
98
119
  />
@@ -17,7 +17,7 @@ import {
17
17
  CreeveyViewFilter,
18
18
  getFailedTests,
19
19
  } from '../shared/helpers.js';
20
- import { CreeveyContext } from './CreeveyContext.js';
20
+ import { CreeveyContext, FocusableItem } from './CreeveyContext.js';
21
21
  import { KeyboardEvents } from './KeyboardEventsContext.js';
22
22
  import { SideBar } from './CreeveyView/SideBar/index.js';
23
23
  import { ResultsPage } from '../shared/components/ResultsPage.js';
@@ -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,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
  };
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
 
package/src/index.ts CHANGED
@@ -1,6 +1,4 @@
1
1
  export * from './types.js';
2
2
  export { loadStories as browserStoriesProvider } from './server/providers/browser.js';
3
3
  export { loadStories as hybridStoriesProvider } from './server/providers/hybrid.js';
4
- export { PlaywrightWebdriver } from './server/playwright/webdriver.js';
5
- export { SeleniumWebdriver } from './server/selenium/webdriver.js';
6
4
  export * from './server/testsFiles/parser.js';
@@ -0,0 +1 @@
1
+ export { PlaywrightWebdriver } from './server/playwright/webdriver.js';