Updates to convex-rs

GitOrigin-RevId: d98988dc0210767115c1aca605b7ba1100594718

Author: Convex, Inc

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Upcoming
 
+# 0.5.0
+
+- Prelim support for ConvexError, encoded into an anyhow::Error. Eventual plan
+ is to expose a separate catchable type, but just getting something out
+ quickly. PRs accepted!
+
 # 0.4.0
 
 - Expose an alternate cleaner JSON export format on Value. The clean format is

Cargo.toml

@@ -2,7 +2,7 @@
 name = "convex"
 description = "Client library for Convex (convex.dev)"
 authors = [ "Convex, Inc. <team@convex.dev>" ]
-version = "0.4.0"
+version = "0.5.0"
 edition = "2021"
 rust-version = "1.65.0"
 resolver = "2"
@@ -15,13 +15,13 @@ anyhow = { version = "1" }
 async-trait = { version = "0.1" }
 base64 = { version = "0.13" }
 bytes = { version = "1.1.0" }
-convex_sync_types = { path = "./sync_types", version = "=0.4.0" }
+convex_sync_types = { path = "./sync_types", version = "=0.5.0" }
 derive_more = { version = "0.99" }
 futures = { version = "0.3" }
 imbl = { version = "2.0.0" }
 parking_lot = { optional = true, version = "0.12" }
 proptest = { optional = true, version = "1" }
-proptest-derive = { optional = true, version = "0.3.0" }
+proptest-derive = { optional = true, version = "0.4.0" }
 rand = { version = "0.8" }
 serde = { features = [ "derive" ], version = "1" }
 serde_json = { features = [ "float_roundtrip", "preserve_order" ], version = "1" }
@@ -34,14 +34,14 @@ uuid = { features = [ "serde", "v4" ], version = "1.4" }
 
 [dev-dependencies]
 colored = { version = "2" }
-convex_sync_types = { path = "./sync_types", version = "=0.4.0", features = [ "testing" ] }
+convex_sync_types = { path = "./sync_types", version = "=0.5.0", features = [ "testing" ] }
 dotenvy = { version = "0.15.7" }
 maplit = { version = "1" }
 parking_lot = { version = "0.12" }
 pretty_assertions = { version = "1" }
 proptest = { version = "1" }
-proptest-derive = { version = "0.3.0" }
-tracing-subscriber = { features = [ "env-filter" ], version = "0.3" }
+proptest-derive = { version = "0.4.0" }
+tracing-subscriber = { features = [ "env-filter" ], version = "0.3.17" }
 
 [features]
 default = [ "native-tls" ]

src/base_client/mod.rs

@@ -301,6 +301,8 @@ impl RemoteQuerySet {
  error_message,
  log_lines: _,
  journal: _,
+ // TODO @srb: Implement ConvexError in Rust client queries
+ error_data: _,
  } => {
  self.remote_query_set
  .insert(query_id, FunctionResult::ErrorMessage(error_message));

src/base_client/query_result.rs

@@ -1,4 +1,7 @@
-use convex_sync_types::QueryId;
+use convex_sync_types::{
+ types::ErrorPayload,
+ QueryId,
+};
 use imbl::{
  OrdMap,
  OrdSet,
@@ -19,20 +22,22 @@ pub enum FunctionResult {
  ErrorMessage(String),
 }
 
-impl From<Result<Value, String>> for FunctionResult {
- fn from(result: Result<Value, String>) -> Self {
+impl From<Result<Value, ErrorPayload<Value>>> for FunctionResult {
+ fn from(result: Result<Value, ErrorPayload<Value>>) -> Self {
  match result {
  Ok(value) => FunctionResult::Value(value),
- Err(error) => FunctionResult::ErrorMessage(error),
+ // TODO @srb: Implement ConvexError in Rust client
+ Err(error) => FunctionResult::ErrorMessage(error.get_message().to_owned()),
  }
  }
 }
 
-impl From<FunctionResult> for Result<Value, String> {
+impl From<FunctionResult> for Result<Value, ErrorPayload<Value>> {
  fn from(result: FunctionResult) -> Self {
  match result {
  FunctionResult::Value(value) => Ok(value),
- FunctionResult::ErrorMessage(error) => Err(error),
+ // TODO @srb: Implement ConvexError in Rust client
+ FunctionResult::ErrorMessage(error) => Err(ErrorPayload::Message(error)),
  }
  }
 }

src/value/export/mod.rs

@@ -9,8 +9,8 @@ use crate::Value;
 pub mod roundtrip;
 
 impl Value {
- /// Converts this value to a JSON value that is more convenient to work with
- /// than the internal representation.
+ /// Converts this value to a JSON value in the `json` export format.
+ /// <https://docs.convex.dev/database/types>
  ///
  /// It is possible for distinct Convex values to be serialized to the same
  /// JSON value by this method. For instance, strings and binary values are

sync_types/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "convex_sync_types"
 description = "Sync types for the Convex Websocket protocol (convex.dev)"
-version = "0.4.0"
+version = "0.5.0"
 authors = [ "Convex, Inc. <team@convex.dev>" ]
 edition = "2021"
 rust-version = "1.65.0"
@@ -15,15 +15,15 @@ anyhow = { version = "1" }
 base64 = { version = "0.13" }
 derive_more = { version = "0.99" }
 proptest = { optional = true, version = "1" }
-proptest-derive = { optional = true, version = "0.3.0" }
+proptest-derive = { optional = true, version = "0.4.0" }
 rand = { version = "0.8" }
 serde = { features = [ "derive" ], version = "1" }
 serde_json = { features = [ "float_roundtrip", "preserve_order" ], version = "1" }
 uuid = { features = [ "serde", "v4" ], version = "1.4" }
 
 [dev-dependencies]
 proptest = { version = "1" }
-proptest-derive = { version = "0.3.0" }
+proptest-derive = { version = "0.4.0" }
 
 [features]
 testing = [ "proptest", "proptest-derive" ]

sync_types/src/identifier.rs

@@ -1,5 +1,3 @@
-use anyhow::bail;
-
 pub const MAX_IDENTIFIER_LEN: usize = 64;
 
 pub const IDENTIFIER_REQUIREMENTS: &str =
@@ -24,33 +22,45 @@ pub const IDENTIFIER_REQUIREMENTS: &str =
 /// [3]: <https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5B%3AXID_START%3A%5D&g=&i=>
 /// [4]: <https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5B%3AXID_CONTINUE%3A%5D&g=&i=>
 pub fn check_valid_identifier(s: &str) -> anyhow::Result<()> {
+ check_valid_identifier_inner(s).map_err(|e| anyhow::anyhow!(e))
+}
+
+pub fn is_valid_identifier(s: &str) -> bool {
+ check_valid_identifier_inner(s).is_ok()
+}
+
+fn check_valid_identifier_inner(s: &str) -> Result<(), String> {
  let mut chars = s.chars();
  match chars.next() {
  Some(c) if c.is_ascii_alphabetic() => (),
  Some('_') => (),
- Some(c) => bail!(
- "Invalid first character '{c}' in {s}: Identifiers must start with an alphabetic \
- character or underscore"
- ),
- None => bail!("Identifier cannot be empty"),
+ Some(c) => {
+ return Err(format!(
+ "Invalid first character '{c}' in {s}: Identifiers must start with an alphabetic \
+ character or underscore"
+ ))
+ },
+ None => return Err(format!("Identifier cannot be empty")),
  };
  for c in chars {
  if !c.is_ascii_alphanumeric() && c != '_' {
- bail!(
+ return Err(format!(
  "Identifier {s} has invalid character '{c}': Identifiers can only contain \
  alphanumeric characters or underscores"
- );
+ ));
  }
  }
  if s.len() > MAX_IDENTIFIER_LEN {
- bail!(
+ return Err(format!(
  "Identifier is too long ({} > maximum {})",
  s.len(),
  MAX_IDENTIFIER_LEN
- );
+ ));
  }
  if s.chars().all(|c| c == '_') {
- bail!("Identifier {s} cannot have exclusively underscores");
+ return Err(format!(
+ "Identifier {s} cannot have exclusively underscores"
+ ));
  }
  Ok(())
 }
@@ -64,33 +74,45 @@ pub const MAX_FIELD_NAME_LENGTH: usize = 1024;
 /// Field names cannot start with '$', must contain only non-control ASCII
 /// characters, and must be at most 1024 characters long.
 pub fn check_valid_field_name(s: &str) -> anyhow::Result<()> {
+ check_valid_field_name_inner(s).map_err(|e| anyhow::anyhow!(e))
+}
+
+pub fn is_valid_field_name(s: &str) -> bool {
+ check_valid_field_name_inner(s).is_ok()
+}
+
+fn check_valid_field_name_inner(s: &str) -> Result<(), String> {
  let mut chars = s.chars();
  match chars.next() {
- Some('$') => bail!("Field name {s} starts with '$', which is reserved."),
+ Some('$') => {
+ return Err(format!(
+ "Field name {s} starts with '$', which is reserved."
+ ))
+ },
  Some(c) => {
  if !c.is_ascii() || c.is_ascii_control() {
- bail!(
+ return Err(format!(
  "Field name {s} has invalid character '{c}': Field names can only contain \
  non-control ASCII characters"
- );
+ ));
  }
  },
- None => bail!("Field name cannot be empty"),
+ None => return Err(format!("Field name cannot be empty")),
  };
  for c in chars {
  if !c.is_ascii() || c.is_ascii_control() {
- bail!(
+ return Err(format!(
  "Field name {s} has invalid character '{c}': Field names can only contain \
  non-control ASCII characters"
- );
+ ));
  }
  }
  if s.len() > MAX_FIELD_NAME_LENGTH {
- bail!(
+ return Err(format!(
  "Field name is too long ({} > maximum {})",
  s.len(),
  MAX_FIELD_NAME_LENGTH
- );
+ ));
  }
  Ok(())
 }