[Workspace] Make url stateful in hash with workspace id

[SuZhou-Joe]

Description

In order to let users switch to specific workspace when paste a deep link from other users, we need to make url stateful with workspace info. This PR mainly introduce the capability to keep the workspace Id in url consistent with the workspace id in memory so that user can feel free to copy the url and share to others.

Issues Resolved

#6015

Screenshot

Testing the changes

• Using the branch to bootstrap
• Enable workspace by adding workspace.enabled to opensearch_dashboards.yml file
• Start OSD
• Navigate to any page, append with hash #/?_w=foo
• Jump to any other pages by clicking nav on left navigation
• You will find _w params will always be there, making the url shareable.

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[SuZhou-Joe]

@kavilla Could you please take a look on this PR as you have enough context on both the issue and the related RFC?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.15%. Comparing base (70adcc9) to head (1392a65).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5984      +/-   ##
==========================================
+ Coverage   67.13%   67.15%   +0.01%     
==========================================
  Files        3318     3318              
  Lines       64021    64021              
  Branches    10256    10256              
==========================================
+ Hits        42981    42991      +10     
+ Misses      18548    18537      -11     
- Partials     2492     2493       +1     

Flag	Coverage Δ
Linux_1	31.63% <ø> (+<0.01%)	⬆️
Linux_2	55.20% <ø> (ø)
Linux_3	?
Linux_4	35.16% <ø> (+<0.01%)	⬆️
Windows_1	31.68% <ø> (+0.02%)	⬆️
Windows_2	55.17% <ø> (ø)
Windows_3	44.60% <ø> (+<0.01%)	⬆️
Windows_4	35.16% <ø> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ruanyl]

getWorkpsaceId could return empty string '', what's the consequence if it's empty string? I guess that should remove the workspace from the url?

[SuZhou-Joe]

Yes, in that case we will remove the _w params from url hash.

[ashwin-pc]

Hmm this has an issue. It does not hook into the default routing API's of the app. This has some risks, e.g. opening links in a new tab to name just the first that comes to mind. Take a look at Discover. Go to discover, expand a row, click on view surrounding documents. This will not work there since the workspace is not carried over. This is just one place. Another way this can break is if a full page navigation occurs. This should not happen if the app developer uses the navigateToUrl or naigateToApp api, but not sure if all plugins actually follow that. We almost didnt use them for the breadcrumbs and i had to push back saying what a bad idea that was. But breadcrumbs are implemented by the plugin so even there its not garaunteed. Have you looked at https://ashwin-pc.github.io/OpenSearch-Dashboards/docs/index.html#/plugins/data_persistence?

Cant you reuse the _g key? That way no app needs to make a change since global query persistence was always a thing for the app. Or else the workspace features should not break an app if the key is missing when they transition from one page to the next.

Also this should definitely have a test. That way we can ensure that under all circumstances the workspace key is passed :)

[SuZhou-Joe]

@ashwin-pc So grateful for the edge case.

• For the edge case in Discover, I add a localStorage to reserve the current workspace so that the new-tab-link will have workspace params patched without doing any code changes. Even if we reuse the _g params Discover app will only honor the filters params. And the approach should solve the concern for breadcrumbs and hard refresh when navigating inside OSD.
• For the test cases, sure I will add cypress test to cover the edge cases.

[ashwin-pc]

@SuZhou-Joe the edge cases I called is just one of them. What I'm asking is if you folks have explored the persistence service to see if that can be used as is or if can be extended instead of rolling out a custom solution. Let's try to build on what existing already since this is just the first edge case I came across in 5 mins. And the last time I tried to mess with routing, I was burnt badly 😅

If you explore it and decide this is still the best way that's fine too. Just want to make sure that we considered the options an made the right tradeoff.

[SuZhou-Joe]

@ashwin-pc , we had a discussion on all the options we can choose from. This is the RFC issue(#5243).

@kavilla has some concerns on making the workspaceId into path as it may affect the OSD a lot, so we did a trade-off to make it in hash.

I am still free to accept advice on how we store the workspace id into url and look forward to your advice as you have much more knowledge on OSD router.

[SuZhou-Joe]

Closed as we will use #6060.