Compare commits

..

9 Commits

Author SHA1 Message Date
Elliot DeNolf
70715926a8 chore(release): richtext-slate/1.4.0 [skip ci] 2024-01-26 13:57:45 -05:00
Elliot DeNolf
b3a6bfacf2 chore(release): db-postgres/0.5.0 [skip ci] 2024-01-26 13:57:34 -05:00
Elliot DeNolf
e1d9accb27 chore(release): db-mongodb/1.4.0 [skip ci] 2024-01-26 13:57:23 -05:00
Elliot DeNolf
f2f55a84cc chore(release): payload/2.9.0 [skip ci] 2024-01-26 13:55:20 -05:00
Dan Ribbens
eba53ba60a feat: forceAcceptWarning migration arg added to accept prompts (#4874)
* chore: gitignore test migrations

* feat: `forceAcceptWarning` migration args added to accept prompts

* chore: migrationDir env variable fallback

* chore: migrationDir testSuiteDir fallback

* chore: migrationDir testSuiteDir fallback fix

* chore: skip migrate down test
2024-01-26 13:48:53 -05:00
Dan Ribbens
f73d503fec fix(plugin-cloud-storage): slow get file performance large collections (#4927) 2024-01-26 13:43:55 -05:00
Dan Ribbens
6930c4e9f2 fix: upload input drawer does not show draft versions (#4903)
* chore: add field classname to upload field

* fix: upload input drawer does not show draft versions
2024-01-26 13:42:32 -05:00
Dan Ribbens
3eb681e847 fix: afterLogin hook write conflicts (#4904)
* fix: afterLogin hook conflict

* test: afterLogin hook returns for assertion

* chore: commit increment login attempt
2024-01-26 13:39:45 -05:00
Jarrod Flesch
cb4638cfa1 chore: make default views callable (#4928) 2024-01-26 13:38:36 -05:00
37 changed files with 512 additions and 305 deletions

View File

@@ -1,3 +1,20 @@
## [2.9.0](https://github.com/payloadcms/payload/compare/v2.8.2...v2.9.0) (2024-01-26)
### Features
* forceAcceptWarning migration arg added to accept prompts ([#4874](https://github.com/payloadcms/payload/issues/4874)) ([eba53ba](https://github.com/payloadcms/payload/commit/eba53ba60afd7c5d37389377ed06a9b556058d49))
### Bug Fixes
* afterLogin hook write conflicts ([#4904](https://github.com/payloadcms/payload/issues/4904)) ([3eb681e](https://github.com/payloadcms/payload/commit/3eb681e847e9c55eaaa69c22bea4f4e66c7eac36))
* **db-postgres:** migrate down error ([#4861](https://github.com/payloadcms/payload/issues/4861)) ([dfba522](https://github.com/payloadcms/payload/commit/dfba5222f3abf3f236dc9212a28e1aec7d7214d5))
* **db-postgres:** query unset relation ([#4862](https://github.com/payloadcms/payload/issues/4862)) ([8ce15c8](https://github.com/payloadcms/payload/commit/8ce15c8b07800397a50dcf790c263ed5b3cfad53))
* migrate down missing filter for latest batch ([#4860](https://github.com/payloadcms/payload/issues/4860)) ([b99d24f](https://github.com/payloadcms/payload/commit/b99d24fcfa698c493ea01c41621201abe18fabe3))
* **plugin-cloud-storage:** slow get file performance large collections ([#4927](https://github.com/payloadcms/payload/issues/4927)) ([f73d503](https://github.com/payloadcms/payload/commit/f73d503fecdfa5cefdc26ab9aad60b00563f881e))
* remove No Options dropdown from hasMany fields ([#4899](https://github.com/payloadcms/payload/issues/4899)) ([e5a7907](https://github.com/payloadcms/payload/commit/e5a7907a72c1371447ac2f71fce213ed22246092))
* upload input drawer does not show draft versions ([#4903](https://github.com/payloadcms/payload/issues/4903)) ([6930c4e](https://github.com/payloadcms/payload/commit/6930c4e9f2200853121391ad8f8df48ea66c40a4))
## [2.8.2](https://github.com/payloadcms/payload/compare/v2.8.1...v2.8.2) (2024-01-16)

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-mongodb",
"version": "1.3.2",
"version": "1.4.0",
"description": "The officially supported MongoDB database adapter for Payload",
"repository": "https://github.com/payloadcms/payload",
"license": "MIT",

View File

@@ -11,25 +11,30 @@ import type { MongooseAdapter } from '.'
/**
* Drop the current database and run all migrate up functions
*/
export async function migrateFresh(this: MongooseAdapter): Promise<void> {
export async function migrateFresh(
this: MongooseAdapter,
{ forceAcceptWarning = false }: { forceAcceptWarning?: boolean },
): Promise<void> {
const { payload } = this
const { confirm: acceptWarning } = await prompts(
{
name: 'confirm',
type: 'confirm',
initial: false,
message: `WARNING: This will drop your database and run all migrations. Are you sure you want to proceed?`,
},
{
onCancel: () => {
process.exit(0)
if (!forceAcceptWarning) {
const { confirm: acceptWarning } = await prompts(
{
name: 'confirm',
type: 'confirm',
initial: false,
message: `WARNING: This will drop your database and run all migrations. Are you sure you want to proceed?`,
},
},
)
{
onCancel: () => {
process.exit(0)
},
},
)
if (!acceptWarning) {
process.exit(0)
if (!acceptWarning) {
process.exit(0)
}
}
payload.logger.info({

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-postgres",
"version": "0.4.0",
"version": "0.5.0",
"description": "The officially supported Postgres database adapter for Payload",
"repository": "https://github.com/payloadcms/payload",
"license": "MIT",

View File

@@ -53,7 +53,7 @@ const getDefaultDrizzleSnapshot = (): DrizzleSnapshotJSON => ({
export const createMigration: CreateMigration = async function createMigration(
this: PostgresAdapter,
{ migrationName, payload },
{ forceAcceptWarning, migrationName, payload },
) {
const dir = payload.db.migrationDir
if (!fs.existsSync(dir)) {
@@ -95,7 +95,7 @@ export const createMigration: CreateMigration = async function createMigration(
const sqlStatementsUp = await generateMigration(drizzleJsonBefore, drizzleJsonAfter)
const sqlStatementsDown = await generateMigration(drizzleJsonAfter, drizzleJsonBefore)
if (!sqlStatementsUp.length && !sqlStatementsDown.length) {
if (!sqlStatementsUp.length && !sqlStatementsDown.length && !forceAcceptWarning) {
const { confirm: shouldCreateBlankMigration } = await prompts(
{
name: 'confirm',

View File

@@ -14,25 +14,30 @@ import { parseError } from './utilities/parseError'
/**
* Drop the current database and run all migrate up functions
*/
export async function migrateFresh(this: PostgresAdapter): Promise<void> {
export async function migrateFresh(
this: PostgresAdapter,
{ forceAcceptWarning = false },
): Promise<void> {
const { payload } = this
const { confirm: acceptWarning } = await prompts(
{
name: 'confirm',
type: 'confirm',
initial: false,
message: `WARNING: This will drop your database and run all migrations. Are you sure you want to proceed?`,
},
{
onCancel: () => {
process.exit(0)
if (forceAcceptWarning === false) {
const { confirm: acceptWarning } = await prompts(
{
name: 'confirm',
type: 'confirm',
initial: false,
message: `WARNING: This will drop your database and run all migrations. Are you sure you want to proceed?`,
},
},
)
{
onCancel: () => {
process.exit(0)
},
},
)
if (!acceptWarning) {
process.exit(0)
if (!acceptWarning) {
process.exit(0)
}
}
payload.logger.info({

View File

@@ -10,14 +10,15 @@ import type { NodePgDatabase, NodePgQueryResultHKT } from 'drizzle-orm/node-post
import type { PgColumn, PgEnum, PgTableWithColumns, PgTransaction } from 'drizzle-orm/pg-core'
import type { Payload } from 'payload'
import type { BaseDatabaseAdapter } from 'payload/database'
import type { PayloadRequest } from 'payload/types'
import type { Pool, PoolConfig } from 'pg'
export type DrizzleDB = NodePgDatabase<Record<string, unknown>>
export type Args = {
logger?: DrizzleConfig['logger']
migrationDir?: string
pool: PoolConfig
logger?: DrizzleConfig['logger']
push?: boolean
}
@@ -49,8 +50,13 @@ export type DrizzleTransaction = PgTransaction<
export type PostgresAdapter = BaseDatabaseAdapter & {
drizzle: DrizzleDB
logger: DrizzleConfig['logger']
enums: Record<string, GenericEnum>
/**
* An object keyed on each table, with a key value pair where the constraint name is the key, followed by the dot-notation field name
* Used for returning properly formed errors from unique fields
*/
fieldConstraints: Record<string, Record<string, string>>
logger: DrizzleConfig['logger']
pool: Pool
poolOptions: Args['pool']
push: boolean
@@ -64,17 +70,12 @@ export type PostgresAdapter = BaseDatabaseAdapter & {
}
}
tables: Record<string, GenericTable>
/**
* An object keyed on each table, with a key value pair where the constraint name is the key, followed by the dot-notation field name
* Used for returning properly formed errors from unique fields
*/
fieldConstraints: Record<string, Record<string, string>>
}
export type PostgresAdapterResult = (args: { payload: Payload }) => PostgresAdapter
export type MigrateUpArgs = { payload: Payload }
export type MigrateDownArgs = { payload: Payload }
export type MigrateUpArgs = { payload: Payload; req?: Partial<PayloadRequest> }
export type MigrateDownArgs = { payload: Payload; req?: Partial<PayloadRequest> }
declare module 'payload' {
export interface DatabaseAdapter
@@ -82,6 +83,7 @@ declare module 'payload' {
BaseDatabaseAdapter {
drizzle: DrizzleDB
enums: Record<string, GenericEnum>
fieldConstraints: Record<string, Record<string, string>>
pool: Pool
push: boolean
relations: Record<string, GenericRelation>
@@ -94,6 +96,5 @@ declare module 'payload' {
}
}
tables: Record<string, GenericTable>
fieldConstraints: Record<string, Record<string, string>>
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "payload",
"version": "2.8.2",
"version": "2.9.0",
"description": "Node, React and MongoDB Headless CMS and Application Framework",
"license": "MIT",
"main": "./dist/index.js",

View File

@@ -20,7 +20,7 @@ export const getCustomViews = (args: {
? collection?.admin?.components?.views?.Edit
: undefined
const defaultViewKeys = Object.keys(defaultCollectionViews)
const defaultViewKeys = Object.keys(defaultCollectionViews())
customViews = Object.entries(collectionViewsConfig || {}).reduce((prev, [key, view]) => {
if (defaultViewKeys.includes(key)) {
@@ -38,7 +38,7 @@ export const getCustomViews = (args: {
? global?.admin?.components?.views?.Edit
: undefined
const defaultViewKeys = Object.keys(defaultGlobalViews)
const defaultViewKeys = Object.keys(defaultGlobalViews())
customViews = Object.entries(globalViewsConfig || {}).reduce((prev, [key, view]) => {
if (defaultViewKeys.includes(key)) {

View File

@@ -133,9 +133,10 @@ export const ListDrawerContent: React.FC<ListDrawerProps> = ({
const moreThanOneAvailableCollection = enabledCollectionConfigs.length > 1
useEffect(() => {
const { slug, admin: { listSearchableFields } = {} } = selectedCollectionConfig
const { slug, admin: { listSearchableFields } = {}, versions } = selectedCollectionConfig
const params: {
cacheBust?: number
draft?: string
limit?: number
page?: number
search?: string
@@ -172,6 +173,7 @@ export const ListDrawerContent: React.FC<ListDrawerProps> = ({
if (sort) params.sort = sort
if (cacheBust) params.cacheBust = cacheBust
if (copyOfWhere) params.where = copyOfWhere
if (versions?.drafts) params.draft = 'true'
setParams(params)
}, [

View File

@@ -137,6 +137,7 @@ const UploadInput: React.FC<UploadInputProps> = (props) => {
fieldBaseClass,
baseClass,
className,
`field-${path.replace(/\./g, '__')}`,
showError && 'error',
readOnly && 'read-only',
]

View File

@@ -17,9 +17,9 @@ export type globalViewType =
| 'Version'
| 'Versions'
export const defaultGlobalViews: {
export const defaultGlobalViews = (): {
[key in globalViewType]: React.ComponentType<any>
} = {
} => ({
API,
Default: DefaultGlobalEdit,
LivePreview: LivePreviewView,
@@ -27,7 +27,7 @@ export const defaultGlobalViews: {
Relationships: null,
Version: VersionView,
Versions: VersionsView,
}
})
export const CustomGlobalComponent = (
args: GlobalEditViewProps & {
@@ -43,18 +43,14 @@ export const CustomGlobalComponent = (
// For example, the Edit view:
// 1. Edit?.Default
// 2. Edit?.Default?.Component
// TODO: Remove the `@ts-ignore` when a Typescript wizard arrives
// For some reason `Component` does not exist on type `Edit[view]` no matter how narrow the type is
const Component =
typeof Edit === 'object' && typeof Edit[view] === 'function'
? Edit[view]
: typeof Edit === 'object' &&
typeof Edit?.[view] === 'object' &&
// @ts-ignore
typeof Edit[view].Component === 'function'
? // @ts-ignore
Edit[view].Component
: defaultGlobalViews[view]
? Edit[view].Component
: defaultGlobalViews()[view]
if (Component) {
return <Component {...args} />

View File

@@ -17,9 +17,9 @@ export type collectionViewType =
| 'Version'
| 'Versions'
export const defaultCollectionViews: {
export const defaultCollectionViews = (): {
[key in collectionViewType]: React.ComponentType<any>
} = {
} => ({
API,
Default: DefaultCollectionEdit,
LivePreview: LivePreviewView,
@@ -27,7 +27,7 @@ export const defaultCollectionViews: {
Relationships: null,
Version: VersionView,
Versions: VersionsView,
}
})
export const CustomCollectionComponent = (
args: CollectionEditViewProps & {
@@ -43,18 +43,15 @@ export const CustomCollectionComponent = (
// For example, the Edit view:
// 1. Edit?.Default
// 2. Edit?.Default?.Component
// TODO: Remove the `@ts-ignore` when a Typescript wizard arrives
// For some reason `Component` does not exist on type `Edit[view]` no matter how narrow the type is
const Component =
typeof Edit === 'object' && typeof Edit[view] === 'function'
? Edit[view]
: typeof Edit === 'object' &&
typeof Edit?.[view] === 'object' &&
// @ts-ignore
typeof Edit[view].Component === 'function'
? // @ts-ignore
Edit[view].Component
: defaultCollectionViews[view]
? Edit[view].Component
: defaultCollectionViews()[view]
if (Component) {
return <Component {...args} />

View File

@@ -18,8 +18,8 @@ import sanitizeInternalFields from '../../utilities/sanitizeInternalFields'
import isLocked from '../isLocked'
import { authenticateLocalStrategy } from '../strategies/local/authenticate'
import { incrementLoginAttempts } from '../strategies/local/incrementLoginAttempts'
import { resetLoginAttempts } from '../strategies/local/resetLoginAttempts'
import { getFieldsToSign } from './getFieldsToSign'
import unlock from './unlock'
export type Result = {
exp?: number
@@ -115,16 +115,16 @@ async function login<TSlug extends keyof GeneratedTypes['collections']>(
})
}
if (shouldCommit) await commitTransaction(req)
throw new AuthenticationError(req.t)
}
if (maxLoginAttemptsEnabled) {
await unlock({
collection: {
config: collectionConfig,
},
data,
overrideAccess: true,
await resetLoginAttempts({
collection: collectionConfig,
doc: user,
payload: req.payload,
req,
})
}

View File

@@ -52,5 +52,6 @@ export const incrementLoginAttempts = async ({
id: doc.id,
collection: collection.slug,
data,
req,
})
}

View File

@@ -15,6 +15,7 @@ export const resetLoginAttempts = async ({
payload,
req,
}: Args): Promise<void> => {
if (!('lockUntil' in doc && typeof doc.lockUntil === 'string') || doc.loginAttempts === 0) return
await payload.update({
id: doc.id,
collection: collection.slug,
@@ -22,6 +23,7 @@ export const resetLoginAttempts = async ({
lockUntil: null,
loginAttempts: 0,
},
overrideAccess: true,
req,
})
}

View File

@@ -27,7 +27,7 @@ const availableCommands = [
const availableCommandsMsg = `Available commands: ${availableCommands.join(', ')}`
export const migrate = async (parsedArgs: ParsedArgs): Promise<void> => {
const { _: args, file, help } = parsedArgs
const { _: args, file, forceAcceptWarning, help } = parsedArgs
if (help) {
// eslint-disable-next-line no-console
console.log(`\n\n${availableCommandsMsg}\n`) // Avoid having to init payload to get the logger
@@ -74,11 +74,16 @@ export const migrate = async (parsedArgs: ParsedArgs): Promise<void> => {
await adapter.migrateReset()
break
case 'migrate:fresh':
await adapter.migrateFresh()
await adapter.migrateFresh({ forceAcceptWarning })
break
case 'migrate:create':
try {
await adapter.createMigration({ file, migrationName: args[1], payload })
await adapter.createMigration({
file,
forceAcceptWarning,
migrationName: args[1],
payload,
})
} catch (err) {
throw new Error(`Error creating migration: ${err.message}`)
}

View File

@@ -3,7 +3,7 @@ import httpStatus from 'http-status'
import type { FindOneArgs } from '../../database/types'
import type { PayloadRequest } from '../../express/types'
import type { Collection, TypeWithID, BeforeOperationHook } from '../config/types'
import type { Collection, TypeWithID } from '../config/types'
import executeAccess from '../../auth/executeAccess'
import { hasWhereAccessResult } from '../../auth/types'
@@ -45,26 +45,6 @@ async function restoreVersion<T extends TypeWithID = any>(args: Arguments): Prom
throw new APIError('Missing ID of version to restore.', httpStatus.BAD_REQUEST)
}
// WIP: https://github.com/payloadcms/payload/discussions/4901
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'update',
})) || args
},
Promise.resolve(),
)
// /////////////////////////////////////
// Retrieve original raw version
// /////////////////////////////////////

View File

@@ -39,7 +39,7 @@ export function createDatabaseAdapter<T extends BaseDatabaseAdapter>(
createMigration,
migrate,
migrateDown,
migrateFresh: async () => null,
migrateFresh: async ({ forceAcceptWarning = null }) => null,
migrateRefresh,
migrateReset,
migrateStatus,

View File

@@ -78,7 +78,7 @@ export interface BaseDatabaseAdapter {
/**
* Drop the current database and run all migrate up functions
*/
migrateFresh: () => Promise<void>
migrateFresh: (args: { forceAcceptWarning?: boolean }) => Promise<void>
/**
* Run all migration down functions before running up
*/
@@ -138,6 +138,10 @@ export type Destroy = (payload: Payload) => Promise<void>
export type CreateMigration = (args: {
file?: string
/**
* Skips the prompt asking to create empty migrations
*/
forceAcceptWarning?: boolean
migrationName?: string
payload: Payload
}) => Promise<void>

View File

@@ -10,6 +10,9 @@ export async function getFilePrefix({
const imageSizes = (collection?.upload as IncomingUploadType)?.imageSizes || []
const files = await req.payload.find({
collection: collection.slug,
depth: 0,
limit: 1,
pagination: false,
where: {
or: [
{

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/richtext-slate",
"version": "1.3.1",
"version": "1.4.0",
"description": "The officially supported Slate richtext adapter for Payload",
"repository": "https://github.com/payloadcms/payload",
"license": "MIT",

View File

@@ -4,10 +4,10 @@ import { usersCollectionSlug } from '../slugs'
export const Users: CollectionConfig = {
slug: usersCollectionSlug,
auth: true,
admin: {
useAsTitle: 'email',
},
auth: true,
fields: [
{
name: 'textField',

View File

@@ -16,13 +16,21 @@ const bundlerAdapters = {
webpack: webpackBundler(),
}
const [testSuiteDir] = process.argv.slice(4)
const migrationDir = path.resolve(
(process.env.PAYLOAD_CONFIG_PATH
? path.join(process.env.PAYLOAD_CONFIG_PATH, '..')
: testSuiteDir) || __dirname,
'migrations',
)
const databaseAdapters = {
mongoose: mongooseAdapter({
migrationDir: path.resolve(__dirname, '../packages/db-mongodb/migrations'),
migrationDir,
url: 'mongodb://127.0.0.1/payloadtests',
}),
postgres: postgresAdapter({
migrationDir: path.resolve(__dirname, '../packages/db-postgres/migrations'),
migrationDir,
pool: {
connectionString: process.env.POSTGRES_URL || 'postgres://127.0.0.1:5432/payloadtests',
},
@@ -33,6 +41,7 @@ export function buildConfigWithDefaults(testConfig?: Partial<Config>): Promise<S
const [name] = process.argv.slice(2)
const config: Config = {
db: databaseAdapters[process.env.PAYLOAD_DATABASE || 'mongoose'],
editor: slateEditor({}),
rateLimit: {
max: 9999999999,
@@ -40,7 +49,6 @@ export function buildConfigWithDefaults(testConfig?: Partial<Config>): Promise<S
},
telemetry: false,
...testConfig,
db: databaseAdapters[process.env.PAYLOAD_DATABASE || 'mongoose'],
}
config.admin = {

1
test/database/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
migrations

View File

@@ -4,14 +4,16 @@ import { devUser } from '../credentials'
export default buildConfigWithDefaults({
collections: [
{
slug: 'posts',
fields: [
{
name: 'title',
required: true,
type: 'text',
required: true,
},
{
name: 'throwAfterChange',
type: 'checkbox',
defaultValue: false,
hooks: {
afterChange: [
@@ -22,17 +24,16 @@ export default buildConfigWithDefaults({
},
],
},
type: 'checkbox',
},
],
slug: 'posts',
},
{
slug: 'relation-a',
fields: [
{
name: 'relationship',
relationTo: 'relation-b',
type: 'relationship',
relationTo: 'relation-b',
},
{
name: 'richText',
@@ -43,14 +44,14 @@ export default buildConfigWithDefaults({
plural: 'Relation As',
singular: 'Relation A',
},
slug: 'relation-a',
},
{
slug: 'relation-b',
fields: [
{
name: 'relationship',
relationTo: 'relation-a',
type: 'relationship',
relationTo: 'relation-a',
},
{
name: 'richText',
@@ -61,7 +62,6 @@ export default buildConfigWithDefaults({
plural: 'Relation Bs',
singular: 'Relation B',
},
slug: 'relation-b',
},
],
onInit: async (payload) => {

View File

@@ -1,13 +1,19 @@
import { sql } from 'drizzle-orm'
import fs from 'fs'
import { GraphQLClient } from 'graphql-request'
import path from 'path'
import type { DrizzleDB } from '../../packages/db-postgres/src/types'
import type { TypeWithID } from '../../packages/payload/src/collections/config/types'
import type { PayloadRequest } from '../../packages/payload/src/express/types'
import payload from '../../packages/payload/src'
import { migrate } from '../../packages/payload/src/bin/migrate'
import { commitTransaction } from '../../packages/payload/src/utilities/commitTransaction'
import { initTransaction } from '../../packages/payload/src/utilities/initTransaction'
import { devUser } from '../credentials'
import { initPayloadTest } from '../helpers/configHelpers'
import removeFiles from '../helpers/removeFiles'
describe('database', () => {
let serverURL
@@ -35,6 +41,101 @@ describe('database', () => {
user = loginResult.user
})
describe('migrations', () => {
beforeAll(async () => {
if (process.env.PAYLOAD_DROP_DATABASE === 'true' && 'drizzle' in payload.db) {
const drizzle = payload.db.drizzle as DrizzleDB
// @ts-expect-error drizzle raw sql typing
await drizzle.execute(sql`drop schema public cascade;
create schema public;`)
}
})
afterAll(() => {
removeFiles(path.normalize(payload.db.migrationDir))
})
it('should run migrate:create', async () => {
const args = {
_: ['migrate:create', 'test'],
forceAcceptWarning: true,
}
await migrate(args)
// read files names in migrationsDir
const migrationFile = path.normalize(fs.readdirSync(payload.db.migrationDir)[0])
expect(migrationFile).toContain('_test')
})
it('should run migrate', async () => {
const args = {
_: ['migrate'],
}
await migrate(args)
const { docs } = await payload.find({
collection: 'payload-migrations',
})
const migration = docs[0]
expect(migration.name).toContain('_test')
expect(migration.batch).toStrictEqual(1)
})
it('should run migrate:status', async () => {
let error
const args = {
_: ['migrate:status'],
}
try {
await migrate(args)
} catch (e) {
error = e
}
expect(error).toBeUndefined()
})
it('should run migrate:fresh', async () => {
const args = {
_: ['migrate:fresh'],
forceAcceptWarning: true,
}
await migrate(args)
const { docs } = await payload.find({
collection: 'payload-migrations',
})
const migration = docs[0]
expect(migration.name).toContain('_test')
expect(migration.batch).toStrictEqual(1)
})
// known issue: https://github.com/payloadcms/payload/issues/4597
it.skip('should run migrate:down', async () => {
let error
const args = {
_: ['migrate:down'],
}
try {
await migrate(args)
} catch (e) {
error = e
}
expect(error).toBeUndefined()
})
// known issue: https://github.com/payloadcms/payload/issues/4597
it.skip('should run migrate:refresh', async () => {
let error
const args = {
_: ['migrate:refresh'],
}
try {
await migrate(args)
} catch (e) {
error = e
}
expect(error).toBeUndefined()
})
})
describe('transactions', () => {
describe('local api', () => {
it('should commit multiple operations in isolation', async () => {

View File

@@ -2,13 +2,14 @@ import fs from 'fs'
import path from 'path'
import { generateGraphQLSchema } from '../packages/payload/src/bin/generateGraphQLSchema'
import { setTestEnvPaths } from './helpers/setTestEnvPaths'
const [testConfigDir] = process.argv.slice(2)
let testDir
if (testConfigDir) {
testDir = path.resolve(__dirname, testConfigDir)
setPaths(testDir)
setTestEnvPaths(testDir)
generateGraphQLSchema()
} else {
// Generate graphql schema for entire directory
@@ -18,17 +19,7 @@ if (testConfigDir) {
.filter((f) => f.isDirectory())
.forEach((dir) => {
const suiteDir = path.resolve(testDir, dir.name)
const configFound = setPaths(suiteDir)
const configFound = setTestEnvPaths(suiteDir)
if (configFound) generateGraphQLSchema()
})
}
// Set config path and TS output path using test dir
function setPaths(dir) {
const configPath = path.resolve(dir, 'config.ts')
if (fs.existsSync(configPath)) {
process.env.PAYLOAD_CONFIG_PATH = configPath
return true
}
return false
}

View File

@@ -2,13 +2,14 @@ import fs from 'fs'
import path from 'path'
import { generateTypes } from '../packages/payload/src/bin/generateTypes'
import { setTestEnvPaths } from './helpers/setTestEnvPaths'
const [testConfigDir] = process.argv.slice(2)
let testDir
if (testConfigDir) {
testDir = path.resolve(__dirname, testConfigDir)
setPaths(testDir)
setTestEnvPaths(testDir)
generateTypes()
} else {
// Generate types for entire directory
@@ -18,19 +19,7 @@ if (testConfigDir) {
.filter((f) => f.isDirectory())
.forEach((dir) => {
const suiteDir = path.resolve(testDir, dir.name)
const configFound = setPaths(suiteDir)
const configFound = setTestEnvPaths(suiteDir)
if (configFound) generateTypes()
})
}
// Set config path and TS output path using test dir
function setPaths(dir) {
const configPath = path.resolve(dir, 'config.ts')
const outputPath = path.resolve(dir, 'payload-types.ts')
if (fs.existsSync(configPath)) {
process.env.PAYLOAD_CONFIG_PATH = configPath
process.env.PAYLOAD_TS_OUTPUT_PATH = outputPath
return true
}
return false
}

View File

@@ -0,0 +1,14 @@
// Set config path and TS output path using test dir
import fs from 'fs'
import path from 'path'
export function setTestEnvPaths(dir) {
const configPath = path.resolve(dir, 'config.ts')
const outputPath = path.resolve(dir, 'payload-types.ts')
if (fs.existsSync(configPath)) {
process.env.PAYLOAD_CONFIG_PATH = configPath
process.env.PAYLOAD_TS_OUTPUT_PATH = outputPath
return true
}
return false
}

View File

@@ -0,0 +1,12 @@
import type { AfterLoginHook } from '../../../../packages/payload/src/collections/config/types'
export const afterLoginHook: AfterLoginHook = async ({ req, user }) => {
return req.payload.update({
id: user.id,
collection: 'hooks-users',
data: {
afterLoginHook: true,
},
req,
})
}

View File

@@ -6,8 +6,9 @@ import type { Payload } from '../../../../packages/payload/src/payload'
import { AuthenticationError } from '../../../../packages/payload/src/errors'
import { devUser, regularUser } from '../../../credentials'
import { afterLoginHook } from './afterLoginHook'
const beforeLoginHook: BeforeLoginHook = ({ user, req }) => {
const beforeLoginHook: BeforeLoginHook = ({ req, user }) => {
const isAdmin = user.roles.includes('admin') ? user : undefined
if (!isAdmin) {
throw new AuthenticationError(req.t)
@@ -33,16 +34,21 @@ const Users: CollectionConfig = {
fields: [
{
name: 'roles',
label: 'Role',
type: 'select',
options: ['admin', 'user'],
defaultValue: 'user',
hasMany: true,
label: 'Role',
options: ['admin', 'user'],
required: true,
saveToJWT: true,
hasMany: true,
},
{
name: 'afterLoginHook',
type: 'checkbox',
},
],
hooks: {
afterLogin: [afterLoginHook],
beforeLogin: [beforeLoginHook],
},
}

View File

@@ -27,7 +27,7 @@ describe('Hooks', () => {
beforeAll(async () => {
const { serverURL } = await initPayloadTest({ __dirname, init: { local: false } })
const config = await configPromise
client = new RESTClient(config, { serverURL, defaultSlug: transformSlug })
client = new RESTClient(config, { defaultSlug: transformSlug, serverURL })
apiUrl = `${serverURL}/api`
})
@@ -43,8 +43,8 @@ describe('Hooks', () => {
const doc = await payload.create({
collection: transformSlug,
data: {
transform: [2, 8],
localizedTransform: [2, 8],
transform: [2, 8],
},
})
@@ -59,15 +59,15 @@ describe('Hooks', () => {
doc = await payload.create({
collection: hooksSlug,
data: {
fieldBeforeValidate: false,
collectionBeforeValidate: false,
fieldBeforeChange: false,
collectionBeforeChange: false,
fieldAfterChange: false,
collectionAfterChange: false,
collectionBeforeRead: false,
fieldAfterRead: false,
collectionAfterRead: false,
collectionBeforeChange: false,
collectionBeforeRead: false,
collectionBeforeValidate: false,
fieldAfterChange: false,
fieldAfterRead: false,
fieldBeforeChange: false,
fieldBeforeValidate: false,
},
})
@@ -84,10 +84,10 @@ describe('Hooks', () => {
const document: NestedAfterReadHook = await payload.create({
collection: nestedAfterReadHooksSlug,
data: {
text: 'ok',
group: {
array: [{ input: 'input' }],
},
text: 'ok',
},
})
@@ -106,7 +106,6 @@ describe('Hooks', () => {
const document = await payload.create({
collection: nestedAfterReadHooksSlug,
data: {
text: 'ok',
group: {
array: [
{
@@ -117,12 +116,13 @@ describe('Hooks', () => {
shouldPopulate: relation.id,
},
},
text: 'ok',
},
})
const retrievedDoc = await payload.findByID({
collection: nestedAfterReadHooksSlug,
id: document.id,
collection: nestedAfterReadHooksSlug,
})
expect(retrievedDoc.group.array[0].shouldPopulate.title).toEqual(relation.title)
@@ -138,8 +138,8 @@ describe('Hooks', () => {
})
const retrievedDoc = await payload.findByID({
collection: chainingHooksSlug,
id: document.id,
collection: chainingHooksSlug,
})
expect(retrievedDoc.text).toEqual('ok!!')
@@ -189,15 +189,15 @@ describe('Hooks', () => {
const [updatedDoc1, updatedDoc2] = await Promise.all([
await payload.update({
collection: afterOperationSlug,
id: doc1.id,
collection: afterOperationSlug,
data: {
title: 'Title',
},
}),
await payload.update({
collection: afterOperationSlug,
id: doc2.id,
collection: afterOperationSlug,
data: {
title: 'Title',
},
@@ -225,8 +225,8 @@ describe('Hooks', () => {
})
const retrievedDoc = await payload.findByID({
collection: contextHooksSlug,
id: document.id,
collection: contextHooksSlug,
})
expect(retrievedDoc.value).toEqual('secret')
@@ -235,17 +235,17 @@ describe('Hooks', () => {
it('should pass context from local API to hooks', async () => {
const document = await payload.create({
collection: contextHooksSlug,
data: {
value: 'wrongvalue',
},
context: {
secretValue: 'data from local API',
},
data: {
value: 'wrongvalue',
},
})
const retrievedDoc = await payload.findByID({
collection: contextHooksSlug,
id: document.id,
collection: contextHooksSlug,
})
expect(retrievedDoc.value).toEqual('data from local API')
@@ -282,8 +282,8 @@ describe('Hooks', () => {
const document = (await response.json()).doc
const retrievedDoc = await payload.findByID({
collection: contextHooksSlug,
id: document.id,
collection: contextHooksSlug,
})
expect(retrievedDoc.value).toEqual('data from rest API')
@@ -291,7 +291,7 @@ describe('Hooks', () => {
})
describe('auth collection hooks', () => {
it('allow admin login', async () => {
it('should call afterLogin hook', async () => {
const { user } = await payload.login({
collection: hooksUsersSlug,
data: {
@@ -299,7 +299,15 @@ describe('Hooks', () => {
password: devUser.password,
},
})
const result = await payload.findByID({
id: user.id,
collection: hooksUsersSlug,
})
expect(user).toBeDefined()
expect(user.afterLoginHook).toStrictEqual(true)
expect(result.afterLoginHook).toStrictEqual(true)
})
it('deny user login', async () => {
@@ -342,8 +350,8 @@ describe('Hooks', () => {
// BeforeRead is only run for find operations
const foundDoc = await payload.findByID({
collection: dataHooksSlug,
id: doc.id,
collection: dataHooksSlug,
})
expect(JSON.parse(foundDoc.collection_beforeRead_collection)).toStrictEqual(

View File

@@ -1,3 +1,4 @@
media
uploads
versions
/media-gif

View File

@@ -7,12 +7,11 @@ import removeFiles from '../helpers/removeFiles'
import { Uploads1 } from './collections/Upload1'
import Uploads2 from './collections/Upload2'
import AdminThumbnailCol from './collections/admin-thumbnail'
import { audioSlug, enlargeSlug, mediaSlug, reduceSlug, relationSlug } from './shared'
import { audioSlug, enlargeSlug, mediaSlug, reduceSlug, relationSlug, versionSlug } from './shared'
const mockModulePath = path.resolve(__dirname, './mocks/mockFSModule.js')
export default buildConfigWithDefaults({
serverURL: undefined,
admin: {
webpack: (config) => ({
...config,
@@ -34,6 +33,11 @@ export default buildConfigWithDefaults({
type: 'upload',
relationTo: 'media',
},
{
name: 'versionedImage',
type: 'upload',
relationTo: versionSlug,
},
],
},
{
@@ -42,164 +46,157 @@ export default buildConfigWithDefaults({
{
name: 'audio',
type: 'upload',
relationTo: 'media',
filterOptions: {
mimeType: {
in: ['audio/mpeg'],
},
},
relationTo: 'media',
},
],
},
{
slug: 'gif-resize',
fields: [],
upload: {
staticURL: '/media-gif',
staticDir: './media-gif',
mimeTypes: ['image/gif'],
resizeOptions: {
position: 'center',
width: 200,
height: 200,
},
formatOptions: {
format: 'gif',
},
imageSizes: [
{
name: 'small',
width: 100,
height: 100,
formatOptions: { format: 'gif', options: { quality: 90 } },
height: 100,
width: 100,
},
{
name: 'large',
width: 1000,
height: 1000,
formatOptions: { format: 'gif', options: { quality: 90 } },
height: 1000,
width: 1000,
},
],
mimeTypes: ['image/gif'],
resizeOptions: {
height: 200,
position: 'center',
width: 200,
},
staticDir: './media-gif',
staticURL: '/media-gif',
},
fields: [],
},
{
slug: 'no-image-sizes',
fields: [],
upload: {
staticURL: '/no-image-sizes',
staticDir: './no-image-sizes',
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
resizeOptions: {
height: 200,
position: 'center',
width: 200,
height: 200,
},
staticDir: './no-image-sizes',
staticURL: '/no-image-sizes',
},
fields: [],
},
{
slug: 'object-fit',
fields: [],
upload: {
staticURL: '/object-fit',
staticDir: './object-fit',
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
imageSizes: [
{
name: 'fitContain',
width: 400,
height: 300,
fit: 'contain',
height: 300,
width: 400,
},
{
name: 'fitInside',
width: 300,
height: 400,
fit: 'inside',
height: 400,
width: 300,
},
{
name: 'fitCover',
width: 900,
height: 300,
fit: 'cover',
height: 300,
width: 900,
},
{
name: 'fitOutside',
width: 900,
height: 200,
fit: 'outside',
height: 200,
width: 900,
},
],
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
staticDir: './object-fit',
staticURL: '/object-fit',
},
fields: [],
},
{
slug: 'crop-only',
fields: [],
upload: {
focalPoint: false,
staticURL: '/crop-only',
staticDir: './crop-only',
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
imageSizes: [
{
name: 'focalTest',
width: 400,
height: 300,
width: 400,
},
{
name: 'focalTest2',
width: 600,
height: 300,
width: 600,
},
{
name: 'focalTest3',
width: 900,
height: 300,
width: 900,
},
],
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
staticDir: './crop-only',
staticURL: '/crop-only',
},
fields: [],
},
{
slug: 'focal-only',
fields: [],
upload: {
crop: false,
staticURL: '/focal-only',
staticDir: './focal-only',
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
imageSizes: [
{
name: 'focalTest',
width: 400,
height: 300,
width: 400,
},
{
name: 'focalTest2',
width: 600,
height: 300,
width: 600,
},
{
name: 'focalTest3',
width: 900,
height: 300,
width: 900,
},
],
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
staticDir: './focal-only',
staticURL: '/focal-only',
},
fields: [],
},
{
slug: mediaSlug,
fields: [],
upload: {
staticURL: '/media',
staticDir: './media',
staticURL: '/media',
// crop: false,
// focalPoint: false,
mimeTypes: [
'image/png',
'image/jpg',
'image/jpeg',
'image/gif',
'image/svg+xml',
'audio/mpeg',
],
formatOptions: {
format: 'png',
options: { quality: 90 },
@@ -207,143 +204,133 @@ export default buildConfigWithDefaults({
imageSizes: [
{
name: 'maintainedAspectRatio',
width: 1024,
height: undefined,
crop: 'center',
position: 'center',
formatOptions: { format: 'png', options: { quality: 90 } },
height: undefined,
position: 'center',
width: 1024,
},
{
name: 'differentFormatFromMainImage',
width: 200,
height: undefined,
formatOptions: { format: 'jpg', options: { quality: 90 } },
height: undefined,
width: 200,
},
{
name: 'maintainedImageSize',
width: undefined,
height: undefined,
width: undefined,
},
{
name: 'maintainedImageSizeWithNewFormat',
width: undefined,
height: undefined,
formatOptions: { format: 'jpg', options: { quality: 90 } },
height: undefined,
width: undefined,
},
{
name: 'accidentalSameSize',
width: 320,
height: 80,
position: 'top',
width: 320,
},
{
name: 'tablet',
width: 640,
height: 480,
width: 640,
},
{
name: 'mobile',
width: 320,
height: 240,
crop: 'left top',
height: 240,
width: 320,
},
{
name: 'icon',
width: 16,
height: 16,
width: 16,
},
{
name: 'focalTest',
width: 400,
height: 300,
width: 400,
},
{
name: 'focalTest2',
width: 600,
height: 300,
width: 600,
},
{
name: 'focalTest3',
width: 900,
height: 300,
width: 900,
},
{
name: 'focalTest4',
width: 300,
height: 400,
width: 300,
},
{
name: 'focalTest5',
width: 300,
height: 600,
width: 300,
},
{
name: 'focalTest6',
width: 300,
height: 800,
width: 300,
},
{
name: 'focalTest7',
width: 300,
height: 300,
width: 300,
},
],
mimeTypes: [
'image/png',
'image/jpg',
'image/jpeg',
'image/gif',
'image/svg+xml',
'audio/mpeg',
],
},
fields: [],
},
{
slug: enlargeSlug,
fields: [],
upload: {
staticURL: '/enlarge',
staticDir: './media/enlarge',
mimeTypes: [
'image/png',
'image/jpg',
'image/jpeg',
'image/gif',
'image/svg+xml',
'audio/mpeg',
],
imageSizes: [
{
name: 'accidentalSameSize',
width: 320,
height: 80,
width: 320,
withoutEnlargement: false,
},
{
name: 'sameSizeWithNewFormat',
width: 320,
height: 80,
formatOptions: { format: 'jpg', options: { quality: 90 } },
height: 80,
width: 320,
withoutEnlargement: false,
},
{
name: 'resizedLarger',
width: 640,
height: 480,
width: 640,
withoutEnlargement: false,
},
{
name: 'resizedSmaller',
width: 180,
height: 50,
width: 180,
},
{
name: 'widthLowerHeightLarger',
width: 300,
height: 300,
fit: 'contain',
height: 300,
width: 300,
},
],
},
fields: [],
},
{
slug: reduceSlug,
upload: {
staticURL: '/reduce',
staticDir: './media/reduce',
mimeTypes: [
'image/png',
'image/jpg',
@@ -352,105 +339,135 @@ export default buildConfigWithDefaults({
'image/svg+xml',
'audio/mpeg',
],
staticDir: './media/enlarge',
staticURL: '/enlarge',
},
},
{
slug: reduceSlug,
fields: [],
upload: {
imageSizes: [
{
name: 'accidentalSameSize',
width: 320,
height: 80,
width: 320,
withoutEnlargement: false,
},
{
name: 'sameSizeWithNewFormat',
width: 320,
height: 80,
formatOptions: { format: 'jpg', options: { quality: 90 } },
height: 80,
width: 320,
withoutReduction: true,
},
{
name: 'resizedLarger',
width: 640,
height: 480,
width: 640,
},
{
name: 'resizedSmaller',
width: 180,
height: 50,
width: 180,
withoutReduction: true,
},
],
mimeTypes: [
'image/png',
'image/jpg',
'image/jpeg',
'image/gif',
'image/svg+xml',
'audio/mpeg',
],
staticDir: './media/reduce',
staticURL: '/reduce',
},
fields: [],
},
{
slug: 'media-trim',
fields: [],
upload: {
staticURL: '/media-trim',
staticDir: './media-trim',
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
trimOptions: 0,
imageSizes: [
{
name: 'trimNumber',
width: 1024,
height: undefined,
trimOptions: 0,
width: 1024,
},
{
name: 'trimString',
width: 1024,
height: undefined,
trimOptions: 0,
width: 1024,
},
{
name: 'trimOptions',
width: 1024,
height: undefined,
trimOptions: {
background: '#000000',
threshold: 50,
},
width: 1024,
},
],
mimeTypes: ['image/png', 'image/jpg', 'image/jpeg'],
staticDir: './media-trim',
staticURL: '/media-trim',
trimOptions: 0,
},
fields: [],
},
{
slug: 'unstored-media',
upload: {
staticURL: '/media',
disableLocalStorage: true,
},
fields: [],
upload: {
disableLocalStorage: true,
staticURL: '/media',
},
},
{
slug: 'externally-served-media',
fields: [],
upload: {
// Either use another web server like `npx serve -l 4000` (http://localhost:4000) or use the static server from the previous collection to serve the media folder (http://localhost:3000/media)
staticURL: 'http://localhost:3000/media',
staticDir: './media',
staticURL: 'http://localhost:3000/media',
},
fields: [],
},
Uploads1,
Uploads2,
AdminThumbnailCol,
{
slug: 'optional-file',
upload: {
staticURL: '/optional',
staticDir: './optional',
filesRequiredOnCreate: false,
},
fields: [],
upload: {
filesRequiredOnCreate: false,
staticDir: './optional',
staticURL: '/optional',
},
},
{
slug: 'required-file',
upload: {
staticURL: '/required',
staticDir: './required',
filesRequiredOnCreate: true,
},
fields: [],
upload: {
filesRequiredOnCreate: true,
staticDir: './required',
staticURL: '/required',
},
},
{
slug: versionSlug,
fields: [
{
name: 'title',
type: 'text',
},
],
upload: true,
versions: {
drafts: true,
},
},
],
onInit: async (payload) => {
@@ -475,10 +492,20 @@ export default buildConfigWithDefaults({
file: imageFile,
})
const { id: versionedImage } = await payload.create({
collection: versionSlug,
data: {
_status: 'published',
title: 'upload',
},
file: imageFile,
})
await payload.create({
collection: relationSlug,
data: {
image: uploadedImage,
versionedImage,
},
})
@@ -518,4 +545,5 @@ export default buildConfigWithDefaults({
},
})
},
serverURL: undefined,
})

View File

@@ -29,7 +29,7 @@ describe('uploads', () => {
beforeAll(async ({ browser }) => {
const { serverURL } = await initPayloadE2E(__dirname)
client = new RESTClient(null, { serverURL, defaultSlug: 'users' })
client = new RESTClient(null, { defaultSlug: 'users', serverURL })
await client.login()
mediaURL = new AdminUrlUtil(serverURL, mediaSlug)
@@ -149,6 +149,33 @@ describe('uploads', () => {
await expect(iconMeta).toContainText('16x16')
})
test('should show draft uploads in the relation list', async () => {
await page.goto(relationURL.list)
// from the list edit the first document
await page.locator('.row-1 a').click()
// edit the versioned image
await page.locator('.field-versionedImage .icon--edit').click()
// fill the title with 'draft'
await page.locator('#field-title').fill('draft')
// save draft
await page.locator('#action-save-draft').click()
// close the drawer
await page.locator('.doc-drawer__header-close').click()
// remove the selected versioned image
await page.locator('.field-versionedImage .icon--x').click()
// choose from existing
await page.locator('.list-drawer__toggler').click()
await expect(page.locator('.cell-title')).toContainText('draft')
})
test('should restrict mimetype based on filterOptions', async () => {
await page.goto(audioURL.edit(audioDoc.id))
await wait(200)
@@ -214,21 +241,21 @@ describe('uploads', () => {
describe('image manipulation', () => {
test('should crop image correctly', async () => {
const positions = {
'top-left': {
focalX: 25,
focalY: 25,
dragX: 0,
dragY: 0,
},
'bottom-right': {
focalX: 75,
focalY: 75,
dragX: 800,
dragY: 800,
focalX: 75,
focalY: 75,
},
'top-left': {
dragX: 0,
dragY: 0,
focalX: 25,
focalY: 25,
},
}
const createFocalCrop = async (page: Page, position: 'bottom-right' | 'top-left') => {
const { focalX, focalY, dragX, dragY } = positions[position]
const { dragX, dragY, focalX, focalY } = positions[position]
await page.goto(mediaURL.create)
// select and upload file

View File

@@ -9,3 +9,5 @@ export const enlargeSlug = 'enlarge'
export const reduceSlug = 'reduce'
export const adminThumbnailSlug = 'admin-thumbnail'
export const versionSlug = 'versions'