putting detection that all coroutines are co-awated wherever expected under a separate def

divanchykhin · divanchykhin · commit 6edb408339b6 · 2021-11-19T10:19:21.000+02:00
diff --git a/include/nodecpp/awaitable.h b/include/nodecpp/awaitable.h
@@ -73,6 +73,10 @@ struct awaitable_base {
 	std::exception_ptr e_pending = nullptr;
 	bool is_value = false;
 
+#ifdef NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
+	bool immediatelyReadyOrAwaited = false;
+#endif // NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
+
 	awaitable_base() {}
 	awaitable_base(const awaitable_base &) = delete;
 	awaitable_base &operator = (const awaitable_base &) = delete;
@@ -214,8 +218,6 @@ struct awaitable : public awaitable_base  {
 	bool coroDestroyed = false;
 	using value_type = T;
 
-	bool dbgValueAvailable = false;
-
 	awaitable()  {}
 	awaitable(handle_type h) : coro(h) { 
 		coro.promise().myRetObject = this;
@@ -234,13 +236,13 @@ struct awaitable : public awaitable_base  {
 	}   
 	
 	~awaitable() {
-		NODECPP_ASSERT( nodecpp::module_id, ::nodecpp::assert::AssertLevel::pedantic, dbgValueAvailable, "awaitable object may not be co_await\'ed as it should be (see stack for details)" ); 
+#ifdef NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
+		NODECPP_ASSERT( nodecpp::module_id, ::nodecpp::assert::AssertLevel::pedantic, immediatelyReadyOrAwaited, "awaitable object may not be co_await\'ed as it should be (see stack for details)" ); 
+#endif // NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
 		if ( !coroDestroyed )
 			coro.promise().myRetObject = nullptr;
 	}
 
-	void dbgAwaitingNotPlannedReturnedValueOfNoInterest() { dbgValueAvailable = true; }
-
 	typename void_type_converter<T>::type& getValue() {
 		if constexpr ( std::is_same<void, T>::value )
 			return placeholder_for_void_ret_type();
@@ -294,7 +296,9 @@ auto promise_type_struct<T>::return_value(T v) {
 	{
 		myRetObject->getValue() = v;
 		myRetObject->is_value = true;
-		myRetObject->dbgValueAvailable = true;
+#ifdef NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
+		myRetObject->immediatelyReadyOrAwaited = true;
+#endif // NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
 	}
     return std::experimental::suspend_never{};
 }
@@ -304,7 +308,9 @@ auto promise_type_struct<void>::return_void(void) {
 	if ( myRetObject != nullptr )
 	{
 		myRetObject->is_value = true;
-		myRetObject->dbgValueAvailable = true;
+#ifdef NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
+		myRetObject->immediatelyReadyOrAwaited = true;
+#endif // NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
 	}
 	return std::experimental::suspend_never{};
 }
@@ -322,6 +328,23 @@ void promise_type_struct<void>::unhandled_exception() {
 }
 
 
+#ifdef NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
+template<class T>
+void dbg_awaitingNotPlannedReturnedValueOfNoInterest( awaitable<T>& p ) { 
+	p.immediatelyReadyOrAwaited = true;
+}
+
+inline
+void dbg_awaitingNotPlannedReturnedValueOfNoInterest( awaitable<void>& p ) { 
+	p.immediatelyReadyOrAwaited = true;
+}
+#else
+template<class T> void dbg_awaitingNotPlannedReturnedValueOfNoInterest( awaitable<T>& p ) {}
+inline void dbg_awaitingNotPlannedReturnedValueOfNoInterest( awaitable<void>& p ) {}
+#endif // NODECPP_ENABLE_CHECKING_COROUTINES_AWAITED
+
+
+
 template<class ... T>
 auto wait_for_all( nodecpp::awaitable<T>& ... calls ) -> nodecpp::awaitable<std::tuple<typename nodecpp::void_type_converter<T>::type...>>
 {
diff --git a/test/experimental/test_co_await/co_await_hierarchy.cpp b/test/experimental/test_co_await/co_await_hierarchy.cpp
@@ -641,7 +641,7 @@ class page_processor_alt
 	nodecpp::awaitable<void> coro_run_no_await_admissible()
 	{
 		auto ar = complete_page_void();
-		ar.dbgAwaitingNotPlannedReturnedValueOfNoInterest();
+		dbg_awaitingNotPlannedReturnedValueOfNoInterest(ar);
 		fmt::print( "if we're here immediately, it could, in general, be wrong, but we don't care about it\n" );
 		co_return;
 	}
@@ -760,11 +760,11 @@ template<class P>
 nodecpp::awaitable<void> processing_loop_core_4_void(P& p)
 {
 	auto r1 = p.preader_0->runVoid();
-	r1.dbgAwaitingNotPlannedReturnedValueOfNoInterest();
+	dbg_awaitingNotPlannedReturnedValueOfNoInterest(r1);
 	auto r2 = p.preader_1->run2Void();
-	r2.dbgAwaitingNotPlannedReturnedValueOfNoInterest();
+	dbg_awaitingNotPlannedReturnedValueOfNoInterest(r2);
 	auto r3 = p.preader_2->run1Void(1);
-	r3.dbgAwaitingNotPlannedReturnedValueOfNoInterest();
+	dbg_awaitingNotPlannedReturnedValueOfNoInterest(r3);
 	co_return;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -641,7 +641,7 @@ class page_processor_alt`
`641`	`641`	`nodecpp::awaitable<void> coro_run_no_await_admissible()`
`642`	`642`	`{`
`643`	`643`	`auto ar = complete_page_void();`
`644`		`- ar.dbgAwaitingNotPlannedReturnedValueOfNoInterest();`
	`644`	`+ dbg_awaitingNotPlannedReturnedValueOfNoInterest(ar);`
`645`	`645`	`fmt::print( "if we're here immediately, it could, in general, be wrong, but we don't care about it\n" );`
`646`	`646`	`co_return;`
`647`	`647`	`}`
`@@ -760,11 +760,11 @@ template<class P>`
`760`	`760`	`nodecpp::awaitable<void> processing_loop_core_4_void(P& p)`
`761`	`761`	`{`
`762`	`762`	`auto r1 = p.preader_0->runVoid();`
`763`		`- r1.dbgAwaitingNotPlannedReturnedValueOfNoInterest();`
	`763`	`+ dbg_awaitingNotPlannedReturnedValueOfNoInterest(r1);`
`764`	`764`	`auto r2 = p.preader_1->run2Void();`
`765`		`- r2.dbgAwaitingNotPlannedReturnedValueOfNoInterest();`
	`765`	`+ dbg_awaitingNotPlannedReturnedValueOfNoInterest(r2);`
`766`	`766`	`auto r3 = p.preader_2->run1Void(1);`
`767`		`- r3.dbgAwaitingNotPlannedReturnedValueOfNoInterest();`
	`767`	`+ dbg_awaitingNotPlannedReturnedValueOfNoInterest(r3);`
`768`	`768`	`co_return;`
`769`	`769`	`}`
`770`	`770`