WIP #309 - Add test coverage and fix some issues

Author: craigfowler

CSF.Screenplay.Selenium/Actions/BeginCollectingLogsWithJavaScript.cs

@@ -22,7 +22,7 @@ namespace CSF.Screenplay.Selenium.Actions
     /// performance (wasted network roundtrips).
     /// </para>
     /// <para>
-    /// This action is for use only with web browsers which have the <see cref="BrowserQuirks.RequiresJavascriptToGetLogs"/> quirk.
+    /// This action is for use only with web browsers which have the <see cref="BrowserQuirks.CanGetLogsWithJavascriptWorkaround"/> quirk.
     /// </para>
     /// </remarks>
     public class BeginCollectingLogsWithJavaScript : IPerformable, ICanReport
@@ -35,7 +35,7 @@ public ReportFragment GetReportFragment(Actor actor, IFormatsReportFragment form
         public async ValueTask PerformAsAsync(ICanPerform actor, CancellationToken cancellationToken = default)
         {
             var driver = actor.GetAbility<BrowseTheWeb>();
-            if(!driver.WebDriver.HasQuirk(BrowserQuirks.RequiresJavascriptToGetLogs))
+            if(!driver.WebDriver.HasQuirk(BrowserQuirks.CanGetLogsWithJavascriptWorkaround))
                 throw new NotSupportedException("The WebDriver must have support for retrieving logs using a Javascript workaround.");
 
             await actor.PerformAsync(PerformableBuilder.ExecuteAScript(Scripts.CaptureLogs), cancellationToken);

CSF.Screenplay.Selenium/Actions/OpenUrl.cs

@@ -56,7 +56,7 @@ public async ValueTask PerformAsAsync(ICanPerform actor, CancellationToken cance
                 throw new InvalidOperationException($"The URL to open must be absolute; have you forgotten to grant {actor} the {nameof(UseABaseUri)} ability?");
             ability.WebDriver.Url = uri.Uri.ToString();
 
-            if(ability.ShouldCollectLogs && ability.WebDriver.HasQuirk(BrowserQuirks.RequiresJavascriptToGetLogs))
+            if(ability.ShouldCollectLogs && ability.WebDriver.HasQuirk(BrowserQuirks.CanGetLogsWithJavascriptWorkaround))
                 await actor.PerformAsync(BeginCollectingLogsWithJavaScript(), cancellationToken);
         }
 

CSF.Screenplay.Selenium/BrowseTheWeb.cs

@@ -99,7 +99,7 @@ public class BrowseTheWeb : ICanReport, IDisposable
         /// <para>
         /// When this value is set to <see langword="true"/>, this will trigger usage of <see cref="Actions.BeginCollectingLogsWithJavaScript"/>
         /// at points where it is required.  This is applicable only when the current <see cref="WebDriver"/> implementation has the
-        /// quirk <see cref="BrowserQuirks.RequiresJavascriptToGetLogs"/>.
+        /// quirk <see cref="BrowserQuirks.CanGetLogsWithJavascriptWorkaround"/>.
         /// </para>
         /// </remarks>
         public bool ShouldCollectLogs => collectLogs;

CSF.Screenplay.Selenium/BrowserQuirks.cs

@@ -113,17 +113,17 @@ public static class BrowserQuirks
         public static readonly string HasNativeLogsSupport = "HasNativeLogsSupport";
 
         /// <summary>
-        /// Gets the name of a browser quirk, for browsers which can read browser logs, but which require a Javascript-based workaround.
+        /// Gets the name of a browser quirk, for browsers which can read browser logs using a Javascript-based workaround.
         /// </summary>
         /// <remarks>
         /// <para>
-        /// Browsers with this quirk cannot read logs in the way that those which <see cref="HasNativeLogsSupport"/> can, however JavaScript
-        /// may be used to intercept logs as they are sent to the console. These may then be stored and retrieved with a different script.
+        /// Browsers with this quirk should prefer using the techniques provided by <see cref="HasNativeLogsSupport"/> if they also support them.
+        /// The use of a Javascript workaround is imperfect and can miss log messages, as described in the documentation for <see cref="GetLogsWithJavaScript"/>.
         /// </para>
         /// </remarks>
         /// <seealso cref="Scripts.CaptureLogs"/>
         /// <seealso cref="Scripts.GetLogs"/>
-        public static readonly string RequiresJavascriptToGetLogs = "RequiresJavascriptToGetLogs";
+        public static readonly string CanGetLogsWithJavascriptWorkaround = "CanGetLogsWithJavascriptWorkaround";
 
         /// <summary>
         /// Gets hard-coded information about known browser quirks.
@@ -198,12 +198,14 @@ public static QuirksData GetQuirksData()
                         }
                     },
                     {
-                        RequiresJavascriptToGetLogs,
+                        CanGetLogsWithJavascriptWorkaround,
                         new BrowserInfoCollection
                         {
                             AffectedBrowsers = new HashSet<BrowserInfo>
                             {
                                 new BrowserInfo { Name = firefox },
+                                new BrowserInfo { Name = chrome },
+                                new BrowserInfo { Name = edge },
                             }
                         }
                     }

CSF.Screenplay.Selenium/Builders/GetTheBrowserLogsBuilder.cs

@@ -1,3 +1,6 @@
+using System.Collections.Generic;
+using CSF.Screenplay.Performables;
+using CSF.Screenplay.Selenium.Questions;
 using CSF.Screenplay.Selenium.Tasks;
 
 namespace CSF.Screenplay.Selenium.Builders
@@ -11,7 +14,7 @@ namespace CSF.Screenplay.Selenium.Builders
     /// collection, should retrieving logs be unsupported by the current WebDriver.
     /// </para>
     /// </remarks>
-    public class GetTheBrowserLogsBuilder
+    public class GetTheBrowserLogsBuilder : IGetsPerformableWithResult<IReadOnlyList<BrowserLog>>
     {
         /// <summary>
         /// Gets a <see cref="GetTheBrowserLogs"/> task.
@@ -22,11 +25,7 @@ public class GetTheBrowserLogsBuilder
         public GetTheBrowserLogs ButReturnEmptyLogsIfUnsupported()
             => new GetTheBrowserLogs(false);
 
-        /// <summary>
-        /// Implicitly converts the builder to an instance of <see cref="GetTheBrowserLogs"/>.
-        /// The task will throw if no viable technique for getting logs is available.
-        /// </summary>
-        public static implicit operator GetTheBrowserLogs(GetTheBrowserLogsBuilder _)
+        IPerformableWithResult<IReadOnlyList<BrowserLog>> IGetsPerformableWithResult<IReadOnlyList<BrowserLog>>.GetPerformable()
             => new GetTheBrowserLogs();
     }
 }

CSF.Screenplay.Selenium/CSF.Screenplay.Selenium.csproj

@@ -32,6 +32,7 @@
 
   <ItemGroup>
     <EmbeddedResource Include="**\*.restext" />
+    <EmbeddedResource Include="Resources\**\*.js" />
   </ItemGroup>
 
 </Project>

CSF.Screenplay.Selenium/PerformableBuilder.general.cs

@@ -216,7 +216,7 @@ public static NamedWaitBuilder WaitUntil(IBuildsElementPredicates predicate)
         /// <para>
         /// It is usually not required to use this action directly.
         /// The recommended way to consume this action is to set <see cref="BrowseTheWeb.ShouldCollectLogs"/> to <see langword="true"/>
-        /// via the ability's constructor. If the WebDriver has the quirk <see cref="BrowserQuirks.RequiresJavascriptToGetLogs"/> then
+        /// via the ability's constructor. If the WebDriver has the quirk <see cref="BrowserQuirks.CanGetLogsWithJavascriptWorkaround"/> then
         /// this action will be executed automatically at appropriate times, such as immediately after <see cref="ClickAndWaitForDocumentReady"/>
         /// or <see cref="OpenUrl"/> is executed.
         /// </para>

CSF.Screenplay.Selenium/Questions/BrowserLog.cs

@@ -36,5 +36,8 @@ public sealed class BrowserLog
         /// Gets the timestamp at which the log message was recorded.
         /// </summary>
         public DateTime Timestamp { get; set; }
+
+        /// <inheritdoc/>
+        public override string ToString() => $"{Timestamp:s} [{Level}]: {Message}";
     }
 }

CSF.Screenplay.Selenium/Questions/GetLogsWithJavaScript.cs

@@ -26,7 +26,13 @@ namespace CSF.Screenplay.Selenium.Questions
     /// not missing any messages.
     /// </para>
     /// <para>
-    /// This action is for use only with web browsers which have the <see cref="BrowserQuirks.RequiresJavascriptToGetLogs"/> quirk.
+    /// This action is for use only with web browsers which have the <see cref="BrowserQuirks.CanGetLogsWithJavascriptWorkaround"/> quirk.
+    /// </para>
+    /// <para>
+    /// Note that this question will not (and cannot) respect the WebDriver's logging preference, such as set at
+    /// <see cref="Extensions.WebDriver.Factories.WebDriverCreationOptions.BrowserLogLevel"/> or
+    /// <see cref="DriverOptions.SetLoggingPreference(string, LogLevel)"/>.
+    /// Consumers will need to manually filter for messages which they care about, based upon the log level.
     /// </para>
     /// </remarks>
     public class GetLogsWithJavaScript : IPerformableWithResult<IReadOnlyList<BrowserLog>>, ICanReport
@@ -39,12 +45,13 @@ public ReportFragment GetReportFragment(Actor actor, IFormatsReportFragment form
         public async ValueTask<IReadOnlyList<BrowserLog>> PerformAsAsync(ICanPerform actor, CancellationToken cancellationToken = default)
         {
             var driver = actor.GetAbility<BrowseTheWeb>();
-            if(!driver.WebDriver.HasQuirk(BrowserQuirks.RequiresJavascriptToGetLogs))
+            if(!driver.WebDriver.HasQuirk(BrowserQuirks.CanGetLogsWithJavascriptWorkaround))
                 throw new NotSupportedException("The WebDriver must have support for retrieving logs using a Javascript workaround.");
 
             var result = await actor.PerformAsync(PerformableBuilder.ExecuteAScript(Scripts.GetLogs), cancellationToken);
             return result
-                .Select(x => new BrowserLog { Level = x["Level"].ToString(), Message = x["Message"].ToString(), Timestamp = (DateTime) x["Timestamp"] })
+                .Cast<IDictionary<string,object>>()
+                .Select(x => new BrowserLog { Level = x["Level"].ToString(), Message = x["Message"].ToString(), Timestamp = DateTime.Parse((string) x["Timestamp"]) })
                 .ToArray();
         }
     }

CSF.Screenplay.Selenium/Resources/GetLogs.js

@@ -4,5 +4,9 @@ return function() {
     const logs = globalThis['__csfScreenplayLogs'].messages.filter(x => !x.Consumed);
     for(const log of logs)
         log.Consumed = true;
-    return logs;
+    return logs.map(x => ({
+        Level: x.Level,
+        Message: x.Message.toString(),
+        Timestamp: x.Timestamp.toISOString()
+    }));
 }();