feat: ULID support

Cargo.toml

@@ -55,6 +55,7 @@ derive_more = "0.99.17"
 user-facing-errors = { path = "./libs/user-facing-errors" }
 uuid = { version = "1", features = ["serde", "v4", "v7", "js"] }
 cuid = { git = "https://github.com/prisma/cuid-rust", branch = "v1.3.3-wasm32-unknown-unknown" }
+ulid = "1"
 getrandom = { version = "0.2" }
 
 indoc = "2.0.1"
@@ -78,7 +79,7 @@ tsify = { version = "0.4.5" }
 
 # version for `[email protected]`, see:
 # https://github.com/rustwasm/wasm-bindgen/pull/4072/
-js-sys = { version = "0.3.70" } 
+js-sys = { version = "0.3.70" }
 
 wasm-bindgen = { version = "0.2.93" }
 wasm-bindgen-futures = { version = "0.4" }

psl/parser-database/src/attributes/default.rs

@@ -197,6 +197,9 @@ fn validate_model_builtin_scalar_type_default(
         {
             validate_empty_function_args(funcname, &funcargs.arguments, accept, ctx)
         }
+        (ScalarType::String, ast::Expression::Function(funcname, funcargs, _)) if funcname == FN_ULID => {
+            validate_empty_function_args(funcname, &funcargs.arguments, accept, ctx)
+        }
         (ScalarType::String, ast::Expression::Function(funcname, funcargs, _)) if funcname == FN_CUID => {
             validate_uid_int_args(funcname, &funcargs.arguments, &CUID_SUPPORTED_VERSIONS, accept, ctx)
         }
@@ -244,6 +247,9 @@ fn validate_composite_builtin_scalar_type_default(
 ) {
     match (scalar_type, value) {
         // Functions
+        (ScalarType::String, ast::Expression::Function(funcname, funcargs, _)) if funcname == FN_ULID => {
+            validate_empty_function_args(funcname, &funcargs.arguments, accept, ctx)
+        }
         (ScalarType::String, ast::Expression::Function(funcname, funcargs, _)) if funcname == FN_CUID => {
             validate_uid_int_args(funcname, &funcargs.arguments, &CUID_SUPPORTED_VERSIONS, accept, ctx)
         }
@@ -526,6 +532,7 @@ fn validate_builtin_scalar_list_default(
 
 const FN_AUTOINCREMENT: &str = "autoincrement";
 const FN_CUID: &str = "cuid";
+const FN_ULID: &str = "ulid";
 const FN_DBGENERATED: &str = "dbgenerated";
 const FN_NANOID: &str = "nanoid";
 const FN_NOW: &str = "now";
@@ -534,6 +541,7 @@ const FN_AUTO: &str = "auto";
 
 const KNOWN_FUNCTIONS: &[&str] = &[
     FN_AUTOINCREMENT,
+    FN_ULID,
     FN_CUID,
     FN_DBGENERATED,
     FN_NANOID,

psl/parser-database/src/walkers/scalar_field.rs

@@ -200,6 +200,11 @@ impl<'db> DefaultValueWalker<'db> {
         matches!(self.value(), ast::Expression::Function(name, _, _) if name == "autoincrement")
     }
 
+    /// Is this an `@default(cuid())`?
+    pub fn is_ulid(self) -> bool {
+        matches!(self.value(), ast::Expression::Function(name, _, _) if name == "ulid")
+    }
+
     /// Is this an `@default(cuid())`?
     pub fn is_cuid(self) -> bool {
         matches!(self.value(), ast::Expression::Function(name, _, _) if name == "cuid")

psl/psl/tests/attributes/id_positive.rs

@@ -148,6 +148,26 @@ fn should_allow_string_ids_with_uuid_version_specified() {
     }
 }
 
+#[test]
+fn should_allow_string_ids_with_ulid() {
+    let dml = indoc! {r#"
+        model Model {
+          id String @id @default(ulid())
+        }
+    "#};
+
+    let schema = psl::parse_schema(dml).unwrap();
+    let model = schema.assert_has_model("Model");
+
+    model
+        .assert_has_scalar_field("id")
+        .assert_scalar_type(ScalarType::String)
+        .assert_default_value()
+        .assert_ulid();
+
+    model.assert_id_on_fields(&["id"]);
+}
+
 #[test]
 fn should_allow_string_ids_without_default() {
     let dml = indoc! {r#"
@@ -317,10 +337,10 @@ fn id_accepts_length_arg_on_mysql() {
           firstName  String
           middleName String
           lastName   String
-         
+
           @@id([firstName, middleName(length: 1), lastName])
          }
-     
+
          model Blog {
           title  String @id(length:5)
          }
@@ -348,10 +368,10 @@ fn id_accepts_sort_arg_on_sqlserver() {
           firstName  String
           middleName String
           lastName   String
-         
+
           @@id([firstName, middleName(sort: Desc), lastName])
         }
-     
+
         model Blog {
           title  String @id(sort: Desc)
         }

psl/psl/tests/common/asserts.rs

@@ -82,6 +82,7 @@ pub(crate) trait DefaultValueAssert {
     fn assert_constant(&self, val: &str) -> &Self;
     fn assert_bytes(&self, val: &[u8]) -> &Self;
     fn assert_now(&self) -> &Self;
+    fn assert_ulid(&self) -> &Self;
     fn assert_cuid(&self) -> &Self;
     fn assert_cuid_version(&self, version: u8) -> &Self;
     fn assert_uuid(&self) -> &Self;
@@ -429,6 +430,12 @@ impl DefaultValueAssert for walkers::DefaultValueWalker<'_> {
         self
     }
 
+    #[track_caller]
+    fn assert_ulid(&self) -> &Self {
+        self.value().assert_ulid();
+        self
+    }
+
     #[track_caller]
     fn assert_cuid(&self) -> &Self {
         self.value().assert_cuid();
@@ -634,6 +641,13 @@ impl DefaultValueAssert for ast::Expression {
         self
     }
 
+    #[track_caller]
+    fn assert_ulid(&self) -> &Self {
+        assert!(matches!(self, ast::Expression::Function(name, _, _) if name == "ulid"));
+
+        self
+    }
+
     #[track_caller]
     fn assert_cuid(&self) -> &Self {
         assert!(matches!(self, ast::Expression::Function(name, _, _) if name == "cuid"));

psl/psl/tests/validation/attributes/ulid/require_string_column.prisma

@@ -0,0 +1,15 @@
+datasource db {
+  provider = "mysql"
+  url      = "does_not_matter"
+}
+
+model Category {
+  id Int @id @default(ulid())
+}
+
+// error: Error parsing attribute "@default": The function `ulid()` cannot be used on fields of type `Int`.
+//   -->  schema.prisma:7
+//    | 
+//  6 | model Category {
+//  7 |   id Int @id @default(ulid())
+//    | 

psl/psl/tests/validation/attributes/ulid/string_column_with_no_arg_valid.prisma

@@ -0,0 +1,8 @@
+datasource db {
+  provider = "mysql"
+  url      = "does_not_matter"
+}
+
+model Category {
+  id String @id @default(ulid())
+}

query-engine/connector-test-kit-rs/query-engine-tests/Cargo.toml

@@ -18,6 +18,7 @@ psl.workspace = true
 base64 = "0.13"
 uuid.workspace = true
 cuid.workspace = true
+ulid.workspace = true
 tokio.workspace = true
 user-facing-errors.workspace = true
 prisma-value = { path = "../../../libs/prisma-value" }

query-engine/connector-test-kit-rs/query-engine-tests/tests/writes/ids/uuid_create_graphql.rs

@@ -232,4 +232,57 @@ mod uuid_create_graphql {
 
         Ok(())
     }
+
+    fn schema_ulid() -> String {
+        let schema = indoc! {
+            r#"model Todo {
+                    #id(id, String, @id, @default(ulid()))
+                    title String
+                }"#
+        };
+
+        schema.to_owned()
+    }
+
+    // "Creating an item with an id field of model ULID and retrieving it" should "work"
+    #[connector_test(schema(schema_ulid))]
+    async fn create_ulid_and_retrieve_it_should_work(runner: Runner) -> TestResult<()> {
+        let res = run_query_json!(
+            &runner,
+            r#"mutation {
+                    createOneTodo(data: { title: "the title" }){
+                        id
+                    }
+                }"#
+        );
+
+        let ulid = res["data"]["createOneTodo"]["id"]
+            .as_str()
+            .expect("Expected string ID but got something else.");
+
+        // Validate that this is a valid ULID value
+        assert!(ulid::Ulid::from_string(ulid).is_ok());
+
+        // Test findMany
+        let res = run_query_json!(
+            &runner,
+            r#"query { findManyTodo(where: { title: "the title" }) { id }}"#
+        );
+        let ulid_find_many = res["data"]["findManyTodo"][0]["id"]
+            .as_str()
+            .expect("Expected string ID but got something else.");
+        assert_eq!(ulid_find_many, ulid);
+
+        // Test findUnique
+        let res = run_query_json!(
+            &runner,
+            format!(r#"query {{ findUniqueTodo(where: {{ id: "{}" }}) {{ id }} }}"#, ulid)
+        );
+        let ulid_find_unique = res["data"]["findUniqueTodo"]["id"]
+            .as_str()
+            .expect("Expected string ID but got something else.");
+        assert_eq!(ulid_find_unique, ulid);
+
+        Ok(())
+    }
 }

query-engine/connectors/sql-query-connector/Cargo.toml

@@ -49,6 +49,7 @@ tracing = { workspace = true, features = ["log"] }
 tracing-futures.workspace = true
 uuid.workspace = true
 cuid.workspace = true
+ulid.workspace = true
 quaint.workspace = true
 
 [dev-dependencies]

query-engine/core/Cargo.toml

@@ -34,6 +34,7 @@ tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 user-facing-errors = { path = "../../libs/user-facing-errors" }
 uuid.workspace = true
 cuid.workspace = true
+ulid.workspace = true
 schema = { path = "../schema" }
 crosstarget-utils = { path = "../../libs/crosstarget-utils" }
 telemetry = { path = "../../libs/telemetry" }