wait.until(ExpectedConditions.visibilityOf(elementName)) related issue

[vikramvi]

Description

I've below code

WebDriverWait wait = new WebDriverWait(AppiumController.instance.driver, timeout); wait.until(ExpectedConditions.visibilityOf(elementName));

Here I pass timeout value but observed that instead of waiting for timeout value, it waits for default time mentioned in

PageFactory.initElements(new AppiumFieldDecorator(driver, 30, TimeUnit.SECONDS), this);

Environment

• java client build version or git revision if you use some shapshot: 5.0.0-BETA3
• Appium server version or git revision if you use some shapshot: 1.6.3
• Desktop OS/version used to run Appium if necessary: Mac
• Node.js version (unless using Appium.app|exe) or Appium CLI or Appium.app|exe:
• Mobile platform/version under test: iOS 10.2
• Real device or emulator/simulator: simulator

Details

1. When I set wait , I expect element to wait for that time interval itself.
2. But value set for wait is ignored and element waits for default timeout mentioned in PageFactory.initElements
3. Later I tried @WithTimeout(time = 3, unit = TimeUnit.SECONDS) for this element but still it waits for defaulttime, my understanding is this particular tag overrides the default time.

Code To Reproduce Issue [ Good To Have ]

NA

Ecxeption stacktraces

NA

Link to Appium logs

https://gist.github.com/vikramvi/2eedd0643f89140fa3d6ffac8f347644

[vikramvi]

@TikhomirovSergey @SrinivasanTarget @saikrishna321 I feel this issue is related to #572

please have a look

[TikhomirovSergey]

Hi @vikramvi
I'm trying to reproduce the issue. It have not reproduced yet. I'm using that sample

    @WithTimeout(time = 500, unit = TimeUnit.MILLISECONDS)
    private WebElement stubSingleElement;

     ...

    @Test
    public void someTest() {
        PageFactory.initElements(new AppiumFieldDecorator(driver, 60, TimeUnit.SECONDS), this);
        FluentWait<WebDriver> wait = new WebDriverWait(driver, 5).ignoring(NoSuchElementException.class);
        long startMark = Calendar.getInstance().getTimeInMillis();
        try {
            wait.until(visibilityOf(stubSingleElement));
        } catch (TimeoutException|NoSuchElementException e) {
            System.out.print(e);
        }
        long endMark = Calendar.getInstance().getTimeInMillis();

        assertTrue(checkTimeDifference(5,
                TimeUnit.SECONDS, endMark - startMark));
    }

WebDriverWait wait = new WebDriverWait(AppiumController.instance.driver, timeout)

Could you provide the value of timeout? I want to try it.

However there is an issue. There is a conflict of implicit and explicit waitings. I think it is design issue of Selenium. You can reproduce it on commom Selenium.

driver.manage().timeouts().implicitlyWait(30, SECONDS);
FluentWait<WebDriver> wait = new WebDriverWait(driver, 5);

wait.until(presenceOfElementLocated(By.id("fakeId"))); //if 
//the element is not present or doen't exist

It will wait for more than 30 seconds.

One more question. Does the element xpath = //XCUIElementTypeApplication[1]//XCUIElementTypeButton[contains(@label,'Already a member')] exist?

Also I'am trying to read the log and it seems everything works ok.
Here it starts the searching
Here the searching ends. The value of timeout is reverted to 10 seconds

[vikramvi]

@TikhomirovSergey Please find below answers

1. In page object class I have below constructor

public pageObjectClass(AppiumDriver driver) {
	this.driver = driver;
        PageFactory.initElements(new AppiumFieldDecorator(driver, 10, TimeUnit.SECONDS), this);
    }

Per my understanding this is implicit wait which is applied to all the elements on this page , is this correct ?

2. Then in the same class; I've generic method which checks for both element availability and unavailability

public boolean isElementPresent(WebElement elementName, int timeout){
        	try{
        	        WebDriverWait wait = new WebDriverWait(AppiumController.instance.driver, timeout);
        	        wait.until(ExpectedConditions.visibilityOf(elementName));
        	        return true;
        	}catch(Exception e){
        	    return false;
        	}
    }

Here I pass smallest amount of time possible, say 1 sec to check and return if element is absent, is this correct way of doing ?

3. xpath = //XCUIElementTypeApplication[1]//XCUIElementTypeButton[contains(@label,'Already a member')]

I check when this is suppose to be present and second instance it is suppose to be absent. For checking absent , I send 1 sec time interval but it waits for 10 sec as per implicit wait mentioned in constructor

4. Is this failing because of mixing both implicit and explicit wait as you mentioned ?

5. Isn't using @WithTimeout has an affect on implicit wait ?

6. timeout I'm using 10 sec as implicit wait

[TikhomirovSergey]

@vikramvi

Per my understanding this is implicit wait which is applied to all the elements on this page , is this correct ?

yes

2. Then in the same class; I've generic method which checks for both element availability and unavailability
   ...
   Here I pass smallest amount of time possible, say 1 sec to check and return if element is absent, is this correct way of doing ?

I'm not sure. What the purpose? May be it is better to just ask

element.isDisplayed();

What are you trying to achieve? Is it some quick checking that is used for if/else?

So you can work it out these ways:

@WithTimeout(time = 100, unit = TimeUnit.MILLISECONDS)
...
WebElement element

or

private RimeOutDuration duration; //should be initiated

...
PageFactory.initElements(new AppiumFieldDecorator(duration), this);
...

public boolean isElementPresent(WebElement elementName, int timeout){
               long time = duration.getTime();
               TimeUnit unit = duration.getTimeUnit(); 
        	try{
                        duration.setTime(100, TimeUnit.MILLISECONDS);
        	        WebDriverWait wait = new WebDriverWait(AppiumController.instance.driver, timeout);
        	        wait.until(ExpectedConditions.visibilityOf(elementName));
        	        return true;
        	}catch(Exception e){
        	    return false;
        	}
               finally {
                     duration.setTime(time, unit);
              }
    }

Is this failing because of mixing both implicit and explicit wait as you mentioned ?

I think yes. I suppose that it is design issue of Selenium.

Sorry for delayng.

[vikramvi]

@TikhomirovSergey sorry for late reply, please find below info in which things go havoc ( I tried with java client project )

AndroidPageObjectTest.java

    @WithTimeout(time = 4, unit = TimeUnit.SECONDS)
    @FindBy(id = "android:id/text11")  //this is invalid locator; purposely put up
    private WebElement textView;

@Before public void setUp() throws Exception {
        if (!populated) {
            //This time out is set because test can be run on slow Android SDK emulator
            PageFactory.initElements(new AppiumFieldDecorator(driver, 15, TimeUnit.SECONDS), this);
                   
        }

        populated = true;
    }

public boolean isElementPresent(WebElement elementName, int timeout){
        //long time = duration.getTime();
        //TimeUnit unit = duration.getTimeUnit(); 
 	try{
                // duration.setTime(100, TimeUnit.MILLISECONDS);
 	        WebDriverWait wait = new WebDriverWait(driver, timeout);
 	        wait.until(ExpectedConditions.visibilityOf(elementName));
 	        return true;
 	}catch(Exception e){
 	    return false;
 	}
        finally {
              //duration.setTime(time, unit);
       }
}
    
    @Test public void findByElementTest() {//Vikram
	//duration.setTime(10, TimeUnit.SECONDS);
	isElementPresent(textView,2);
       // assertNotEquals(null, textView.getAttribute("text"));
    }

Here I have 3 times set for same element
4 sec at element declaration
2 sec for checking that it's absent
15 sec as implicit wait

In this case even though appium server log says

[debug] [BaseDriver] Set implicit wait to 0ms
[debug] [BaseDriver] Set implicit wait to 15000ms

Test takes 15+ sec.

I feel we should make it clear not to combine all the timeouts and mention good practices wrt its usage.

[TikhomirovSergey]

@vikramvi Will try to reproduce it on the sample above soon.

[TikhomirovSergey]

@vikramvi Ok. It is interesting

The first sample

package io.appium.java_client.pagefactory_tests;

import io.appium.java_client.android.BaseAndroidTest;
import io.appium.java_client.pagefactory.AppiumFieldDecorator;
import io.appium.java_client.pagefactory.WithTimeout;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.PageFactory;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;

import java.util.Calendar;
import java.util.concurrent.TimeUnit;

import static org.junit.Assert.assertTrue;

public class BugReproducing extends BaseAndroidTest {

    private static final long ACCEPTABLE_DELTA_MILLS = 1500;

    @WithTimeout(time = 4, unit = TimeUnit.SECONDS)
    @FindBy(id = "android:id/text11")  //this is invalid locator; purposely put up
    private WebElement textView;

    /**
     * The setting up.
     */
    @Before
    public void setUp() throws Exception {
        PageFactory.initElements(new AppiumFieldDecorator(driver, 15, TimeUnit.SECONDS), this);
    }

    public boolean isElementPresent(WebElement elementName, int timeout){
        try{
            WebDriverWait wait = new WebDriverWait(driver, timeout);
            wait.until(ExpectedConditions.visibilityOf(elementName));
            return true;
        }catch(Exception e){
            return false;
        }
    }

    private static boolean checkTimeDifference(long expectedTime, TimeUnit expectedTimeUnit,
                                               long currentMillis) {
        long expectedMillis = TimeUnit.MILLISECONDS.convert(expectedTime, expectedTimeUnit);
        try {
            Assert.assertEquals(true,
                    ((currentMillis - expectedMillis) < ACCEPTABLE_DELTA_MILLS) && (
                            (currentMillis - expectedMillis) >= 0));
        } catch (Error e) {
            String message = String.valueOf(expectedTime) + " "
                    + expectedTimeUnit.toString()
                    + " current duration in millis "
                    + String.valueOf(currentMillis) + " Failed";
            throw new AssertionError(message, e);
        }
        return true;
    }

    @Test
    public void findByElementTest() {
        long startMark = Calendar.getInstance().getTimeInMillis();
        //isElementPresent(textView,2);
        try {
            textView.isDisplayed();
        }
        catch (Exception e) {
            e.printStackTrace();
        }
        long endMark = Calendar.getInstance().getTimeInMillis();
        assertTrue(checkTimeDifference(4,
                TimeUnit.SECONDS, endMark - startMark));
    }
}

and

It took about 4.5 sec.

ok.

package io.appium.java_client.pagefactory_tests;

import io.appium.java_client.android.BaseAndroidTest;
import io.appium.java_client.pagefactory.AppiumFieldDecorator;
import io.appium.java_client.pagefactory.WithTimeout;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.PageFactory;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;

import java.util.Calendar;
import java.util.concurrent.TimeUnit;

import static org.junit.Assert.assertTrue;

public class BugReproducing extends BaseAndroidTest {

    private static final long ACCEPTABLE_DELTA_MILLS = 1500;

    @WithTimeout(time = 4, unit = TimeUnit.SECONDS)
    @FindBy(id = "android:id/text11")  //this is invalid locator; purposely put up
    private WebElement textView;

    /**
     * The setting up.
     */
    @Before
    public void setUp() throws Exception {
        PageFactory.initElements(new AppiumFieldDecorator(driver, 15, TimeUnit.SECONDS), this);
    }

    public boolean isElementPresent(WebElement elementName, int timeout){
        try{
            WebDriverWait wait = new WebDriverWait(driver, timeout);
            wait.until(ExpectedConditions.visibilityOf(elementName));
            return true;
        }catch(Exception e){
            return false;
        }
    }

    private static boolean checkTimeDifference(long expectedTime, TimeUnit expectedTimeUnit,
                                               long currentMillis) {
        long expectedMillis = TimeUnit.MILLISECONDS.convert(expectedTime, expectedTimeUnit);
        try {
            Assert.assertEquals(true,
                    ((currentMillis - expectedMillis) < ACCEPTABLE_DELTA_MILLS) && (
                            (currentMillis - expectedMillis) >= 0));
        } catch (Error e) {
            String message = String.valueOf(expectedTime) + " "
                    + expectedTimeUnit.toString()
                    + " current duration in millis "
                    + String.valueOf(currentMillis) + " Failed";
            throw new AssertionError(message, e);
        }
        return true;
    }

    @Test
    public void findByElementTest() {
        long startMark = Calendar.getInstance().getTimeInMillis();
        isElementPresent(textView,2);
        /*try {
            textView.isDisplayed();
        }
        catch (Exception e) {
            e.printStackTrace();
        }*/
        long endMark = Calendar.getInstance().getTimeInMillis();
        assertTrue(checkTimeDifference(4,
                TimeUnit.SECONDS, endMark - startMark));
    }
}

this test was failed

But you can see that

4 SECONDS current duration in millis 8675 Failed
java.lang.AssertionError: 4 SECONDS current duration in millis 8675 Failed

not 15 seconds. However it looks curiously.

Ok. One more sample.

package io.appium.java_client.pagefactory_tests;

import io.appium.java_client.android.BaseAndroidTest;
import org.junit.Assert;
import org.junit.Test;
import org.openqa.selenium.By;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;

import java.util.Calendar;
import java.util.concurrent.TimeUnit;

import static org.junit.Assert.assertTrue;

public class BugReproducing extends BaseAndroidTest {

    public boolean isElementPresent(By by, int timeout){
        try{
            WebDriverWait wait = new WebDriverWait(driver, timeout);
            wait.until(ExpectedConditions.visibilityOfElementLocated(by));
            return true;
        }catch(Exception e){
            return false;
        }
    }

    private static boolean checkTimeDifference(long expectedTime, TimeUnit expectedTimeUnit,
                                               long currentMillis) {
        long expectedMillis = TimeUnit.MILLISECONDS.convert(expectedTime, expectedTimeUnit);
        try {
            Assert.assertEquals(true,
                    ((currentMillis - expectedMillis) < ACCEPTABLE_DELTA_MILLS) && (
                            (currentMillis - expectedMillis) >= 0));
        } catch (Error e) {
            String message = String.valueOf(expectedTime) + " "
                    + expectedTimeUnit.toString()
                    + " current duration in millis "
                    + String.valueOf(currentMillis) + " Failed";
            throw new AssertionError(message, e);
        }
        return true;
    }

    @Test
    public void findByElementTest() {
        driver.manage().timeouts().implicitlyWait(4, TimeUnit.SECONDS);
        long startMark = Calendar.getInstance().getTimeInMillis();
        isElementPresent(By.id("android:id/text11"),2);
        /*try {
            textView.isDisplayed();
        }
        catch (Exception e) {
            e.printStackTrace();
        }*/
        long endMark = Calendar.getInstance().getTimeInMillis();
        assertTrue(checkTimeDifference(4,
                TimeUnit.SECONDS, endMark - startMark));
    }
}

Test passed.

But it took about 5 seconds, not 2 as it was expected.

Ok. The workaround for now.

package io.appium.java_client.pagefactory_tests;

import io.appium.java_client.android.BaseAndroidTest;
import io.appium.java_client.pagefactory.AppiumFieldDecorator;
import io.appium.java_client.pagefactory.WithTimeout;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.PageFactory;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;

import java.util.Calendar;
import java.util.concurrent.TimeUnit;

import static org.junit.Assert.assertTrue;

public class BugReproducing extends BaseAndroidTest {

    private static final long ACCEPTABLE_DELTA_MILLS = 1500;

    @WithTimeout(time = 100, unit = TimeUnit.MILLISECONDS)
    @FindBy(id = "android:id/text11")  //this is invalid locator; purposely put up
    private WebElement textView;

    /**
     * The setting up.
     */
    @Before
    public void setUp() throws Exception {
        PageFactory.initElements(new AppiumFieldDecorator(driver, 15, TimeUnit.SECONDS), this);
    }

    public boolean isElementPresent(WebElement elementName, int timeout){
        try{
            WebDriverWait wait = new WebDriverWait(driver, timeout);
            wait.until(ExpectedConditions.visibilityOf(elementName));
            return true;
        }catch(Exception e){
            return false;
        }
    }

    private static boolean checkTimeDifference(long expectedTime, TimeUnit expectedTimeUnit,
                                               long currentMillis) {
        long expectedMillis = TimeUnit.MILLISECONDS.convert(expectedTime, expectedTimeUnit);
        try {
            Assert.assertEquals(true,
                    ((currentMillis - expectedMillis) < ACCEPTABLE_DELTA_MILLS) && (
                            (currentMillis - expectedMillis) >= 0));
        } catch (Error e) {
            String message = String.valueOf(expectedTime) + " "
                    + expectedTimeUnit.toString()
                    + " current duration in millis "
                    + String.valueOf(currentMillis) + " Failed";
            throw new AssertionError(message, e);
        }
        return true;
    }

    @Test
    public void findByElementTest() {
        long startMark = Calendar.getInstance().getTimeInMillis();
        isElementPresent(textView,2);
        long endMark = Calendar.getInstance().getTimeInMillis();
        assertTrue(checkTimeDifference(2,
                TimeUnit.SECONDS, endMark - startMark));
    }
}

And test passed

The same is true for the direct using of the implicit waiting.

Summary:
It is possible that there is an issue. I'm cahanging the label to "But". I suppose that something has to be optimized. But the fluent waiting won't take lesser time than implicit waiting time out.

PS:

[debug] [BaseDriver] Set implicit wait to 15000ms

It is normal behaviour. It reverts timeout to the general value.

[vikramvi]

@TikhomirovSergey Thanks a ton for detailed analysis, I know it's built in problem with Selenium. If we can manage in better way at client side, will be good for users.

Please let me know in case further info needed on this

[TikhomirovSergey]

@vikramvi I am going to research and try to find more optimal solution.