Add configuration for custom search fields (#4892)

.changeset/shiny-ways-grin.md

@@ -0,0 +1,7 @@
+---
+'@keystonejs/adapter-knex': minor
+'@keystonejs/adapter-mongoose': minor
+'@keystonejs/adapter-prisma': minor
+---
+
+Added support for configuring the field to use for `search` filtering via the `searchField` list adapter config option.

.changeset/yellow-hornets-lay.md

@@ -0,0 +1,8 @@
+---
+'@keystone-next/website': minor
+'@keystone-next/keystone': minor
+'@keystone-next/types': minor
+'@keystonejs/api-tests': minor
+---
+
+Added support for configuring the field to use for `search` filtering via the `db: { searchField }` list config option.

docs-next/pages/apis/schema.mdx

@@ -18,6 +18,7 @@ export default config({
       ui: { /* ... */ },
       hooks: { /* ... */ },
       graphql: { /* ... */ },
+      db: { /* ... */ },
       description: '...',
     }),
     /* ... */
@@ -213,6 +214,31 @@ export default config({
 });
 ```
 
+## db
+
+The `db` config option allows you to configures certain aspects of the database connection specific to this list.
+
+Options:
+
+- `searchField` (default: `"name"`): The name of the field to use when performing `search` filters in the GraphQL API.
+
+```typescript
+import { config, createSchema, list } from '@keystone-next/keystone/schema';
+
+export default config({
+  lists: createSchema({
+    ListName: list({
+      db: {
+        searchField: 'email',
+      },
+      /* ... */
+    }),
+    /* ... */
+  }),
+  /* ... */
+});
+```
+
 ## description
 
 The `description` option defines a string which will be used as a description in the Admin UI and GraphQL API docs.

packages-next/keystone/src/lib/createKeystone.ts

@@ -50,7 +50,7 @@ export function createKeystone(config: KeystoneConfig, dotKeystonePath: string,
     // appVersion
   });
 
-  Object.entries(lists).forEach(([key, { fields, graphql, access, hooks, description }]) => {
+  Object.entries(lists).forEach(([key, { fields, graphql, access, hooks, description, db }]) => {
     keystone.createList(key, {
       fields: Object.fromEntries(
         Object.entries(fields).map(([key, { type, config }]: any) => [key, { type, ...config }])
@@ -61,6 +61,7 @@ export function createKeystone(config: KeystoneConfig, dotKeystonePath: string,
       listQueryName: graphql?.listQueryName,
       itemQueryName: graphql?.itemQueryName,
       hooks,
+      adapterConfig: db,
       // FIXME: Unsupported options: Need to work which of these we want to support with backwards
       // compatibility options.
       // adminDoc
@@ -71,7 +72,6 @@ export function createKeystone(config: KeystoneConfig, dotKeystonePath: string,
       // singular
       // plural
       // path
-      // adapterConfig
       // cacheHint
       // plugins
     });

packages-next/types/src/base.ts

@@ -15,6 +15,7 @@ export type BaseKeystone = {
       listQueryName?: string;
       itemQueryName?: string;
       hooks?: Record<string, any>;
+      adapterConfig?: { searchField?: string };
     }
   ) => BaseKeystoneList;
   connect: (args?: any) => Promise<void>;

packages-next/types/src/config/lists.ts

@@ -43,6 +43,8 @@ export type ListConfig<
 
   graphql?: ListGraphQLConfig;
 
+  db?: ListDBConfig;
+
   // Not currently supported
   // plugins?: any[]; // array of plugins that can modify the list config
 
@@ -224,4 +226,12 @@ export type ListGraphQLConfig = {
   };
 };
 
+export type ListDBConfig = {
+  /**
+   * The name of the field to use for `search` filter operations.
+   * @default "name""
+   */
+  searchField?: string;
+};
+
 // export type CacheHint = { scope: 'PRIVATE' | 'PUBLIC'; maxAge: number };

packages/adapter-knex/lib/adapter-knex.js

@@ -620,11 +620,12 @@ class QueryBuilder {
     this._addWheres(w => this._query.andWhere(w), listAdapter, where, baseTableAlias);
 
     // TODO: Implement configurable search fields for lists
-    const searchField = listAdapter.fieldAdaptersByPath['name'];
+    const searchFieldName = listAdapter.config.searchField || 'name';
+    const searchField = listAdapter.fieldAdaptersByPath[searchFieldName];
     if (search !== undefined && searchField) {
       if (searchField.fieldName === 'Text') {
         const f = escapeRegExp;
-        this._query.andWhere(`${baseTableAlias}.name`, '~*', f(search));
+        this._query.andWhere(`${baseTableAlias}.${searchFieldName}`, '~*', f(search));
       } else {
         this._query.whereRaw('false'); // Return no results
       }

packages/adapter-mongoose/lib/tokenizers.js

@@ -112,13 +112,14 @@ const simpleTokenizer = (listAdapter, query, queryKey, path) => {
 
 const modifierTokenizer = (listAdapter, query, queryKey, path) => {
   const refListAdapter = getRelatedListAdapterFromQueryPath(listAdapter, path);
+  const searchFieldName = listAdapter.config.searchField || 'name';
   return {
     // TODO: Implement configurable search fields for lists
     $search: value => {
       if (!value || (getType(value) === 'String' && !value.trim())) {
         return undefined;
       }
-      return { $match: { name: new RegExp(`${escapeRegExp(value)}`, 'i') } };
+      return { $match: { [searchFieldName]: new RegExp(`${escapeRegExp(value)}`, 'i') } };
     },
     $orderBy: (value, _, listAdapter) => {
       const [orderField, orderDirection] = value.split('_');

packages/adapter-mongoose/tests/simple.test.js

@@ -4,7 +4,7 @@ describe('Simple tokenizer', () => {
   test('Uses correct conditions', () => {
     const simpleConditions = { name: () => ({ foo: 'bar' }) };
     const getQueryConditions = jest.fn(() => simpleConditions);
-    const listAdapter = { fieldAdapters: [{ getQueryConditions }] };
+    const listAdapter = { fieldAdapters: [{ getQueryConditions }], config: {} };
 
     expect(simpleTokenizer(listAdapter, { name: 'hi' }, 'name', ['name'])).toMatchObject({
       foo: 'bar',
@@ -15,7 +15,7 @@ describe('Simple tokenizer', () => {
   test('Falls back to modifier conditions when no simple condition found', () => {
     const simpleConditions = { notinuse: () => ({ foo: 'bar' }) };
     const getQueryConditions = jest.fn(() => simpleConditions);
-    const listAdapter = { fieldAdapters: [{ getQueryConditions }] };
+    const listAdapter = { fieldAdapters: [{ getQueryConditions }], config: {} };
 
     expect(modifierTokenizer(listAdapter, { $count: 'hi' }, '$count', ['$count'])).toMatchObject({
       $count: 'hi',
@@ -26,7 +26,7 @@ describe('Simple tokenizer', () => {
   test('returns empty array when no matches found', () => {
     const simpleConditions = { notinuse: () => ({ foo: 'bar' }) };
     const getQueryConditions = jest.fn(() => simpleConditions);
-    const listAdapter = { fieldAdapters: [{ getQueryConditions }] };
+    const listAdapter = { fieldAdapters: [{ getQueryConditions }], config: {} };
 
     const result = simpleTokenizer(listAdapter, { name: 'hi' }, 'name', ['name']);
     expect(result).toBe(undefined);
@@ -37,7 +37,7 @@ describe('Simple tokenizer', () => {
     const nameConditions = jest.fn(() => ({ foo: 'bar' }));
     const simpleConditions = { name: nameConditions };
     const getQueryConditions = jest.fn(() => simpleConditions);
-    const listAdapter = { fieldAdapters: [{ getQueryConditions }] };
+    const listAdapter = { fieldAdapters: [{ getQueryConditions }], config: {} };
 
     expect(simpleTokenizer(listAdapter, { name: 'hi' }, 'name', ['name'])).toMatchObject({
       foo: 'bar',

packages/adapter-mongoose/tests/utils.js

@@ -9,6 +9,7 @@ const tagsAdapter = {
     },
   ],
   graphQlQueryPathToMongoField: orderField => orderField,
+  config: {},
 };
 
 const postsAdapter = {
@@ -42,6 +43,7 @@ const postsAdapter = {
     },
   ],
   graphQlQueryPathToMongoField: orderField => orderField,
+  config: {},
 };
 
 const listAdapter = {
@@ -87,6 +89,7 @@ const listAdapter = {
       }),
     },
   ],
+  config: {},
 };
 
 listAdapter.fieldAdapters.push({

packages/adapter-prisma/lib/adapter-prisma.js

@@ -411,18 +411,29 @@ class PrismaListAdapter extends BaseListAdapter {
     }
 
     // TODO: Implement configurable search fields for lists
-    const searchField = this.fieldAdaptersByPath['name'];
+    const searchFieldName = this.config.searchField || 'name';
+    const searchField = this.fieldAdaptersByPath[searchFieldName];
     if (search !== undefined && search !== '' && searchField) {
       if (searchField.fieldName === 'Text') {
         // FIXME: Think about regex
-        if (!ret.where) ret.where = { name: { contains: search, mode: 'insensitive' } };
-        else ret.where = { AND: [ret.where, { name: { contains: search, mode: 'insensitive' } }] };
+        if (!ret.where) {
+          ret.where = { [searchFieldName]: { contains: search, mode: 'insensitive' } };
+        } else {
+          ret.where = {
+            AND: [ret.where, { [searchFieldName]: { contains: search, mode: 'insensitive' } }],
+          };
+        }
         // const f = escapeRegExp;
-        // this._query.andWhere(`${baseTableAlias}.name`, '~*', f(search));
+        // this._query.andWhere(`${baseTableAlias}.${searchFieldName}`, '~*', f(search));
       } else {
         // Return no results
-        if (!ret.where) ret.where = { AND: [{ name: null }, { NOT: { name: null } }] };
-        else ret.where = { AND: [ret.where, { name: null }, { NOT: { name: null } }] };
+        if (!ret.where) {
+          ret.where = { AND: [{ [searchFieldName]: null }, { NOT: { [searchFieldName]: null } }] };
+        } else {
+          ret.where = {
+            AND: [ret.where, { [searchFieldName]: null }, { NOT: { [searchFieldName]: null } }],
+          };
+        }
       }
     }
 

tests/api-tests/queries/search.test.js

@@ -18,6 +18,12 @@ function setupKeystone(adapterName) {
             name: integer(),
           },
         }),
+        Custom: list({
+          fields: {
+            other: text(),
+          },
+          db: { searchField: 'other' },
+        }),
       },
     }),
   });
@@ -226,5 +232,34 @@ multiAdapterRunners().map(({ runner, adapterName }) =>
         ]); // All results
       })
     );
+    test(
+      'custom',
+      runner(setupKeystone, async ({ context }) => {
+        const create = async (listKey, item) => createItem({ context, listKey, item });
+        await Promise.all([
+          create('Test', { name: 'one' }),
+          create('Test', { name: '%islikelike%' }),
+          create('Test', { name: 'three' }),
+          create('Number', { name: 12345 }),
+          create('Custom', { other: 'one' }),
+          create('Custom', { other: 'two' }),
+        ]);
+
+        const { data, errors } = await context.executeGraphQL({
+          query: `
+          query {
+            allCustoms(
+              search: "one",
+            ) {
+              other
+            }
+          }
+      `,
+        });
+        expect(errors).toBe(undefined);
+        expect(data).toHaveProperty('allCustoms');
+        expect(data.allCustoms).toEqual([{ other: 'one' }]);
+      })
+    );
   })
 );