From f0e6ac4eb5258a937f0d50a926d8330162b30377 Mon Sep 17 00:00:00 2001
From: Alberto Schiabel <jkomyno@users.noreply.github.com>
Date: Fri, 1 Dec 2023 18:08:59 +0100
Subject: [PATCH] feat(driver-adapters): rename "flavour" into "provider"
 (#4512)

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

* feat(driver-adapters): fallback to \"flavour\" for `prisma@5.7.0`

Co-authored-by: Serhii Tatarintsev <tatarintsev@prisma.io>

* chore(driver-adapters): fixed panic on CommonProxy's fallback

---------

Co-authored-by: Serhii Tatarintsev <tatarintsev@prisma.io>
---
 query-engine/driver-adapters/src/proxy.rs     | 16 +++++++++++----
 query-engine/driver-adapters/src/queryable.rs | 20 +++++++++----------
 2 files changed, 22 insertions(+), 14 deletions(-)

diff --git a/query-engine/driver-adapters/src/proxy.rs b/query-engine/driver-adapters/src/proxy.rs
index 19693453988e..6ce12c5bca42 100644
--- a/query-engine/driver-adapters/src/proxy.rs
+++ b/query-engine/driver-adapters/src/proxy.rs
@@ -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
@@ -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(),
         })
     }
 
diff --git a/query-engine/driver-adapters/src/queryable.rs b/query-engine/driver-adapters/src/queryable.rs
index ab154eccc139..728bceed698f 100644
--- a/query-engine/driver-adapters/src/queryable.rs
+++ b/query-engine/driver-adapters/src/queryable.rs
@@ -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
@@ -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()),
@@ -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!(),