Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Perf/memo prepare form state #7519

Closed
wants to merge 8 commits into from
+2,434 −1,049
Closed

Perf/memo prepare form state #7519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c8d5932
perf(core): memoize prepareFormState
ricokahler Sep 12, 2024
014fc8b
refactor(core): update root form state options
ricokahler Sep 13, 2024
c8edc6b
fix(core): fix memoization bugs
ricokahler Sep 13, 2024
ab050ce
test(core): finish tests for every form option
ricokahler Sep 16, 2024
15737c5
fix(core): fix stale `fieldGroupState` memo result
ricokahler Sep 16, 2024
f71b671
refactor(core): return named function for readability
ricokahler Sep 16, 2024
e3b2bd8
docs(core): add JSDoc for `getId`
ricokahler Sep 16, 2024
35c17a7
refactor(core): mark sub-functions of `PrepareFormState` as internal
ricokahler Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/sanity/playwright-ct/tests/formBuilder/utils/TestForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,8 @@ export function TestForm(props: TestFormProps) {
validateStaticDocument(document, workspace, (result) => setValidation(result))
}, [document, workspace])

const formState = useFormState(schemaType, {
const formState = useFormState({
schemaType,
focusPath,
collapsedPaths,
collapsedFieldSets,
Expand All @@ -166,7 +167,7 @@ export function TestForm(props: TestFormProps) {
openPath,
presence: presenceFromProps,
validation,
value: document,
documentValue: document,
})

const formStateRef = useRef(formState)
Expand Down
20 changes: 13 additions & 7 deletions packages/sanity/src/core/form/store/__tests__/collapsible.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import {describe, expect, it, test} from '@jest/globals'
import {beforeEach, describe, expect, it, test} from '@jest/globals'
import {Schema} from '@sanity/schema'
import {type ObjectSchemaType, type Path} from '@sanity/types'

import {pathToString} from '../../../field'
import {prepareFormState} from '../formState'
import {createPrepareFormState, type PrepareFormState} from '../formState'
import {type FieldMember, type ObjectFormNode} from '../types'
import {isObjectFormNode} from '../types/asserters'
import {DEFAULT_PROPS} from './shared'
Expand Down Expand Up @@ -81,6 +81,12 @@ function getBookType(fieldOptions: {
}).get('book')
}

let prepareFormState!: PrepareFormState

beforeEach(() => {
prepareFormState = createPrepareFormState()
})

test("doesn't make primitive fields collapsed even if they are configured to be", () => {
// Note: the schema validation should possibly enforce this
// Note2: We might want to support making all kinds of fields collapsible, even primitive fields
Expand All @@ -93,7 +99,7 @@ test("doesn't make primitive fields collapsed even if they are configured to be"
const result = prepareFormState({
...DEFAULT_PROPS,
schemaType: bookType,
document: {_id: 'foo', _type: 'book'},
documentValue: {_id: 'foo', _type: 'book'},
})

expect(result).not.toBe(null)
Expand Down Expand Up @@ -121,7 +127,7 @@ describe('collapsible object fields', () => {
const result = prepareFormState({
...DEFAULT_PROPS,
schemaType: bookType,
document: {_id: 'foo', _type: 'book'},
documentValue: {_id: 'foo', _type: 'book'},
})

expect(result).not.toBe(null)
Expand All @@ -141,7 +147,7 @@ describe('collapsible object fields', () => {
const result = prepareFormState({
...DEFAULT_PROPS,
schemaType: bookType,
document: {_id: 'foo', _type: 'book'},
documentValue: {_id: 'foo', _type: 'book'},
})

expect(result).not.toBe(null)
Expand All @@ -160,7 +166,7 @@ describe('collapsible object fields', () => {
const result = prepareFormState({
...DEFAULT_PROPS,
schemaType: bookType,
document: {_id: 'foo', _type: 'book'},
value: {_id: 'foo', _type: 'book'},
})

expect(result).not.toBe(null)
Expand All @@ -184,7 +190,7 @@ describe('collapsible object fields', () => {
const result = prepareFormState({
...DEFAULT_PROPS,
schemaType: bookType,
document: {_id: 'foo', _type: 'book'},
documentValue: {_id: 'foo', _type: 'book'},
})

expect(result).not.toBe(null)
Expand Down
16 changes: 11 additions & 5 deletions packages/sanity/src/core/form/store/__tests__/equality.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {expect, test} from '@jest/globals'
import {beforeEach, expect, test} from '@jest/globals'
import {Schema} from '@sanity/schema'
import {type ConditionalProperty} from '@sanity/types'

import {prepareFormState} from '../formState'
import {createPrepareFormState, type PrepareFormState} from '../formState'
import {DEFAULT_PROPS} from './shared'

function getBookType(properties: {
Expand Down Expand Up @@ -73,20 +73,26 @@ function getBookType(properties: {
}).get('book')
}

let prepareFormState!: PrepareFormState

beforeEach(() => {
prepareFormState = createPrepareFormState()
})

test('it doesnt return new object equalities given the same input', () => {
const document = {_id: 'test', _type: 'foo'}
const documentValue = {_id: 'test', _type: 'foo'}
const bookType = getBookType({})

const state1 = prepareFormState({
...DEFAULT_PROPS,
schemaType: bookType,
document,
documentValue,
})

const state2 = prepareFormState({
...DEFAULT_PROPS,
schemaType: bookType,
document,
documentValue,
})
expect(state1).not.toBe(null)
expect(state2).not.toBe(null)
Expand Down
Loading
Loading