C#: Automatically download and lazily load C# dependencies #74089

neikeq · 2023-02-27T22:57:18Z

This is the first step towards a unified editor. If the C# dependencies are not available, the editor will continue to work with C# features disabled, and attempts to download them.

The downloader is a carbon copy of the export templates downloader, except we use EditorProgress to display (and I'm planning to replace it with EditorProgressBG or an alternative that also displays the status).

Production edit: closes godotengine/godot-roadmap#48

raulsntos

Overall it seems pretty good already even though it's a draft. Here are some observations after testing the PR.

I have been unable to make the downloader work, I always get RESULT_CANT_RESOLVE. I have been using https://tmpfiles.org to upload the GodotSharp.zip, I haven't tested with a different host.

When trying to create a C# script for the first time (without the C# dependencies):

It launches the C# downloader but also immediately prints errors in the console since the editor plugin is not initialized. As an user I feel like something went wrong, but as I understand it this is by design since we don't want to wait for the C# dependencies to download and freeze the editor.
After the downloader has failed to download the C# dependencies it doesn't try again when creating new C# scripts until restarting the editor, this can feel a bit annoying.

I feel like some indicator that shows if .NET features are enabled could be nice to have. It could also be used to open a C# dependencies manager to allow retrying manually. This can be done in a follow-up PR but just wanted to throw the idea out there.

When trying to create a C# script for the first time (with the C# dependencies):

It prints errors about creating the csproj because of a condition was backwards. (See C#: Automatically download and lazily load C# dependencies #74089 (comment)).
It also seems like it calls HotReloadAssemblyWatcher.RestartTimer before _Ready because _watchTimer is null and throws a System.NullReferenceException.
When launching the game _try_load_godotsharp_editor prints an error: Cannot initialize C# editor plugin. This is caused by ensure_dotnet_initialized. (See C#: Automatically download and lazily load C# dependencies #74089 (comment)).

raulsntos · 2023-06-11T09:07:09Z

modules/mono/csharp_script.cpp

-	CRASH_COND(CSharpLanguage::get_singleton()->get_godotsharp_editor() == nullptr);
+	ERR_FAIL_COND_V_MSG(GDMono::get_singleton()->is_runtime_initialized(), false,
+			"Cannot create C# project because the .NET runtime is not loaded.");
+	ERR_FAIL_COND_V_MSG(CSharpLanguage::get_singleton()->get_godotsharp_editor() == nullptr, false,


Suggested change

ERR_FAIL_COND_V_MSG(CSharpLanguage::get_singleton()->get_godotsharp_editor() == nullptr, false,

ERR_FAIL_NULL_V_MSG(CSharpLanguage::get_singleton()->get_godotsharp_editor(), false,

raulsntos · 2023-06-11T09:12:57Z

modules/mono/csharp_script.cpp

@@ -1078,10 +1191,15 @@ void CSharpLanguage::get_recognized_extensions(List<String> *p_extensions) const

 #ifdef TOOLS_ENABLED
 Error CSharpLanguage::open_in_external_editor(const Ref<Script> &p_script, int p_line, int p_col) {
+	ERR_FAIL_COND_V(get_godotsharp_editor() == nullptr, ERR_UNAVAILABLE);


Suggested change

ERR_FAIL_COND_V(get_godotsharp_editor() == nullptr, ERR_UNAVAILABLE);

ERR_FAIL_NULL_V(get_godotsharp_editor(), ERR_UNAVAILABLE);

raulsntos · 2023-06-11T09:31:38Z

modules/mono/csharp_script.cpp

+	if (!FileAccess::exists(godot_tools_assembly_path)) {
+		print_line("The C# editor plugin is missing.");
+		return;
+	}


Should this use ERR_FAIL_COND_MSG?

Suggested change

if (!FileAccess::exists(godot_tools_assembly_path)) {

print_line("The C# editor plugin is missing.");

return;

}

ERR_FAIL_COND_MSG(!FileAccess::exists(godot_tools_assembly_path), "The C# editor plugin is missing.");

raulsntos · 2023-06-11T09:36:11Z

modules/mono/csharp_script.cpp

+	Object *editor_plugin_obj = GDMono::get_singleton()->get_plugin_callbacks().LoadToolsAssemblyCallback(
+			godot_tools_assembly_path.utf16(),
+			interop_funcs, interop_funcs_size);
+	ERR_FAIL_COND_MSG(editor_plugin_obj == nullptr, "Cannot initialize C# editor plugin.");


Suggested change

ERR_FAIL_COND_MSG(editor_plugin_obj == nullptr, "Cannot initialize C# editor plugin.");

ERR_FAIL_NULL_MSG(editor_plugin_obj, "Cannot initialize C# editor plugin.");

raulsntos · 2023-06-11T09:42:13Z

modules/mono/mono_gd/gd_mono.cpp

+		r_missing_runtime_config = true;
+		ERR_FAIL_V_MSG(nullptr, ".NET: Cannot initialize because runtimeconfig is missing");
+	}
+
 	load_assembly_and_get_function_pointer_fn load_assembly_and_get_function_pointer =
 			initialize_hostfxr_for_config(get_data(config_path));

 	if (load_assembly_and_get_function_pointer == nullptr) {
 		// Show a message box to the user to make the problem explicit (and explain a potential crash).


This comment can be removed since the alert was removed.

raulsntos · 2023-06-11T10:43:22Z

modules/mono/editor/csharp_deps_downloader.cpp

+						EditorNode::get_singleton()->add_io_error(TTR("Cannot remove temporary file:") + "\n" + path + "\n");
+					}
+				} else {
+					EditorNode::get_singleton()->add_io_error(vformat(TTR("Templates installation failed.\nThe problematic templates archives can be found at '%s'."), path));


Suggested change

EditorNode::get_singleton()->add_io_error(vformat(TTR("Templates installation failed.\nThe problematic templates archives can be found at '%s'."), path));

EditorNode::get_singleton()->add_io_error(vformat(TTR("C# dependencies installation failed.\nThe problematic C# dependencies archives can be found at '%s'."), path));

raulsntos · 2023-06-11T10:43:49Z

modules/mono/editor/csharp_deps_downloader.cpp

+	}
+	int ret = unzGoToFirstFile(pkg);
+
+	// Count them and find version.


Suggested change

// Count them and find version.

// Count them.

raulsntos · 2023-06-11T10:46:34Z

modules/mono/editor/csharp_deps_downloader.cpp

+		if (is_dir) {
+			Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
+			ERR_CONTINUE(da.is_null());
+
+			if (!DirAccess::exists(to_write)) {
+				Error mkdir_err = da->make_dir_recursive(to_write);
+				ERR_CONTINUE(mkdir_err != OK);
+			}


This section does not exist in export_template_manager. Why do we need it? It seems to me like the subdirectories will be created by the code above that checks the base_dir, no?

raulsntos · 2023-06-11T16:41:01Z

modules/mono/csharp_script.cpp

@@ -67,7 +67,11 @@

 #ifdef TOOLS_ENABLED
 static bool _create_project_solution_if_needed() {
-	CRASH_COND(CSharpLanguage::get_singleton()->get_godotsharp_editor() == nullptr);
+	ERR_FAIL_COND_V_MSG(GDMono::get_singleton()->is_runtime_initialized(), false,


This condition is backwards, it should be checking if the runtime is not initialized.

Suggested change

ERR_FAIL_COND_V_MSG(GDMono::get_singleton()->is_runtime_initialized(), false,

ERR_FAIL_COND_V_MSG(!GDMono::get_singleton()->is_runtime_initialized(), false,

raulsntos · 2023-06-11T16:57:14Z

modules/mono/csharp_script.cpp

+		if (get_godotsharp_editor() == nullptr) {
+			_try_load_godotsharp_editor();
+		}


Should probably check if Engine::get_singleton()->is_editor_hint() to prevent trying to load GodotSharpEditor when the assemblies haven't been loaded.

Suggested change

if (get_godotsharp_editor() == nullptr) {

_try_load_godotsharp_editor();

}

if (Engine::get_singleton()->is_editor_hint() && get_godotsharp_editor() == nullptr) {

_try_load_godotsharp_editor();

}

raulsntos · 2023-06-20T23:18:29Z

modules/mono/mono_gd/gd_mono.cpp

+	String project_assembly_name = (String)ProjectSettings::get_singleton()->get_setting("dotnet/project/assembly_name");
+	if (project_assembly_name.is_empty()) {
+		String appname = GLOBAL_GET("application/config/name");
+		String appname_safe = OS::get_singleton()->get_safe_dir_name(appname);
+		if (appname_safe.is_empty()) {
+			appname_safe = "UnnamedProject";
+		}
+		project_assembly_name = appname_safe;
+	}


Should be able to use path::get_csharp_project_name here.

Suggested change

String project_assembly_name = (String)ProjectSettings::get_singleton()->get_setting("dotnet/project/assembly_name");

if (project_assembly_name.is_empty()) {

String appname = GLOBAL_GET("application/config/name");

String appname_safe = OS::get_singleton()->get_safe_dir_name(appname);

if (appname_safe.is_empty()) {

appname_safe = "UnnamedProject";

}

project_assembly_name = appname_safe;

}

String project_assembly_name = path::get_csharp_project_name();

neikeq added enhancement topic:dotnet labels Feb 27, 2023

neikeq added this to the 4.1 milestone Feb 27, 2023

neikeq requested a review from a team as a code owner February 27, 2023 22:57

neikeq marked this pull request as draft February 27, 2023 22:57

neikeq force-pushed the wip-unified-editor branch 2 times, most recently from 7358188 to 2443d0a Compare February 28, 2023 00:33

C#: Automatically download and lazily load C# dependencies

d0900b9

neikeq force-pushed the wip-unified-editor branch from 2443d0a to d0900b9 Compare February 28, 2023 00:37

raulsntos reviewed Jun 11, 2023

View reviewed changes

YuriSizov modified the milestones: 4.1, 4.x Jun 14, 2023

raulsntos reviewed Jun 20, 2023

View reviewed changes

raulsntos mentioned this pull request Aug 3, 2023

Show alert if .NET assemblies dir does not exist #80212

Merged

raulsntos mentioned this pull request Sep 18, 2023

4.2-dev4 C# export to Android generates the APK fine, but fails finding .NET assemblies for arm64 at runtime #81852

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

C#: Automatically download and lazily load C# dependencies #74089

C#: Automatically download and lazily load C# dependencies #74089

neikeq commented Feb 27, 2023 •

edited by adamscott

Loading

raulsntos left a comment •

edited

Loading

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 11, 2023

raulsntos Jun 20, 2023

	ERR_FAIL_COND_V_MSG(CSharpLanguage::get_singleton()->get_godotsharp_editor() == nullptr, false,
	ERR_FAIL_NULL_V_MSG(CSharpLanguage::get_singleton()->get_godotsharp_editor(), false,

	ERR_FAIL_COND_V(get_godotsharp_editor() == nullptr, ERR_UNAVAILABLE);
	ERR_FAIL_NULL_V(get_godotsharp_editor(), ERR_UNAVAILABLE);

	ERR_FAIL_COND_MSG(editor_plugin_obj == nullptr, "Cannot initialize C# editor plugin.");
	ERR_FAIL_NULL_MSG(editor_plugin_obj, "Cannot initialize C# editor plugin.");

	EditorNode::get_singleton()->add_io_error(vformat(TTR("Templates installation failed.\nThe problematic templates archives can be found at '%s'."), path));
	EditorNode::get_singleton()->add_io_error(vformat(TTR("C# dependencies installation failed.\nThe problematic C# dependencies archives can be found at '%s'."), path));

	ERR_FAIL_COND_V_MSG(GDMono::get_singleton()->is_runtime_initialized(), false,
	ERR_FAIL_COND_V_MSG(!GDMono::get_singleton()->is_runtime_initialized(), false,

C#: Automatically download and lazily load C# dependencies #74089

Are you sure you want to change the base?

C#: Automatically download and lazily load C# dependencies #74089

Conversation

neikeq commented Feb 27, 2023 • edited by adamscott Loading

raulsntos left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neikeq commented Feb 27, 2023 •

edited by adamscott

Loading

raulsntos left a comment •

edited

Loading