Chore/next poc merge main (#5204)

* wip moves payload, user and data into partial req * chore: adjust req type * chore(next): installs sass and resolves type errors * feat: working login route/view * fix: me route * chore(next): scaffolds access routes (#4562) * chore(next): scaffolds admin layout and dashboard view (#4566) * chore(next): builds initPage utility (#4589) * feat(3.0): next route handlers (#4590) * chore: removes old files * chore(next): ssr list view (#4594) * chore: removes old files * chore: adjusts graphql file imports to align with new operation exports * chore: allows for custom endpoints * chore: cleanup * chore(next): ssr edit view (#4614) * chore(ui): ssr main nav (#4619) * chore(next): ssr account view (#4620) * chore(next): ssr auth views and document create (#4631) * chore(next): ssr globals view (#4640) * chore(next): scaffolds document layout (#4644) * chore(next): ssr versions view (#4645) * chore(next): ssr field conditions (#4675) * chore(next): ssr field validations (#4700) * chore(next): moves dashboard view into next dir * chore(next): moves account view into next dir * chore(next): moves global edit view into next dir * chore(next): returns isolated configs and locale from initPage * chore(next): ssr api view (#4721) * feat: adds i18n functionality within Rest API, Local and Client contexts (#4749) * chore: separate client translation groups with empty line * chore: add missing translation used in db adapters * chore: simplify next/routes export and import paths * chore: renames PayloadT to Payload * chore(next): custom views (#4748) * chore: fix translation tsconfig * chore: adjust other package ts-configs that rely on translations * chore(next): installs @payloadcms/ui as direct dependency * chore(next): progress to build * chore(next): migrates types (#4792) * fixes acccept-language detection * chore(next): moves remaining components out from payload core (#4794) * chore(deps): removes all unused dependencies from payload core (#4797) * chore(next): achieves buildable state (#4803) * adds Translation component and removes more react-i18next * fixes up remaining translation strings * fixes a few i18n TODO's * chore: remaining translation strings without colons * chore: adds missing ja translations * chore(next): ssr group field (#4830) * chore: removes placeholder t function * chore: removes old file * chore(bundler-webpack): removes webpack bundler * chore(bundler-vite): removes vite bundler * chore(next): ssr tabs field (#4863) * chore(next): ssr row field * chore(next): ssr textarea field * chore(next): wires server action into document edit view (#4873) * chore(next): conditional logic (#4880) * chore(next): ssr radio, point, code, json, ui, and hidden fields (#4891) * chore(next): ssr collapsible field (#4894) * chore: remove findByID from req * chore: adjusts file property on request type * comment clarification * chore: wires up busboy with Requst readstream * chore: ports over express-fileupload into a NextJS compatible format * chore: adjust upload file structure * chore: adds try/catch around routes, corrects a few route responses * chore: renames file/function * chore: improve req type safety in local operations, misc req.files replacements * chore: misc type and fn export changes * chore: ensures root routes take pass unmodified request to root routes * chore: improve types * chore: consolidates locale api req initialization (#4922) * chore(next): overhauls field rendering strategy (#4924) * chore(next): ssr array field (#4937) * chore(next): ssr blocks field (#4942) * chore(next): ssr upload field and document drawer (#4957) * chore(next): wires form submissions (#4982) * chore: api handler adjustments * feat: adds graphql playground handler * adds credentials include setting to playground * remove old playground init, stub graphql handler location * fix: allow for null fallbackLocale * fix: correctly prioritize locales passed as null * chore: move all graphql code into next package * graphql changes * chore: semi working version of graphql http layer * gql fix attempts * rm console log * chore: partial gql changes * chore: adds gql and gql-http back into payload * chore: removes collection from req * chore: separates graphql package out for schema generation * chore: dep cleanup * chore: move graphql handlers * chore: removes unused deps * chore(next): ssr list view (#5032) * chore: refactor response handler order for custom endpoints * chore: add back in condition for collection GET path with 2 slugs * chore: rm optional chain * chore: import sort route file * chore: allows custom endpoints to attempt before erroring * feat: adds memoization to translation functions (#5036) * chore: fix APIError import * chore: return attemptCustomEndpointBeforeError responses * chore(next): properly instantiates table columns * fix(next): attaches params to req and properly assigns prefs key (#5042) * chore: reorganize next route order * chore(next): adds RouteError handler to next routes * chore: builds payload successfully * chore: misc file omissions * fix(ui): maintains proper column order * fix(ui): ensures first cell is a link * fix(next): properly copies url object in createPayloadRequest (#5064) * fix(ui): bumps react-toastify to v10.0.4 to fix hydration warnings * feat: add route for static file GET requests (#5065) * chore(next): allows resolved config promise to be thread through initPage (#5071) * chore(ui): conditionally renders field label from props * feat(next): next install script * chore: pass config to route handlers * feat: initial test suite framework (#4929) * chore(next): renderable account, api, and create first user views (#5084) * fix(next): properly parses search params in find, update, and delete handlers (#5088) * chore(next): ssr versions view (#5085) * chore: adds homepage for scss testing * chore: moves dev folder to top, establishes new test pattern * chore: working turbopack * chore: sets up working dynamic payload-config imports * remove unused code * chore: rm console log * misc * feat: correctly subs out ability to boot REST API within same process * chore: WIP dev suites * chore: removes need for REST_API folder in test dir * removes duplicate bootAdminPanel fn * misc * specify default export * chore: sets up jest to work with next/jest * chore: progress to mongodb and sharp builds * chore: passing community tests * chore: sorta workin * chore: adjust payload-config import * chore: adds rest client for Next handlers * chore: removes test garb * chore: restores payload-config tsconfig path temporarily * chore: establishes pattern for memory db during tests * chore: bumps mongoose to 7 * chore(next): 404s on nested create urls * chore: functional _community e2e * chore: increases e2e expect timeout * fix(next): sanitizes locale toString from client config * chore: type fixes * chore: pulls mongodb from main * chore: uses graphql to log user in * feat: passing auth test suite * chore(ui): threads params through context and conditionally renders document tabs (#5094) * feat(ui): adds params context (#5095) * chore: removes unecessary memory allocation for urlPropertiesObject object * chore: passing graphql test suite * chore: removes references to bson * chore: re-enables mongodb memory server for auth test suite * chore: replace bson with bson-objectid * feat: passing collections-rest int suite * chore: fixes bad imports * chore: more passing int suites * feat: passing globals int tests * feat: passing hooks int test suite * chore: remove last express file * chore: start live-preview int test migration * chore: passing localization int tests * passing relationships int tests * chore: partial passing upload int tests * chore: fixes scss imports * chore(ui): renders document info provider at root (#5106) * chore: adds schema path to useFieldPath provider, more passing tests * chore: begins work to optimize translation imports * chore: add translations to ui ts-config references * chore: add exports folder to package json exports * chore: adds readme how-to-use instructions * chore: attempts refactor of translation imports * chore: adds authentication:account translation key to server keys * chore: finishes translation optimization * chore: ignores warnings from mongodb * chore(ui): renders live document title (#5115) * chore(ui): ssr document tabs (#5116) * chore: handles redirecting from login * chore: handle redirect with no searchParams * chore: handle missing segments * chore(next): migrates server action into standalone api endpoint (#5122) * chore: adjust dashboard colection segments * test: update e2e suites * fix(ui): prevents unnecessary calls to form state * chore: fix finding global config fields from schema path * fix(next): executes root POST endpoints * chore(ui): ignores values returned by form state polling * chore: scaffolds ssr rte * chore: renders client leaves * chore: server-side rendered rich text elements * chore: defines ClientFunction pattern * chore(ui): migrates relationship field * chore: adds translations, cleans up slate * chore: functional slate link * chore: slate upload ssr * chore: relationship slate ssr * chore: remaining slate ssr * chore: fixes circular workspace dep * chore: correct broken int test import paths * chore: remove media files from root * chore: server renders custom edit view * fix(ui): resolves infinite loading in versions view * fix(next): resolves global edit view lookup * chore: payload builds * chore: delete unused files * chore: removes local property from payload * chore: adds mongodb as dev dep in db-mongodb package * chore: hide deprecation warnings for tempfile and jest-environment-jsdom * chore: remove all translations from translations dist * chore: clean ts-config files * chore: simple type fixes * chore(ui): server renders custom list view * chore: fix next config payload-config alias * chore: adds turbo alias paths * chore: adjusts translation generation * chore: improve auth function * chore: eslint config for packages/ui * chore(ui): exports FormState * chore(next): migrates account view to latest patterns * chore: disable barbie mode * chore(ui): lints * chore(next): lints * chore: for alexical * chore: custom handler type signature adjustment * fix: non-boolean condition result causes infinite looping (#4579) * chore(richtext-lexical): upgrade lexical from v0.12.5 to v0.12.6 (#4732) * chore(richtext-lexical): upgrade all lexical packages from 0.12.5 to 0.12.6 * fix(richtext-lexical): fix TypeScript errors * fix indenting * feat(richtext-lexical): Blocks: generate type definitions for blocks fields (#4529) * feat(richtext-lexical)!: Update lexical from 0.12.6 to 0.13.1, port over all useful changes from playground (#5066) * feat(richtext-lexical): Update lexical from 0.12.6 to 0.13.1, port over all useful changes from playground * chore: upgrade lexical version used in monorepo * chore: remove the 3 * chore: upgrade nodemon versions (#5059) * feat: add more options to addFieldStatePromise so that it can be used for field flattening (#4799) * feat(plugin-seo)!: remove support for payload <2.7.0 (#4765) * chore(plugin-seo): remove test script from package.json (#4762) * chore: upgrade @types/nodemailer from v6.4.8 to v6.4.14 (#4733) * chore: revert auth and initPage changes * chore(next): moves edit and list views (#5170) * fix: "The punycode module is deprecated" warning by updating nodemailer * chore: adjust translations tsconfig paths in root * chore: fix merge build --------- Co-authored-by: Jarrod Flesch <jarrodmflesch@gmail.com> Co-authored-by: Jacob Fletcher <jacobsfletch@gmail.com> Co-authored-by: Jarrod Flesch <30633324+JarrodMFlesch@users.noreply.github.com> Co-authored-by: Elliot DeNolf <denolfe@gmail.com> Co-authored-by: James <james@trbl.design> Co-authored-by: Alessio Gravili <alessio@gravili.de> Co-authored-by: Alessio Gravili <70709113+AlessioGr@users.noreply.github.com>
2024-02-28 13:44:17 -05:00
parent 0b296cb271
commit b9dec2f714
444 changed files with 28902 additions and 11078 deletions
--- a/test/hooks/collections/Hook/index.ts
+++ b/test/hooks/collections/Hook/index.ts
@@ -5,12 +5,19 @@ export const hooksSlug = 'hooks'
 const Hooks: CollectionConfig = {
  slug: hooksSlug,
  access: {
-    read: () => true,
    create: () => true,
    delete: () => true,
+    read: () => true,
    update: () => true,
  },
  hooks: {
+    beforeOperation: [
+      ({ req }) => {
+        if (!req.transactionID) {
+          throw new Error('transactionID is missing in beforeOperation hook')
+        }
+      },
+    ],
    beforeValidate: [({ data }) => validateHookOrder('collectionBeforeValidate', data)],
    beforeChange: [({ data }) => validateHookOrder('collectionBeforeChange', data)],
    afterChange: [
@@ -43,7 +50,15 @@ const Hooks: CollectionConfig = {
      type: 'checkbox',
      hooks: {
        beforeChange: [
-          ({ data }) => {
+          ({ data, operation, previousSiblingDoc, previousValue }) => {
+            if (operation === 'update') {
+              if (typeof previousValue === 'undefined') {
+                throw new Error('previousValue is missing in beforeChange hook')
+              }
+              if (!previousSiblingDoc) {
+                throw new Error('previousSiblingDoc is missing in beforeChange hook')
+              }
+            }
            data.fieldBeforeChange = true
            validateHookOrder('fieldBeforeChange', data)
            return true
@@ -106,7 +121,7 @@ const Hooks: CollectionConfig = {
  ],
 }

-const createHookOrder = [
+const writeHooksOrder = [
  'fieldBeforeValidate',
  'collectionBeforeValidate',
  'collectionBeforeChange',
@@ -119,10 +134,11 @@ const createHookOrder = [

 const validateHookOrder = (check: string, data) => {
  let hasMatched
-  createHookOrder.forEach((hook) => {
-    if (check === 'collectionBeforeRead' && !data.id) {
-      data[check] = true
-    } else if (hook === check) {
+  if (check === 'collectionBeforeRead') {
+    data.collectionBeforeRead = true
+  }
+  writeHooksOrder.forEach((hook) => {
+    if (hook === check) {
      data[check] = true
      hasMatched = true
    } else if ((!hasMatched && !data[hook]) || (hasMatched && data[hook])) {
--- a/test/hooks/collections/Users/afterLoginHook.ts
+++ b/test/hooks/collections/Users/afterLoginHook.ts
@@ -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,
+  })
+}
--- a/test/hooks/collections/Users/index.ts
+++ b/test/hooks/collections/Users/index.ts
@@ -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],
  },
 }
--- a/test/hooks/config.ts
+++ b/test/hooks/config.ts
@@ -1,5 +1,6 @@
 import type { SanitizedConfig } from '../../packages/payload/src/config/types'

+import { APIError } from '../../packages/payload/errors'
 import { buildConfigWithDefaults } from '../buildConfigWithDefaults'
 import AfterOperation from './collections/AfterOperation'
 import ChainingHooks from './collections/ChainingHooks'
@@ -24,6 +25,18 @@ export const HooksConfig: Promise<SanitizedConfig> = buildConfigWithDefaults({
    DataHooks,
  ],
  globals: [DataHooksGlobal],
+  endpoints: [
+    {
+      path: '/throw-to-after-error',
+      method: 'get',
+      handler: () => {
+        throw new APIError("I'm a teapot", 418)
+      },
+    },
+  ],
+  hooks: {
+    afterError: () => console.log('Running afterError hook'),
+  },
  onInit: async (payload) => {
    await seedHooksUsers(payload)
    await payload.create({
--- a/test/hooks/int.spec.ts
+++ b/test/hooks/int.spec.ts
@@ -43,8 +43,8 @@ describe('Hooks', () => {
      const doc = await payload.create({
        collection: transformSlug,
        data: {
-          transform: [2, 8],
          localizedTransform: [2, 8],
+          transform: [2, 8],
        },
      })

@@ -55,39 +55,75 @@ describe('Hooks', () => {

  describe('hook execution', () => {
    let doc
-    it('should execute hooks in correct order on create', async () => {
+    const data = {
+      collectionAfterChange: false,
+      collectionAfterRead: false,
+      collectionBeforeChange: false,
+      collectionBeforeRead: false,
+      collectionBeforeValidate: false,
+      fieldAfterChange: false,
+      fieldAfterRead: false,
+      fieldBeforeChange: false,
+      fieldBeforeValidate: false,
+    }
+    beforeEach(async () => {
      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,
-        },
+        data,
+      })
+    })
+
+    it('should execute hooks in correct order on create', async () => {
+      expect(doc.collectionAfterChange).toBeTruthy()
+      expect(doc.collectionAfterRead).toBeTruthy()
+      expect(doc.collectionBeforeChange).toBeTruthy()
+      // beforeRead is not run on create operation
+      expect(doc.collectionBeforeRead).toBeFalsy()
+      expect(doc.collectionBeforeValidate).toBeTruthy()
+      expect(doc.fieldAfterChange).toBeTruthy()
+      expect(doc.fieldAfterRead).toBeTruthy()
+      expect(doc.fieldBeforeChange).toBeTruthy()
+      expect(doc.fieldBeforeValidate).toBeTruthy()
+    })
+
+    it('should execute hooks in correct order on update', async () => {
+      doc = await payload.update({
+        id: doc.id,
+        collection: hooksSlug,
+        data,
      })

-      expect(doc.fieldBeforeValidate).toEqual(true)
-      expect(doc.collectionBeforeValidate).toEqual(true)
-      expect(doc.fieldBeforeChange).toEqual(true)
-      expect(doc.collectionBeforeChange).toEqual(true)
-      expect(doc.fieldAfterChange).toEqual(true)
-      expect(doc.collectionAfterChange).toEqual(true)
-      expect(doc.fieldAfterRead).toEqual(true)
+      expect(doc.collectionAfterChange).toBeTruthy()
+      expect(doc.collectionAfterRead).toBeTruthy()
+      expect(doc.collectionBeforeChange).toBeTruthy()
+      // beforeRead is not run on update operation
+      expect(doc.collectionBeforeRead).toBeFalsy()
+      expect(doc.collectionBeforeValidate).toBeTruthy()
+      expect(doc.fieldAfterChange).toBeTruthy()
+      expect(doc.fieldAfterRead).toBeTruthy()
+      expect(doc.fieldBeforeChange).toBeTruthy()
+      expect(doc.fieldBeforeValidate).toBeTruthy()
+    })
+
+    it('should execute hooks in correct order on find', async () => {
+      doc = await payload.findByID({
+        id: doc.id,
+        collection: hooksSlug,
+      })
+
+      expect(doc.collectionAfterRead).toBeTruthy()
+      expect(doc.collectionBeforeRead).toBeTruthy()
+      expect(doc.fieldAfterRead).toBeTruthy()
    })

    it('should save data generated with afterRead hooks in nested field structures', async () => {
      const document: NestedAfterReadHook = await payload.create({
        collection: nestedAfterReadHooksSlug,
        data: {
-          text: 'ok',
          group: {
            array: [{ input: 'input' }],
          },
+          text: 'ok',
        },
      })

@@ -106,7 +142,6 @@ describe('Hooks', () => {
      const document = await payload.create({
        collection: nestedAfterReadHooksSlug,
        data: {
-          text: 'ok',
          group: {
            array: [
              {
@@ -117,12 +152,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 +174,8 @@ describe('Hooks', () => {
      })

      const retrievedDoc = await payload.findByID({
-        collection: chainingHooksSlug,
        id: document.id,
+        collection: chainingHooksSlug,
      })

      expect(retrievedDoc.text).toEqual('ok!!')
@@ -189,15 +225,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 +261,8 @@ describe('Hooks', () => {
      })

      const retrievedDoc = await payload.findByID({
-        collection: contextHooksSlug,
        id: document.id,
+        collection: contextHooksSlug,
      })

      expect(retrievedDoc.value).toEqual('secret')
@@ -235,17 +271,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')
@@ -290,7 +326,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: {
@@ -298,7 +334,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 () => {
@@ -341,8 +385,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(
@@ -417,4 +461,13 @@ describe('Hooks', () => {
      expect(doc.field_globalAndField).toStrictEqual(globalAndFieldString + globalAndFieldString)
    })
  })
+
+  describe('config level after error hook', () => {
+    it('should handle error', async () => {
+      const response = await fetch(`${apiUrl}/throw-to-after-error`)
+      const body = await response.json()
+      expect(response.status).toEqual(418)
+      expect(body).toEqual({ errors: [{ message: "I'm a teapot" }] })
+    })
+  })
 })