microsoft--agent-framework/dotnet/tests/Microsoft.Agents.AI.Hosting.UnitTests/DelegatingAgentSessionStoreTests.cs

// Copyright (c) Microsoft. All rights reserved.

using System;
using System.Threading;
using System.Threading.Tasks;
using Moq;

namespace Microsoft.Agents.AI.Hosting.UnitTests;

/// <summary>
/// Unit tests for the <see cref="DelegatingAgentSessionStore"/> class.
/// </summary>
public class DelegatingAgentSessionStoreTests
{
    private readonly Mock<AgentSessionStore> _innerStoreMock;
    private readonly Mock<AIAgent> _agentMock;
    private readonly TestDelegatingAgentSessionStore _delegatingStore;
    private readonly AgentSession _testSession;

    /// <summary>
    /// Initializes a new instance of the <see cref="DelegatingAgentSessionStoreTests"/> class.
    /// </summary>
    public DelegatingAgentSessionStoreTests()
    {
        this._innerStoreMock = new Mock<AgentSessionStore>();
        this._agentMock = new Mock<AIAgent>();
        this._testSession = new TestAgentSession();

        // Setup inner store mock
        this._innerStoreMock
            .Setup(x => x.GetSessionAsync(It.IsAny<AIAgent>(), It.IsAny<string>(), It.IsAny<CancellationToken>()))
            .ReturnsAsync(this._testSession);

        this._innerStoreMock
            .Setup(x => x.SaveSessionAsync(It.IsAny<AIAgent>(), It.IsAny<string>(), It.IsAny<AgentSession>(), It.IsAny<CancellationToken>()))
            .Returns(ValueTask.CompletedTask);

        this._delegatingStore = new TestDelegatingAgentSessionStore(this._innerStoreMock.Object);
    }

    #region Constructor Tests

    /// <summary>
    /// Verify that constructor throws ArgumentNullException when innerStore is null.
    /// </summary>
    [Fact]
    public void RequiresInnerStore() =>
        // Act & Assert
        Assert.Throws<ArgumentNullException>("innerStore", () => new TestDelegatingAgentSessionStore(null!));

    /// <summary>
    /// Verify that constructor sets the inner store correctly.
    /// </summary>
    [Fact]
    public void Constructor_WithValidInnerStore_SetsInnerStore()
    {
        // Act
        var delegatingStore = new TestDelegatingAgentSessionStore(this._innerStoreMock.Object);

        // Assert
        Assert.Same(this._innerStoreMock.Object, delegatingStore.InnerStore);
    }

    #endregion

    #region Method Delegation Tests

    /// <summary>
    /// Verify that GetSessionAsync delegates to inner store with correct parameters.
    /// </summary>
    [Fact]
    public async Task GetSessionAsyncDelegatesToInnerStoreAsync()
    {
        // Arrange
        const string ExpectedConversationId = "test-conversation-id";
        var expectedCancellationToken = new CancellationToken();

        this._innerStoreMock
            .Setup(x => x.GetSessionAsync(
                It.Is<AIAgent>(a => a == this._agentMock.Object),
                It.Is<string>(c => c == ExpectedConversationId),
                It.Is<CancellationToken>(ct => ct == expectedCancellationToken)))
            .ReturnsAsync(this._testSession);

        // Act
        var session = await this._delegatingStore.GetSessionAsync(
            this._agentMock.Object,
            ExpectedConversationId,
            expectedCancellationToken);

        // Assert
        Assert.Same(this._testSession, session);
        this._innerStoreMock.Verify(
            x => x.GetSessionAsync(
                this._agentMock.Object,
                ExpectedConversationId,
                expectedCancellationToken),
            Times.Once);
    }

    /// <summary>
    /// Verify that SaveSessionAsync delegates to inner store with correct parameters.
    /// </summary>
    [Fact]
    public async Task SaveSessionAsyncDelegatesToInnerStoreAsync()
    {
        // Arrange
        const string ExpectedConversationId = "test-conversation-id";
        var expectedCancellationToken = new CancellationToken();
        var expectedSession = new TestAgentSession();

        this._innerStoreMock
            .Setup(x => x.SaveSessionAsync(
                It.Is<AIAgent>(a => a == this._agentMock.Object),
                It.Is<string>(c => c == ExpectedConversationId),
                It.Is<AgentSession>(s => s == expectedSession),
                It.Is<CancellationToken>(ct => ct == expectedCancellationToken)))
            .Returns(ValueTask.CompletedTask);

        // Act
        await this._delegatingStore.SaveSessionAsync(
            this._agentMock.Object,
            ExpectedConversationId,
            expectedSession,
            expectedCancellationToken);

        // Assert
        this._innerStoreMock.Verify(
            x => x.SaveSessionAsync(
                this._agentMock.Object,
                ExpectedConversationId,
                expectedSession,
                expectedCancellationToken),
            Times.Once);
    }

    /// <summary>
    /// Verify that GetSessionAsync awaits the inner store's result before returning.
    /// </summary>
    [Fact]
    public async Task GetSessionAsyncAwaitsInnerStoreResultAsync()
    {
        // Arrange
        const string ExpectedConversationId = "test-conversation-id";
        var taskCompletionSource = new TaskCompletionSource<AgentSession>();

        var innerStoreMock = new Mock<AgentSessionStore>();
        innerStoreMock
            .Setup(x => x.GetSessionAsync(It.IsAny<AIAgent>(), It.IsAny<string>(), It.IsAny<CancellationToken>()))
            .Returns(new ValueTask<AgentSession>(taskCompletionSource.Task));

        var delegatingStore = new TestDelegatingAgentSessionStore(innerStoreMock.Object);

        // Act
        var resultTask = delegatingStore.GetSessionAsync(this._agentMock.Object, ExpectedConversationId);

        // Assert
        Assert.False(resultTask.IsCompleted);
        taskCompletionSource.SetResult(this._testSession);
        Assert.True(resultTask.IsCompleted);
        Assert.Same(this._testSession, await resultTask);
    }

    /// <summary>
    /// Verify that SaveSessionAsync awaits the inner store's completion before returning.
    /// </summary>
    [Fact]
    public async Task SaveSessionAsyncAwaitsInnerStoreCompletionAsync()
    {
        // Arrange
        const string ExpectedConversationId = "test-conversation-id";
        var expectedSession = new TestAgentSession();
        var taskCompletionSource = new TaskCompletionSource();

        var innerStoreMock = new Mock<AgentSessionStore>();
        innerStoreMock
            .Setup(x => x.SaveSessionAsync(It.IsAny<AIAgent>(), It.IsAny<string>(), It.IsAny<AgentSession>(), It.IsAny<CancellationToken>()))
            .Returns(new ValueTask(taskCompletionSource.Task));

        var delegatingStore = new TestDelegatingAgentSessionStore(innerStoreMock.Object);

        // Act
        var resultTask = delegatingStore.SaveSessionAsync(this._agentMock.Object, ExpectedConversationId, expectedSession);

        // Assert
        Assert.False(resultTask.IsCompleted);
        taskCompletionSource.SetResult();
        Assert.True(resultTask.IsCompleted);
        await resultTask;
    }

    #endregion

    #region GetService Tests

    /// <summary>
    /// Verify that GetService returns itself when requesting the exact type.
    /// </summary>
    [Fact]
    public void GetServiceReturnsItselfForExactType()
    {
        // Act
        var result = this._delegatingStore.GetService(typeof(TestDelegatingAgentSessionStore));

        // Assert
        Assert.Same(this._delegatingStore, result);
    }

    /// <summary>
    /// Verify that GetService returns itself when requesting a base type.
    /// </summary>
    [Fact]
    public void GetServiceReturnsItselfForBaseType()
    {
        // Act
        var result = this._delegatingStore.GetService(typeof(DelegatingAgentSessionStore));

        // Assert
        Assert.Same(this._delegatingStore, result);
    }

    /// <summary>
    /// Verify that GetService returns itself when requesting AgentSessionStore.
    /// </summary>
    [Fact]
    public void GetServiceReturnsItselfForAgentSessionStoreType()
    {
        // Act
        var result = this._delegatingStore.GetService(typeof(AgentSessionStore));

        // Assert
        Assert.Same(this._delegatingStore, result);
    }

    /// <summary>
    /// Verify that GetService chains to inner store when type is not satisfied by outer store.
    /// </summary>
    [Fact]
    public void GetServiceChainsToInnerStore()
    {
        // Arrange
        var innerStore = new ConcreteAgentSessionStore();
        var delegatingStore = new TestDelegatingAgentSessionStore(innerStore);

        // Act
        var result = delegatingStore.GetService(typeof(ConcreteAgentSessionStore));

        // Assert
        Assert.Same(innerStore, result);
    }

    /// <summary>
    /// Verify that GetService chains through multiple delegation layers.
    /// </summary>
    [Fact]
    public void GetServiceChainsThoughMultipleDelegationLayers()
    {
        // Arrange - create a three-layer chain: outer -> middle -> inner
        var innerStore = new ConcreteAgentSessionStore();
        var middleStore = new AnotherDelegatingAgentSessionStore(innerStore);
        var outerStore = new TestDelegatingAgentSessionStore(middleStore);

        // Act - request the innermost store type
        var result = outerStore.GetService(typeof(ConcreteAgentSessionStore));

        // Assert
        Assert.Same(innerStore, result);
    }

    /// <summary>
    /// Verify that GetService can find a store in the middle of the delegation chain.
    /// </summary>
    [Fact]
    public void GetServiceFindsMiddleStoreInChain()
    {
        // Arrange - create a three-layer chain: outer -> middle -> inner
        var innerStore = new ConcreteAgentSessionStore();
        var middleStore = new AnotherDelegatingAgentSessionStore(innerStore);
        var outerStore = new TestDelegatingAgentSessionStore(middleStore);

        // Act - request the middle store type
        var result = outerStore.GetService(typeof(AnotherDelegatingAgentSessionStore));

        // Assert
        Assert.Same(middleStore, result);
    }

    /// <summary>
    /// Verify that GetService returns null when the requested type is not found in the chain.
    /// </summary>
    [Fact]
    public void GetServiceReturnsNullWhenTypeNotFound()
    {
        // Arrange
        var innerStore = new ConcreteAgentSessionStore();
        var delegatingStore = new TestDelegatingAgentSessionStore(innerStore);

        // Act
        var result = delegatingStore.GetService(typeof(string));

        // Assert
        Assert.Null(result);
    }

    /// <summary>
    /// Verify that GetService returns null when a service key is provided but not matched.
    /// </summary>
    [Fact]
    public void GetServiceReturnsNullWhenServiceKeyProvided()
    {
        // Act
        var result = this._delegatingStore.GetService(typeof(TestDelegatingAgentSessionStore), "some-key");

        // Assert
        Assert.Null(result);
    }

    /// <summary>
    /// Verify that GetService throws ArgumentNullException when serviceType is null.
    /// </summary>
    [Fact]
    public void GetServiceThrowsWhenServiceTypeIsNull() =>
        Assert.Throws<ArgumentNullException>("serviceType", () => this._delegatingStore.GetService(null!));

    /// <summary>
    /// Verify that GetService generic method works correctly.
    /// </summary>
    [Fact]
    public void GetServiceGenericReturnsItself()
    {
        // Act
        var result = this._delegatingStore.GetService<TestDelegatingAgentSessionStore>();

        // Assert
        Assert.Same(this._delegatingStore, result);
    }

    /// <summary>
    /// Verify that GetService generic method chains to inner store.
    /// </summary>
    [Fact]
    public void GetServiceGenericChainsToInnerStore()
    {
        // Arrange
        var innerStore = new ConcreteAgentSessionStore();
        var delegatingStore = new TestDelegatingAgentSessionStore(innerStore);

        // Act
        var result = delegatingStore.GetService<ConcreteAgentSessionStore>();

        // Assert
        Assert.Same(innerStore, result);
    }

    /// <summary>
    /// Verify that GetService generic method returns null when type not found.
    /// </summary>
    [Fact]
    public void GetServiceGenericReturnsNullWhenTypeNotFound()
    {
        // Act
        var result = this._delegatingStore.GetService<string>();

        // Assert
        Assert.Null(result);
    }

    #endregion

    #region Test Implementation

    /// <summary>
    /// Test implementation of DelegatingAgentSessionStore for testing purposes.
    /// </summary>
    private sealed class TestDelegatingAgentSessionStore(AgentSessionStore innerStore) : DelegatingAgentSessionStore(innerStore)
    {
        public new AgentSessionStore InnerStore => base.InnerStore;
    }

    /// <summary>
    /// Another delegating store implementation for testing multi-layer chains.
    /// </summary>
    private sealed class AnotherDelegatingAgentSessionStore(AgentSessionStore innerStore) : DelegatingAgentSessionStore(innerStore);

    /// <summary>
    /// Concrete (non-delegating) session store for testing GetService chaining.
    /// </summary>
    private sealed class ConcreteAgentSessionStore : AgentSessionStore
    {
        public override ValueTask<AgentSession> GetSessionAsync(AIAgent agent, string conversationId, CancellationToken cancellationToken = default)
            => new(new TestAgentSession());

        public override ValueTask SaveSessionAsync(AIAgent agent, string conversationId, AgentSession session, CancellationToken cancellationToken = default)
            => ValueTask.CompletedTask;
    }

    private sealed class TestAgentSession : AgentSession;

    #endregion
}