Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix project info reading #10623

Merged
merged 3 commits into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ private static async Task ReportUpdateProjectAsync(Stream stream, Project projec
return;
}

stream.WriteProjectInfoAction(ProjectInfoAction.Update);
await stream.WriteProjectInfoAsync(projectInfo, cancellationToken).ConfigureAwait(false);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ public static async Task<string> ReadStringAsync(this Stream stream, Encoding? e
var length = ReadSize(stream);

using var _ = ArrayPool<byte>.Shared.GetPooledArray(length, out var encodedBytes);
await stream.ReadAsync(encodedBytes, 0, length, cancellationToken).ConfigureAwait(false);

await ReadExactlyAsync(stream, encodedBytes, length, cancellationToken).ConfigureAwait(false);
return encoding.GetString(encodedBytes, 0, length);
}

Expand Down Expand Up @@ -94,8 +95,6 @@ public static Task<string> ReadProjectInfoRemovalAsync(this Stream stream, Cance

public static async Task WriteProjectInfoAsync(this Stream stream, RazorProjectInfo projectInfo, CancellationToken cancellationToken)
{
WriteProjectInfoAction(stream, ProjectInfoAction.Update);

var bytes = projectInfo.Serialize();
WriteSize(stream, bytes.Length);
await stream.WriteAsync(bytes, 0, bytes.Length, cancellationToken).ConfigureAwait(false);
Expand All @@ -106,11 +105,15 @@ public static async Task WriteProjectInfoAsync(this Stream stream, RazorProjectI
var sizeToRead = ReadSize(stream);

using var _ = ArrayPool<byte>.Shared.GetPooledArray(sizeToRead, out var projectInfoBytes);
await stream.ReadAsync(projectInfoBytes, 0, projectInfoBytes.Length, cancellationToken).ConfigureAwait(false);
return RazorProjectInfo.DeserializeFrom(projectInfoBytes.AsMemory());
await ReadExactlyAsync(stream, projectInfoBytes, sizeToRead, cancellationToken).ConfigureAwait(false);

// The array may be larger than the bytes read so make sure to trim accordingly.
var projectInfoMemory = projectInfoBytes.AsMemory(0, sizeToRead);

return RazorProjectInfo.DeserializeFrom(projectInfoMemory);
}

private static void WriteSize(Stream stream, int length)
public static void WriteSize(this Stream stream, int length)
{
#if NET
Span<byte> sizeBytes = stackalloc byte[4];
Expand All @@ -125,7 +128,7 @@ private static void WriteSize(Stream stream, int length)

}

private unsafe static int ReadSize(Stream stream)
public unsafe static int ReadSize(this Stream stream)
{
#if NET
Span<byte> bytes = stackalloc byte[4];
Expand All @@ -137,4 +140,24 @@ private unsafe static int ReadSize(Stream stream)
return BitConverter.ToInt32(bytes, 0);
#endif
}

#if NET
private static ValueTask ReadExactlyAsync(Stream stream, byte[] buffer, int length, CancellationToken cancellationToken)
=> stream.ReadExactlyAsync(buffer, 0, length, cancellationToken);
#else
private static async ValueTask ReadExactlyAsync(Stream stream, byte[] buffer, int length, CancellationToken cancellationToken)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll do a follow up cleanup to move these to net only instead of having a bunch of ifdefs

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, none of these methods need to actually run on netstandard2.0 or NetFx. You could #ifdef the whole file for NET or change the file name to StreamExtensions.NetCore.cs so that they only compile for NET. Then, you can get rid of the non-NET branches. That will open up lots of Span-based APIs on Stream and other types.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea that's the plan, move the whole file over.

{
var bytesRead = 0;
while (bytesRead < length)
{
var read = await stream.ReadAsync(buffer, bytesRead, length - bytesRead, cancellationToken);
if (read == 0)
{
throw new EndOfStreamException();
}

bytesRead += read;
}
}
#endif
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT license. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Razor.Language;
using Microsoft.AspNetCore.Razor.ProjectSystem;
using Microsoft.AspNetCore.Razor.Serialization;
using Microsoft.AspNetCore.Razor.Utilities;
using Microsoft.CodeAnalysis;
using Xunit;

namespace Microsoft.AspNetCore.Razor.ProjectEngineHost.Test;

public class StreamExtensionTests
{
[Theory]
[InlineData(0)]
[InlineData(int.MaxValue)]
[InlineData(int.MinValue)]
[InlineData(-500)]
[InlineData(500)]
public void SizeFunctions(int size)
{
using var stream = new MemoryStream();

stream.WriteSize(size);
stream.Position = 0;

Assert.Equal(size, stream.ReadSize());
}

public static TheoryData<string, Encoding?> StringFunctionData = new TheoryData<string, Encoding?>
{
{ "", null },
{ "hello", null },
{ "", Encoding.UTF8 },
{ "hello", Encoding.UTF8 },
{ "", Encoding.ASCII },
{ "hello", Encoding.ASCII },
{ "", Encoding.UTF32 },
{ "hello", Encoding.UTF32 },
{ "", Encoding.Unicode },
{ "hello", Encoding.Unicode },
{ "", Encoding.BigEndianUnicode },
{ "hello", Encoding.BigEndianUnicode },
};

[Theory]
[MemberData(nameof(StringFunctionData))]
public async Task StringFunctions(string expected, Encoding? encoding)
{
using var stream = new MemoryStream();

await stream.WriteStringAsync(expected, encoding, default);
stream.Position = 0;

var actual = await stream.ReadStringAsync(encoding, default);
Assert.Equal(expected, actual);
}

[Fact]
public async Task SerializeProjectInfo()
{
using var stream = new MemoryStream();

var configuration = new RazorConfiguration(
RazorLanguageVersion.Latest,
"TestConfiguration",
ImmutableArray<RazorExtension>.Empty);

var tagHelper = TagHelperDescriptorBuilder.Create("TypeName", "AssemblyName")
.TagMatchingRuleDescriptor(rule => rule.RequireTagName("tag-name"))
.Build();

var projectWorkspaceState = ProjectWorkspaceState.Create([tagHelper], CodeAnalysis.CSharp.LanguageVersion.Latest);

var projectInfo = new RazorProjectInfo(
new ProjectKey("TestProject"),
@"C:\test\test.csproj",
configuration,
"TestNamespace",
"Test",
projectWorkspaceState,
[new DocumentSnapshotHandle(@"C:\test\document.razor", @"document.razor", FileKinds.Component)]);

var bytesToSerialize = projectInfo.Serialize();

await stream.WriteProjectInfoAsync(projectInfo, default);

// WriteProjectInfoAsync prepends the size before writing which is 4 bytes long
Assert.Equal(bytesToSerialize.Length + 4, stream.Position);

var streamContents = stream.ToArray();
var expectedSize = BitConverter.GetBytes(bytesToSerialize.Length);
Assert.Equal(expectedSize, streamContents.Take(4).ToArray());

Assert.Equal(bytesToSerialize, streamContents.Skip(4).ToArray());

stream.Position = 0;
var deserialized = await stream.ReadProjectInfoAsync(default);

Assert.Equal(projectInfo, deserialized);
}

[Theory]
[CombinatorialData]
internal void ProjectInfoActionFunctions(ProjectInfoAction infoAction)
{
using var stream = new MemoryStream();
stream.WriteProjectInfoAction(infoAction);

stream.Position = 0;
Assert.Equal(infoAction, stream.ReadProjectInfoAction());
}
}