Add synchronization to tab page resolver (#300)

Author: sbabcoc

src/main/java/com/nordstrom/automation/selenium/examples/TabPageResolver.java

@@ -1,8 +1,12 @@
 package com.nordstrom.automation.selenium.examples;
 
+import org.openqa.selenium.TimeoutException;
+import org.openqa.selenium.WebElement;
+
+import com.nordstrom.automation.selenium.AbstractSeleniumConfig.WaitType;
 import com.nordstrom.automation.selenium.exceptions.UnresolvedContainerTypeException;
 import com.nordstrom.automation.selenium.interfaces.ContainerResolver;
-import com.nordstrom.automation.selenium.model.RobustWebElement;
+import com.nordstrom.automation.selenium.support.Coordinators;
 
 /**
  * This class implements the container resolver for the tab pages opened by the "Open A/B Tab" button on the 'Example'
@@ -11,17 +15,19 @@
 public class TabPageResolver implements ContainerResolver<TabPage> {
     @Override
     public TabPage resolve(TabPage container) {
-        RobustWebElement element = container.findOptional(TabPage.Using.HEADING);
-        if (element.hasReference()) {
+        try {
+            WebElement element = container.getWait(WaitType.PAGE_LOAD)
+                    .until(Coordinators.presenceOfElementLocated(TabPage.Using.HEADING.locator()));
             String pageContent = element.getText();
             if (pageContent.equals(TabPageA.EXPECT_CONTENT)) {
                 return new TabPageA(container.getWrappedDriver());
             }
             if (pageContent.equals(TabPageB.EXPECT_CONTENT)) {
                 return new TabPageB(container.getWrappedDriver());
             }
-           throw new UnresolvedContainerTypeException("Unsupported tab page heading: " + pageContent);
+            throw new UnresolvedContainerTypeException("Unsupported tab page heading: " + pageContent);
+        } catch (TimeoutException e) {
+            throw new UnresolvedContainerTypeException("Tab page heading not found");
         }
-        throw new UnresolvedContainerTypeException("Tab page heading not found");
     }
 }

src/main/java/com/nordstrom/automation/selenium/model/ComponentContainer.java

@@ -106,7 +106,7 @@ public interface ByEnum {
      * Constructor for component container
      * 
      * @param context container search context
-     * @param parent container parent (may be {@code null} for {@link Page} objects
+     * @param parent container parent (may be {@code null} for {@link Page} objects)
      */
     public ComponentContainer(final SearchContext context, final ComponentContainer parent) {
         Objects.requireNonNull(context, "[context] must be non-null");
@@ -370,7 +370,7 @@ public RobustWebElement findOptional(final ByEnum constant) {
      * @return robust web element
      */
     public RobustWebElement findOptional(final By by) {
-        return (RobustWebElement) RobustElementFactory.getElement(this, by, RobustElementWrapper.OPTIONAL);
+        return RobustElementFactory.getOptional(this, by);
     }
 
     /**

src/main/java/com/nordstrom/automation/selenium/model/RobustElementFactory.java

@@ -248,4 +248,17 @@ public static WebElement getElement(final WrapsContext context, final By locator
     public static WebElement getElement(final WrapsContext context, final By locator, final int index) {
         return makeRobustElement(null, context, locator, index);
     }
+    
+    /**
+     * Get a wrapped reference to the first element matching the specified locator.
+     * <p>
+     * <b>NOTE</b>: Use {@link RobustWebElement#hasReference()} to determine if a valid reference was acquired.
+     * 
+     * @param context element search context
+     * @param locator element locator
+     * @return optional robust element in context that matches the locator
+     */
+    public static RobustWebElement getOptional(final WrapsContext context, final By locator) {
+        return (RobustWebElement) makeRobustElement(null, context, locator, RobustElementWrapper.OPTIONAL);
+    }
 }

src/main/java/com/nordstrom/automation/selenium/utility/SearchContextUtils.java

@@ -159,30 +159,28 @@ public static String quoteSelector(final String selector) {
      * @return containing {@link ComponentContainer}
      */
     public static ComponentContainer getContainingContext(final SearchContext context) {
-        SearchContext unwrapped = unwrapContext(context);
-        while (unwrapped != null) {
-            if (unwrapped instanceof ComponentContainer) {
-                return (ComponentContainer) unwrapped;
-            }
-            unwrapped = unwrapContext(unwrapped);
+        SearchContext candidate = context;
+        while (candidate instanceof RobustWebElement) {
+            candidate = (SearchContext) ((RobustWebElement) candidate).getContext();
         }
-        return null;
+        if (candidate instanceof ComponentContainer) {
+            return (ComponentContainer) candidate;
+        }
+        throw new UnsupportedOperationException("Failed getting containing context");
     }
 
     /**
-     * Get the parent context for the specified search context.
+     * Unwrap the specified search context.
      * 
      * @param context target search context
-     * @return parent {@link SearchContext}
+     * @return unwrapped {@link SearchContext}
      */
     public static SearchContext unwrapContext(final SearchContext context) {
-        if (context instanceof RobustWebElement) {
-            return (SearchContext) ((RobustWebElement) context).getContext();
-        }
-        if (context instanceof WrapsContext) {
-            return ((WrapsContext) context).getWrappedContext();
+        SearchContext unwrapped = context;
+        while (unwrapped instanceof WrapsContext) {
+            unwrapped = ((WrapsContext) context).getWrappedContext();
         }
-        return null;
+        return unwrapped;
     }
 
     /**