Persist the query params for migration flow to user navigation issue.

[StevenDufresne]

Fixes #98572

Relies on #99444.

Proposed Changes

• Persist the current Query params in the migration flow to make sure users return from whence they came!

Why are these changes being made?

As described in #98572, the context is currently lost and our user is exited in the wrong place.

This is because we don't pass along the ref properly as we navigate from view to view.

I've decided to wrap the URLs with persistQueryParams which adds the current params to the new URL. When used with addQueryArgs, the parameters on the URL will be overwritten by addQueryArgs and therefore it's safe to do so.

It does mean though that parameters we don't want to pass long will be passed which is why I haven't updated all references. I'm not certain that's expected.

Warning

Without an explicit state definition, I'm not certain I've updated all the relevant paths. It's a bit hard to read with the conditions.

Why not just pass the ref to addQueryArgs?

To be honest, I was originally going to do this. I'm fine with this approach as well. I decided against it because I think it's ultimately safer to pass all the parameters based on how we are composing flows together. I can also see the other side as well that we should be explicitly setting this.

I can be swayed either way.

Why not wrap navigate or addQueryArgs?

• Since we use exitFlow and navigate to direct users, we need to intercept earlier.
• addQueryArgs is an external dependency and heavily used, wrapping that would be confusing.

Is persistQueryParams the best function name?

I don't know. :) Alternatives could be:

• appendQueryParams
• addQueryParamsToUrl
• applyCurrentParams

Testing Instructions

• Go to http://calypso.localhost:3000/import/{site}?ref=site-migration
• Click on WordPress
• Choose Migrate Site
• Click the in app back button twice.
• Notice you are back where you started.

Pre-merge Checklist

Note

I'll also add unit tests to site-migration-flows.tsx if this approach makes sense.

• Has the general commit checklist been followed? (PCYsg-hS-p2)
• Have you written new tests for your changes?
• Have you tested the feature in Simple (P9HQHe-k8-p2), Atomic (P9HQHe-jW-p2), and self-hosted Jetpack sites (PCYsg-g6b-p2)?
• Have you checked for TypeScript, React or other console errors?
• Have you used memoizing on expensive computations? More info in Memoizing with create-selector and Using memoizing selectors and Our Approach to Data
• Have we added the "[Status] String Freeze" label as soon as any new strings were ready for translation (p4TIVU-5Jq-p2)?
  • For UI changes, have we tested the change in various languages (for example, ES, PT, FR, or DE)? The length of text and words vary significantly between languages.
• For changes affecting Jetpack: Have we added the "[Status] Needs Privacy Updates" label if this pull request changes what data or activity we track or use (p4TIVU-aUh-p2)?

[github-actions]

Calypso Live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-132382

Jetpack Cloud live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-132382&env=jetpack

Automattic for Agencies live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-132382&env=a8c-for-agencies

[matticbot]

This PR modifies the release build for the following Calypso Apps:

For info about this notification, see here: PCYsg-OT6-p2

• blaze-dashboard
• command-palette-wp-admin
• help-center
• notifications
• odyssey-stats
• whats-new
• wpcom-block-editor

To test WordPress.com changes, run install-plugin.sh $pluginSlug try/keep-the-ref on your sandbox.

[matticbot]

Here is how your PR affects size of JS and CSS bundles shipped to the user's browser:

Sections (~70 bytes added 📈 [gzipped])

name                        parsed_size           gzip_size
site-migration-flow              +147 B  (+0.3%)      +70 B  (+0.5%)
hosted-site-migration-flow       +147 B  (+0.3%)      +70 B  (+0.5%)

Sections contain code specific for a given set of routes. Is downloaded and parsed only when a particular route is navigated to.

Legend

What is parsed and gzip size?

Parsed Size: Uncompressed size of the JS and CSS files. This much code needs to be parsed and stored in memory.
Gzip Size: Compressed size of the JS and CSS files. This much data needs to be downloaded over network.

Generated by performance advisor bot at iscalypsofastyet.com.