[Guided onboarding] Dynamic URLs for steps

[yuliacech]

Summary

Fixes #143322

This PR adds an option to store dynamic parameters when a step is completed to be used later for dynamically built URLs.

How to test

1. Add xpack.cloud.id: 'testID' to your /config/kibana.dev.yml file
2. Start ES with yarn es snapshot
3. Start Kibana with yarn start --run-examples
4. Navigate to the guided onboarding example plugin http://localhost:5601/app/guidedOnboardingExample
5. Start the test guide and when completing step 1 provide any value for the paramter indexName
6. Continue the guide until step 4 and check that the correct value is being used for the url of this step.

Checklist

• Unit or functional tests were updated or added to match the most common scenarios

[yuliacech]

@elasticmachine merge upstream

[elasticmachine]

Pinging @elastic/platform-onboarding (Team:Journey/Onboarding)

[alisonelizabeth]

Thanks for working on this @yuliacech! Changes LGTM. Verified locally. Left a couple minor comments in the code. Let me know if you end up making changes and want me to review again.

Also, noticed a small UI bug while testing (unrelated to your PR). Opened #155421 to follow up.

[alisonelizabeth]

Should we rename this to something more specific? Or do we expect the potential to use this in other ways than just the URL in the future?

[yuliacech]

yes, I thought that we might have other dynamic parameters like integrations or something in the copy. But I can also rename it to something more specific, for example urlParams or even just guideConfigParams or guideParams, wdyt? (naming is hard 😅 )

[alisonelizabeth]

I'm OK to leave as-is for now. We can always revisit.

[alisonelizabeth]

[nit] Probably outside the scope of this PR, but this might be easier to reason with if we passed in an single object with the arguments.

[yuliacech]

The reasoning here was to not introduce any breaking changes for the existing guides that are not going to use dynamic params.

[alisonelizabeth]

👍 makes sense

[yuliacech]

Thanks a lot for your review, @alisonelizabeth!
I did end up doing a small change: removing the new params property from the location object, because we should just be able to match any dynamic params inside curly braces in the path string itself. Otherwise, consumers could forget to update the property params when they add a dynamic param to the path. The commit is here, could you please have another look?

[alisonelizabeth]

I did end up doing a small change: removing the new params property from the location object, because we should just be able to match any dynamic params inside curly braces in the path string itself. Otherwise, consumers could forget to update the property params when they add a dynamic param to the path. The commit is here, could you please have another look?

Thanks @yuliacech! That makes sense to me. I reviewed the commit and changes LGTM. I did not retest.

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 42e4231

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
guidedOnboarding	28	29	+1

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
@kbn/guided-onboarding	50	52	+2
guidedOnboarding	55	56	+1
total			+3

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
guidedOnboarding	26.9KB	27.2KB	+267.0B

Unknown metric groups

API count

id	before	after	diff
@kbn/guided-onboarding	52	54	+2
guidedOnboarding	56	57	+1
total			+3

ESLint disabled line counts

id	before	after	diff
enterpriseSearch	16	18	+2
securitySolution	394	397	+3
total			+5

Total ESLint disabled count

id	before	after	diff
enterpriseSearch	17	19	+2
securitySolution	474	477	+3
total			+5

History

• 💚 Build #120769 succeeded 8bc89c4
• 💚 Build #120686 succeeded e2b5805
• 💔 Build #120315 failed e164481
• 💔 Build #119866 failed 2aa72c0
• 💚 Build #119688 succeeded 2d007a5
• 💚 Build #118385 succeeded 136730c

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream