src/Components/Endpoints/test/Buffering/BufferedTextWriterTest.cs - main - githubmirror/aspnetcore

src/Components/Endpoints/test/Buffering/BufferedTextWriterTest.cs
89 строк3 KB
Steve Sanderson
Fix corrupted streaming SSR output (#50380)
01 сен 2023, 18:56
01 сен 2023, 18:569101335
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.AspNetCore.Components.Endpoints.Rendering;

public class BufferedTextWriterTest
{
    [Fact]
    public void DoesNotSupportFlushSync()
    {
        var writer = new BufferedTextWriter(new StringWriter());
        Assert.Throws<NotSupportedException>(writer.Flush);
    }

    [Fact]
    public async Task WritesThroughToUnderlyingWriter()
    {
        var underlying = new StringWriter();
        var writer = new BufferedTextWriter(underlying);

        writer.Write('x');
        writer.Write("My string");
        writer.Write(new char[] { 'a', 'b', 'c', 'd', 'e' }, 1, 3);

        Assert.Empty(underlying.ToString());
        await writer.FlushAsync();

        Assert.Equal("xMy stringbcd", underlying.ToString());
    }

    [Fact]
    public async Task CanWriteAndFlushWhileFlushIsInProgress()
    {
        var underlying = new SlowFlushingTextWriter();
        var writer = new BufferedTextWriter(underlying);

        // Start the first flush
        writer.Write('a');
        var flush1Tcs = new TaskCompletionSource();
        underlying.CompleteNextFlushAfter = flush1Tcs.Task;
        var flushAsyncTask1 = writer.FlushAsync();
        Assert.False(flushAsyncTask1.IsCompleted);

        // While that's running, write more then do a second flush
        writer.Write('b');
        var flush2Tcs = new TaskCompletionSource();
        underlying.CompleteNextFlushAfter = flush2Tcs.Task;
        var flushAsyncTask2 = writer.FlushAsync();
        Assert.False(flushAsyncTask2.IsCompleted);

        // Can add more output that will be included in the second flush because it hasn't started yet
        writer.Write('c');

        // Can add a third flush that completes with the second (because the second hasn't started yet)
        var flushAsyncTask3 = writer.FlushAsync();
        Assert.False(flushAsyncTask3.IsCompleted);

        // See the first flush can complete
        Assert.Empty(underlying.FlushedOutput);
        flush1Tcs.SetResult();
        await flushAsyncTask1;
        Assert.Equal("a", underlying.FlushedOutput);
        Assert.False(flushAsyncTask2.IsCompleted);

        // See the second flush can complete, which immediately completes the third since they were coalesced
        flush2Tcs.SetResult();
        await flushAsyncTask2;
        Assert.True(flushAsyncTask3.IsCompleted);
        Assert.Equal("abc", underlying.FlushedOutput);
    }

    private class SlowFlushingTextWriter : StringWriter
    {
        public Task CompleteNextFlushAfter { get; set; }

        public string FlushedOutput { get; private set; } = string.Empty;

        public override async Task FlushAsync()
        {
            if (CompleteNextFlushAfter is not null)
            {
                await CompleteNextFlushAfter;
            }

            await base.FlushAsync();
            FlushedOutput = ToString();
        }
    }
}