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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
use std::{
marker::PhantomData,
pin::Pin,
task::{Context, Poll},
};
use bson::RawDocument;
use futures_core::{future::BoxFuture, Stream};
use futures_util::StreamExt;
use serde::{de::DeserializeOwned, Deserialize};
#[cfg(test)]
use tokio::sync::oneshot;
use super::{
common::{
kill_cursor,
CursorBuffer,
CursorInformation,
CursorState,
GenericCursor,
GetMoreProvider,
GetMoreProviderResult,
PinnedConnection,
},
BatchValue,
CursorStream,
};
use crate::{
bson::Document,
change_stream::event::ResumeToken,
client::options::ServerAddress,
cmap::conn::PinnedConnectionHandle,
cursor::CursorSpecification,
error::{Error, Result},
operation::GetMore,
results::GetMoreResult,
Client,
ClientSession,
};
/// A [`SessionCursor`] is a cursor that was created with a [`ClientSession`] that must be iterated
/// using one. To iterate, use [`SessionCursor::next`] or retrieve a [`SessionCursorStream`] using
/// [`SessionCursor::stream`]:
///
/// ```rust
/// # use mongodb::{bson::Document, Client, error::Result, ClientSession, SessionCursor};
/// #
/// # async fn do_stuff() -> Result<()> {
/// # let client = Client::with_uri_str("mongodb://example.com").await?;
/// # let mut session = client.start_session(None).await?;
/// # let coll = client.database("foo").collection::<Document>("bar");
/// #
/// // iterate using next()
/// let mut cursor = coll.find_with_session(None, None, &mut session).await?;
/// while let Some(doc) = cursor.next(&mut session).await.transpose()? {
/// println!("{}", doc)
/// }
///
/// // iterate using `Stream`:
/// use futures::stream::TryStreamExt;
///
/// let mut cursor = coll.find_with_session(None, None, &mut session).await?;
/// let results: Vec<_> = cursor.stream(&mut session).try_collect().await?;
/// #
/// # Ok(())
/// # }
/// ```
///
/// If a [`SessionCursor`] is still open when it goes out of scope, it will automatically be closed
/// via an asynchronous [killCursors](https://www.mongodb.com/docs/manual/reference/command/killCursors/) command executed
/// from its [`Drop`](https://doc.rust-lang.org/std/ops/trait.Drop.html) implementation.
#[derive(Debug)]
pub struct SessionCursor<T> {
client: Client,
info: CursorInformation,
state: Option<CursorState>,
drop_address: Option<ServerAddress>,
_phantom: PhantomData<T>,
#[cfg(test)]
kill_watcher: Option<oneshot::Sender<()>>,
}
impl<T> SessionCursor<T> {
pub(crate) fn new(
client: Client,
spec: CursorSpecification,
pinned: Option<PinnedConnectionHandle>,
) -> Self {
let exhausted = spec.info.id == 0;
Self {
client,
info: spec.info,
drop_address: None,
_phantom: Default::default(),
#[cfg(test)]
kill_watcher: None,
state: CursorState {
buffer: CursorBuffer::new(spec.initial_buffer),
exhausted,
post_batch_resume_token: None,
pinned_connection: PinnedConnection::new(pinned),
}
.into(),
}
}
}
impl<T> SessionCursor<T>
where
T: DeserializeOwned + Unpin + Send + Sync,
{
/// Retrieves a [`SessionCursorStream`] to iterate this cursor. The session provided must be the
/// same session used to create the cursor.
///
/// Note that the borrow checker will not allow the session to be reused in between iterations
/// of this stream. In order to do that, either use [`SessionCursor::next`] instead or drop
/// the stream before using the session.
///
/// ```
/// # use bson::{doc, Document};
/// # use mongodb::{Client, error::Result};
/// # fn main() {
/// # async {
/// # let client = Client::with_uri_str("foo").await?;
/// # let coll = client.database("foo").collection::<Document>("bar");
/// # let other_coll = coll.clone();
/// # let mut session = client.start_session(None).await?;
/// #
/// use futures::stream::TryStreamExt;
///
/// // iterate over the results
/// let mut cursor = coll.find_with_session(doc! { "x": 1 }, None, &mut session).await?;
/// while let Some(doc) = cursor.stream(&mut session).try_next().await? {
/// println!("{}", doc);
/// }
///
/// // collect the results
/// let mut cursor1 = coll.find_with_session(doc! { "x": 1 }, None, &mut session).await?;
/// let v: Vec<Document> = cursor1.stream(&mut session).try_collect().await?;
///
/// // use session between iterations
/// let mut cursor2 = coll.find_with_session(doc! { "x": 1 }, None, &mut session).await?;
/// loop {
/// let doc = match cursor2.stream(&mut session).try_next().await? {
/// Some(d) => d,
/// None => break,
/// };
/// other_coll.insert_one_with_session(doc, None, &mut session).await?;
/// }
/// # Ok::<(), mongodb::error::Error>(())
/// # };
/// # }
/// ```
pub fn stream<'session>(
&mut self,
session: &'session mut ClientSession,
) -> SessionCursorStream<'_, 'session, T> {
self.make_stream(session)
}
/// Retrieve the next result from the cursor.
/// The session provided must be the same session used to create the cursor.
///
/// Use this method when the session needs to be used again between iterations or when the added
/// functionality of `Stream` is not needed.
///
/// ```
/// # use bson::{doc, Document};
/// # use mongodb::Client;
/// # fn main() {
/// # async {
/// # let client = Client::with_uri_str("foo").await?;
/// # let coll = client.database("foo").collection::<Document>("bar");
/// # let other_coll = coll.clone();
/// # let mut session = client.start_session(None).await?;
/// let mut cursor = coll.find_with_session(doc! { "x": 1 }, None, &mut session).await?;
/// while let Some(doc) = cursor.next(&mut session).await.transpose()? {
/// other_coll.insert_one_with_session(doc, None, &mut session).await?;
/// }
/// # Ok::<(), mongodb::error::Error>(())
/// # };
/// # }
/// ```
pub async fn next(&mut self, session: &mut ClientSession) -> Option<Result<T>> {
self.stream(session).next().await
}
}
impl<T> SessionCursor<T> {
fn make_stream<'session>(
&mut self,
session: &'session mut ClientSession,
) -> SessionCursorStream<'_, 'session, T> {
let get_more_provider = ExplicitSessionGetMoreProvider::new(session);
// Pass the state into this cursor handle for iteration.
// It will be returned in the handle's `Drop` implementation.
SessionCursorStream {
generic_cursor: ExplicitSessionCursor::from_state(
self.take_state(),
self.client.clone(),
self.info.clone(),
get_more_provider,
),
session_cursor: self,
}
}
fn take_state(&mut self) -> CursorState {
self.state.take().unwrap()
}
/// Move the cursor forward, potentially triggering requests to the database for more results
/// if the local buffer has been exhausted.
///
/// This will keep requesting data from the server until either the cursor is exhausted
/// or batch with results in it has been received.
///
/// The return value indicates whether new results were successfully returned (true) or if
/// the cursor has been closed (false).
///
/// Note: [`SessionCursor::current`] and [`SessionCursor::deserialize_current`] must only be
/// called after [`SessionCursor::advance`] returned `Ok(true)`. It is an error to call
/// either of them without calling [`SessionCursor::advance`] first or after
/// [`SessionCursor::advance`] returns an error / false.
///
/// ```
/// # use mongodb::{Client, bson::Document, error::Result};
/// # async fn foo() -> Result<()> {
/// # let client = Client::with_uri_str("mongodb://localhost:27017").await?;
/// # let mut session = client.start_session(None).await?;
/// # let coll = client.database("stuff").collection::<Document>("stuff");
/// let mut cursor = coll.find_with_session(None, None, &mut session).await?;
/// while cursor.advance(&mut session).await? {
/// println!("{:?}", cursor.current());
/// }
/// # Ok(())
/// # }
/// ```
pub async fn advance(&mut self, session: &mut ClientSession) -> Result<bool> {
self.make_stream(session).generic_cursor.advance().await
}
/// Returns a reference to the current result in the cursor.
///
/// # Panics
/// [`SessionCursor::advance`] must return `Ok(true)` before [`SessionCursor::current`] can be
/// invoked. Calling [`SessionCursor::current`] after [`SessionCursor::advance`] does not return
/// true or without calling [`SessionCursor::advance`] at all may result in a panic.
///
/// ```
/// # use mongodb::{Client, bson::Document, error::Result};
/// # async fn foo() -> Result<()> {
/// # let client = Client::with_uri_str("mongodb://localhost:27017").await?;
/// # let mut session = client.start_session(None).await?;
/// # let coll = client.database("stuff").collection::<Document>("stuff");
/// let mut cursor = coll.find_with_session(None, None, &mut session).await?;
/// while cursor.advance(&mut session).await? {
/// println!("{:?}", cursor.current());
/// }
/// # Ok(())
/// # }
/// ```
pub fn current(&self) -> &RawDocument {
self.state.as_ref().unwrap().buffer.current().unwrap()
}
/// Deserialize the current result to the generic type associated with this cursor.
///
/// # Panics
/// [`SessionCursor::advance`] must return `Ok(true)` before
/// [`SessionCursor::deserialize_current`] can be invoked. Calling
/// [`SessionCursor::deserialize_current`] after [`SessionCursor::advance`] does not return
/// true or without calling [`SessionCursor::advance`] at all may result in a panic.
///
/// ```
/// # use mongodb::{Client, error::Result};
/// # async fn foo() -> Result<()> {
/// # let client = Client::with_uri_str("mongodb://localhost:27017").await?;
/// # let mut session = client.start_session(None).await?;
/// # let db = client.database("foo");
/// use serde::Deserialize;
///
/// #[derive(Debug, Deserialize)]
/// struct Cat<'a> {
/// #[serde(borrow)]
/// name: &'a str
/// }
///
/// let coll = db.collection::<Cat>("cat");
/// let mut cursor = coll.find_with_session(None, None, &mut session).await?;
/// while cursor.advance(&mut session).await? {
/// println!("{:?}", cursor.deserialize_current()?);
/// }
/// # Ok(())
/// # }
/// ```
pub fn deserialize_current<'a>(&'a self) -> Result<T>
where
T: Deserialize<'a>,
{
bson::from_slice(self.current().as_bytes()).map_err(Error::from)
}
/// Update the type streamed values will be parsed as.
pub fn with_type<'a, D>(mut self) -> SessionCursor<D>
where
D: Deserialize<'a>,
{
let out = SessionCursor {
client: self.client.clone(),
info: self.info.clone(),
state: Some(self.take_state()),
drop_address: self.drop_address.take(),
_phantom: Default::default(),
#[cfg(test)]
kill_watcher: self.kill_watcher.take(),
};
self.mark_exhausted(); // prevent a `kill_cursor` call in `drop`
out
}
pub(crate) fn address(&self) -> &ServerAddress {
&self.info.address
}
pub(crate) fn set_drop_address(&mut self, address: ServerAddress) {
self.drop_address = Some(address);
}
/// Some tests need to be able to observe the events generated by `killCommand` execution;
/// however, because that happens asynchronously on `drop`, the test runner can conclude before
/// the event is published. To fix that, tests can set a "kill watcher" on cursors - a
/// one-shot channel with a `()` value pushed after `killCommand` is run that the test can wait
/// on.
#[cfg(test)]
pub(crate) fn set_kill_watcher(&mut self, tx: oneshot::Sender<()>) {
assert!(
self.kill_watcher.is_none(),
"cursor already has a kill_watcher"
);
self.kill_watcher = Some(tx);
}
}
impl<T> SessionCursor<T> {
fn mark_exhausted(&mut self) {
self.state.as_mut().unwrap().exhausted = true;
}
pub(crate) fn is_exhausted(&self) -> bool {
self.state.as_ref().unwrap().exhausted
}
#[cfg(test)]
pub(crate) fn client(&self) -> &Client {
&self.client
}
}
impl<T> Drop for SessionCursor<T> {
fn drop(&mut self) {
if self.is_exhausted() {
return;
}
kill_cursor(
self.client.clone(),
&self.info.ns,
self.info.id,
self.state.as_ref().unwrap().pinned_connection.replicate(),
self.drop_address.take(),
#[cfg(test)]
self.kill_watcher.take(),
);
}
}
/// A `GenericCursor` that borrows its session.
/// This is to be used with cursors associated with explicit sessions borrowed from the user.
type ExplicitSessionCursor<'session, T> =
GenericCursor<ExplicitSessionGetMoreProvider<'session>, T>;
/// A type that implements [`Stream`](https://docs.rs/futures/latest/futures/stream/index.html) which can be used to
/// stream the results of a [`SessionCursor`]. Returned from [`SessionCursor::stream`].
///
/// This updates the buffer of the parent [`SessionCursor`] when dropped. [`SessionCursor::next`] or
/// any further streams created from [`SessionCursor::stream`] will pick up where this one left off.
pub struct SessionCursorStream<'cursor, 'session, T = Document> {
session_cursor: &'cursor mut SessionCursor<T>,
generic_cursor: ExplicitSessionCursor<'session, T>,
}
impl<'cursor, 'session, T> SessionCursorStream<'cursor, 'session, T>
where
T: DeserializeOwned + Unpin + Send + Sync,
{
pub(crate) fn post_batch_resume_token(&self) -> Option<&ResumeToken> {
self.generic_cursor.post_batch_resume_token()
}
pub(crate) fn client(&self) -> &Client {
&self.session_cursor.client
}
}
impl<'cursor, 'session, T> Stream for SessionCursorStream<'cursor, 'session, T>
where
T: DeserializeOwned + Unpin + Send + Sync,
{
type Item = Result<T>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
Pin::new(&mut self.generic_cursor).poll_next(cx)
}
}
impl<'cursor, 'session, T> CursorStream for SessionCursorStream<'cursor, 'session, T>
where
T: DeserializeOwned + Unpin + Send + Sync,
{
fn poll_next_in_batch(&mut self, cx: &mut Context<'_>) -> Poll<Result<BatchValue>> {
self.generic_cursor.poll_next_in_batch(cx)
}
}
impl<'cursor, 'session, T> Drop for SessionCursorStream<'cursor, 'session, T> {
fn drop(&mut self) {
// Update the parent cursor's state based on any iteration performed on this handle.
self.session_cursor.state = Some(self.generic_cursor.take_state());
}
}
/// Enum determining whether a `SessionCursorHandle` is excuting a getMore or not.
/// In charge of maintaining ownership of the session reference.
enum ExplicitSessionGetMoreProvider<'session> {
/// The handle is currently executing a getMore via the future.
///
/// This future owns the reference to the session and will return it on completion.
Executing(BoxFuture<'session, ExecutionResult<'session>>),
/// No future is being executed.
///
/// This variant needs a `MutableSessionReference` struct that can be moved in order to
/// transition to `Executing` via `take_mut`.
Idle(MutableSessionReference<'session>),
}
impl<'session> ExplicitSessionGetMoreProvider<'session> {
fn new(session: &'session mut ClientSession) -> Self {
Self::Idle(MutableSessionReference { reference: session })
}
}
impl<'session> GetMoreProvider for ExplicitSessionGetMoreProvider<'session> {
type ResultType = ExecutionResult<'session>;
type GetMoreFuture = BoxFuture<'session, ExecutionResult<'session>>;
fn executing_future(&mut self) -> Option<&mut Self::GetMoreFuture> {
match self {
Self::Executing(future) => Some(future),
Self::Idle { .. } => None,
}
}
fn clear_execution(&mut self, session: &'session mut ClientSession, _exhausted: bool) {
*self = Self::Idle(MutableSessionReference { reference: session })
}
fn start_execution(
&mut self,
info: CursorInformation,
client: Client,
pinned_connection: Option<&PinnedConnectionHandle>,
) {
take_mut::take(self, |self_| {
if let ExplicitSessionGetMoreProvider::Idle(session) = self_ {
let pinned_connection = pinned_connection.map(|c| c.replicate());
let future = Box::pin(async move {
let get_more = GetMore::new(info, pinned_connection.as_ref());
let get_more_result = client
.execute_operation(get_more, Some(&mut *session.reference))
.await;
ExecutionResult {
get_more_result,
session: session.reference,
}
});
return ExplicitSessionGetMoreProvider::Executing(future);
}
self_
});
}
fn execute(
&mut self,
info: CursorInformation,
client: Client,
pinned_connection: PinnedConnection,
) -> BoxFuture<'_, Result<GetMoreResult>> {
match self {
Self::Idle(ref mut session) => Box::pin(async move {
let get_more = GetMore::new(info, pinned_connection.handle());
client
.execute_operation(get_more, Some(&mut *session.reference))
.await
}),
Self::Executing(_fut) => Box::pin(async {
Err(Error::internal(
"streaming the cursor was cancelled while a request was in progress and must \
be continued before iterating manually",
))
}),
}
}
}
/// Struct returned from awaiting on a `GetMoreFuture` containing the result of the getMore as
/// well as the reference to the `ClientSession` used for the getMore.
struct ExecutionResult<'session> {
get_more_result: Result<GetMoreResult>,
session: &'session mut ClientSession,
}
impl<'session> GetMoreProviderResult for ExecutionResult<'session> {
type Session = &'session mut ClientSession;
fn as_ref(&self) -> std::result::Result<&GetMoreResult, &Error> {
self.get_more_result.as_ref()
}
fn into_parts(self) -> (Result<GetMoreResult>, Self::Session) {
(self.get_more_result, self.session)
}
}
/// Wrapper around a mutable reference to a `ClientSession` that provides move semantics.
/// This is used to prevent re-borrowing of the session and forcing it to be moved instead
/// by moving the wrapping struct.
struct MutableSessionReference<'a> {
reference: &'a mut ClientSession,
}