fix(db-vercel-postgres): migrate from deprecated @vercel/postgres to @neondatabase/serverless

- `@vercel/postgres` has been deprecated. All Vercel Postgres stores have been migrated to Neon's native integration. The package is no
  longer maintained and its `VercelPool` (which extends `@neondatabase/serverless`'s `Pool`, not `pg`'s `Pool`) is incompatible with
  `drizzle-orm@0.45.2`'s stricter `NodePgClient` type.

Author: siimsams

packages/db-vercel-postgres/src/connect.ts

@@ -1,9 +1,10 @@
-import type { DrizzleAdapter } from '@payloadcms/drizzle/types'
+import type { DrizzleAdapter } from '@payloadcms/drizzle'
 import type { Connect, Migration } from 'payload'
 
+import { Pool as NeonPool } from '@neondatabase/serverless'
 import { pushDevSchema } from '@payloadcms/drizzle'
-import { sql, VercelPool } from '@vercel/postgres'
-import { drizzle } from 'drizzle-orm/node-postgres'
+import { drizzle as drizzleNeon } from 'drizzle-orm/neon-serverless'
+import { drizzle as drizzlePg } from 'drizzle-orm/node-postgres'
 import { withReplicas } from 'drizzle-orm/pg-core'
 import pg from 'pg'
 
@@ -20,42 +21,39 @@ export const connect: Connect = async function connect(
   try {
     const logger = this.logger || false
 
-    let client: pg.Pool | VercelPool
-
     const connectionString = this.poolOptions?.connectionString ?? process.env.POSTGRES_URL
 
     // Use non-vercel postgres for local database
-    if (
+    const useLocalPg =
       !this.forceUseVercelPostgres &&
       connectionString &&
       ['127.0.0.1', 'localhost'].includes(new URL(connectionString).hostname)
-    ) {
-      client = new pg.Pool(
+
+    if (useLocalPg) {
+      const client = new pg.Pool(
         this.poolOptions ?? {
           connectionString,
         },
       )
+      this.drizzle = drizzlePg({ client, logger, schema: this.schema })
     } else {
-      client = this.poolOptions ? new VercelPool(this.poolOptions) : sql
+      const client = new NeonPool(this.poolOptions ?? { connectionString })
+      this.drizzle = drizzleNeon({ client, logger, schema: this.schema })
     }
 
-    // Passed the poolOptions if provided,
-    // else have vercel/postgres detect the connection string from the environment
-    this.drizzle = drizzle({
-      client,
-      logger,
-      schema: this.schema,
-    })
-
     if (this.readReplicaOptions) {
       this.primaryDrizzle = this.drizzle as any
       const readReplicas = this.readReplicaOptions.map((connectionString) => {
         const options = {
           ...this.poolOptions,
           connectionString,
         }
-        const pool = new VercelPool(options)
-        return drizzle({ client: pool, logger, schema: this.schema })
+        if (useLocalPg) {
+          const pool = new pg.Pool(options)
+          return drizzlePg({ client: pool, logger, schema: this.schema })
+        }
+        const pool = new NeonPool(options)
+        return drizzleNeon({ client: pool, logger, schema: this.schema })
       })
       const myReplicas = withReplicas(this.drizzle, readReplicas as any)
       this.drizzle = myReplicas

packages/db-vercel-postgres/src/types.ts

@@ -1,15 +1,14 @@
+import type { Pool, PoolConfig } from '@neondatabase/serverless'
 import type {
   BasePostgresAdapter,
   GenericEnum,
   MigrateDownArgs,
   MigrateUpArgs,
-  PostgresDB,
   PostgresSchemaHook,
 } from '@payloadcms/drizzle/postgres'
 import type { DrizzleAdapter } from '@payloadcms/drizzle/types'
-import type { VercelPool, VercelPostgresPoolConfig } from '@vercel/postgres'
 import type { DrizzleConfig } from 'drizzle-orm'
-import type { NodePgDatabase } from 'drizzle-orm/node-postgres'
+import type { NeonDatabase } from 'drizzle-orm/neon-serverless'
 import type { PgSchema, PgTableFn, PgTransactionConfig } from 'drizzle-orm/pg-core'
 
 export type Args = {
@@ -45,10 +44,8 @@ export type Args = {
   disableCreateDatabase?: boolean
   extensions?: string[]
   /**
-   * By default, we connect to a local database using the `pg` module instead of `@vercel/postgres`.
-   * This is because `@vercel/postgres` doesn't work with local databases.
-   * If you still want to use `@vercel/postgres` even locally you can pass `true` here
-   * and you'd to spin up the database with a special Neon's Docker Compose setup - https://vercel.com/docs/storage/vercel-postgres/local-development#option-2:-local-postgres-instance-with-docker
+   * By default, we connect to a local database using the `pg` module instead of `@neondatabase/serverless`.
+   * If you still want to use `@neondatabase/serverless` even locally you can pass `true` here.
    */
   forceUseVercelPostgres?: boolean
   /** Generated schema from payload generate:db-schema file path */
@@ -58,10 +55,10 @@ export type Args = {
   logger?: DrizzleConfig['logger']
   migrationDir?: string
   /**
-   * Optional pool configuration for Vercel Postgres
-   * If not provided, vercel/postgres will attempt to use the Vercel environment variables
+   * Optional pool configuration
+   * If not provided, will attempt to use the Vercel/Neon environment variables
    */
-  pool?: VercelPostgresPoolConfig
+  pool?: PoolConfig
   prodMigrations?: {
     down: (args: MigrateDownArgs) => Promise<void>
     name: string
@@ -96,12 +93,12 @@ type ResolveSchemaType<T> = 'schema' extends keyof T
   ? T['schema']
   : GeneratedDatabaseSchema['schemaUntyped']
 
-type Drizzle = NodePgDatabase<ResolveSchemaType<GeneratedDatabaseSchema>>
+type Drizzle = NeonDatabase<ResolveSchemaType<GeneratedDatabaseSchema>>
 
 export type VercelPostgresAdapter = {
   drizzle: Drizzle
   forceUseVercelPostgres?: boolean
-  pool?: VercelPool
+  pool?: Pool
   poolOptions?: Args['pool']
 } & BasePostgresAdapter
 
@@ -126,7 +123,7 @@ declare module 'payload' {
     localesSuffix?: string
     logger: DrizzleConfig['logger']
     pgSchema?: { table: PgTableFn } | PgSchema
-    pool: VercelPool
+    pool: Pool
     poolOptions: Args['pool']
     prodMigrations?: {
       down: (args: MigrateDownArgs) => Promise<void>