fix(db-postgres, db-sqlite): enum schema (#7453)

DanRibbens · web-flow · commit 075819964d65 · 2024-07-31T16:42:00.000-04:00
- updates drizzle-kit and drizzle-orm
- fix enum creation to fully support custom schemas
- sqlite by default will not use transactions
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -196,6 +196,7 @@ jobs:
           - postgres-custom-schema
           - postgres-uuid
           - supabase
+          - sqlite
     env:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
diff --git a/package.json b/package.json
@@ -119,7 +119,7 @@
     "create-payload-app": "workspace:*",
     "cross-env": "7.0.3",
     "dotenv": "16.4.5",
-    "drizzle-orm": "0.29.4",
+    "drizzle-orm": "0.32.1",
     "escape-html": "^1.0.3",
     "execa": "5.1.1",
     "form-data": "3.0.1",
diff --git a/packages/db-postgres/package.json b/packages/db-postgres/package.json
@@ -47,8 +47,8 @@
   "dependencies": {
     "@payloadcms/drizzle": "workspace:*",
     "console-table-printer": "2.11.2",
-    "drizzle-kit": "0.20.14-1f2c838",
-    "drizzle-orm": "0.29.4",
+    "drizzle-kit": "0.23.1-7816536",
+    "drizzle-orm": "0.32.1",
     "pg": "8.11.3",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
diff --git a/packages/db-postgres/src/connect.ts b/packages/db-postgres/src/connect.ts
@@ -53,6 +53,7 @@ export const connect: Connect = async function connect(
   const { hotReload } = options
 
   this.schema = {
+    pgSchema: this.pgSchema,
     ...this.tables,
     ...this.relations,
     ...this.enums,
diff --git a/packages/db-postgres/src/createMigration.ts b/packages/db-postgres/src/createMigration.ts
@@ -49,6 +49,12 @@ export const createMigration: CreateMigration = async function createMigration(
 
   let drizzleJsonBefore = defaultDrizzleSnapshot
 
+  if (this.schemaName) {
+    drizzleJsonBefore.schemas = {
+      [this.schemaName]: this.schemaName,
+    }
+  }
+
   if (!upSQL) {
     // Get latest migration snapshot
     const latestSnapshot = fs
diff --git a/packages/db-postgres/src/defaultSnapshot.ts b/packages/db-postgres/src/defaultSnapshot.ts
@@ -7,10 +7,11 @@ export const defaultDrizzleSnapshot: DrizzleSnapshotJSON = {
     schemas: {},
     tables: {},
   },
-  dialect: 'pg',
+  dialect: 'postgresql',
   enums: {},
   prevId: '00000000-0000-0000-0000-00000000000',
   schemas: {},
+  sequences: {},
   tables: {},
-  version: '5',
+  version: '7',
 }
diff --git a/packages/db-postgres/src/index.ts b/packages/db-postgres/src/index.ts
@@ -32,6 +32,7 @@ import {
   updateOne,
   updateVersion,
 } from '@payloadcms/drizzle'
+import { type PgSchema, pgEnum, pgSchema, pgTable } from 'drizzle-orm/pg-core'
 import { createDatabaseAdapter } from 'payload'
 
 import type { Args, PostgresAdapter } from './types.js'
@@ -62,12 +63,19 @@ export function postgresAdapter(args: Args): DatabaseAdapterObj<PostgresAdapter>
     const migrationDir = findMigrationDir(args.migrationDir)
     let resolveInitializing
     let rejectInitializing
+    let adapterSchema: PostgresAdapter['pgSchema']
 
     const initializing = new Promise<void>((res, rej) => {
       resolveInitializing = res
       rejectInitializing = rej
     })
 
+    if (args.schemaName) {
+      adapterSchema = pgSchema(args.schemaName)
+    } else {
+      adapterSchema = { enum: pgEnum, table: pgTable }
+    }
+
     return createDatabaseAdapter<PostgresAdapter>({
       name: 'postgres',
       defaultDrizzleSnapshot,
@@ -83,7 +91,7 @@ export function postgresAdapter(args: Args): DatabaseAdapterObj<PostgresAdapter>
       localesSuffix: args.localesSuffix || '_locales',
       logger: args.logger,
       operators: operatorMap,
-      pgSchema: undefined,
+      pgSchema: adapterSchema,
       pool: undefined,
       poolOptions: args.pool,
       push: args.push,
diff --git a/packages/db-postgres/src/init.ts b/packages/db-postgres/src/init.ts
@@ -1,7 +1,6 @@
 import type { Init, SanitizedCollectionConfig } from 'payload'
 
 import { createTableName } from '@payloadcms/drizzle'
-import { pgEnum, pgSchema, pgTable } from 'drizzle-orm/pg-core'
 import { buildVersionCollectionFields, buildVersionGlobalFields } from 'payload'
 import toSnakeCase from 'to-snake-case'
 
@@ -10,13 +9,8 @@ import type { PostgresAdapter } from './types.js'
 import { buildTable } from './schema/build.js'
 
 export const init: Init = function init(this: PostgresAdapter) {
-  if (this.schemaName) {
-    this.pgSchema = pgSchema(this.schemaName)
-  } else {
-    this.pgSchema = { table: pgTable }
-  }
   if (this.payload.config.localization) {
-    this.enums.enum__locales = pgEnum(
+    this.enums.enum__locales = this.pgSchema.enum(
       '_locales',
       this.payload.config.localization.locales.map(({ code }) => code) as [string, ...string[]],
     )
diff --git a/packages/db-postgres/src/schema/createIndex.ts b/packages/db-postgres/src/schema/createIndex.ts
@@ -1,4 +1,3 @@
-/* eslint-disable no-param-reassign */
 import { index, uniqueIndex } from 'drizzle-orm/pg-core'
 
 import type { GenericColumn } from '../types.js'
diff --git a/packages/db-postgres/src/schema/traverseFields.ts b/packages/db-postgres/src/schema/traverseFields.ts
@@ -18,7 +18,6 @@ import {
   integer,
   jsonb,
   numeric,
-  pgEnum,
   text,
   timestamp,
   varchar,
@@ -237,7 +236,7 @@ export const traverseFields = ({
           throwValidationError,
         })
 
-        adapter.enums[enumName] = pgEnum(
+        adapter.enums[enumName] = adapter.pgSchema.enum(
           enumName,
           field.options.map((option) => {
             if (optionIsObject(option)) {
diff --git a/packages/db-postgres/src/types.ts b/packages/db-postgres/src/types.ts
@@ -21,6 +21,7 @@ import type {
   PgSchema,
   PgTableWithColumns,
   PgTransactionConfig,
+  pgEnum,
 } from 'drizzle-orm/pg-core'
 import type { PgTableFn } from 'drizzle-orm/pg-core/table'
 import type { Payload, PayloadRequest } from 'payload'
@@ -106,6 +107,13 @@ type PostgresDrizzleAdapter = Omit<
   | 'relations'
 >
 
+type Schema =
+  | {
+      enum: typeof pgEnum
+      table: PgTableFn
+    }
+  | PgSchema
+
 export type PostgresAdapter = {
   countDistinct: CountDistinct
   defaultDrizzleSnapshot: DrizzleSnapshotJSON
@@ -125,15 +133,15 @@ export type PostgresAdapter = {
   localesSuffix?: string
   logger: DrizzleConfig['logger']
   operators: Operators
-  pgSchema?: { table: PgTableFn } | PgSchema
+  pgSchema?: Schema
   pool: Pool
   poolOptions: Args['pool']
   push: boolean
   rejectInitializing: () => void
   relations: Record<string, GenericRelation>
   relationshipsSuffix?: string
   resolveInitializing: () => void
-  schema: Record<string, GenericEnum | GenericRelation | GenericTable>
+  schema: DrizzleConfig
   schemaName?: Args['schemaName']
   sessions: {
     [id: string]: {
diff --git a/packages/db-sqlite/package.json b/packages/db-sqlite/package.json
@@ -46,8 +46,8 @@
     "@libsql/client": "^0.6.2",
     "@payloadcms/drizzle": "workspace:*",
     "console-table-printer": "2.11.2",
-    "drizzle-kit": "0.20.14-1f2c838",
-    "drizzle-orm": "0.29.4",
+    "drizzle-kit": "0.23.1-7816536",
+    "drizzle-orm": "0.32.1",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
     "uuid": "9.0.0"
diff --git a/packages/db-sqlite/src/defaultSnapshot.ts b/packages/db-sqlite/src/defaultSnapshot.ts
@@ -10,5 +10,5 @@ export const defaultDrizzleSnapshot: DrizzleSQLiteSnapshotJSON = {
   enums: {},
   prevId: '00000000-0000-0000-0000-00000000000',
   tables: {},
-  version: '5',
+  version: '6',
 }
diff --git a/packages/db-sqlite/src/index.ts b/packages/db-sqlite/src/index.ts
@@ -105,7 +105,7 @@ export function sqliteAdapter(args: Args): DatabaseAdapterObj<SQLiteAdapter> {
       versionsSuffix: args.versionsSuffix || '_v',
 
       // DatabaseAdapter
-      beginTransaction: args.transactionOptions === false ? undefined : beginTransaction,
+      beginTransaction: args.transactionOptions ? beginTransaction : undefined,
       commitTransaction,
       connect,
       convertPathToJSONTraversal,
diff --git a/packages/db-sqlite/src/schema/build.ts b/packages/db-sqlite/src/schema/build.ts
@@ -1,9 +1,8 @@
-/* eslint-disable no-param-reassign */
-import type { ColumnDataType, Relation } from 'drizzle-orm'
+import type { Relation } from 'drizzle-orm'
 import type {
+  AnySQLiteColumn,
   ForeignKeyBuilder,
   IndexBuilder,
-  SQLiteColumn,
   SQLiteColumnBuilder,
   SQLiteTableWithColumns,
   UniqueConstraintBuilder,
@@ -32,18 +31,7 @@ import { traverseFields } from './traverseFields.js'
 export type BaseExtraConfig = Record<
   string,
   (cols: {
-    [x: string]: SQLiteColumn<{
-      baseColumn: never
-      columnType: string
-      data: unknown
-      dataType: ColumnDataType
-      driverParam: unknown
-      enumValues: string[]
-      hasDefault: false
-      name: string
-      notNull: false
-      tableName: string
-    }>
+    [x: string]: AnySQLiteColumn
   }) => ForeignKeyBuilder | IndexBuilder | UniqueConstraintBuilder
 >
 
diff --git a/packages/db-sqlite/src/schema/createIndex.ts b/packages/db-sqlite/src/schema/createIndex.ts
@@ -1,7 +1,6 @@
-/* eslint-disable no-param-reassign */
-import { index, uniqueIndex } from 'drizzle-orm/sqlite-core'
+import type { AnySQLiteColumn} from 'drizzle-orm/sqlite-core';
 
-import type { GenericColumn } from '../types.js'
+import { index, uniqueIndex } from 'drizzle-orm/sqlite-core'
 
 type CreateIndexArgs = {
   columnName: string
@@ -11,7 +10,7 @@ type CreateIndexArgs = {
 }
 
 export const createIndex = ({ name, columnName, tableName, unique }: CreateIndexArgs) => {
-  return (table: { [x: string]: GenericColumn }) => {
+  return (table: { [x: string]: AnySQLiteColumn }) => {
     let columns
     if (Array.isArray(name)) {
       columns = name
diff --git a/packages/db-sqlite/src/types.ts b/packages/db-sqlite/src/types.ts
@@ -1,10 +1,10 @@
 import type { Client, Config, ResultSet } from '@libsql/client'
 import type { Operators } from '@payloadcms/drizzle'
 import type { BuildQueryJoinAliases, DrizzleAdapter } from '@payloadcms/drizzle/types'
-import type { ColumnDataType, DrizzleConfig, Relation, Relations, SQL } from 'drizzle-orm'
+import type { DrizzleConfig, Relation, Relations, SQL } from 'drizzle-orm'
 import type { LibSQLDatabase } from 'drizzle-orm/libsql'
 import type {
-  SQLiteColumn,
+  AnySQLiteColumn,
   SQLiteInsertOnConflictDoUpdateConfig,
   SQLiteTableWithColumns,
   SQLiteTransactionConfig,
@@ -25,24 +25,8 @@ export type Args = {
   versionsSuffix?: string
 }
 
-export type GenericColumn = SQLiteColumn<
-  {
-    baseColumn: never
-    columnType: string
-    data: unknown
-    dataType: ColumnDataType
-    driverParam: unknown
-    enumValues: string[]
-    hasDefault: false
-    name: string
-    notNull: false
-    tableName: string
-  },
-  object
->
-
 export type GenericColumns = {
-  [x: string]: GenericColumn
+  [x: string]: AnySQLiteColumn
 }
 
 export type GenericTable = SQLiteTableWithColumns<{
diff --git a/packages/drizzle/package.json b/packages/drizzle/package.json
@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "console-table-printer": "2.11.2",
-    "drizzle-orm": "0.29.4",
+    "drizzle-orm": "0.32.1",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
     "uuid": "9.0.0"
diff --git a/packages/drizzle/src/types.ts b/packages/drizzle/src/types.ts
@@ -120,6 +120,7 @@ export type RequireDrizzleKit = () => {
   pushSchema: (
     schema: Record<string, unknown>,
     drizzle: DrizzleAdapter['drizzle'],
+    filterSchema?: string[],
   ) => Promise<{ apply; hasDataLoss; warnings }>
 }
 
diff --git a/packages/drizzle/src/utilities/pushDevSchema.ts b/packages/drizzle/src/utilities/pushDevSchema.ts
@@ -12,7 +12,11 @@ export const pushDevSchema = async (adapter: DrizzleAdapter) => {
   const { pushSchema } = adapter.requireDrizzleKit()
 
   // This will prompt if clarifications are needed for Drizzle to push new schema
-  const { apply, hasDataLoss, warnings } = await pushSchema(adapter.schema, adapter.drizzle)
+  const { apply, hasDataLoss, warnings } = await pushSchema(
+    adapter.schema,
+    adapter.drizzle,
+    adapter.schemaName ? [adapter.schemaName] : undefined,
+  )
 
   if (warnings.length) {
     let message = `Warnings detected during schema push: \n\n${warnings.join('\n')}\n\n`
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/database/int.spec.ts b/test/database/int.spec.ts
diff --git a/test/hooks/collections/Hook/index.ts b/test/hooks/collections/Hook/index.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-/* eslint-disable no-param-reassign */`
`2`	`1`	`import { index, uniqueIndex } from 'drizzle-orm/pg-core'`
`3`	`2`
`4`	`3`	`import type { GenericColumn } from '../types.js'`