feat(payload, richtext-lexical): runtime dependency checks (#6838)

AlessioGr · web-flow · commit bf374a23ab4a · 2024-06-18T21:11:07.000Z
diff --git a/packages/payload/src/exports/index.ts b/packages/payload/src/exports/index.ts
@@ -354,6 +354,8 @@ export { getFileByPath } from '../uploads/getFileByPath.js'
 
 export { commitTransaction } from '../utilities/commitTransaction.js'
 
+export { getDependencies } from '../utilities/dependencies/getDependencies.js'
+
 export { initTransaction } from '../utilities/initTransaction.js'
 
 export { killTransaction } from '../utilities/killTransaction.js'
diff --git a/packages/payload/src/index.ts b/packages/payload/src/index.ts
@@ -55,6 +55,7 @@ import { validateSchema } from './config/validate.js'
 import { consoleEmailAdapter } from './email/consoleEmailAdapter.js'
 import { fieldAffectsData } from './fields/config/types.js'
 import localGlobalOperations from './globals/operations/local/index.js'
+import { getDependencies } from './utilities/dependencies/getDependencies.js'
 import flattenFields from './utilities/flattenTopLevelFields.js'
 import Logger from './utilities/logger.js'
 import { serverInit as serverInitTelemetry } from './utilities/telemetry/events/serverInit.js'
@@ -357,6 +358,61 @@ export class BasePayload<TGeneratedTypes extends GeneratedTypes> {
    * @param options
    */
   async init(options: InitOptions): Promise<Payload> {
+    if (process.env.NODE_ENV !== 'production') {
+      // First load. First check if there are mismatching dependency versions of payload packages
+      const resolvedDependencies = await getDependencies(dirname, [
+        '@payloadcms/ui/shared',
+        'payload',
+        '@payloadcms/next/utilities',
+        '@payloadcms/richtext-lexical',
+        '@payloadcms/richtext-slate',
+        '@payloadcms/graphql',
+        '@payloadcms/plugin-cloud',
+        '@payloadcms/db-mongodb',
+        '@payloadcms/db-postgres',
+        '@payloadcms/plugin-form-builder',
+        '@payloadcms/plugin-nested-docs',
+        '@payloadcms/plugin-seo',
+        '@payloadcms/plugin-search',
+        '@payloadcms/plugin-cloud-storage',
+        '@payloadcms/plugin-stripe',
+        '@payloadcms/plugin-zapier',
+        '@payloadcms/plugin-redirects',
+        '@payloadcms/plugin-sentry',
+        '@payloadcms/bundler-webpack',
+        '@payloadcms/bundler-vite',
+        '@payloadcms/live-preview',
+        '@payloadcms/live-preview-react',
+        '@payloadcms/translations',
+        '@payloadcms/email-nodemailer',
+        '@payloadcms/email-resend',
+        '@payloadcms/storage-azure',
+        '@payloadcms/storage-s3',
+        '@payloadcms/storage-gcs',
+        '@payloadcms/storage-vercel-blob',
+        '@payloadcms/storage-uploadthing',
+      ])
+
+      // Go through each resolved dependency. If any dependency has a mismatching version, throw an error
+      const foundVersions: {
+        [version: string]: string
+      } = {}
+      for (const [_pkg, { version }] of resolvedDependencies.resolved) {
+        if (!Object.keys(foundVersions).includes(version)) {
+          foundVersions[version] = _pkg
+        }
+      }
+      if (Object.keys(foundVersions).length !== 1) {
+        const formattedVersionsWithPackageNameString = Object.entries(foundVersions)
+          .map(([version, pkg]) => `${pkg}@${version}`)
+          .join(', ')
+
+        throw new Error(
+          `Mismatching payload dependency versions found: ${formattedVersionsWithPackageNameString}. All payload and @payloadcms/* packages must have the same version.`,
+        )
+      }
+    }
+
     if (!options?.config) {
       throw new Error('Error: the payload config is required to initialize payload.')
     }
diff --git a/packages/payload/src/utilities/dependencies/getDependencies.ts b/packages/payload/src/utilities/dependencies/getDependencies.ts
@@ -0,0 +1,82 @@
+/*
+  This source code has been taken and modified from https://github.com/vercel/next.js/blob/41a80533f900467e1b788bd2673abe2dca20be6a/packages/next/src/lib/has-necessary-dependencies.ts
+
+  License:
+
+  The MIT License (MIT)
+
+  Copyright (c) 2024 Vercel, Inc.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+import { findUp } from 'find-up'
+import { existsSync, promises as fs } from 'fs'
+import { dirname } from 'path'
+
+import { resolveFrom } from './resolveFrom.js'
+
+export type NecessaryDependencies = {
+  missing: string[]
+  resolved: Map<
+    string,
+    {
+      path: string
+      version: string
+    }
+  >
+}
+
+export async function getDependencies(
+  baseDir: string,
+  requiredPackages: string[],
+): Promise<NecessaryDependencies> {
+  const resolutions = new Map<
+    string,
+    {
+      path: string
+      version: string
+    }
+  >()
+  const missingPackages: string[] = []
+
+  await Promise.all(
+    requiredPackages.map(async (pkg) => {
+      try {
+        const pkgPath = await fs.realpath(resolveFrom(baseDir, pkg))
+
+        const pkgDir = dirname(pkgPath)
+
+        let packageJsonFilePath = null
+
+        await findUp('package.json', { type: 'file', cwd: pkgDir }).then((path) => {
+          packageJsonFilePath = path
+        })
+
+        if (packageJsonFilePath && existsSync(packageJsonFilePath)) {
+          // parse version
+          const packageJson = JSON.parse(await fs.readFile(packageJsonFilePath, 'utf8'))
+          const version = packageJson.version
+
+          resolutions.set(pkg, {
+            path: packageJsonFilePath,
+            version,
+          })
+        } else {
+          return missingPackages.push(pkg)
+        }
+      } catch (_) {
+        return missingPackages.push(pkg)
+      }
+    }),
+  )
+
+  return {
+    missing: missingPackages,
+    resolved: resolutions,
+  }
+}
diff --git a/packages/payload/src/utilities/dependencies/isError.ts b/packages/payload/src/utilities/dependencies/isError.ts
@@ -0,0 +1,23 @@
+/*
+  This source code has been taken and modified from https://github.com/vercel/next.js/blob/be87132327ea28acd4bf7af09a401bac2374cb64/packages/next/src/lib/is-error.ts
+
+  License:
+
+  The MIT License (MIT)
+
+  Copyright (c) 2024 Vercel, Inc.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+export interface ErrorWithCode extends Error {
+  code?: number | string
+}
+
+export function isError(err: unknown): err is ErrorWithCode {
+  return typeof err === 'object' && err !== null && 'name' in err && 'message' in err
+}
diff --git a/packages/payload/src/utilities/dependencies/realPath.ts b/packages/payload/src/utilities/dependencies/realPath.ts
@@ -0,0 +1,24 @@
+/*
+  This source code has been taken from https://github.com/vercel/next.js/blob/39498d604c3b25d92a483153fe648a7ee456fbda/packages/next/src/lib/realpath.ts
+
+  License:
+
+  The MIT License (MIT)
+
+  Copyright (c) 2024 Vercel, Inc.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+import fs from 'fs'
+
+const isWindows = process.platform === 'win32'
+
+// Interesting learning from this, that fs.realpathSync is 70x slower than fs.realpathSync.native:
+// https://sun0day.github.io/blog/vite/why-vite4_3-is-faster.html#fs-realpathsync-issue
+// https://github.com/nodejs/node/issues/2680
+// However, we can't use fs.realpathSync.native on Windows due to behavior differences.
+export const realpathSync = isWindows ? fs.realpathSync : fs.realpathSync.native
diff --git a/packages/payload/src/utilities/dependencies/resolveFrom.ts b/packages/payload/src/utilities/dependencies/resolveFrom.ts
@@ -0,0 +1,72 @@
+/*
+  This source code has been taken and modified from https://github.com/vercel/next.js/blob/39498d604c3b25d92a483153fe648a7ee456fbda/packages/next/src/lib/resolve-from.ts
+
+  License:
+
+  The MIT License (MIT)
+
+  Copyright (c) 2024 Vercel, Inc.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+// source: https://github.com/sindresorhus/resolve-from
+import { createRequire } from 'module'
+import path from 'path'
+
+import { isError } from './isError.js'
+import { realpathSync } from './realPath.js'
+
+export const resolveFrom = (fromDirectory: string, moduleId: string, silent?: boolean) => {
+  if (typeof fromDirectory !== 'string') {
+    throw new TypeError(
+      `Expected \`fromDir\` to be of type \`string\`, got \`${typeof fromDirectory}\``,
+    )
+  }
+
+  if (typeof moduleId !== 'string') {
+    throw new TypeError(
+      `Expected \`moduleId\` to be of type \`string\`, got \`${typeof moduleId}\``,
+    )
+  }
+
+  try {
+    fromDirectory = realpathSync(fromDirectory)
+  } catch (error: unknown) {
+    if (isError(error) && error.code === 'ENOENT') {
+      fromDirectory = path.resolve(fromDirectory)
+    } else if (silent) {
+      return
+    } else {
+      throw error
+    }
+  }
+
+  const fromFile = path.join(fromDirectory, 'noop.js')
+
+  const require = createRequire(import.meta.url)
+
+  const Module = require('module')
+
+  const resolveFileName = () => {
+    return Module._resolveFilename(moduleId, {
+      id: fromFile,
+      filename: fromFile,
+      paths: Module._nodeModulePaths(fromDirectory),
+    })
+  }
+
+  if (silent) {
+    try {
+      return resolveFileName()
+    } catch (error) {
+      return
+    }
+  }
+
+  return resolveFileName()
+}
diff --git a/packages/richtext-lexical/src/index.ts b/packages/richtext-lexical/src/index.ts
@@ -6,11 +6,14 @@ import type {
 } from 'lexical'
 
 import { withMergedProps } from '@payloadcms/ui/elements/withMergedProps'
+import { fileURLToPath } from 'node:url'
+import path from 'path'
 import {
   afterChangeTraverseFields,
   afterReadTraverseFields,
   beforeChangeTraverseFields,
   beforeValidateTraverseFields,
+  getDependencies,
   withNullableJSONSchemaType,
 } from 'payload'
 
@@ -44,8 +47,45 @@ import { richTextValidateHOC } from './validate/index.js'
 
 let defaultSanitizedServerEditorConfig: SanitizedServerEditorConfig = null
 
+const filename = fileURLToPath(import.meta.url)
+const dirname = path.dirname(filename)
+
 export function lexicalEditor(props?: LexicalEditorProps): LexicalRichTextAdapterProvider {
   return async ({ config, isRoot }) => {
+    if (process.env.NODE_ENV !== 'production') {
+      const resolvedDependencies = await getDependencies(dirname, [
+        'lexical',
+        '@lexical/headless',
+        '@lexical/link',
+        '@lexical/list',
+        '@lexical/mark',
+        '@lexical/markdown',
+        '@lexical/react',
+        '@lexical/rich-text',
+        '@lexical/selection',
+        '@lexical/utils',
+      ])
+
+      // Go through each resolved dependency. If any dependency has a mismatching version, throw an error
+      const foundVersions: {
+        [version: string]: string
+      } = {}
+      for (const [_pkg, { version }] of resolvedDependencies.resolved) {
+        if (!Object.keys(foundVersions).includes(version)) {
+          foundVersions[version] = _pkg
+        }
+      }
+      if (Object.keys(foundVersions).length !== 1) {
+        const formattedVersionsWithPackageNameString = Object.entries(foundVersions)
+          .map(([version, pkg]) => `${pkg}@${version}`)
+          .join(', ')
+
+        throw new Error(
+          `Mismatching lexical dependency versions found: ${formattedVersionsWithPackageNameString}. All lexical and @lexical/* packages must have the same version.`,
+        )
+      }
+    }
+
     let features: FeatureProviderServer<unknown, unknown>[] = []
     let resolvedFeatureMap: ResolvedServerFeatureMap
 
