surrealpatch/lib/tests/live.rs

mod helpers;
mod parse;

use helpers::new_ds;
use surrealdb::dbs::Session;
use surrealdb::err::Error;
use surrealdb::fflags::FFLAGS;
use surrealdb::sql::Value;
use surrealdb_core::dbs::Options;

#[tokio::test]
async fn live_query_fails_if_no_change_feed() -> Result<(), Error> {
	if !FFLAGS.change_feed_live_queries.enabled() {
		return Ok(());
	}
	let sql = "
		LIVE SELECT * FROM lq_test_123;
	";
	let dbs = new_ds().await?;
	let ses = Session::owner().with_ns("test").with_db("test").with_rt(true);
	let res = &mut dbs.execute(sql, &ses, None).await?;
	assert_eq!(res.len(), 1);
	let res = res.remove(0).result;
	assert!(res.is_err(), "{:?}", res);
	let err = res.as_ref().err().unwrap();
	assert_eq!(
		format!("{}", err),
		"Failed to process Live Query: The Live Query must have a change feed for it it work"
	);
	Ok(())
}

#[tokio::test]
async fn live_query_fails_if_change_feed_missing_diff() -> Result<(), Error> {
	if !FFLAGS.change_feed_live_queries.enabled() {
		return Ok(());
	}
	let sql = "
		DEFINE TABLE lq_test_123 CHANGEFEED 10m;
		LIVE SELECT * FROM lq_test_123;
	";
	let dbs = new_ds().await?;
	let ses = Session::owner().with_ns("test").with_db("test").with_rt(true);
	let res = &mut dbs.execute(sql, &ses, None).await?;
	assert_eq!(res.len(), 2);
	res.remove(0).result.unwrap();
	let res = res.remove(0).result;
	assert!(res.is_err(), "{:?}", res);
	let err = res.as_ref().err().unwrap();
	assert_eq!(
		format!("{}", err),
		"Failed to process Live Query: The Live Query must have a change feed that includes relative changes"
	);
	Ok(())
}

#[tokio::test]
async fn live_query_sends_registered_lq_details() -> Result<(), Error> {
	if !FFLAGS.change_feed_live_queries.enabled() {
		return Ok(());
	}
	let sql = "
		DEFINE TABLE lq_test_123 CHANGEFEED 10m INCLUDE ORIGINAL;
		LIVE SELECT * FROM lq_test_123;
	";
	let mut stack = reblessive::tree::TreeStack::new();
	let dbs = new_ds().await?;
	let ses = Session::owner().with_ns("test").with_db("test").with_rt(true);
	let res = &mut dbs.execute(sql, &ses, None).await?;
	assert_eq!(res.len(), 2);

	// Define table didnt fail
	let tmp = res.remove(0).result;
	assert!(tmp.is_ok());

	// Live query returned a valid uuid
	let actual = res.remove(0).result.unwrap();
	let live_id = match actual {
		Value::Uuid(live_id) => live_id,
		_ => panic!("Expected a UUID"),
	};
	assert!(!live_id.is_nil());

	// Create some data
	let res = &mut dbs.execute("CREATE lq_test_123", &ses, None).await?;
	assert_eq!(res.len(), 1);

	let result = res.remove(0);
	assert!(result.result.is_ok());

	let ctx = Default::default();
	let opt = Options::default();
	stack.enter(|stk| dbs.process_lq_notifications(stk, &ctx, &opt)).finish().await?;

	let notifications_chan = dbs.notifications().unwrap();

	assert!(notifications_chan.try_recv().is_ok());
	assert!(notifications_chan.try_recv().is_err());

	Ok(())
}

#[tokio::test]
async fn live_query_does_not_drop_notifications() -> Result<(), Error> {
	let table = "lq_test_123";
	const RUNS: u16 = 1_000;
	let define_stm = match FFLAGS.change_feed_live_queries.enabled() {
		true => format!("DEFINE TABLE {table} CHANGEFEED 10m INCLUDE ORIGINAL;"),
		false => format!("DEFINE TABLE {table};"),
	};
	let sql = format!(
		"
		{define_stm}	
		LIVE SELECT * FROM lq_test_123;
	"
	);
	let mut stack = reblessive::tree::TreeStack::new();
	let dbs = new_ds().await?;
	let ses = Session::owner().with_ns("test").with_db("test").with_rt(true);
	let res = &mut dbs.execute(&sql, &ses, None).await?;
	assert_eq!(res.len(), 2);

	// Define table didnt fail
	let tmp = res.remove(0).result;
	assert!(tmp.is_ok());

	// Live query returned a valid uuid
	let actual = res.remove(0).result.unwrap();
	let live_id = match actual {
		Value::Uuid(live_id) => live_id,
		_ => panic!("Expected a UUID"),
	};
	assert!(!live_id.is_nil());

	// Create some data
	for i in 0..RUNS {
		let test_sql = format!(
			"
		CREATE {table}:test_case_{i};
		UPDATE {table}:test_case_{i} SET name = 'test_case_{i}';
		DELETE {table}:test_case_{i};
		"
		);
		let res = &mut dbs.execute(&test_sql, &ses, None).await?;
		// All statements succeed
		let expected = 3;
		assert_eq!(res.len(), expected);
		for _ in 0..expected {
			let result = res.remove(0);
			assert!(result.result.is_ok());
		}
		// Process the notifications
		let ctx = Default::default();
		let opt = Options::default();
		stack.enter(|stk| dbs.process_lq_notifications(stk, &ctx, &opt)).finish().await?;

		let notifications_chan = dbs.notifications().unwrap();

		for case in 0..expected {
			tokio::select! {
				_ = tokio::time::sleep(tokio::time::Duration::from_millis(1000)) => {
					panic!("Timeout - Failed at run {} for case {}", i, case);
				}
				msg = notifications_chan.recv() => {
					assert!(msg.is_ok(), "Failed at run {} for case {}", i, case);
				}
			}
		}
		assert!(notifications_chan.try_recv().is_err());
	}

	Ok(())
}