Update built-in fields to new validate hook syntax #9166

acburdine · 2024-06-05T16:57:25Z

this updates the built-in fields using validateInput to use the new unified validation syntax, and handles merging with the old syntax to ensure user-land old syntax still works

codesandbox-ci · 2024-06-05T17:00:22Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit ea10e02:

Sandbox	Source
@keystone-6/sandbox	Configuration

dcousens · 2024-06-05T23:23:44Z

Amazing @acburdine, this is tedious and really appreciated work! 💚
I'll review, merge + release this as soon as I can.

gautamsi · 2024-07-08T05:02:37Z

I am working on #9204 which removes the deprecated hooks and cleanups code for Fields as well as consuming code in a breaking changes. This PR will not be needed if that approach works for @dcousens

dcousens · 2024-07-08T05:03:40Z

@gautamsi #9204 will be a breaking change, which is good, we want that, but, we should let users gracefully upgrade by releasing this first no?

gautamsi · 2024-07-08T05:04:42Z

we can do that, i guess the other one would be part of v-next branch and might take longer, I agree with you to get this going.

dcousens · 2024-07-09T00:37:42Z

tests/api-tests/fields/types/fixtures/decimal/test-fixtures.ts

@@ -55,7 +55,7 @@ export const crudTests = (keystoneTestWrapper: any) => {
      expect(result.errors).toHaveLength(1)
      expect(result.errors![0].message).toMatchInlineSnapshot(`
        "You provided invalid data for this operation.
-          - Test.price: Price must be greater than or equal to -300"
+          - Test.price: value must be greater than or equal to -300"


Errors are already prefixed with {listKey}.{fieldKey}, this humanized part is redundant and is difficult to understand for names with a few words

dcousens · 2024-07-09T00:50:32Z

packages/core/src/fields/types/bigInt/index.ts

+      max !== undefined &&
+      min > max
+    ) {
+      throw new Error(`${meta.listKey}.${meta.fieldKey} specifies a validation.max that is less than the validation.min, and therefore has no valid options`)
    }


I used this opportunity to unify each of the numerical fields to share nearly the same code for min and max validation.

dcousens · 2024-07-09T01:10:47Z

packages/core/src/fields/resolve-hooks.ts

+      delete: merge(builtinValidate?.delete, hooksValidate?.delete)
+    } : undefined,
+  } satisfies FieldHooks<ListTypeInfo>
+}


@acburdine I tidied this up a little to re-use a new merge function, but fundamentally it's the same

packages/core/src/fields/resolve-hooks.ts

dcousens · 2024-07-09T01:57:03Z

tests/api-tests/fields/types/fixtures/text/test-fixtures.ts

@@ -4,6 +4,7 @@ export const name = 'Text'
 export const typeFunction = text
 export const exampleValue = () => 'foo'
 export const exampleValue2 = () => 'bar'
+export const nonNullableDefault = true


By adding this for multiselect, and text supporting null in #9057, text is now less special in our tests

dcousens · 2024-07-09T01:57:48Z

tests/api-tests/fields/required.test.ts

@@ -53,6 +52,11 @@ for (const modulePath of testModules) {
              fields: {
                name: text(),
                testField: mod.typeFunction({
+                  ...(mod.nonNullableDefault ? {
+                    db: {
+                      isNullable: true


These tests had been previously written assuming that db.isNullable is true by default, with an inline exception for text

dcousens · 2024-07-09T01:59:27Z

Thanks for starting this work @acburdine, this has been a heavy lift that has been required for a while - I don't think I could have jumped in to update the fields to be aligned with validation.isRequired and db.isNullable without your help!

Thank you 💛

dcousens self-requested a review June 12, 2024 23:35

dcousens self-assigned this Jun 12, 2024

gautamsi mentioned this pull request Jul 8, 2024

Remove deprecated hooks #9204

Open

5 tasks

dcousens force-pushed the fix/field-hooks branch 6 times, most recently from 4d56c41 to 2d2b8fc Compare July 8, 2024 10:57

keystonejs deleted a comment from codesandbox-ci bot Jul 8, 2024

dcousens force-pushed the fix/field-hooks branch 4 times, most recently from d6cbbcc to 2cf6c8c Compare July 9, 2024 00:34

acburdine and others added 8 commits July 9, 2024 10:34

update built-in fields to new validate hook syntax

9e7b1d0

refactor resolve-hooks code

b285e25

dedupe makeValidationHook for mode and validate hook

d9cfc5d

fix select isNotNull when only validation.isRequired is set

556b941

less meta at the front of error messages

ed77734

tidy up

22e87fa

revert password to db.isNullable: false default

8dc51b9

unify validation and fix tests

393dc93

dcousens force-pushed the fix/field-hooks branch from 2cf6c8c to 393dc93 Compare July 9, 2024 00:34

dcousens reviewed Jul 9, 2024

View reviewed changes

unify float to same as integer, bigInt et al

f29f4ba

dcousens reviewed Jul 9, 2024

View reviewed changes

dcousens added 3 commits July 9, 2024 11:00

add bigInt error when defaultValue and isRequired is set

eadd3b0

add bigInt changeset

64069ff

fix example-test.ts

cbc2ece

dcousens approved these changes Jul 9, 2024

View reviewed changes

dcousens reviewed Jul 9, 2024

View reviewed changes

packages/core/src/fields/resolve-hooks.ts Outdated Show resolved Hide resolved

revert builtin.beforeOperation to happen first

d1dba42

dcousens force-pushed the fix/field-hooks branch from 391e694 to a5dc5b3 Compare July 9, 2024 01:44

add multiselect nullable changeset + add tests

a3c80b9

dcousens force-pushed the fix/field-hooks branch from a5dc5b3 to a3c80b9 Compare July 9, 2024 01:49

fix tests for non-nullable default fields

c2420fc

dcousens reviewed Jul 9, 2024

View reviewed changes

fix bigInt changeset

c45b153

dcousens merged commit ad45b05 into keystonejs:main Jul 9, 2024
42 of 43 checks passed

acburdine deleted the fix/field-hooks branch July 9, 2024 12:20

dcousens mentioned this pull request Aug 9, 2024

Version Packages #9264

Merged

acburdine mentioned this pull request Aug 9, 2024

Fix validation hook merge function passthrough #9278

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update built-in fields to new validate hook syntax #9166

Update built-in fields to new validate hook syntax #9166

acburdine commented Jun 5, 2024

codesandbox-ci bot commented Jun 5, 2024

dcousens commented Jun 5, 2024

gautamsi commented Jul 8, 2024

dcousens commented Jul 8, 2024 •

edited

Loading

gautamsi commented Jul 8, 2024

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens commented Jul 9, 2024 •

edited

Loading

Update built-in fields to new validate hook syntax #9166

Update built-in fields to new validate hook syntax #9166

Conversation

acburdine commented Jun 5, 2024

codesandbox-ci bot commented Jun 5, 2024

dcousens commented Jun 5, 2024

gautamsi commented Jul 8, 2024

dcousens commented Jul 8, 2024 • edited Loading

gautamsi commented Jul 8, 2024

dcousens Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens commented Jul 9, 2024 • edited Loading

dcousens commented Jul 8, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens Jul 9, 2024 •

edited

Loading

dcousens commented Jul 9, 2024 •

edited

Loading