acdream/tests/AcDream.App.Tests/UI/ChatTranscriptLogWriterTests.cs

using System;
using System.IO;
using AcDream.App.UI;
using AcDream.Core.Chat;

namespace AcDream.App.Tests.UI;

/// <summary>
/// CT-B4: what actually reaches the <c>@log</c> file.
/// </summary>
public sealed class ChatTranscriptLogWriterTests : IDisposable
{
    private readonly string _directory =
        Path.Combine(Path.GetTempPath(), "acdream-logwriter-" + Guid.NewGuid().ToString("N"));

    public void Dispose()
    {
        try { Directory.Delete(_directory, recursive: true); }
        catch (IOException) { /* nothing left to say */ }
    }

    private string Read() => File.ReadAllText(Path.Combine(_directory, "session.txt"));

    [Fact]
    public void TheComposedDisplayLineIsLoggedRatherThanTheRawMessage()
    {
        // The entry's own Text is just 'hello' — the speaker and the quotes
        // are composition. Retail's log write sits downstream of that
        // (fprintf inside AddTextToScroll), so logging entry.Text would give
        // a file full of bare fragments with no idea who said them.
        using var log = new ChatSessionLog(_directory);
        var transcript = new ChatLog();
        var writer = new ChatTranscriptLogWriter(log);

        log.Open("session", out _);
        writer.Attach(transcript);
        transcript.OnLocalSpeech("Dww", "hello", 0x02u, false, 0u);
        log.Close();

        Assert.Equal("Dww says, \"hello\"\n", Read());
    }

    [Fact]
    public void TheTimestampFollowsTheSameOptionTheWindowUses()
    {
        // Retail computes the stamp ONCE and hands the same string to the
        // window and to the file, so the two can never disagree.
        using var log = new ChatSessionLog(_directory);
        bool stamps = false;
        var transcript = new ChatLog { DisplayTimestampsSource = () => stamps };
        var writer = new ChatTranscriptLogWriter(log);

        log.Open("session", out _);
        writer.Attach(transcript);
        transcript.OnLocalSpeech("Dww", "before", 0x02u, false, 0u);
        stamps = true;
        transcript.OnLocalSpeech("Dww", "after", 0x02u, false, 0u);
        log.Close();

        string[] lines = Read().Split('\n', StringSplitOptions.RemoveEmptyEntries);
        Assert.Equal("Dww says, \"before\"", lines[0]);
        Assert.Matches(@"^\d{1,2}:\d{2}:\d{2} Dww says, ""after""$", lines[1]);
    }

    [Fact]
    public void NothingIsLoggedBeforeAttachOrAfterDetach()
    {
        // Retail's help is explicit that logging starts when you type the
        // command: only what appears AFTER it is copied.
        using var log = new ChatSessionLog(_directory);
        var transcript = new ChatLog();
        var writer = new ChatTranscriptLogWriter(log);

        log.Open("session", out _);
        transcript.OnLocalSpeech("Dww", "before attach", 0x02u, false, 0u);
        writer.Attach(transcript);
        transcript.OnLocalSpeech("Dww", "during", 0x02u, false, 0u);
        writer.Detach();
        transcript.OnLocalSpeech("Dww", "after detach", 0x02u, false, 0u);
        log.Close();

        Assert.Equal("Dww says, \"during\"\n", Read());
    }

    [Fact]
    public void AttachingTwiceDoesNotWriteEveryLineTwice()
    {
        using var log = new ChatSessionLog(_directory);
        var transcript = new ChatLog();
        var writer = new ChatTranscriptLogWriter(log);

        log.Open("session", out _);
        writer.Attach(transcript);
        writer.Attach(transcript);
        transcript.OnLocalSpeech("Dww", "once", 0x02u, false, 0u);
        log.Close();

        Assert.Equal("Dww says, \"once\"\n", Read());
    }

    [Fact]
    public void DetachReleasesTheTranscriptItActuallyAttachedTo()
    {
        // A session teardown replaces the transcript. Detaching from the
        // CURRENT one would leave a live handler on the old one, which then
        // keeps writing into a file the player believes is closed.
        using var log = new ChatSessionLog(_directory);
        var first = new ChatLog();
        var second = new ChatLog();
        var writer = new ChatTranscriptLogWriter(log);

        log.Open("session", out _);
        writer.Attach(first);
        writer.Attach(second);          // switches transcripts
        first.OnLocalSpeech("Dww", "stale", 0x02u, false, 0u);
        second.OnLocalSpeech("Dww", "live", 0x02u, false, 0u);
        log.Close();

        Assert.Equal("Dww says, \"live\"\n", Read());
    }
}