GDScript: Fix common mismatched external parser errors (reverted) #94617
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There's a failing unit test: |
rune-scape
force-pushed
the
fix-mismatched-parsers
branch
from
85d5dbf to
1ecfdde
Compare
This was referenced Jul 23, 2024
rune-scape
force-pushed
the
fix-mismatched-parsers
branch
from
1ecfdde to
a5437d7
Compare
|
the failing test helped me generalize it more, its much simpler and more robust now |
akien-mga
reviewed
Jul 23, 2024
|
It is a bit complex but it looks okay to me. I just really don't understand the need of |
|
it searches the depended parsers of other parsers, so it has to be delayed until they actually resolve and call and the finally pattern is of course to make the code much cleaner |
rune-scape
force-pushed
the
fix-mismatched-parsers
branch
from
a5437d7 to
c75225f
Compare
akien-mga
approved these changes
Jul 24, 2024
|
Thanks! |
|
I'm getting a nullptr exception at the bellow line when I try opening a scene after this PR. godot/modules/gdscript/gdscript_analyzer.cpp Line 3705 in 91eb688 Coming from here: godot/modules/gdscript/gdscript_analyzer.cpp Line 891 in 91eb688 I don't know how the analyzer system works but the second argument (which is p_from_class) is nullptr so this code path always throws an exception.
Call stack: |
|
I don't know if that preserves the intention of this code, but this might fix the crash: diff --git a/modules/gdscript/gdscript_analyzer.cpp b/modules/gdscript/gdscript_analyzer.cpp
index 990384bcaa..27e1a97b8e 100644
--- a/modules/gdscript/gdscript_analyzer.cpp
+++ b/modules/gdscript/gdscript_analyzer.cpp
@@ -3669,7 +3669,7 @@ Ref<GDScriptParserRef> GDScriptAnalyzer::ensure_cached_parser_for_class(const GD
Ref<GDScriptParserRef> parser_ref;
Ref<GDScriptParserRef> dependant_parser_ref;
GDScriptParser *dependant_parser = parser;
- do {
+ while (p_from_class != nullptr) {
if (HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>>::Iterator E = external_class_parser_cache.find(p_from_class)) {
dependant_parser_ref = E->value;
dependant_parser = E->value->get_parser();
@@ -3703,7 +3703,7 @@ Ref<GDScriptParserRef> GDScriptAnalyzer::ensure_cached_parser_for_class(const GD
dependant_parser_ref = Ref<GDScriptParserRef>();
dependant_parser = nullptr;
p_from_class = p_from_class->base_type.class_type;
- } while (p_from_class != nullptr);
+ }
if (parser_ref.is_null()) {
push_error(vformat(R"(Parser bug: Could not find external parser. (%s))", p_context), p_source);(or move it somewhere else) Could you try and confirm? I couldn't reproduce the crash in a couple projects I tested. Edit: Well that might fix the crash but then it will raise the parser bug below: push_error(vformat(R"(Parser bug: Could not find external parser. (%s))", p_context), p_source); |
|
I think we can just add a null check before dereferencing it: diff --git a/modules/gdscript/gdscript_analyzer.cpp b/modules/gdscript/gdscript_analyzer.cpp
index 990384bcaa..3299aa44a2 100644
--- a/modules/gdscript/gdscript_analyzer.cpp
+++ b/modules/gdscript/gdscript_analyzer.cpp
@@ -3702,7 +3702,9 @@ Ref<GDScriptParserRef> GDScriptAnalyzer::ensure_cached_parser_for_class(const GD
dependant_parser_ref = Ref<GDScriptParserRef>();
dependant_parser = nullptr;
- p_from_class = p_from_class->base_type.class_type;
+ if (p_from_class != nullptr) {
+ p_from_class = p_from_class->base_type.class_type;
+ }
} while (p_from_class != nullptr);
if (parser_ref.is_null()) {EDIT: Or simply break early: diff --git a/modules/gdscript/gdscript_analyzer.cpp b/modules/gdscript/gdscript_analyzer.cpp
index 990384bcaa..2e29c141bd 100644
--- a/modules/gdscript/gdscript_analyzer.cpp
+++ b/modules/gdscript/gdscript_analyzer.cpp
@@ -3702,6 +3702,9 @@ Ref<GDScriptParserRef> GDScriptAnalyzer::ensure_cached_parser_for_class(const GD
dependant_parser_ref = Ref<GDScriptParserRef>();
dependant_parser = nullptr;
+ if (p_from_class == nullptr) {
+ break;
+ }
p_from_class = p_from_class->base_type.class_type;
} while (p_from_class != nullptr); |
|
Moving the while statement causes an infinite loop for scripts that didn't trigger the exception before. |
|
I can confirm that both suggestions by @vnen resolves the crash but instead results in the errors mentioned by @ydeltastar. |
|
This maybe isn't the most minimal of MRPs, but it does reproduce the crash/regression mentioned above: cached-parser-crash.zip It's essentially just a clean project with the Cheatsheet add-on added to it, but with one tiny modification done to it, which is that func register(name: String, callback: Callable) -> Command:
var command := db.register(name, callback)
+ if not command.args.is_empty():
+ print(command.args[0].name)
commands_changed.emit()
return commandThat modification causes the crash, and without that modification the project loads just fine. EDIT: There's a more minimal MRP here as well: #94697 (comment) |
akien-mga
added a commit
to akien-mga/godot
that referenced
this pull request
Jul 25, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
akien-mga
changed the title
|
Reverted for now with #94723 to fix the new regression, which is more critical than the one fixed by this PR. |
Luis-Wong
pushed a commit
to Luis-Wong/godot
that referenced
this pull request
Jul 26, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
MBCX
pushed a commit
to Sunfly-Studios/godot
that referenced
this pull request
Jul 26, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine/godot#94617 (comment)
RadiantUwU
pushed a commit
to RadiantUwU/godot
that referenced
this pull request
Jul 27, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
kii-chan-reloaded
pushed a commit
to kii-chan-reloaded/godot
that referenced
this pull request
Aug 3, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
2nafish117
pushed a commit
to 2nafish117/godot
that referenced
this pull request
Aug 5, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
chryan
pushed a commit
to chryan/godot
that referenced
this pull request
Aug 6, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
maidopi-usagi
pushed a commit
to maidopi-usagi/godot
that referenced
this pull request
Sep 11, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
Akeal
pushed a commit
to Akeal/godot
that referenced
this pull request
Oct 16, 2024
This reverts commit c75225f. This caused a crashing regression for multiple users: godotengine#94617 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
tried to make this simple and thorough without fundamentally changing how GDScriptCache or GDScriptAnalyzer works
adds a cache of external class nodes that have been requested to be resolved, that map to the
GDScriptParserRefthat owns the class nodethen the external resolve code can use it to find the parser that owns the node it wants to resolve
this is all needed to accommodates multiple different parser trees of the same script in the dependency tree
https://github.com/Zylann/godot_heightmap_plugin was excellent in demonstrating weird edge cases, i feel confident this PR solves the issue generally
also added much more descriptive errors
fixes #94244