surrealdb 3.0.3

A scalable, distributed, collaborative, document-graph database, for the realtime web
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use std::borrow::Cow;
use std::future::IntoFuture;
use std::marker::PhantomData;

use crate::conn::Command;
use crate::method::{BoxFuture, OnceLockExt};
use crate::opt::auth::{RefreshToken, Token};
use crate::types::SurrealValue;
use crate::{Connection, Error, Result, Surreal};

/// An authentication future
#[derive(Debug)]
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct Authenticate<'r, C: Connection, T = ()> {
	pub(super) client: Cow<'r, Surreal<C>>,
	pub(super) token: Token,
	pub(super) token_type: PhantomData<T>,
}

impl<'r, Client> IntoFuture for Authenticate<'r, Client>
where
	Client: Connection,
{
	type Output = Result<Token>;
	type IntoFuture = BoxFuture<'r, Self::Output>;

	fn into_future(self) -> Self::IntoFuture {
		Box::pin(async move {
			let router = self.client.inner.router.extract()?;
			let value = router
				.execute_value(
					self.client.session_id,
					Command::Authenticate {
						token: SurrealValue::from_value(self.token.into_value())
							.map_err(|e| Error::internal(e.to_string()))?,
					},
				)
				.await?;
			Token::from_value(value).map_err(|e| Error::internal(e.to_string()))
		})
	}
}

impl<'r, Client, T> Authenticate<'r, Client, T>
where
	Client: Connection,
{
	pub fn into_owned(self) -> Authenticate<'r, Client, T> {
		Authenticate {
			client: self.client,
			token: self.token,
			token_type: PhantomData,
		}
	}
}

impl<'r, Client> Authenticate<'r, Client>
where
	Client: Connection,
{
	/// Converts this authentication future into a token refresh operation.
	///
	/// This method changes the authentication mode from standard authentication
	/// to token refresh. When awaited, the future will use the refresh token
	/// to obtain a new access token instead of authenticating with the access token.
	///
	/// # Returns
	///
	/// An `Authenticate` future configured for token refresh.
	///
	/// # Examples
	///
	/// ```ignore
	/// // Get a token from signin
	/// let token = db.signin(credentials).await?;
	///
	/// // Later, refresh the token
	/// let new_token = db.authenticate(token).refresh().await?;
	/// ```
	pub fn refresh(self) -> Authenticate<'r, Client, RefreshToken> {
		Authenticate {
			client: self.client,
			token: self.token,
			token_type: PhantomData,
		}
	}
}

impl<'r, Client> IntoFuture for Authenticate<'r, Client, RefreshToken>
where
	Client: Connection,
{
	type Output = Result<Token>;
	type IntoFuture = BoxFuture<'r, Self::Output>;

	fn into_future(self) -> Self::IntoFuture {
		Box::pin(async move {
			let router = self.client.inner.router.extract()?;
			// Validate that the token has a refresh component.
			// If not, return an error since we can't perform a refresh.
			let token = match self.token.refresh.is_some() {
				true => self.token.into_value(),
				false => {
					return Err(Error::internal("Missing refresh token".to_string()));
				}
			};
			// Execute the refresh command to obtain new tokens.
			let value = router
				.execute_value(
					self.client.session_id,
					Command::Refresh {
						token: SurrealValue::from_value(token)
							.map_err(|e| Error::internal(e.to_string()))?,
					},
				)
				.await?;
			Token::from_value(value).map_err(|e| Error::internal(e.to_string()))
		})
	}
}