| | | 1 | | //======================================================================= |
| | | 2 | | // LifecycleHookHandler.cs |
| | | 3 | | //======================================================================= |
| | | 4 | | // MIT License, Copyright (c) 2024-present David Oravsky (mrdav30) |
| | | 5 | | // See LICENSE file in the project root for full license information. |
| | | 6 | | //======================================================================= |
| | | 7 | | |
| | | 8 | | using System; |
| | | 9 | | using System.Collections.Generic; |
| | | 10 | | using SwiftCollections; |
| | | 11 | | |
| | | 12 | | namespace Trailblazer.Support; |
| | | 13 | | |
| | | 14 | | /// <summary> |
| | | 15 | | /// Provides functionality to register, unregister, and invoke lifecycle hooks in a thread-safe manner. |
| | | 16 | | /// </summary> |
| | | 17 | | internal sealed class LifecycleHookHandler |
| | | 18 | | { |
| | 989 | 19 | | private readonly object _lifecycleHookLock = new(); |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// Registers a lifecycle hook with the specified owner, order, and callback. |
| | | 23 | | /// Hooks are executed in order of their specified order, and if orders are equal, they are sorted by owner name. |
| | | 24 | | /// The returned IDisposable can be used to unregister the hook when it is no longer needed. |
| | | 25 | | /// </summary> |
| | | 26 | | /// <param name="hooks">The list of hooks to register the new hook with.</param> |
| | | 27 | | /// <param name="owner">The owner of the hook, used to identify and manage the hook.</param> |
| | | 28 | | /// <param name="order">The order in which the hook should be executed relative to other hooks.</param> |
| | | 29 | | /// <param name="callback">The callback to invoke when the hook is executed.</param> |
| | | 30 | | /// <returns>An IDisposable that can be used to unregister the hook.</returns> |
| | | 31 | | /// <exception cref="ArgumentException">Thrown if the owner is null or whitespace.</exception> |
| | | 32 | | /// <exception cref="InvalidOperationException">Thrown if a hook with the same owner is already registered.</excepti |
| | | 33 | | public IDisposable RegisterHook( |
| | | 34 | | SwiftList<OrderedLifecycleHook> hooks, |
| | | 35 | | string owner, |
| | | 36 | | int order, |
| | | 37 | | Action callback) |
| | | 38 | | { |
| | 15 | 39 | | SwiftThrowHelper.ThrowIfArgument( |
| | 15 | 40 | | string.IsNullOrWhiteSpace(owner), |
| | 15 | 41 | | paramName: nameof(owner), |
| | 15 | 42 | | message: "Lifecycle hook owner cannot be null or whitespace."); |
| | | 43 | | |
| | 14 | 44 | | SwiftThrowHelper.ThrowIfNull(callback, nameof(callback)); |
| | | 45 | | |
| | 14 | 46 | | lock (_lifecycleHookLock) |
| | | 47 | | { |
| | 32 | 48 | | for (int i = 0; i < hooks.Count; i++) |
| | | 49 | | { |
| | 3 | 50 | | SwiftThrowHelper.ThrowIfTrue( |
| | 3 | 51 | | hooks[i].Owner == owner, |
| | 3 | 52 | | message: $"Lifecycle hook '{owner}' is already registered."); |
| | | 53 | | } |
| | | 54 | | |
| | 13 | 55 | | hooks.Add(new OrderedLifecycleHook(owner, order, callback)); |
| | 13 | 56 | | hooks.SortInPlace(CompareHook()); |
| | 13 | 57 | | } |
| | | 58 | | |
| | 13 | 59 | | return new LifecycleHookRegistration(() => UnregisterHook(hooks, owner)); |
| | | 60 | | } |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Unregisters a lifecycle hook based on the specified owner. |
| | | 64 | | /// </summary> |
| | | 65 | | /// <param name="hooks">The list of hooks to unregister the hook from.</param> |
| | | 66 | | /// <param name="owner">The owner of the hook to unregister.</param> |
| | | 67 | | public void UnregisterHook(SwiftList<OrderedLifecycleHook> hooks, string owner) |
| | | 68 | | { |
| | 13 | 69 | | lock (_lifecycleHookLock) |
| | | 70 | | { |
| | 13 | 71 | | hooks.RemoveAll(hook => hook.Owner == owner); |
| | 13 | 72 | | } |
| | 13 | 73 | | } |
| | | 74 | | |
| | | 75 | | /// <summary> |
| | | 76 | | /// Invokes all registered lifecycle hooks in the order they were registered. |
| | | 77 | | /// </summary> |
| | | 78 | | /// <param name="hooks">The list of hooks to invoke.</param> |
| | | 79 | | public void InvokeHooks(SwiftList<OrderedLifecycleHook> hooks) |
| | | 80 | | { |
| | | 81 | | OrderedLifecycleHook[] snapshot; |
| | 8 | 82 | | lock (_lifecycleHookLock) |
| | | 83 | | { |
| | 8 | 84 | | snapshot = hooks.ToArray(); |
| | 8 | 85 | | } |
| | | 86 | | |
| | 36 | 87 | | for (int i = 0; i < snapshot.Length; i++) |
| | 10 | 88 | | snapshot[i].Callback(); |
| | 8 | 89 | | } |
| | | 90 | | |
| | | 91 | | private static Comparer<OrderedLifecycleHook> CompareHook() |
| | | 92 | | { |
| | 13 | 93 | | return Comparer<OrderedLifecycleHook>.Create((left, right) => |
| | 13 | 94 | | { |
| | 13 | 95 | | int orderCompare = left.Order.CompareTo(right.Order); |
| | 13 | 96 | | if (orderCompare != 0) |
| | 13 | 97 | | return orderCompare; |
| | 13 | 98 | | |
| | 13 | 99 | | return StringComparer.Ordinal.Compare(left.Owner, right.Owner); |
| | 13 | 100 | | }); |
| | | 101 | | } |
| | | 102 | | } |