Fix an error which lead to fallback messages being used needlessly

craigfowler · craigfowler · commit 80b193f024c6 · 2026-03-17T21:31:53.000Z
The problem was that formatting the Lazy Selenium Element caused a new
exception of its own, causing the fallback message to be used.
This now catches those errors and handles them in a way that allows
the proper message to be generated.
diff --git a/CSF.Screenplay.Selenium/Actions/ClearTheContents.cs b/CSF.Screenplay.Selenium/Actions/ClearTheContents.cs
@@ -46,7 +46,7 @@ public class ClearTheContents : ISingleElementPerformable
     {
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} clears the contents of {Element}", actor.Name, element.Value);
+            => formatter.Format("{Actor} clears the contents of {Element}", actor.Name, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/Click.cs b/CSF.Screenplay.Selenium/Actions/Click.cs
@@ -41,7 +41,7 @@ public class Click : ISingleElementPerformable
     {
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} clicks on {Element}", actor.Name, element.Value);
+            => formatter.Format("{Actor} clicks on {Element}", actor.Name, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/DeselectAll.cs b/CSF.Screenplay.Selenium/Actions/DeselectAll.cs
@@ -47,7 +47,7 @@ public class DeselectAll : ISingleElementPerformable
     {
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} deselects all of the options from {Element}", actor.Name, element.Value);
+            => formatter.Format("{Actor} deselects all of the options from {Element}", actor.Name, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/DeselectByIndex.cs b/CSF.Screenplay.Selenium/Actions/DeselectByIndex.cs
@@ -50,7 +50,7 @@ public class DeselectByIndex : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} deselects option {Index} (zero-based) from {Element}", actor.Name, index, element.Value);
+            => formatter.Format("{Actor} deselects option {Index} (zero-based) from {Element}", actor.Name, index, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/DeselectByText.cs b/CSF.Screenplay.Selenium/Actions/DeselectByText.cs
@@ -50,7 +50,7 @@ public class DeselectByText : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} deselects '{Text}' from {Element}", actor.Name, text, element.Value);
+            => formatter.Format("{Actor} deselects '{Text}' from {Element}", actor.Name, text, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/DeselectByValue.cs b/CSF.Screenplay.Selenium/Actions/DeselectByValue.cs
@@ -50,7 +50,7 @@ public class DeselectByValue : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} deselects the option with value {Value} from {Element}", actor.Name, value, element.Value);
+            => formatter.Format("{Actor} deselects the option with value {Value} from {Element}", actor.Name, value, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/SelectByIndex.cs b/CSF.Screenplay.Selenium/Actions/SelectByIndex.cs
@@ -59,7 +59,7 @@ public class SelectByIndex : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} selects option {Index} (zero-based) from {Element}", actor.Name, index, element.Value);
+            => formatter.Format("{Actor} selects option {Index} (zero-based) from {Element}", actor.Name, index, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/SelectByText.cs b/CSF.Screenplay.Selenium/Actions/SelectByText.cs
@@ -59,7 +59,7 @@ public class SelectByText : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} selects '{Text}' from {Element}", actor.Name, text, element.Value);
+            => formatter.Format("{Actor} selects '{Text}' from {Element}", actor.Name, text, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/SelectByValue.cs b/CSF.Screenplay.Selenium/Actions/SelectByValue.cs
@@ -59,7 +59,7 @@ public class SelectByValue : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} selects the option with value {Value} from {Element}", actor.Name, value, element.Value);
+            => formatter.Format("{Actor} selects the option with value {Value} from {Element}", actor.Name, value, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Actions/SendKeys.cs b/CSF.Screenplay.Selenium/Actions/SendKeys.cs
@@ -53,7 +53,7 @@ public class SendKeys : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} enters the text '{Text}' into {Element}", actor.Name, text, element.Value);
+            => formatter.Format("{Actor} enters the text '{Text}' into {Element}", actor.Name, text, element);
 
         /// <inheritdoc/>
         public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Elements/LazySeleniumElementFormatter.cs b/CSF.Screenplay.Selenium/Elements/LazySeleniumElementFormatter.cs
@@ -0,0 +1,50 @@
+using System;
+using CSF.Screenplay.Reporting;
+using CSF.Screenplay.Selenium.Resources;
+
+namespace CSF.Screenplay.Selenium.Elements
+{
+    /// <summary>
+    /// A value formatter for <see cref="Lazy{T}"/> of <see cref="SeleniumElement"/>.
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// Importantly this handles errors which may be raised when resolving the element from the Web Driver.
+    /// </para>
+    /// </remarks>
+    public class LazySeleniumElementFormatter : IValueFormatter
+    {
+        /// <inheritdoc/>
+        public bool CanFormat(object value) => value is Lazy<SeleniumElement> || value is Lazy<IHasSearchContext>;
+
+        /// <inheritdoc/>
+        public string FormatForReport(object value)
+        {
+            if (value is Lazy<SeleniumElement> lazyElement) return GetName(lazyElement);
+            if (value is Lazy<IHasSearchContext> lazySearch) return GetName(lazySearch);
+            throw new ArgumentException($"The value must be either a lazy {nameof(SeleniumElement)} or a lazy {nameof(IHasSearchContext)}");
+        }
+
+        internal static string GetName(Lazy<SeleniumElement> lazyElement)
+            => GetName(e => e.Value.Name, lazyElement);
+
+        internal static string GetName(Lazy<IHasSearchContext> lazySearch)
+            => GetName(e => e.Value.Name, lazySearch);
+
+        static string GetName<T>(Func<Lazy<T>, string> getter, Lazy<T> lazy) where T : IHasName
+        {
+            try
+            {
+                return getter(lazy);
+            }
+            catch(TargetNotFoundException)
+            {
+                return MessageResources.NonExistentElement;
+            }
+            catch
+            {
+                return MessageResources.UnknownElement;
+            }
+        }
+    }
+}
diff --git a/CSF.Screenplay.Selenium/Questions/FindElement.cs b/CSF.Screenplay.Selenium/Questions/FindElement.cs
@@ -2,7 +2,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using CSF.Screenplay.Selenium.Elements;
-using OpenQA.Selenium;
 
 namespace CSF.Screenplay.Selenium.Questions
 {
@@ -66,18 +65,18 @@ public class FindElement : IPerformableWithResult<SeleniumElement>, ICanReport
         public ReportFragment GetReportFragment(Actor actor, IFormatsReportFragment formatter)
         {
             lazyElement = lazyElement ?? GetLazyElement(actor);
-            return formatter.Format("{Actor} finds {ElementsName} from {Element}", actor, GetElementsName(lazyElement.Value) ?? "HTML elements", lazyElement.Value);
+            return formatter.Format("{Actor} finds {ElementsName} within {Element}", actor, GetElementsName(), lazyElement);
         }
 
         /// <inheritdoc/>
         public ValueTask<SeleniumElement> PerformAsAsync(ICanPerform actor, CancellationToken cancellationToken = default)
         {
             lazyElement = lazyElement ?? GetLazyElement(actor);
             var element = lazyElement.Value.SearchContext.FindElement(locatorBasedMatcher ?? CssSelector.AnyElement);
-            return new ValueTask<SeleniumElement>(new SeleniumElement(element, GetElementsName(lazyElement.Value)));
+            return new ValueTask<SeleniumElement>(new SeleniumElement(element, GetElementsName()));
         }
 
-        string GetElementsName(IHasName element) => elementsName ?? $"{locatorBasedMatcher?.Name} within {element.Name}";
+        string GetElementsName() => elementsName != null ? elementsName : (locatorBasedMatcher?.Name ?? "HTML elements");
 
         Lazy<IHasSearchContext> GetLazyElement(ICanPerform actor)
         {
diff --git a/CSF.Screenplay.Selenium/Questions/FindElements.cs b/CSF.Screenplay.Selenium/Questions/FindElements.cs
@@ -2,7 +2,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using CSF.Screenplay.Selenium.Elements;
-using OpenQA.Selenium;
 
 namespace CSF.Screenplay.Selenium.Questions
 {
@@ -65,18 +64,18 @@ public class FindElements : IPerformableWithResult<SeleniumElementCollection>, I
         public ReportFragment GetReportFragment(Actor actor, IFormatsReportFragment formatter)
         {
             lazyElement = lazyElement ?? GetLazyElement(actor);
-            return formatter.Format("{Actor} finds {ElementsName} from {Element}", actor, GetElementsName(lazyElement.Value) ?? "HTML elements", lazyElement.Value);
+            return formatter.Format("{Actor} finds {ElementsName} within {Element}", actor, GetElementsName(), lazyElement);
         }
 
         /// <inheritdoc/>
         public ValueTask<SeleniumElementCollection> PerformAsAsync(ICanPerform actor, CancellationToken cancellationToken = default)
         {
             lazyElement = lazyElement ?? GetLazyElement(actor);
             var elements = lazyElement.Value.SearchContext.FindElements(locatorBasedMatcher ?? CssSelector.AnyElement);
-            return new ValueTask<SeleniumElementCollection>(new SeleniumElementCollection(elements, GetElementsName(lazyElement.Value)));
+            return new ValueTask<SeleniumElementCollection>(new SeleniumElementCollection(elements, GetElementsName()));
         }
 
-        string GetElementsName(IHasName element) => elementsName ?? $"{locatorBasedMatcher?.Name} within {element.Name}";
+        string GetElementsName() => elementsName != null ? elementsName : (locatorBasedMatcher?.Name ?? "HTML elements");
 
         Lazy<IHasSearchContext> GetLazyElement(ICanPerform actor)
         {
diff --git a/CSF.Screenplay.Selenium/Questions/GetShadowRootNatively.cs b/CSF.Screenplay.Selenium/Questions/GetShadowRootNatively.cs
@@ -32,7 +32,7 @@ public class GetShadowRootNatively : ISingleElementPerformableWithResult<Element
     {
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} gets the Shadow Root node from {Element} using the native Selenium technique", actor, element.Value);
+            => formatter.Format("{Actor} gets the Shadow Root node from {Element} using the native Selenium technique", actor, element);
 
         /// <inheritdoc/>
         public string GetHumanReadableTypeName() => GetType().FullName;
diff --git a/CSF.Screenplay.Selenium/Questions/GetShadowRootWithJavaScript.cs b/CSF.Screenplay.Selenium/Questions/GetShadowRootWithJavaScript.cs
@@ -33,7 +33,7 @@ public class GetShadowRootWithJavaScript : ISingleElementPerformableWithResult<E
     {
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} gets the Shadow Root node from {Element} using JavaScript", actor, element.Value);
+            => formatter.Format("{Actor} gets the Shadow Root node from {Element} using JavaScript", actor, element);
 
         /// <inheritdoc/>
         public string GetHumanReadableTypeName() => GetType().FullName;
diff --git a/CSF.Screenplay.Selenium/Questions/SingleElementQuery.cs b/CSF.Screenplay.Selenium/Questions/SingleElementQuery.cs
@@ -49,7 +49,7 @@ public class SingleElementQuery<TResult> : ISingleElementPerformableWithResult<T
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} reads {Query} from {Element}", actor, query, element.Value);
+            => formatter.Format("{Actor} reads {Query} from {Element}", actor, query, element);
 
         /// <inheritdoc/>
         public ValueTask<TResult> PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Resources/MessageResouces.cs b/CSF.Screenplay.Selenium/Resources/MessageResouces.cs
@@ -0,0 +1,18 @@
+using System.Resources;
+
+namespace CSF.Screenplay.Selenium.Resources
+{
+    /// <summary>
+    /// Message strings, stored in the assembly as resources.
+    /// </summary>
+    static class MessageResources
+    {
+        static readonly ResourceManager resourceManager = new ResourceManager(typeof(MessageResources).FullName, typeof(MessageResources).Assembly);
+
+        /// <summary>Gets human-readable message indicating a nonexistent element.</summary>
+        internal static string NonExistentElement =>  resourceManager.GetString("NonExistentElement");
+
+        /// <summary>Gets a human-readable message indicating an unknown HTML element.</summary>
+        internal static string UnknownElement =>  resourceManager.GetString("UnknownElement");
+    }
+}
diff --git a/CSF.Screenplay.Selenium/Resources/MessageResources.restext b/CSF.Screenplay.Selenium/Resources/MessageResources.restext
@@ -0,0 +1,2 @@
+NonExistentElement = a non-existent element
+UnknownElement = an element
diff --git a/CSF.Screenplay.Selenium/ServiceCollectionExtensions.cs b/CSF.Screenplay.Selenium/ServiceCollectionExtensions.cs
@@ -22,10 +22,12 @@ public static IServiceCollection AddSelenium(this IServiceCollection services)
 
             services.AddTransient<Reporting.OptionsFormatter>();
             services.AddTransient<Reporting.ScreenshotFormatter>();
+            services.AddTransient<Elements.LazySeleniumElementFormatter>();
             services.Configure<ScreenplayOptions>(o =>
             {
                 o.ValueFormatters.Add(typeof(Reporting.OptionsFormatter));
                 o.ValueFormatters.Add(typeof(Reporting.ScreenshotFormatter));
+                o.ValueFormatters.Add(typeof(Elements.LazySeleniumElementFormatter));
                 
                 o.PerformanceEventHandlers.Add((eventBus, s) =>
                 {
diff --git a/CSF.Screenplay.Selenium/Tasks/ClickAndWaitForDocumentReady.cs b/CSF.Screenplay.Selenium/Tasks/ClickAndWaitForDocumentReady.cs
@@ -74,7 +74,7 @@ public class ClickAndWaitForDocumentReady : ISingleElementPerformable
 
         /// <inheritdoc/>
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
-            => formatter.Format("{Actor} clicks on {Element} and waits up to {Time} for the next page to load", actor, element.Value, GetTimeout(actor));
+            => formatter.Format("{Actor} clicks on {Element} and waits up to {Time} for the next page to load", actor, element, GetTimeout(actor));
 
         /// <inheritdoc/>
         public async ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
diff --git a/CSF.Screenplay.Selenium/Tasks/SetTheElementValue.cs b/CSF.Screenplay.Selenium/Tasks/SetTheElementValue.cs
@@ -69,8 +69,8 @@ public class SetTheElementValue : Actions.ISingleElementPerformable
         public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
         {
             return simulateInteractiveSet
-                ? formatter.Format("{Actor} uses JavaScript to simulate setting the value of {Element} to {Value} interactively", actor, element.Value, value)
-                : formatter.Format("{Actor} uses JavaScript to set the value of {Element} to {Value}", actor, element.Value, value);
+                ? formatter.Format("{Actor} uses JavaScript to simulate setting the value of {Element} to {Value} interactively", actor, element, value)
+                : formatter.Format("{Actor} uses JavaScript to set the value of {Element} to {Value}", actor, element, value);
         }
 
         /// <inheritdoc/>

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public class ClearTheContents : ISingleElementPerformable`
`46`	`46`	`{`
`47`	`47`	`/// <inheritdoc/>`
`48`	`48`	`public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)`
`49`		`- => formatter.Format("{Actor} clears the contents of {Element}", actor.Name, element.Value);`
	`49`	`+ => formatter.Format("{Actor} clears the contents of {Element}", actor.Name, element);`
`50`	`50`
`51`	`51`	`/// <inheritdoc/>`
`52`	`52`	`public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public class Click : ISingleElementPerformable`
`41`	`41`	`{`
`42`	`42`	`/// <inheritdoc/>`
`43`	`43`	`public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)`
`44`		`- => formatter.Format("{Actor} clicks on {Element}", actor.Name, element.Value);`
	`44`	`+ => formatter.Format("{Actor} clicks on {Element}", actor.Name, element);`
`45`	`45`
`46`	`46`	`/// <inheritdoc/>`
`47`	`47`	`public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public class DeselectAll : ISingleElementPerformable`
`47`	`47`	`{`
`48`	`48`	`/// <inheritdoc/>`
`49`	`49`	`public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)`
`50`		`- => formatter.Format("{Actor} deselects all of the options from {Element}", actor.Name, element.Value);`
	`50`	`+ => formatter.Format("{Actor} deselects all of the options from {Element}", actor.Name, element);`
`51`	`51`
`52`	`52`	`/// <inheritdoc/>`
`53`	`53`	`public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)`