feat(inspect): add inspect for all types

also add `double` custom type

Signed-off-by: Daniel Boll <danielboll.academico@gmail.com>

Author: Daniel-Boll

examples/custom-types/double.mts

@@ -0,0 +1,24 @@
+import { Cluster, Double } from "../../index.js";
+
+const nodes = process.env.CLUSTER_NODES?.split(",") ?? ["127.0.0.1:9042"];
+
+console.log(`Connecting to ${nodes}`);
+
+const cluster = new Cluster({ nodes });
+const session = await cluster.connect();
+
+await session.execute(
+  "CREATE KEYSPACE IF NOT EXISTS double WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 }",
+);
+await session.useKeyspace("double");
+
+await session.execute(
+  "CREATE TABLE IF NOT EXISTS double (a double, primary key (a))",
+);
+
+const input = new Double(1.1127830921);
+const _ = await session.execute("INSERT INTO double (a) VALUES (?)", [input]);
+console.log(_);
+
+const results = await session.execute("SELECT a FROM double");
+console.log(`${input} -> ${results[0].a}`);

examples/custom-types/floats.mts

@@ -16,7 +16,8 @@ await session.execute(
   "CREATE TABLE IF NOT EXISTS floats (a float, primary key (a))",
 );
 
-await session.execute("INSERT INTO floats (a) VALUES (?)", [new Float(1.1)]);
+const input = new Float(1.1127830921);
+await session.execute("INSERT INTO floats (a) VALUES (?)", [input]);
 
 const results = await session.execute("SELECT a FROM floats");
-console.log(results);
+console.log(`${input} -> ${results[0].a}`);

index.d.ts

@@ -38,6 +38,17 @@ export declare class Decimal {
   toString(): string
 }
 
+/**
+ * A double precision float number.
+ *
+ * Due to the nature of numbers in JavaScript, it's hard to distinguish between integers and floats, so this type is used to represent
+ * double precision float numbers while any other JS number will be treated as an integer. (This is not the case for BigInts, which are always treated as BigInts).
+ */
+export declare class Double {
+  constructor(inner: number)
+  toString(): string
+}
+
 export declare class Duration {
   months: number
   days: number
@@ -55,16 +66,19 @@ export declare class Duration {
  */
 export declare class Float {
   constructor(inner: number)
+  toString(): string
 }
 
 /** A list of any CqlType */
 export declare class List<T = NativeTypes> {
   constructor(values: T[])
+  toString(): string
 }
 
 /** A map of any CqlType to any CqlType */
 export declare class Map<T = NativeTypes, U = NativeTypes> {
   constructor(values: Array<Array<T | U>>)
+  toString(): string
 }
 
 export declare class Metrics {
@@ -242,6 +256,7 @@ export declare class ScyllaSession {
 /** A list of any CqlType */
 export declare class Set<T = NativeTypes> {
   constructor(values: T[])
+  toString(): string
 }
 
 export declare class Uuid {
@@ -272,6 +287,7 @@ export declare class Uuid {
  */
 export declare class Varint {
   constructor(inner: Array<number>)
+  toString(): string
 }
 
 export interface Auth {

index.js

@@ -366,6 +366,7 @@ module.exports.ScyllaBatchStatement = nativeBinding.ScyllaBatchStatement
 module.exports.Cluster = nativeBinding.Cluster
 module.exports.ScyllaCluster = nativeBinding.ScyllaCluster
 module.exports.Decimal = nativeBinding.Decimal
+module.exports.Double = nativeBinding.Double
 module.exports.Duration = nativeBinding.Duration
 module.exports.Float = nativeBinding.Float
 module.exports.List = nativeBinding.List
@@ -387,4 +388,10 @@ const customInspectSymbol = Symbol.for('nodejs.util.inspect.custom')
 
 nativeBinding.Uuid.prototype[customInspectSymbol]     = function () { return this.toString(); }
 nativeBinding.Duration.prototype[customInspectSymbol] = function () { return this.toString(); }
-nativeBinding.Decimal.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Decimal.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Float.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Double.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.List.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Set.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Map.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Varint.prototype[customInspectSymbol]  = function () { return this.toString(); }

scripts/fix-files.mjs

@@ -31,6 +31,12 @@ const customInspectSymbol = Symbol.for('nodejs.util.inspect.custom')
 nativeBinding.Uuid.prototype[customInspectSymbol]     = function () { return this.toString(); }
 nativeBinding.Duration.prototype[customInspectSymbol] = function () { return this.toString(); }
 nativeBinding.Decimal.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Float.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Double.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.List.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Set.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Map.prototype[customInspectSymbol]  = function () { return this.toString(); }
+nativeBinding.Varint.prototype[customInspectSymbol]  = function () { return this.toString(); }
 `,
       )
       .trim(),

src/helpers/cql_value_bridge.rs

@@ -1,24 +1,24 @@
-use napi::bindgen_prelude::{BigInt, Either13, Either14};
+use napi::bindgen_prelude::{BigInt, Either14, Either15};
 use scylla::frame::response::result::CqlValue;
 
 use std::collections::HashMap;
 
 use crate::types::{
-  decimal::Decimal, duration::Duration, float::Float, list::List, map::Map, set::Set, uuid::Uuid,
-  varint::Varint,
+  decimal::Decimal, double::Double, duration::Duration, float::Float, list::List, map::Map,
+  set::Set, uuid::Uuid, varint::Varint,
 };
 
 use super::to_cql_value::ToCqlValue;
 
 macro_rules! define_expected_type {
     ($lifetime:lifetime, $($t:ty),+) => {
-      pub type ParameterNativeTypes<$lifetime> = Either13<$($t),+>;
-      pub type ParameterWithMapType<$lifetime> = Either14<$($t),+, HashMap<String, ParameterNativeTypes<$lifetime>>>;
+      pub type ParameterNativeTypes<$lifetime> = Either14<$($t),+>;
+      pub type ParameterWithMapType<$lifetime> = Either15<$($t),+, HashMap<String, ParameterNativeTypes<$lifetime>>>;
       pub type JSQueryParameters<$lifetime> = napi::Result<Vec<HashMap<String, ParameterWithMapType<$lifetime>>>>;
     };
 }
 
-define_expected_type!('a, u32, String, &'a Uuid, BigInt, &'a Duration, &'a Decimal, bool, Vec<u32>, &'a Float, &'a Varint, &'a List, &'a Set, &'a Map);
+define_expected_type!('a, u32, String, &'a Uuid, BigInt, &'a Duration, &'a Decimal, bool, Vec<u32>, &'a Float, &'a Varint, &'a List, &'a Set, &'a Map, &'a Double);
 
 impl<'a> ToCqlValue for ParameterWithMapType<'a> {
   fn to_cql_value(&self) -> CqlValue {
@@ -36,7 +36,8 @@ impl<'a> ToCqlValue for ParameterWithMapType<'a> {
       ParameterWithMapType::K(list) => list.to_cql_value(),
       ParameterWithMapType::L(set) => set.to_cql_value(),
       ParameterWithMapType::M(map) => map.to_cql_value(),
-      ParameterWithMapType::N(map) => CqlValue::UserDefinedType {
+      ParameterWithMapType::N(double) => double.to_cql_value(),
+      ParameterWithMapType::O(map) => CqlValue::UserDefinedType {
         // TODO: think a better way to fill this info here
         keyspace: "keyspace".to_string(),
         type_name: "type_name".to_string(),
@@ -65,6 +66,7 @@ impl<'a> ToCqlValue for ParameterNativeTypes<'a> {
       ParameterNativeTypes::K(list) => list.to_cql_value(),
       ParameterNativeTypes::L(set) => set.to_cql_value(),
       ParameterNativeTypes::M(map) => map.to_cql_value(),
+      ParameterNativeTypes::N(double) => double.to_cql_value(),
     }
   }
 }

src/helpers/to_cql_value.rs

@@ -2,8 +2,8 @@ use napi::bindgen_prelude::BigInt;
 use scylla::frame::response::result::CqlValue;
 
 use crate::types::{
-  decimal::Decimal, duration::Duration, float::Float, list::List, map::Map, set::Set, uuid::Uuid,
-  varint::Varint,
+  decimal::Decimal, double::Double, duration::Duration, float::Float, list::List, map::Map,
+  set::Set, uuid::Uuid, varint::Varint,
 };
 
 // Trait to abstract the conversion to CqlValue
@@ -60,6 +60,12 @@ impl ToCqlValue for &Float {
   }
 }
 
+impl ToCqlValue for &Double {
+  fn to_cql_value(&self) -> CqlValue {
+    CqlValue::Double((*self).into())
+  }
+}
+
 impl ToCqlValue for &Varint {
   fn to_cql_value(&self) -> CqlValue {
     CqlValue::Varint((*self).into())

src/types/double.rs

@@ -0,0 +1,35 @@
+/// A double precision float number.
+///
+/// Due to the nature of numbers in JavaScript, it's hard to distinguish between integers and floats, so this type is used to represent
+/// double precision float numbers while any other JS number will be treated as an integer. (This is not the case for BigInts, which are always treated as BigInts).
+#[napi]
+#[derive(Debug, Copy, Clone, PartialEq)]
+pub struct Double {
+  pub(crate) inner: f64,
+}
+
+impl From<f64> for Double {
+  fn from(inner: f64) -> Self {
+    Self { inner }
+  }
+}
+
+impl From<&Double> for f64 {
+  fn from(float: &Double) -> Self {
+    float.inner
+  }
+}
+
+#[napi]
+impl Double {
+  #[napi(constructor)]
+  pub fn new_float(inner: f64) -> Double {
+    Double::from(inner)
+  }
+
+  #[napi]
+  #[allow(clippy::inherent_to_string)]
+  pub fn to_string(&self) -> String {
+    self.inner.to_string()
+  }
+}

src/types/float.rs

@@ -5,31 +5,31 @@
 #[napi]
 #[derive(Debug, Copy, Clone, PartialEq)]
 pub struct Float {
-  pub(crate) inner: f64,
+  pub(crate) inner: f32,
 }
 
-impl From<f64> for Float {
-  fn from(inner: f64) -> Self {
+impl From<f32> for Float {
+  fn from(inner: f32) -> Self {
     Self { inner }
   }
 }
 
-impl From<Float> for f64 {
-  fn from(float: Float) -> Self {
-    float.inner
-  }
-}
-
 impl From<&Float> for f32 {
   fn from(float: &Float) -> Self {
-    float.inner as f32
+    float.inner
   }
 }
 
 #[napi]
 impl Float {
   #[napi(constructor)]
   pub fn new_float(inner: f64) -> Float {
-    Float::from(inner)
+    Float::from(inner as f32)
+  }
+
+  #[napi]
+  #[allow(clippy::inherent_to_string)]
+  pub fn to_string(&self) -> String {
+    self.inner.to_string()
   }
 }

src/types/list.rs

@@ -34,4 +34,10 @@ impl List {
     let inner = values.into_iter().map(|v| v.to_cql_value()).collect();
     List { inner }
   }
+
+  #[napi]
+  #[allow(clippy::inherent_to_string)]
+  pub fn to_string(&self) -> String {
+    format!("{:?}", self.inner)
+  }
 }