Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/sdk-e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,13 @@ jobs:
VIZZLY_COMMIT_MESSAGE: ${{ github.event.pull_request.head.commit.message || github.event.head_commit.message }}
VIZZLY_COMMIT_SHA: ${{ github.event.pull_request.head.sha || github.event.head_commit.id }}

- name: Upload preview
if: success()
working-directory: ./clients/storybook
run: ../../bin/vizzly.js preview example-storybook/dist
env:
VIZZLY_TOKEN: ${{ secrets.VIZZLY_STORYBOOK_CLIENT_TOKEN }}

# Static-Site SDK
static-site:
name: Static-Site SDK
Expand Down
5 changes: 5 additions & 0 deletions clients/storybook/src/screenshot.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ try {
vizzlyScreenshot = async () => {};
}

/** @internal Replace vizzlyScreenshot for testing */
export function _setVizzlyScreenshot(fn) {
vizzlyScreenshot = fn;
}

/**
* Generate screenshot name from story and viewport
* Format: "ComponentName-StoryName@viewportName"
Expand Down
33 changes: 25 additions & 8 deletions clients/storybook/tests/screenshot.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import assert from 'node:assert/strict';
import { describe, it, mock } from 'node:test';
import {
_setVizzlyScreenshot,
captureAndSendScreenshot,
captureScreenshot,
generateScreenshotName,
Expand Down Expand Up @@ -86,24 +87,40 @@ describe('captureScreenshot', () => {
});

describe('captureAndSendScreenshot', () => {
it('should capture and send screenshot to vizzly', async () => {
it('should send the iframe URL for isolated story preview', async () => {
let mockVizzly = mock.fn(async () => {});
_setVizzlyScreenshot(mockVizzly);

let mockBuffer = Buffer.from('fake-screenshot');
let mockScreenshot = mock.fn(() => mockBuffer);
let mockPage = { screenshot: mockScreenshot, url: () => 'http://localhost:6006/?path=/story/button--primary' };
let story = { title: 'Button', name: 'Primary' };
let iframeUrl =
'http://localhost:6006/iframe.html?id=button--primary&viewMode=story';
let mockPage = {
screenshot: mock.fn(() => mockBuffer),
url: () => iframeUrl,
};
let story = { id: 'button--primary', title: 'Button', name: 'Primary' };
let viewport = { name: 'desktop' };

// This will use the mock vizzlyScreenshot from the module
await captureAndSendScreenshot(mockPage, story, viewport);

assert.equal(mockScreenshot.mock.calls.length, 1);
assert.equal(mockVizzly.mock.calls.length, 1);
let [name, , options] = mockVizzly.mock.calls[0].arguments;
assert.equal(name, 'Button-Primary@desktop');
assert.equal(options.properties.url, iframeUrl);
});

it('should pass screenshot options through', async () => {
let mockVizzly = mock.fn(async () => {});
_setVizzlyScreenshot(mockVizzly);

let mockBuffer = Buffer.from('fake-screenshot');
let mockScreenshot = mock.fn(() => mockBuffer);
let mockPage = { screenshot: mockScreenshot, url: () => 'http://localhost:6006/?path=/story/card--default' };
let story = { title: 'Card', name: 'Default' };
let mockPage = {
screenshot: mockScreenshot,
url: () =>
'http://localhost:6006/iframe.html?id=card--default&viewMode=story',
};
let story = { id: 'card--default', title: 'Card', name: 'Default' };
let viewport = { name: 'mobile' };

await captureAndSendScreenshot(mockPage, story, viewport, {
Expand Down