Skip to content

Allow applitools to resize browser using capabilities #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmarmer merged 1 commit into from
Oct 13, 2022
Merged

Allow applitools to resize browser using capabilities #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 18 additions & 5 deletions packages/browser/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ export interface BrowserSessionOptions {
path?: string;
}

export interface ViewportDimensions {
width: number;
height: number;
}

const DefaultGridOptions: Record<Grid, any> = {
local: {
host: 'localhost',
Expand Down Expand Up @@ -102,7 +107,13 @@ export default class BrowserFactory {
this.waitForRoot = options.waitForRoot ?? 1000;
}

private getOptions(options: BrowserSessionOptions) {
private getOptions(
options: BrowserSessionOptions,
browserSize: ViewportDimensions = {
width: 1280,
height: 800,
}
) {
const {
grid,
name,
Expand All @@ -114,6 +125,7 @@ export default class BrowserFactory {
const { name: testName } = options;

const normalGrid = grid ?? 'local';
const windowSizeArg = `--window-size=${browserSize.width},${browserSize.height}`;

const chromeOptions = headless
? {
Expand All @@ -123,10 +135,10 @@ export default class BrowserFactory {
'--disable-extensions',
'--no-sandbox',
'--disable-dev-shm-usage',
'--window-size=1280,800',
windowSizeArg,
],
}
: undefined;
: [windowSizeArg];

const base = gridOptions?.[normalGrid]
? gridOptions[normalGrid]
Expand All @@ -153,12 +165,13 @@ export default class BrowserFactory {

async create(
options: BrowserSessionOptions,
logger = createLogger({ scope: 'browser' })
logger = createLogger({ scope: 'browser' }),
browserSize?: ViewportDimensions
): Promise<BrowserSession> {
const { config } = this;
logger.trace('Creating browser session', config);
const grid = this.config.grid || 'local';
const browserOptions = this.getOptions(options);
const browserOptions = this.getOptions(options, browserSize);
let browser;

try {
Expand Down
2 changes: 1 addition & 1 deletion packages/logger/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ function wrap(l: Logger): Logger {
export const logger = wrap(baseLogger);

/** Create a logger scoped to a specific command */
export function createLogger({ scope }: { scope: string }) {
export function createLogger({ scope }: { scope: string }): Logger {
const scoped = logger.scope(padScope(scope));
return wrap(scoped);
}
125 changes: 71 additions & 54 deletions plugins/applitools/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,12 @@ import createApplitoolsLogHandler from './createApplitoolsLogHandler';
import BrowserFactory from '@proof-ui/browser';

export interface ApplitoolsPluginConfig {
/** Delay time before taking a screenshot (Default: 1000) */
delay?: number;
/** Optional function to configure applitools for all tests */
configure?(configuration: Configuration): void;
/** Set to true to resize browser before sending to the UltraFastGrid. Slower test runs but allows JS dependent on screen size to run before the DOM is sent to applitools for comparisons. (Default: false) */
useWebdriverWindowSize?: boolean;
}

type ApplitoolsBrowsersInfo =
Expand Down Expand Up @@ -122,34 +126,40 @@ export default class ApplitoolsPlugin implements ProofPlugin, CLIPlugin {
const browserConfig = this.options.configure ?? defaultConfigure;
browserConfig(configuration);

const useWebdriverWindowSize = this.options.useWebdriverWindowSize ?? false;

const browserConfigs: Array<{
width: number;
height: number;
browsers: BrowserTypePlain[];
}> = [];
const otherConfigs: Array<ApplitoolsBrowsersInfo> = [];
configuration.getBrowsersInfo().forEach((info) => {
// Group known screen sizes so browser can be resized before test runs to allow JS to run before image capture.
if ('name' in info && info.name !== undefined) {
const existing = browserConfigs.find(
(w) => w.width === info.width && w.height === info.height
);
if (existing) {
if (!existing.browsers.includes(info.name)) {
existing.browsers.push(info.name);
if (useWebdriverWindowSize) {
configuration.getBrowsersInfo().forEach((info) => {
// Group known screen sizes so browser can be resized before test runs to allow JS to run before image capture.
if ('name' in info && info.name !== undefined) {
const existing = browserConfigs.find(
(w) => w.width === info.width && w.height === info.height
);
if (existing) {
if (!existing.browsers.includes(info.name)) {
existing.browsers.push(info.name);
}
} else {
browserConfigs.push({
width: info.width,
height: info.height,
browsers: [info.name],
});
}
} else {
browserConfigs.push({
width: info.width,
height: info.height,
browsers: [info.name],
});
// TODO: Find a way to get screen size info for all device types.
otherConfigs.push(info);
}
} else {
// TODO: Find a way to get screen size info for all device types.
otherConfigs.push(info);
}
});
});
} else {
otherConfigs.push(...configuration.getBrowsersInfo());
}

let browserFactory: BrowserFactory;
proof.hooks.browserFactory.tap('visual', (factory) => {
Expand All @@ -165,19 +175,23 @@ export default class ApplitoolsPlugin implements ProofPlugin, CLIPlugin {
const runTest = async (
browsersInfo: ApplitoolsBrowsersInfo[],
browser: WebdriverIO.Browser
): Promise<void> => {
const eyes = new Eyes(runner, configuration);
const config = eyes.getConfiguration();
config.setBrowsersInfo(browsersInfo);
eyes.setConfiguration(config);
eyes.setLogHandler(applitoolsLogger);

await this.runVisualCheck(
eyes,
testArgs.logger,
testArgs.name,
browser
);
): Promise<Error | undefined> => {
try {
const eyes = new Eyes(runner, configuration);
const config = eyes.getConfiguration();
config.setBrowsersInfo(browsersInfo);
eyes.setConfiguration(config);
eyes.setLogHandler(applitoolsLogger);

await this.runVisualCheck(
eyes,
testArgs.logger,
testArgs.name,
browser
);
} catch (e) {
return e as Error;
}
};

const allTests = browserConfigs.map(async (browserConfig) => {
Expand All @@ -187,38 +201,41 @@ export default class ApplitoolsPlugin implements ProofPlugin, CLIPlugin {
kind: testArgs.config.kind,
story: testArgs.config.story,
},
testArgs.logger
testArgs.logger,
browserConfig
);

try {
await browserSession.browser.url(await testArgs.browser.getUrl());
// Resizing the browser instead of using applitools config allows for JS dependent on screen size to run before the screenshot is taken
await browserSession.browser.setWindowSize(
browserConfig.width,
browserConfig.height
);

const browsersInfo = browserConfig.browsers.map(
(browserName) => ({
width: browserConfig.width,
height: browserConfig.height,
name: browserName,
})
);
const browsersInfo = browserConfig.browsers.map((browserName) => ({
width: browserConfig.width,
height: browserConfig.height,
name: browserName,
}));

await runTest(browsersInfo, browserSession.browser);
} finally {
if (browserSession.browser) {
await browserSession.browser.deleteSession();
}
const result = await runTest(browsersInfo, browserSession.browser);
if (browserSession.browser) {
await browserSession.browser.deleteSession();
}

return result;
});

if (otherConfigs.length > 0) {
allTests.push(runTest(otherConfigs, testArgs.browser));
}

await Promise.all(allTests);
const results = (await Promise.all(allTests)).filter(
(result): result is Error => result !== undefined
);

if (results.length === 0) return;

if (results.length === 1) throw results[0];

throw new Error(
`Visual tests failed for multiple screen sizes with the following messages:\n\t${results
.map((e) => e.message)
.join('\n\t')}`
);
}
);
});
Expand Down