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 all commits
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
3 changes: 2 additions & 1 deletion src/NuGet.Core/NuGet.ProjectModel/DependencyGraphSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
using System.IO;
using System.Linq;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using NuGet.Common;
using NuGet.Packaging;

Expand Down Expand Up @@ -253,7 +252,9 @@ public static DependencyGraphSpec Load(string path)
case "projects":
jsonReader.ReadObject(projectsPropertyName =>
{
#pragma warning disable CS0612 // Type or member is obsolete
PackageSpec packageSpec = JsonPackageSpecReader.GetPackageSpec(jsonReader, path);
#pragma warning restore CS0612 // Type or member is obsolete

dgspec._projects.Add(projectsPropertyName, packageSpec);
});
Expand Down
52 changes: 28 additions & 24 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 @@ -85,6 +85,18 @@ internal static FileFormatException Create(Exception exception, int line, int co
return ex.WithFilePath(path).WithLineInfo(line, column);
}

internal static FileFormatException Create(Exception exception, string path)
{
var message = string.Format(CultureInfo.CurrentCulture,
Strings.Log_ErrorReadingProjectJson,
path,
exception.Message);

var ex = new FileFormatException(message, exception);

return ex.WithFilePath(path);
}

public static FileFormatException Create(string message, JToken value, string path)
{
var lineInfo = (IJsonLineInfo)value;
Expand All @@ -101,32 +113,24 @@ internal static FileFormatException Create(string message, int line, int column,
return ex.WithFilePath(path).WithLineInfo(line, column);
}

internal static FileFormatException Create(Exception exception, string path)
internal static FileFormatException Create(JsonReaderException exception, string path)
{
var jex = exception as JsonReaderException;

string message;
if (jex == null)
{
message = string.Format(CultureInfo.CurrentCulture,
Strings.Log_ErrorReadingProjectJson,
path,
exception.Message);

return new FileFormatException(message, exception).WithFilePath(path);
}
else
{
message = string.Format(CultureInfo.CurrentCulture,
Strings.Log_ErrorReadingProjectJsonWithLocation,
path, jex.LineNumber,
jex.LinePosition,
exception.Message);

return new FileFormatException(message, exception)
.WithFilePath(path)
.WithLineInfo(jex);
}
message = string.Format(CultureInfo.CurrentCulture,
Strings.Log_ErrorReadingProjectJsonWithLocation,
path, exception.LineNumber,
exception.LinePosition,
exception.Message);

return new FileFormatException(message, exception)
.WithFilePath(path)
.WithLineInfo(exception);
}

internal static FileFormatException Create(string message, string path)
{
return new FileFormatException(message)
.WithFilePath(path);
}
}
}
1,822 changes: 1,822 additions & 0 deletions src/NuGet.Core/NuGet.ProjectModel/JsonPackageSpecReader.Utf8JsonStreamReader.cs
View file
Open in desktop

Large diffs are not rendered by default.

78 changes: 64 additions & 14 deletions src/NuGet.Core/NuGet.ProjectModel/JsonPackageSpecReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@

namespace NuGet.ProjectModel
{
public static class JsonPackageSpecReader
public static partial class JsonPackageSpecReader
{
private static readonly char[] DelimitedStringSeparators = { ' ', ',' };
private static readonly char[] VersionSeparators = new[] { ';' };

public static readonly string RestoreOptions = "restore";
public static readonly string RestoreSettings = "restoreSettings";
public static readonly string HideWarningsAndErrors = "hideWarningsAndErrors";
Expand All @@ -49,19 +48,15 @@ public static PackageSpec GetPackageSpec(string json, string name, string packag
}
}

[Obsolete("This method is obsolete and will be removed in a future release.")]
public static PackageSpec GetPackageSpec(JObject json)
public static PackageSpec GetPackageSpec(Stream stream, string name, string packageSpecPath, string snapshotValue)
{
return GetPackageSpec(json, name: null, packageSpecPath: null, snapshotValue: null);
return GetPackageSpec(stream, name, packageSpecPath, snapshotValue, EnvironmentVariableWrapper.Instance);
}

public static PackageSpec GetPackageSpec(Stream stream, string name, string packageSpecPath, string snapshotValue)
[Obsolete("This method is obsolete and will be removed in a future release.")]
public static PackageSpec GetPackageSpec(JObject json)
{
using (var streamReader = new StreamReader(stream))
using (var jsonReader = new JsonTextReader(streamReader))
{
return GetPackageSpec(jsonReader, name, packageSpecPath, snapshotValue);
}
return GetPackageSpec(json, name: null, packageSpecPath: null, snapshotValue: null);
}

[Obsolete("This method is obsolete and will be removed in a future release.")]
Expand All @@ -74,12 +69,33 @@ public static PackageSpec GetPackageSpec(JObject rawPackageSpec, string name, st
}
}

[Obsolete]
internal static PackageSpec GetPackageSpec(JsonTextReader jsonReader, string packageSpecPath)
{
return GetPackageSpec(jsonReader, name: null, packageSpecPath, snapshotValue: null);
}

private static PackageSpec GetPackageSpec(JsonTextReader jsonReader, string name, string packageSpecPath, string snapshotValue)
internal static PackageSpec GetPackageSpec(Stream stream, string name, string packageSpecPath, string snapshotValue, IEnvironmentVariableReader environmentVariableReader)
{
var useNj = environmentVariableReader.GetEnvironmentVariable("NUGET_EXPERIMENTAL_USE_NJ_FOR_FILE_PARSING");
if (string.IsNullOrEmpty(useNj) || useNj.Equals("false", StringComparison.OrdinalIgnoreCase))
{
return GetPackageSpecUtf8JsonStreamReader(stream, name, packageSpecPath, snapshotValue);
}
else
{
using (var textReader = new StreamReader(stream))
using (var jsonReader = new JsonTextReader(textReader))
{
#pragma warning disable CS0612 // Type or member is obsolete
return GetPackageSpec(jsonReader, name, packageSpecPath, snapshotValue);
#pragma warning restore CS0612 // Type or member is obsolete
}
}
}

[Obsolete]
internal static PackageSpec GetPackageSpec(JsonTextReader jsonReader, string name, string packageSpecPath, string snapshotValue)
{
var packageSpec = new PackageSpec();

Expand Down Expand Up @@ -237,6 +253,7 @@ private static PackageSpec GetPackageSpec(JsonTextReader jsonReader, string name
return packageSpec;
}

[Obsolete]
private static PackageType CreatePackageType(JsonTextReader jsonReader)
{
var name = (string)jsonReader.Value;
Expand All @@ -258,6 +275,7 @@ private static void ReadBuildOptions(JsonTextReader jsonReader, PackageSpec pack
});
}

[Obsolete]
private static void ReadCentralPackageVersions(
JsonTextReader jsonReader,
IDictionary<string, CentralPackageVersion> centralPackageVersions,
Expand Down Expand Up @@ -292,6 +310,7 @@ private static void ReadCentralPackageVersions(
});
}

[Obsolete]
Copy link
Contributor

@kartheekp-ms kartheekp-ms Dec 21, 2023

Choose a reason for hiding this comment

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

An obsolete attribute allows to add a short explanation suggesting alternative workarounds. It could be great if we can add that information here. Are these methods marked as obsolete due to their usage in the Newtonsoft.Json API? If that's the case, perhaps we could add a message to inform the caller. In certain instances, the caller might be a customer of the NuGet SDK.

Copy link
Contributor Author

@jgonz120 jgonz120 Jan 4, 2024

Choose a reason for hiding this comment

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

This function is private so we shouldn't have any customers calling it right? The public functions have a message in them already but I can update it if you think a specific call out to STJ would be better.

private static CompatibilityProfile ReadCompatibilityProfile(JsonTextReader jsonReader, string profileName)
{
List<FrameworkRuntimePair> sets = null;
Expand All @@ -308,6 +327,7 @@ private static CompatibilityProfile ReadCompatibilityProfile(JsonTextReader json
return new CompatibilityProfile(profileName, sets ?? Enumerable.Empty<FrameworkRuntimePair>());
}

[Obsolete]
private static IEnumerable<FrameworkRuntimePair> ReadCompatibilitySets(JsonTextReader jsonReader, string compatibilitySetName)
{
NuGetFramework framework = NuGetFramework.Parse(compatibilitySetName);
Expand All @@ -320,7 +340,8 @@ private static IEnumerable<FrameworkRuntimePair> ReadCompatibilitySets(JsonTextR
}
}

internal static void ReadDependencies(
[Obsolete]
private static void ReadDependencies(
JsonTextReader jsonReader,
IList<LibraryDependency> results,
string packageSpecPath,
Expand Down Expand Up @@ -519,6 +540,7 @@ internal static void ReadDependencies(
});
}

[Obsolete]
internal static void ReadCentralTransitiveDependencyGroup(
JsonTextReader jsonReader,
IList<LibraryDependency> results,
Expand Down Expand Up @@ -641,6 +663,7 @@ internal static void ReadCentralTransitiveDependencyGroup(
});
}

[Obsolete]
private static void ReadDownloadDependencies(
JsonTextReader jsonReader,
IList<DownloadDependency> downloadDependencies,
Expand Down Expand Up @@ -731,13 +754,15 @@ private static void ReadDownloadDependencies(
}
}

[Obsolete]
private static IReadOnlyList<string> ReadEnumerableOfString(JsonTextReader jsonReader)
{
string value = jsonReader.ReadNextTokenAsString();

return value.Split(DelimitedStringSeparators, StringSplitOptions.RemoveEmptyEntries);
}

[Obsolete]
private static void ReadFrameworkReferences(
JsonTextReader jsonReader,
ISet<FrameworkDependency> frameworkReferences,
Expand Down Expand Up @@ -773,6 +798,7 @@ private static void ReadFrameworkReferences(
});
}

[Obsolete]
private static void ReadFrameworks(JsonTextReader jsonReader, PackageSpec packageSpec)
{
jsonReader.ReadObject(_ =>
Expand All @@ -791,6 +817,7 @@ private static void ReadFrameworks(JsonTextReader jsonReader, PackageSpec packag
});
}

[Obsolete]
private static void ReadImports(PackageSpec packageSpec, JsonTextReader jsonReader, TargetFrameworkInformation targetFrameworkInformation)
{
int lineNumber = jsonReader.LineNumber;
Expand Down Expand Up @@ -822,6 +849,7 @@ private static void ReadImports(PackageSpec packageSpec, JsonTextReader jsonRead
}
}

[Obsolete]
private static void ReadMappings(JsonTextReader jsonReader, string mappingKey, IDictionary<string, IncludeExcludeFiles> mappings)
{
if (jsonReader.ReadNextToken())
Expand Down Expand Up @@ -899,6 +927,7 @@ private static void ReadMappings(JsonTextReader jsonReader, string mappingKey, I
}
}

[Obsolete]
private static void ReadMSBuildMetadata(JsonTextReader jsonReader, PackageSpec packageSpec)
{
var centralPackageVersionsManagementEnabled = false;
Expand Down Expand Up @@ -1205,6 +1234,7 @@ private static void ReadMSBuildMetadata(JsonTextReader jsonReader, PackageSpec p
packageSpec.RestoreMetadata = msbuildMetadata;
}

[Obsolete]
private static bool ReadNextTokenAsBoolOrFalse(JsonTextReader jsonReader, string filePath)
{
if (jsonReader.ReadNextToken() && jsonReader.TokenType == JsonToken.Boolean)
Expand All @@ -1222,6 +1252,7 @@ private static bool ReadNextTokenAsBoolOrFalse(JsonTextReader jsonReader, string
return false;
}

[Obsolete]
private static void ReadNuGetLogCodes(JsonTextReader jsonReader, HashSet<NuGetLogCode> hashCodes)
{
if (jsonReader.ReadNextToken() && jsonReader.TokenType == JsonToken.StartArray)
Expand All @@ -1236,6 +1267,7 @@ private static void ReadNuGetLogCodes(JsonTextReader jsonReader, HashSet<NuGetLo
}
}

[Obsolete]
private static List<NuGetLogCode> ReadNuGetLogCodesList(JsonTextReader jsonReader)
{
List<NuGetLogCode> items = null;
Expand All @@ -1256,6 +1288,7 @@ private static List<NuGetLogCode> ReadNuGetLogCodesList(JsonTextReader jsonReade
return items;
}

[Obsolete]
private static void ReadPackageTypes(PackageSpec packageSpec, JsonTextReader jsonReader)
{
var errorLine = 0;
Expand Down Expand Up @@ -1460,7 +1493,8 @@ private static bool ReadPackOptionsFiles(PackageSpec packageSpec, JsonTextReader
return wasMappingsRead;
}

private static RuntimeDependencySet ReadRuntimeDependencySet(JsonTextReader jsonReader, string dependencySetName)
[Obsolete]
static RuntimeDependencySet ReadRuntimeDependencySet(JsonTextReader jsonReader, string dependencySetName)
{
List<RuntimePackageDependency> dependencies = null;

Expand All @@ -1478,6 +1512,7 @@ private static RuntimeDependencySet ReadRuntimeDependencySet(JsonTextReader json
dependencies);
}

[Obsolete]
private static RuntimeDescription ReadRuntimeDescription(JsonTextReader jsonReader, string runtimeName)
{
List<string> inheritedRuntimes = null;
Expand Down Expand Up @@ -1505,6 +1540,7 @@ private static RuntimeDescription ReadRuntimeDescription(JsonTextReader jsonRead
additionalDependencies);
}

[Obsolete]
private static List<RuntimeDescription> ReadRuntimes(JsonTextReader jsonReader)
{
var runtimeDescriptions = new List<RuntimeDescription>();
Expand Down Expand Up @@ -1553,13 +1589,15 @@ private static void ReadScripts(JsonTextReader jsonReader, PackageSpec packageSp
});
}

[Obsolete]
private static string[] ReadStringArray(JsonTextReader jsonReader)
{
List<string> list = jsonReader.ReadStringArrayAsList();

return list?.ToArray();
}

[Obsolete]
private static List<CompatibilityProfile> ReadSupports(JsonTextReader jsonReader)
{
var compatibilityProfiles = new List<CompatibilityProfile>();
Expand All @@ -1574,6 +1612,7 @@ private static List<CompatibilityProfile> ReadSupports(JsonTextReader jsonReader
return compatibilityProfiles;
}

[Obsolete]
private static LibraryDependencyTarget ReadTarget(
JsonTextReader jsonReader,
string packageSpecPath,
Expand Down Expand Up @@ -1604,6 +1643,7 @@ private static LibraryDependencyTarget ReadTarget(
return targetFlagsValue;
}

[Obsolete]
private static List<ProjectRestoreMetadataFrameworkInfo> ReadTargetFrameworks(JsonTextReader jsonReader)
{
var targetFrameworks = new List<ProjectRestoreMetadataFrameworkInfo>();
Expand Down Expand Up @@ -1677,6 +1717,7 @@ private static List<ProjectRestoreMetadataFrameworkInfo> ReadTargetFrameworks(Js
return targetFrameworks;
}

[Obsolete]
private static void ReadTargetFrameworks(PackageSpec packageSpec, JsonTextReader jsonReader, out int frameworkLine, out int frameworkColumn)
{
frameworkLine = 0;
Expand Down Expand Up @@ -1757,6 +1798,12 @@ private static void ReadTargetFrameworks(PackageSpec packageSpec, JsonTextReader
}
}, out frameworkLine, out frameworkColumn);

AddTargetFramework(packageSpec, frameworkName, secondaryFramework, targetFrameworkInformation);
}

[Obsolete]
private static void AddTargetFramework(PackageSpec packageSpec, NuGetFramework frameworkName, NuGetFramework secondaryFramework, TargetFrameworkInformation targetFrameworkInformation)
{
NuGetFramework updatedFramework = frameworkName;

if (targetFrameworkInformation.Imports.Count > 0)
Expand All @@ -1782,6 +1829,8 @@ private static void ReadTargetFrameworks(PackageSpec packageSpec, JsonTextReader
packageSpec.TargetFrameworks.Add(targetFrameworkInformation);
}


[Obsolete]
private static NuGetFramework GetDualCompatibilityFrameworkIfNeeded(NuGetFramework frameworkName, NuGetFramework secondaryFramework)
{
if (secondaryFramework != default)
Expand All @@ -1792,6 +1841,7 @@ private static NuGetFramework GetDualCompatibilityFrameworkIfNeeded(NuGetFramewo
return frameworkName;
}

[Obsolete]
private static bool ValidateDependencyTarget(LibraryDependencyTarget targetValue)
{
var isValid = false;
Expand Down
Loading