Mod fails to compile for unresolved FNA during pdb generation

[sgkoishi]

Description

When I compile the mod in CI with includePDB = true, the game was unable to locate the FNA during writing PDB symbol.
The source code of the mod does not locate in the Mod Source folder.
Similar to #672

Log File

Compiling XXX.XNA.dll
Compilation finished with 0 errors and 3 warnings
Compiling XXX.FNA.dll
Compilation finished with 0 errors and 3 warnings
Mono.Cecil.AssemblyResolutionException: Failed to resolve assembly: 'FNA, Version=17.3.0.0, Culture=neutral, PublicKeyToken=null'
   at Mono.Cecil.BaseAssemblyResolver.Resolve(AssemblyNameReference name, ReaderParameters parameters)
   at Mono.Cecil.DefaultAssemblyResolver.Resolve(AssemblyNameReference name)
   at Mono.Cecil.MetadataResolver.Resolve(TypeReference type)
   at Mono.Cecil.TypeReference.Resolve()
   at Mono.Cecil.Mixin.CheckedResolve(TypeReference self)
   at Mono.Cecil.MetadataBuilder.GetConstantType(TypeReference constant_type, Object constant)
   at Mono.Cecil.MetadataBuilder.AddConstant(IConstantProvider owner, TypeReference type)
   at Mono.Cecil.MetadataBuilder.AddParameter(UInt16 sequence, ParameterDefinition parameter, ParamTable table)
   at Mono.Cecil.MetadataBuilder.AddParameters(MethodDefinition method)
   at Mono.Cecil.MetadataBuilder.AddMethod(MethodDefinition method)
   at Mono.Cecil.MetadataBuilder.AddMethods(TypeDefinition type)
   at Mono.Cecil.MetadataBuilder.AddType(TypeDefinition type)
   at Mono.Cecil.MetadataBuilder.AddTypes()
   at Mono.Cecil.MetadataBuilder.BuildTypes()
   at Mono.Cecil.MetadataBuilder.BuildModule()
   at Mono.Cecil.MetadataBuilder.BuildMetadata()
   at Mono.Cecil.ModuleWriter.<>c.<BuildMetadata>b__2_0(MetadataBuilder builder, MetadataReader _)
   at Mono.Cecil.ModuleDefinition.Read[TItem,TRet](TItem item, Func`3 read)
   at Mono.Cecil.ModuleWriter.BuildMetadata(ModuleDefinition module, MetadataBuilder metadata)
   at Mono.Cecil.ModuleWriter.Write(ModuleDefinition module, Disposable`1 stream, WriterParameters parameters)
   at Mono.Cecil.ModuleWriter.WriteModule(ModuleDefinition module, Disposable`1 stream, WriterParameters parameters)       at Mono.Cecil.ModuleDefinition.Write(String fileName, WriterParameters parameters)
   at Terraria.ModLoader.Core.ModCompile.BuildModForPlatform(BuildingMod mod, List`1& refMods, Boolean xna)
   at Terraria.ModLoader.Core.ModCompile.Build(BuildingMod mod)
   at Terraria.ModLoader.Core.ModCompile.BuildModCommandLine(String modFolder)

Expected behavior

Compile should not fail.

Actual behavior

FNA was not found in all given search path, so AssemblyResolutionException was thrown.

Additional Information

tModLoader/patches/tModLoader/Terraria.ModLoader.Core/ModCompile.cs

Lines 491 to 509 in 8db1ce2

	using (var asmResolver = new DefaultAssemblyResolver()) {
	asmResolver.AddSearchDirectory(Path.GetDirectoryName(dllPath));
	asmResolver.AddSearchDirectory(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location));
	var asm = AssemblyDefinition.ReadAssembly(dllPath, new ReaderParameters { InMemory = true, ReadSymbols = mod.properties.includePDB, AssemblyResolver = asmResolver });
	VerifyModAssembly(mod.Name, asm);
	if (!mod.properties.includePDB)
	return;
	// when reading and writing a module with cecil, the debug sequence points need regenerating, even if the methods are not changed
	// write out the pdb file using cecil because doing it at runtime is difficult
	var tempDllPath = Path.Combine(tempDir, dllName); //use the temp dir to avoid overwriting a precompiled dll
	// force the native pdb writer when possible, to support stack traces on older .NET frameworks
	asm.Write(tempDllPath, new WriterParameters {
	WriteSymbols = true,
	SymbolWriterProvider = FrameworkVersion.Framework == Framework.NetFramework ? new NativePdbWriterProvider() : null
	});

Only the compile_temp and game executable path was added, ModCompile was not.

[JavidPack]

By CI do you mean continuous integration? if so, you'll need to show how you are setting that up, since it seems to me to be an issue with that.

[sgkoishi]

By CI do you mean continuous integration? if so, you'll need to show how you are setting that up, since it seems to me to be an issue with that.

Pretty much it's just a simple call Process.Start(Path.Combine(GAME_PATH, "tModLoaderServer.exe"), "-build XXX -unsafe") - I've reproduce it locally using cmd.
Attaching with dnSpy locate the problem to the asm.Write - the game can not find FNA.dll in either game folder or compile_temp folder (it's in ModCompile folder).

tModLoader/patches/tModLoader/Terraria.ModLoader.Core/ModCompile.cs

Lines 506 to 509 in 8db1ce2

	asm.Write(tempDllPath, new WriterParameters {
	WriteSymbols = true,
	SymbolWriterProvider = FrameworkVersion.Framework == Framework.NetFramework ? new NativePdbWriterProvider() : null
	});

This problem doesn't appear after I set includePDB = false (as line 498)

tModLoader/patches/tModLoader/Terraria.ModLoader.Core/ModCompile.cs

Lines 498 to 499 in 8db1ce2

	if (!mod.properties.includePDB)
	return;

The CI part is here - Action
I'm not sure if I miss anything, but at least it works correctly when includePDB = false

[Chicken-Bones]

Send me a test mod. I'll fix it

…

On Tue., 4 Feb. 2020, 12:42 pm Stargazing Koishi, ***@***.***> wrote: By CI do you mean continuous integration? if so, you'll need to show how you are setting that up, since it seems to me to be an issue with that. Pretty much it's just a simple call Process.Start(Path.Combine(GAME_PATH, "tModLoaderServer.exe"), "-build XXX -unsafe") - I've reproduce it locally using cmd. Attaching with dnSpy locate the problem to the asm.Write - the game can not find FNA.dll in either game folder or compile_temp folder (it's in ModCompile folder). https://github.com/tModLoader/tModLoader/blob/8db1ce22ea6918ebbcfb96a4dabf3c365d998072/patches/tModLoader/Terraria.ModLoader.Core/ModCompile.cs#L506-L509 This problem doesn't appear after I set includePDB = false (as line 498) https://github.com/tModLoader/tModLoader/blob/8db1ce22ea6918ebbcfb96a4dabf3c365d998072/patches/tModLoader/Terraria.ModLoader.Core/ModCompile.cs#L498-L499 — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#785?email_source=notifications&email_token=AAC6ZCN65TYX27R3X52NPHLRBDI2RA5CNFSM4KPNLO52YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEKWEO7Q#issuecomment-581715838>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC6ZCONHONA6UPJJXXNW5LRBDI2RANCNFSM4KPNLO5Q> .

[sgkoishi]

tML_issue785.zip
Here's the minimal version.

build.txt:

displayName = tML_issue785
author = SGKoishi
version = 1.0
includePDB = true

code:

using Terraria.ModLoader;
using Microsoft.Xna.Framework.Graphics;

namespace tML_issue785
{
    public class tML_issue785 : Mod
    {
        private void method(SpriteEffects sf = SpriteEffects.None)
        {
            
        }
    }
}