fix(portable-text-editor): add autoresolving validations and fix normalization issues #6770

skogsmaskin · 2024-05-24T14:54:51Z

Description

This will add two auto-resolving validations:

Test a block for orphaned markDefs and remove obsolete ones (previously only done through editor normalization).
Test a block for orphaned marks and remove obsolete ones (previously a hard validation error).

By introducing these new validations, I found two issues. The first was there before, and the other one occured introducing the new normalization rules of markDefs.

Fix issue where deleting block 3, 2 and partially 1 where block 1 contains an remaining annotation (too many validation iterations error).
Fix issue where copying an text fragment containing an annotation would not be valid with the new validation code.

What to review

Testing

Should be covered by unit tests.

Notes for release

Improve the validation of content in the Portable Text Editor.

vercel · 2024-05-24T14:54:54Z

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

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 27, 2024 0:41am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 27, 2024 0:41am
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 27, 2024 0:41am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 27, 2024 0:41am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		May 27, 2024 0:41am

github-actions · 2024-05-24T14:57:11Z

No changes to documentation

github-actions · 2024-05-24T15:04:29Z

Component Testing Report Updated May 27, 2024 12:40 PM (UTC)

File	Status	Duration	Passed	Skipped
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	37s	15	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	6s	3	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	26s	6	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	31s	11	7
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	14s	6	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	8s	3	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	36s	15	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 15s	21	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 3s	18	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	7s	3	9
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	21s	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	15s	6	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	30s	12	0

skogsmaskin · 2024-05-24T15:07:22Z

packages/@sanity/portable-text-editor/src/editor/__tests__/PortableTextEditor.test.tsx

@@ -310,7 +310,7 @@ describe('initialization', () => {
        _key: 'abc',
        _type: 'myTestBlockType',
        markDefs: [],
-        children: [{_key: 'def', _type: 'span', text: 'Test', marks: ['invalid']}],
+        children: [{_key: 'def', _type: 'span', marks: []}],


The previous test case is now auto-resolved, so we need another (hard) validation error for this test.

skogsmaskin · 2024-05-24T15:08:11Z

packages/@sanity/portable-text-editor/src/editor/plugins/createWithInsertData.ts

-        },
-        {at: focusPath, mode: 'lowest', voids: false},
-      )
+  editor.withoutNormalizing(() => {


This whole transformation must be run without normalizing, as we build up the data (we don't want to be normalizing orphaned data in the intermediate state).

skogsmaskin · 2024-05-27T08:55:08Z

packages/@sanity/portable-text-editor/src/editor/plugins/createWithInsertData.ts

@@ -142,7 +142,7 @@ export function createWithInsertData(
          // Validate the result
          const validation = validateValue(parsed, schemaTypes, keyGenerator)
          // Bail out if it's not valid
-          if (!validation.valid) {
+          if (!validation.valid && !validation.resolution?.autoResolve) {


Validation errors for pasted fragments that can be auto-resolved should pass.

skogsmaskin · 2024-05-27T09:03:08Z

packages/@sanity/portable-text-editor/src/utils/validateValue.ts

@@ -276,7 +283,7 @@ export function validateValue(
              i18n: {
                description: 'inputs.portable-text.invalid-value.orphaned-marks.description',
                action: 'inputs.portable-text.invalid-value.orphaned-marks.action',
-                values: {key: blk._key, orphanedMarks},
+                values: {key: blk._key, orphanedMarks: orphanedMarks.map((m) => m.toString())},


Values for i18n must be strings, so safeguard this map as strings.

skogsmaskin · 2024-05-27T09:28:18Z

packages/@sanity/portable-text-editor/src/editor/plugins/createWithPortableTextMarkModel.ts

-          ['split_node', 'remove_node', 'remove_text', 'merge_node'].includes(op.type),
+        editor.isTextBlock(node) &&
+        !editor.operations.some(
+          (op) => op.type === 'merge_node' && 'markDefs' in op.properties && op.path.length === 1,


Because of the new normalization rules, this must be rewritten (as discovered by tests).

Now we do the markDefs normalization here for every operation that is NOT merging two text blocks, as this will be an intermediate state, where potentially new child nodes are added later in the change (next operation). We should do this normalization in the later operations instead.

skogsmaskin · 2024-05-27T09:29:16Z

packages/@sanity/portable-text-editor/src/editor/plugins/createWithPortableTextMarkModel.ts

        )
      ) {
-        normalizeMarkDefs(editor, types)


This is very pretty inefficient as it will do the whole editor, and not the actual nodes that are transformed.

skogsmaskin · 2024-05-27T10:41:54Z

packages/@sanity/portable-text-editor/src/editor/plugins/createWithEditableAPI.ts

@@ -517,7 +516,6 @@ export function createWithEditableAPI(
                  })
                }
              })
-              normalizeMarkDefs(editor, types)


This is now done in the normalization inside withPortableTextMarksModel

…alization issue This will add up front validation for orphaned marks and markDefs that can be autoresolved through patches. It will also fix some issues when it comes to adding and removing annotations, which transformations now must be built up using the withoutNormalization scope.

RitaDias

This is great 👍

vercel bot deployed to Preview – test-next-studio May 24, 2024 14:55 View deployment

skogsmaskin commented May 24, 2024

View reviewed changes

skogsmaskin commented May 27, 2024

View reviewed changes

skogsmaskin force-pushed the fix/pte-normalization-and-validation branch from 4c507fa to 99fa9af Compare May 27, 2024 08:58

vercel bot deployed to Preview – page-building-studio May 27, 2024 09:01 View deployment

vercel bot deployed to Preview – performance-studio May 27, 2024 09:01 View deployment

skogsmaskin force-pushed the fix/pte-normalization-and-validation branch from 99fa9af to d7c7040 Compare May 27, 2024 09:01

vercel bot deployed to Preview – page-building-studio May 27, 2024 09:02 View deployment

vercel bot deployed to Preview – performance-studio May 27, 2024 09:02 View deployment

vercel bot deployed to Preview – test-studio May 27, 2024 09:03 View deployment

skogsmaskin commented May 27, 2024

View reviewed changes

vercel bot deployed to Preview – test-next-studio May 27, 2024 09:07 View deployment

skogsmaskin commented May 27, 2024

View reviewed changes

skogsmaskin marked this pull request as ready for review May 27, 2024 11:19

skogsmaskin requested review from a team and RitaDias and removed request for a team May 27, 2024 11:19

skogsmaskin added 2 commits May 27, 2024 14:30

test(portable-text-editor): add validation and normalization tests

839e93d

skogsmaskin force-pushed the fix/pte-normalization-and-validation branch from d7c7040 to 839e93d Compare May 27, 2024 12:30

vercel bot deployed to Preview – page-building-studio May 27, 2024 12:36 View deployment

vercel bot deployed to Preview – performance-studio May 27, 2024 12:36 View deployment

vercel bot deployed to Preview – test-studio May 27, 2024 12:37 View deployment

vercel bot deployed to Preview – test-next-studio May 27, 2024 12:41 View deployment

RitaDias approved these changes May 28, 2024

View reviewed changes

skogsmaskin added this pull request to the merge queue May 28, 2024

Merged via the queue into next with commit c458289 May 28, 2024
42 checks passed

skogsmaskin deleted the fix/pte-normalization-and-validation branch May 28, 2024 08:25

leocabrallce mentioned this pull request Jun 20, 2024

[Snyk] Upgrade sanity from 3.43.0 to 3.44.0 leocabrallce/portfolio-next#3

Open

This was referenced Jun 24, 2024

[Snyk] Upgrade @sanity/vision from 3.33.0 to 3.44.0 justmogen/Celestial-haven-retreat#5

Open

[Snyk] Upgrade sanity from 3.33.0 to 3.44.0 justmogen/Celestial-haven-retreat#6

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(portable-text-editor): add autoresolving validations and fix normalization issues #6770

fix(portable-text-editor): add autoresolving validations and fix normalization issues #6770

skogsmaskin commented May 24, 2024 •

edited

Loading

vercel bot commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024

github-actions bot commented May 24, 2024 •

edited

Loading

skogsmaskin May 24, 2024 •

edited

Loading

skogsmaskin May 24, 2024 •

edited

Loading

skogsmaskin May 27, 2024

skogsmaskin May 27, 2024

skogsmaskin May 27, 2024

skogsmaskin May 27, 2024

skogsmaskin May 27, 2024

RitaDias left a comment

fix(portable-text-editor): add autoresolving validations and fix normalization issues #6770

fix(portable-text-editor): add autoresolving validations and fix normalization issues #6770

Conversation

skogsmaskin commented May 24, 2024 • edited Loading

Description

What to review

Testing

Notes for release

vercel bot commented May 24, 2024 • edited Loading

github-actions bot commented May 24, 2024

github-actions bot commented May 24, 2024 • edited Loading

skogsmaskin May 24, 2024 • edited Loading

Choose a reason for hiding this comment

skogsmaskin May 24, 2024 • edited Loading

Choose a reason for hiding this comment

skogsmaskin May 27, 2024

Choose a reason for hiding this comment

skogsmaskin May 27, 2024

Choose a reason for hiding this comment

skogsmaskin May 27, 2024

Choose a reason for hiding this comment

skogsmaskin May 27, 2024

Choose a reason for hiding this comment

skogsmaskin May 27, 2024

Choose a reason for hiding this comment

RitaDias left a comment

Choose a reason for hiding this comment

skogsmaskin commented May 24, 2024 •

edited

Loading

vercel bot commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024 •

edited

Loading

skogsmaskin May 24, 2024 •

edited

Loading

skogsmaskin May 24, 2024 •

edited

Loading