add multiselect nullable changeset + add tests

keystonejs · Jul 9, 2024 · a3c80b9 · a3c80b9
1 parent d1dba42
commit a3c80b9
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 35 deletions.
diff --git a/.changeset/add-isnullable-multiselect.md b/.changeset/add-isnullable-multiselect.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+Add `db.isNullable` support for multiselect field type, defaults to false
diff --git a/packages/core/src/fields/types/multiselect/index.ts b/packages/core/src/fields/types/multiselect/index.ts
@@ -8,7 +8,6 @@ import {
   jsonFieldTypePolyfilledForSQLite,
 } from '../../../types'
 import { graphql } from '../../..'
-import { userInputError } from '../../../lib/core/graphql-errors'
 import { makeValidateHook } from '../../non-null-graphql'
 import { mergeFieldHooks } from '../../resolve-hooks'
 
@@ -25,12 +24,12 @@ export type MultiselectFieldConfig<ListTypeInfo extends BaseListTypeInfo> =
            * If `enum` is provided on SQLite, it will use an enum in GraphQL but a string in the database.
            */
           type?: 'string' | 'enum'
-          defaultValue?: readonly string[]
+          defaultValue?: readonly string[] | null
         }
       | {
           options: readonly { label: string, value: number }[]
           type: 'integer'
-          defaultValue?: readonly number[]
+          defaultValue?: readonly number[] | null
         }
     ) & {
       db?: {
@@ -48,7 +47,7 @@ export function multiselect <ListTypeInfo extends BaseListTypeInfo> (
   config: MultiselectFieldConfig<ListTypeInfo>
 ): FieldTypeFunc<ListTypeInfo> {
   const {
-    defaultValue = [],
+    defaultValue = [], // TODO: deprecated, remove in breaking change
   } = config
 
   config.db ??= {}
@@ -64,7 +63,7 @@ export function multiselect <ListTypeInfo extends BaseListTypeInfo> (
       return graphql.arg({ type: nonNullList(type) })
     }
 
-    const resolveCreate = <T extends string | number>(val: T[] | null | undefined): T[] => {
+    const resolveCreate = <T extends string | number>(val: T[] | null | undefined): T[] | null => {
       const resolved = resolveUpdate(val)
       if (resolved === undefined) {
         return defaultValue as T[]
@@ -74,15 +73,11 @@ export function multiselect <ListTypeInfo extends BaseListTypeInfo> (
 
     const resolveUpdate = <T extends string | number>(
       val: T[] | null | undefined
-    ): T[] | undefined => {
-      if (val === null) {
-        throw userInputError('multiselect fields cannot be set to null')
-      }
+    ): T[] | null | undefined => {
       return val
     }
 
     const transformedConfig = configToOptionsAndGraphQLType(config, meta)
-
     const accepted = new Set(transformedConfig.options.map(x => x.value))
     if (accepted.size !== transformedConfig.options.length) {
       throw new Error(`${meta.listKey}.${meta.fieldKey} has duplicate options, this is not allowed`)
@@ -94,8 +89,8 @@ export function multiselect <ListTypeInfo extends BaseListTypeInfo> (
     } = makeValidateHook(meta, config, ({ inputData, operation, addValidationError }) => {
       if (operation === 'delete') return
 
-      const values: readonly (string | number)[] | undefined = inputData[meta.fieldKey] // resolvedData is JSON
-      if (values !== undefined) {
+      const values: readonly (string | number)[] | null | undefined = inputData[meta.fieldKey] // resolvedData is JSON
+      if (values != null) {
         for (const value of values) {
           if (!accepted.has(value)) {
             addValidationError(`'${value}' is not an accepted option`)
@@ -137,7 +132,10 @@ export function multiselect <ListTypeInfo extends BaseListTypeInfo> (
         mode,
         map: config?.db?.map,
         extendPrismaSchema: config.db?.extendPrismaSchema,
-        default: { kind: 'literal', value: JSON.stringify(defaultValue) },
+        default: {
+          kind: 'literal',
+          value: JSON.stringify(defaultValue ?? null)
+        },
       }
     )
   }
@@ -191,5 +189,4 @@ function configToOptionsAndGraphQLType (
   }
 }
 
-const nonNullList = <T extends graphql.NullableType>(type: T) =>
-  graphql.list(graphql.nonNull(type))
+const nonNullList = <T extends graphql.NullableType>(type: T) => graphql.list(graphql.nonNull(type))
diff --git a/tests/api-tests/fields/required.test.ts b/tests/api-tests/fields/required.test.ts
@@ -86,25 +86,27 @@ for (const modulePath of testModules) {
 
       const messages = [`Test.testField: missing value`]
 
-      test(
-        'Create an object without the required field',
-        runner(async ({ context }) => {
-          const { data, errors } = await context.graphql.raw({
-            query: `
-              mutation {
-                createTest(data: { name: "test entry" } ) { id }
-              }`,
+      if (!mod.hasDefaultDefault) {
+        test(
+          'Create an object without the required field',
+          runner(async ({ context }) => {
+            const { data, errors } = await context.graphql.raw({
+              query: `
+                mutation {
+                  createTest(data: { name: "test entry" } ) { id }
+                }`,
+            })
+            expect(data).toEqual({ createTest: null })
+            expectValidationError(errors, [
+              {
+                path: ['createTest'],
+                messages:
+                  mod.name === 'Text' ? ['Test.testField: value must not be empty'] : messages,
+              },
+            ])
           })
-          expect(data).toEqual({ createTest: null })
-          expectValidationError(errors, [
-            {
-              path: ['createTest'],
-              messages:
-                mod.name === 'Text' ? ['Test.testField: value must not be empty'] : messages,
-            },
-          ])
-        })
-      )
+        )
+      }
 
       test(
         'Create an object with an explicit null value',

diff --git a/tests/api-tests/fields/types/fixtures/multiselect/test-fixtures.ts b/tests/api-tests/fields/types/fixtures/multiselect/test-fixtures.ts
@@ -17,10 +17,11 @@ export const exampleValue2 = (matrixValue: MatrixValue) =>
     ? ['a string', '1number']
     : [2, 4]
 export const supportsNullInput = false
-export const neverNull = true
+export const hasDefaultDefault = true
+export const neverNull = false
 export const supportsUnique = false
 export const supportsDbMap = true
-export const skipRequiredTest = true
+export const skipRequiredTest = false
 export const fieldConfig = (matrixValue: MatrixValue) => {
   if (matrixValue === 'enum' || matrixValue === 'string') {
     return {