surrealdb-core 3.2.0

#![recursion_limit = "256"]
#![cfg(not(target_family = "wasm"))]

mod helpers;
use anyhow::Result;
use helpers::{new_ds, with_enough_stack};
use surrealdb_core::dbs::Session;
use surrealdb_core::syn;
use surrealdb_types::{Error as TypesError, Value};

/* Removed because of <future> removal, not yet relevant for the initial COMPUTED implementation.
 * Once we start to analyze query dependencies up front we can error on cyclic dependencies again.

#[test]
fn self_referential_field() -> Result<()> {
	// Ensure a good stack size for tests
	with_enough_stack(async {
		let mut res = run_queries(
			"
			CREATE pet:dog SET tail = <future> { tail };
			",
		)
		.await?;
		//
		assert_eq!(res.len(), 1);
		//
		let tmp = res.next().unwrap();
		let err = tmp.unwrap_err();
		assert!(
			matches!(err.downcast_ref(), Some(Error::ComputationDepthExceeded)),
			"found {:?}",
			err
		);
		//
		Ok(())
	})
}

#[test]
fn cyclic_fields() -> Result<()> {
	// Ensure a good stack size for tests
	with_enough_stack(async {
		let mut res = run_queries(
			"
			CREATE recycle SET consume = <future> { produce }, produce = <future> { consume };
			",
		)
		.await?;
		//
		assert_eq!(res.len(), 1);
		//
		let tmp = res.next().unwrap();
		let err = tmp.unwrap_err();
		assert!(
			matches!(err.downcast_ref(), Some(Error::ComputationDepthExceeded)),
			"found {:?}",
			err
		);
		//
		Ok(())
	})
}

#[test]
fn cyclic_records() -> Result<()> {
	// Ensure a good stack size for tests
	with_enough_stack(async {
		let mut res = run_queries(
			"
			CREATE thing:one SET friend = <future> { thing:two.friend };
			CREATE thing:two SET friend = <future> { thing:one.friend };
			",
		)
		.await?;
		//
		assert_eq!(res.len(), 2);
		//
		let tmp = res.next().unwrap();
		tmp.unwrap();
		//
		let tmp = res.next().unwrap();
		let err = tmp.unwrap_err();
		assert!(
			matches!(err.downcast_ref(), Some(Error::ComputationDepthExceeded)),
			"found {:?}",
			err
		);
		//
		Ok(())
	})
}

#[test]
fn ok_future_graph_subquery_recursion_depth() -> Result<()> {
	// Ensure a good stack size for tests
	with_enough_stack(async {
		let mut res = run_queries(
			r#"
			CREATE thing:three SET fut = <future> { friends[0].fut }, friends = [thing:four, thing:two];
			CREATE thing:four SET fut = <future> { (friend) }, friend = <future> { 42 };
			CREATE thing:two SET fut = <future> { friend }, friend = <future> { thing:three.fut };

			CREATE thing:one SET foo = "bar";
			RELATE thing:one->friend->thing:two SET timestamp = time::now();

			CREATE thing:zero SET foo = "baz";
			RELATE thing:zero->enemy->thing:one SET timestamp = time::now();

			SELECT * FROM (SELECT * FROM (SELECT ->enemy->thing->friend->thing.fut as fut FROM thing:zero));
			"#,
		)
		.await?;
		//
		assert_eq!(res.len(), 8);
		//
		for i in 0..7 {
			let tmp = res.next().unwrap();
			assert!(tmp.is_ok(), "Statement {} resulted in {:?}", i, tmp);
		}
		//
		let tmp = res.next().unwrap()?;
		let val = syn::value("[ { fut: [42] } ]").unwrap();
		assert_eq!(tmp, val);
		//
		Ok(())
	})
}
*/

#[test]
fn ok_graph_traversal_depth() -> Result<()> {
	// Build the SQL traversal query
	fn graph_traversal(n: usize) -> String {
		let mut ret = String::from("REMOVE TABLE IF EXISTS node;\n");
		ret.push_str("CREATE node:0;\n");
		for i in 1..=n {
			let prev = i - 1;
			ret.push_str(&format!("CREATE node:{i};\n"));
			ret.push_str(&format!("RELATE node:{prev}->edge{i}->node:{i};\n"));
		}
		ret.push_str("SELECT ");
		for i in 1..=n {
			ret.push_str(&format!("->edge{i}->node"));
		}
		ret.push_str(" AS res FROM node:0;\n");
		ret
	}
	// Test different traversal depths
	for n in 1..=40 {
		// Ensure a good stack size for tests
		with_enough_stack(async move {
			// Run the graph traversal queries
			let mut res = run_queries(&graph_traversal(n)).await;
			// Remove the last result
			let tmp = res.next_back().unwrap();
			// Check all other queries
			for r in res {
				r.unwrap();
			}
			//
			match tmp {
				Ok(res) => {
					let val = syn::value(&format!(
						"[
							{{
								res: [node:{n}],
							}}
						]"
					))
					.unwrap();
					assert_eq!(res, val);
				}
				Err(res) => {
					assert!(n > 10, "Max traversals: {}", n - 1);
					panic!("This should not happen: {res:?}");
				}
			}

			Ok(())
		})
		.unwrap();
	}

	Ok(())
}

#[test]
fn ok_cast_chain_depth() -> Result<()> {
	// Ensure a good stack size for tests
	with_enough_stack(async {
		// Run a casting query which succeeds
		let mut res = run_queries(&cast_chain(10)).await;
		//
		assert_eq!(res.len(), 1);
		//
		let tmp = res.next().unwrap()?;
		let val = Value::from_vec(vec![Value::from_int(5)]);
		assert_eq!(tmp, val);
		//
		Ok(())
	})
}

#[test]
fn excessive_cast_chain_depth() -> Result<()> {
	// Ensure a good stack size for tests
	with_enough_stack(async {
		// Run a casting query which will fail (either while parsing or executing)
		let mut res = run_queries(&cast_chain(125)).await;
		assert_eq!(res.len(), 1);
		//
		let tmp = res.next().unwrap();
		let err = tmp.unwrap_err();
		assert!(err.is_internal());
		assert_eq!(
			err.message(),
			"Reached excessive computation depth due to functions, subqueries, or computed values"
		);
		//
		Ok(())
	})
}

async fn run_queries(
	sql: &str,
) -> impl ExactSizeIterator<Item = std::result::Result<Value, TypesError>> + DoubleEndedIterator + 'static
{
	let (_, dbs) = new_ds("test", "test", false).await.expect("Failed to create new datastore");
	let ses = Session::owner().with_ns("test").with_db("test");
	dbs.execute(sql, &ses, None)
		.await
		.expect("Failed to execute query")
		.into_iter()
		.map(|res| res.result)
}

fn cast_chain(n: usize) -> String {
	let mut sql = String::from("SELECT * FROM ");
	for _ in 0..n {
		sql.push_str("<int>");
	}
	sql.push_str("5;");
	sql
}