fix(db-*): findMigrationDir in projects without src folder (#14381)

Fixes #14379

Additionally, removes duplication of `findMigrationDir` between DB
adapters, deprecates the export from `@payloadcms/drizzle` and adds unit
testing to this function.

Author: r1tsuu

packages/db-d1-sqlite/src/index.ts

@@ -20,7 +20,6 @@ import {
   find,
   findGlobal,
   findGlobalVersions,
-  findMigrationDir,
   findOne,
   findVersions,
   migrate,
@@ -52,7 +51,7 @@ import {
   requireDrizzleKit,
 } from '@payloadcms/drizzle/sqlite'
 import { like, notLike } from 'drizzle-orm'
-import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction, findMigrationDir } from 'payload'
 import { fileURLToPath } from 'url'
 
 import type { Args, SQLiteD1Adapter } from './types.js'

packages/db-mongodb/src/index.ts

@@ -21,10 +21,8 @@ import type {
   UpdateVersionArgs,
 } from 'payload'
 
-import fs from 'fs'
 import mongoose from 'mongoose'
-import path from 'path'
-import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction, findMigrationDir } from 'payload'
 
 import type { CollectionModel, GlobalModel, MigrateDownArgs, MigrateUpArgs } from './types.js'
 
@@ -332,44 +330,3 @@ export function mongooseAdapter({
 }
 
 export { compatibilityOptions } from './utilities/compatibilityOptions.js'
-
-/**
- * Attempt to find migrations directory.
- *
- * Checks for the following directories in order:
- * - `migrationDir` argument from Payload config
- * - `src/migrations`
- * - `dist/migrations`
- * - `migrations`
- *
- * Defaults to `src/migrations`
- *
- * @param migrationDir
- * @returns
- */
-function findMigrationDir(migrationDir?: string): string {
-  const cwd = process.cwd()
-  const srcDir = path.resolve(cwd, 'src/migrations')
-  const distDir = path.resolve(cwd, 'dist/migrations')
-  const relativeMigrations = path.resolve(cwd, 'migrations')
-
-  // Use arg if provided
-  if (migrationDir) {
-    return migrationDir
-  }
-
-  // Check other common locations
-  if (fs.existsSync(srcDir)) {
-    return srcDir
-  }
-
-  if (fs.existsSync(distDir)) {
-    return distDir
-  }
-
-  if (fs.existsSync(relativeMigrations)) {
-    return relativeMigrations
-  }
-
-  return srcDir
-}

packages/db-postgres/src/index.ts

@@ -20,7 +20,6 @@ import {
   findDistinct,
   findGlobal,
   findGlobalVersions,
-  findMigrationDir,
   findOne,
   findVersions,
   migrate,
@@ -55,7 +54,7 @@ import {
   requireDrizzleKit,
 } from '@payloadcms/drizzle/postgres'
 import { pgEnum, pgSchema, pgTable } from 'drizzle-orm/pg-core'
-import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction, findMigrationDir } from 'payload'
 import pgDependency from 'pg'
 import { fileURLToPath } from 'url'
 

packages/db-sqlite/src/index.ts

@@ -21,7 +21,6 @@ import {
   findDistinct,
   findGlobal,
   findGlobalVersions,
-  findMigrationDir,
   findOne,
   findVersions,
   migrate,
@@ -55,7 +54,7 @@ import {
   requireDrizzleKit,
 } from '@payloadcms/drizzle/sqlite'
 import { like, notLike } from 'drizzle-orm'
-import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction, findMigrationDir } from 'payload'
 import { fileURLToPath } from 'url'
 
 import type { Args, SQLiteAdapter } from './types.js'

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

@@ -21,7 +21,6 @@ import {
   findDistinct,
   findGlobal,
   findGlobalVersions,
-  findMigrationDir,
   findOne,
   findVersions,
   migrate,
@@ -56,7 +55,7 @@ import {
   requireDrizzleKit,
 } from '@payloadcms/drizzle/postgres'
 import { pgEnum, pgSchema, pgTable } from 'drizzle-orm/pg-core'
-import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction, findMigrationDir } from 'payload'
 import { fileURLToPath } from 'url'
 
 import type { Args, VercelPostgresAdapter } from './types.js'

packages/drizzle/src/index.ts

@@ -15,7 +15,6 @@ export { chainMethods } from './find/chainMethods.js'
 export { findDistinct } from './findDistinct.js'
 export { findGlobal } from './findGlobal.js'
 export { findGlobalVersions } from './findGlobalVersions.js'
-export { findMigrationDir } from './findMigrationDir.js'
 export { findOne } from './findOne.js'
 export { findVersions } from './findVersions.js'
 export { migrate } from './migrate.js'
@@ -89,3 +88,13 @@ export { extendDrizzleTable } from './utilities/extendDrizzleTable.js'
 export { hasLocalesTable } from './utilities/hasLocalesTable.js'
 export { pushDevSchema } from './utilities/pushDevSchema.js'
 export { validateExistingBlockIsIdentical } from './utilities/validateExistingBlockIsIdentical.js'
+import { findMigrationDir as payloadFindMigrationDir } from 'payload'
+
+/**
+ * @deprecated remove in 4.0
+ * use
+ * ```ts
+ * import { findMigrationDir } from 'payload'
+ * ```
+ */
+export const findMigrationDir = payloadFindMigrationDir

packages/payload/src/database/migrations/findMigrationDir.spec.ts

@@ -0,0 +1,41 @@
+import { findMigrationDir } from './findMigrationDir'
+import fs from 'fs'
+import path from 'path'
+
+const workDir = path.resolve(import.meta.dirname, '_tmp')
+
+describe('findMigrationDir', () => {
+  beforeEach(() => {
+    const cwdSpy = jest.spyOn(process, 'cwd')
+    cwdSpy.mockReturnValue(workDir)
+    fs.mkdirSync(workDir, { recursive: true })
+  })
+
+  afterEach(() => {
+    fs.rmSync(workDir, { force: true, recursive: true })
+  })
+
+  it('should return the passed directory', () => {
+    const dir = path.resolve(workDir, 'custom_migrations')
+    expect(findMigrationDir(dir)).toBe(dir)
+  })
+
+  it('should return src/migrations because that folder exists', () => {
+    fs.mkdirSync(path.resolve(workDir, 'src/migrations'), { recursive: true })
+    expect(findMigrationDir()).toBe(path.resolve(workDir, 'src/migrations'))
+  })
+
+  it('should return dist/migrations because that folder exists', () => {
+    fs.mkdirSync(path.resolve(workDir, 'dist/migrations'), { recursive: true })
+    expect(findMigrationDir()).toBe(path.resolve(workDir, 'dist/migrations'))
+  })
+
+  it('should return src/migrations because src exists', () => {
+    fs.mkdirSync(path.resolve(workDir, 'src'), { recursive: true })
+    expect(findMigrationDir()).toBe(path.resolve(workDir, 'src/migrations'))
+  })
+
+  it('should return migrations because src does not exist', () => {
+    expect(findMigrationDir()).toBe(path.resolve(workDir, 'migrations'))
+  })
+})

packages/drizzle/src/findMigrationDir.ts renamed to packages/payload/src/database/migrations/findMigrationDir.ts

@@ -10,15 +10,15 @@ import path from 'path'
  * - `dist/migrations`
  * - `migrations`
  *
- * Defaults to `src/migrations`
- *
  * @param migrationDir
+ * @default src/migrations`, if the src folder does not exists - migrations.
  * @returns
  */
-export function findMigrationDir(migrationDir?: string): string {
+export const findMigrationDir = (migrationDir?: string): string => {
   const cwd = process.cwd()
-  const srcDir = path.resolve(cwd, 'src/migrations')
-  const distDir = path.resolve(cwd, 'dist/migrations')
+
+  const srcMigrationsDir = path.resolve(cwd, 'src/migrations')
+  const distMigrationsDir = path.resolve(cwd, 'dist/migrations')
   const relativeMigrations = path.resolve(cwd, 'migrations')
 
   // Use arg if provided
@@ -27,17 +27,21 @@ export function findMigrationDir(migrationDir?: string): string {
   }
 
   // Check other common locations
-  if (fs.existsSync(srcDir)) {
-    return srcDir
+  if (fs.existsSync(srcMigrationsDir)) {
+    return srcMigrationsDir
   }
 
-  if (fs.existsSync(distDir)) {
-    return distDir
+  if (fs.existsSync(distMigrationsDir)) {
+    return distMigrationsDir
   }
 
   if (fs.existsSync(relativeMigrations)) {
     return relativeMigrations
   }
 
-  return srcDir
+  if (fs.existsSync(path.resolve(cwd, 'src'))) {
+    return srcMigrationsDir
+  }
+
+  return relativeMigrations
 }

packages/payload/src/index.ts

@@ -1299,6 +1299,7 @@ export { defaultBeginTransaction } from './database/defaultBeginTransaction.js'
 export { flattenWhereToOperators } from './database/flattenWhereToOperators.js'
 export { getLocalizedPaths } from './database/getLocalizedPaths.js'
 export { createMigration } from './database/migrations/createMigration.js'
+export { findMigrationDir } from './database/migrations/findMigrationDir.js'
 export { getMigrations } from './database/migrations/getMigrations.js'
 export { getPredefinedMigration } from './database/migrations/getPredefinedMigration.js'
 export { migrate } from './database/migrations/migrate.js'