Skip to content

chore: replace dynamic tsconfig path generation with static imports #11984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,7 @@
"eslint --cache --fix"
],
"templates/website/**/*": "sh -c \"cd templates/website; pnpm install --no-frozen-lockfile --ignore-workspace; pnpm run lint --fix\"",
"templates/**/pnpm-lock.yaml": "pnpm runts scripts/remove-template-lock-files.ts",
"tsconfig.json": "node scripts/reset-tsconfig.js"
"templates/**/pnpm-lock.yaml": "pnpm runts scripts/remove-template-lock-files.ts"
},
"devDependencies": {
"@jest/globals": "29.7.0",
Expand Down
30 changes: 0 additions & 30 deletions scripts/reset-tsconfig.js

This file was deleted.

14 changes: 0 additions & 14 deletions test/app/(app)/layout.tsx

This file was deleted.

11 changes: 0 additions & 11 deletions test/app/(app)/test/page.tsx

This file was deleted.

65 changes: 65 additions & 0 deletions test/config-imports.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
export const staticConfigImports = {
_community: () => import('./_community/config.js'),
'access-control': () => import('./access-control/config.js'),
'admin-bar': () => import('./admin-bar/config.js'),
'admin-root': () => import('./admin-root/config.js'),
admin: () => import('./admin/config.js'),
'array-update': () => import('./array-update/config.js'),
'auth-basic': () => import('./auth-basic/config.js'),
auth: () => import('./auth/config.js'),
'benchmark-blocks': () => import('./benchmark-blocks/config.js'),
'bulk-edit': () => import('./bulk-edit/config.js'),
'collections-graphql': () => import('./collections-graphql/config.js'),
'collections-rest': () => import('./collections-rest/config.js'),
config: () => import('./config/config.js'),
'custom-graphql': () => import('./custom-graphql/config.js'),
database: () => import('./database/config.js'),
dataloader: () => import('./dataloader/config.js'),
'email-nodemailer': () => import('./email-nodemailer/config.js'),
'email-resend': () => import('./email-resend/config.js'),
email: () => import('./email/config.js'),
endpoints: () => import('./endpoints/config.js'),
'field-error-states': () => import('./field-error-states/config.js'),
'field-perf': () => import('./field-perf/config.js'),
'fields-relationship': () => import('./fields-relationship/config.js'),
fields: () => import('./fields/config.js'),
'form-state': () => import('./form-state/config.js'),
globals: () => import('./globals/config.js'),
'graphql-schema-gen': () => import('./graphql-schema-gen/config.js'),
graphql: () => import('./graphql/config.js'),
hooks: () => import('./hooks/config.js'),
i18n: () => import('./i18n/config.js'),
joins: () => import('./joins/config.js'),
'lexical-mdx': () => import('./lexical-mdx/config.js'),
'live-preview': () => import('./live-preview/config.js'),
'localization-rtl': () => import('./localization-rtl/config.js'),
localization: () => import('./localization/config.js'),
'locked-documents': () => import('./locked-documents/config.js'),
'login-with-username': () => import('./login-with-username/config.js'),
'migrations-cli': () => import('./migrations-cli/config.js'),
'nested-fields': () => import('./nested-fields/config.js'),
'payload-cloud': () => import('./payload-cloud/config.js'),
'plugin-cloud-storage': () => import('./plugin-cloud-storage/config.js'),
'plugin-form-builder': () => import('./plugin-form-builder/config.js'),
'plugin-import-export': () => import('./plugin-import-export/config.js'),
'plugin-multi-tenant': () => import('./plugin-multi-tenant/config.js'),
'plugin-nested-docs': () => import('./plugin-nested-docs/config.js'),
'plugin-redirects': () => import('./plugin-redirects/config.js'),
'plugin-search': () => import('./plugin-search/config.js'),
'plugin-sentry': () => import('./plugin-sentry/config.js'),
'plugin-seo': () => import('./plugin-seo/config.js'),
'plugin-stripe': () => import('./plugin-stripe/config.js'),
plugins: () => import('./plugins/config.js'),
'query-presets': () => import('./query-presets/config.js'),
queues: () => import('./queues/config.js'),
relationships: () => import('./relationships/config.js'),
select: () => import('./select/config.js'),
sort: () => import('./sort/config.js'),
'storage-azure': () => import('./storage-azure/config.js'),
'storage-gcs': () => import('./storage-gcs/config.js'),
'storage-s3': () => import('./storage-s3/config.js'),
'storage-uploadthing': () => import('./storage-uploadthing/config.js'),
'storage-vercel-blob': () => import('./storage-vercel-blob/config.js'),
uploads: () => import('./uploads/config.js'),
versions: () => import('./versions/config.js'),
} as const
15 changes: 14 additions & 1 deletion test/dev.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import open from 'open'
import { loadEnv } from 'payload/node'
import { parse } from 'url'

import { staticConfigImports } from './config-imports.js'
import { getNextRootDir } from './helpers/getNextRootDir.js'
import startMemoryDB from './helpers/startMemoryDB.js'
import { runInit } from './runInit.js'
Expand Down Expand Up @@ -55,13 +56,25 @@ if (!testSuiteArg || !fs.existsSync(path.resolve(dirname, testSuiteArg))) {
process.exit(0)
}

if (!(testSuiteArg in staticConfigImports)) {
console.log(
chalk.red(
[
`ERROR: The test folder "${testSuiteArg}" exists, but you need to add`,
`it to the static config imports object in /test/config-imports.ts`,
].join(' '),
),
)
process.exit(0)
}

console.log(`Selected test suite: ${testSuiteArg}`)

if (args.turbo === true) {
process.env.TURBOPACK = '1'
}

const { beforeTest } = await createTestHooks(testSuiteArg, testSuiteConfigOverride)
const { beforeTest } = createTestHooks(testSuiteArg, testSuiteConfigOverride)
await beforeTest()

const { rootDir, adminRoute } = getNextRootDir(testSuiteArg)
Expand Down
22 changes: 22 additions & 0 deletions test/dynamic-config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/* eslint-disable no-restricted-exports */

import { staticConfigImports } from './config-imports.js'

if (!process.env.PAYLOAD_CONFIG_PATH) {
throw new Error('PAYLOAD_CONFIG_PATH environment variable is required')
}

// Extract the suite name from the path
const suiteName = process.env.PAYLOAD_CONFIG_PATH.split('/').slice(
-2,
)[0] as keyof typeof staticConfigImports

if (!(suiteName in staticConfigImports)) {
throw new Error(
`Unknown test suite: ${suiteName}. This error should have been
caught several seconds earlier in dev.ts.`,
)
}

const config = await staticConfigImports[suiteName]()
export default config.default
42 changes: 17 additions & 25 deletions test/testHooks.ts
Original file line number Diff line number Diff line change
@@ -1,49 +1,41 @@
import { parse, stringify } from 'comment-json'
import { existsSync, promises } from 'fs'
import path from 'path'
import { fileURLToPath } from 'url'

import { getNextRootDir } from './helpers/getNextRootDir.js'

const { readFile, writeFile, rm } = promises
const { rm } = promises
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)

export const createTestHooks = async (
testSuiteName = '_community',
testSuiteConfig = 'config.ts',
) => {
export const createTestHooks = (testSuiteName = '_community', testSuiteConfig = 'config.ts') => {
const rootDir = getNextRootDir().rootDir
const tsConfigBasePath = path.resolve(rootDir, './tsconfig.base.json')
const tsConfigPath = existsSync(tsConfigBasePath)
? tsConfigBasePath
: path.resolve(rootDir, './tsconfig.json')

const tsConfigContent = await readFile(tsConfigPath, 'utf8')
const tsConfig = parse(tsConfigContent)
process.env.PAYLOAD_CONFIG_PATH =
process.env.PAYLOAD_TEST_PROD === 'true'
? `./${testSuiteName}/${testSuiteConfig}`
: `./test/${testSuiteName}/${testSuiteConfig}`

console.log('Debug paths:', {
rootDir,
dirname,
testSuiteName,
testSuiteConfig,
configPath: process.env.PAYLOAD_CONFIG_PATH,
cwd: process.cwd(),
NODE_PATH: process.env.NODE_PATH,
})

return {
/**
* Clear next webpack cache and set '@payload-config' path in tsconfig.json
* Clear next webpack cache and set 'PAYLOAD_CONFIG_PATH' environment variable
*/
beforeTest: async () => {
// Delete entire .next cache folder
const nextCache = path.resolve(rootDir, './.next')
if (existsSync(nextCache)) {
await rm(nextCache, { recursive: true })
}

// Set '@payload-config' in tsconfig.json

// @ts-expect-error
tsConfig.compilerOptions.paths['@payload-config'] = [
process.env.PAYLOAD_TEST_PROD === 'true'
? `./${testSuiteName}/${testSuiteConfig}`
: `./test/${testSuiteName}/${testSuiteConfig}`,
]
await writeFile(tsConfigPath, stringify(tsConfig, null, 2) + '\n')

process.env.PAYLOAD_CONFIG_PATH = path.resolve(dirname, testSuiteName, testSuiteConfig)
},
}
}
2 changes: 1 addition & 1 deletion tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
}
],
"paths": {
"@payload-config": ["./test/_community/config.ts"],
"@payload-config": ["./test/dynamic-config.ts"],
"@payloadcms/admin-bar": ["./packages/admin-bar/src"],
"@payloadcms/live-preview": ["./packages/live-preview/src"],
"@payloadcms/live-preview-react": ["./packages/live-preview-react/src/index.ts"],
Expand Down
Loading