Skip to content
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.

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

feat(driver-adapters): rename "flavour" into "provider" #4512

Merged
merged 3 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 12 additions & 4 deletions query-engine/driver-adapters/src/proxy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ pub(crate) struct CommonProxy {
/// returning the number of affected rows.
execute_raw: AsyncJsFunction<Query, u32>,

/// Return the flavour for this driver.
pub(crate) flavour: String,
/// Return the provider for this driver.
pub(crate) provider: String,
}

/// This is a JS proxy for accessing the methods specific to top level
Expand Down Expand Up @@ -531,12 +531,20 @@ impl TryFrom<JSResultSet> for QuaintResultSet {

impl CommonProxy {
pub fn new(object: &JsObject) -> napi::Result<Self> {
let flavour: JsString = object.get_named_property("flavour")?;
// Background infos:
// - the provider was previously called "flavour", so we provide a temporary fallback for third-party providers
// to give them time to adapt
// - reading a named property that does not exist yields a panic, despite the `Result<_, _>` return type
let provider: JsString = if object.has_named_property("provider")? {
object.get_named_property("provider")?
} else {
object.get_named_property("flavour")?
};

Ok(Self {
query_raw: object.get_named_property("queryRaw")?,
execute_raw: object.get_named_property("executeRaw")?,
flavour: flavour.into_utf8()?.as_str()?.to_owned(),
provider: provider.into_utf8()?.as_str()?.to_owned(),
})
}

Expand Down
20 changes: 10 additions & 10 deletions query-engine/driver-adapters/src/queryable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,33 +28,33 @@ use tracing::{info_span, Instrument};
///
pub(crate) struct JsBaseQueryable {
pub(crate) proxy: CommonProxy,
pub flavour: Flavour,
pub provider: Flavour,
}

impl JsBaseQueryable {
pub(crate) fn new(proxy: CommonProxy) -> Self {
let flavour: Flavour = proxy.flavour.parse().unwrap();
Self { proxy, flavour }
let provider: Flavour = proxy.provider.parse().unwrap();
Self { proxy, provider }
}

/// visit a quaint query AST according to the flavour of the JS connector
/// visit a quaint query AST according to the provider of the JS connector
fn visit_quaint_query<'a>(&self, q: QuaintQuery<'a>) -> quaint::Result<(String, Vec<quaint::Value<'a>>)> {
match self.flavour {
match self.provider {
Flavour::Mysql => visitor::Mysql::build(q),
Flavour::Postgres => visitor::Postgres::build(q),
Flavour::Sqlite => visitor::Sqlite::build(q),
_ => unimplemented!("Unsupported flavour for JS connector {:?}", self.flavour),
_ => unimplemented!("Unsupported provider for JS connector {:?}", self.provider),
}
}

async fn build_query(&self, sql: &str, values: &[quaint::Value<'_>]) -> quaint::Result<Query> {
let sql: String = sql.to_string();

let converter = match self.flavour {
let converter = match self.provider {
Flavour::Postgres => conversion::postgres::value_to_js_arg,
Flavour::Sqlite => conversion::sqlite::value_to_js_arg,
Flavour::Mysql => conversion::mysql::value_to_js_arg,
_ => unreachable!("Unsupported flavour for JS connector {:?}", self.flavour),
_ => unreachable!("Unsupported provider for JS connector {:?}", self.provider),
};

let args = values
Expand Down Expand Up @@ -126,7 +126,7 @@ impl QuaintQueryable for JsBaseQueryable {
return Err(Error::builder(ErrorKind::invalid_isolation_level(&isolation_level)).build());
}

if self.flavour == Flavour::Sqlite {
if self.provider == Flavour::Sqlite {
return match isolation_level {
IsolationLevel::Serializable => Ok(()),
_ => Err(Error::builder(ErrorKind::invalid_isolation_level(&isolation_level)).build()),
Expand All @@ -138,7 +138,7 @@ impl QuaintQueryable for JsBaseQueryable {
}

fn requires_isolation_first(&self) -> bool {
match self.flavour {
match self.provider {
Flavour::Mysql => true,
Flavour::Postgres | Flavour::Sqlite => false,
_ => unreachable!(),
Expand Down
Loading