Merge #1002

1002: Catch null object pointers in Variant::is_nil r=chitoyuu a=chitoyuu

With varcall, Godot sometimes return null objects as Variants with `VariantType::Object` but a null pointer, instead of the usually expected/assumed `VariantType::Nil`. This caused `Option::from_variant` to panic in case of null objects returned by Godot in this way.

Fix #1001

Co-authored-by: Chitose Yuuzaki <chitoyuu@potatoes.gay>

Author: bors[bot]

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.2] - 2023-01-09
+
+This is a hot-fix release for a high priority issue.
+
+### Fixed
+
+- API methods that may return null object pointers should no longer panic. ([#1002](https://github.com/godot-rust/gdnative/pull/1002))
+
 ## [0.11.1] - 2023-01-06
 
 This is a backwards-compatible release; thus no removals or breaking changes.

bindings-generator/Cargo.toml

@@ -6,7 +6,7 @@ documentation = "https://docs.rs/crate/gdnative_bindings_generator"
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
 license = "MIT"
-version = "0.11.1"
+version = "0.11.2"
 workspace = ".."
 edition = "2021"
 rust-version = "1.63"

gdnative-async/Cargo.toml

@@ -5,7 +5,7 @@ description = "Runtime async support for godot-rust."
 documentation = "https://docs.rs/crate/gdnative-async"
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
-version = "0.11.1"
+version = "0.11.2"
 license = "MIT"
 workspace = ".."
 edition = "2021"
@@ -14,9 +14,9 @@ rust-version = "1.63"
 [features]
 
 [dependencies]
-gdnative-derive = { path = "../gdnative-derive", version = "=0.11.1" }
-gdnative-core = { path = "../gdnative-core", version = "=0.11.1" }
-gdnative-bindings = { path = "../gdnative-bindings", version = "=0.11.1" }
+gdnative-derive = { path = "../gdnative-derive", version = "=0.11.2" }
+gdnative-core = { path = "../gdnative-core", version = "=0.11.2" }
+gdnative-bindings = { path = "../gdnative-bindings", version = "=0.11.2" }
 atomic-waker = "1"
 crossbeam-channel = "0.5"
 futures-task = "0.3"

gdnative-bindings/Cargo.toml

@@ -5,7 +5,7 @@ description = "The Godot game engine's automatcally generated bindings to Godot
 documentation = "https://docs.rs/crate/gdnative-bindings"
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
-version = "0.11.1"
+version = "0.11.2"
 license = "MIT"
 workspace = ".."
 edition = "2021"
@@ -18,8 +18,8 @@ custom-godot = ["gdnative_bindings_generator/custom-godot"]
 ptrcall = ["gdnative_bindings_generator/ptrcall"]
 
 [dependencies]
-gdnative-core = { path = "../gdnative-core", version = "=0.11.1" }
+gdnative-core = { path = "../gdnative-core", version = "=0.11.2" }
 libc = "0.2"
 
 [build-dependencies]
-gdnative_bindings_generator = { path = "../bindings-generator", version = "=0.11.1" }
+gdnative_bindings_generator = { path = "../bindings-generator", version = "=0.11.2" }

gdnative-core/Cargo.toml

@@ -5,7 +5,7 @@ description = "The Godot game engine's gdnative core bindings."
 documentation = "https://docs.rs/crate/gdnative-core"
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
-version = "0.11.1"
+version = "0.11.2"
 license = "MIT"
 workspace = ".."
 edition = "2021"
@@ -17,9 +17,9 @@ gd-test = []
 type-tag-fallback = []
 
 [dependencies]
-gdnative-sys = { path = "../gdnative-sys", version = "=0.11.1" }
-gdnative-derive = { path = "../gdnative-derive", version = "=0.11.1" }
-gdnative-impl-proc-macros = { path = "../impl/proc-macros", version = "=0.11.1" }
+gdnative-sys = { path = "../gdnative-sys", version = "=0.11.2" }
+gdnative-derive = { path = "../gdnative-derive", version = "=0.11.2" }
+gdnative-impl-proc-macros = { path = "../impl/proc-macros", version = "=0.11.2" }
 ahash = "0.8"
 approx = "0.5"
 atomic-take = "1"

gdnative-core/src/core_types/variant.rs

@@ -451,7 +451,14 @@ impl Variant {
     /// Returns true if this is an empty variant.
     #[inline]
     pub fn is_nil(&self) -> bool {
-        self.get_type() == VariantType::Nil
+        match self.get_type() {
+            VariantType::Nil => true,
+            VariantType::Object => {
+                let ptr = unsafe { (get_api().godot_variant_as_object)(&self.0) };
+                ptr.is_null()
+            }
+            _ => false,
+        }
     }
 
     #[inline]

gdnative-derive/Cargo.toml

@@ -5,7 +5,7 @@ description = "The Godot game engine's gdnative derive and procedural macros."
 documentation = "https://docs.rs/crate/gdnative-derive"
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
-version = "0.11.1"
+version = "0.11.2"
 license = "MIT"
 workspace = ".."
 edition = "2021"

gdnative-sys/Cargo.toml

@@ -5,7 +5,7 @@ description = "Generated bindings to the Godot game engine's gdnative core types
 documentation = "https://docs.rs/crate/gdnative-sys"
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
-version = "0.11.1"
+version = "0.11.2"
 build = "build.rs"
 license = "MIT"
 workspace = ".."

gdnative/Cargo.toml

@@ -6,7 +6,7 @@ keywords = ["gamedev", "godot", "engine", "bindings"]
 documentation = "https://docs.rs/crate/gdnative"
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
-version = "0.11.1"
+version = "0.11.2"
 license = "MIT"
 workspace = ".."
 readme = "../README.md"
@@ -28,10 +28,10 @@ gd-test = ["gdnative-core/gd-test"]
 type-tag-fallback = ["gdnative-core/type-tag-fallback"]
 
 [dependencies]
-gdnative-derive = { path = "../gdnative-derive", version = "=0.11.1" }
-gdnative-core = { path = "../gdnative-core", version = "=0.11.1" }
-gdnative-bindings = { path = "../gdnative-bindings", version = "=0.11.1" }
-gdnative-async = { path = "../gdnative-async", version = "=0.11.1", optional = true }
+gdnative-derive = { path = "../gdnative-derive", version = "=0.11.2" }
+gdnative-core = { path = "../gdnative-core", version = "=0.11.2" }
+gdnative-bindings = { path = "../gdnative-bindings", version = "=0.11.2" }
+gdnative-async = { path = "../gdnative-async", version = "=0.11.2", optional = true }
 
 [dev-dependencies]
 trybuild = "1.0.18" # earrlier versions use broken termcolor 1.0.0

impl/proc-macros/Cargo.toml

@@ -4,7 +4,7 @@ authors = ["The godot-rust developers"]
 description = "Internal dependency of the gdnative bindings."
 repository = "https://github.com/godot-rust/godot-rust"
 homepage = "https://godot-rust.github.io/"
-version = "0.11.1"
+version = "0.11.2"
 license = "MIT"
 workspace = "../.."
 edition = "2021"