False failure of CLI with multiple sources

[igor84]

CLI is currently implement to finish with a non zero return code if anything logs the error. But when using multiple sources and some packages is only available on one source, the other sources will log an error that package was not found. In the end the package will be found and installed from the source that has it but CLI will still return a non zero return code making it seem like restore operation has failed even though it hasn't.

[JoC0de]

I added a test #728 to verify that it works with multiple sources but I can't reproduce.
Normal "package not in source" is only generating a warning, only if it is not found in the active sources it generates a error.

[igor84]

I forgot to mention that this only happens if the packages in question are not already cached on the system. But just to be sure I run the CLI in the debugger and it seems that you are right and the problem is actually something else. It stopped on this exception for me:

System.InvalidOperationException: This JsonSerializerOptions instance is read-only or has already been used in serialization or deserialization.
   at System.Text.Json.ThrowHelper.ThrowInvalidOperationException_SerializerOptionsReadOnly(JsonSerializerContext context)
   at System.Text.Json.JsonSerializerOptions.VerifyMutable()
   at System.Text.Json.JsonSerializerOptions.set_WriteIndented(Boolean value)
   at UnityEngine.JsonUtility.ToJson[T](T value, Boolean pretty) in D:\git\NuGetForUnity\src\NuGetForUnity.Cli\Fakes\JsonUtility.cs:line 45
   at NugetForUnity.PackageSource.NugetApiClientV3.ConvertDependencyGroups(CatalogEntry entry) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageSource\NugetApiClientV3.cs:line 399
   at NugetForUnity.PackageSource.NugetApiClientV3.CreatePackageFromRegistrationLeaf(NugetPackageSourceV3 packageSource, RegistrationLeafObject leafItem, List`1 allVersions) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageSource\NugetApiClientV3.cs:line 359
   at NugetForUnity.PackageSource.NugetApiClientV3.GetPackageWithDetailsAsync(NugetPackageSourceV3 packageSource, INugetPackageIdentifier package, CancellationToken cancellationToken) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageSource\NugetApiClientV3.cs:line 317
   at NugetForUnity.PackageSource.NugetPackageSourceV3.FindPackagesById(INugetPackageIdentifier package) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageSource\NugetPackageSourceV3.cs:line 187
   at NugetForUnity.PackageSource.NugetPackageSourceV3.GetSpecificPackage(INugetPackageIdentifier package) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageSource\NugetPackageSourceV3.cs:line 215
   at NugetForUnity.PackageSource.NugetPackageSourceCombined.GetSpecificPackage(INugetPackageIdentifier package) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageSource\NugetPackageSourceCombined.cs:line 169
   at NugetForUnity.Configuration.ConfigurationManager.GetSpecificPackage(INugetPackageIdentifier nugetPackageIdentifier) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\Configuration\ConfigurationManager.cs:line 257
   at NugetForUnity.PackageCacheManager.GetOnlinePackage(INugetPackageIdentifier packageId) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageCacheManager.cs:line 123
   at NugetForUnity.PackageCacheManager.GetPackageFromCacheOrSource(INugetPackageIdentifier packageId) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageCacheManager.cs:line 83
   at NugetForUnity.NugetPackageInstaller.Install(INugetPackageIdentifier package, Boolean refreshAssets, Boolean isSlimRestoreInstall, Boolean allowUpdateForExplicitlyInstalled) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\NugetPackageInstaller.cs:line 65
   at NugetForUnity.NugetPackageInstaller.InstallIdentifier(INugetPackageIdentifier package, Boolean refreshAssets, Boolean isSlimRestoreInstall, Boolean allowUpdateForExplicitlyInstalled) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\NugetPackageInstaller.cs:line 40
   at NugetForUnity.PackageRestorer.Restore(Boolean slimRestore) in D:\git\NuGetForUnity\src\NuGetForUnity\Editor\PackageRestorer.cs:line 41

It seems that we can not use one instance of JsonSerializerOptions and change WriteIndented on it in Fakes/JsonUtility.cs. I guess we will have to have two instances: one with WriteIndented = false and one with true.

[JoC0de]

In the PR #722 I already fixed this before merging it d4f46ac so somehow your CLI code doesn't seem to be up-to-date.

[igor84]

This is a different issue. This isn't a problem with private fields. Look at the error message in the first line of the Exception. It is about trying to change WriteIndented on JsonSerializerOptions after it has been used at least once.

[JoC0de]

This is exactly what the commit does, it uses two separate JsonSettings as they are immutable

[igor84]

Sorry @JoC0de for my lack of attention :). You are right. I was using older version on build machine and testing with a bit newer version locally and got myself confused. I will close this.