feat(migration): support async hooks in migration nodes

[binoy14]

Description

Adds support for async hooks in migration nodes for instance you can do the following thing

export default defineMigration({
  name: 'Cleanup empty values',
  documentType: 'playlist',
  migrate: {
    async object(node) {
      if (Object.keys(node).filter((k) => !k.startsWith('_')).length) {
        await setTimeout(() => console.log('waiting object'), 1000)
        return unset()
      }
    },
    async array(node) {
      if (node.length === 0) {
        await setTimeout(() => console.log('waiting array'), 1000)
        return unset()
      }
    },
    async string(node) {
      if (node.length === 0) {
        await setTimeout(() => console.log('waiting string'), 1000)
        return unset()
      }
    },
  },
})

What to review

If everything still works

Testing

• Add unit tests for the functions in normalizeMigrateDefinition
• Investigate how easy/hard is to write integration tests for migration CLI

Notes for release

N/A

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
performance-studio	✅ Ready (Inspect)	Visit Preview		Jan 29, 2024 3:17pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 3:17pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 29, 2024 3:17pm

[binoy14]

Current dependencies on/for this PR:

• next
  • PR feat: migration runner #5540
    • PR feat(cli): improve reporting when dry running from export #5609
    • PR feat(cli): add pretty mutation formatting to migration runner #5573
    • PR feat(migrate): add bufferThroughFile utility #5572
    • PR chore(migration): add better error message when request fails #5567
    • PR feat(migration): support passing an array of documentTypes to migration #5566
    • PR feat(migration): support async hooks in migration nodes #5564 👈
      • PR test(migration) add tests for normalizeMigrationDefinition #5565
    • PR feat(migrate): use safe JSON parser when streaming from Export HTTP API #5542
    • PR feat(migrate): implement mutation batcher #5541
      • PR feat(migrate): limit mutate request concurrency #5544
        • PR feat(migration): improve progress as migration is running #5550
          • PR feat(migration): add a prompt before runing a real migration #5552

This stack of pull requests is managed by Graphite.

[github-actions]

Package	Documentation Change
sanity	-3%

Full Report

@sanity/migrate

This branch	Next branch
14 documented	0 documented
63 not documented	0 not documented

@sanity/diff

This branch	Next branch
13 documented	13 documented
16 not documented	16 not documented

@sanity/block-tools

This branch	Next branch
4 documented	4 documented
9 not documented	9 not documented

@sanity/types

This branch	Next branch
55 documented	55 documented
239 not documented	239 not documented

sanity/desk

This branch	Next branch
84 documented	84 documented
64 not documented	64 not documented

@sanity/portable-text-editor

This branch	Next branch
21 documented	21 documented
44 not documented	44 not documented

@sanity/mutator

This branch	Next branch
7 documented	7 documented
4 not documented	4 not documented

@sanity/cli

This branch	Next branch
1 documented	1 documented
31 not documented	31 not documented

@sanity/util/legacyDateFormat

This branch	Next branch
0 documented	0 documented
5 not documented	5 not documented

@sanity/schema/_internal

This branch	Next branch
0 documented	0 documented
12 not documented	12 not documented

@sanity/util/paths

This branch	Next branch
1 documented	1 documented
15 not documented	15 not documented

sanity/router

This branch	Next branch
17 documented	17 documented
26 not documented	26 not documented

@sanity/schema

This branch	Next branch
0 documented	0 documented
2 not documented	2 not documented

sanity/structure

This branch	Next branch
2 documented	2 documented
6 not documented	6 not documented

sanity/cli

This branch	Next branch
2 documented	2 documented
0 not documented	0 not documented

@sanity/vision

This branch	Next branch
0 documented	0 documented
3 not documented	3 not documented

@sanity/util/fs

This branch	Next branch
0 documented	0 documented
3 not documented	3 not documented

sanity/_internal

This branch	Next branch
0 documented	0 documented
1 not documented	1 not documented

@sanity/util/createSafeJsonParser

This branch	Next branch
1 documented	0 documented
0 not documented	0 not documented

sanity/_internalBrowser

This branch	Next branch
0 documented	0 documented
3 not documented	3 not documented

@sanity/util/content

This branch	Next branch
1 documented	1 documented
5 not documented	5 not documented

sanity

This branch	Next branch
177 documented	183 documented
843 not documented	846 not documented

[github-actions]

Component Testing Report Updated Jan 29, 2024 3:18 PM (UTC)

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	34s	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)	12s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	33s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	18s	9	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 0s	18	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	14s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	7s	3	0	0