Improve automated checks for GDExtension compatibility by Yarwin · Pull Request #113743 · godotengine/godot

Yarwin · 2025-12-08T10:53:59Z

Implements the first proposed solution in this thread, i.e.:

We could make a minimal GDExtension (maybe directly in C?) that attempts to load all methods in the extension_api.json from the previous minor version and see if any of them fails to load. This feels like the most complete way to test it, because it's not just testing the JSON data, but also the fallback code

Effect of running said check against Godot 4.5.1-stable:

$ ./tests/compatibility_test/run_compatibility_test.py

Effect of running said check against Godot Engine v4.6.dev.custom_build.63e14e13f:

Errors

$ ./tests/compatibility_test/run_compatibility_test.py
Compatibility test failed. Errors:
 ERROR: Method 'EditorFileDialog.set_file_mode' has changed and no compatibility fallback has been provided. Please open an issue.
   at: gdextension_classdb_get_method_bind (core/extension/gdextension_interface.cpp:1643)
Method bind not found: EditorFileDialog.set_file_mode (hash: 274150415)
ERROR: Method 'EditorFileDialog.get_file_mode' has changed and no compatibility fallback has been provided. Please open an issue.
   at: gdextension_classdb_get_method_bind (core/extension/gdextension_interface.cpp:1643)
Method bind not found: EditorFileDialog.get_file_mode (hash: 2681044145)
ERROR: Method 'EditorFileDialog.set_access' has changed and no compatibility fallback has been provided. Please open an issue.
   at: gdextension_classdb_get_method_bind (core/extension/gdextension_interface.cpp:1643)
Method bind not found: EditorFileDialog.set_access (hash: 3882893764)
ERROR: Method 'EditorFileDialog.get_access' has changed and no compatibility fallback has been provided. Please open an issue.
   at: gdextension_classdb_get_method_bind (core/extension/gdextension_interface.cpp:1643)
Method bind not found: EditorFileDialog.get_access (hash: 778734016)
ERROR: Method 'EditorFileDialog.set_display_mode' has changed and no compatibility fallback has been provided. Please open an issue.
   at: gdextension_classdb_get_method_bind (core/extension/gdextension_interface.cpp:1643)
Method bind not found: EditorFileDialog.set_display_mode (hash: 3049004050)
ERROR: Method 'EditorFileDialog.get_display_mode' has changed and no compatibility fallback has been provided. Please open an issue.
   at: gdextension_classdb_get_method_bind (core/extension/gdextension_interface.cpp:1643)
Method bind not found: EditorFileDialog.get_display_mode (hash: 3517174669)
ERROR: Index p_which = 1 is out of bounds (popup->get_item_count() = 1).
   at: _select (scene/gui/option_button.cpp:416)

Compatibility test against Godot4.5-stable failed

.github/actions/godot-compat-test/action.yml

dsnopek

Thanks!

Overall, this looks really great to me - I've got only a few minor notes :-)

tests/compatibility_test/run_compatibility_test.py

tests/compatibility_test/src/compat_checker.c

tests/compatibility_test/run_compatibility_test.py

dsnopek · 2025-12-08T21:47:47Z

.github/workflows/linux_builds.yml

            doc-test: true
            proj-conv: true
            api-compat: true
+            api-compat-load: true


I don't know that this needs its own variable? It could probably just use the pre-existing api-compat. But this up to the build system folks - maybe they'll like having a separate variable

Reusing api-compat would indeed be preferable

Suggested change

api-compat-load: true

tests/compatibility_test/run_compatibility_test.py

dsnopek

Thanks!

From a GDExtension perspective, this looks great to me. :-) This still needs some review from the build system and CI folks, though

(FYI, the current test failures are just issues with downloading the ANGLE libs - I'll re-run the failed jobs after they finish)

Repiteo

I'm very torn on this implementation. On one hand, unless there's a very good reason to do so, we should be using C++ instead of C. This would allow using the godot-cpp helper methods directly, which I think should be encouraged for any GDExtension test. On the other hand, this is meant to be as minimal as possible, so maybe the specialized setup is warranted here? I never realized how the lack of a godot-c equivalent forced direct reliance on the standard library.

.github/actions/godot-compat-test/action.yml

Repiteo · 2026-01-05T17:20:05Z

.github/workflows/linux_builds.yml

            doc-test: true
            proj-conv: true
            api-compat: true
+            api-compat-load: true


Reusing api-compat would indeed be preferable

Suggested change

api-compat-load: true

.github/workflows/linux_builds.yml

tests/compatibility_test/.gitignore

tests/compatibility_test/SConstruct

tests/compatibility_test/src/compat_checker.h

dsnopek · 2026-01-05T19:14:02Z

On one hand, unless there's a very good reason to do so, we should be using C++ instead of C. This would allow using the godot-cpp helper methods directly, which I think should be encouraged for any GDExtension test. On the other hand, this is meant to be as minimal as possible, so maybe the specialized setup is warranted here?

Personally, I think using C (or at least not using godot-cpp) here is the right choice. If this test used godot-cpp, it wouldn't really use any of its helpers (maybe just loading the interface functions?), and would still be implemented pretty much the exact same way as it is now. All we would get is slower build times and the potential for godot-cpp changes/bugs to break the test.

==== - Create minimal GDExtension which tries to load methods specified in a gdextension_api.json. - Run said GDExtension in the CI.

Repiteo

I have some reservations on this not being in a separate repo, but having this check in place is more pertinent. Sorry for the wait, and great job!

Repiteo · 2026-02-06T14:23:38Z

Thanks!

…omated-checks-for-gdextension-compatibility Improve automated checks for GDExtension compatibility

Yarwin requested review from a team as code owners December 8, 2025 10:54

Yarwin marked this pull request as draft December 8, 2025 10:54

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch 2 times, most recently from a115f26 to 49bf182 Compare December 8, 2025 10:56

Yarwin marked this pull request as ready for review December 8, 2025 10:57

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch 2 times, most recently from dba9425 to 6ed1267 Compare December 8, 2025 11:01

AThousandShips added enhancement topic:buildsystem topic:gdextension topic:tests labels Dec 8, 2025

AThousandShips added this to the 4.x milestone Dec 8, 2025

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch 2 times, most recently from 076b2da to 262f560 Compare December 8, 2025 12:10

Yarwin commented Dec 8, 2025

View reviewed changes

.github/actions/godot-compat-test/action.yml Outdated Show resolved Hide resolved

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch 2 times, most recently from 5aaf1b6 to 2aad03c Compare December 8, 2025 12:43

dsnopek reviewed Dec 8, 2025

View reviewed changes

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch from 5d3831d to a255d3e Compare December 9, 2025 08:26

Yarwin requested a review from a team as a code owner December 9, 2025 08:26

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch from a255d3e to a468c31 Compare December 9, 2025 08:27

Yarwin mentioned this pull request Dec 18, 2025

Initialize platform APIs before GDExtensions level scene. #114143

Closed

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch 2 times, most recently from 9b59968 to f9dd9ca Compare December 18, 2025 12:07

dsnopek reviewed Dec 18, 2025

View reviewed changes

tests/compatibility_test/run_compatibility_test.py Outdated Show resolved Hide resolved

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch from f9dd9ca to d7df4a0 Compare December 18, 2025 14:42

dsnopek approved these changes Dec 18, 2025

View reviewed changes

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch from d7df4a0 to 8b656b6 Compare December 19, 2025 22:37

Repiteo self-requested a review January 5, 2026 17:13

Repiteo reviewed Jan 5, 2026

View reviewed changes

Improve automated checks for GDExtension compatibility

e517509

==== - Create minimal GDExtension which tries to load methods specified in a gdextension_api.json. - Run said GDExtension in the CI.

Yarwin force-pushed the feature/improve-automated-checks-for-gdextension-compatibility branch from 8b656b6 to e517509 Compare January 6, 2026 07:31

Yarwin requested a review from Repiteo January 15, 2026 16:19

Bromeon mentioned this pull request Feb 6, 2026

Fix GDExtension breakage in removed AudioEffectSpectrumAnalyzer::get_tap_back_pos #115951

Merged

akien-mga requested a review from a team February 6, 2026 11:59

Repiteo approved these changes Feb 6, 2026

View reviewed changes

Repiteo modified the milestones: 4.x, 4.7 Feb 6, 2026

Repiteo merged commit ff7d5cb into godotengine:master Feb 6, 2026
20 checks passed

rivie13 pushed a commit to rivie13/Phoenix-Agentic-Engine that referenced this pull request Feb 16, 2026

Merge pull request godotengine#113743 from Yarwin/feature/improve-aut…

0b9c308

…omated-checks-for-gdextension-compatibility Improve automated checks for GDExtension compatibility

Repiteo mentioned this pull request Feb 20, 2026

SCons: Bump minimum Python version (3.8 → 3.9) #116550

Merged

Uh oh!

Conversation

Yarwin commented Dec 8, 2025

Uh oh!

Uh oh!

dsnopek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dsnopek Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Repiteo Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dsnopek left a comment

Choose a reason for hiding this comment

Uh oh!

Repiteo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Repiteo Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dsnopek commented Jan 5, 2026

Uh oh!

Repiteo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Repiteo commented Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dsnopek Dec 8, 2025 •

edited

Loading