Merge pull request #230 from egil/bug/119-bubble-events

Bug/119 bubble events

Author: egil

CHANGELOG.md

@@ -2,9 +2,11 @@
 
 All notable changes to **bUnit** will be documented in this file. The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+<!-- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -->
+
 ## [UNRELEASED BETA 11]
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+The following section list all changes in beta-11.
 
 ### Added
 List of new features.
@@ -43,17 +45,17 @@ List of soon-to-be removed features.
 ### Removed
 List of now removed features.
 
+- The async event dispatcher helper methods have been removed (e.g. `ClickAsync()`), as they do not provide any benefit. If you have an event that triggers async operations in the component under test, instead use `cut.WaitForState()` or `cut.WaitForAssertion()` to await the expected state in the component.  
+
 ### Fixed
 List of any bug fixes.
 
 - Using the ComponentParameterCollectionBuilder's `Add(p => p.Param, value)` method to add a unnamed cascading value didn't create an unnnamed cascading value parameter. By [@egil](https://github.com/egil) in [#203](https://github.com/egil/bUnit/pull/203). Credits to [Ben Sampica (@benjaminsampica)](https://github.com/benjaminsampica) for reporting and helping investigate this issue.
-
-### Security
-List of fixed security vulnerabilities.
+- Triggered events now bubble correctly up the DOM tree and triggers other events of the same type. This is a **potentially breaking change,** since this changes the behaviour of event triggering and thus you might see tests start breaking as a result hereof. By [@egil](https://github.com/egil) in [#119](https://github.com/egil/bUnit/issues/119).
 
 ## [1.0.0-beta 10] - 2020-09-15
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+The following section list all changes in beta-10.
 
 ### Added
 List of new features.

src/bunit.web/EventDispatchExtensions/ClipboardEventDispatchExtensions.cs

@@ -23,7 +23,7 @@ public static class ClipboardEventDispatchExtensions
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task BeforeCopyAsync(this IElement element) => element.TriggerEventAsync("onbeforecopy", EventArgs.Empty);
+		private static Task BeforeCopyAsync(this IElement element) => element.TriggerEventAsync("onbeforecopy", EventArgs.Empty);
 
 		/// <summary>
 		/// Raises the <c>@onbeforecut</c> event on <paramref name="element"/>, passing an empty (<see cref="EventArgs.Empty"/>) 
@@ -38,7 +38,7 @@ public static class ClipboardEventDispatchExtensions
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task BeforeCutAsync(this IElement element) => element.TriggerEventAsync("onbeforecut", EventArgs.Empty);
+		private static Task BeforeCutAsync(this IElement element) => element.TriggerEventAsync("onbeforecut", EventArgs.Empty);
 
 		/// <summary>
 		/// Raises the <c>@onbeforepaste</c> event on <paramref name="element"/>, passing an empty (<see cref="EventArgs.Empty"/>) 
@@ -53,7 +53,7 @@ public static class ClipboardEventDispatchExtensions
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task BeforePasteAsync(this IElement element) => element.TriggerEventAsync("onbeforepaste", EventArgs.Empty);
+		private static Task BeforePasteAsync(this IElement element) => element.TriggerEventAsync("onbeforepaste", EventArgs.Empty);
 
 		/// <summary>
 		/// Raises the <c>@oncopy</c> event on <paramref name="element"/>, passing the provided
@@ -78,7 +78,7 @@ public static class ClipboardEventDispatchExtensions
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task CopyAsync(this IElement element, ClipboardEventArgs eventArgs) => element.TriggerEventAsync("oncopy", eventArgs);
+		private static Task CopyAsync(this IElement element, ClipboardEventArgs eventArgs) => element.TriggerEventAsync("oncopy", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@oncut</c> event on <paramref name="element"/>, passing the provided
@@ -103,7 +103,7 @@ public static class ClipboardEventDispatchExtensions
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task CutAsync(this IElement element, ClipboardEventArgs eventArgs) => element.TriggerEventAsync("oncut", eventArgs);
+		private static Task CutAsync(this IElement element, ClipboardEventArgs eventArgs) => element.TriggerEventAsync("oncut", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onpaste</c> event on <paramref name="element"/>, passing the provided
@@ -128,6 +128,6 @@ public static class ClipboardEventDispatchExtensions
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task PasteAsync(this IElement element, ClipboardEventArgs eventArgs) => element.TriggerEventAsync("onpaste", eventArgs);
+		private static Task PasteAsync(this IElement element, ClipboardEventArgs eventArgs) => element.TriggerEventAsync("onpaste", eventArgs);
 	}
 }

src/bunit.web/EventDispatchExtensions/DragEventDispatchExtensions.cs

@@ -56,7 +56,7 @@ public static void Drag(this IElement element, long detail = default, double scr
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task DragAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondrag", eventArgs);
+		private static Task DragAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondrag", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@ondragend</c> event on <paramref name="element"/>, passing the provided
@@ -105,7 +105,7 @@ public static void DragEnd(this IElement element, long detail = default, double
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task DragEndAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragend", eventArgs);
+		private static Task DragEndAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragend", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@ondragenter</c> event on <paramref name="element"/>, passing the provided
@@ -154,7 +154,7 @@ public static void DragEnter(this IElement element, long detail = default, doubl
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task DragEnterAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragenter", eventArgs);
+		private static Task DragEnterAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragenter", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@ondragleave</c> event on <paramref name="element"/>, passing the provided
@@ -203,7 +203,7 @@ public static void DragLeave(this IElement element, long detail = default, doubl
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task DragLeaveAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragleave", eventArgs);
+		private static Task DragLeaveAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragleave", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@ondragover</c> event on <paramref name="element"/>, passing the provided
@@ -252,7 +252,7 @@ public static void DragOver(this IElement element, long detail = default, double
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task DragOverAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragover", eventArgs);
+		private static Task DragOverAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragover", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@ondragstart</c> event on <paramref name="element"/>, passing the provided
@@ -301,7 +301,7 @@ public static void DragStart(this IElement element, long detail = default, doubl
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task DragStartAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragstart", eventArgs);
+		private static Task DragStartAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondragstart", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@ondrop</c> event on <paramref name="element"/>, passing the provided
@@ -350,6 +350,6 @@ public static void Drop(this IElement element, long detail = default, double scr
 		/// <param name="element"></param>
 		/// <param name="eventArgs"></param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task DropAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondrop", eventArgs);
+		private static Task DropAsync(this IElement element, DragEventArgs eventArgs) => element.TriggerEventAsync("ondrop", eventArgs);
 	}
 }

src/bunit.web/EventDispatchExtensions/FocusEventDispatchExtensions.cs

@@ -22,17 +22,17 @@ public static class FocusEventDispatchExtensions
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		public static void Focus(this IElement element, FocusEventArgs eventArgs) => _ = FocusAsync(element, eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onfocus</c> event on <paramref name="element"/>, passing the provided
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task FocusAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onfocus", eventArgs);
+		private static Task FocusAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onfocus", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onblur</c> event on <paramref name="element"/>, passing the provided
@@ -47,17 +47,17 @@ public static class FocusEventDispatchExtensions
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		public static void Blur(this IElement element, FocusEventArgs eventArgs) => _ = BlurAsync(element, eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onblur</c> event on <paramref name="element"/>, passing the provided
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task BlurAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onblur", eventArgs);
+		private static Task BlurAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onblur", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onfocusin</c> event on <paramref name="element"/>, passing the provided
@@ -72,17 +72,17 @@ public static class FocusEventDispatchExtensions
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		public static void FocusIn(this IElement element, FocusEventArgs eventArgs) => _ = FocusInAsync(element, eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onfocusin</c> event on <paramref name="element"/>, passing the provided
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task FocusInAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onfocusin", eventArgs);
+		private static Task FocusInAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onfocusin", eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onfocusout</c> event on <paramref name="element"/>, passing the provided
@@ -97,16 +97,16 @@ public static class FocusEventDispatchExtensions
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		public static void FocusOut(this IElement element, FocusEventArgs eventArgs) => _ = FocusOutAsync(element, eventArgs);
 
 		/// <summary>
 		/// Raises the <c>@onfocusout</c> event on <paramref name="element"/>, passing the provided
 		/// event arguments to the event handler.
 		/// </summary>
 		/// <param name="element">The element to raise the event on.</param>
-		/// <param name="eventArgs">The event arguments to passs the event handler.</param>
+		/// <param name="eventArgs">The event arguments to pass the event handler.</param>
 		/// <returns>A task that completes when the event handler is done.</returns>
-		public static Task FocusOutAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onfocusout", eventArgs);
+		private static Task FocusOutAsync(this IElement element, FocusEventArgs eventArgs) => element.TriggerEventAsync("onfocusout", eventArgs);
 	}
 }