Skip to content

Commit

Permalink
#1361: draft implementation of isAlive method for CarinaDriver in IDr…
Browse files Browse the repository at this point in the history 
…iverPool
  • Loading branch information
@vdelendik
vdelendik committed Sep 12, 2021
1 parent bc865b3 commit 920a352
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 31 deletions.
13 changes: 12 additions & 1 deletion ...-webdriver/src/main/java/com/qaprosoft/carina/core/foundation/webdriver/CarinaDriver.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ public class CarinaDriver {
private Device device;
private Phase phase;
private long threadId;
private boolean isAlive;

public CarinaDriver(String name, WebDriver driver, Device device, Phase phase, long threadId) {
public CarinaDriver(String name, WebDriver driver, Device device, Phase phase, long threadId) {
super();
this.name = name;
this.driver = driver;
this.device = device;
this.phase = phase;
this.threadId = threadId;

this.isAlive = true;
}

public WebDriver getDriver() {
Expand All @@ -44,4 +47,12 @@ public Phase getPhase() {
protected void setThreadId(long threadId) {
this.threadId = threadId;
}

public boolean isAlive() {
return isAlive;
}

public void setAlive(boolean isAlive) {
this.isAlive = isAlive;
}
}
19 changes: 13 additions & 6 deletions ...a-webdriver/src/main/java/com/qaprosoft/carina/core/foundation/webdriver/IDriverPool.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,14 +135,14 @@ default public WebDriver getDriver(String name, DesiredCapabilities capabilities
}

/**
* Get driver by sessionId.
* Get Carina driver by sessionId.
*
* @param sessionId
* - session id to be used for searching a desired driver
*
* @return default WebDriver
* @return default CarinaDriver
*/
public static WebDriver getDriver(SessionId sessionId) {
public static CarinaDriver getCarinaDriver(SessionId sessionId) {
for (CarinaDriver carinaDriver : driversPool) {
WebDriver drv = carinaDriver.getDriver();
if (drv instanceof EventFiringWebDriver) {
Expand All @@ -154,11 +154,11 @@ public static WebDriver getDriver(SessionId sessionId) {

if (drvSessionId != null) {
if (sessionId.equals(drvSessionId)) {
return drv;
return carinaDriver;
}
}
}
throw new DriverPoolException("Unable to find driver using sessionId artifacts. Returning default one!");
throw new DriverPoolException("Unable to find driver using sessionId!");
}

/**
Expand Down Expand Up @@ -238,7 +238,14 @@ default public void quitDriver(String name) {
throw new RuntimeException("Unable to find driver '" + name + "'!");
}

quitDriver(carinaDrv, false);
if (carinaDrv.isAlive()) {
//do actual quit only if driver still alive
quitDriver(carinaDrv, false);
} else {
POOL_LOGGER.error("Unable to do quit over died driver: " + carinaDrv.getName() + " for thread: " + carinaDrv.getThreadId());
}


driversPool.remove(carinaDrv);

POOL_LOGGER.debug("after quitDriver: " + driversPool);
Expand Down
2 changes: 1 addition & 1 deletion ...ain/java/com/qaprosoft/carina/core/foundation/webdriver/decorator/ExtendedWebElement.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ public ExtendedWebElement(WebElement element, String name) {
// that's the only place to use DriverPool to get driver.
try {
//try to search securely in driver pool by sessionId
this.driver = IDriverPool.getDriver(sessionId);
this.driver = IDriverPool.getCarinaDriver(sessionId).getDriver();
} catch (DriverPoolException ex) {
// seems like driver started outside of IDriverPool so try to register it as well
this.driver = (WebDriver) tempSearchContext;
Expand Down
80 changes: 57 additions & 23 deletions ...src/main/java/com/qaprosoft/carina/core/foundation/webdriver/listener/DriverListener.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@
import org.openqa.selenium.OutputType;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.support.events.EventFiringWebDriver;
import org.openqa.selenium.support.events.WebDriverEventListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.qaprosoft.carina.core.foundation.report.ReportContext;
import com.qaprosoft.carina.core.foundation.utils.FileManager;
import com.qaprosoft.carina.core.foundation.webdriver.CarinaDriver;
import com.qaprosoft.carina.core.foundation.webdriver.IDriverPool;
import com.qaprosoft.carina.core.foundation.webdriver.Screenshot;
import com.zebrunner.agent.core.registrar.Artifact;
Expand Down Expand Up @@ -152,26 +154,15 @@ public void beforeScript(String script, WebDriver driver) {

@Override
public void onException(Throwable thr, WebDriver driver) {
// [VD] make below code as much safety as possible otherwise potential recursive failure could occur with driver related issue.
// most suspicious are capture screenshots, generating dumps etc
if (thr == null
|| thr.getMessage() == null
|| thr.getMessage().contains("Method has not yet been implemented")
|| thr.getMessage().contains("Expected to read a START_MAP but instead have: END. Last 0 characters read")
|| thr.getMessage().contains("Unable to determine type from: <. Last 1 characters read")
|| thr.getMessage().contains("script timeout")
|| thr.getMessage().contains("javascript error: Cannot read property 'outerHTML' of null")
|| thr.getMessage().contains("javascript error: Cannot read property 'scrollHeight' of null")
|| thr.getMessage().contains("Method is not implemented")
|| thr.getMessage().contains("An element could not be located on the page using the given search parameters")
|| thr.getMessage().contains("no such element: Unable to locate element")
// carina has a lot of extra verifications to solve all stale reference issue and finally perform an action so ignore such exception in listener!
|| thr.getMessage().contains("StaleElementReferenceException")
|| thr.getMessage().contains("stale_element_reference.html")) {
if (thr == null || thr.getMessage() == null) {
// do nothing
return;
}


CarinaDriver carinaDriver = IDriverPool.getCarinaDriver(((RemoteWebDriver) driver).getSessionId());

String message = thr.getMessage();

// handle use-case when application crashed on iOS but tests continue to execute something because doesn't raise valid exception
// Example:

Expand All @@ -183,21 +174,64 @@ public void onException(Throwable thr, WebDriver driver) {
// stacktrace information)

// TODO: investigate if we run @AfterMethod etc system events after this crash
if (thr.getMessage().contains("is not running, possibly crashed")) {
if (message.contains("is not running, possibly crashed")) {
throw new RuntimeException(thr);
}

if (message.contains("Session ID is null. Using WebDriver after calling quit")
|| message.contains("A session is either terminated or not started")
|| message.contains("invalid session id")
|| message.contains("Session does not exist")
|| message.contains("not found in active sessions")
|| message.contains("Session timed out or not found")
|| message.contains("Unable to determine type from: <. Last 1 characters read")
|| message.contains("not available and is not among the last 1000 terminated sessions")
|| message.contains("cannot forward the request")
|| message.contains("connect ECONNREFUSED")
|| message.contains("was terminated due to") // FORWARDING_TO_NODE_FAILED, CLIENT_STOPPED_SESSION, PROXY_REREGISTRATION, TIMEOUT, BROWSER_TIMEOUT etc
|| message.contains("no such window: window was already closed")
|| message.contains("Error communicating with the remote browser. It may have died")
|| message.contains("chrome not reachable")
|| message.contains("cannot forward the request Connect to")
|| message.contains("Could not proxy command to remote server. Original error:") // Error: socket hang up, Error: read ECONNRESET etc
|| message.contains("Could not proxy command to the remote server. Original error:") // Different messages on some Appium versions
|| message.contains("Driver connection refused")) {
// mark driver as not alive anymore!
LOGGER.error("Mark current driver as died!");

carinaDriver.setAlive(false);
return;
}

// [VD] make below code as much safety as possible otherwise potential recursive failure could occur with driver related issue.
// most suspicious are capture screenshots, generating dumps etc
if (message.contains("Method has not yet been implemented")
|| message.contains("Expected to read a START_MAP but instead have: END. Last 0 characters read")
|| message.contains("Unable to determine type from: <. Last 1 characters read")
|| message.contains("script timeout")
|| message.contains("javascript error: Cannot read property 'outerHTML' of null")
|| message.contains("javascript error: Cannot read property 'scrollHeight' of null")
|| message.contains("Method is not implemented")
|| message.contains("An element could not be located on the page using the given search parameters")
|| message.contains("no such element: Unable to locate element")
// carina has a lot of extra verifications to solve all stale reference issue and finally perform an action so ignore such exception in listener!
|| message.contains("StaleElementReferenceException")
|| message.contains("stale_element_reference.html")) {
// do nothing
return;
}

// hopefully castDriver below resolve root cause of the recursive onException calls but keep below to ensure
if (thr.getStackTrace() != null
&& (Arrays.toString(thr.getStackTrace())
.contains("com.qaprosoft.carina.core.foundation.webdriver.listener.DriverListener.onException")
|| Arrays.toString(thr.getStackTrace()).contains("Unable to capture screenshot due to the WebDriverException"))) {
LOGGER.error("Do not generate screenshot for invalid driver!");
LOGGER.warn("Do not generate recursive screenshots!");
// prevent recursive crash for onException
return;
}

LOGGER.debug("DriverListener->onException starting..." + thr.getMessage());
LOGGER.debug("DriverListener->onException starting..." + message);
driver = castDriver(driver);

try {
Expand All @@ -207,8 +241,8 @@ public void onException(Throwable thr, WebDriver driver) {
// 3. 99% those root exception means that we should prohibit screenshot generation for such use-case
// 4. if 3rd one is true just update Screenshot.isCaptured() adding part of the exception to the list
// handle cases which should't be captured
if (Screenshot.isCaptured(thr.getMessage())) {
captureScreenshot(thr.getMessage(), driver, null, true);
if (carinaDriver.isAlive() && Screenshot.isCaptured(message)) {
captureScreenshot(message, driver, null, true);
}
} catch (Exception e) {
if (!e.getMessage().isEmpty()
Expand All @@ -218,7 +252,7 @@ public void onException(Throwable thr, WebDriver driver) {
LOGGER.error("Unrecognized exception detected in DriverListener->onException! " + e.getMessage(), e);
}
} catch (Throwable e) {
LOGGER.error("Take a look to the logs above for current thread and add exception into the exclusion for Screenshot.isCaptured(). "
LOGGER.error("Take a look to the logs above for current thread and exclude particular exception for Screenshot.isCaptured(). "
+ e.getMessage(), e);
}

Expand Down

0 comments on commit 920a352

Please sign in to comment.