@applitools/eyes-puppeteer 1.8.5 → 1.10.1

package/CHANGELOG.md

@@ -3,6 +3,49 @@
 ## Unreleased
 
 
+
+
+
+
+
+
+## 1.10.1 - 2022/6/2
+
+### Features
+### Bug fixes
+- Fix rounding error of image size when scaling introduces fractions
+
+## 1.10.0 - 2022/6/1
+
+### Features
+- Support UFG for native mobile
+- `runner.getAllTestResults` returns the corresponding UFG browser/device configuration for each test. This is available as `runner.getAllTestResults()[i].browserInfo`.
+- Support iPhone SE `IosDeviceName.iPhone_SE` and iPhone 8 Plus `IosDeviceName.iPhone_8_Plus` iOS devices
+- Support Galaxy S22 `DeviceName.Galaxy_S22` emulation device
+- Dorp support for Node.js versions <=12
+### Bug fixes
+- `runner.getAllTestResults` now aborts unclosed tests
+- `runner.getAllTestResults` now returns all results, including aborted tests
+- `extractText` now supports regions that don't use hints while using `x`/`y` coordinates
+- accept ios and android lowercase as driver platformName capability when using custom grid
+- Fixed check region fully in classic execution when using CSS stitching
+- Support data urls in iframes
+- Allow running with self-signed certificates
+- Fixed `CheckSetting`'s `fully` being overridden by `Configuration`'s `forceFullPageScreenshot`
+- Set EyesExceptions (such as new test, diffs exception and failed test exception) to exception property in TestResultsSummary
+- Improve error message when failed to set viewport size
+- Fixed incorrect calculation of coded regions in classic mode when using CSS stitching
+
+## 1.9.0 - 2021/11/10
+
+- support cookies
+- updated to @applitools/eyes-api@1.1.5 (from 1.0.12)
+- updated to @applitools/eyes-sdk-core@12.23.24 (from 12.22.6)
+- updated to @applitools/visual-grid-client@15.8.43 (from 15.8.20)
+- updated to @applitools/eyes-api@1.1.6 (from 1.1.5)
+- updated to @applitools/eyes-sdk-core@12.24.0 (from 12.23.24)
+- updated to @applitools/visual-grid-client@15.8.44 (from 15.8.43)
+
 ## 1.8.5 - 2021/10/30
 
 - updated to @applitools/eyes-sdk-core@12.23.22 (from 12.23.18)

package/dist/api.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -25,8 +29,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = void 0;
 const eyes_sdk_core_1 = require("@applitools/eyes-sdk-core");
 const api = __importStar(require("@applitools/eyes-api"));
-const spec = __importStar(require("./spec-driver"));
-const sdk = eyes_sdk_core_1.makeSDK({
+const spec = __importStar(require("@applitools/spec-driver-puppeteer"));
+const sdk = (0, eyes_sdk_core_1.makeSDK)({
     name: 'eyes.puppeteer',
     version: require('../package.json').version,
     spec,

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/spec-driver.js

@@ -1,232 +1,17 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = exports.waitUntilDisplayed = exports.scrollIntoView = exports.hover = exports.type = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.setViewportSize = exports.getViewportSize = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isStaleElementError = exports.extractContext = exports.transformSelector = exports.isSelector = exports.isElement = exports.isContext = exports.isDriver = void 0;
-const utils = __importStar(require("@applitools/utils"));
-async function handleToObject(handle) {
-    const [, type] = handle.toString().split('@');
-    if (type === 'array') {
-        const map = await handle.getProperties();
-        return Promise.all(Array.from(map.values(), handleToObject));
-    }
-    else if (type === 'object') {
-        const map = await handle.getProperties();
-        const chunks = await Promise.all(Array.from(map, async ([key, handle]) => ({ [key]: await handleToObject(handle) })));
-        return chunks.length > 0 ? Object.assign(...chunks) : {};
-    }
-    else if (type === 'node') {
-        return handle.asElement();
-    }
-    else {
-        return handle.jsonValue();
-    }
-}
-function transformArgument(arg) {
-    const elements = [];
-    const argWithElementMarkers = transform(arg);
-    return [argWithElementMarkers, ...elements];
-    function transform(arg) {
-        if (isElement(arg)) {
-            elements.push(arg);
-            return { isElement: true };
-        }
-        else if (utils.types.isArray(arg)) {
-            return arg.map(transform);
-        }
-        else if (utils.types.isObject(arg)) {
-            return Object.entries(arg).reduce((object, [key, value]) => {
-                return Object.assign(object, { [key]: transform(value) });
-            }, {});
-        }
-        else {
-            return arg;
-        }
-    }
-}
-function scriptRunner(script, arg, ...elements) {
-    const func = new Function(script.startsWith('function') ? `return (${script}).apply(null, arguments)` : script);
-    return func(transform(arg));
-    function transform(arg) {
-        if (!arg) {
-            return arg;
-        }
-        else if (arg.isElement) {
-            return elements.shift();
-        }
-        else if (Array.isArray(arg)) {
-            return arg.map(transform);
-        }
-        else if (typeof arg === 'object') {
-            return Object.entries(arg).reduce((object, [key, value]) => {
-                return Object.assign(object, { [key]: transform(value) });
-            }, {});
-        }
-        else {
-            return arg;
-        }
-    }
-}
-function isXpath(selector) {
-    return selector.startsWith('//') || selector.startsWith('..');
-}
-function isDriver(page) {
-    if (!page)
-        return false;
-    return utils.types.instanceOf(page, 'Page');
-}
-exports.isDriver = isDriver;
-function isContext(frame) {
-    if (!frame)
-        return false;
-    return utils.types.instanceOf(frame, 'Frame');
-}
-exports.isContext = isContext;
-function isElement(element) {
-    if (!element)
-        return false;
-    return utils.types.instanceOf(element, 'ElementHandle');
-}
-exports.isElement = isElement;
-function isSelector(selector) {
-    return utils.types.isString(selector);
-}
-exports.isSelector = isSelector;
-function transformSelector(selector) {
-    if (utils.types.has(selector, 'selector'))
-        return selector.selector;
-    return selector;
-}
-exports.transformSelector = transformSelector;
-function extractContext(page) {
-    return isDriver(page) ? page.mainFrame() : page;
-}
-exports.extractContext = extractContext;
-function isStaleElementError(err) {
-    return (err &&
-        err.message &&
-        (err.message.includes('Execution context was destroyed') ||
-            err.message.includes('JSHandles can be evaluated only in the context they were created')));
-}
-exports.isStaleElementError = isStaleElementError;
-async function executeScript(frame, script, arg) {
-    script = utils.types.isString(script) ? script : `function() {return (${script.toString()}).apply(null, arguments)}`;
-    const result = await frame.evaluateHandle(scriptRunner, script, ...transformArgument(arg));
-    return handleToObject(result);
-}
-exports.executeScript = executeScript;
-async function mainContext(frame) {
-    frame = extractContext(frame);
-    let mainFrame = frame;
-    while (mainFrame.parentFrame()) {
-        mainFrame = mainFrame.parentFrame();
-    }
-    return mainFrame;
-}
-exports.mainContext = mainContext;
-async function parentContext(frame) {
-    frame = extractContext(frame);
-    return frame.parentFrame();
-}
-exports.parentContext = parentContext;
-async function childContext(_frame, element) {
-    return element.contentFrame();
-}
-exports.childContext = childContext;
-async function findElement(frame, selector, parent) {
-    const root = parent !== null && parent !== void 0 ? parent : frame;
-    return isXpath(selector) ? root.$x(selector).then(elements => elements[0]) : root.$(selector);
-}
-exports.findElement = findElement;
-async function findElements(frame, selector, parent) {
-    const root = parent !== null && parent !== void 0 ? parent : frame;
-    return isXpath(selector) ? root.$x(selector) : root.$$(selector);
-}
-exports.findElements = findElements;
-async function getViewportSize(page) {
-    return page.viewport();
-}
-exports.getViewportSize = getViewportSize;
-async function setViewportSize(page, size) {
-    await page.setViewport(size);
-    await new Promise(res => setTimeout(res, 100));
-}
-exports.setViewportSize = setViewportSize;
-async function getTitle(page) {
-    return page.title();
-}
-exports.getTitle = getTitle;
-async function getUrl(page) {
-    return page.url();
-}
-exports.getUrl = getUrl;
-async function visit(page, url) {
-    await page.goto(url);
-}
-exports.visit = visit;
-async function takeScreenshot(page) {
-    const scr = await page._client.send('Page.captureScreenshot');
-    return scr.data;
-}
-exports.takeScreenshot = takeScreenshot;
-async function click(frame, element) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    await element.click();
-}
-exports.click = click;
-async function type(frame, element, keys) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    return element.type(keys);
-}
-exports.type = type;
-async function hover(frame, element) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    await element.hover();
-}
-exports.hover = hover;
-async function scrollIntoView(frame, element, align = false) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    await frame.evaluate((element, align) => element.scrollIntoView(align), element, align);
-}
-exports.scrollIntoView = scrollIntoView;
-async function waitUntilDisplayed(frame, selector) {
-    await frame.waitForSelector(selector);
-}
-exports.waitUntilDisplayed = waitUntilDisplayed;
-async function build(env) {
-    const puppeteer = require('puppeteer');
-    env = Object.assign(Object.assign({}, env), { ignoreDefaultArgs: ['--hide-scrollbars'], executablePath: 'google-chrome-stable', args: ['--no-sandbox', '--disable-setuid-sandbox', '--disable-dev-shm-usage', '--disable-gpu'] });
-    delete env.headless;
-    if (process.env.APPLITOOLS_DEBUG) {
-        env.headless = false;
-        env.devtools = true;
-        delete env.executablePath;
-    }
-    if (process.platform !== 'linux')
-        delete env.executablePath;
-    const driver = await puppeteer.launch(env);
-    const page = await driver.newPage();
-    return [page, () => driver.close()];
-}
-exports.build = build;
+__exportStar(require("@applitools/spec-driver-puppeteer"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-puppeteer",
-  "version": "1.8.5",
+  "version": "1.10.1",
   "description": "Applitools Eyes SDK for Puppeteer",
   "keywords": [
     "eyes-puppeteer",
@@ -29,33 +29,26 @@
   },
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
-  "directories": {
-    "lib": "./src",
-    "example": "./example",
-    "test": "./test"
-  },
   "files": [
     "dist",
     "types"
   ],
   "scripts": {
     "lint": "eslint '**/*.ts'",
-    "build": "yarn build:dist && yarn build:types",
-    "build:dist": "tsc",
-    "build:types": "api-extractor ./src/index.ts --out ./types/index.d.ts --external-modules puppeteer",
-    "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-puppeteer'",
-    "test": "yarn test:it && yarn test:coverage",
-    "test:it": "mocha --exit --no-timeouts -r ts-node/register ./test/it/*.spec.ts",
-    "test:coverage": "yarn build:dist && yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --exit --config .mocharc.cvg.js",
+    "build": "ttsc",
+    "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-puppeteer'",
+    "test": "yarn test:coverage",
+    "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --exit --config .mocharc.cvg.js",
     "report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-puppeteer'",
     "docker:build": "docker build -t applitools/puppeteer-chrome .",
     "docker:rebuild": "docker build --no-cache -t applitools/puppeteer-chrome .",
     "docker:run": "yarn docker:build && docker run -e NODE_AUTH_TOKEN --env APPLITOOLS_API_KEY=$APPLITOOLS_API_KEY_SDK --env APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' --env APPLITOOLS_BATCH_ID=$(uuidgen) --env XUNIT_FILE=coverage-test-report.xml -it --init --rm -v $(pwd):/sandbox applitools/puppeteer-chrome",
+    "upgrade:framework": "if [ ! -z $APPLITOOLS_PUPPETEER_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile puppeteer@$APPLITOOLS_PUPPETEER_VERSION; echo \"$packagejson\" > package.json; fi",
     "deps": "bongo deps",
-    "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='puppeteer' -f links='eyes-sdk-core eyes-api types test-utils utils driver snippets screenshoter sdk-shared visual-grid-client' -f linking-depth=3",
-    "gh:publish": "gh workflow run publish.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='puppeteer'",
-    "preversion": "bongo preversion && yarn build",
-    "version": "bongo version",
+    "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='puppeteer' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-puppeteer utils driver snippets screenshoter' -f linking-depth=3",
+    "gh:publish": "gh workflow run publish-puppeteer.yml --ref $(git rev-parse --abbrev-ref HEAD)",
+    "preversion": "bongo preversion --verifyPendingChanges && yarn build",
+    "version": "bongo version --withPendingChanges",
     "postversion": "bongo postversion"
   },
   "husky": {
@@ -64,37 +57,40 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.1.5",
-    "@applitools/eyes-sdk-core": "12.23.24",
-    "@applitools/utils": "1.2.4",
-    "@applitools/visual-grid-client": "15.8.43"
+    "@applitools/eyes-api": "1.5.1",
+    "@applitools/eyes-sdk-core": "13.6.28",
+    "@applitools/spec-driver-puppeteer": "1.1.3",
+    "@applitools/visual-grid-client": "15.12.37"
   },
   "devDependencies": {
-    "@applitools/api-extractor": "1.1.3",
-    "@applitools/scripts": "1.0.1",
-    "@applitools/sdk-coverage-tests": "2.3.15",
-    "@applitools/sdk-release-kit": "0.13.4",
-    "@applitools/sdk-shared": "0.9.7",
-    "@applitools/test-utils": "1.0.9",
-    "@types/mocha": "^9.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.15.1",
-    "@typescript-eslint/parser": "^4.15.1",
-    "eslint": "^7.9.0",
-    "eslint-config-prettier": "^7.2.0",
+    "@applitools/api-extractor": "1.2.8",
+    "@applitools/bongo": "^2.1.1",
+    "@applitools/scripts": "1.1.0",
+    "@applitools/sdk-coverage-tests": "2.3.18",
+    "@applitools/sdk-shared": "0.9.11",
+    "@applitools/test-utils": "1.3.2",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "12",
+    "@typescript-eslint/eslint-plugin": "^5.27.0",
+    "@typescript-eslint/parser": "^5.27.0",
+    "eslint": "^8.16.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-mocha-no-only": "^1.1.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-prettier": "^4.0.0",
     "husky": "^4.3.8",
-    "mocha": "^8.0.1",
-    "prettier": "^2.1.2",
-    "puppeteer": "^9.0.0",
+    "mocha": "^9.2.2",
+    "prettier": "^2.6.2",
+    "puppeteer": "^14.1.2",
     "spec-xunit-file": "0.0.1-3",
-    "ts-node": "^10.2.1"
+    "ts-node": "^10.8.0",
+    "ttypescript": "^1.5.13",
+    "typescript": "^4.7.2"
   },
   "peerDependencies": {
     "puppeteer": ">=5.3.0"
   },
   "engines": {
-    "node": ">=8.9.0"
+    "node": ">=12.13.0"
   }
 }