Skip to content

System.Text.Json Migration - Adding code to parse the PackageSpec using STJ #5541

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.

Sign up for GitHub

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

Merged
jgonz120 merged 21 commits into from
Dec 20, 2023
Merged

System.Text.Json Migration - Adding code to parse the PackageSpec using STJ #5541

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
22f3566
Create class for reading Json files in chunks (#5530)
jgonz120 Dec 12, 2023
b92d83f
Copy files from previous PR
jgonz120 Dec 12, 2023
e6219c5
Remoce surface message param
jgonz120 Dec 12, 2023
b3c8f85
Updated tests
jgonz120 Dec 13, 2023
96e628a
Remove unused functions
jgonz120 Dec 13, 2023
de5f9e8
Rename property names
jgonz120 Dec 13, 2023
ee98406
fix a rename bug 😅
jgonz120 Dec 13, 2023
0803621
Update dependency target tests
jgonz120 Dec 13, 2023
08c02b2
fix unit tests
jgonz120 Dec 14, 2023
51a1aa9
use doulbe quotes
jgonz120 Dec 14, 2023
31d06f1
more double quotes
jgonz120 Dec 14, 2023
0b26816
double quoootes
jgonz120 Dec 14, 2023
2c5e756
even more quotes
jgonz120 Dec 14, 2023
192ee52
quotes
jgonz120 Dec 15, 2023
f1200e5
Move Newtson code back to main json package spec reader
jgonz120 Dec 15, 2023
8e2c300
move ReadCentralTransitiveDependencyGroup to match previous location
jgonz120 Dec 15, 2023
eef2428
formatting
jgonz120 Dec 15, 2023
7eb51ae
convert to parial class
jgonz120 Dec 15, 2023
4db5fea
restructure class
jgonz120 Dec 18, 2023
c01a509
added unit test
jgonz120 Dec 18, 2023
d38617a
Merge branch 'dev-jgonz120-FeatureBranch-Stj-Migration' into dev-feat…
jgonz120 Dec 20, 2023
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
Prev Previous commit
Next Next commit
Remoce surface message param
  • Loading branch information
@jgonz120
jgonz120 committed Dec 12, 2023
commit e6219c5233e5271e91727421e4113f158689cd33
8 changes: 1 addition & 7 deletions src/NuGet.Core/NuGet.ProjectModel/FileFormatException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ namespace NuGet.ProjectModel
{
public class FileFormatException : Exception
{
static internal string SurfaceMessage = "SurfaceMessage";

public FileFormatException(string message)
: base(message)
{
Expand Down Expand Up @@ -128,11 +126,7 @@ internal static FileFormatException Create(JsonReaderException exception, string
internal static FileFormatException Create(System.Text.Json.JsonException exception, string path)
{
string message;
if (exception.Data.Contains(SurfaceMessage))
{
message = exception.Message;
}
else if (exception.BytePositionInLine is not null && exception.LineNumber is not null)
if (exception.BytePositionInLine is not null && exception.LineNumber is not null)
{
message = string.Format(CultureInfo.CurrentCulture,
Strings.Log_ErrorReadingProjectJsonWithLocation,
Expand Down
20 changes: 5 additions & 15 deletions src/NuGet.Core/NuGet.ProjectModel/Utf8JsonStreamPackageSpecReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,7 @@ internal static void ReadCentralTransitiveDependencyGroup(
var propertyName = jsonReader.GetString();
if (string.IsNullOrEmpty(propertyName))
{
var exception = new JsonException("Unable to resolve dependency ''.");
exception.Data.Add(FileFormatException.SurfaceMessage, true);
throw exception;
throw new JsonException("Unable to resolve dependency ''.");
}

if (jsonReader.Read())
Expand Down Expand Up @@ -418,9 +416,7 @@ private static void ReadDependencies(
var propertyName = jsonReader.GetString();
if (string.IsNullOrEmpty(propertyName))
{
var exception = new JsonException("Unable to resolve dependency ''.");
exception.Data.Add(FileFormatException.SurfaceMessage, true);
throw exception;
throw new JsonException("Unable to resolve dependency ''.");
}

// Support
Expand Down Expand Up @@ -1292,12 +1288,10 @@ private static void ReadPackageTypes(PackageSpec packageSpec, ref Utf8JsonStream
{
if (jsonReader.TokenType != JsonTokenType.String)
{
var exception = new JsonException(string.Format(
throw new JsonException(string.Format(
CultureInfo.CurrentCulture,
Strings.InvalidPackageType,
PackageSpec.PackageSpecFileName));
exception.Data.Add(FileFormatException.SurfaceMessage, true);
throw exception;
}

packageType = CreatePackageType(ref jsonReader);
Expand All @@ -1324,12 +1318,10 @@ private static void ReadPackageTypes(PackageSpec packageSpec, ref Utf8JsonStream
}
catch (Exception)
{
var exception = new JsonException(string.Format(
throw new JsonException(string.Format(
CultureInfo.CurrentCulture,
Strings.InvalidPackageType,
PackageSpec.PackageSpecFileName));
exception.Data.Add(FileFormatException.SurfaceMessage, true);
throw exception;
}
}

Expand Down Expand Up @@ -1579,9 +1571,7 @@ private static void ReadScripts(ref Utf8JsonStreamReader jsonReader, PackageSpec
}
else
{
var exception = new JsonException(string.Format(CultureInfo.CurrentCulture, "The value of a script in '{0}' can only be a string or an array of strings", PackageSpec.PackageSpecFileName));
exception.Data.Add(FileFormatException.SurfaceMessage, true);
throw exception;
throw new JsonException(string.Format(CultureInfo.CurrentCulture, "The value of a script in '{0}' can only be a string or an array of strings", PackageSpec.PackageSpecFileName));
}
}
}
Expand Down
9 changes: 4 additions & 5 deletions test/NuGet.Core.Tests/NuGet.ProjectModel.Test/Utf8JsonStreamPackageSpecReaderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1176,8 +1176,7 @@ public void GetPackageSpec_WhenDependenciesDependencyNameIsEmptyString_Throws()
const string json = "{\"dependencies\":{\"\":{}}}";

FileFormatException exception = Assert.Throws<FileFormatException>(() => GetPackageSpec(json));

Assert.Equal("Unable to resolve dependency ''.", exception.Message);
Assert.Equal("Error reading '' : Unable to resolve dependency ''.", exception.Message);
}

[Fact]
Expand Down Expand Up @@ -1660,7 +1659,7 @@ public void GetPackageSpec_WhenFrameworksDependenciesDependencyNameIsEmptyString

FileFormatException exception = Assert.Throws<FileFormatException>(() => GetPackageSpec(json));

Assert.Equal("Unable to resolve dependency ''.", exception.Message);
Assert.Equal("Error reading '' : Unable to resolve dependency ''.", exception.Message);
Assert.IsType<System.Text.Json.JsonException>(exception.InnerException);
Assert.Null(exception.InnerException.InnerException);
}
Expand Down Expand Up @@ -2493,7 +2492,7 @@ public void GetPackageSpec_WhenPackOptionsPackageTypeIsInvalid_Throws(string val

FileFormatException exception = Assert.Throws<FileFormatException>(() => GetPackageSpec(json));

Assert.Equal("The pack options package type must be a string or array of strings in 'project.json'.", exception.Message);
Assert.Equal("Error reading '' : The pack options package type must be a string or array of strings in 'project.json'.", exception.Message);
Assert.IsType<System.Text.Json.JsonException>(exception.InnerException);
Assert.Null(exception.InnerException.InnerException);
}
Expand Down Expand Up @@ -3363,7 +3362,7 @@ public void GetPackageSpec_WhenScriptsValueIsInvalid_Throws()

FileFormatException exception = Assert.Throws<FileFormatException>(() => GetPackageSpec(json));

Assert.Equal("The value of a script in 'project.json' can only be a string or an array of strings", exception.Message);
Assert.Equal("Error reading '' : The value of a script in 'project.json' can only be a string or an array of strings", exception.Message);
Assert.IsType<System.Text.Json.JsonException>(exception.InnerException);
Assert.Null(exception.InnerException.InnerException);

Expand Down