@applitools/spec-driver-playwright 1.1.1 → 1.3.1

package/dist/index.js

@@ -1,13 +1,31 @@
 "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 });
+const spec = __importStar(require("./spec-driver"));
 __exportStar(require("./spec-driver"), exports);
+exports.default = spec;

package/dist/spec-driver.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];
@@ -19,7 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 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;
+exports.build = exports.waitUntilDisplayed = exports.scrollIntoView = exports.hover = exports.type = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.getCookies = 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 fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
 const utils = __importStar(require("@applitools/utils"));
 // #region HELPERS
 async function handleToObject(handle) {
@@ -63,7 +70,9 @@ function isElement(element) {
 }
 exports.isElement = isElement;
 function isSelector(selector) {
-    return utils.types.isString(selector);
+    if (!selector)
+        return false;
+    return utils.types.isString(selector) || utils.types.instanceOf(selector, 'Locator');
 }
 exports.isSelector = isSelector;
 function transformSelector(selector) {
@@ -81,7 +90,12 @@ function extractContext(page) {
 }
 exports.extractContext = extractContext;
 function isStaleElementError(err) {
-    return err && err.message && err.message.includes('Protocol error (DOM.describeNode)');
+    var _a, _b, _c, _d;
+    return (((_a = err === null || err === void 0 ? void 0 : err.message) === null || _a === void 0 ? void 0 : _a.includes('Element is not attached to the DOM')) || // universal message
+        ((_b = err === null || err === void 0 ? void 0 : err.message) === null || _b === void 0 ? void 0 : _b.includes('Protocol error (DOM.describeNode)')) || // chrome message
+        ((_c = err === null || err === void 0 ? void 0 : err.message) === null || _c === void 0 ? void 0 : _c.includes('Protocol error (Page.adoptNode)')) || // firefox message
+        ((_d = err === null || err === void 0 ? void 0 : err.message) === null || _d === void 0 ? void 0 : _d.includes('Unable to adopt element handle from a different document')) // webkit message
+    );
 }
 exports.isStaleElementError = isStaleElementError;
 // #endregion
@@ -111,11 +125,15 @@ async function childContext(_frame, element) {
 }
 exports.childContext = childContext;
 async function findElement(frame, selector, parent) {
+    if (utils.types.instanceOf(selector, 'Locator'))
+        return selector.elementHandle();
     const root = parent !== null && parent !== void 0 ? parent : frame;
     return root.$(selector);
 }
 exports.findElement = findElement;
 async function findElements(frame, selector, parent) {
+    if (utils.types.instanceOf(selector, 'Locator'))
+        return selector.elementHandles();
     const root = parent !== null && parent !== void 0 ? parent : frame;
     return root.$$(selector);
 }
@@ -128,6 +146,19 @@ async function setViewportSize(page, size) {
     return page.setViewportSize(size);
 }
 exports.setViewportSize = setViewportSize;
+async function getCookies(page) {
+    const cookies = await page.context().cookies();
+    return cookies.map(cookie => {
+        const copy = Object.assign(Object.assign({}, cookie), { expiry: cookie.expires });
+        delete copy.expires;
+        return copy;
+    });
+}
+exports.getCookies = getCookies;
+async function getDriverInfo(_page) {
+    return { features: { allCookies: true } };
+}
+exports.getDriverInfo = getDriverInfo;
 async function getTitle(page) {
     return page.title();
 }
@@ -170,6 +201,8 @@ async function scrollIntoView(frame, element, align = false) {
 }
 exports.scrollIntoView = scrollIntoView;
 async function waitUntilDisplayed(frame, selector) {
+    if (utils.types.instanceOf(selector, 'Locator'))
+        return selector.waitFor();
     await frame.waitForSelector(selector);
 }
 exports.waitUntilDisplayed = waitUntilDisplayed;
@@ -183,7 +216,7 @@ const browserNames = {
 async function build(env) {
     const playwright = require('playwright');
     const parseEnv = require('@applitools/test-utils/src/parse-env');
-    const { browser, device, url, attach, proxy, args = [], headless } = parseEnv(env, 'cdp');
+    const { browser, device, url, attach, proxy, args = [], headless, extension } = parseEnv(env, 'cdp');
     const launcher = playwright[browserNames[browser] || browser];
     if (!launcher)
         throw new Error(`Browser "${browser}" is not supported.`);
@@ -191,30 +224,38 @@ async function build(env) {
         throw new Error(`Attaching to the existed browser doesn't supported by playwright`);
     const options = {
         args,
-        headless,
+        headless: headless && !extension,
         ignoreDefaultArgs: ['--hide-scrollbars'],
     };
+    if (extension) {
+        options.args.push(`--load-extension=${extension}`, `--disable-extensions-except=${extension}`);
+    }
     if (proxy) {
         options.proxy = {
             server: proxy.https || proxy.http || proxy.server,
             bypass: proxy.bypass.join(','),
         };
     }
-    let driver;
-    if (url) {
-        if (utils.types.isArray(options.ignoreDefaultArgs)) {
-            url.searchParams.set('ignoreDefaultArgs', options.ignoreDefaultArgs.join(','));
-        }
-        url.searchParams.set('headless', options.headless);
-        options.args.forEach((arg) => url.searchParams.set(...arg.split('=')));
-        driver = await launcher.connect({ wsEndpoint: url.href });
+    let driver, context;
+    if (extension) {
+        context = await launcher.launchPersistentContext(fs.mkdtempSync(path.join(os.tmpdir(), 'chrome-user-data-dir')), Object.assign(Object.assign(Object.assign({}, options), { viewport: null }), (device ? playwright.devices[device] : {})));
     }
     else {
-        driver = await launcher.launch(options);
+        if (url) {
+            if (utils.types.isArray(options.ignoreDefaultArgs)) {
+                url.searchParams.set('ignoreDefaultArgs', options.ignoreDefaultArgs.join(','));
+            }
+            url.searchParams.set('headless', options.headless);
+            options.args.forEach((arg) => url.searchParams.set(...arg.split('=')));
+            driver = await launcher.connect({ wsEndpoint: url.href });
+        }
+        else {
+            driver = await launcher.launch(options);
+        }
+        context = await driver.newContext(device ? playwright.devices[device] : {});
     }
-    const context = await driver.newContext(device ? playwright.devices[device] : {});
     const page = await context.newPage();
-    return [page, () => driver.close()];
+    return [page, () => (driver ? driver.close() : context.close())];
 }
 exports.build = build;
 // #endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-playwright",
-  "version": "1.1.1",
+  "version": "1.3.1",
   "keywords": [
     "playwright",
     "chrome devtools protocol",
@@ -17,7 +17,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/applitools/eyes.sdk.javascript1.git"
+    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "packages/spec-driver-playwright"
   },
   "license": "SEE LICENSE IN LICENSE",
   "author": {
@@ -32,12 +33,14 @@
   ],
   "scripts": {
     "lint": "eslint '**/*.ts'",
-    "build": "yarn build:dist",
-    "build:dist": "tsc",
+    "build": "ttsc",
     "test": "mocha ./test/**/*.spec.ts --no-timeouts -r ts-node/register",
+    "setup": "yarn playwright:setup",
+    "playwright:setup": "sudo npx playwright install-deps",
+    "upgrade:framework": "if [ ! -z $APPLITOOLS_PLAYWRIGHT_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile playwright@$APPLITOOLS_PLAYWRIGHT_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='spec-playwright' -f links='test-utils utils'",
-    "gh:publish": "gh workflow run publish.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='spec-playwright'",
+    "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='spec-playwright' -f links='types utils test-utils'",
+    "gh:publish": "gh workflow run publish-spec-playwright.yml --ref $(git rev-parse --abbrev-ref HEAD)",
     "preversion": "bongo preversion",
     "version": "bongo version",
     "postversion": "bongo postversion --skip-release-notification"
@@ -48,29 +51,35 @@
     }
   },
   "dependencies": {
-    "@applitools/utils": "1.2.3"
+    "@applitools/types": "1.4.4",
+    "@applitools/utils": "1.3.1"
   },
   "devDependencies": {
-    "@applitools/scripts": "1.0.1",
-    "@applitools/sdk-release-kit": "0.13.3",
-    "@applitools/test-utils": "1.0.9",
+    "@applitools/api-extractor": "^1.2.7",
+    "@applitools/bongo": "^2.1.0",
+    "@applitools/scripts": "1.1.0",
+    "@applitools/test-utils": "1.3.2",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.10.2",
-    "@typescript-eslint/eslint-plugin": "^4.15.1",
-    "@typescript-eslint/parser": "^4.15.1",
-    "eslint": "^7.9.0",
-    "eslint-config-prettier": "^7.2.0",
+    "@types/node": "17.0.36",
+    "@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.7",
-    "mocha": "^9.1.2",
-    "playwright": "^1.15.2",
-    "prettier": "^2.4.1",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.4.3"
+    "mocha": "^9.2.2",
+    "playwright": "^1.22.2",
+    "prettier": "^2.6.2",
+    "ts-node": "^10.8.0",
+    "ttypescript": "^1.5.13",
+    "typescript": "^4.7.2"
   },
   "peerDependencies": {
     "playwright": ">=1.0.0"
+  },
+  "engines": {
+    "node": ">=12.13.0"
   }
 }

package/types/index.d.ts

@@ -1 +1,33 @@
-export * from './spec-driver';
+declare const _default: import('@applitools/types').SpecDriver<Driver, Context, Element, Selector>;
+export default _default;
+export function isDriver(page: any): page is Driver;
+export function isContext(frame: any): frame is Context;
+export function isElement(element: any): element is Element;
+export function isSelector(selector: any): selector is Selector;
+export function transformSelector(selector: Selector | (string | { selector: string | Selector; type?: string; })): Selector;
+export function extractContext(page: Driver | Context): Context;
+export function isStaleElementError(err: any): boolean;
+export function executeScript(frame: Context, script: string | ((arg: any) => any), arg: any): Promise<any>;
+export function mainContext(frame: Context): Promise<Context>;
+export function parentContext(frame: Context): Promise<Context>;
+export function childContext(_frame: Context, element: Element): Promise<Context>;
+export function findElement(frame: Context, selector: Selector, parent?: Element): Promise<Element>;
+export function findElements(frame: Context, selector: Selector, parent?: Element): Promise<Array<Element>>;
+export function getViewportSize(page: Driver): Promise<import('@applitools/types').Size>;
+export function setViewportSize(page: Driver, size: import('@applitools/types').Size): Promise<void>;
+export function getCookies(page: Driver): Promise<Array<import('@applitools/types').Cookie>>;
+export function getDriverInfo(_page: Driver): Promise<import('@applitools/types').DriverInfo>;
+export function getTitle(page: Driver): Promise<string>;
+export function getUrl(page: Driver): Promise<string>;
+export function visit(page: Driver, url: string): Promise<void>;
+export function takeScreenshot(page: Driver): Promise<Buffer>;
+export function click(frame: Context, element: Element | Selector): Promise<void>;
+export function type(frame: Context, element: Element | Selector, keys: string): Promise<void>;
+export function hover(frame: Context, element: Element | Selector): Promise<void>;
+export function scrollIntoView(frame: Context, element: Element | Selector, align: boolean): Promise<void>;
+export function waitUntilDisplayed(frame: Context, selector: Selector): Promise<void>;
+export function build(env: any): Promise<[Driver, () => Promise<void>]>;
+export type Driver = import('playwright').Page & { __applitoolsBrand?: never; };
+export type Context = import('playwright').Frame & { __applitoolsBrand?: never; };
+export type Element = import('playwright').ElementHandle & { __applitoolsBrand?: never; };
+export type Selector = (string | import('playwright').Locator) & { __applitoolsBrand?: never; };

package/CHANGELOG.md

@@ -1,16 +0,0 @@
-# Change Log
-
-## Unreleased
-
-
-## 1.1.1 - 2021/10/20
-
-- fix handle type parser
-
-## 1.1.0 - 2021/10/12
-
-- bump version
-
-## 1.0.3 - 2021/10/12
-
-- spec driver implementation for playwright framework

package/types/spec-driver.d.ts

@@ -1,42 +0,0 @@
-/// <reference types="node" />
-import type * as Playwright from 'playwright';
-export declare type Driver = Playwright.Page;
-export declare type Context = Playwright.Frame;
-export declare type Element = Playwright.ElementHandle;
-export declare type Selector = string;
-declare type CommonSelector = string | {
-    selector: Selector | string;
-    type?: string;
-};
-export declare function isDriver(page: any): page is Driver;
-export declare function isContext(frame: any): frame is Context;
-export declare function isElement(element: any): element is Element;
-export declare function isSelector(selector: any): selector is Selector;
-export declare function transformSelector(selector: Selector | CommonSelector): Selector;
-export declare function extractContext(page: Driver | Context): Context;
-export declare function isStaleElementError(err: any): boolean;
-export declare function executeScript(frame: Context, script: ((arg: any) => any) | string, arg: any): Promise<any>;
-export declare function mainContext(frame: Context): Promise<Context>;
-export declare function parentContext(frame: Context): Promise<Context>;
-export declare function childContext(_frame: Context, element: Element): Promise<Context>;
-export declare function findElement(frame: Context, selector: Selector, parent?: Element): Promise<Element>;
-export declare function findElements(frame: Context, selector: Selector, parent?: Element): Promise<Element[]>;
-export declare function getViewportSize(page: Driver): Promise<{
-    width: number;
-    height: number;
-}>;
-export declare function setViewportSize(page: Driver, size: {
-    width: number;
-    height: number;
-}): Promise<void>;
-export declare function getTitle(page: Driver): Promise<string>;
-export declare function getUrl(page: Driver): Promise<string>;
-export declare function visit(page: Driver, url: string): Promise<void>;
-export declare function takeScreenshot(page: Driver): Promise<Buffer>;
-export declare function click(frame: Context, element: Element | Selector): Promise<void>;
-export declare function type(frame: Context, element: Element | Selector, keys: string): Promise<void>;
-export declare function hover(frame: Context, element: Element | Selector): Promise<void>;
-export declare function scrollIntoView(frame: Context, element: Element | Selector, align?: boolean): Promise<void>;
-export declare function waitUntilDisplayed(frame: Context, selector: Selector): Promise<void>;
-export declare function build(env: any): Promise<[Driver, () => Promise<void>]>;
-export {};