c96fa613bc
Currently, Payload renders all custom components on initial compile of the admin panel. This is problematic for two key reasons: 1. Custom components do not receive contextual data, i.e. fields do not receive their field data, edit views do not receive their document data, etc. 2. Components are unnecessarily rendered before they are used This was initially required to support React Server Components within the Payload Admin Panel for two key reasons: 1. Fields can be dynamically rendered within arrays, blocks, etc. 2. Documents can be recursively rendered within a "drawer" UI, i.e. relationship fields 3. Payload supports server/client component composition In order to achieve this, components need to be rendered on the server and passed as "slots" to the client. Currently, the pattern for this is to render custom server components in the "client config". Then when a view or field is needed to be rendered, we first check the client config for a "pre-rendered" component, otherwise render our client-side fallback component. But for the reasons listed above, this pattern doesn't exactly make custom server components very useful within the Payload Admin Panel, which is where this PR comes in. Now, instead of pre-rendering all components on initial compile, we're able to render custom components _on demand_, only as they are needed. To achieve this, we've established [this pattern](https://github.com/payloadcms/payload/pull/8481) of React Server Functions in the Payload Admin Panel. With Server Functions, we can iterate the Payload Config and return JSX through React's `text/x-component` content-type. This means we're able to pass contextual props to custom components, such as data for fields and views. ## Breaking Changes 1. Add the following to your root layout file, typically located at `(app)/(payload)/layout.tsx`: ```diff /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */ /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */ + import type { ServerFunctionClient } from 'payload' import config from '@payload-config' import { RootLayout } from '@payloadcms/next/layouts' import { handleServerFunctions } from '@payloadcms/next/utilities' import React from 'react' import { importMap } from './admin/importMap.js' import './custom.scss' type Args = { children: React.ReactNode } + const serverFunctions: ServerFunctionClient = async function (args) { + 'use server' + return handleServerFunctions({ + ...args, + config, + importMap, + }) + } const Layout = ({ children }: Args) => ( <RootLayout config={config} importMap={importMap} + serverFunctions={serverFunctions} > {children} </RootLayout> ) export default Layout ``` 2. If you were previously posting to the `/api/form-state` endpoint, it no longer exists. Instead, you'll need to invoke the `form-state` Server Function, which can be done through the _new_ `getFormState` utility: ```diff - import { getFormState } from '@payloadcms/ui' - const { state } = await getFormState({ - apiRoute: '', - body: { - // ... - }, - serverURL: '' - }) + const { getFormState } = useServerFunctions() + + const { state } = await getFormState({ + // ... + }) ``` ## Breaking Changes ```diff - useFieldProps() - useCellProps() ``` More details coming soon. --------- Co-authored-by: Alessio Gravili <alessio@gravili.de> Co-authored-by: Jarrod Flesch <jarrodmflesch@gmail.com> Co-authored-by: James <james@trbl.design>
122 lines
4.1 KiB
JavaScript
122 lines
4.1 KiB
JavaScript
// From https://github.com/robertbradleyux/jest-ci-spec-reporter/blob/main/src/jest-ci-spec-reporter.ts
|
|
/*
|
|
MIT License
|
|
|
|
Copyright (c) 2023 Robert Bradley
|
|
|
|
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.
|
|
*/
|
|
'use strict'
|
|
Object.defineProperty(exports, '__esModule', { value: true })
|
|
class JestCiSpecReporter {
|
|
onRunStart({ numTotalTestSuites }) {
|
|
console.log()
|
|
console.log(`Found ${numTotalTestSuites} test suites.`)
|
|
console.log()
|
|
}
|
|
onRunComplete(_, results) {
|
|
const {
|
|
numFailedTests,
|
|
numPassedTests,
|
|
numPendingTests,
|
|
testResults,
|
|
numTotalTests,
|
|
startTime,
|
|
} = results
|
|
testResults.forEach(({ failureMessage }) => {
|
|
if (failureMessage) {
|
|
console.log(failureMessage)
|
|
}
|
|
})
|
|
const testResultText = numFailedTests === 0 ? 'SUCCESS' : 'FAILED'
|
|
const numNotSkippedTests = numPassedTests + numFailedTests
|
|
const runDuration = this._getRunDuration(startTime)
|
|
console.log()
|
|
console.log(
|
|
`Executed ${numNotSkippedTests} of ${numTotalTests} (skipped ${numPendingTests}) ${testResultText} (${runDuration})`,
|
|
)
|
|
console.log(`TOTAL: ${numFailedTests || numNotSkippedTests} ${testResultText}`)
|
|
}
|
|
onTestResult(test, { testResults }) {
|
|
// Log pretty ALL RESULTS message
|
|
console.log('\n\n\x1b[1m\x1b[30mALL RESULTS\x1b[0m')
|
|
testResults.forEach((result) => {
|
|
var _a, _b
|
|
const { title, duration, status, ancestorTitles } = result
|
|
const { name } =
|
|
(_b = (_a = test.context.config) === null || _a === void 0 ? void 0 : _a.displayName) !==
|
|
null && _b !== void 0
|
|
? _b
|
|
: {}
|
|
if (name) {
|
|
ancestorTitles.unshift(name)
|
|
}
|
|
const breadcrumbs = `${ancestorTitles.join(' > ')} >`
|
|
|
|
console.log(
|
|
` ${this._getTestStatus(status)} ${breadcrumbs} ${title} ${this._getTestDuration(duration)}`,
|
|
)
|
|
})
|
|
}
|
|
|
|
onTestCaseResult(test, result) {
|
|
var _a, _b
|
|
const { title, duration, status, ancestorTitles } = result
|
|
const { name } =
|
|
(_b = (_a = test.context.config) === null || _a === void 0 ? void 0 : _a.displayName) !==
|
|
null && _b !== void 0
|
|
? _b
|
|
: {}
|
|
if (name) {
|
|
ancestorTitles.unshift(name)
|
|
}
|
|
const breadcrumbs = `${ancestorTitles.join(' > ')} >`
|
|
|
|
console.log(
|
|
` ${this._getTestStatus(status)} ${breadcrumbs} ${title} ${this._getTestDuration(duration)}`,
|
|
)
|
|
}
|
|
|
|
getLastError() {
|
|
return undefined
|
|
}
|
|
_getRunDuration(startTime) {
|
|
const deltaInMillis = new Date().getTime() - new Date(startTime).getTime()
|
|
const seconds = ((deltaInMillis % 60000) / 1000).toFixed(3)
|
|
return `${seconds} secs`
|
|
}
|
|
_getTestDuration(duration) {
|
|
return `\x1b[1m\x1b[30m(${duration !== null && duration !== void 0 ? duration : 0}ms)\x1b[0m`
|
|
}
|
|
_getTestStatus(status) {
|
|
switch (status) {
|
|
case 'passed':
|
|
return '\x1b[1m\x1b[32m[PASS]\x1b[0m'
|
|
case 'pending':
|
|
return '\x1b[1m\x1b[33m[SKIP]\x1b[0m'
|
|
case 'todo':
|
|
return '\x1b[1m\x1b[34m[TODO]\x1b[0m'
|
|
case 'failed':
|
|
default:
|
|
return '\x1b[1m\x1b[31m[FAIL]\x1b[0m'
|
|
}
|
|
}
|
|
}
|
|
exports.default = JestCiSpecReporter
|