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

Fixing ignoreRegions for POA Full Page #1466

Merged
merged 6 commits into from
Dec 20, 2023
Merged

Fixing ignoreRegions for POA Full Page #1466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
782688a
Fixing ignoreRegions for POA Full Page
rishigupta1599 Dec 13, 2023
82a9e52
Adding specs
rishigupta1599 Dec 14, 2023
b5ff6ca
Fixing coverage
rishigupta1599 Dec 14, 2023
203a47a
Cleaning specs
rishigupta1599 Dec 14, 2023
c5b8e7b
Resolving comments
rishigupta1599 Dec 19, 2023
ed6324b
Resolving comments
rishigupta1599 Dec 19, 2023
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
77 changes: 51 additions & 26 deletions packages/webdriver-utils/src/providers/genericProvider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export default class GenericProvider {
this.pageYShiftFactor = 0;
this.currentTag = null;
this.removeElementShiftFactor = 50000;
this.initialScrollFactor = { value: [0, 0] };
this.initialScrollLocation = null;
}

addDefaultOptions() {
Expand Down Expand Up @@ -69,16 +69,24 @@ export default class GenericProvider {
}
}

async getInitialPosition() {
if (this.currentTag.osName === 'iOS') {
this.initialScrollFactor = await this.driver.executeScript({ script: 'return [parseInt(window.scrollX), parseInt(window.scrollY)];', args: [] });
}
isIOS() {
return this.currentTag?.osName === 'iOS';
}

async getScrollDetails() {
return await this.driver.executeScript({ script: 'return [parseInt(window.scrollX), parseInt(window.scrollY)];', args: [] });
}

async scrollToInitialPosition(x, y) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets have it as generic function then scrollToPosition(x,y) so if needed in future we can use it as we want and pass x and y accordingly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

if (this.currentTag.osName === 'iOS') {
await this.driver.executeScript({ script: `window.scrollTo(${x}, ${y})`, args: [] });
async getInitialScrollLocation() {
if (this.initialScrollLocation) {
return this.initialScrollLocation;
}
this.initialScrollLocation = await this.getScrollDetails();
return this.initialScrollLocation;
}

async scrollToPosition(x, y) {
await this.driver.executeScript({ script: `window.scrollTo(${x}, ${y})`, args: [] });
}

async screenshot(name, {
Expand Down Expand Up @@ -212,6 +220,9 @@ export default class GenericProvider {
document.head.appendChild(e);`;

await this.driver.executeScript({ script: jsScript, args: [] });
if (this.options?.fullPage || this.isIOS()) {
await this.getInitialScrollLocation();
}
}

async undoTransformations(data) {
Expand Down Expand Up @@ -245,15 +256,21 @@ export default class GenericProvider {

async getRegionObjectFromBoundingBox(selector, element) {
const scaleFactor = await this.metaData.devicePixelRatio();
let scrollX = 0, scrollY = 0;
if (this.options?.fullPage) {
scrollX = this.initialScrollLocation.value[0];
scrollY = this.initialScrollLocation.value[1];
}

let headerAdjustment = 0;
if (this.currentTag.osName === 'iOS') {
if (this.isIOS()) {
headerAdjustment = this.statusBarHeight;
}
const coOrdinates = {
top: Math.floor(element.y * scaleFactor) + Math.floor(headerAdjustment),
bottom: Math.ceil((element.y + element.height) * scaleFactor) + Math.ceil(headerAdjustment),
left: Math.floor(element.x * scaleFactor),
right: Math.ceil((element.x + element.width) * scaleFactor)
top: Math.floor((element.y + scrollY) * scaleFactor) + Math.floor(headerAdjustment),
bottom: Math.ceil((element.y + element.height + scrollY) * scaleFactor) + Math.ceil(headerAdjustment),
left: Math.floor((element.x + scrollX) * scaleFactor),
right: Math.ceil((element.x + element.width + scrollX) * scaleFactor)
};

const jsonObject = {
Expand All @@ -280,16 +297,15 @@ export default class GenericProvider {
return regionsArray;
}

async updatePageShiftFactor(location, scaleFactor) {
const scrollFactors = await this.driver.executeScript({ script: 'return [parseInt(window.scrollX), parseInt(window.scrollY)];', args: [] });
if (this.currentTag.osName === 'iOS' || (this.currentTag.osName === 'OS X' && parseInt(this.currentTag.browserVersion) > 13 && this.currentTag.browserName.toLowerCase() === 'safari')) {
async updatePageShiftFactor(location, scaleFactor, scrollFactors) {
if (this.isIOS() || (this.currentTag.osName === 'OS X' && parseInt(this.currentTag.browserVersion) > 13 && this.currentTag.browserName.toLowerCase() === 'safari')) {
this.pageYShiftFactor = this.statusBarHeight;
} else {
this.pageYShiftFactor = this.statusBarHeight - (scrollFactors.value[1] * scaleFactor);
}
this.pageXShiftFactor = this.currentTag.osName === 'iOS' ? 0 : (-(scrollFactors.value[0] * scaleFactor));
if (this.currentTag.osName === 'iOS') {
if (scrollFactors.value[0] !== this.initialScrollFactor.value[0] || scrollFactors.value[1] !== this.initialScrollFactor.value[1]) {
this.pageXShiftFactor = this.isIOS() ? 0 : (-(scrollFactors.value[0] * scaleFactor));
if (this.isIOS() && !this.options?.fullPage) {
if (scrollFactors.value[0] !== this.initialScrollLocation.value[0] || scrollFactors.value[1] !== this.initialScrollLocation.value[1]) {
this.pageXShiftFactor = (-1 * this.removeElementShiftFactor);
this.pageYShiftFactor = (-1 * this.removeElementShiftFactor);
} else if (location.y === 0) {
Expand All @@ -303,16 +319,23 @@ export default class GenericProvider {
const rect = await this.driver.rect(elementId);
const location = { x: rect.x, y: rect.y };
const size = { height: rect.height, width: rect.width };
let scrollX = 0, scrollY = 0;
const scrollFactors = await this.getScrollDetails();
if (this.options?.fullPage) {
scrollX = scrollFactors.value[0];
scrollY = scrollFactors.value[1];
}

// Update pageShiftFactor Element is not visible in viewport
// In case of iOS if the element is not visible in viewport it gives 0 for x-y coordinate.
// In case of iOS if the element is partially visible it gives negative x-y coordinate.
// Subtracting ScrollY/ScrollX ensures if the element is visible in viewport or not.
await this.updatePageShiftFactor(location, scaleFactor);
await this.updatePageShiftFactor(location, scaleFactor, scrollFactors);
const coOrdinates = {
top: Math.floor(location.y * scaleFactor) + Math.floor(this.pageYShiftFactor),
bottom: Math.ceil((location.y + size.height) * scaleFactor) + Math.ceil(this.pageYShiftFactor),
left: Math.floor(location.x * scaleFactor) + Math.floor(this.pageXShiftFactor),
right: Math.ceil((location.x + size.width) * scaleFactor) + Math.ceil(this.pageXShiftFactor)
top: Math.floor((location.y + scrollY) * scaleFactor) + Math.floor(this.pageYShiftFactor),
bottom: Math.ceil((location.y + size.height + scrollY) * scaleFactor) + Math.ceil(this.pageYShiftFactor),
left: Math.floor((location.x + scrollX) * scaleFactor) + Math.floor(this.pageXShiftFactor),
right: Math.ceil((location.x + size.width + scrollX) * scaleFactor) + Math.ceil(this.pageXShiftFactor)
};

const jsonObject = {
Expand All @@ -325,7 +348,6 @@ export default class GenericProvider {

async getSeleniumRegionsByElement(elements) {
const regionsArray = [];
await this.getInitialPosition();
for (let index = 0; index < elements.length; index++) {
try {
const selector = `element: ${index}`;
Expand All @@ -336,7 +358,10 @@ export default class GenericProvider {
log.debug(e.toString());
}
}
await this.scrollToInitialPosition(this.initialScrollFactor.value[0], this.initialScrollFactor.value[1]);

if (this.isIOS()) {
await this.scrollToPosition(this.initialScrollLocation.value[0], this.initialScrollLocation.value[1]);
}
return regionsArray;
}

Expand Down
Loading
Loading