feat(psl, query-engine, schema-engine): add `cuid(2)` support, fix `uuid(7)` #5047

jkomyno · 2024-11-15T18:46:14Z

This PR:

Closes Make cuid2 available in @default prisma#17102
Adds cuid(2) support
Deprecates feat(core): add cuid2 default generator #4218
~~Deprecates https://github.com/prisma/cuid-rust, as wasm32-unknown-unknown support is already provided by [email protected]. cuid is also now installed as a crate at the workspace level.~~
[Breaking] Serialise @default(uuid(4)) as { "default": { "name": "uuid", "args": [4] }} rather than { "default": { "name": "uuid(4)", "args": [] }} in DMMF
[Breaking] Serialise @default(uuid(7)) as { "default": { "name": "uuid", "args": [7] }} rather than { "default": { "name": "uuid(7)", "args": [] }} in DMMF
Cleans up DMMF serialisation of ID generators
Improves tests after uuid(7) was introduced via Add support for UUIDv7 #4877
Fixes re-introspection for uuid (uuid(7) was re-introspected by the Schema Engine as uuid(), which defaults to uuid(4) when using the Query Engine at runtime)
Adds new tests for cuid and uuid

I originally tried to deprecate https://github.com/prisma/cuid-rust, as wasm32-unknown-unknown support was allegedly already provided by [email protected]. However, that resulted in runtime panics when running the driver-adapters (wasm) test suite, specifically when on std::process::id() (e.g., here) and std::time::SystemTime::now() (e.g., here).
I've thus created another fork branch of the latest cuid version in the v1.3.3-wasm32-unknown-unknown branch (see diff).

Some notes for docs writers:

@default(cuid()) is interpreted as @default(cuid(1)), so we keep generating cuid v1 by default, as usual.
@default(uuid()) is interpreted as @default(uuid(4)), so we keep generating UUID v4 by default, as usual.

Example cuid(1): "cm3rpdbhn0001w10gi9au8cul" (25 chars)
Example cuid(2): "u8yjmh700jcegr5oi3onij1u" (24 chars)

codspeed-hq · 2024-11-15T18:53:33Z

CodSpeed Performance Report

Merging #5047 will not alter performance

_{Comparing feat/cuid2-support (bd42901) with main (90c6eb3)}

Summary

✅ 11 untouched benchmarks

github-actions · 2024-11-15T18:54:05Z

WASM Query Engine file Size

Engine	This PR	Base branch	Diff
Postgres	2.044MiB	2.038MiB	6.291KiB
Postgres (gzip)	820.489KiB	818.840KiB	1.649KiB
Mysql	2.010MiB	2.001MiB	8.866KiB
Mysql (gzip)	806.673KiB	804.595KiB	2.079KiB
Sqlite	1.907MiB	1.900MiB	6.850KiB
Sqlite (gzip)	766.352KiB	765.015KiB	1.337KiB

jkomyno · 2024-11-15T19:28:18Z

query-engine/dmmf/src/ast_builders/datamodel_ast_builder.rs

@@ -310,7 +310,7 @@ fn prisma_value_to_serde(value: &PrismaValue) -> serde_json::Value {
        PrismaValue::Float(val) => {
            serde_json::Value::Number(serde_json::Number::from_f64(val.to_f64().unwrap()).unwrap())
        }
-        PrismaValue::Int(val) => serde_json::Value::Number(serde_json::Number::from_f64(*val as f64).unwrap()),
+        PrismaValue::Int(val) => serde_json::Value::Number(serde_json::Number::from(*val)),


This was with all likelihood a bug introduced in 34219a9.

psl/psl/tests/common/asserts.rs

…uite

…riented fork with cuid 1.3.3

… IDs

… into feat/cuid2-support

jkomyno · 2024-11-19T17:23:11Z

query-engine/core/src/interactive_transactions/mod.rs

@@ -16,8 +16,7 @@ pub struct TxId(String);

 impl Default for TxId {
    fn default() -> Self {
-        #[allow(deprecated)]
-        Self(cuid::cuid().unwrap())
+        Self(cuid::cuid2())


As discussed with @aqrln, we're now using cuid2 for interactive transaction IDs (internal API).

aqrln

amazing work 💯

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

psl/parser-database/src/generators.rs

psl/psl/tests/common/asserts.rs

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

query-engine/query-structure/src/default_value.rs

aqrln · 2024-11-20T17:49:16Z

@jkomyno heads up: some tests are failing with queries returning different results (could be something sensitive to ordering I guess)

…cuid

jkomyno · 2024-11-21T00:33:44Z

query-engine/dmmf/test_files/functions.prisma

+  id             Int      @id
+  createdAt      DateTime @default(now())
+  someCuid       String   @default(cuid())    @unique
+  someCuid1      String   @default(cuid(1))   @unique
+  someCuid2      String   @default(cuid(2))   @unique
+  someUuid       String   @default(uuid())    @unique
+  someUuid4      String   @default(uuid(4))   @unique
+  someUuid7      String   @default(uuid(7))   @unique
+  someNanoid     String   @default(nanoid())  @unique
+  someNanoidLen6 String   @default(nanoid(6)) @unique


Note: this is the Prisma schema file for

prisma-engines/query-engine/dmmf/src/ast_builders/datamodel_ast_builder.rs

Lines 355 to 378 in 04af8ad

#[test]

fn test_dmmf_rendering() {

let test_cases = fs::read_dir(SAMPLES_FOLDER_PATH)

.unwrap()

.map(|entry| entry.unwrap().file_name().into_string().unwrap())

.filter(|name| name.ends_with(".prisma"))

.map(|name| name.trim_end_matches(".prisma").to_owned());

for test_case in test_cases {

println!("TESTING: {test_case}");

let datamodel_string = load_from_file(format!("{test_case}.prisma").as_str());

let dmmf_string = render_to_dmmf(&datamodel_string);

if std::env::var("UPDATE_EXPECT") == Ok("1".into()) {

save_to_file(&format!("{test_case}.json"), &dmmf_string);

}

let expected_json = load_from_file(format!("{test_case}.json").as_str());

println!("{dmmf_string}");

assert_eq_json(&dmmf_string, &expected_json, &test_case);

}

}

, whose dmmf is serialised in the JSON snapshot above (query-engine/dmmf/test_files/functions.json).

A convenient way to update the dmmf snapshots is:

UPDATE_EXPECT=1 cargo test --package dmmf --features psl/all --lib -- --show-output

jkomyno · 2024-11-21T00:35:26Z

query-engine/query-structure/src/default_value.rs

-    pub fn new_cuid() -> Self {
-        ValueGenerator::new("cuid".to_owned(), vec![]).unwrap()
+    pub fn new_cuid(version: u8) -> Self {
+        ValueGenerator::new("cuid".to_owned(), vec![(None, PrismaValue::Int(version as i64))]).unwrap()


The first Option<String> argument of the tuple in Vec<> seems to be totally useless, btw. This is something we can clean up before Prisma 6

query-engine/dmmf/test_files/functions.json

…tors

`#!/bin/bash` is non-portable and only works on some systems which has bash in that location, which is not actually standard or necessarily expected. The only two absolute paths one can rely on in portable scripts are `#!/bin/sh` (which is a POSIX standard) and `#!/usr/bin/env` (which is not technically mandated by a formal standard but is de-facto implemented on all Unix systems). None of my systems have a usable bash installation in `/bin/bash`. My Linux system only has bash in `/run/current-system/sw/bin/bash`, so the script fails with `sh: line 2: ./build.sh: cannot execute: required file not found`. My macOS system has an ancient version of bash shipped with the system installed as `/bin/bash` (which Apple last updated in 2007 and will never ever update anymore for license reasons since bash 4+ switched to GPLv3; it's likely to be removed in future macOS versions though as macOS has long replaced bash with zsh as its shell of choice), and in some ways it's worse than not having any since modern bash scripts that assume bash 4 or 5 often fail or produce incorrect results with it. This specific script accidentally happens to work anyway, but the correct bash installation to use on this system is still `/opt/homebrew/bin/bash`. Anything other than `/bin/sh` (be it `bash` or `python` or `node`) can only be dispatched via `/usr/bin/env` if a script is intended to be used on more than one machine because it's not possible to predict where the interpreter is going to be at.

… latest version

… into feat/cuid2-support

…v1.3.3-wasm32-unknown-unknown"

… into feat/cuid2-support

Cargo.toml

… race condition in newer versions

aqrln · 2024-11-22T14:04:49Z

.gitignore

-# Ignore pnpm-lock.yaml
-query-engine/driver-adapters/pnpm-lock.yaml


actually I don't see it committed in this PR, is also covered by a .gitignore in some subdirectory?

Right, let's fix this in a follow-up PR

aqrln · 2024-11-22T14:05:20Z

Cargo.lock

-version = "1.3.2"
-source = "git+https://github.com/prisma/cuid-rust?branch=wasm32-support#ccfd958c224c79758c2527a0bca9efcd71790a19"
+version = "1.3.3"
+source = "git+https://github.com/prisma/cuid-rust?branch=v1.3.3-wasm32-unknown-unknown#dc68c4f47a3dbcd511f605135ac7c948775a3ab9"


anything to contribute upstream?

Yes, but let's do that after we've shipped Prisma 6

aqrln · 2024-11-22T14:08:40Z

query-engine/driver-adapters/executor/package.json

-    "node": ">=16.13",
-    "pnpm": ">=8.6.6 <9"
+    "node": ">=18.18",
+    "pnpm": ">=8.6.6"


I think this should be limited to a specific major version because of different lockfile versions, if we are going to commit the lockfile. If you used pnpm 9 locally then let's just specify pnpm 9.

Right, let's fix this in a follow-up PR.

mzdr · 2024-11-22T14:28:17Z

fantastic work @jkomyno, thank you!

feat(psl): add cuid(2) support, fix uuid(7) re-introspection

454112f

jkomyno added this to the 6.0.0 milestone Nov 15, 2024

jkomyno requested a review from a team as a code owner November 15, 2024 18:46

jkomyno requested review from wmadden and removed request for a team and wmadden November 15, 2024 18:46

chore(psl): fix clippy

8b6ac6e

jkomyno added 2 commits November 15, 2024 19:57

chore(psl): fix clippy

195d25d

fix(dmmf): [breaking] serialise uuid and cuid with proper args

04af8ad

jkomyno changed the title ~~feat(psl): add cuid(2) support~~ feat(psl): add cuid(2) support, fix uuid(7) Nov 15, 2024

test(dmmf): expand functions.json test suite

e902e3a

jkomyno commented Nov 15, 2024

View reviewed changes

psl/psl/tests/common/asserts.rs Outdated Show resolved Hide resolved

jkomyno and others added 9 commits November 15, 2024 20:44

chore(query-structure): interpret "cuid()" as "cuid(1)"

df254e9

chore: remove leftover

547c979

Merge branch 'main' into feat/cuid2-support

8e91dfb

fix(query-engine): fix "create_uuid_v7_and_retrieve_it_should_work" s…

a154696

…uite

test(query-engine): add create_cuid_v2_and_retrieve_it_should_work test

56a6ca6

feat(query-engine): port cuid to workspace, replace Prisma's wasm32-o…

16e3d1d

…riented fork with cuid 1.3.3

feat(query-engine): replace cuid1 with cuid2 for internal transaction…

71c4aeb

… IDs

Merge branch 'feat/cuid2-support' of github.com:prisma/prisma-engines…

9d191ed

… into feat/cuid2-support

chore: cargo fmt

148551c

jkomyno commented Nov 19, 2024

View reviewed changes

chore: clippy

c1159eb

jkomyno requested a review from aqrln November 19, 2024 17:36

jkomyno self-assigned this Nov 19, 2024

aqrln reviewed Nov 20, 2024

View reviewed changes

fix(dmmf): serialise uuid, cuid like nanoid; parse nanoid like uuid, …

5102928

…cuid

jkomyno commented Nov 21, 2024

View reviewed changes

query-engine/dmmf/test_files/functions.json Outdated Show resolved Hide resolved

jkomyno and others added 7 commits November 21, 2024 01:38

chore(psl): revert bad test update to "server_side_functions"

e0e5158

chore(dmmf): remove unused tuple, simplify "default_value" for genera…

4410268

…tors

fix(psl): typo in test

e232e8a

fix(psl): typo in test

fe03f7e

chore(psl): use itertools

f9f2ef1

Merge branch 'main' into feat/cuid2-support

9b43712

jkomyno changed the title ~~feat(psl): add cuid(2) support, fix uuid(7)~~ feat(psl, query-engine, schema-engine): add cuid(2) support, fix uuid(7) Nov 21, 2024

jkomyno added 6 commits November 21, 2024 18:02

Merge branch 'main' into feat/cuid2-support

d9386d2

chore(driver-adapters):: bump wrangler version to 3.88.0

1e91366

chore(driver-adapters): bump wasm32-unknown-unknown rust-toolchain to…

f767af2

… latest version

Merge branch 'feat/cuid2-support' of github.com:prisma/prisma-engines…

c538098

… into feat/cuid2-support

fix(query-engine-wasm): replace "cuid" with "prisma/cuid-rust?branch=…

520fb09

…v1.3.3-wasm32-unknown-unknown"

Merge branch 'feat/cuid2-support' of github.com:prisma/prisma-engines…

5e70c06

… into feat/cuid2-support

jkomyno mentioned this pull request Nov 21, 2024

feat(client): [breaking] remove type aliases introduced in #20184 prisma/prisma#25703

Merged

aqrln reviewed Nov 22, 2024

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

jkomyno added 2 commits November 22, 2024 14:04

chore: revert upgrade to wrangler (from 3.50.0 to 3.88.0) for suspect…

c57a8e2

… race condition in newer versions

chore: remove leftover

bd42901

aqrln reviewed Nov 22, 2024

View reviewed changes

aqrln approved these changes Nov 22, 2024

View reviewed changes

jkomyno mentioned this pull request Nov 22, 2024

Make cuid2 available in @default prisma/prisma#17102

Closed

jkomyno merged commit 5e70d19 into main Nov 22, 2024
368 checks passed

jkomyno deleted the feat/cuid2-support branch November 22, 2024 14:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(psl, query-engine, schema-engine): add `cuid(2)` support, fix `uuid(7)` #5047

feat(psl, query-engine, schema-engine): add `cuid(2)` support, fix `uuid(7)` #5047

jkomyno commented Nov 15, 2024 •

edited

Loading

codspeed-hq bot commented Nov 15, 2024 •

edited

Loading

github-actions bot commented Nov 15, 2024 •

edited

Loading

jkomyno Nov 15, 2024

jkomyno Nov 19, 2024

aqrln left a comment

aqrln commented Nov 20, 2024

jkomyno Nov 21, 2024

jkomyno Nov 21, 2024 •

edited

Loading

aqrln Nov 22, 2024

aqrln Nov 22, 2024

jkomyno Nov 22, 2024

aqrln Nov 22, 2024

jkomyno Nov 22, 2024 •

edited

Loading

aqrln Nov 22, 2024 •

edited

Loading

jkomyno Nov 22, 2024

mzdr commented Nov 22, 2024

	#[test]
	fn test_dmmf_rendering() {
	let test_cases = fs::read_dir(SAMPLES_FOLDER_PATH)
	.unwrap()
	.map(\|entry\| entry.unwrap().file_name().into_string().unwrap())
	.filter(\|name\| name.ends_with(".prisma"))
	.map(\|name\| name.trim_end_matches(".prisma").to_owned());

	for test_case in test_cases {
	println!("TESTING: {test_case}");

	let datamodel_string = load_from_file(format!("{test_case}.prisma").as_str());
	let dmmf_string = render_to_dmmf(&datamodel_string);

	if std::env::var("UPDATE_EXPECT") == Ok("1".into()) {
	save_to_file(&format!("{test_case}.json"), &dmmf_string);
	}

	let expected_json = load_from_file(format!("{test_case}.json").as_str());

	println!("{dmmf_string}");
	assert_eq_json(&dmmf_string, &expected_json, &test_case);
	}
	}

		# Ignore pnpm-lock.yaml
		query-engine/driver-adapters/pnpm-lock.yaml

feat(psl, query-engine, schema-engine): add cuid(2) support, fix uuid(7) #5047

feat(psl, query-engine, schema-engine): add cuid(2) support, fix uuid(7) #5047

Conversation

jkomyno commented Nov 15, 2024 • edited Loading

codspeed-hq bot commented Nov 15, 2024 • edited Loading

Merging #5047 will not alter performance

Summary

github-actions bot commented Nov 15, 2024 • edited Loading

WASM Query Engine file Size

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aqrln left a comment

Choose a reason for hiding this comment

aqrln commented Nov 20, 2024

Choose a reason for hiding this comment

jkomyno Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkomyno Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

aqrln Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mzdr commented Nov 22, 2024

feat(psl, query-engine, schema-engine): add `cuid(2)` support, fix `uuid(7)` #5047

feat(psl, query-engine, schema-engine): add `cuid(2)` support, fix `uuid(7)` #5047

jkomyno commented Nov 15, 2024 •

edited

Loading

codspeed-hq bot commented Nov 15, 2024 •

edited

Loading

github-actions bot commented Nov 15, 2024 •

edited

Loading

jkomyno Nov 21, 2024 •

edited

Loading

jkomyno Nov 22, 2024 •

edited

Loading

aqrln Nov 22, 2024 •

edited

Loading