defa13e4fe
### What? This PR aims to add reindexing capabilities to `plugin-search` to allow users to reindex entire searchable collections on demand. ### Why? As it stands, end users must either perform document reindexing manually one-by-one or via bulk operations. Both of these approaches are undesirable because they result in new versions being published on existing documents. Consider the case when `plugin-search` is only added _after_ the project has started and documents have been added to existing collections. It would be nice if users could simply click a button, choose the searchable collections to reindex, and have the custom endpoint handle the rest. ### How? This PR adds on to the existing plugin configuration, creating a custom endpoint and a custom `beforeListTable` component in the form of a popup button. Upon clicking the button, a dropdown/popup is opened with options to select which collection to reindex, as well as a useful `All Collections` option to run reindexing on all configured search collections. It also adds a `reindexBatchSize` option in the config to allow users to specify in what quantity to batch documents to sync with search. Big shoutout to @paulpopus & @r1tsuu for the triple-A level support on this one! Fixes #8902 See it in action: https://github.com/user-attachments/assets/ee8dd68c-ea89-49cd-adc3-151973eea28b Notes: - Traditionally these kinds of long-running tasks would be better suited for a job. However, given how many users enjoy deploying to serverless environments, it would be problematic to offer this feature exclusive to jobs queues. I thought a significant amount about this and decided it would be best to ship the feature as-is with the intention of creating an opt-in method to use job queues in the future if/when this gets merged. - In my testing, the collection description somehow started to appear in the document views after the on-demand RSC merge. I haven't reproduced this, but this PR has an example of that problem. Super strange. --------- Co-authored-by: Sasha <64744993+r1tsuu@users.noreply.github.com> Co-authored-by: Paul Popus <paul@nouance.io>
96 lines
2.6 KiB
TypeScript
96 lines
2.6 KiB
TypeScript
import { fileURLToPath } from 'node:url'
|
|
import path from 'path'
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
import { searchPlugin } from '@payloadcms/plugin-search'
|
|
import { randomUUID } from 'node:crypto'
|
|
|
|
import { buildConfigWithDefaults } from '../buildConfigWithDefaults.js'
|
|
import { devUser } from '../credentials.js'
|
|
import { Pages } from './collections/Pages.js'
|
|
import { Posts } from './collections/Posts.js'
|
|
import { Users } from './collections/Users.js'
|
|
import { seed } from './seed/index.js'
|
|
|
|
export default buildConfigWithDefaults({
|
|
collections: [Users, Pages, Posts],
|
|
localization: {
|
|
defaultLocale: 'en',
|
|
fallback: true,
|
|
locales: ['en', 'es', 'de'],
|
|
},
|
|
admin: {
|
|
importMap: {
|
|
baseDir: path.resolve(dirname),
|
|
},
|
|
},
|
|
onInit: async (payload) => {
|
|
await payload.create({
|
|
collection: 'users',
|
|
data: {
|
|
email: devUser.email,
|
|
password: devUser.password,
|
|
},
|
|
})
|
|
|
|
await seed(payload)
|
|
},
|
|
plugins: [
|
|
searchPlugin({
|
|
beforeSync: ({ originalDoc, searchDoc }) => {
|
|
return {
|
|
...searchDoc,
|
|
excerpt: originalDoc?.excerpt || 'This is a fallback excerpt',
|
|
slug: originalDoc.slug,
|
|
}
|
|
},
|
|
collections: ['pages', 'posts'],
|
|
defaultPriorities: {
|
|
pages: 10,
|
|
posts: ({ title }) => (title === 'Hello, world!' ? 30 : 20),
|
|
},
|
|
searchOverrides: {
|
|
access: {
|
|
// Used for int test
|
|
delete: ({ req: { user } }) => user.email === devUser.email,
|
|
},
|
|
fields: ({ defaultFields }) => [
|
|
...defaultFields,
|
|
// This is necessary to test whether search docs were deleted or not with SQLite
|
|
// Because IDs in SQLite, apparently, aren't unique if we count deleted rows without AUTOINCREMENT option
|
|
// Thus we have a custom UUID field.
|
|
{
|
|
name: 'id',
|
|
type: 'text',
|
|
hooks: {
|
|
beforeChange: [
|
|
({ operation }) => {
|
|
if (operation === 'create') {
|
|
return randomUUID()
|
|
}
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{
|
|
name: 'excerpt',
|
|
type: 'textarea',
|
|
admin: {
|
|
position: 'sidebar',
|
|
},
|
|
},
|
|
{
|
|
name: 'slug',
|
|
required: false,
|
|
type: 'text',
|
|
localized: true,
|
|
},
|
|
],
|
|
},
|
|
}),
|
|
],
|
|
typescript: {
|
|
outputFile: path.resolve(dirname, 'payload-types.ts'),
|
|
},
|
|
})
|