@cappa/plugin-storybook 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/dist/index.d.mts +22 -1
- package/dist/index.d.ts +22 -1
- package/dist/index.js +81 -29
- package/dist/index.mjs +81 -29
- package/dist/preview.mjs +4 -2
- package/package.json +3 -3
- package/src/cappa/plugin.ts +111 -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
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,27 +294,11 @@ var cappaPluginStorybook = (options) => {
|
|
|
266
294
|
await page.setViewportSize(resolvedViewport);
|
|
267
295
|
await freezeUI(page);
|
|
268
296
|
await waitForVisualIdle(page);
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
id: variant.id,
|
|
273
|
-
label: variant.label,
|
|
274
|
-
filename: variant.filename,
|
|
275
|
-
options: variant.options ? {
|
|
276
|
-
...variant.options,
|
|
277
|
-
mask: toLocatorMask(variant.options.mask)
|
|
278
|
-
} : void 0
|
|
279
|
-
})
|
|
297
|
+
await waitForPlayFunctionCompletion(
|
|
298
|
+
page,
|
|
299
|
+
`${story.title} - ${story.name}`
|
|
280
300
|
);
|
|
281
|
-
const
|
|
282
|
-
fullPage: storyParameters?.fullPage,
|
|
283
|
-
delay: storyParameters?.delay,
|
|
284
|
-
omitBackground: storyParameters?.omitBackground,
|
|
285
|
-
skip: storyParameters?.skip,
|
|
286
|
-
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
287
|
-
mask: toLocatorMask(storyParameters?.mask),
|
|
288
|
-
variants: screenshotVariants.length ? screenshotVariants : void 0
|
|
289
|
-
};
|
|
301
|
+
const toLocatorMask = (mask) => mask?.map((selector) => page.locator(selector));
|
|
290
302
|
const filename = buildFilename(story);
|
|
291
303
|
const expectedExists = screenshotTool.filesystem.hasExpectedFile(filename);
|
|
292
304
|
if (!expectedExists) {
|
|
@@ -294,12 +306,50 @@ var cappaPluginStorybook = (options) => {
|
|
|
294
306
|
`Expected image not found for story ${story.title} - ${story.name}, taking screenshot`
|
|
295
307
|
);
|
|
296
308
|
}
|
|
309
|
+
const variantsWithUrls = variantParameters.map(
|
|
310
|
+
(variant) => {
|
|
311
|
+
const variantFilename = variant.filename || screenshotTool.getVariantFilename(filename, {
|
|
312
|
+
id: variant.id,
|
|
313
|
+
label: variant.label,
|
|
314
|
+
filename: variant.filename
|
|
315
|
+
});
|
|
316
|
+
const mergedArgs = {
|
|
317
|
+
...defaultStorybookOptions?.args,
|
|
318
|
+
...variant.options?.args
|
|
319
|
+
};
|
|
320
|
+
return {
|
|
321
|
+
id: variant.id,
|
|
322
|
+
label: variant.label,
|
|
323
|
+
filename: variantFilename,
|
|
324
|
+
url: buildStorybookIframeUrl({
|
|
325
|
+
baseUrl: options?.storybookUrl || "",
|
|
326
|
+
storyId: story.id,
|
|
327
|
+
viewMode: defaultStorybookOptions?.viewMode,
|
|
328
|
+
args: mergedArgs,
|
|
329
|
+
globals: defaultStorybookOptions?.globals,
|
|
330
|
+
query: defaultStorybookOptions?.query,
|
|
331
|
+
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
332
|
+
singleStory: defaultStorybookOptions?.singleStory
|
|
333
|
+
}),
|
|
334
|
+
options: variant.options ? {
|
|
335
|
+
...variant.options,
|
|
336
|
+
mask: toLocatorMask(variant.options.mask)
|
|
337
|
+
} : void 0
|
|
338
|
+
};
|
|
339
|
+
}
|
|
340
|
+
);
|
|
341
|
+
const baseOptions = {
|
|
342
|
+
fullPage: storyParameters?.fullPage,
|
|
343
|
+
delay: storyParameters?.delay,
|
|
344
|
+
omitBackground: storyParameters?.omitBackground,
|
|
345
|
+
skip: storyParameters?.skip,
|
|
346
|
+
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
347
|
+
mask: toLocatorMask(storyParameters?.mask)
|
|
348
|
+
};
|
|
297
349
|
const variantFilenameMap = /* @__PURE__ */ new Map();
|
|
298
|
-
for (const variant of
|
|
299
|
-
const variantFilename =
|
|
300
|
-
|
|
301
|
-
variant
|
|
302
|
-
);
|
|
350
|
+
for (const variant of variantsWithUrls) {
|
|
351
|
+
const variantFilename = variant.filename;
|
|
352
|
+
if (!variantFilename) continue;
|
|
303
353
|
variantFilenameMap.set(variant.id, variantFilename);
|
|
304
354
|
if (!screenshotTool.filesystem.hasExpectedFile(variantFilename)) {
|
|
305
355
|
logger.info(
|
|
@@ -307,12 +357,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
307
357
|
);
|
|
308
358
|
}
|
|
309
359
|
}
|
|
310
|
-
const variantExtrasEntries =
|
|
360
|
+
const variantExtrasEntries = variantsWithUrls.map(
|
|
311
361
|
(variant) => [
|
|
312
362
|
variant.id,
|
|
313
363
|
{
|
|
314
364
|
saveDiffImage: true,
|
|
315
|
-
diffImageFilename:
|
|
365
|
+
diffImageFilename: variant.filename
|
|
316
366
|
}
|
|
317
367
|
]
|
|
318
368
|
);
|
|
@@ -321,10 +371,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
321
371
|
diffImageFilename: filename,
|
|
322
372
|
variants: variantExtrasEntries.length ? Object.fromEntries(variantExtrasEntries) : void 0
|
|
323
373
|
};
|
|
324
|
-
const captureResult = await screenshotTool.
|
|
374
|
+
const captureResult = await screenshotTool.captureWithVariants(
|
|
325
375
|
page,
|
|
326
376
|
filename,
|
|
327
|
-
|
|
377
|
+
url,
|
|
378
|
+
baseOptions,
|
|
379
|
+
variantsWithUrls,
|
|
328
380
|
captureExtras
|
|
329
381
|
);
|
|
330
382
|
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,27 +264,11 @@ var cappaPluginStorybook = (options) => {
|
|
|
236
264
|
await page.setViewportSize(resolvedViewport);
|
|
237
265
|
await freezeUI(page);
|
|
238
266
|
await waitForVisualIdle(page);
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
id: variant.id,
|
|
243
|
-
label: variant.label,
|
|
244
|
-
filename: variant.filename,
|
|
245
|
-
options: variant.options ? {
|
|
246
|
-
...variant.options,
|
|
247
|
-
mask: toLocatorMask(variant.options.mask)
|
|
248
|
-
} : void 0
|
|
249
|
-
})
|
|
267
|
+
await waitForPlayFunctionCompletion(
|
|
268
|
+
page,
|
|
269
|
+
`${story.title} - ${story.name}`
|
|
250
270
|
);
|
|
251
|
-
const
|
|
252
|
-
fullPage: storyParameters?.fullPage,
|
|
253
|
-
delay: storyParameters?.delay,
|
|
254
|
-
omitBackground: storyParameters?.omitBackground,
|
|
255
|
-
skip: storyParameters?.skip,
|
|
256
|
-
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
257
|
-
mask: toLocatorMask(storyParameters?.mask),
|
|
258
|
-
variants: screenshotVariants.length ? screenshotVariants : void 0
|
|
259
|
-
};
|
|
271
|
+
const toLocatorMask = (mask) => mask?.map((selector) => page.locator(selector));
|
|
260
272
|
const filename = buildFilename(story);
|
|
261
273
|
const expectedExists = screenshotTool.filesystem.hasExpectedFile(filename);
|
|
262
274
|
if (!expectedExists) {
|
|
@@ -264,12 +276,50 @@ var cappaPluginStorybook = (options) => {
|
|
|
264
276
|
`Expected image not found for story ${story.title} - ${story.name}, taking screenshot`
|
|
265
277
|
);
|
|
266
278
|
}
|
|
279
|
+
const variantsWithUrls = variantParameters.map(
|
|
280
|
+
(variant) => {
|
|
281
|
+
const variantFilename = variant.filename || screenshotTool.getVariantFilename(filename, {
|
|
282
|
+
id: variant.id,
|
|
283
|
+
label: variant.label,
|
|
284
|
+
filename: variant.filename
|
|
285
|
+
});
|
|
286
|
+
const mergedArgs = {
|
|
287
|
+
...defaultStorybookOptions?.args,
|
|
288
|
+
...variant.options?.args
|
|
289
|
+
};
|
|
290
|
+
return {
|
|
291
|
+
id: variant.id,
|
|
292
|
+
label: variant.label,
|
|
293
|
+
filename: variantFilename,
|
|
294
|
+
url: buildStorybookIframeUrl({
|
|
295
|
+
baseUrl: options?.storybookUrl || "",
|
|
296
|
+
storyId: story.id,
|
|
297
|
+
viewMode: defaultStorybookOptions?.viewMode,
|
|
298
|
+
args: mergedArgs,
|
|
299
|
+
globals: defaultStorybookOptions?.globals,
|
|
300
|
+
query: defaultStorybookOptions?.query,
|
|
301
|
+
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
302
|
+
singleStory: defaultStorybookOptions?.singleStory
|
|
303
|
+
}),
|
|
304
|
+
options: variant.options ? {
|
|
305
|
+
...variant.options,
|
|
306
|
+
mask: toLocatorMask(variant.options.mask)
|
|
307
|
+
} : void 0
|
|
308
|
+
};
|
|
309
|
+
}
|
|
310
|
+
);
|
|
311
|
+
const baseOptions = {
|
|
312
|
+
fullPage: storyParameters?.fullPage,
|
|
313
|
+
delay: storyParameters?.delay,
|
|
314
|
+
omitBackground: storyParameters?.omitBackground,
|
|
315
|
+
skip: storyParameters?.skip,
|
|
316
|
+
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
317
|
+
mask: toLocatorMask(storyParameters?.mask)
|
|
318
|
+
};
|
|
267
319
|
const variantFilenameMap = /* @__PURE__ */ new Map();
|
|
268
|
-
for (const variant of
|
|
269
|
-
const variantFilename =
|
|
270
|
-
|
|
271
|
-
variant
|
|
272
|
-
);
|
|
320
|
+
for (const variant of variantsWithUrls) {
|
|
321
|
+
const variantFilename = variant.filename;
|
|
322
|
+
if (!variantFilename) continue;
|
|
273
323
|
variantFilenameMap.set(variant.id, variantFilename);
|
|
274
324
|
if (!screenshotTool.filesystem.hasExpectedFile(variantFilename)) {
|
|
275
325
|
logger.info(
|
|
@@ -277,12 +327,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
277
327
|
);
|
|
278
328
|
}
|
|
279
329
|
}
|
|
280
|
-
const variantExtrasEntries =
|
|
330
|
+
const variantExtrasEntries = variantsWithUrls.map(
|
|
281
331
|
(variant) => [
|
|
282
332
|
variant.id,
|
|
283
333
|
{
|
|
284
334
|
saveDiffImage: true,
|
|
285
|
-
diffImageFilename:
|
|
335
|
+
diffImageFilename: variant.filename
|
|
286
336
|
}
|
|
287
337
|
]
|
|
288
338
|
);
|
|
@@ -291,10 +341,12 @@ var cappaPluginStorybook = (options) => {
|
|
|
291
341
|
diffImageFilename: filename,
|
|
292
342
|
variants: variantExtrasEntries.length ? Object.fromEntries(variantExtrasEntries) : void 0
|
|
293
343
|
};
|
|
294
|
-
const captureResult = await screenshotTool.
|
|
344
|
+
const captureResult = await screenshotTool.captureWithVariants(
|
|
295
345
|
page,
|
|
296
346
|
filename,
|
|
297
|
-
|
|
347
|
+
url,
|
|
348
|
+
baseOptions,
|
|
349
|
+
variantsWithUrls,
|
|
298
350
|
captureExtras
|
|
299
351
|
);
|
|
300
352
|
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.1",
|
|
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.1",
|
|
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,32 +252,14 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
210
252
|
await freezeUI(page);
|
|
211
253
|
await waitForVisualIdle(page);
|
|
212
254
|
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
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
|
-
}),
|
|
255
|
+
// Wait for play function to complete if it exists
|
|
256
|
+
await waitForPlayFunctionCompletion(
|
|
257
|
+
page,
|
|
258
|
+
`${story.title} - ${story.name}`,
|
|
228
259
|
);
|
|
229
260
|
|
|
230
|
-
const
|
|
231
|
-
|
|
232
|
-
delay: storyParameters?.delay,
|
|
233
|
-
omitBackground: storyParameters?.omitBackground,
|
|
234
|
-
skip: storyParameters?.skip,
|
|
235
|
-
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
236
|
-
mask: toLocatorMask(storyParameters?.mask),
|
|
237
|
-
variants: screenshotVariants.length ? screenshotVariants : undefined,
|
|
238
|
-
};
|
|
261
|
+
const toLocatorMask = (mask?: string[]) =>
|
|
262
|
+
mask?.map((selector) => page.locator(selector));
|
|
239
263
|
|
|
240
264
|
const filename = buildFilename(story);
|
|
241
265
|
const expectedExists =
|
|
@@ -246,12 +270,62 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
246
270
|
);
|
|
247
271
|
}
|
|
248
272
|
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
273
|
+
// Convert variants to the new format with URLs
|
|
274
|
+
const variantsWithUrls: ScreenshotVariantWithUrl[] =
|
|
275
|
+
variantParameters.map(
|
|
276
|
+
(variant: ScreenshotVariantOptionsStorybook) => {
|
|
277
|
+
const variantFilename =
|
|
278
|
+
variant.filename ||
|
|
279
|
+
screenshotTool.getVariantFilename(filename, {
|
|
280
|
+
id: variant.id,
|
|
281
|
+
label: variant.label,
|
|
282
|
+
filename: variant.filename,
|
|
283
|
+
});
|
|
284
|
+
|
|
285
|
+
// Merge variant args with default storybook options
|
|
286
|
+
const mergedArgs = {
|
|
287
|
+
...defaultStorybookOptions?.args,
|
|
288
|
+
...variant.options?.args,
|
|
289
|
+
};
|
|
290
|
+
|
|
291
|
+
return {
|
|
292
|
+
id: variant.id,
|
|
293
|
+
label: variant.label,
|
|
294
|
+
filename: variantFilename,
|
|
295
|
+
url: buildStorybookIframeUrl({
|
|
296
|
+
baseUrl: options?.storybookUrl || "",
|
|
297
|
+
storyId: story.id,
|
|
298
|
+
viewMode: defaultStorybookOptions?.viewMode,
|
|
299
|
+
args: mergedArgs,
|
|
300
|
+
globals: defaultStorybookOptions?.globals,
|
|
301
|
+
query: defaultStorybookOptions?.query,
|
|
302
|
+
fullscreen: defaultStorybookOptions?.fullscreen,
|
|
303
|
+
singleStory: defaultStorybookOptions?.singleStory,
|
|
304
|
+
}),
|
|
305
|
+
options: variant.options
|
|
306
|
+
? {
|
|
307
|
+
...variant.options,
|
|
308
|
+
mask: toLocatorMask(variant.options.mask),
|
|
309
|
+
}
|
|
310
|
+
: undefined,
|
|
311
|
+
};
|
|
312
|
+
},
|
|
254
313
|
);
|
|
314
|
+
|
|
315
|
+
const baseOptions = {
|
|
316
|
+
fullPage: storyParameters?.fullPage,
|
|
317
|
+
delay: storyParameters?.delay,
|
|
318
|
+
omitBackground: storyParameters?.omitBackground,
|
|
319
|
+
skip: storyParameters?.skip,
|
|
320
|
+
viewport: storyParameters?.viewport ?? screenshotTool.viewport,
|
|
321
|
+
mask: toLocatorMask(storyParameters?.mask),
|
|
322
|
+
};
|
|
323
|
+
|
|
324
|
+
const variantFilenameMap = new Map<string, string>();
|
|
325
|
+
for (const variant of variantsWithUrls) {
|
|
326
|
+
const variantFilename = variant.filename;
|
|
327
|
+
if (!variantFilename) continue; // Skip if no filename
|
|
328
|
+
|
|
255
329
|
variantFilenameMap.set(variant.id, variantFilename);
|
|
256
330
|
|
|
257
331
|
if (!screenshotTool.filesystem.hasExpectedFile(variantFilename)) {
|
|
@@ -261,14 +335,13 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
261
335
|
}
|
|
262
336
|
}
|
|
263
337
|
|
|
264
|
-
const variantExtrasEntries =
|
|
338
|
+
const variantExtrasEntries = variantsWithUrls.map(
|
|
265
339
|
(variant) =>
|
|
266
340
|
[
|
|
267
341
|
variant.id,
|
|
268
342
|
{
|
|
269
343
|
saveDiffImage: true,
|
|
270
|
-
diffImageFilename:
|
|
271
|
-
variantFilenameMap.get(variant.id) ?? filename,
|
|
344
|
+
diffImageFilename: variant.filename,
|
|
272
345
|
},
|
|
273
346
|
] as const,
|
|
274
347
|
);
|
|
@@ -281,10 +354,12 @@ export const cappaPluginStorybook: Plugin<StorybookPluginOptions> = (
|
|
|
281
354
|
: undefined,
|
|
282
355
|
};
|
|
283
356
|
|
|
284
|
-
const captureResult = await screenshotTool.
|
|
357
|
+
const captureResult = await screenshotTool.captureWithVariants(
|
|
285
358
|
page,
|
|
286
359
|
filename,
|
|
287
|
-
|
|
360
|
+
url,
|
|
361
|
+
baseOptions,
|
|
362
|
+
variantsWithUrls,
|
|
288
363
|
captureExtras,
|
|
289
364
|
);
|
|
290
365
|
|
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
|
}
|