UA-.NETStandard/tests/Opc.Ua.Server.Tests/NodeManager/AsyncNodeManagerDisposalReviewTests.cs

/* ========================================================================
 * Copyright (c) 2005-2026 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Moq;
using NUnit.Framework;

namespace Opc.Ua.Server.Tests.NodeManager
{
    /// <summary>
    /// Verifies asynchronous node-manager cleanup admission, deferred-operation draining, and failure aggregation.
    /// </summary>
    [TestFixture]
    [Category("NodeManager")]
    [Parallelizable(ParallelScope.All)]
    public sealed class AsyncNodeManagerDisposalReviewTests
    {
        /// <summary>
        /// Verifies that subclass cleanup may use guarded members without allowing callers to enter during disposal.
        /// </summary>
        [TestCase(false)]
        [TestCase(true)]
        public async Task DisposeCoreCanUseGuardedMembersWithoutReopeningCallerAdmissionAsync(bool pause)
        {
            Mock<IServerInternal> server = DeterministicServerMock.Create(out MonitoredItemQueueFactory queues);
            using (queues)
            {
                var manager = new CleanupNodeManager(server.Object);
                var entered = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
                var release = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
                manager.Cleanup = async () =>
                {
                    Assert.That(manager.FindCachedNode(), Is.SameAs(manager.CachedNode));
                    entered.SetResult(true);
                    if (pause)
                    {
                        await release.Task.ConfigureAwait(false);
                    }
                    Assert.That(manager.FindCachedNode(), Is.SameAs(manager.CachedNode));
                    using var context = new OperationContext(
                        new RequestHeader(), null, RequestType.Write, RequestLifetime.None);
                    await manager.WriteAsync(context, [], [], CancellationToken.None).ConfigureAwait(false);
                };

                Task disposal = manager.DisposeAsync().AsTask();
                try
                {
                    Task first = await Task.WhenAny(entered.Task, disposal)
                        .WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    if (first == disposal)
                    {
                        await disposal.ConfigureAwait(false);
                    }
                    Assert.That(entered.Task.Status, Is.EqualTo(TaskStatus.RanToCompletion));
                    if (pause)
                    {
                        Assert.That(disposal.IsCompleted, Is.False);
                        Assert.That(() => manager.FindCachedNode(), Throws.TypeOf<ObjectDisposedException>());
                        Task concurrentDisposal = manager.DisposeAsync().AsTask();
                        Assert.That(concurrentDisposal.IsCompleted, Is.False);
                        Assert.That(manager.RetainedNodes, Is.EqualTo(1));
                        Assert.That(manager.OwnedDisposeCalls, Is.Zero);
                        release.SetResult(true);
                        await concurrentDisposal.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    }
                    await disposal.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                }
                finally
                {
                    release.TrySetResult(true);
                    await manager.DisposeAsync().ConfigureAwait(false);
                }

                Assert.That(manager.CleanupCalls, Is.EqualTo(1));
                Assert.That(manager.OwnedDisposeCalls, Is.EqualTo(1));
                Assert.That(manager.RetainedNodes, Is.Zero);
                Assert.That(() => manager.FindCachedNode(), Throws.TypeOf<ObjectDisposedException>());
            }
        }

        /// <summary>
        /// Verifies that synchronous owned cleanup can join a worker that must observe closed admission to finish.
        /// </summary>
        [Test]
        public async Task SynchronousOwnedCleanupLetsSamplingWorkerReachClosedAdmissionAsync()
        {
            Mock<IServerInternal> server = DeterministicServerMock.Create(out MonitoredItemQueueFactory queues);
            using (queues)
            using (var workerFinished = new ManualResetEventSlim())
            {
                var manager = new CleanupNodeManager(server.Object);
                var workerReady = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
                var resumeWorker = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
                bool workerFinishedDuringCleanup = false;
                manager.OwnedCleanup = () =>
                {
                    resumeWorker.SetResult(true);
                    // Model a sampling group joining its worker while disposing synchronously.
                    workerFinishedDuringCleanup = workerFinished.Wait(TimeSpan.FromSeconds(5));
                };
                Task worker = Task.Run(async () =>
                {
                    workerReady.SetResult(true);
                    await resumeWorker.Task.ConfigureAwait(false);
                    try
                    {
                        Assert.That(() => manager.FindCachedNode(), Throws.TypeOf<ObjectDisposedException>());
                    }
                    finally
                    {
                        workerFinished.Set();
                    }
                });

                try
                {
                    await workerReady.Task.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    manager.Dispose();
                    await worker.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    await manager.DisposeAsync().ConfigureAwait(false);

                    Assert.That(workerFinishedDuringCleanup, Is.True,
                        "Owned cleanup must not hold the admission lock while joining a sampling worker.");
                    Assert.That(manager.CleanupCalls, Is.EqualTo(1));
                    Assert.That(manager.OwnedDisposeCalls, Is.EqualTo(1));
                    Assert.That(manager.RetainedNodes, Is.Zero);
                }
                finally
                {
                    resumeWorker.TrySetResult(true);
                    await worker.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    await manager.DisposeAsync().ConfigureAwait(false);
                }
            }
        }

        /// <summary>
        /// Verifies that disposal waits for a deferred write callback even after its serialization semaphore is
        /// released.
        /// </summary>
        [Test]
        public async Task DisposalWaitsForWriteAfterItsSemaphoreIsReleasedAsync()
        {
            Mock<IServerInternal> server = DeterministicServerMock.Create(out MonitoredItemQueueFactory queues);
            using (queues)
            {
                var manager = new CleanupNodeManager(server.Object);
                using var context = new OperationContext(
                    new RequestHeader(), null, RequestType.Write, RequestLifetime.None);
                var entered = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
                var release = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
                manager.DeferredWrite = async () =>
                {
                    entered.SetResult(true);
                    await release.Task.ConfigureAwait(false);
                };
                ServiceResult[] errors = [ServiceResult.Good];
                Task write = manager.WriteAsync(context,
                    [new WriteValue { NodeId = manager.CachedNode.NodeId, AttributeId = Attributes.Value }],
                    errors, CancellationToken.None).AsTask();

                try
                {
                    await entered.Task.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    await manager.WriteAsync(context, [], [], CancellationToken.None).AsTask()
                        .WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    Task disposal = manager.DisposeAsync().AsTask();

                    Assert.That(write.IsCompleted, Is.False);
                    Assert.That(disposal.IsCompleted, Is.False,
                        "Admission lasts through deferred callbacks, not just semaphore ownership.");
                    Assert.That(manager.RetainedNodes, Is.EqualTo(1));
                    Assert.That(manager.OwnedDisposeCalls, Is.Zero);
                    release.SetResult(true);
                    await write.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    await disposal.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                }
                finally
                {
                    release.TrySetResult(true);
                    await write.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
                    await manager.DisposeAsync().ConfigureAwait(false);
                }

                Assert.That(errors[0].StatusCode, Is.EqualTo(StatusCodes.Good));
                Assert.That(manager.OwnedDisposeCalls, Is.EqualTo(1));
                Assert.That(manager.RetainedNodes, Is.Zero);
            }
        }

        /// <summary>
        /// Verifies that capturing a cleanup execution context cannot extend its admission privilege beyond the
        /// callback.
        /// </summary>
        [Test]
        public async Task CapturedCleanupContextCannotAdmitWorkAfterTheCallbackReturnsAsync()
        {
            Mock<IServerInternal> server = DeterministicServerMock.Create(out MonitoredItemQueueFactory queues);
            using (queues)
            {
                var manager = new CleanupNodeManager(server.Object);
                ExecutionContext? captured = null;
                manager.Cleanup = () =>
                {
                    Assert.That(manager.FindCachedNode(), Is.SameAs(manager.CachedNode));
                    captured = ExecutionContext.Capture()!;
                    return default;
                };
                manager.OwnedCleanup = () =>
                {
                    Assert.That(captured, Is.Not.Null);
                    using (captured)
                    {
                        ExecutionContext.Run(captured, _ =>
                            Assert.That(() => manager.FindCachedNode(), Throws.TypeOf<ObjectDisposedException>()), null);
                    }
                };

                await manager.DisposeAsync().ConfigureAwait(false);

                Assert.That(manager.CleanupCalls, Is.EqualTo(1));
                Assert.That(manager.OwnedDisposeCalls, Is.EqualTo(1));
            }
        }

        /// <summary>
        /// Verifies that cleanup failures are aggregated after releasing owned resources and replayed on repeated
        /// disposal.
        /// </summary>
        [Test]
        public void CleanupFailuresAreReportedAfterOwnedResourcesAreReleased()
        {
            Mock<IServerInternal> server = DeterministicServerMock.Create(out MonitoredItemQueueFactory queues);
            using (queues)
            {
                var coreFailure = new InvalidOperationException("subclass cleanup failed");
                var ownedFailure = new InvalidOperationException("owned cleanup failed");
                var manager = new CleanupNodeManager(server.Object)
                {
                    Cleanup = () => throw coreFailure,
                    OwnedCleanup = () => throw ownedFailure
                };

                AggregateException failure = Assert.ThrowsAsync<AggregateException>(
                    async () => await manager.DisposeAsync().ConfigureAwait(false));
                Assert.That(failure.InnerExceptions, Is.EqualTo(new[] { coreFailure, ownedFailure }));
                AggregateException repeated = Assert.ThrowsAsync<AggregateException>(
                    async () => await manager.DisposeAsync().ConfigureAwait(false));

                Assert.That(repeated, Is.SameAs(failure));
                Assert.That(manager.CleanupCalls, Is.EqualTo(1));
                Assert.That(manager.OwnedDisposeCalls, Is.EqualTo(1));
                Assert.That(manager.RetainedNodes, Is.Zero);
                Assert.That(() => manager.FindCachedNode(), Throws.TypeOf<ObjectDisposedException>());
            }
        }

        /// <summary>
        /// Exposes cached state with configurable subclass cleanup, owned-resource cleanup, and deferred writes.
        /// </summary>
        private sealed class CleanupNodeManager : AsyncCustomNodeManager
        {
            /// <summary>
            /// Registers a cached variable and wraps monitored-item cleanup to observe ownership release.
            /// </summary>
            public CleanupNodeManager(IServerInternal server)
                : base(server, "urn:disposal-review")
            {
                CachedNode = new BaseDataVariableState(null)
                {
                    NodeId = new NodeId("cached", NamespaceIndexes[0]),
                    BrowseName = new QualifiedName("Cached", NamespaceIndexes[0]),
                    Value = new Variant(1)
                };
                PredefinedNodes[CachedNode.NodeId] = CachedNode;
                m_handle = new NodeHandle { NodeId = CachedNode.NodeId };
                AddNodeToComponentCache(SystemContext, m_handle, CachedNode);

                IMonitoredItemManager ownedManager = m_monitoredItemManager;
                var monitoredItems = new Mock<IMonitoredItemManager>();
                monitoredItems.Setup(value => value.Dispose()).Callback(() =>
                {
                    OwnedDisposeCalls++;
                    ownedManager.Dispose();
                    OwnedCleanup?.Invoke();
                });
                m_monitoredItemManager = monitoredItems.Object;
            }

            /// <summary>
            /// Gets or sets the asynchronous callback executed during subclass cleanup.
            /// </summary>
            public Func<ValueTask> Cleanup { get; set; } = null!;

            /// <summary>
            /// Gets or sets the deferred write callback whose admission must outlive semaphore ownership.
            /// </summary>
            public Func<ValueTask> DeferredWrite { get; set; } = null!;

            /// <summary>
            /// Gets or sets the callback executed after the owned monitored-item manager is disposed.
            /// </summary>
            public Action OwnedCleanup { get; set; } = null!;

            /// <summary>
            /// Gets the variable retained in the predefined-node and component caches until cleanup completes.
            /// </summary>
            public NodeState CachedNode { get; }

            /// <summary>
            /// Gets the number of subclass cleanup invocations.
            /// </summary>
            public int CleanupCalls { get; private set; }

            /// <summary>
            /// Gets the number of owned monitored-item manager disposal invocations.
            /// </summary>
            public int OwnedDisposeCalls { get; private set; }

            /// <summary>
            /// Gets the number of predefined nodes still retained during disposal.
            /// </summary>
            public int RetainedNodes => PredefinedNodes.Count;

            /// <summary>
            /// Looks up the cached variable through a member guarded by operation admission.
            /// </summary>
            public NodeState FindCachedNode()
            {
                return LookupNodeInComponentCache(SystemContext, m_handle)!;
            }

            /// <summary>
            /// Runs and counts the configured subclass cleanup before delegating to base cleanup.
            /// </summary>
            protected override async ValueTask DisposeAsyncCore()
            {
                CleanupCalls++;
                if (Cleanup != null)
                {
                    await Cleanup().ConfigureAwait(false);
                }
                await base.DisposeAsyncCore().ConfigureAwait(false);
            }

            /// <summary>
            /// Returns an unresolved handle so writes reach the deferred validation callback.
            /// </summary>
            protected override ValueTask<NodeHandle> GetManagerHandleAsync(
                ServerSystemContext context,
                NodeId nodeId,
                IDictionary<NodeId, NodeState> cache,
                CancellationToken cancellationToken = default)
            {
                return new ValueTask<NodeHandle>(new NodeHandle { NodeId = nodeId });
            }

            /// <summary>
            /// Waits for the controlled deferred write and marks every deferred item successful.
            /// </summary>
            protected override async ValueTask WriteAsync(
                ServerSystemContext context,
                ArrayOf<WriteValue> nodesToWrite,
                IList<ServiceResult> errors,
                List<NodeHandle> nodesToValidate,
                IDictionary<NodeId, NodeState> cache,
                CancellationToken cancellationToken = default)
            {
                await DeferredWrite().ConfigureAwait(false);
                foreach (NodeHandle handle in nodesToValidate)
                {
                    errors[handle.Index] = ServiceResult.Good;
                }
            }

            /// <summary>
            /// Identifies the cached node used to probe guarded access during cleanup.
            /// </summary>
            private readonly NodeHandle m_handle;
        }
    }
}