surrealpatch/lib/src/sql/subquery.rs

use crate::ctx::Context;
use crate::dbs::Options;
use crate::dbs::Transaction;
use crate::err::Error;
use crate::sql::comment::mightbespace;
use crate::sql::ending::subquery as ending;
use crate::sql::error::IResult;
use crate::sql::serde::is_internal_serialization;
use crate::sql::statements::create::{create, CreateStatement};
use crate::sql::statements::delete::{delete, DeleteStatement};
use crate::sql::statements::ifelse::{ifelse, IfelseStatement};
use crate::sql::statements::insert::{insert, InsertStatement};
use crate::sql::statements::output::{output, OutputStatement};
use crate::sql::statements::relate::{relate, RelateStatement};
use crate::sql::statements::select::{select, SelectStatement};
use crate::sql::statements::update::{update, UpdateStatement};
use crate::sql::value::{value, Value};
use nom::branch::alt;
use nom::character::complete::char;
use nom::combinator::map;
use serde::{Deserialize, Serialize};
use std::cmp::Ordering;
use std::fmt::{self, Display, Formatter};

pub(crate) const TOKEN: &str = "$surrealdb::private::sql::Subquery";

#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Hash)]
pub enum Subquery {
	Value(Value),
	Ifelse(IfelseStatement),
	Output(OutputStatement),
	Select(SelectStatement),
	Create(CreateStatement),
	Update(UpdateStatement),
	Delete(DeleteStatement),
	Relate(RelateStatement),
	Insert(InsertStatement),
}

impl PartialOrd for Subquery {
	#[inline]
	fn partial_cmp(&self, _: &Self) -> Option<Ordering> {
		None
	}
}

impl Subquery {
	pub(crate) fn writeable(&self) -> bool {
		match self {
			Self::Value(v) => v.writeable(),
			Self::Ifelse(v) => v.writeable(),
			Self::Output(v) => v.writeable(),
			Self::Select(v) => v.writeable(),
			Self::Create(v) => v.writeable(),
			Self::Update(v) => v.writeable(),
			Self::Delete(v) => v.writeable(),
			Self::Relate(v) => v.writeable(),
			Self::Insert(v) => v.writeable(),
		}
	}

	pub(crate) async fn compute(
		&self,
		ctx: &Context<'_>,
		opt: &Options,
		txn: &Transaction,
		doc: Option<&Value>,
	) -> Result<Value, Error> {
		// Prevent deep recursion
		let opt = &opt.dive(2)?;
		// Process the subquery
		match self {
			Self::Value(ref v) => v.compute(ctx, opt, txn, doc).await,
			Self::Ifelse(ref v) => v.compute(ctx, opt, txn, doc).await,
			Self::Output(ref v) => v.compute(ctx, opt, txn, doc).await,
			Self::Select(ref v) => {
				// Is this a single output?
				let one = v.single();
				// Duplicate context
				let mut ctx = Context::new(ctx);
				// Add parent document
				if let Some(doc) = doc {
					ctx.add_value("parent".into(), doc);
				}
				// Process subquery
				match v.compute(&ctx, opt, txn, doc).await? {
					// This is a single record result
					Value::Array(mut a) if one => match a.len() {
						// There was at least one result
						v if v > 0 => Ok(a.remove(0)),
						// There were no results
						_ => Ok(Value::None),
					},
					// This is standard query result
					v => Ok(v),
				}
			}
			Self::Create(ref v) => {
				// Is this a single output?
				let one = v.single();
				// Duplicate context
				let mut ctx = Context::new(ctx);
				// Add parent document
				if let Some(doc) = doc {
					ctx.add_value("parent".into(), doc);
				}
				// Process subquery
				match v.compute(&ctx, opt, txn, doc).await? {
					// This is a single record result
					Value::Array(mut a) if one => match a.len() {
						// There was at least one result
						v if v > 0 => Ok(a.remove(0)),
						// There were no results
						_ => Ok(Value::None),
					},
					// This is standard query result
					v => Ok(v),
				}
			}
			Self::Update(ref v) => {
				// Is this a single output?
				let one = v.single();
				// Duplicate context
				let mut ctx = Context::new(ctx);
				// Add parent document
				if let Some(doc) = doc {
					ctx.add_value("parent".into(), doc);
				}
				// Process subquery
				match v.compute(&ctx, opt, txn, doc).await? {
					// This is a single record result
					Value::Array(mut a) if one => match a.len() {
						// There was at least one result
						v if v > 0 => Ok(a.remove(0)),
						// There were no results
						_ => Ok(Value::None),
					},
					// This is standard query result
					v => Ok(v),
				}
			}
			Self::Delete(ref v) => {
				// Is this a single output?
				let one = v.single();
				// Duplicate context
				let mut ctx = Context::new(ctx);
				// Add parent document
				if let Some(doc) = doc {
					ctx.add_value("parent".into(), doc);
				}
				// Process subquery
				match v.compute(&ctx, opt, txn, doc).await? {
					// This is a single record result
					Value::Array(mut a) if one => match a.len() {
						// There was at least one result
						v if v > 0 => Ok(a.remove(0)),
						// There were no results
						_ => Ok(Value::None),
					},
					// This is standard query result
					v => Ok(v),
				}
			}
			Self::Relate(ref v) => {
				// Is this a single output?
				let one = v.single();
				// Duplicate context
				let mut ctx = Context::new(ctx);
				// Add parent document
				if let Some(doc) = doc {
					ctx.add_value("parent".into(), doc);
				}
				// Process subquery
				match v.compute(&ctx, opt, txn, doc).await? {
					// This is a single record result
					Value::Array(mut a) if one => match a.len() {
						// There was at least one result
						v if v > 0 => Ok(a.remove(0)),
						// There were no results
						_ => Ok(Value::None),
					},
					// This is standard query result
					v => Ok(v),
				}
			}
			Self::Insert(ref v) => {
				// Is this a single output?
				let one = v.single();
				// Duplicate context
				let mut ctx = Context::new(ctx);
				// Add parent document
				if let Some(doc) = doc {
					ctx.add_value("parent".into(), doc);
				}
				// Process subquery
				match v.compute(&ctx, opt, txn, doc).await? {
					// This is a single record result
					Value::Array(mut a) if one => match a.len() {
						// There was at least one result
						v if v > 0 => Ok(a.remove(0)),
						// There were no results
						_ => Ok(Value::None),
					},
					// This is standard query result
					v => Ok(v),
				}
			}
		}
	}
}

impl Display for Subquery {
	fn fmt(&self, f: &mut Formatter) -> fmt::Result {
		match self {
			Self::Value(v) => write!(f, "({v})"),
			Self::Output(v) => write!(f, "({v})"),
			Self::Select(v) => write!(f, "({v})"),
			Self::Create(v) => write!(f, "({v})"),
			Self::Update(v) => write!(f, "({v})"),
			Self::Delete(v) => write!(f, "({v})"),
			Self::Relate(v) => write!(f, "({v})"),
			Self::Insert(v) => write!(f, "({v})"),
			Self::Ifelse(v) => Display::fmt(v, f),
		}
	}
}

impl Serialize for Subquery {
	fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
	where
		S: serde::Serializer,
	{
		if is_internal_serialization() {
			match self {
				Self::Value(v) => serializer.serialize_newtype_variant(TOKEN, 0, "Value", v),
				Self::Ifelse(v) => serializer.serialize_newtype_variant(TOKEN, 1, "Ifelse", v),
				Self::Output(v) => serializer.serialize_newtype_variant(TOKEN, 2, "Output", v),
				Self::Select(v) => serializer.serialize_newtype_variant(TOKEN, 3, "Select", v),
				Self::Create(v) => serializer.serialize_newtype_variant(TOKEN, 4, "Create", v),
				Self::Update(v) => serializer.serialize_newtype_variant(TOKEN, 5, "Update", v),
				Self::Delete(v) => serializer.serialize_newtype_variant(TOKEN, 6, "Delete", v),
				Self::Relate(v) => serializer.serialize_newtype_variant(TOKEN, 7, "Relate", v),
				Self::Insert(v) => serializer.serialize_newtype_variant(TOKEN, 8, "Insert", v),
			}
		} else {
			serializer.serialize_none()
		}
	}
}

pub fn subquery(i: &str) -> IResult<&str, Subquery> {
	alt((subquery_ifelse, subquery_other, subquery_value))(i)
}

fn subquery_ifelse(i: &str) -> IResult<&str, Subquery> {
	let (i, v) = map(ifelse, Subquery::Ifelse)(i)?;
	Ok((i, v))
}

fn subquery_value(i: &str) -> IResult<&str, Subquery> {
	let (i, _) = char('(')(i)?;
	let (i, _) = mightbespace(i)?;
	let (i, v) = map(value, Subquery::Value)(i)?;
	let (i, _) = mightbespace(i)?;
	let (i, _) = char(')')(i)?;
	Ok((i, v))
}

fn subquery_other(i: &str) -> IResult<&str, Subquery> {
	alt((
		|i| {
			let (i, _) = char('(')(i)?;
			let (i, _) = mightbespace(i)?;
			let (i, v) = subquery_inner(i)?;
			let (i, _) = mightbespace(i)?;
			let (i, _) = char(')')(i)?;
			Ok((i, v))
		},
		|i| {
			let (i, v) = subquery_inner(i)?;
			let (i, _) = ending(i)?;
			Ok((i, v))
		},
	))(i)
}

fn subquery_inner(i: &str) -> IResult<&str, Subquery> {
	alt((
		map(output, Subquery::Output),
		map(select, Subquery::Select),
		map(create, Subquery::Create),
		map(update, Subquery::Update),
		map(delete, Subquery::Delete),
		map(relate, Subquery::Relate),
		map(insert, Subquery::Insert),
	))(i)
}

#[cfg(test)]
mod tests {

	use super::*;

	#[test]
	fn subquery_expression_statement() {
		let sql = "(1 + 2 + 3)";
		let res = subquery(sql);
		assert!(res.is_ok());
		let out = res.unwrap().1;
		assert_eq!("(1 + 2 + 3)", format!("{}", out))
	}

	#[test]
	fn subquery_ifelse_statement() {
		let sql = "IF true THEN false END";
		let res = subquery(sql);
		assert!(res.is_ok());
		let out = res.unwrap().1;
		assert_eq!("IF true THEN false END", format!("{}", out))
	}

	#[test]
	fn subquery_select_statement() {
		let sql = "(SELECT * FROM test)";
		let res = subquery(sql);
		assert!(res.is_ok());
		let out = res.unwrap().1;
		assert_eq!("(SELECT * FROM test)", format!("{}", out))
	}
}