17f7b94555
* feat(richtext-lexical): 'bottom' position value for plugins * feat: TestRecorderFeature * chore: restructuring to seed and clear db before each test * chore: make sure all tests pass * chore: make sure indexes are created in seed.ts - this fixes one erroring test * chore: speed up test runs through db snapshots * chore: support drizzle when resetting db * chore: simplify seeding process, by moving boilerplate db reset / snapshot logic into a wrapper function * chore: add new seeding process to admin test suite * chore(deps): upgrade jest and playwright * chore: make sure mongoose-specific tests are not skipped * chore: fix point test, which was depending on another test (that's bad!) * chore: fix incorrect import * chore: remove unnecessary comments * chore: clearly label lexicalE2E test file as todo * chore: simplify seed logic * chore: move versions test suite to new seed system
96 lines
2.9 KiB
TypeScript
96 lines
2.9 KiB
TypeScript
import fs from 'fs'
|
|
import path from 'path'
|
|
|
|
import { type Payload } from '../../packages/payload/src'
|
|
import { isMongoose } from './isMongoose'
|
|
import { resetDB } from './reset'
|
|
import { createSnapshot, dbSnapshot, restoreFromSnapshot } from './snapshot'
|
|
|
|
type SeedFunction = (_payload: Payload) => Promise<void>
|
|
|
|
export async function seedDB({
|
|
shouldResetDB,
|
|
_payload,
|
|
snapshotKey,
|
|
seedFunction,
|
|
uploadsDir,
|
|
collectionSlugs,
|
|
}: {
|
|
_payload: Payload
|
|
collectionSlugs: string[]
|
|
seedFunction: SeedFunction
|
|
shouldResetDB: boolean
|
|
/**
|
|
* Key to uniquely identify the kind of snapshot. Each test suite should pass in a unique key
|
|
*/
|
|
snapshotKey: string
|
|
uploadsDir?: string
|
|
}) {
|
|
/**
|
|
* Reset database and delete uploads directory
|
|
*/
|
|
if (shouldResetDB) {
|
|
let clearUploadsDirPromise: any = Promise.resolve()
|
|
if (uploadsDir) {
|
|
clearUploadsDirPromise = fs.promises
|
|
.access(uploadsDir)
|
|
.then(() => fs.promises.readdir(uploadsDir))
|
|
.then((files) =>
|
|
Promise.all(files.map((file) => fs.promises.rm(path.join(uploadsDir, file)))),
|
|
)
|
|
.catch((error) => {
|
|
if (error.code !== 'ENOENT') {
|
|
// If the error is not because the directory doesn't exist
|
|
console.error('Error clearing the uploads directory:', error)
|
|
throw error
|
|
}
|
|
// If the directory does not exist, resolve the promise (nothing to clear)
|
|
return
|
|
})
|
|
}
|
|
|
|
await Promise.all([resetDB(_payload, collectionSlugs), clearUploadsDirPromise])
|
|
}
|
|
|
|
/**
|
|
* Mongoose & Postgres: Restore snapshot of old data if available
|
|
*
|
|
* Note for postgres: For postgres, this needs to happen AFTER the tables were created.
|
|
* This does not work if I run payload.db.init or payload.db.connect anywhere. Thus, when resetting the database, we are not dropping the schema, but are instead only deleting the table values
|
|
*/
|
|
let restored = false
|
|
if (dbSnapshot[snapshotKey] && Object.keys(dbSnapshot[snapshotKey]).length) {
|
|
await restoreFromSnapshot(_payload, snapshotKey, collectionSlugs)
|
|
restored = true
|
|
}
|
|
|
|
/**
|
|
* Mongoose: Re-create indexes
|
|
* Postgres: No need for any action here, since we only delete the table data and no schemas
|
|
*/
|
|
// Dropping the db breaks indexes (on mongoose - did not test extensively on postgres yet), so we recreate them here
|
|
if (shouldResetDB) {
|
|
if (isMongoose(_payload)) {
|
|
await Promise.all([
|
|
...collectionSlugs.map(async (collectionSlug) => {
|
|
await _payload.db.collections[collectionSlug].createIndexes()
|
|
}),
|
|
])
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If a snapshot was restored, we don't need to seed the database
|
|
*/
|
|
if (restored) {
|
|
return
|
|
}
|
|
|
|
/**
|
|
* Seed the database with data and save it to a snapshot
|
|
**/
|
|
await seedFunction(_payload)
|
|
|
|
await createSnapshot(_payload, snapshotKey, collectionSlugs)
|
|
}
|