Execute in scope with error handling

yapoml · Apr 27, 2024 · 8c69aff · 8c69aff
1 parent a301a82
commit 8c69aff
Show file tree

Hide file tree

Showing 16 changed files with 253 additions and 106 deletions.
diff --git a/Yapoml.Playwright.sln b/Yapoml.Playwright.sln
@@ -9,7 +9,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Yapoml.Playwright.Sample",
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Yapoml.Playwright", "src\Yapoml.Playwright\Yapoml.Playwright.csproj", "{95C372C4-6BC3-4F29-B92E-FF71F1D74369}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Yapoml.Playwright.SourceGeneration", "src\Yapoml.Playwright.SourceGeneration\Yapoml.Playwright.SourceGeneration.csproj", "{8DEAB4F2-8951-4B94-81E5-537CE4E65DE7}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Yapoml.Playwright.SourceGeneration", "src\Yapoml.Playwright.SourceGeneration\Yapoml.Playwright.SourceGeneration.csproj", "{8DEAB4F2-8951-4B94-81E5-537CE4E65DE7}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

diff --git a/sample/Yapoml.Playwright.Sample/Basics/Pages/Base.component.cs b/sample/Yapoml.Playwright.Sample/Basics/Pages/Base.component.cs
@@ -15,10 +15,12 @@ partial class Conditions<TSelf>
         {
             public TSelf IsNotWhite()
             {
-                using (this.Logger.BeginLogScope($"Expect {this.ElementHandler.ComponentMetadata.Name} color is not white"))
+                using var logScope = Logger.BeginLogScope($"Expect {this.ElementHandler.ComponentMetadata.Name} color is not white");
+
+                return logScope.Execute(() =>
                 {
                     return Styles.BackgroundColor.DoesNotContain("255, 255, 255");
-                }
+                });
             }
         }
     }

diff --git a/sample/Yapoml.Playwright.Sample/Home.page.cs b/sample/Yapoml.Playwright.Sample/Home.page.cs
@@ -4,13 +4,15 @@ public partial class HomePage
     {
         public PackagesPage Search(string text)
         {
-            using (_logger.BeginLogScope($"Searching for packages by '{text}' query"))
+            using var scope = _logger.BeginLogScope($"Searching for packages by '{text}' query");
+
+            return scope.Execute(() =>
             {
                 SearchInput.Fill(text);
                 SearchButton.Click();
 
                 return SpaceOptions.Services.Get<YaSpace>().PackagesPage;
-            }
+            });
         }
     }
 }
diff --git a/src/Yapoml.Playwright.SourceGeneration/Templates/NestedComponentTemplate.scriban b/src/Yapoml.Playwright.SourceGeneration/Templates/NestedComponentTemplate.scriban
@@ -249,9 +249,12 @@ public partial class {{$1.singular_name}}ComponentList : global::Yapoml.Playwrig
 	/// </summary>
 	public {{$1.singular_name}}ComponentList Expect(global::System.Action<Conditions> it)
 	{
-		using (_logger.BeginLogScope($"Expect {_elementsListHandler.ComponentsListMetadata.Name} satisfy conditions"))
+		using (var scope = _logger.BeginLogScope($"Expect {_elementsListHandler.ComponentsListMetadata.Name} satisfy conditions"))
 		{
-			it(listConditions);
+			scope.Execute(() =>
+			{
+				it(listConditions);
+			});
 		}
 
 		return this;

diff --git a/src/Yapoml.Playwright.SourceGeneration/Templates/PageConditionsTemplate.scriban b/src/Yapoml.Playwright.SourceGeneration/Templates/PageConditionsTemplate.scriban
@@ -16,11 +16,14 @@ public partial class Conditions : global::Yapoml.Playwright.Components.BasePageC
 	/// </summary>
 	public override Conditions IsOpened(global::System.TimeSpan? timeout = default)
 	{
-		using (Logger.BeginLogScope("Expect the {{$1.name}} page is opened"))
+		using (var scope = Logger.BeginLogScope("Expect the {{$1.name}} page is opened"))
 		{
-			Url.Contains("{{ $1.url.path }}", timeout);
+			return scope.Execute(() =>
+			{
+				Url.Contains("{{ $1.url.path }}", timeout);
 
-			return base.IsOpened(timeout);
+				return base.IsOpened(timeout);
+			});
 		}
 	}
 	{{ end }}

diff --git a/src/Yapoml.Playwright.SourceGeneration/Templates/PageOneTimeConditionsTemplate.scriban b/src/Yapoml.Playwright.SourceGeneration/Templates/PageOneTimeConditionsTemplate.scriban
@@ -16,11 +16,14 @@ public class OneTimeConditions : global::Yapoml.Playwright.Components.BasePageCo
 	/// </summary>
 	public override {{get_page_class_name $1}} IsOpened(global::System.TimeSpan? timeout = default)
 	{
-		using (Logger.BeginLogScope("Expect the {{$1.name}} page is opened"))
+		using (var scope = Logger.BeginLogScope("Expect the {{$1.name}} page is opened"))
 		{
-			Url.Contains("{{ $1.url.path }}", timeout);
+			return scope.Execute(() =>
+			{
+				Url.Contains("{{ $1.url.path }}", timeout);
 
-			return base.IsOpened(timeout);
+				return base.IsOpened(timeout);
+			});
 		}
 	}
 	{{ end }}

diff --git a/src/Yapoml.Playwright.SourceGeneration/Templates/PageTemplate.scriban b/src/Yapoml.Playwright.SourceGeneration/Templates/PageTemplate.scriban
@@ -35,10 +35,14 @@ namespace {{namespace}}
 
 			EventSource.PageEventSource.RaiseOnPageNavigating(this, url, Metadata);
 
-			using (_logger.BeginLogScope($"Opening {Metadata.Name} page by {url}"))
+			using (var scope = _logger.BeginLogScope($"Opening {Metadata.Name} page by {url}"))
 			{
-				Driver.GotoAsync(url.ToString()).GetAwaiter().GetResult();
+				scope.Execute(async () =>
+				{
+					await Driver.GotoAsync(url.ToString());
+				});
 			}
+
 			return this;
 		}
 		{{ end }}

diff --git a/src/Yapoml.Playwright.SourceGeneration/Yapoml.Playwright.SourceGeneration.csproj b/src/Yapoml.Playwright.SourceGeneration/Yapoml.Playwright.SourceGeneration.csproj
@@ -16,7 +16,7 @@
     <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.3" PrivateAssets="all" />
     <PackageReference Include="Scriban" Version="5.9.0" GeneratePathProperty="true" PrivateAssets="all" />
     <PackageReference Include="YamlDotNet" Version="13.4.0" GeneratePathProperty="true" PrivateAssets="all" />
-    <PackageReference Include="Yapoml.Framework.Workspace" Version="0.13.1" GeneratePathProperty="true" PrivateAssets="all" />
+    <PackageReference Include="Yapoml.Framework.Workspace" Version="0.14.1" GeneratePathProperty="true" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/Yapoml.Playwright/Components/BaseComponent.Actions.cs b/src/Yapoml.Playwright/Components/BaseComponent.Actions.cs
@@ -15,9 +15,12 @@ partial class BaseComponent<TComponent, TConditions, TCondition>
         /// <returns>The same instance of the component to continue interaction with it.</returns>
         public virtual TComponent Clear()
         {
-            using (_logger.BeginLogScope($"Clearing {Metadata.Name}"))
+            using (var scope = _logger.BeginLogScope($"Clearing {Metadata.Name}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.ClearAsync().GetAwaiter().GetResult());
+                scope.Execute(() =>
+                {
+                    RelocateOnStaleReference(() => WrappedElement.ClearAsync().GetAwaiter().GetResult());
+                });
             }
 
             return component;
@@ -54,9 +57,12 @@ public virtual TComponent Type(string text)
                 scopeName = $"Typing '{text}' into {Metadata.Name}";
             }
 
-            using (_logger.BeginLogScope(scopeName))
+            using (var scope = _logger.BeginLogScope(scopeName))
             {
-                RelocateOnStaleReference(() => WrappedElement.TypeAsync(text).GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.TypeAsync(text));
+                });
             }
 
             return component;
@@ -78,9 +84,12 @@ public virtual TComponent Type(string text, Action<TConditions> when)
         /// <returns>The same instance of the component to continue interaction with it.</returns>
         public virtual TComponent Fill(string text)
         {
-            using (_logger.BeginLogScope($"Filling in {component.Metadata.Name} within '{text}'"))
+            using (var scope = _logger.BeginLogScope($"Filling in {component.Metadata.Name} within '{text}'"))
             {
-                RelocateOnStaleReference(() => WrappedElement.FillAsync(text).GetAwaiter().GetResult());
+                scope.Execute(() =>
+                {
+                    RelocateOnStaleReference(() => WrappedElement.FillAsync(text).GetAwaiter().GetResult());
+                });
             }
 
             return component;
@@ -102,9 +111,12 @@ public virtual TComponent Fill(string text, Action<TConditions> when)
         /// <returns>The same instance of the component to continue interaction with it.</returns>
         public virtual TComponent Click()
         {
-            using (_logger.BeginLogScope($"Clicking on {Metadata.Name}"))
+            using (var scope = _logger.BeginLogScope($"Clicking on {Metadata.Name}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.ClickAsync().GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.ClickAsync());
+                });
             }
 
             return component;
@@ -124,9 +136,12 @@ public virtual TComponent Click(Action<TConditions> when)
         /// <param name="y">Coordinates offset by Y-axis.</param>
         public virtual TComponent Click(int x, int y)
         {
-            using (_logger.BeginLogScope($"Clicking on {Metadata.Name} by X: {x}, Y: {y}"))
+            using (var scope = _logger.BeginLogScope($"Clicking on {Metadata.Name} by X: {x}, Y: {y}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.ClickAsync(new Microsoft.Playwright.LocatorClickOptions { Position = new Microsoft.Playwright.Position { X = x, Y = y } }).GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.ClickAsync(new Microsoft.Playwright.LocatorClickOptions { Position = new Microsoft.Playwright.Position { X = x, Y = y } }));
+                });
             }
 
             return component;
@@ -151,9 +166,12 @@ public virtual TComponent Click(int x, int y, Action<TConditions> when)
         /// <returns>The same instance of the component to continue interaction with it.</returns>
         public virtual TComponent Hover()
         {
-            using (_logger.BeginLogScope($"Hovering over {Metadata.Name}"))
+            using (var scope = _logger.BeginLogScope($"Hovering over {Metadata.Name}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.HoverAsync().GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.HoverAsync());
+                });
             }
 
             return component;
@@ -173,10 +191,13 @@ public virtual TComponent Hover(Action<TConditions> when)
         /// <param name="y">Coordinates offset by Y-axis.</param>
         public virtual TComponent Hover(int x, int y)
         {
-            using (_logger.BeginLogScope($"Hovering on {Metadata.Name} by X: {x}, Y: {y}"))
+            using (var scope = _logger.BeginLogScope($"Hovering on {Metadata.Name} by X: {x}, Y: {y}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.HoverAsync(new Microsoft.Playwright.LocatorHoverOptions { Position = new Microsoft.Playwright.Position { X = x, Y = y } }).GetAwaiter().GetResult());
-            }
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.HoverAsync(new Microsoft.Playwright.LocatorHoverOptions { Position = new Microsoft.Playwright.Position { X = x, Y = y } }));
+                });
+            };
 
             return component;
         }
@@ -206,9 +227,12 @@ public virtual TComponent ScrollIntoView()
             }
             else
             {
-                using (_logger.BeginLogScope($"Scrolling {Metadata.Name} into view"))
+                using (var scope = _logger.BeginLogScope($"Scrolling {Metadata.Name} into view"))
                 {
-                    RelocateOnStaleReference(() => WrappedElement.ScrollIntoViewIfNeededAsync().GetAwaiter().GetResult());
+                    scope.Execute(async () =>
+                    {
+                        await RelocateOnStaleReference(async () => await WrappedElement.ScrollIntoViewIfNeededAsync());
+                    });
                 }
             }
 
@@ -239,9 +263,12 @@ public virtual TComponent ScrollIntoView(ScrollIntoViewOptions options)
         {
             if (options == null) throw new ArgumentNullException(nameof(options));
 
-            using (_logger.BeginLogScope($"Scrolling {Metadata.Name} into view with options {options}"))
+            using (var scope = _logger.BeginLogScope($"Scrolling {Metadata.Name} into view with options {options}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.ScrollIntoViewIfNeededAsync().GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.ScrollIntoViewIfNeededAsync());
+                });
             }
 
             return component;
@@ -272,9 +299,12 @@ public virtual TComponent Focus()
             }
             else
             {
-                using (_logger.BeginLogScope($"Focusing {Metadata.Name}"))
+                using (var scope = _logger.BeginLogScope($"Focusing {Metadata.Name}"))
                 {
-                    RelocateOnStaleReference(() => WrappedElement.FocusAsync().GetAwaiter().GetResult());
+                    scope.Execute(async () =>
+                    {
+                        await RelocateOnStaleReference(async () => await WrappedElement.FocusAsync());
+                    });
                 }
             }
 
@@ -303,9 +333,12 @@ public virtual TComponent Focus(FocusOptions options)
         {
             if (options == null) throw new ArgumentNullException(nameof(options));
 
-            using (_logger.BeginLogScope($"Focusing {Metadata.Name} with options {options}"))
+            using (var scope = _logger.BeginLogScope($"Focusing {Metadata.Name} with options {options}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.FocusAsync());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.FocusAsync());
+                });
             }
 
             return component;
@@ -330,9 +363,12 @@ public virtual TComponent Focus(FocusOptions options, Action<TConditions> when)
         /// <returns>The same instance of the component to continue interaction with it.</returns>
         public virtual TComponent Blur()
         {
-            using (_logger.BeginLogScope($"Bluring {Metadata.Name}"))
+            using (var scope = _logger.BeginLogScope($"Bluring {Metadata.Name}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.BlurAsync().GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.BlurAsync());
+                });
             }
 
             return component;
@@ -354,9 +390,12 @@ public virtual TComponent Blur(Action<TConditions> when)
         /// <returns>The same instance of the component to continue interaction with it.</returns>
         public virtual TComponent ContextClick()
         {
-            using (_logger.BeginLogScope($"Context clicking on {Metadata.Name}"))
+            using (var scope = _logger.BeginLogScope($"Context clicking on {Metadata.Name}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.ClickAsync(new Microsoft.Playwright.LocatorClickOptions { Button = Microsoft.Playwright.MouseButton.Right }).GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.ClickAsync(new Microsoft.Playwright.LocatorClickOptions { Button = Microsoft.Playwright.MouseButton.Right }));
+                });
             }
 
             return component;
@@ -378,12 +417,15 @@ public virtual TComponent ContextClick(Action<TConditions> when)
         /// <returns>The same instance of the component to continue interaction with it.</returns>
         public virtual TComponent DoubleClick()
         {
-            using (_logger.BeginLogScope($"Double clicking on {Metadata.Name}"))
+            using (var scope = _logger.BeginLogScope($"Double clicking on {Metadata.Name}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.DblClickAsync().GetAwaiter().GetResult());
-            }
+                scope.Execute(async () =>
+                {
+                    await RelocateOnStaleReference(async () => await WrappedElement.DblClickAsync());
+                });
 
-            return component;
+                return component;
+            }
         }
 
         /// <inheritdoc cref="DoubleClick()"/>
@@ -403,9 +445,12 @@ public virtual TComponent DragAndDrop<TToComponent, TToConditions, TToCondition>
             where TToConditions : BaseComponentConditions<TToConditions>
             where TToCondition : BaseComponentConditions<TToComponent>
         {
-            using (_logger.BeginLogScope($"Dragging {Metadata.Name} to {toComponent.Metadata.Name}"))
+            using (var scope = _logger.BeginLogScope($"Dragging {Metadata.Name} to {toComponent.Metadata.Name}"))
             {
-                RelocateOnStaleReference(() => WrappedElement.DragToAsync(toComponent.WrappedElement).GetAwaiter().GetResult());
+                scope.Execute(async () =>
+                {
+                    RelocateOnStaleReference(async () => await WrappedElement.DragToAsync(toComponent.WrappedElement));
+                });
             }
 
             return component;

diff --git a/src/Yapoml.Playwright/Components/BaseComponent.cs b/src/Yapoml.Playwright/Components/BaseComponent.cs
@@ -6,6 +6,7 @@
 using Yapoml.Playwright.Components.Metadata;
 using Yapoml.Playwright.Options;
 using Microsoft.Playwright;
+using System.Threading.Tasks;
 
 namespace Yapoml.Playwright.Components
 {