@serenity-js/webdriverio 3.0.0-rc.9 → 3.0.1

package/src/screenplay/models/locators/WebdriverIOLocator.ts

@@ -1,27 +1,101 @@
-import { Locator, PageElement, Selector } from '@serenity-js/web';
+import { f, LogicError } from '@serenity-js/core';
+import { ByCss, ByCssContainingText, ByDeepCss, ById, ByTagName, ByXPath, Locator, PageElement, RootLocator, Selector } from '@serenity-js/web';
 import * as wdio from 'webdriverio';
 
+import { WebdriverIOErrorHandler } from '../WebdriverIOErrorHandler';
 import { WebdriverIOPageElement } from '../WebdriverIOPageElement';
-import { WebdriverIONativeElementRoot } from './WebdriverIONativeElementRoot';
+import { WebdriverIORootLocator } from './WebdriverIORootLocator';
 
-export class WebdriverIOLocator<Selector_Type extends Selector> extends Locator<wdio.Element<'async'>, WebdriverIONativeElementRoot, Selector_Type> {
+/**
+ * WebdriverIO-specific implementation of {@apilink Locator}.
+ *
+ * @group Models
+ */
+export class WebdriverIOLocator extends Locator<wdio.Element<'async'>, string> {
 
-    static createRootLocator<ST extends Selector>(browser: WebdriverIONativeElementRoot, selector: ST, webdriverioSelector: string): WebdriverIOLocator<ST> {
-        return new WebdriverIOLocator(
-            () => browser,
-            selector,
-            (root: WebdriverIONativeElementRoot) => root.$(webdriverioSelector) as unknown as wdio.Element<'async'>,
-            (root: WebdriverIONativeElementRoot) => root.$$(webdriverioSelector)
-        );
+    constructor(
+        parent: RootLocator<wdio.Element<'async'>>,
+        selector: Selector,
+        private readonly errorHandler: WebdriverIOErrorHandler,
+    ) {
+        super(parent, selector);
     }
 
-    of(parent: WebdriverIOLocator<unknown>): Locator<wdio.Element<'async'>, WebdriverIONativeElementRoot, Selector_Type> {
-        return new WebdriverIOLocator(
-            () => parent.nativeElement(),
-            this.selector,
-            (parentRoot: WebdriverIONativeElementRoot) => this.locateElement(parentRoot),
-            (parentRoot: WebdriverIONativeElementRoot) => this.locateAllElements(parentRoot),
-        );
+    // todo: refactor; replace with a map and some more generic lookup mechanism
+    protected nativeSelector(): string {
+        if (this.selector instanceof ByCss) {
+            return this.selector.value;
+        }
+
+        if (this.selector instanceof ByDeepCss) {
+            return `>>> ${ this.selector.value }`;
+        }
+
+        if (this.selector instanceof ByCssContainingText) {
+            return `${ this.selector.value }*=${ this.selector.text }`;
+        }
+
+        if (this.selector instanceof ById) {
+            return `#${ this.selector.value }`;
+        }
+
+        if (this.selector instanceof ByTagName) {
+            return `<${ this.selector.value } />`;
+        }
+
+        if (this.selector instanceof ByXPath) {
+            return this.selector.value;
+        }
+
+        throw new LogicError(f `${ this.selector } is not supported by ${ this.constructor.name }`);
+    }
+
+    async isPresent(): Promise<boolean> {
+        try {
+            const element = await this.resolveNativeElement();
+            return Boolean(element);
+        }
+        catch {
+            return false;
+        }
+    }
+
+    async nativeElement(): Promise<wdio.Element<'async'>> {
+        try {
+            return await this.resolveNativeElement();
+        }
+        catch (error) {
+            return await this.errorHandler.executeIfHandled(error, () => this.resolveNativeElement());
+        }
+    }
+
+    private async resolveNativeElement(): Promise<wdio.Element<'async'>> {
+        const parent = await this.parent.nativeElement();
+
+        if (parent.error) {
+            throw parent.error;
+        }
+
+        const element = await parent.$(this.nativeSelector());
+
+        if (element.error) {
+            throw element.error;
+        }
+
+        return element;
+    }
+
+    async allNativeElements(): Promise<Array<wdio.Element<'async'>>> {
+        const parent = await this.parent.nativeElement();
+        return parent.$$(this.nativeSelector());
+    }
+
+    of(parent: WebdriverIOLocator): Locator<wdio.Element<'async'>, string> {
+        return new WebdriverIOLocator(parent, this.selector, this.errorHandler);
+    }
+
+    locate(child: WebdriverIOLocator): Locator<wdio.Element<'async'>, string> {
+        return new WebdriverIOLocator(this, child.selector, this.errorHandler);
     }
 
     element(): PageElement<wdio.Element<'async'>> {
@@ -29,15 +103,39 @@ export class WebdriverIOLocator<Selector_Type extends Selector> extends Locator<
     }
 
     async allElements(): Promise<Array<PageElement<wdio.Element<'async'>>>> {
-        const elements = await this.locateAllElements(await this.parentRoot());
+        const elements = await this.allNativeElements();
 
         return elements.map(childElement =>
-            new WebdriverIOPageElement(new WebdriverIOLocator(
-                () => this.parentRoot(),
-                this.selector,
-                () => childElement,
-                () => [ childElement ],
-            ))
+            new WebdriverIOPageElement(
+                new ExistingElementLocator(
+                    this.parent as WebdriverIORootLocator,
+                    this.selector,
+                    this.errorHandler,
+                    childElement
+                )
+            )
         );
     }
 }
+
+/**
+ * @private
+ */
+class ExistingElementLocator extends WebdriverIOLocator {
+    constructor(
+        parentRoot: RootLocator<wdio.Element<'async'>>,
+        selector: Selector,
+        errorHandler: WebdriverIOErrorHandler,
+        private readonly existingNativeElement: wdio.Element<'async'>,
+    ) {
+        super(parentRoot, selector, errorHandler);
+    }
+
+    async nativeElement(): Promise<wdio.Element<'async'>> {
+        return this.existingNativeElement;
+    }
+
+    async allNativeElements(): Promise<Array<wdio.Element<'async'>>> {
+        return [ this.existingNativeElement ];
+    }
+}

package/src/screenplay/models/locators/WebdriverIORootLocator.ts

@@ -0,0 +1,33 @@
+import { RootLocator } from '@serenity-js/web';
+import * as wdio from 'webdriverio';
+
+/**
+ * WebdriverIO-specific implementation of {@apilink RootLocator}.
+ *
+ * @group Models
+ */
+export class WebdriverIORootLocator extends RootLocator<wdio.Browser<'async'>> {
+    constructor(private readonly browser: wdio.Browser<'async'>) {
+        super();
+    }
+
+    async isPresent(): Promise<boolean> {
+        return true;
+    }
+
+    async nativeElement(): Promise<Pick<wdio.Browser<'async'>, '$' | '$$'>> {
+        return this.browser;
+    }
+
+    async switchToFrame(frame: wdio.Element<'async'>): Promise<void> {
+        await this.browser.switchToFrame(frame);
+    }
+
+    async switchToParentFrame(): Promise<void> {
+        await this.browser.switchToParentFrame();
+    }
+
+    async switchToMainFrame(): Promise<void> {
+        await this.browser.switchToFrame(null); // eslint-disable-line unicorn/no-null
+    }
+}

package/src/screenplay/models/locators/index.ts

@@ -1,2 +1,2 @@
 export * from './WebdriverIOLocator';
-export * from './WebdriverIONativeElementRoot';
+export * from './WebdriverIORootLocator';

package/tsconfig.build.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src",
+    "lib": [
+      "es2019",
+      "dom"
+    ],
+    "types": [
+      "webdriverio/async"
+    ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}

package/lib/screenplay/models/WebdriverIOModalDialog.d.ts

@@ -1,11 +0,0 @@
-import { ModalDialog } from '@serenity-js/web';
-import { Browser } from 'webdriverio';
-export declare class WebdriverIOModalDialog extends ModalDialog {
-    private readonly browser;
-    constructor(browser: Browser<'async'>);
-    accept(): Promise<void>;
-    dismiss(): Promise<void>;
-    text(): Promise<string>;
-    enterValue(value: string | number | (string | number)[]): Promise<void>;
-    isPresent(): Promise<boolean>;
-}

package/lib/screenplay/models/WebdriverIOModalDialog.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebdriverIOModalDialog = void 0;
-const web_1 = require("@serenity-js/web");
-class WebdriverIOModalDialog extends web_1.ModalDialog {
-    constructor(browser) {
-        super();
-        this.browser = browser;
-    }
-    accept() {
-        return this.browser.acceptAlert();
-    }
-    dismiss() {
-        return this.browser.dismissAlert();
-    }
-    text() {
-        return this.browser.getAlertText();
-    }
-    async enterValue(value) {
-        const text = [].concat(value).join('');
-        await this.browser.sendAlertText(text);
-        // Puppeteer auto-accepts the dialog upon sendAlertText
-        // other implementations require the dialog to be closed
-        if (!this.browser.isDevTools) {
-            await this.browser.acceptAlert();
-        }
-    }
-    isPresent() {
-        return this.browser.getAlertText()
-            .then(() => true, error => {
-            if (error && (error.name === 'no such alert'
-                || error.message.startsWith('no such alert'))) {
-                return false;
-            }
-            throw error;
-        });
-    }
-}
-exports.WebdriverIOModalDialog = WebdriverIOModalDialog;
-//# sourceMappingURL=WebdriverIOModalDialog.js.map

package/lib/screenplay/models/WebdriverIOModalDialog.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebdriverIOModalDialog.js","sourceRoot":"","sources":["../../../src/screenplay/models/WebdriverIOModalDialog.ts"],"names":[],"mappings":";;;AAAA,0CAA+C;AAG/C,MAAa,sBAAuB,SAAQ,iBAAW;IACnD,YAA6B,OAAyB;QAClD,KAAK,EAAE,CAAC;QADiB,YAAO,GAAP,OAAO,CAAkB;IAEtD,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;IACvC,CAAC;IACD,IAAI;QACA,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAA4C;QACzD,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEvC,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAEvC,uDAAuD;QACvD,wDAAwD;QACxD,IAAI,CAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC3B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;SACpC;IACL,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;aAC7B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YACtB,IAAI,KAAK,IAAI,CACT,KAAK,CAAC,IAAI,KAAK,eAAe;mBAC3B,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAC/C,EAAE;gBACC,OAAO,KAAK,CAAC;aAChB;YAED,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;CACJ;AAzCD,wDAyCC"}

package/lib/screenplay/models/locators/WebdriverIONativeElementRoot.d.ts

@@ -1,2 +0,0 @@
-import * as wdio from 'webdriverio';
-export declare type WebdriverIONativeElementRoot = Pick<wdio.Browser<'async'>, '$' | '$$'>;

package/lib/screenplay/models/locators/WebdriverIONativeElementRoot.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=WebdriverIONativeElementRoot.js.map

package/lib/screenplay/models/locators/WebdriverIONativeElementRoot.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebdriverIONativeElementRoot.js","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/WebdriverIONativeElementRoot.ts"],"names":[],"mappings":""}

package/src/screenplay/models/WebdriverIOModalDialog.ts

@@ -1,45 +0,0 @@
-import { ModalDialog } from '@serenity-js/web';
-import { Browser } from 'webdriverio';
-
-export class WebdriverIOModalDialog extends ModalDialog {
-    constructor(private readonly browser: Browser<'async'>) {
-        super();
-    }
-
-    accept(): Promise<void> {
-        return this.browser.acceptAlert();
-    }
-
-    dismiss(): Promise<void> {
-        return this.browser.dismissAlert();
-    }
-    text(): Promise<string> {
-        return this.browser.getAlertText();
-    }
-
-    async enterValue(value: string | number | (string | number)[]): Promise<void> {
-        const text = [].concat(value).join('');
-
-        await this.browser.sendAlertText(text);
-
-        // Puppeteer auto-accepts the dialog upon sendAlertText
-        // other implementations require the dialog to be closed
-        if (! this.browser.isDevTools) {
-            await this.browser.acceptAlert();
-        }
-    }
-
-    isPresent(): Promise<boolean> {
-        return this.browser.getAlertText()
-            .then(() => true, error => {
-                if (error && (
-                    error.name === 'no such alert'
-                    || error.message.startsWith('no such alert')
-                )) {
-                    return false;
-                }
-
-                throw error;
-            });
-    }
-}

package/src/screenplay/models/locators/WebdriverIONativeElementRoot.ts

@@ -1,3 +0,0 @@
-import * as wdio from 'webdriverio';
-
-export type WebdriverIONativeElementRoot = Pick<wdio.Browser<'async'>, '$' | '$$'>;

package/tsconfig.eslint.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig",
-  "include": [
-    "src/**/*.ts",
-    "spec/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}