SelfContained does not work anymore since version 4.14.4

[robmuller]

Starting with the 4.14.4 release any project with SelfContained set to true gives errors when trying to compile a script.
I have attached a minimal example which shows the problem. If you change cs-script to version 4.14.3 or set SelfContained to false the script can be compiled.

The is the exception message:

<script>(6,12): error CS0518: Predefined type 'System.Void' is not defined or imported
<script>(8,9): error CS0518: Predefined type 'System.Object' is not defined or imported
<script>(8,17): error CS0012: The type 'Object' is defined in an assembly that is not referenced. You must add a reference to assembly 'System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e'.
<script>(8,17): error CS0518: Predefined type 'System.Object' is not defined or imported
<script>(8,27): error CS0518: Predefined type 'System.Object' is not defined or imported
<script>(8,27): error CS0103: The name 'Environment' does not exist in the current context
<script>(8,49): error CS0518: Predefined type 'System.String' is not defined or imported
<script>(8,58): error CS0518: Predefined type 'System.Object' is not defined or imported
<script>(8,58): error CS1069: The type name 'RuntimeInformation' could not be found in the namespace 'System.Runtime.InteropServices'. This type has been forwarded to assembly 'System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e' Consider adding a reference to that assembly.
<script>(8,9): error CS0518: Predefined type 'System.Void' is not defined or imported
<script>(4,14): error CS1729: 'object' does not contain a constructor that takes 0 arguments
error CS0518: Predefined type 'System.Attribute' is not defined or imported
error CS0518: Predefined type 'System.Attribute' is not defined or imported
error CS0518: Predefined type 'System.Int32' is not defined or imported
error CS0656: Missing compiler required member 'System.AttributeUsageAttribute..ctor'
error CS0656: Missing compiler required member 'System.AttributeUsageAttribute.AllowMultiple'
error CS0656: Missing compiler required member 'System.AttributeUsageAttribute.Inherited'

SelfContained_problem.zip

[oleg-shilo]

The problem is caused by the side effect of the new Roslyn compilation mode that has been added recently to accommodate multi-file scripting - SourceCodeKind.Regular. This mode is default now. Though the previous mode SourceCodeKind.Script is still supported.

Anyway, it looks like SourceCodeKind.Regular is incompatible with Self-contained host app. To solve this problem you need to switch back to old mode. The easiest way to do this is to change the defaults:

Globals.DefaultRoslynCompilationToScript = true; 

I am changing this ticket to enhancement as I want to reflect your finding in the documentation.

[oleg-shilo]

just to ensure we are testing the same things, I used the latest version of the nuget package:

[robmuller]

With DefaultRoslynCompilationToScript set to true our application works fine with CS-Script 4.18.4.
Thanks for the fast support.

[9vult]

Hi @oleg-shilo, I have some further details on this.

With cs-script 4.14.9 and CSScripting.Globals.DefaultRoslynCompilationToScript = true;, compiled scripts work fine:

var script = Engine.PrepareScript(await reader.ReadToEndAsync());
await script.ExecuteAsync(null, args);
// OK

Evaluations result in the issue in the OP:

CSScript.Evaluator.Eval(content);
// CSScriptLib.CompilerException: <script>(5,1): error CS0518: Predefined type 'System.Object' is not defined or imported ...

This was built with dotnet publish -c Release -r linux-x64 --self-contained true

---

I'm not sure if this is related or not, but if I build in single-file mode, neither work, and I get a TypeInitializationException instead:

System.TypeInitializationException: The type initializer for 'CSScriptLib.Runtime' threw an exception.
 ---> System.NullReferenceException: Object reference not set to an instance of an object.
   at CSScriptLib.Runtime..cctor()
   --- End of inner exception stack trace ---
   at CSScriptLib.Runtime.get_IsLinux()
   at CSScriptLib.CSharpParser.Init(String code, String file, String[] directivesToSearch, String[] probingDirs)
   at CSScriptLib.CSharpParser.Construct(String script, Boolean isFile, String[] directivesToSearch, String[] probingDirs)
   at CSScriptLib.CSharpParser..ctor(String script, Boolean isFile)
   at CSScriptLib.RoslynEvaluator.Compile(String scriptText, String scriptFile, CompileInfo info)
   at CSScriptLib.EvaluatorBase`1.CompileCode(String scriptText, String scriptFile, CompileInfo info)
   at CSScriptLib.EvaluatorBase`1.CompileCode(String scriptText, CompileInfo info)
   at CSScriptLib.RoslynEvaluator.Eval(String scriptText)

dotnet publish -c Release -r linux-x64 --self-contained true /p:PublishSingleFile=true

Let me know if I should move this to a new issue.

[oleg-shilo]

It is a bug that is exploitable in teh self-contained builds. The bug itself is rather trivial and is not related to teh Roslyn internals. But it is a bug nevertheless.
I have just published the fix.
When nuget.org updates the index, you can sync and get the v4.14.10.0 fix in your codebase.

Please note that there is a comprehensive example that shows how to deal with the self-contained builds:

cs-script/src/CSScriptLib/src/Client.SingleFileBuild/Program.cs

Lines 6 to 15 in 75b7ed6

	// publishing as a single-file with and without runtime
	// (project file contains PublishSingleFile=true)
	// dotnet publish --configuration Release --output .\publish --self-contained false
	// dotnet publish --configuration Release --output .\publish --self-contained true
	//
	// You may need to experiment with the publish options to get the desired result.
	// The code below will only work for `--self-contained false`
	// But if you want to use `--self-contained true` you may need to isolate this code into a library
	// and reference it from your entry assembly.
	// See this discussion for the example: https://github.com/oleg-shilo/cs-script/issues/343#issuecomment-2841878623.

Though this matter is really complicated due to the various Roslyn and CLR limitations.
But this discussion shows (with the samples) the solutions for the all flavours of self-contained builds.