configure retry to pick value from capability

Author: saikrishna321

README.md

@@ -17,7 +17,7 @@ appium plugin install --source=npm appium-element-wait
 
 ## Installation - Client
 
-No special action is needed to make things work on the client side. Just keep sending in your unprefixed caps!
+No special action is needed to make things work on the client side.
 
 ## Activation
 
@@ -27,6 +27,10 @@ The plugin will not be active unless turned on when invoking the Appium server:
 appium --plugins=element-wait
 ```
 
+## Configuration
+
+To override the default element-wait retry set `capabilities.setCapability("appium:element-wait", 20);`. Default value is 30.
+
 ### Example
 
 

src/plugin.js

@@ -4,88 +4,106 @@ import fetch from 'node-fetch';
 let retryCount = 0;
 export default class WaitCommandPlugin extends BasePlugin {
   async findElement(next, driver, ...args) {
+    this.driver = driver;
     let originalRes;
     const locatorArgs = JSON.parse(JSON.stringify(args));
     this.strategy = locatorArgs[0];
     this.selector = locatorArgs[1];
-    await this._find(driver, locatorArgs);
-    await this._elementDisplayed(driver);
+    await this._find(locatorArgs);
+    await this._elementDisplayed();
     originalRes = await next();
     retryCount = 0;
     return originalRes;
   }
 
-  async _find(driver) {
-    const baseUrl = this._constructSessionUrl(driver);
-    const response = await fetch(
-      `${baseUrl}wd/hub/session/${driver.sessionId}/element`,
-      {
-        body: JSON.stringify({
-          strategy: this.strategy,
-          selector: this.selector,
-          context: '',
-          multiple: false,
-        }),
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-      }
-    );
-    const json = await response.json();
-    if (json.value.error) {
-      if (retryCount !== 25) {
+  async _find() {
+    const baseUrl = this._constructSessionUrl();
+    const element = await this.elementState(baseUrl);
+    if (element.value.error) {
+      console.log('----', this._getTimeout());
+      if (retryCount !== this._getTimeout()) {
         this.logger.info(
-          `Retrying to find element with ${this.strategy} strategy for ${this.selector} selector`
+          `Waiting for find element with ${this.strategy} strategy for ${this.selector} selector`
         );
         retryCount++;
-        await this._find(driver);
+        await this._find();
       }
     }
 
-    if (json.sessionId && json.value.ELEMENT) {
-      this.element = json.value.ELEMENT;
+    if (element.sessionId && element.value.ELEMENT) {
+      this.element = element.value.ELEMENT;
       this.logger.info(
         `Element with ${this.strategy} strategy for ${this.selector} selector found.`
       );
       retryCount = 0;
     }
   }
 
-  async _elementDisplayed(driver) {
-    this.logger.info(`Checking if ${this.selector} element is displayed`);
-    const baseUrl = this._constructSessionUrl(driver);
+  async elementState(baseUrl) {
     const response = await fetch(
-      `${baseUrl}wd/hub/session/${driver.sessionId}/element/${this.element}/attribute/displayed`,
+      `${baseUrl}wd/hub/session/${this.driver.sessionId}/element`,
       {
-        method: 'GET',
+        body: JSON.stringify({
+          strategy: this.strategy,
+          selector: this.selector,
+          context: '',
+          multiple: false,
+        }),
+        method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       }
     );
-    const json = await response.json();
-    if (json.value.error) {
-      if (retryCount !== 25) {
+    return await response.json();
+  }
+
+  async _elementDisplayed() {
+    this.logger.info(`Checking if ${this.selector} element is displayed`);
+    const baseUrl = this._constructSessionUrl();
+    const response = await this.elementDisplayed(baseUrl);
+    if (response.value.error) {
+      if (retryCount !== this._getTimeout()) {
         this.logger.info(
           `Retrying to check whether ${this.selector} element is displayed or not`
         );
         retryCount++;
-        await this._elementDisplayed(driver);
+        await this._elementDisplayed();
       }
     }
-    if (json.sessionId && json.value === 'true') {
+    if (response.sessionId && response.value === 'true') {
       this.logger.info(`${this.selector} element is displayed.`);
       retryCount = 0;
     }
   }
 
-  _getAutomationName(driver) {
-    return driver.caps.automationName;
+  async elementDisplayed(baseUrl) {
+    const response = await fetch(
+      `${baseUrl}wd/hub/session/${this.driver.sessionId}/element/${this.element}/attribute/displayed`,
+      {
+        method: 'GET',
+        headers: { 'Content-Type': 'application/json' },
+      }
+    );
+    return await response.json();
+  }
+
+  _getAutomationName() {
+    return this.driver.caps.automationName;
   }
 
-  _constructSessionUrl(driver) {
-    const automationName = this._getAutomationName(driver);
+  _constructSessionUrl() {
+    const automationName = this._getAutomationName();
     if (automationName === 'XCuiTest') {
-      return `${driver.wda.wdaBaseUrl}:${driver.wda.wdaLocalPort}/`;
+      return `${this.driver.wda.wdaBaseUrl}:${this.driver.wda.wdaLocalPort}/`;
+    } else {
+      return `http://${this.driver.uiautomator2.host}:${this.driver.uiautomator2.systemPort}/`;
+    }
+  }
+
+  _getTimeout() {
+    if (this.driver.caps['element-wait']) {
+      return (this.timeout = this.driver.caps['element-wait']);
     } else {
-      return `http://${driver.uiautomator2.host}:${driver.uiautomator2.systemPort}/`;
+      return (this.timeout = 30);
     }
   }
 }