♻️ refactor: convert Name struct to enum and extract to own module

- Convert Name from struct to enum with Named(String) and Unnamed variants
- Extract Name type into dedicated name.rs module for better organization
- Add From<String> and From<&str> implementations for convenient construction
- Update all usage sites to use Name::from() constructor
- Update field access from .0 to .as_str() method
- Maintain backward compatibility through re-exports and Deref trait
- Improve type safety by preventing empty named statements

Author: tobyhede

packages/cipherstash-proxy/src/postgresql/context/mod.rs

@@ -2,10 +2,7 @@ pub mod column;
 
 use super::{
     format_code::FormatCode,
-    messages::{
-        describe::{Describe, Target},
-        Name,
-    },
+    messages::{describe::Describe, Name, Target},
     Column,
 };
 use crate::{
@@ -621,7 +618,7 @@ mod tests {
 
         let mut context = Context::new(1, schema);
 
-        let name = Name("name".to_string());
+        let name = Name::from("name");
 
         context.add_statement(name.clone(), statement());
 
@@ -646,8 +643,8 @@ mod tests {
 
         let mut context = Context::new(1, schema);
 
-        let statement_name = Name("statement".to_string());
-        let portal_name = Name("portal".to_string());
+        let statement_name = Name::from("statement");
+        let portal_name = Name::from("portal");
 
         // Add statement to context
         context.add_statement(statement_name.clone(), statement());
@@ -688,8 +685,8 @@ mod tests {
         let mut context = Context::new(1, schema);
 
         // Create multiple statements
-        let statement_name_1 = Name("statement_1".to_string());
-        let statement_name_2 = Name("statement_2".to_string());
+        let statement_name_1 = Name::from("statement_1");
+        let statement_name_2 = Name::from("statement_2");
 
         // Add statements to context
         context.add_statement(statement_name_1.clone(), statement());
@@ -698,7 +695,7 @@ mod tests {
         // Replicate pipelined execution
         // Add multiple portals with the same name
         // Pointing to different statements
-        let portal_name = Name("portal".to_string());
+        let portal_name = Name::from("portal");
 
         let statement_1 = context.get_statement(&statement_name_1).unwrap();
         context.add_portal(portal_name.clone(), portal(&statement_1));
@@ -737,14 +734,14 @@ mod tests {
 
         let mut context = Context::new(1, schema);
 
-        let statement_name_1 = Name("statement_1".to_string());
+        let statement_name_1 = Name::from("statement_1");
         let portal_name_1 = Name::unnamed();
 
-        let statement_name_2 = Name("statement_2".to_string());
+        let statement_name_2 = Name::from("statement_2");
         let portal_name_2 = Name::unnamed();
 
-        let statement_name_3 = Name("statement_3".to_string());
-        let portal_name_3 = Name("portal_3".to_string());
+        let statement_name_3 = Name::from("statement_3");
+        let portal_name_3 = Name::from("portal_3");
 
         // Add statement to context
         context.add_statement(statement_name_1.clone(), statement());

packages/cipherstash-proxy/src/postgresql/frontend.rs

@@ -333,7 +333,7 @@ where
             Target::Portal => self.context.close_portal(&close.name),
             Target::Statement => {
                 self.context.close_portal(&close.name);
-                self.context.close_statement(&close.name);
+                // self.context.close_statement(&close.name);
             }
         }
         Ok(())

packages/cipherstash-proxy/src/postgresql/messages/bind.rs

@@ -227,10 +227,10 @@ impl TryFrom<&BytesMut> for Bind {
         let _len = cursor.get_i32();
 
         let portal = cursor.read_string()?;
-        let portal = Name(portal);
+        let portal = Name::from(portal);
 
         let prepared_statement = cursor.read_string()?;
-        let prepared_statement = Name(prepared_statement);
+        let prepared_statement = Name::from(prepared_statement);
 
         let num_param_format_codes = cursor.get_i16();
         let mut param_format_codes = Vec::new();

packages/cipherstash-proxy/src/postgresql/messages/close.rs

@@ -52,7 +52,7 @@ impl TryFrom<&BytesMut> for Close {
         let target = cursor.get_u8();
         let target = Target::try_from(target)?;
         let name = cursor.read_string()?;
-        let name = Name(name);
+        let name = Name::from(name);
 
         Ok(Close { target, name })
     }
@@ -64,7 +64,7 @@ impl TryFrom<Close> for BytesMut {
     fn try_from(close: Close) -> Result<BytesMut, Error> {
         let mut bytes = BytesMut::new();
 
-        let name = CString::new(close.name.0.as_str())?;
+        let name = CString::new(close.name.as_str())?;
         let name = name.as_bytes_with_nul();
 
         let len = SIZE_I32 + SIZE_U8 + name.len();
@@ -122,7 +122,7 @@ mod tests {
         let close = Close::try_from(&bytes).unwrap();
 
         assert!(matches!(close.target, Target::Statement));
-        assert_eq!(close.name.0, "stmt1");
+        assert_eq!(close.name.as_str(), "stmt1");
         assert!(!close.name.is_unnamed());
     }
 
@@ -132,13 +132,13 @@ mod tests {
 
         let close = Close {
             target: Target::Portal,
-            name: Name("portal1".to_string()),
+            name: Name::from("portal1"),
         };
 
         let bytes = BytesMut::try_from(close).unwrap();
         let parsed = Close::try_from(&bytes).unwrap();
 
         assert!(matches!(parsed.target, Target::Portal));
-        assert_eq!(parsed.name.0, "portal1");
+        assert_eq!(parsed.name.as_str(), "portal1");
     }
 }

packages/cipherstash-proxy/src/postgresql/messages/describe.rs

@@ -33,7 +33,6 @@ pub(crate) struct Describe {
     pub name: Name,
 }
 
-
 impl TryFrom<&BytesMut> for Describe {
     type Error = Error;
 
@@ -53,7 +52,7 @@ impl TryFrom<&BytesMut> for Describe {
         let target = cursor.get_u8();
         let target = Target::try_from(target)?;
         let name = cursor.read_string()?;
-        let name = Name(name);
+        let name = Name::from(name);
 
         Ok(Describe { target, name })
     }
@@ -65,7 +64,7 @@ impl TryFrom<Describe> for BytesMut {
     fn try_from(describe: Describe) -> Result<BytesMut, Error> {
         let mut bytes = BytesMut::new();
 
-        let name = CString::new(describe.name.0.as_str())?;
+        let name = CString::new(describe.name.as_str())?;
         let name = name.as_bytes_with_nul();
 
         let len = SIZE_I32 + SIZE_U8 + name.len();
@@ -78,4 +77,3 @@ impl TryFrom<Describe> for BytesMut {
         Ok(bytes)
     }
 }
-

packages/cipherstash-proxy/src/postgresql/messages/execute.rs

@@ -29,7 +29,7 @@ impl TryFrom<&BytesMut> for Execute {
         let _len = cursor.get_i32(); // read and progress cursor
 
         let portal = cursor.read_string()?;
-        let portal = Name(portal);
+        let portal = Name::from(portal);
         let max_rows = cursor.get_i32();
 
         Ok(Execute { portal, max_rows })

packages/cipherstash-proxy/src/postgresql/messages/mod.rs

@@ -9,6 +9,7 @@ pub mod data_row;
 pub mod describe;
 pub mod error_response;
 pub mod execute;
+pub mod name;
 pub mod param_description;
 pub mod parse;
 pub mod query;
@@ -18,6 +19,7 @@ pub mod target;
 pub mod terminate;
 
 // Re-export commonly used types
+pub use name::Name;
 pub use target::Target;
 
 pub const NULL: i32 = -1;
@@ -264,27 +266,6 @@ impl fmt::Display for FrontendCode {
     }
 }
 
-#[derive(Debug, Clone, Hash, Eq, PartialEq)]
-pub struct Name(pub String);
-
-impl Name {
-    pub fn unnamed() -> Name {
-        Name("".to_string())
-    }
-
-    pub fn is_unnamed(&self) -> bool {
-        self.0.is_empty()
-    }
-}
-
-impl std::ops::Deref for Name {
-    type Target = str;
-
-    fn deref(&self) -> &str {
-        self.0.as_str()
-    }
-}
-
 ///
 /// Peaks at the first byte char.
 /// Assumes that a leading `{` may be a JSON value

packages/cipherstash-proxy/src/postgresql/messages/name.rs

@@ -0,0 +1,50 @@
+#[derive(Debug, Clone, Hash, Eq, PartialEq)]
+pub enum Name {
+    Named(String),
+    Unnamed,
+}
+
+impl Name {
+    pub fn unnamed() -> Name {
+        Name::Unnamed
+    }
+
+    pub fn is_unnamed(&self) -> bool {
+        matches!(self, Name::Unnamed)
+    }
+
+    pub fn as_str(&self) -> &str {
+        match self {
+            Name::Named(s) => s,
+            Name::Unnamed => "",
+        }
+    }
+}
+
+impl std::ops::Deref for Name {
+    type Target = str;
+
+    fn deref(&self) -> &str {
+        self.as_str()
+    }
+}
+
+impl From<String> for Name {
+    fn from(s: String) -> Self {
+        if s.is_empty() {
+            Name::Unnamed
+        } else {
+            Name::Named(s)
+        }
+    }
+}
+
+impl From<&str> for Name {
+    fn from(s: &str) -> Self {
+        if s.is_empty() {
+            Name::Unnamed
+        } else {
+            Name::Named(s.to_string())
+        }
+    }
+}

packages/cipherstash-proxy/src/postgresql/messages/parse.rs

@@ -62,7 +62,7 @@ impl TryFrom<&BytesMut> for Parse {
 
         let _len = cursor.get_i32();
         let name = cursor.read_string()?;
-        let name = Name(name);
+        let name = Name::from(name);
 
         let statement = cursor.read_string()?;
         let num_params = cursor.get_i16();
@@ -89,7 +89,7 @@ impl TryFrom<Parse> for BytesMut {
     fn try_from(parse: Parse) -> Result<BytesMut, Error> {
         let mut bytes = BytesMut::new();
 
-        let name = CString::new(parse.name.0.as_str())?;
+        let name = CString::new(parse.name.as_str())?;
         let name = name.as_bytes_with_nul();
 
         let statement = CString::new(parse.statement)?;