feat: match next.js env file loading behavior in bin scripts & importConfig, clean up installed packages & mismatching package versions

package.json

@@ -113,7 +113,7 @@
     "concat-stream": "^2.0.0",
     "copyfiles": "2.4.1",
     "cross-env": "7.0.3",
-    "dotenv": "8.6.0",
+    "dotenv": "16.4.5",
     "drizzle-kit": "0.20.14-1f2c838",
     "drizzle-orm": "0.29.4",
     "escape-html": "^1.0.3",

packages/payload/package.json

@@ -81,6 +81,7 @@
     "pretest": "pnpm build"
   },
   "dependencies": {
+    "@next/env": "^15.0.0-rc.0",
     "@payloadcms/translations": "workspace:*",
     "@swc-node/core": "^1.13.0",
     "@swc-node/sourcemap-support": "^0.5.0",
@@ -92,9 +93,8 @@
     "console-table-printer": "2.11.2",
     "dataloader": "2.2.2",
     "deepmerge": "4.3.1",
-    "dotenv": "8.6.0",
     "file-type": "16.5.4",
-    "find-up": "4.1.0",
+    "find-up": "7.0.0",
     "get-tsconfig": "^4.7.2",
     "http-status": "1.6.2",
     "image-size": "^1.1.1",
@@ -141,11 +141,9 @@
     "confusing-browser-globals": "1.0.11",
     "copyfiles": "2.4.1",
     "cross-env": "7.0.3",
-    "file-loader": "6.2.0",
     "form-data": "3.0.1",
     "get-port": "5.1.1",
     "graphql-http": "^1.22.0",
-    "mini-css-extract-plugin": "1.6.2",
     "nodemon": "3.0.3",
     "object.assign": "4.1.4",
     "object.entries": "1.1.6",

packages/payload/src/bin/loadEnv.ts

@@ -1,22 +1,25 @@
-import dotenv from 'dotenv'
-import findUp from 'find-up'
-import fs from 'fs'
-import path from 'path'
+import nextEnvImport from '@next/env'
+const { loadEnvConfig } = nextEnvImport
+import { findUpStop, findUpSync } from 'find-up'
 
 /**
- * Try to find user's .env and load it
+ * Try to find user's env files and load it. Uses the same algorithm next.js uses to parse env files, meaning this also supports .env.local, .env.development, .env.production, etc.
  */
-export function loadEnv() {
-  const envPath = findUp.sync('.env')
+export function loadEnv(path?: string) {
+  if (path?.length) {
+    loadEnvConfig(path, true)
+    return
+  }
+
+  const { loadedEnvFiles } = loadEnvConfig(process.cwd(), true) // assuming this won't run in production
 
-  if (envPath) {
-    dotenv.config({ path: envPath })
-  } else {
-    const cwdPath = path.resolve(process.cwd(), '.env')
-    if (fs.existsSync(cwdPath)) {
-      dotenv.config({
-        path: cwdPath,
-      })
-    }
+  if (!loadedEnvFiles?.length) {
+    // use findUp to find the env file. So, run loadEnvConfig for every directory upwards
+    findUpSync((dir) => {
+      const { loadedEnvFiles } = loadEnvConfig(dir, true)
+      if (loadedEnvFiles?.length) {
+        return findUpStop
+      }
+    })
   }
 }

packages/payload/src/config/find.ts

@@ -1,4 +1,4 @@
-import findUp from 'find-up'
+import { findUpSync, pathExistsSync } from 'find-up'
 import fs from 'fs'
 import path from 'path'
 
@@ -13,7 +13,7 @@ const getTSConfigPaths = (): {
   rootPath?: string
   srcPath?: string
 } => {
-  const tsConfigPath = findUp.sync('tsconfig.json')
+  const tsConfigPath = findUpSync('tsconfig.json')
 
   if (!tsConfigPath) {
     return {
@@ -79,17 +79,17 @@ export const findConfig = (): string => {
   for (const searchPath of searchPaths) {
     if (!searchPath) continue
 
-    const configPath = findUp.sync(
+    const configPath = findUpSync(
       (dir) => {
         const tsPath = path.join(dir, 'payload.config.ts')
-        const hasTS = findUp.sync.exists(tsPath)
+        const hasTS = pathExistsSync(tsPath)
 
         if (hasTS) {
           return tsPath
         }
 
         const jsPath = path.join(dir, 'payload.config.js')
-        const hasJS = findUp.sync.exists(jsPath)
+        const hasJS = pathExistsSync(jsPath)
 
         if (hasJS) {
           return jsPath
@@ -108,13 +108,13 @@ export const findConfig = (): string => {
   // If no config file is found in the directories defined by tsconfig.json,
   // try searching in the 'src' and 'dist' directory as a last resort, as they are most commonly used
   if (process.env.NODE_ENV === 'production') {
-    const distConfigPath = findUp.sync(['payload.config.js', 'payload.config.ts'], {
+    const distConfigPath = findUpSync(['payload.config.js', 'payload.config.ts'], {
       cwd: path.resolve(process.cwd(), 'dist'),
     })
 
     if (distConfigPath) return distConfigPath
   } else {
-    const srcConfigPath = findUp.sync(['payload.config.js', 'payload.config.ts'], {
+    const srcConfigPath = findUpSync(['payload.config.js', 'payload.config.ts'], {
       cwd: path.resolve(process.cwd(), 'src'),
     })
 

packages/payload/src/utilities/importWithoutClientFiles.ts

@@ -4,6 +4,8 @@ import path from 'path'
 
 import type { SanitizedConfig } from '../config/types.js'
 
+import { loadEnv } from '../bin/loadEnv.js'
+
 const filename = fileURLToPath(import.meta.url)
 const dirname = path.dirname(filename)
 
@@ -20,6 +22,7 @@ export const importWithoutClientFiles = async <T = unknown>(filePath: string) =>
  * Resolve and load Payload config from either a relative or absolute path
  */
 export const importConfig = async (configPath: string) => {
+  loadEnv() // loadConfig would usually be run outside of next. This means they will not get next's automatic env loading here. In order to not force them to install dotenv and set it up manually, we can load the env for them here
   const isAbsolutePath = path.isAbsolute(configPath)
   if (isAbsolutePath) {
     const config = await importWithoutClientFiles<{ default: Promise<SanitizedConfig> }>(configPath)

packages/payload/src/utilities/telemetry/index.ts

@@ -2,7 +2,7 @@ import { execSync } from 'child_process'
 import ciInfo from 'ci-info'
 import ConfImport from 'conf'
 import { randomBytes } from 'crypto'
-import findUp from 'find-up'
+import { findUp } from 'find-up'
 import fs from 'fs'
 import path from 'path'
 import { fileURLToPath } from 'url'

packages/plugin-sentry/package.json

@@ -51,7 +51,6 @@
     "@types/react-dom": "npm:[email protected]",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "dotenv": "^8.2.0",
     "jest": "^29.5.0",
     "nodemon": "3.0.3",
     "payload": "workspace:*",

packages/translations/package.json

@@ -40,7 +40,7 @@
     "@types/react": "npm:[email protected]",
     "@types/react-dom": "npm:[email protected]",
     "date-fns": "3.3.1",
-    "dotenv": "8.6.0",
+    "dotenv": "16.4.5",
     "prettier": "^3.0.3",
     "typescript": "5.4.5"
   },