Skip to content
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

Added skipPageHeightSetter option to circumvent #25 #83

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added skipPageHeightSetter option to circumvent #25 #83

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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ available:
* **remove** `String[]`<br>
removes all elements queried by all kinds of different [WebdriverIO selector strategies](http://webdriver.io/guide/usage/selectors.html) (via `display: none`)

* **skipPageHeightSetter** `bool` <br>
bypasses the fix introduced in #25, as it can add weird behavior to some pages

## Use GraphicsMagick
wdio-screenshot uses [GraphicsMagick](http://www.graphicsmagick.org/) for image processing when available. Without GraphicsMagick installed, wdio-screenshot fallbacks to [Jimp](https://github.com/oliver-moran/jimp) - a image processing library written in JS.

Expand Down
14 changes: 9 additions & 5 deletions src/modules/makeAreaScreenshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ async function storeScreenshot(browser, screenDimensions, cropDimensions, base64
await saveBase64Image(filePath, croppedBase64Screenshot);
}

export default async function makeAreaScreenshot(browser, startX, startY, endX, endY) {
export default async function makeAreaScreenshot(browser, startX, startY, endX, endY, options) {
log('requested a screenshot for the following area: %j', {startX, startY, endX, endY});

const screenDimensions = (await browser.execute(getScreenDimensions)).value;
Expand All @@ -44,8 +44,10 @@ export default async function makeAreaScreenshot(browser, startX, startY, endX,
const cropImages = [];
const screenshotPromises = [];

log('set page height to %s px', screenDimension.getDocumentHeight());
await browser.execute(pageHeight, `${screenDimension.getDocumentHeight()}px`);
if (!options.skipPageHeightSetter) {
log('set page height to %s px', screenDimension.getDocumentHeight());
await browser.execute(pageHeight, `${screenDimension.getDocumentHeight()}px`);
}

let loop = false;
do {
Expand Down Expand Up @@ -82,8 +84,10 @@ export default async function makeAreaScreenshot(browser, startX, startY, endX,
return mergedBase64Screenshot;
}),
Promise.resolve().then(async() => {
log('reset page height');
await browser.execute(pageHeight, '');
if (!options.skipPageHeightSetter) {
log('reset page height');
await browser.execute(pageHeight, '');
}

log('revert scroll to x: %s, y: %s', 0, 0);
await browser.execute(virtualScroll, 0, 0, true);
Expand Down
2 changes: 1 addition & 1 deletion src/modules/makeDocumentScreenshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export default async function makeDocumentScreenshot(browser, options = {}) {
const screenDimension = new ScreenDimension(screenDimensions, browser);

// make screenshot of area
const base64Image = await makeAreaScreenshot(browser, 0, 0, screenDimension.getDocumentWidth(), screenDimension.getDocumentHeight());
const base64Image = await makeAreaScreenshot(browser, 0, 0, screenDimension.getDocumentWidth(), screenDimension.getDocumentHeight(), options);

// show scrollbars, show & add elements
await afterScreenshot(browser, options);
Expand Down
2 changes: 1 addition & 1 deletion src/modules/makeElementScreenshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export default async function makeElementScreenshot(browser, elementSelector, op
const boundingRect = groupBoundingRect(boundingRects);

// make screenshot of area
const base64Image = await makeAreaScreenshot(browser, boundingRect.left, boundingRect.top, boundingRect.right, boundingRect.bottom);
const base64Image = await makeAreaScreenshot(browser, boundingRect.left, boundingRect.top, boundingRect.right, boundingRect.bottom, options);

// show scrollbars, show & add elements
await afterScreenshot(browser, options);
Expand Down
2 changes: 1 addition & 1 deletion src/modules/makeViewportScreenshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default async function makeViewportScreenshot(browser, options = {}) {
const screenDimension = new ScreenDimension(screenDimensions, browser);

// make screenshot of area
const base64Image = await makeAreaScreenshot(browser, startX, startY, screenDimension.getViewportWidth(), screenDimension.getViewportHeight());
const base64Image = await makeAreaScreenshot(browser, startX, startY, screenDimension.getViewportWidth(), screenDimension.getViewportHeight(), options);

// show scrollbars, show & add elements
await afterScreenshot(browser, options);
Expand Down