@cappa/plugin-storybook 0.2.0 → 0.2.2
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.
- package/CHANGELOG.md +17 -0
- package/dist/index.d.mts +22 -1
- package/dist/index.d.ts +22 -1
- package/dist/index.js +75 -29
- package/dist/index.mjs +75 -29
- package/dist/preview.mjs +4 -2
- package/package.json +3 -3
- package/src/cappa/plugin.ts +104 -36
- package/src/index.ts +2 -0
- package/src/storybook/addon/decorator.ts +5 -3
- package/src/storybook/addon/preview.ts +1 -0
- package/src/types.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# @cappa/plugin-storybook
|
|
2
2
|
|
|
3
|
+
## 0.2.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 6526418: fix: actual screenshot error
|
|
8
|
+
- Updated dependencies [6526418]
|
|
9
|
+
- @cappa/core@0.2.2
|
|
10
|
+
|
|
11
|
+
## 0.2.1
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- 526857a: feat: add variant and play function support
|
|
16
|
+
- Updated dependencies [526857a]
|
|
17
|
+
- @cappa/core@0.2.1
|
|
18
|
+
- @cappa/logger@0.0.4
|
|
19
|
+
|
|
3
20
|
## 0.2.0
|
|
4
21
|
|
|
5
22
|
### Minor Changes
|
package/dist/index.d.mts
CHANGED
|
@@ -8,6 +8,27 @@ interface StorybookRenderOptions {
|
|
|
8
8
|
fullscreen?: boolean;
|
|
9
9
|
singleStory?: boolean;
|
|
10
10
|
}
|
|
11
|
+
interface ScreenshotVariantOverrideStorybook {
|
|
12
|
+
fullPage?: boolean;
|
|
13
|
+
delay?: number;
|
|
14
|
+
skip?: boolean;
|
|
15
|
+
mask?: string[];
|
|
16
|
+
omitBackground?: boolean;
|
|
17
|
+
viewport?: {
|
|
18
|
+
width: number;
|
|
19
|
+
height: number;
|
|
20
|
+
};
|
|
21
|
+
args?: Record<string, unknown>;
|
|
22
|
+
}
|
|
23
|
+
interface ScreenshotVariantOptionsStorybook {
|
|
24
|
+
id: string;
|
|
25
|
+
label?: string;
|
|
26
|
+
filename?: string;
|
|
27
|
+
options?: ScreenshotVariantOverrideStorybook;
|
|
28
|
+
}
|
|
29
|
+
interface ScreenshotOptionsStorybook extends ScreenshotVariantOverrideStorybook {
|
|
30
|
+
variants?: ScreenshotVariantOptionsStorybook[];
|
|
31
|
+
}
|
|
11
32
|
|
|
12
33
|
interface StorybookPluginOptions {
|
|
13
34
|
storybookUrl: string;
|
|
@@ -29,4 +50,4 @@ declare const cappaPluginStorybook: Plugin<StorybookPluginOptions>;
|
|
|
29
50
|
|
|
30
51
|
declare const previewAnnotations: string[];
|
|
31
52
|
|
|
32
|
-
export { cappaPluginStorybook, previewAnnotations };
|
|
53
|
+
export { type ScreenshotOptionsStorybook as CappaStorybookOptions, cappaPluginStorybook, previewAnnotations };
|
package/dist/index.d.ts
CHANGED
|
@@ -8,6 +8,27 @@ interface StorybookRenderOptions {
|
|
|
8
8
|
fullscreen?: boolean;
|
|
9
9
|
singleStory?: boolean;
|
|
10
10
|
}
|
|
11
|
+
interface ScreenshotVariantOverrideStorybook {
|
|
12
|
+
fullPage?: boolean;
|
|
13
|
+
delay?: number;
|
|
14
|
+
skip?: boolean;
|
|
15
|
+
mask?: string[];
|
|
16
|
+
omitBackground?: boolean;
|
|
17
|
+
viewport?: {
|
|
18
|
+
width: number;
|
|
19
|
+
height: number;
|
|
20
|
+
};
|
|
21
|
+
args?: Record<string, unknown>;
|
|
22
|
+
}
|
|
23
|
+
interface ScreenshotVariantOptionsStorybook {
|
|
24
|
+
id: string;
|
|
25
|
+
label?: string;
|
|
26
|
+
filename?: string;
|
|
27
|
+
options?: ScreenshotVariantOverrideStorybook;
|
|
28
|
+
}
|
|
29
|
+
interface ScreenshotOptionsStorybook extends ScreenshotVariantOverrideStorybook {
|
|
30
|
+
variants?: ScreenshotVariantOptionsStorybook[];
|
|
31
|
+
}
|
|
11
32
|
|
|
12
33
|
interface StorybookPluginOptions {
|
|
13
34
|
storybookUrl: string;
|
|
@@ -29,4 +50,4 @@ declare const cappaPluginStorybook: Plugin<StorybookPluginOptions>;
|
|
|
29
50
|
|
|
30
51
|
declare const previewAnnotations: string[];
|
|
31
52
|
|
|
32
|
-
export { cappaPluginStorybook, previewAnnotations };
|
|
53
|
+
export { type ScreenshotOptionsStorybook as CappaStorybookOptions, cappaPluginStorybook, previewAnnotations };
|
package/dist/index.js
CHANGED
|
@@ -149,6 +149,33 @@ var buildFilename = (story) => {
|
|
|
149
149
|
};
|
|
150
150
|
|
|
151
151
|
// src/cappa/plugin.ts
|
|
152
|
+
async function waitForPlayFunctionCompletion(page, storyName) {
|
|
153
|
+
const logger = (0, import_logger.getLogger)();
|
|
154
|
+
try {
|
|
155
|
+
const hasPlayFunction = await page.evaluate(
|
|
156
|
+
() => window.__cappa_has_play_function === true
|
|
157
|
+
);
|
|
158
|
+
if (!hasPlayFunction) {
|
|
159
|
+
return;
|
|
160
|
+
}
|
|
161
|
+
logger.debug(
|
|
162
|
+
`Waiting for play function to complete for story: ${storyName}`
|
|
163
|
+
);
|
|
164
|
+
await page.waitForFunction(() => window.playAfterEach === true, {
|
|
165
|
+
timeout: 1e4
|
|
166
|
+
});
|
|
167
|
+
logger.debug(`Play function completed for story: ${storyName}`);
|
|
168
|
+
await page.evaluate(() => {
|
|
169
|
+
window.playAfterEach = false;
|
|
170
|
+
window.__cappa_has_play_function = false;
|
|
171
|
+
});
|
|
172
|
+
} catch {
|
|
173
|
+
await page.evaluate(() => {
|
|
174
|
+
window.playAfterEach = false;
|
|
175
|
+
window.__cappa_has_play_function = false;
|
|
176
|
+
});
|
|
177
|
+
}
|
|
178
|
+
}
|
|
152
179
|
function createLatch() {
|
|
153
180
|
let resolve;
|
|
154
181
|
const p = new Promise((r) => resolve = r);
|
|
@@ -228,6 +255,7 @@ var cappaPluginStorybook = (options) => {
|
|
|
228
255
|
const { url, data } = task;
|
|
229
256
|
const { story } = data;
|
|
230
257
|
const logger = (0, import_logger.getLogger)();
|
|
258
|
+
const { storybook: defaultStorybookOptions } = options || {};
|
|
231
259
|
try {
|
|
232
260
|
const currentLatch = createLatch();
|
|
233
261
|
context.latchMap.set(story.id, currentLatch);
|
|
@@ -266,40 +294,56 @@ var cappaPluginStorybook = (options) => {
|
|
|
266
294
|
await page.setViewportSize(resolvedViewport);
|
|
267
295
|
await freezeUI(page);
|
|
268
296
|
await waitForVisualIdle(page);
|
|
297
|
+
await waitForPlayFunctionCompletion(
|
|
298
|
+
page,
|
|
299
|
+
`${story.title} - ${story.name}`
|
|
300
|
+
);
|
|
269
301
|
const toLocatorMask = (mask) => mask?.map((selector) => page.locator(selector));
|
|
270
|
-
const
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
302
|
+
const filename = buildFilename(story);
|
|
303
|
+
const variantsWithUrls = variantParameters.map(
|
|
304
|
+
(variant) => {
|
|
305
|
+
const variantFilename = variant.filename || screenshotTool.getVariantFilename(filename, {
|
|
306
|
+
id: variant.id,
|
|
307
|
+
label: variant.label,
|
|
308
|
+
filename: variant.filename
|
|
309
|
+
});
|
|
310
|
+
const mergedArgs = {
|
|
311
|
+
...defaultStorybookOptions?.args,
|
|
312
|
+
...variant.options?.args
|
|
313
|
+
};
|
|
314
|
+
return {
|
|
315
|
+
id: variant.id,
|
|
316
|
+
label: variant.label,
|
|
317
|
+
filename: variantFilename,
|
|
318
|
+
url: buildStorybookIframeUrl({
|
|
319
|
+
baseUrl: options?.storybookUrl || "",
|
|
320
|
+
storyId: story.id,
|
|
321
|
+
viewMode: defaultStorybookOptions?.viewMode,
|
|
322
|
+
args: mergedArgs,
|
|
323
|
+
globals: defaultStorybookOptions?.globals,
|
|
324
|
+
query: defaultStorybookOptions?.query,
|
|
325
|
+
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
326
|
+
singleStory: defaultStorybookOptions?.singleStory
|
|
327
|
+
}),
|
|
328
|
+
options: variant.options ? {
|
|
329
|
+
...variant.options,
|
|
330
|
+
mask: toLocatorMask(variant.options.mask)
|
|
331
|
+
} : void 0
|
|
332
|
+
};
|
|
333
|
+
}
|
|
280
334
|
);
|
|
281
|
-
const
|
|
335
|
+
const baseOptions = {
|
|
282
336
|
fullPage: storyParameters?.fullPage,
|
|
283
337
|
delay: storyParameters?.delay,
|
|
284
338
|
omitBackground: storyParameters?.omitBackground,
|
|
285
339
|
skip: storyParameters?.skip,
|
|
286
340
|
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
287
|
-
mask: toLocatorMask(storyParameters?.mask)
|
|
288
|
-
variants: screenshotVariants.length ? screenshotVariants : void 0
|
|
341
|
+
mask: toLocatorMask(storyParameters?.mask)
|
|
289
342
|
};
|
|
290
|
-
const filename = buildFilename(story);
|
|
291
|
-
const expectedExists = screenshotTool.filesystem.hasExpectedFile(filename);
|
|
292
|
-
if (!expectedExists) {
|
|
293
|
-
logger.info(
|
|
294
|
-
`Expected image not found for story ${story.title} - ${story.name}, taking screenshot`
|
|
295
|
-
);
|
|
296
|
-
}
|
|
297
343
|
const variantFilenameMap = /* @__PURE__ */ new Map();
|
|
298
|
-
for (const variant of
|
|
299
|
-
const variantFilename =
|
|
300
|
-
|
|
301
|
-
variant
|
|
302
|
-
);
|
|
344
|
+
for (const variant of variantsWithUrls) {
|
|
345
|
+
const variantFilename = variant.filename;
|
|
346
|
+
if (!variantFilename) continue;
|
|
303
347
|
variantFilenameMap.set(variant.id, variantFilename);
|
|
304
348
|
if (!screenshotTool.filesystem.hasExpectedFile(variantFilename)) {
|
|
305
349
|
logger.info(
|
|
@@ -307,12 +351,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
307
351
|
);
|
|
308
352
|
}
|
|
309
353
|
}
|
|
310
|
-
const variantExtrasEntries =
|
|
354
|
+
const variantExtrasEntries = variantsWithUrls.map(
|
|
311
355
|
(variant) => [
|
|
312
356
|
variant.id,
|
|
313
357
|
{
|
|
314
358
|
saveDiffImage: true,
|
|
315
|
-
diffImageFilename:
|
|
359
|
+
diffImageFilename: variant.filename
|
|
316
360
|
}
|
|
317
361
|
]
|
|
318
362
|
);
|
|
@@ -321,10 +365,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
321
365
|
diffImageFilename: filename,
|
|
322
366
|
variants: variantExtrasEntries.length ? Object.fromEntries(variantExtrasEntries) : void 0
|
|
323
367
|
};
|
|
324
|
-
const captureResult = await screenshotTool.
|
|
368
|
+
const captureResult = await screenshotTool.captureWithVariants(
|
|
325
369
|
page,
|
|
326
370
|
filename,
|
|
327
|
-
|
|
371
|
+
url,
|
|
372
|
+
baseOptions,
|
|
373
|
+
variantsWithUrls,
|
|
328
374
|
captureExtras
|
|
329
375
|
);
|
|
330
376
|
return {
|
package/dist/index.mjs
CHANGED
|
@@ -119,6 +119,33 @@ var buildFilename = (story) => {
|
|
|
119
119
|
};
|
|
120
120
|
|
|
121
121
|
// src/cappa/plugin.ts
|
|
122
|
+
async function waitForPlayFunctionCompletion(page, storyName) {
|
|
123
|
+
const logger = getLogger();
|
|
124
|
+
try {
|
|
125
|
+
const hasPlayFunction = await page.evaluate(
|
|
126
|
+
() => window.__cappa_has_play_function === true
|
|
127
|
+
);
|
|
128
|
+
if (!hasPlayFunction) {
|
|
129
|
+
return;
|
|
130
|
+
}
|
|
131
|
+
logger.debug(
|
|
132
|
+
`Waiting for play function to complete for story: ${storyName}`
|
|
133
|
+
);
|
|
134
|
+
await page.waitForFunction(() => window.playAfterEach === true, {
|
|
135
|
+
timeout: 1e4
|
|
136
|
+
});
|
|
137
|
+
logger.debug(`Play function completed for story: ${storyName}`);
|
|
138
|
+
await page.evaluate(() => {
|
|
139
|
+
window.playAfterEach = false;
|
|
140
|
+
window.__cappa_has_play_function = false;
|
|
141
|
+
});
|
|
142
|
+
} catch {
|
|
143
|
+
await page.evaluate(() => {
|
|
144
|
+
window.playAfterEach = false;
|
|
145
|
+
window.__cappa_has_play_function = false;
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
}
|
|
122
149
|
function createLatch() {
|
|
123
150
|
let resolve;
|
|
124
151
|
const p = new Promise((r) => resolve = r);
|
|
@@ -198,6 +225,7 @@ var cappaPluginStorybook = (options) => {
|
|
|
198
225
|
const { url, data } = task;
|
|
199
226
|
const { story } = data;
|
|
200
227
|
const logger = getLogger();
|
|
228
|
+
const { storybook: defaultStorybookOptions } = options || {};
|
|
201
229
|
try {
|
|
202
230
|
const currentLatch = createLatch();
|
|
203
231
|
context.latchMap.set(story.id, currentLatch);
|
|
@@ -236,40 +264,56 @@ var cappaPluginStorybook = (options) => {
|
|
|
236
264
|
await page.setViewportSize(resolvedViewport);
|
|
237
265
|
await freezeUI(page);
|
|
238
266
|
await waitForVisualIdle(page);
|
|
267
|
+
await waitForPlayFunctionCompletion(
|
|
268
|
+
page,
|
|
269
|
+
`${story.title} - ${story.name}`
|
|
270
|
+
);
|
|
239
271
|
const toLocatorMask = (mask) => mask?.map((selector) => page.locator(selector));
|
|
240
|
-
const
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
272
|
+
const filename = buildFilename(story);
|
|
273
|
+
const variantsWithUrls = variantParameters.map(
|
|
274
|
+
(variant) => {
|
|
275
|
+
const variantFilename = variant.filename || screenshotTool.getVariantFilename(filename, {
|
|
276
|
+
id: variant.id,
|
|
277
|
+
label: variant.label,
|
|
278
|
+
filename: variant.filename
|
|
279
|
+
});
|
|
280
|
+
const mergedArgs = {
|
|
281
|
+
...defaultStorybookOptions?.args,
|
|
282
|
+
...variant.options?.args
|
|
283
|
+
};
|
|
284
|
+
return {
|
|
285
|
+
id: variant.id,
|
|
286
|
+
label: variant.label,
|
|
287
|
+
filename: variantFilename,
|
|
288
|
+
url: buildStorybookIframeUrl({
|
|
289
|
+
baseUrl: options?.storybookUrl || "",
|
|
290
|
+
storyId: story.id,
|
|
291
|
+
viewMode: defaultStorybookOptions?.viewMode,
|
|
292
|
+
args: mergedArgs,
|
|
293
|
+
globals: defaultStorybookOptions?.globals,
|
|
294
|
+
query: defaultStorybookOptions?.query,
|
|
295
|
+
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
296
|
+
singleStory: defaultStorybookOptions?.singleStory
|
|
297
|
+
}),
|
|
298
|
+
options: variant.options ? {
|
|
299
|
+
...variant.options,
|
|
300
|
+
mask: toLocatorMask(variant.options.mask)
|
|
301
|
+
} : void 0
|
|
302
|
+
};
|
|
303
|
+
}
|
|
250
304
|
);
|
|
251
|
-
const
|
|
305
|
+
const baseOptions = {
|
|
252
306
|
fullPage: storyParameters?.fullPage,
|
|
253
307
|
delay: storyParameters?.delay,
|
|
254
308
|
omitBackground: storyParameters?.omitBackground,
|
|
255
309
|
skip: storyParameters?.skip,
|
|
256
310
|
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
257
|
-
mask: toLocatorMask(storyParameters?.mask)
|
|
258
|
-
variants: screenshotVariants.length ? screenshotVariants : void 0
|
|
311
|
+
mask: toLocatorMask(storyParameters?.mask)
|
|
259
312
|
};
|
|
260
|
-
const filename = buildFilename(story);
|
|
261
|
-
const expectedExists = screenshotTool.filesystem.hasExpectedFile(filename);
|
|
262
|
-
if (!expectedExists) {
|
|
263
|
-
logger.info(
|
|
264
|
-
`Expected image not found for story ${story.title} - ${story.name}, taking screenshot`
|
|
265
|
-
);
|
|
266
|
-
}
|
|
267
313
|
const variantFilenameMap = /* @__PURE__ */ new Map();
|
|
268
|
-
for (const variant of
|
|
269
|
-
const variantFilename =
|
|
270
|
-
|
|
271
|
-
variant
|
|
272
|
-
);
|
|
314
|
+
for (const variant of variantsWithUrls) {
|
|
315
|
+
const variantFilename = variant.filename;
|
|
316
|
+
if (!variantFilename) continue;
|
|
273
317
|
variantFilenameMap.set(variant.id, variantFilename);
|
|
274
318
|
if (!screenshotTool.filesystem.hasExpectedFile(variantFilename)) {
|
|
275
319
|
logger.info(
|
|
@@ -277,12 +321,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
277
321
|
);
|
|
278
322
|
}
|
|
279
323
|
}
|
|
280
|
-
const variantExtrasEntries =
|
|
324
|
+
const variantExtrasEntries = variantsWithUrls.map(
|
|
281
325
|
(variant) => [
|
|
282
326
|
variant.id,
|
|
283
327
|
{
|
|
284
328
|
saveDiffImage: true,
|
|
285
|
-
diffImageFilename:
|
|
329
|
+
diffImageFilename: variant.filename
|
|
286
330
|
}
|
|
287
331
|
]
|
|
288
332
|
);
|
|
@@ -291,10 +335,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
291
335
|
diffImageFilename: filename,
|
|
292
336
|
variants: variantExtrasEntries.length ? Object.fromEntries(variantExtrasEntries) : void 0
|
|
293
337
|
};
|
|
294
|
-
const captureResult = await screenshotTool.
|
|
338
|
+
const captureResult = await screenshotTool.captureWithVariants(
|
|
295
339
|
page,
|
|
296
340
|
filename,
|
|
297
|
-
|
|
341
|
+
url,
|
|
342
|
+
baseOptions,
|
|
343
|
+
variantsWithUrls,
|
|
298
344
|
captureExtras
|
|
299
345
|
);
|
|
300
346
|
return {
|
package/dist/preview.mjs
CHANGED
|
@@ -25,13 +25,15 @@ var withCappaDecorator = makeDecorator({
|
|
|
25
25
|
skipIfNoParametersOrOptions: false,
|
|
26
26
|
wrapper: (getStory, context, { parameters: parameters2 }) => {
|
|
27
27
|
window.__cappa_screenshot = true;
|
|
28
|
-
|
|
28
|
+
if (context.playFunction != null) {
|
|
29
|
+
window.__cappa_has_play_function = true;
|
|
30
|
+
}
|
|
29
31
|
queueMicrotask(async () => {
|
|
30
32
|
try {
|
|
31
33
|
const cappaParameters = await waitForExposed("__cappa_parameters");
|
|
32
34
|
cappaParameters(context.id, parameters2 ?? {});
|
|
33
35
|
} catch (error) {
|
|
34
|
-
console.error(error);
|
|
36
|
+
console.error("Cappa decorator error:", error);
|
|
35
37
|
}
|
|
36
38
|
});
|
|
37
39
|
return getStory(context);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cappa/plugin-storybook",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Storybook plugin for Cappa - takes screenshots of Storybook stories",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -31,8 +31,8 @@
|
|
|
31
31
|
"@swc/core": "^1.13.5",
|
|
32
32
|
"chalk": "^5.6.2",
|
|
33
33
|
"storybook": "^9.1.12",
|
|
34
|
-
"@cappa/core": "0.2.
|
|
35
|
-
"@cappa/logger": "0.0.
|
|
34
|
+
"@cappa/core": "0.2.2",
|
|
35
|
+
"@cappa/logger": "0.0.4"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"@vitest/coverage-v8": "3.2.4",
|
package/src/cappa/plugin.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type {
|
|
2
2
|
Plugin,
|
|
3
3
|
ScreenshotCaptureExtras,
|
|
4
|
-
|
|
5
|
-
ScreenshotVariant,
|
|
4
|
+
ScreenshotVariantWithUrl,
|
|
6
5
|
} from "@cappa/core";
|
|
7
6
|
import { getLogger } from "@cappa/logger";
|
|
7
|
+
import type { Page } from "playwright-core";
|
|
8
8
|
import type {
|
|
9
9
|
ScreenshotOptionsStorybook,
|
|
10
10
|
ScreenshotVariantOptionsStorybook,
|
|
@@ -13,6 +13,47 @@ import type {
|
|
|
13
13
|
import { buildStorybookIframeUrl } from "./storybook-url";
|
|
14
14
|
import { buildFilename, freezeUI, waitForVisualIdle } from "./util";
|
|
15
15
|
|
|
16
|
+
/**
|
|
17
|
+
* Wait for the play function to complete by checking the playAfterEach flag
|
|
18
|
+
* Only waits if the story actually has a play function
|
|
19
|
+
*/
|
|
20
|
+
async function waitForPlayFunctionCompletion(page: Page, storyName: string) {
|
|
21
|
+
const logger = getLogger();
|
|
22
|
+
|
|
23
|
+
try {
|
|
24
|
+
// First check if this story has a play function
|
|
25
|
+
const hasPlayFunction = await page.evaluate(
|
|
26
|
+
() => (window as any).__cappa_has_play_function === true,
|
|
27
|
+
);
|
|
28
|
+
|
|
29
|
+
if (!hasPlayFunction) {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
logger.debug(
|
|
34
|
+
`Waiting for play function to complete for story: ${storyName}`,
|
|
35
|
+
);
|
|
36
|
+
|
|
37
|
+
await page.waitForFunction(() => (window as any).playAfterEach === true, {
|
|
38
|
+
timeout: 10000,
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
logger.debug(`Play function completed for story: ${storyName}`);
|
|
42
|
+
|
|
43
|
+
// Reset the flags for the next story
|
|
44
|
+
await page.evaluate(() => {
|
|
45
|
+
(window as any).playAfterEach = false;
|
|
46
|
+
(window as any).__cappa_has_play_function = false;
|
|
47
|
+
});
|
|
48
|
+
} catch {
|
|
49
|
+
// Reset flags even on timeout
|
|
50
|
+
await page.evaluate(() => {
|
|
51
|
+
(window as any).playAfterEach = false;
|
|
52
|
+
(window as any).__cappa_has_play_function = false;
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
16
57
|
export interface StorybookStory {
|
|
17
58
|
id: string;
|
|
18
59
|
name: string;
|
|
@@ -154,6 +195,7 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
154
195
|
const { url, data } = task;
|
|
155
196
|
const { story } = data;
|
|
156
197
|
const logger = getLogger();
|
|
198
|
+
const { storybook: defaultStorybookOptions } = options || {};
|
|
157
199
|
|
|
158
200
|
try {
|
|
159
201
|
// Setup exposed function for this page
|
|
@@ -210,48 +252,73 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
210
252
|
await freezeUI(page);
|
|
211
253
|
await waitForVisualIdle(page);
|
|
212
254
|
|
|
255
|
+
// Wait for play function to complete if it exists
|
|
256
|
+
await waitForPlayFunctionCompletion(
|
|
257
|
+
page,
|
|
258
|
+
`${story.title} - ${story.name}`,
|
|
259
|
+
);
|
|
260
|
+
|
|
213
261
|
const toLocatorMask = (mask?: string[]) =>
|
|
214
262
|
mask?.map((selector) => page.locator(selector));
|
|
215
263
|
|
|
216
|
-
const
|
|
217
|
-
(variant: ScreenshotVariantOptionsStorybook) => ({
|
|
218
|
-
id: variant.id,
|
|
219
|
-
label: variant.label,
|
|
220
|
-
filename: variant.filename,
|
|
221
|
-
options: variant.options
|
|
222
|
-
? {
|
|
223
|
-
...variant.options,
|
|
224
|
-
mask: toLocatorMask(variant.options.mask),
|
|
225
|
-
}
|
|
226
|
-
: undefined,
|
|
227
|
-
}),
|
|
228
|
-
);
|
|
264
|
+
const filename = buildFilename(story);
|
|
229
265
|
|
|
230
|
-
|
|
266
|
+
// Convert variants to the new format with URLs
|
|
267
|
+
const variantsWithUrls: ScreenshotVariantWithUrl[] =
|
|
268
|
+
variantParameters.map(
|
|
269
|
+
(variant: ScreenshotVariantOptionsStorybook) => {
|
|
270
|
+
const variantFilename =
|
|
271
|
+
variant.filename ||
|
|
272
|
+
screenshotTool.getVariantFilename(filename, {
|
|
273
|
+
id: variant.id,
|
|
274
|
+
label: variant.label,
|
|
275
|
+
filename: variant.filename,
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
// Merge variant args with default storybook options
|
|
279
|
+
const mergedArgs = {
|
|
280
|
+
...defaultStorybookOptions?.args,
|
|
281
|
+
...variant.options?.args,
|
|
282
|
+
};
|
|
283
|
+
|
|
284
|
+
return {
|
|
285
|
+
id: variant.id,
|
|
286
|
+
label: variant.label,
|
|
287
|
+
filename: variantFilename,
|
|
288
|
+
url: buildStorybookIframeUrl({
|
|
289
|
+
baseUrl: options?.storybookUrl || "",
|
|
290
|
+
storyId: story.id,
|
|
291
|
+
viewMode: defaultStorybookOptions?.viewMode,
|
|
292
|
+
args: mergedArgs,
|
|
293
|
+
globals: defaultStorybookOptions?.globals,
|
|
294
|
+
query: defaultStorybookOptions?.query,
|
|
295
|
+
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
296
|
+
singleStory: defaultStorybookOptions?.singleStory,
|
|
297
|
+
}),
|
|
298
|
+
options: variant.options
|
|
299
|
+
? {
|
|
300
|
+
...variant.options,
|
|
301
|
+
mask: toLocatorMask(variant.options.mask),
|
|
302
|
+
}
|
|
303
|
+
: undefined,
|
|
304
|
+
};
|
|
305
|
+
},
|
|
306
|
+
);
|
|
307
|
+
|
|
308
|
+
const baseOptions = {
|
|
231
309
|
fullPage: storyParameters?.fullPage,
|
|
232
310
|
delay: storyParameters?.delay,
|
|
233
311
|
omitBackground: storyParameters?.omitBackground,
|
|
234
312
|
skip: storyParameters?.skip,
|
|
235
313
|
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
236
314
|
mask: toLocatorMask(storyParameters?.mask),
|
|
237
|
-
variants: screenshotVariants.length ? screenshotVariants : undefined,
|
|
238
315
|
};
|
|
239
316
|
|
|
240
|
-
const filename = buildFilename(story);
|
|
241
|
-
const expectedExists =
|
|
242
|
-
screenshotTool.filesystem.hasExpectedFile(filename);
|
|
243
|
-
if (!expectedExists) {
|
|
244
|
-
logger.info(
|
|
245
|
-
`Expected image not found for story ${story.title} - ${story.name}, taking screenshot`,
|
|
246
|
-
);
|
|
247
|
-
}
|
|
248
|
-
|
|
249
317
|
const variantFilenameMap = new Map<string, string>();
|
|
250
|
-
for (const variant of
|
|
251
|
-
const variantFilename =
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
);
|
|
318
|
+
for (const variant of variantsWithUrls) {
|
|
319
|
+
const variantFilename = variant.filename;
|
|
320
|
+
if (!variantFilename) continue; // Skip if no filename
|
|
321
|
+
|
|
255
322
|
variantFilenameMap.set(variant.id, variantFilename);
|
|
256
323
|
|
|
257
324
|
if (!screenshotTool.filesystem.hasExpectedFile(variantFilename)) {
|
|
@@ -261,14 +328,13 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
261
328
|
}
|
|
262
329
|
}
|
|
263
330
|
|
|
264
|
-
const variantExtrasEntries =
|
|
331
|
+
const variantExtrasEntries = variantsWithUrls.map(
|
|
265
332
|
(variant) =>
|
|
266
333
|
[
|
|
267
334
|
variant.id,
|
|
268
335
|
{
|
|
269
336
|
saveDiffImage: true,
|
|
270
|
-
diffImageFilename:
|
|
271
|
-
variantFilenameMap.get(variant.id) ?? filename,
|
|
337
|
+
diffImageFilename: variant.filename,
|
|
272
338
|
},
|
|
273
339
|
] as const,
|
|
274
340
|
);
|
|
@@ -281,10 +347,12 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
281
347
|
: undefined,
|
|
282
348
|
};
|
|
283
349
|
|
|
284
|
-
const captureResult = await screenshotTool.
|
|
350
|
+
const captureResult = await screenshotTool.captureWithVariants(
|
|
285
351
|
page,
|
|
286
352
|
filename,
|
|
287
|
-
|
|
353
|
+
url,
|
|
354
|
+
baseOptions,
|
|
355
|
+
variantsWithUrls,
|
|
288
356
|
captureExtras,
|
|
289
357
|
);
|
|
290
358
|
|
package/src/index.ts
CHANGED
|
@@ -8,15 +8,17 @@ export const withCappaDecorator = makeDecorator({
|
|
|
8
8
|
wrapper: (getStory, context, { parameters }) => {
|
|
9
9
|
(window as any).__cappa_screenshot = true;
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
// Set indicator if this story has a play function
|
|
12
|
+
if (context.playFunction != null) {
|
|
13
|
+
(window as any).__cappa_has_play_function = true;
|
|
14
|
+
}
|
|
12
15
|
|
|
13
16
|
queueMicrotask(async () => {
|
|
14
17
|
try {
|
|
15
18
|
const cappaParameters = await waitForExposed("__cappa_parameters");
|
|
16
|
-
|
|
17
19
|
cappaParameters(context.id, parameters ?? {});
|
|
18
20
|
} catch (error) {
|
|
19
|
-
console.error(error);
|
|
21
|
+
console.error("Cappa decorator error:", error);
|
|
20
22
|
}
|
|
21
23
|
});
|
|
22
24
|
|
package/src/types.ts
CHANGED
|
@@ -14,6 +14,7 @@ export interface ScreenshotVariantOverrideStorybook {
|
|
|
14
14
|
mask?: string[];
|
|
15
15
|
omitBackground?: boolean;
|
|
16
16
|
viewport?: { width: number; height: number };
|
|
17
|
+
args?: Record<string, unknown>;
|
|
17
18
|
}
|
|
18
19
|
|
|
19
20
|
export interface ScreenshotVariantOptionsStorybook {
|
|
@@ -26,5 +27,4 @@ export interface ScreenshotVariantOptionsStorybook {
|
|
|
26
27
|
export interface ScreenshotOptionsStorybook
|
|
27
28
|
extends ScreenshotVariantOverrideStorybook {
|
|
28
29
|
variants?: ScreenshotVariantOptionsStorybook[];
|
|
29
|
-
storybook?: StorybookRenderOptions;
|
|
30
30
|
}
|