fix(util): safely stringify path segments named as GROQ data types (e.g. null)

[juice49]

Description

Fields named as GROQ data types (true, false, and null) cannot be accessed using dot notation. These fields must instead be serialized using square bracket notation.

Segments names true, false, or null will now be serialized using square bracket notation. All other segments will continue to use dot notation.

Invalid

parent.true

Valid

parent["true"]

You can observe this by executing a GROQ query such as:

[{
  "true": "positive"
}, {
  "false": "negative"
}, {
  "null": "nothing"
}].null

// attribute expected

Versus:

[{
  "true": "positive"
}, {
  "false": "negative"
}, {
  "null": "nothing"
}]["null"]

// [
//   null,
//   null,
//   "nothing"
// ]

What to review

The paths created by the toString function are correct.

Testing

This branch adds tests to the packages/@sanity/util/test/PathUtils.test.ts test suite.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
performance-studio	✅ Ready (Inspect)	Visit Preview	Mar 13, 2024 10:58am
test-studio	✅ Ready (Inspect)	Visit Preview	Mar 13, 2024 10:58am

1 Ignored Deployment

Name	Status	Preview	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)		Mar 13, 2024 10:58am

[juice49]

• refactor(core): use path toString function from @sanity/util/paths #5987
• fix(util): safely stringify path segments named as GROQ data types (e.g. null) #5986 👈
• next

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @juice49 and the rest of your teammates on Graphite

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Mar 13, 2024 11:08 AM (UTC)

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	32s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	6s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	12s	4	2	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	13s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	31s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 0s	15	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 1s	18	0	0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	12s	6	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	13s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	19s	9	0	0

[bjoerge]

Very nice, thank you!

[juice49]

Merge activity

• Mar 18, 12:45 PM EDT: @juice49 started a stack merge that includes this pull request via Graphite.
• Mar 18, 12:46 PM EDT: @juice49 merged this pull request with Graphite.