updated uuid generator

Author: OleksiiKH0240

changelogs/drizzle-seed/1.0.0-beta.2.md

@@ -0,0 +1,67 @@
+## Bug fixes
+
+- https://github.com/drizzle-team/drizzle-orm/issues/4551
+
+## Breaking changes
+
+### `uuid` generator was changed and upgraded to v4
+
+```ts
+await seed(db, { table }).refine((f) => ({
+  table: {
+    columns: {
+      // AA97B177-9383-4934-8543-0F91A7A02836
+      //                    ^
+      //                    1
+      // the digit at position 1 is always one of '8', '9', 'A' or 'B'
+      column1: f.uuid(),
+    }
+  }
+}))
+```
+
+**Reason for upgrade**
+
+UUID values generated by the old version of the `uuid` generator fail Zod’s v4 UUID validation.
+
+example
+```ts
+import { createSelectSchema } from 'drizzle-zod';
+import { seed } from 'drizzle-seed';
+
+await seed(db, { uuidTest: schema.uuidTest }, { count: 1 }).refine((funcs) => ({
+		uuidTest: {
+			columns: {
+				col1: funcs.uuid()
+			}
+		}
+	})
+);
+
+const uuidSelectSchema = createSelectSchema(schema.uuidTest);
+const res = await db.select().from(schema.uuidTest);
+// the line below will throw an error when using old version of uuid generator
+uuidSelectSchema.parse(res[0]);
+```
+
+**Usage**
+```ts
+await seed(db, schema);
+// or explicit
+await seed(db, schema, { version: '4' });
+```
+
+**Switch to the old version**
+
+The previous version of `uuid` generator is v1.
+```ts
+await seed(db, schema, { version: '1' });
+```
+To use the v2 generators while maintaining the v1 `uuid` generator:
+```ts
+await seed(db, schema, { version: '2' });
+```
+To use the v3 generators while maintaining the v1 `uuid` generator:
+```ts
+await seed(db, schema, { version: '3' });
+```

drizzle-seed/package.json

@@ -93,6 +93,7 @@
 		"dotenv": "^16.4.5",
 		"drizzle-kit": "workspace:./drizzle-kit/dist",
 		"drizzle-orm": "workspace:./drizzle-orm/dist",
+		"drizzle-zod": "workspace:./drizzle-zod/dist",
 		"get-port": "^7.1.0",
 		"mssql": "^11.0.1",
 		"mysql2": "^3.14.1",
@@ -102,6 +103,7 @@
 		"tslib": "^2.7.0",
 		"tsx": "^4.19.0",
 		"uuid": "^10.0.0",
+		"zod": "^4.0.0",
 		"zx": "^8.1.5"
 	},
 	"dependencies": {

drizzle-seed/src/SeedService.ts

@@ -226,7 +226,7 @@ export class SeedService {
 						}
 
 						// Generating undefined as a value for a column and then inserting it via drizzle-orm
-						// will result in the value not being inserted into that column.
+						// will result in null of default value being inserted into that column.
 						columnPossibleGenerator.generator = new generatorsMap.GenerateDefault[0]({ defaultValue: undefined });
 						columnPossibleGenerator.wasRefined = true;
 

drizzle-seed/src/generators/GeneratorFuncs.ts

@@ -63,6 +63,7 @@ import {
 } from './Generators.ts';
 import { GenerateStringV2, GenerateUniqueIntervalV2, GenerateUniqueStringV2 } from './versioning/v2.ts';
 import { GenerateHashFromStringV3 } from './versioning/v3.ts';
+import { GenerateUUIDV4 } from './versioning/v4.ts';
 
 function createGenerator<GeneratorType extends AbstractGenerator<T>, T>(
 	generatorConstructor: new(params?: T) => GeneratorType,
@@ -910,6 +911,10 @@ export const generatorsFuncsV3 = {
 	...generatorsFuncs,
 };
 
+export const generatorsFuncsV4 = {
+	...generatorsFuncs,
+};
+
 export const generatorsMap = {
 	GenerateHashFromString: [
 		GenerateHashFromString,
@@ -983,6 +988,7 @@ export const generatorsMap = {
 	],
 	GenerateUUID: [
 		GenerateUUID,
+		GenerateUUIDV4,
 	],
 	GenerateFirstName: [
 		GenerateFirstName,

drizzle-seed/src/generators/apiVersion.ts

@@ -1 +1 @@
-export const latestVersion = 3;
+export const latestVersion = 4;

drizzle-seed/src/generators/versioning/v4.ts

@@ -0,0 +1,62 @@
+import prand from 'pure-rand';
+import { AbstractGenerator } from '../Generators.ts';
+
+/* eslint-disable drizzle-internal/require-entity-kind */
+export class GenerateUUIDV4 extends AbstractGenerator<{
+	arraySize?: number;
+}> {
+	static override readonly entityKind: string = 'GenerateUUID';
+	static override readonly version: number = 4;
+
+	public override isGeneratorUnique = true;
+	public override maxUniqueCount: number = Number.POSITIVE_INFINITY;
+
+	private state: { rng: prand.RandomGenerator } | undefined;
+
+	override getMaxUniqueCount(): number {
+		return Number.POSITIVE_INFINITY;
+	}
+
+	override init({ count, seed }: { count: number; seed: number }) {
+		super.init({ count, seed });
+
+		const rng = prand.xoroshiro128plus(seed);
+		this.state = { rng };
+	}
+
+	generate() {
+		if (this.state === undefined) {
+			throw new Error('state is not defined.');
+		}
+		// TODO generate uuid using string generator
+		const stringChars = '1234567890abcdef';
+		let idx: number,
+			currStr: string;
+		const strLength = 36;
+
+		// uuid v4
+		const uuidTemplate = '########-####-4###-N###-############';
+		currStr = '';
+		for (let i = 0; i < strLength; i++) {
+			[idx, this.state.rng] = prand.uniformIntDistribution(
+				0,
+				stringChars.length - 1,
+				this.state.rng,
+			);
+
+			if (uuidTemplate[i] === '#') {
+				currStr += stringChars[idx];
+				continue;
+			}
+
+			// used this pr -> https://github.com/drizzle-team/drizzle-orm/pull/4503
+			if (uuidTemplate[i] === 'N') {
+				currStr += '89ab'[idx % 4];
+				continue;
+			}
+
+			currStr += uuidTemplate[i];
+		}
+		return currStr;
+	}
+}

drizzle-seed/src/index.ts

@@ -21,7 +21,12 @@ import type { SingleStoreColumn, SingleStoreSchema, SingleStoreTable } from 'dri
 import { SingleStoreDatabase } from 'drizzle-orm/singlestore-core';
 
 import { filterCockroachSchema, resetCockroach, seedCockroach } from './cockroach-core/index.ts';
-import { generatorsFuncs, generatorsFuncsV2, type generatorsFuncsV3 } from './generators/GeneratorFuncs.ts';
+import {
+	generatorsFuncs,
+	generatorsFuncsV2,
+	type generatorsFuncsV3,
+	type generatorsFuncsV4,
+} from './generators/GeneratorFuncs.ts';
 import type { AbstractGenerator } from './generators/Generators.ts';
 import { filterMsSqlTables, resetMsSql, seedMsSql } from './mssql-core/index.ts';
 import { filterMysqlTables, resetMySql, seedMySql } from './mysql-core/index.ts';
@@ -161,7 +166,8 @@ export type FunctionsVersioning<VERSION extends string | undefined = undefined>
 	? typeof generatorsFuncs
 	: VERSION extends `2` ? typeof generatorsFuncsV2
 	: VERSION extends `3` ? typeof generatorsFuncsV3
-	: typeof generatorsFuncsV3;
+	: VERSION extends `4` ? typeof generatorsFuncsV4
+	: typeof generatorsFuncsV4;
 
 export function getGeneratorsFunctions() {
 	return generatorsFuncs;
@@ -319,7 +325,7 @@ export function seed<
 	SCHEMA extends {
 		[key: string]: SchemaValuesType;
 	},
-	VERSION extends '3' | '2' | '1' | undefined,
+	VERSION extends '4' | '3' | '2' | '1' | undefined,
 >(db: DB, schema: SCHEMA, options?: { count?: number; seed?: number; version?: VERSION }) {
 	return new SeedPromise<typeof db, typeof schema, VERSION>(db, schema, options);
 }

drizzle-seed/tests/pg/pg.test.ts

@@ -4,6 +4,7 @@ import { relations } from 'drizzle-orm/_relations';
 import type { PgliteDatabase } from 'drizzle-orm/pglite';
 import { drizzle } from 'drizzle-orm/pglite';
 import { afterAll, afterEach, beforeAll, expect, test, vi } from 'vitest';
+import { createSelectSchema } from '../../../drizzle-zod/dist';
 import { reset, seed } from '../../src/index.ts';
 import * as schema from './pgSchema.ts';
 
@@ -236,6 +237,15 @@ beforeAll(async () => {
 			);
 		`,
 	);
+
+	await db.execute(
+		sql`
+			create table "seeder_lib_pg"."uuid_test"
+			(
+			    col1 uuid
+			);
+		`,
+	);
 });
 
 afterEach(async () => {
@@ -501,3 +511,28 @@ test('seeding table with sequences', async () => {
 		col8: 11,
 	});
 });
+
+test('uuid with drizzle-zod check', async () => {
+	await seed(db, { uuidTest: schema.uuidTest }, { count: 1 }).refine((funcs) => ({
+		uuidTest: {
+			columns: {
+				col1: funcs.uuid(),
+			},
+		},
+	}));
+
+	const uuidSelectSchema = createSelectSchema(schema.uuidTest);
+	const res = await db.select().from(schema.uuidTest);
+	uuidSelectSchema.parse(res[0]);
+
+	expect(res).toStrictEqual([{ col1: 'caf44ec1-e98c-4d92-8ed5-beb2074f1460' }]);
+	const possibleUuids = [
+		'caf44ec1-e98c-4d92-8ed5-beb2074f1460',
+		'caf44ec1-e98c-4d92-9ed5-beb2074f1460',
+		'caf44ec1-e98c-4d92-aed5-beb2074f1460',
+		'caf44ec1-e98c-4d92-bed5-beb2074f1460',
+	];
+	for (const uuid of possibleUuids) {
+		uuidSelectSchema.parse({ col1: uuid });
+	}
+});

drizzle-seed/tests/pg/pgSchema.ts

@@ -10,6 +10,7 @@ import {
 	smallserial,
 	text,
 	timestamp,
+	uuid,
 	varchar,
 } from 'drizzle-orm/pg-core';
 
@@ -153,3 +154,7 @@ export const testSequences = schema.table(
 		col8: smallserial(),
 	},
 );
+
+export const uuidTest = schema.table('uuid_test', {
+	col1: uuid(),
+});