Extract interface from ElementActionRetrier (#53)

* Extract interface from ElementActionRetrier and Allow to pass ignored exceptions in constructor

* Allow to override IsExceptionHandled decision mechanism

* fix tested type in ApplicationNotStartedTests

Author: mialeska

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Applications/Startup.cs

@@ -38,7 +38,7 @@ public virtual IServiceCollection ConfigureServices(IServiceCollection services,
             services.AddSingleton<IRetryConfiguration, RetryConfiguration>();
             services.AddSingleton<ILocalizationManager, LocalizationManager>();
             services.AddSingleton<ILocalizedLogger, LocalizedLogger>();
-            services.AddSingleton<ElementActionRetrier>();
+            services.AddSingleton<IElementActionRetrier, ElementActionRetrier>();
 
             services.AddTransient<ConditionalWait>();
             services.AddTransient<IElementFinder, ElementFinder>();

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.xml

@@ -47,7 +47,7 @@ protected virtual IElementCacheHandler Cache
             }
         }
 
-        protected abstract ElementActionRetrier ActionRetrier { get; }
+        protected abstract IElementActionRetrier ActionRetrier { get; }
 
         protected abstract IApplication Application { get; }
 

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/Element.cs

@@ -1,31 +1,53 @@
 using Aquality.Selenium.Core.Configurations;
 using OpenQA.Selenium;
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Threading;
 
 namespace Aquality.Selenium.Core.Utilities
 {
     /// <summary>
-    /// Retries an action or function when <see cref="StaleElementReferenceException"/> or <see cref="InvalidElementStateException"/> occures.
+    /// Retries an action or function when <see cref="HandledExceptions"/> occures.
     /// </summary>
-    public class ElementActionRetrier
+    public class ElementActionRetrier : IElementActionRetrier
     {
         private readonly IRetryConfiguration retryConfiguration;
 
         /// <summary>
         /// Instantiates the class using retry configuration.
         /// </summary>
-        /// <param name="retryConfiguration"></param>
-        public ElementActionRetrier(IRetryConfiguration retryConfiguration)
+        /// <param name="retryConfiguration">Retry configuration.</param>
+        /// <param name="handledExceptions">Exceptions to be handled. 
+        /// If set to null, <see cref="StaleElementReferenceException"/> and <see cref="InvalidElementStateException"/> will be handled.</param>
+        public ElementActionRetrier(IRetryConfiguration retryConfiguration, IList<Type> handledExceptions = null)
         {
             this.retryConfiguration = retryConfiguration;
+            HandledExceptions = handledExceptions ?? new List<Type> { typeof(StaleElementReferenceException), typeof(InvalidElementStateException) };
         }
 
         /// <summary>
-        /// Retries the action when <see cref="StaleElementReferenceException"/> or <see cref="InvalidElementStateException"/> occures.
+        /// Exceptions to be ignored during action retrying.
+        /// Set by the constructor parameter.
+        /// If were not passed to constructor, <see cref="StaleElementReferenceException"/> and <see cref="InvalidElementStateException"/> will be handled.
+        /// </summary>
+        public virtual IList<Type> HandledExceptions { get; }
+
+        /// <summary>
+        /// Decides should the occured exception be handled (ignored during the retry) or not.
+        /// </summary>
+        /// <param name="exception">Exception to proceed.</param>
+        /// <returns>True if the exception should be ignored, false otherwise.</returns>
+        protected virtual bool IsExceptionHandled(Exception exception)
+        {
+            return HandledExceptions.Any(type => type.IsAssignableFrom(exception.GetType()));
+        }
+
+        /// <summary>
+        /// Retries the action when the handled exception <see cref="HandledExceptions"/> occures.
         /// </summary>
         /// <param name="action">Action to be applied.</param>
-        public void DoWithRetry(Action action)
+        public virtual void DoWithRetry(Action action)
         {
             DoWithRetry(() =>
             {
@@ -35,12 +57,12 @@ public void DoWithRetry(Action action)
         }
 
         /// <summary>
-        /// Retries the function when <see cref="StaleElementReferenceException"/> or <see cref="InvalidElementStateException"/> occures.
+        /// Retries the function when <see cref="HandledExceptions"/> occures.
         /// </summary>
         /// <typeparam name="T">Return type of function.</typeparam>
         /// <param name="function">Function to be applied.</param>
-        /// <returns>Result of the function</returns>
-        public T DoWithRetry<T>(Func<T> function)
+        /// <returns>Result of the function.</returns>
+        public virtual T DoWithRetry<T>(Func<T> function)
         {
             var retryAttemptsLeft = retryConfiguration.Number;
             var actualInterval = retryConfiguration.PollingInterval;
@@ -68,10 +90,5 @@ public T DoWithRetry<T>(Func<T> function)
 
             return result;
         }
-
-        private bool IsExceptionHandled(Exception exception)
-        {
-            return exception is StaleElementReferenceException || exception is InvalidElementStateException;
-        }
     }
 }

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Utilities/ElementActionRetrier.cs

@@ -0,0 +1,32 @@
+using OpenQA.Selenium;
+using System;
+using System.Collections.Generic;
+
+namespace Aquality.Selenium.Core.Utilities
+{
+    /// <summary>
+    /// Retries an action or function when <see cref="HandledExceptions"/> occures.
+    /// </summary>
+    public interface IElementActionRetrier
+    {
+        /// <summary>
+        /// Exceptions to be ignored during action retrying.
+        /// By the default implementation, <see cref="StaleElementReferenceException"/> and <see cref="InvalidElementStateException"/> are handled.
+        /// </summary>
+        IList<Type> HandledExceptions { get; }
+
+        /// <summary>
+        /// Retries the action when the handled exception <see cref="HandledExceptions"/> occures.
+        /// </summary>
+        /// <param name="action">Action to be applied.</param>
+        void DoWithRetry(Action action);
+
+        /// <summary>
+        /// Retries the function when the handled exception <see cref="HandledExceptions"/> occures.
+        /// </summary>
+        /// <typeparam name="T">Return type of function.</typeparam>
+        /// <param name="function">Function to be applied.</param>
+        /// <returns>Result of the function.</returns>
+        T DoWithRetry<T>(Func<T> function);
+    }
+}

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Utilities/IElementActionRetrier.cs

@@ -14,7 +14,7 @@ public class ApplicationNotStartedTests : TestWithBrowser
     {
         private static readonly Type[] TypesNotRequireApplication = 
         { 
-            typeof(ElementActionRetrier),
+            typeof(IElementActionRetrier),
             typeof(ConditionalWait),
             typeof(Logger),
             typeof(ILocalizationManager),

Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Applications/Browser/ApplicationNotStartedTests.cs

@@ -16,7 +16,7 @@ protected WebElement(By locator, string name, ElementState state) : base(locator
         {
         }
 
-        protected override ElementActionRetrier ActionRetrier => AqualityServices.ServiceProvider.GetRequiredService<ElementActionRetrier>();
+        protected override IElementActionRetrier ActionRetrier => AqualityServices.ServiceProvider.GetRequiredService<IElementActionRetrier>();
 
         protected override IApplication Application => AqualityServices.Application;
 

Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Applications/Browser/Elements/WebElement.cs

@@ -16,7 +16,7 @@ protected WindowElement(By locator, string name) : base(locator, name, ElementSt
         {
         }
 
-        protected override ElementActionRetrier ActionRetrier => AqualityServices.ServiceProvider.GetRequiredService<ElementActionRetrier>();
+        protected override IElementActionRetrier ActionRetrier => AqualityServices.ServiceProvider.GetRequiredService<IElementActionRetrier>();
 
         protected override IApplication Application => AqualityServices.Application;