feat(router): update router to support query params in intent links

[pedrobonamin]

Description

As part of releases we are introducing a query param that needs to be persisted in the url, perspective

It will determine which perspective the user has selected and we need to use the IntentLink component to change the perspective the user has selected when navigating to a version document.

How it will be used:

          <IntentLink
            {...linkProps}
            intent="edit"
            params={{
              id: getPublishedId(documentId, true),
              type: documentTypeName,
            }}
            searchParams={[['perspective', `bundle.${release.name}`]]}
            ref={ref}
          />

Path example: /test/intent/edit/id=c0c99e43-40de-4d8b-abec-a710d5752ea2;type=book/?perspective=bundle.pedro-summer

see https://github.com/sanity-io/sanity/pull/7092/files#diff-729068b8f99a9501225501d3379505aa1a85162b6e41aa9654b7c5aa8a83d067R122-R139 for further details.

What to review

Is this change correct? Is there other way to handle this?

Testing

Added tests for IntentLink and for resolveIntentState function

Notes for release

Adds support in intent links for _searchParams: SearchParam[].

[vercel]

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	Jul 9, 2024 8:18am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 9, 2024 8:18am
test-compiled-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 9, 2024 8:18am
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 9, 2024 8:18am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 9, 2024 8:18am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jul 9, 2024 8:18am

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Jul 9, 2024 8:26 AM (UTC)

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	43s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	8s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	27s	6	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	35s	11	7	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	16s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	10s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	23s	5	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	42s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 23s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 12s	18	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	8s	3	9	0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	24s	9	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	17s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	❌ Failed (Inspect)	1m 16s	20	0	1
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	1m 42s	30	0	0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	19s	3	0	0

[binoy14]

Couple questions

1. Is there a reason there would not be a need for release notes for this change?
2. Is it possible to add tests for this change? Not sure if there are existing tests for Router that you can piggy back on.

Looks good otherwise besides the comments

[binoy14]

Wondering, what's the reason to use _searchParams instead of searchParams

[pedrobonamin]

This is because the router expects the search params to be in a _searchParams property.
I've added an update to the RouterEvent interface to reflect that the state returned from this function should be a RouterState.

export interface RouterStateEvent {
  type: 'state'
+ state: RouterState
- state: Record<string, unknown> 
  isNotFound: boolean
}

RouterState is the following:
export type RouterState = Record<string, unknown> & {_searchParams?: SearchParam[]}

[pedrobonamin]

646f433

[binoy14]

understood, thanks for confirming

[pedrobonamin]

Couple questions

1. Is there a reason there would not be a need for release notes for this change?
2. Is it possible to add tests for this change? Not sure if there are existing tests for Router that you can piggy back on.

Looks good otherwise besides the comments

Thanks for the review @binoy14 .

Added test for the change in the IntentLink component, that now supports query params and added test for the resolveIntentState function that it now supports query params