Skip to content

fix: loading script in wrong thread and load non existing scripts #189

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
nmerget merged 2 commits into from
Sep 15, 2024
Merged

fix: loading script in wrong thread and load non existing scripts #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccaaa2f
fix: loading script in wrong thread and load non existing scripts
nmerget Jan 19, 2024
fbe1607
Merge branch 'master' into fix-reload-scripts
nmerget Sep 15, 2024
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
26 changes: 26 additions & 0 deletions javascript.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/

/* This is implementation is for loading/saving JS files. */
/* After loading it contains the code/bytecode of the loaded file. */

#include "javascript.h"
#include "core/config/engine.h"
#include "core/io/file_access_encrypted.h"
Expand Down Expand Up @@ -110,8 +113,17 @@ Error JavaScript::reload(bool p_keep_state) {
javascript_class = NULL;
Error err = OK;
JavaScriptBinder *binder = JavaScriptLanguage::get_thread_binder(Thread::get_caller_id());
#ifdef TOOLS_ENABLED
// This is a workaround for files generated outside of the godot editor
if (binder == NULL) {
binder = JavaScriptLanguage::get_thread_binder(Thread::MAIN_ID);
}
#endif
ERR_FAIL_COND_V_MSG(binder == NULL, ERR_INVALID_DATA, "Cannot load script in this thread");
JavaScriptError js_err;

// TODO: We should have a setting/option to skip parsing or reading .mjs files which aren't Godot classes for example "chunk-xxx.mjs" build from esbuild

if (!bytecode.is_empty()) {
javascript_class = binder->parse_javascript_class(bytecode, script_path, true, &js_err);
} else {
Expand Down Expand Up @@ -268,6 +280,11 @@ Ref<Resource> ResourceFormatLoaderJavaScript::load(const String &p_path, const S
Ref<JavaScriptModule> module = ResourceFormatLoaderJavaScriptModule::load_static(p_path, p_original_path, &err);
if (r_error)
*r_error = err;

if (err == ERR_FILE_NOT_FOUND) {
return module;
}

ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Cannot load script file '" + p_path + "'.");
Ref<JavaScript> javaScript;
javaScript.instantiate();
Expand Down Expand Up @@ -377,9 +394,17 @@ String ResourceFormatLoaderJavaScriptModule::get_resource_type(const String &p_p

Ref<Resource> ResourceFormatLoaderJavaScriptModule::load_static(const String &p_path, const String &p_original_path, Error *r_error) {
Error err = ERR_FILE_CANT_OPEN;
bool fileExists = FileAccess::exists(p_path);
if (!fileExists) {
*r_error = ERR_FILE_NOT_FOUND;
WARN_PRINT("Cannot find file '" + p_path + "'. Maybe you deleted the file.");
return Ref<Resource>();
}

Ref<JavaScriptModule> module;
module.instantiate();
module->set_script_path(p_path);

if (p_path.ends_with("." EXT_JSMODULE) || p_path.ends_with("." EXT_JSCLASS) || p_path.ends_with("." EXT_JSON)) {
String code = FileAccess::get_file_as_string(p_path, &err);
if (r_error)
Expand All @@ -388,6 +413,7 @@ Ref<Resource> ResourceFormatLoaderJavaScriptModule::load_static(const String &p_
module->set_source_code(code);
}

// TODO: Check what this block is for
#if 0
else if (p_path.ends_with("." EXT_JSMODULE_BYTECODE) || p_path.ends_with("." EXT_JSCLASS_BYTECODE)) {
module->set_bytecode(FileAccess::get_file_as_array(p_path, &err));
Expand Down
20 changes: 16 additions & 4 deletions javascript_language.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/

/* This is the language server implementation. It handles how/when to use JS Scripts. */

#include "javascript_language.h"
#include "core/io/file_access.h"
#include "core/object/class_db.h"
Expand Down Expand Up @@ -343,10 +345,20 @@ void JavaScriptLanguage::reload_script(const Ref<Script> &p_script, bool p_soft_
if (s.is_valid()) {
Error err = OK;
Ref<JavaScriptModule> module = ResourceFormatLoaderJavaScriptModule::load_static(s->get_script_path(), "", &err);
ERR_FAIL_COND_MSG(err != OK, ("Cannot load script file '" + s->get_script_path() + "'."));
s->set_source_code(module->get_source_code());
err = s->reload(p_soft_reload);
ERR_FAIL_COND_MSG(err != OK, "Parse source code from file '" + s->get_script_path() + "' failed.");

if (err != ERR_FILE_NOT_FOUND) {
// We don't need to reload a script if it isn't existing

ERR_FAIL_COND_MSG(err != OK, ("Cannot reload script file '" + s->get_script_path() + "'."));
s->set_source_code(module->get_source_code());
err = s->reload(p_soft_reload);
ERR_FAIL_COND_MSG(err != OK, "Parse source code from file '" + s->get_script_path() + "' failed.");
} else {
// If we are in the editor we need to erase the script from the language server to avoid reload on focus (editor_tools.cpp[_notification()])
#ifdef TOOLS_ENABLED
singleton->get_scripts().erase(s);
#endif
}
}
}

Expand Down