From 07beae98f04308ebcbaa5f4efc2d5e982b2eda22 Mon Sep 17 00:00:00 2001
From: Danil Alexeev <danil@alexeev.xyz>
Date: Wed, 15 Mar 2023 22:11:02 +0300
Subject: GDScript: Fix false positive `REDUNDANT_AWAIT` warning

(cherry picked from commit c0eeb32e38fbd4f582f7a2726e6535614e507205)
---
 .../analyzer/features/warning_ignore_annotation.gd |  2 +-
 .../scripts/analyzer/warnings/redundant_await.gd   | 53 ++++++++++++++++++++++
 .../scripts/analyzer/warnings/redundant_await.out  | 37 +++++++++++++++
 .../runtime/features/await_without_coroutine.gd    |  2 +-
 4 files changed, 92 insertions(+), 2 deletions(-)
 create mode 100644 modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.gd
 create mode 100644 modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.out

(limited to 'modules/gdscript/tests')

diff --git a/modules/gdscript/tests/scripts/analyzer/features/warning_ignore_annotation.gd b/modules/gdscript/tests/scripts/analyzer/features/warning_ignore_annotation.gd
index 4c02fd4b0d..292db30bcd 100644
--- a/modules/gdscript/tests/scripts/analyzer/features/warning_ignore_annotation.gd
+++ b/modules/gdscript/tests/scripts/analyzer/features/warning_ignore_annotation.gd
@@ -11,5 +11,5 @@ func test():
 
 	print("done")
 
-func regular_func():
+func regular_func() -> int:
 	return 0
diff --git a/modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.gd b/modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.gd
new file mode 100644
index 0000000000..f8844d66a7
--- /dev/null
+++ b/modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.gd
@@ -0,0 +1,53 @@
+signal my_signal()
+
+# CI cannot test async things.
+func test_signals():
+	await my_signal
+	var t: Signal = my_signal
+	await t
+
+func coroutine() -> void:
+	@warning_ignore("redundant_await")
+	await 0
+
+func not_coroutine_variant():
+	pass
+
+func not_coroutine_void() -> void:
+	pass
+
+func test():
+	const CONST_NULL = null
+	var var_null = null
+	var var_int: int = 1
+	var var_variant: Variant = 1
+	var var_array: Array = [1]
+
+	await CONST_NULL
+	await var_null
+	await var_int
+	await var_variant
+	await var_array[0]
+
+	await coroutine
+	await coroutine()
+	await coroutine.call()
+	await self.coroutine()
+	await call(&"coroutine")
+
+	await not_coroutine_variant
+	await not_coroutine_variant()
+	await self.not_coroutine_variant()
+	await not_coroutine_variant.call()
+	await call(&"not_coroutine_variant")
+
+	await not_coroutine_void
+	await not_coroutine_void()
+	await self.not_coroutine_void()
+	await not_coroutine_void.call()
+	await call(&"not_coroutine_void")
+
+	var callable: Callable = coroutine
+	await callable
+	await callable.call()
+	await callable.get_method()
diff --git a/modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.out b/modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.out
new file mode 100644
index 0000000000..3d251c2906
--- /dev/null
+++ b/modules/gdscript/tests/scripts/analyzer/warnings/redundant_await.out
@@ -0,0 +1,37 @@
+GDTEST_OK
+>> WARNING
+>> Line: 26
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 28
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 32
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 38
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 44
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 45
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 46
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 51
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
+>> WARNING
+>> Line: 53
+>> REDUNDANT_AWAIT
+>> "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.
diff --git a/modules/gdscript/tests/scripts/runtime/features/await_without_coroutine.gd b/modules/gdscript/tests/scripts/runtime/features/await_without_coroutine.gd
index 9da61ab184..1c39073be9 100644
--- a/modules/gdscript/tests/scripts/runtime/features/await_without_coroutine.gd
+++ b/modules/gdscript/tests/scripts/runtime/features/await_without_coroutine.gd
@@ -4,5 +4,5 @@ func test():
 	print(await not_coroutine())
 
 
-func not_coroutine():
+func not_coroutine() -> String:
 	return "awaited"
-- 
cgit v1.2.3