Skip to content

spanner: support automatic Session refreshes #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
cliff-openai wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

spanner: support automatic Session refreshes #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions googleapis/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ fn generate(config: prost_build::Config, out_dir: impl AsRef<std::path::Path>) {
.compile_with_config(
config,
&[
"googleapis/google/rpc/error_details.proto",
"googleapis/google/cloud/bigquery/storage/v1/storage.proto",
"googleapis/google/storage/v2/storage.proto",
"googleapis/google/pubsub/v1/pubsub.proto",
Expand Down
370 changes: 370 additions & 0 deletions googleapis/src/google.rpc.rs
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion spanner/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@ doctest = false
[dependencies]
tracing = "0.1"
prost-types = "0.14"
prost = "0.14"
tokio = "1.32"
time = { version="0.3", features = ["std", "macros", "formatting", "parsing"] }
thiserror = "2.0"
parking_lot = "0.12"
base64 = "0.22"
tokio-util = "0.7"
serde = { version = "1.0", optional = true, features = ["derive"] }
tokio-util = { version = "0.7", features = ["rt"] }
bigdecimal = { version="0.4", features=["serde"] }

token-source = "1.0"
Expand All @@ -36,6 +38,7 @@ tokio = { version="1.32", features=["rt-multi-thread"] }
tracing-subscriber = { version="0.3", features=["env-filter"] }
serial_test = "3.1"
ctor = "0.5"
tonic = { version = "0.13", default-features = false, features = ["transport"] }
google-cloud-auth = { package = "gcloud-auth", path="../foundation/auth", default-features=false, features=["rustls-tls"]}

[features]
Expand Down
231 changes: 144 additions & 87 deletions spanner/src/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ use std::time::Duration;

use google_cloud_gax::conn::{ConnectionOptions, Environment};
use google_cloud_gax::grpc::{Code, Status};
use google_cloud_gax::retry::{invoke_fn, TryAs};
use google_cloud_gax::retry::TryAs;
use google_cloud_googleapis::spanner::v1::{commit_request, transaction_options, Mutation, TransactionOptions};
use token_source::NoopTokenSourceProvider;

use crate::apiv1::conn_pool::{ConnectionManager, SPANNER};
use crate::retry::TransactionRetrySetting;
use crate::session::{ManagedSession, SessionConfig, SessionError, SessionManager};
use crate::retry::{invoke_with_session_retry, SessionRetryAction, TransactionRetrySetting};
use crate::session::{is_session_not_found_status, ManagedSession, SessionConfig, SessionError, SessionManager};
use crate::statement::Statement;
use crate::transaction::{CallOptions, QueryOptions};
use crate::transaction_ro::{BatchReadOnlyTransaction, ReadOnlyTransaction};
Expand Down Expand Up @@ -275,9 +275,20 @@ impl Client {
&self,
options: ReadOnlyTransactionOption,
) -> Result<ReadOnlyTransaction, Error> {
let session = self.get_session().await?;
let result = ReadOnlyTransaction::begin(session, options.timestamp_bound, options.call_options).await?;
Ok(result)
let timestamp_bound = options.timestamp_bound;
let call_options = options.call_options;
loop {
let session = self.get_session().await?;
match ReadOnlyTransaction::begin(session, timestamp_bound.clone(), call_options.clone()).await {
Ok(tx) => return Ok(tx),
Err(status) => {
if is_session_not_found_status(&status) {
continue;
}
return Err(Error::GRPC(status));
}
}
}
}

/// batch_read_only_transaction returns a BatchReadOnlyTransaction that can be used
Expand All @@ -297,9 +308,20 @@ impl Client {
&self,
options: ReadOnlyTransactionOption,
) -> Result<BatchReadOnlyTransaction, Error> {
let session = self.get_session().await?;
let result = BatchReadOnlyTransaction::begin(session, options.timestamp_bound, options.call_options).await?;
Ok(result)
let timestamp_bound = options.timestamp_bound;
let call_options = options.call_options;
loop {
let session = self.get_session().await?;
match BatchReadOnlyTransaction::begin(session, timestamp_bound.clone(), call_options.clone()).await {
Ok(tx) => return Ok(tx),
Err(status) => {
if is_session_not_found_status(&status) {
continue;
}
return Err(Error::GRPC(status));
}
}
}
}

/// partitioned_update executes a DML statement in parallel across the database,
Expand Down Expand Up @@ -328,30 +350,35 @@ impl Client {
stmt: Statement,
options: PartitionedUpdateOption,
) -> Result<i64, Error> {
let ro = TransactionRetrySetting::new(vec![Code::Aborted, Code::Internal]);
let session = Some(self.get_session().await?);

// reuse session
invoke_fn(
Some(ro),
|session| async {
let mut tx = match ReadWriteTransaction::begin_partitioned_dml(
session.unwrap(),
options.begin_options.clone(),
options.transaction_tag.clone(),
)
.await
{
Ok(tx) => tx,
Err(e) => return Err((Error::GRPC(e.status), Some(e.session))),
};
tx.update_with_option(stmt.clone(), options.query_options.clone().unwrap_or_default())
let helper = self.session_retry_helper(TransactionRetrySetting::new(vec![Code::Aborted, Code::Internal]));
helper
.run(|session| {
let stmt = stmt.clone();
let options = options.clone();
async move {
let mut tx = match ReadWriteTransaction::begin_partitioned_dml(
session,
options.begin_options.clone(),
options.transaction_tag.clone(),
)
.await
.map_err(|e| (Error::GRPC(e), tx.take_session()))
},
session,
)
.await
{
Ok(tx) => tx,
Err(e) => return Err(SessionRetryAction::retry(Error::GRPC(e.status), e.session)),
};
match tx
.update_with_option(stmt, options.query_options.clone().unwrap_or_default())
.await
{
Ok(rows) => Ok(rows),
Err(status) => match tx.take_session() {
Some(session) => Err(SessionRetryAction::retry(Error::GRPC(status), session)),
None => Err(SessionRetryAction::fail(Error::GRPC(status))),
},
}
}
})
.await
}

/// apply_at_least_once may attempt to apply mutations more than once; if
Expand Down Expand Up @@ -381,25 +408,24 @@ impl Client {
ms: Vec<Mutation>,
options: CommitOptions,
) -> Result<Option<CommitResult>, Error> {
let ro = TransactionRetrySetting::default();
let mut session = self.get_session().await?;

invoke_fn(
Some(ro),
|session| async {
let tx = commit_request::Transaction::SingleUseTransaction(TransactionOptions {
exclude_txn_from_change_streams: false,
mode: Some(transaction_options::Mode::ReadWrite(transaction_options::ReadWrite::default())),
isolation_level: IsolationLevel::Unspecified as i32,
});
match commit(session, ms.clone(), tx, options.clone()).await {
Ok(s) => Ok(Some(s.into())),
Err(e) => Err((Error::GRPC(e), session)),
let helper = self.session_retry_helper(TransactionRetrySetting::new(vec![Code::Aborted, Code::Internal]));
helper
.run(|mut session| {
let ms = ms.clone();
let options = options.clone();
async move {
let tx = commit_request::Transaction::SingleUseTransaction(TransactionOptions {
exclude_txn_from_change_streams: false,
mode: Some(transaction_options::Mode::ReadWrite(transaction_options::ReadWrite::default())),
isolation_level: IsolationLevel::Unspecified as i32,
});
match commit(&mut session, ms, tx, options.clone()).await {
Ok(s) => Ok(Some(s.into())),
Err(status) => Err(SessionRetryAction::retry(Error::GRPC(status), session)),
}
}
},
&mut session,
)
.await
})
.await
}

/// Apply applies a list of mutations atomically to the database.
Expand Down Expand Up @@ -526,22 +552,21 @@ impl Client {
F: for<'tx> Fn(&'tx mut ReadWriteTransaction) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send + 'tx>>,
{
let (bo, co, tag) = Client::split_read_write_transaction_option(options);

let ro = TransactionRetrySetting::default();
let session = Some(self.get_session().await?);
// must reuse session
invoke_fn(
Some(ro),
|session| async {
let mut tx = self
.create_read_write_transaction::<E>(session, bo.clone(), tag.clone())
.await?;
let result = f(&mut tx).await;
tx.finish(result, Some(co.clone())).await
},
session,
)
.await
let client = self;
let helper = self.session_retry_helper(TransactionRetrySetting::default());
helper
.run(|session| {
let bo = bo.clone();
let co = co.clone();
let tag = tag.clone();
let func = &f;
async move {
let mut tx = client.create_read_write_transaction::<E>(session, bo, tag).await?;
let result = func(&mut tx).await;
tx.finish(result, Some(co)).await.map_err(SessionRetryAction::from)
}
})
.await
}

/// begin_read_write_transaction creates new ReadWriteTransaction.
Expand Down Expand Up @@ -610,37 +635,35 @@ impl Client {
E: TryAs<Status> + From<SessionError> + From<Status>,
{
let (bo, co, tag) = Client::split_read_write_transaction_option(options);

let ro = TransactionRetrySetting::default();
let session = Some(self.get_session().await?);

// reuse session
invoke_fn(
Some(ro),
|session| async {
let mut tx = self
.create_read_write_transaction::<E>(session, bo.clone(), tag.clone())
.await?;
let result = f(&mut tx);
tx.finish(result, Some(co.clone())).await
},
session,
)
.await
let client = self;
let helper = self.session_retry_helper(TransactionRetrySetting::default());
helper
.run(|session| {
let bo = bo.clone();
let co = co.clone();
let tag = tag.clone();
let func = &f;
async move {
let mut tx = client.create_read_write_transaction::<E>(session, bo, tag).await?;
let result = func(&mut tx);
tx.finish(result, Some(co)).await.map_err(SessionRetryAction::from)
}
})
.await
}

async fn create_read_write_transaction<E>(
&self,
session: Option<ManagedSession>,
session: ManagedSession,
bo: CallOptions,
transaction_tag: Option<String>,
) -> Result<ReadWriteTransaction, (E, Option<ManagedSession>)>
) -> Result<ReadWriteTransaction, SessionRetryAction<E>>
where
E: TryAs<Status> + From<SessionError> + From<Status>,
{
ReadWriteTransaction::begin(session.unwrap(), bo, transaction_tag)
ReadWriteTransaction::begin(session, bo, transaction_tag)
.await
.map_err(|e| (E::from(e.status), Some(e.session)))
.map_err(|e| SessionRetryAction::retry(E::from(e.status), e.session))
}

async fn get_session(&self) -> Result<ManagedSession, SessionError> {
Expand All @@ -652,4 +675,38 @@ impl Client {
) -> (CallOptions, CommitOptions, Option<String>) {
(options.begin_options, options.commit_options, options.transaction_tag)
}

fn session_retry_helper(&self, retry: TransactionRetrySetting) -> SessionRetryHelper<'_> {
SessionRetryHelper {
sessions: &self.sessions,
retry,
}
}
}

struct SessionRetryHelper<'a> {
sessions: &'a Arc<SessionManager>,
retry: TransactionRetrySetting,
}

impl<'a> SessionRetryHelper<'a> {
async fn run<R, Fut, F, E>(&self, mut f: F) -> Result<R, E>
where
E: TryAs<Status> + From<SessionError> + From<Status>,
Fut: Future<Output = Result<R, SessionRetryAction<E>>>,
F: FnMut(ManagedSession) -> Fut,
{
let session = Some(self.sessions.get().await?);
invoke_with_session_retry(Some(self.retry.clone()), session, |session| {
let session = session.expect("session missing");
let fut = f(session);
async move {
match fut.await {
Ok(value) => Ok(value),
Err(action) => Err(action.into()),
}
}
})
.await
}
}
Loading