Feat: Bolt 6.0 (vector types) (#45)

Author: robsdedude

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ## NEXT
 ***
+**⭐️ New Features**
+ - Add Support for Bolt 6.0: vector types.
+
 **👏️ Improvements**
  - Reduce network latency in some cases by setting `TCP_NODELAY`.
  - ⚠️ Reduce the size of `Neo4jError`. The `ServerError` variant is now wrapped in a Box.

README.md

@@ -165,6 +165,9 @@ A bump in MSRV is considered a minor breaking change.
      * [x] (GQL errors)
      * [x] (new bolt version handshake)
    * [x] 5.8 (home db resolution cache)
+   * [x] 6.0
+     * [x] (vector types)
+     * [ ] (unsupported type)
  * [x] Types
    * [x] `Null`
    * [x] `Integer`

neo4j/src/driver/home_db_cache.rs

@@ -23,6 +23,7 @@ use std::time::Instant;
 
 use super::auth::AuthToken;
 use crate::value::spatial;
+use crate::value::vector;
 use crate::{value, ValueSend};
 
 #[derive(Debug)]
@@ -220,6 +221,16 @@ impl SessionAuthKey {
             ValueSend::LocalDateTime(v) => v.hash(state),
             ValueSend::DateTime(v) => v.hash(state),
             ValueSend::DateTimeFixed(v) => v.hash(state),
+            ValueSend::Vector(vector::Vector::F64(v)) => {
+                v.iter().for_each(|v| v.to_bits().hash(state))
+            }
+            ValueSend::Vector(vector::Vector::F32(v)) => {
+                v.iter().for_each(|v| v.to_bits().hash(state))
+            }
+            ValueSend::Vector(vector::Vector::I64(v)) => v.hash(state),
+            ValueSend::Vector(vector::Vector::I32(v)) => v.hash(state),
+            ValueSend::Vector(vector::Vector::I16(v)) => v.hash(state),
+            ValueSend::Vector(vector::Vector::I8(v)) => v.hash(state),
         }
     }
 }

neo4j/src/driver/io/bolt.rs

@@ -23,6 +23,7 @@ mod bolt5x4;
 mod bolt5x6;
 mod bolt5x7;
 mod bolt5x8;
+mod bolt6x0;
 mod bolt_handler;
 mod bolt_state;
 mod chunk;
@@ -64,6 +65,7 @@ use bolt5x4::{Bolt5x4, Bolt5x4StructTranslator};
 use bolt5x6::{Bolt5x6, Bolt5x6StructTranslator};
 use bolt5x7::{Bolt5x7, Bolt5x7StructTranslator};
 use bolt5x8::{Bolt5x8, Bolt5x8StructTranslator};
+use bolt6x0::{Bolt6x0, Bolt6x0StructTranslator};
 use bolt_common::ServerAwareBoltVersion;
 use bolt_handler::{
     BeginHandler, CommitHandler, DiscardHandler, GoodbyeHandler, HandleResponseHandler,
@@ -203,6 +205,7 @@ pub(crate) struct Bolt<RW: Read + Write> {
     protocol: BoltProtocol,
 }
 
+// [bolt-version-bump] search tag when changing bolt version support
 impl<RW: Read + Write> Bolt<RW> {
     fn new(
         version: (u8, u8),
@@ -211,44 +214,39 @@ impl<RW: Read + Write> Bolt<RW> {
         local_port: Option<u16>,
         address: Arc<Address>,
     ) -> Self {
-        let (protocol_version, protocol) = match version {
-            (5, 8) => (
-                ServerAwareBoltVersion::V5x8,
-                Bolt5x8::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (5, 7) => (
-                ServerAwareBoltVersion::V5x7,
-                Bolt5x7::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (5, 6) => (
-                ServerAwareBoltVersion::V5x6,
-                Bolt5x6::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (5, 4) => (
-                ServerAwareBoltVersion::V5x4,
-                Bolt5x4::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (5, 3) => (
-                ServerAwareBoltVersion::V5x3,
-                Bolt5x3::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (5, 2) => (
-                ServerAwareBoltVersion::V5x2,
-                Bolt5x2::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (5, 1) => (
-                ServerAwareBoltVersion::V5x1,
-                Bolt5x1::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (5, 0) => (
-                ServerAwareBoltVersion::V5x0,
-                Bolt5x0::<Bolt5x0StructTranslator>::default().into(),
-            ),
-            (4, 4) => (
-                ServerAwareBoltVersion::V4x4,
-                Bolt4x4::<Bolt4x4StructTranslator>::default().into(),
-            ),
-            _ => panic!("implement protocol for version {version:?}"),
+        let protocol_version = ServerAwareBoltVersion::parse(version.0, version.1)
+            .unwrap_or_else(|| panic!("implement protocol for version {version:?}"));
+        let protocol = match protocol_version {
+            ServerAwareBoltVersion::V6x0 => {
+                Bolt6x0::<Bolt6x0StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x8 => {
+                Bolt5x8::<Bolt5x8StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x7 => {
+                Bolt5x7::<Bolt5x7StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x6 => {
+                Bolt5x6::<Bolt5x6StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x4 => {
+                Bolt5x4::<Bolt5x4StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x3 => {
+                Bolt5x3::<Bolt5x3StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x2 => {
+                Bolt5x2::<Bolt5x2StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x1 => {
+                Bolt5x1::<Bolt5x1StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V5x0 => {
+                Bolt5x0::<Bolt5x0StructTranslator>::new(protocol_version).into()
+            }
+            ServerAwareBoltVersion::V4x4 => {
+                Bolt4x4::<Bolt4x4StructTranslator>::new(protocol_version).into()
+            }
         };
         let data = BoltData::new(
             version,
@@ -505,6 +503,7 @@ enum BoltProtocol {
     V5x6(Bolt5x6<Bolt5x6StructTranslator>),
     V5x7(Bolt5x7<Bolt5x7StructTranslator>),
     V5x8(Bolt5x8<Bolt5x8StructTranslator>),
+    V6x0(Bolt6x0<Bolt6x0StructTranslator>),
 }
 
 #[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
@@ -783,7 +782,9 @@ impl AuthResetHandle {
     }
 }
 
-pub(crate) trait BoltStructTranslator: Debug + Default {
+pub(crate) trait BoltStructTranslator: Debug {
+    fn new(bolt_version: ServerAwareBoltVersion) -> Self;
+
     fn serialize<S: PackStreamSerializer>(
         &self,
         serializer: &mut S,
@@ -794,6 +795,10 @@ pub(crate) trait BoltStructTranslator: Debug + Default {
 }
 
 impl<T: BoltStructTranslator> BoltStructTranslator for Arc<AtomicRefCell<T>> {
+    fn new(bolt_version: ServerAwareBoltVersion) -> Self {
+        Arc::new(AtomicRefCell::new(T::new(bolt_version)))
+    }
+
     fn serialize<S: PackStreamSerializer>(
         &self,
         serializer: &mut S,

neo4j/src/driver/io/bolt/bolt4x4/protocol.rs

@@ -17,6 +17,7 @@ use std::sync::Arc;
 
 use atomic_refcell::AtomicRefCell;
 
+use super::super::bolt_common::ServerAwareBoltVersion;
 use super::super::bolt_handler::{
     begin_5x0::BeginHandler5x0, commit_5x0::CommitHandler5x0, goodbye_5x0::GoodbyeHandler5x0,
     hello_4x4::HelloHandler4x4, impl_begin, impl_commit, impl_discard, impl_goodbye, impl_hello,
@@ -30,11 +31,19 @@ use super::super::bolt_handler::{
 };
 use super::super::BoltStructTranslatorWithUtcPatch;
 
-#[derive(Debug, Default)]
+#[derive(Debug)]
 pub(crate) struct Bolt4x4<T: BoltStructTranslatorWithUtcPatch + Sync + Send + 'static> {
     translator: Arc<AtomicRefCell<T>>,
 }
 
+impl<T: BoltStructTranslatorWithUtcPatch + Sync + Send + 'static> Bolt4x4<T> {
+    pub(crate) fn new(bolt_version: ServerAwareBoltVersion) -> Self {
+        Self {
+            translator: Arc::new(AtomicRefCell::new(T::new(bolt_version))),
+        }
+    }
+}
+
 impl_hello!((BoltStructTranslatorWithUtcPatch, Sync, Send, 'static), Bolt4x4<T>, HelloHandler4x4);
 impl_reauth!((BoltStructTranslatorWithUtcPatch, Sync, Send, 'static), Bolt4x4<T>, ReauthUnsupportedHandler);
 impl_goodbye!((BoltStructTranslatorWithUtcPatch, Sync, Send, 'static), Bolt4x4<T>, GoodbyeHandler5x0);

neo4j/src/driver/io/bolt/bolt4x4/translator.rs

@@ -19,21 +19,27 @@ use usize_cast::IntoIsize;
 
 use super::super::bolt5x0::Bolt5x0StructTranslator;
 use super::super::bolt_common::*;
-use super::super::{BoltStructTranslator, BoltStructTranslatorWithUtcPatch};
-use crate::driver::io::bolt::PackStreamSerializer;
+use super::super::{BoltStructTranslator, BoltStructTranslatorWithUtcPatch, PackStreamSerializer};
 use crate::value::graph::{Node, Path, Relationship, UnboundRelationship};
 use crate::value::time::chrono::{FixedOffset, LocalResult, Offset, TimeZone};
 use crate::value::time::chrono_tz::Tz;
 use crate::value::time::{local_date_time_from_timestamp, DateTime, DateTimeFixed};
 use crate::value::{BrokenValue, BrokenValueInner, ValueReceive, ValueSend};
 
-#[derive(Debug, Default)]
+#[derive(Debug)]
 pub(crate) struct Bolt4x4StructTranslator {
     utc_patch: bool,
     bolt5x0_translator: Bolt5x0StructTranslator,
 }
 
 impl BoltStructTranslator for Bolt4x4StructTranslator {
+    fn new(bolt_version: ServerAwareBoltVersion) -> Self {
+        Self {
+            utc_patch: false,
+            bolt5x0_translator: Bolt5x0StructTranslator::new(bolt_version),
+        }
+    }
+
     fn serialize<S: PackStreamSerializer>(
         &self,
         serializer: &mut S,

neo4j/src/driver/io/bolt/bolt5x0/protocol.rs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use super::super::bolt_common::ServerAwareBoltVersion;
 use super::super::bolt_handler::{
     begin_5x0::BeginHandler5x0, commit_5x0::CommitHandler5x0, goodbye_5x0::GoodbyeHandler5x0,
     hello_5x0::HelloHandler5x0, impl_begin, impl_commit, impl_discard, impl_goodbye, impl_hello,
@@ -30,6 +31,14 @@ pub(crate) struct Bolt5x0<T: BoltStructTranslator> {
     translator: T,
 }
 
+impl<T: BoltStructTranslator> Bolt5x0<T> {
+    pub(crate) fn new(bolt_version: ServerAwareBoltVersion) -> Self {
+        Self {
+            translator: T::new(bolt_version),
+        }
+    }
+}
+
 impl_hello!((BoltStructTranslator), Bolt5x0<T>, HelloHandler5x0);
 impl_reauth!((BoltStructTranslator), Bolt5x0<T>, ReauthUnsupportedHandler);
 impl_goodbye!((BoltStructTranslator), Bolt5x0<T>, GoodbyeHandler5x0);

neo4j/src/driver/io/bolt/bolt5x0/translator.rs

@@ -17,8 +17,7 @@ use std::collections::VecDeque;
 use usize_cast::{FromUsize, IntoIsize};
 
 use super::super::bolt_common::*;
-use super::super::BoltStructTranslator;
-use crate::driver::io::bolt::PackStreamSerializer;
+use super::super::{BoltStructTranslator, PackStreamSerializer};
 use crate::value::graph::{Node, Path, Relationship, UnboundRelationship};
 use crate::value::spatial::{
     Cartesian2D, Cartesian3D, SRID_CARTESIAN_2D, SRID_CARTESIAN_3D, SRID_WGS84_2D, SRID_WGS84_3D,
@@ -27,8 +26,10 @@ use crate::value::spatial::{
 use crate::value::time::{Date, DateTime, DateTimeFixed, Duration, LocalDateTime, LocalTime, Time};
 use crate::value::{BrokenValue, BrokenValueInner, ValueReceive, ValueSend};
 
-#[derive(Debug, Default)]
-pub(crate) struct Bolt5x0StructTranslator {}
+#[derive(Debug)]
+pub(crate) struct Bolt5x0StructTranslator {
+    bolt_version: ServerAwareBoltVersion,
+}
 
 impl Bolt5x0StructTranslator {
     fn write_2d_point<S: PackStreamSerializer>(
@@ -58,6 +59,10 @@ impl Bolt5x0StructTranslator {
 }
 
 impl BoltStructTranslator for Bolt5x0StructTranslator {
+    fn new(bolt_version: ServerAwareBoltVersion) -> Self {
+        Self { bolt_version }
+    }
+
     fn serialize<S: PackStreamSerializer>(
         &self,
         serializer: &mut S,
@@ -154,6 +159,11 @@ impl BoltStructTranslator for Bolt5x0StructTranslator {
                 serializer.write_int(tz_offset.into())?;
                 Ok(())
             }
+            ValueSend::Vector(_) => Err(serializer.error(unsupported_protocol_feature_message(
+                "vector types",
+                self.bolt_version,
+                ServerAwareBoltVersion::V6x0,
+            ))),
         }
     }
 

neo4j/src/driver/io/bolt/bolt5x1/protocol.rs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use super::super::bolt_common::ServerAwareBoltVersion;
 use super::super::bolt_handler::{
     begin_5x0::BeginHandler5x0, commit_5x0::CommitHandler5x0, goodbye_5x0::GoodbyeHandler5x0,
     hello_5x1::HelloHandler5x1, impl_begin, impl_commit, impl_discard, impl_goodbye, impl_hello,
@@ -30,6 +31,14 @@ pub(crate) struct Bolt5x1<T: BoltStructTranslator> {
     translator: T,
 }
 
+impl<T: BoltStructTranslator> Bolt5x1<T> {
+    pub(crate) fn new(bolt_version: ServerAwareBoltVersion) -> Self {
+        Self {
+            translator: T::new(bolt_version),
+        }
+    }
+}
+
 impl_hello!((BoltStructTranslator), Bolt5x1<T>, HelloHandler5x1);
 impl_reauth!((BoltStructTranslator), Bolt5x1<T>, ReauthHandler5x1);
 impl_goodbye!((BoltStructTranslator), Bolt5x1<T>, GoodbyeHandler5x0);

neo4j/src/driver/io/bolt/bolt5x2/protocol.rs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use super::super::bolt_common::ServerAwareBoltVersion;
 use super::super::bolt_handler::{
     begin_5x2::BeginHandler5x2, commit_5x0::CommitHandler5x0, goodbye_5x0::GoodbyeHandler5x0,
     hello_5x2::HelloHandler5x2, impl_begin, impl_commit, impl_discard, impl_goodbye, impl_hello,
@@ -30,6 +31,14 @@ pub(crate) struct Bolt5x2<T: BoltStructTranslator> {
     translator: T,
 }
 
+impl<T: BoltStructTranslator> Bolt5x2<T> {
+    pub(crate) fn new(bolt_version: ServerAwareBoltVersion) -> Self {
+        Self {
+            translator: T::new(bolt_version),
+        }
+    }
+}
+
 impl_hello!((BoltStructTranslator), Bolt5x2<T>, HelloHandler5x2);
 impl_reauth!((BoltStructTranslator), Bolt5x2<T>, ReauthHandler5x1);
 impl_goodbye!((BoltStructTranslator), Bolt5x2<T>, GoodbyeHandler5x0);