Switch to new tenant after loading a copied long URL

[leanneeliatra]

Description

It's now possible to copy a URL (not short URL just the URL from the share button), paste it into a new window and change the tenant, continuing on from there in a new tenant.

Category

[Enhancement]

Why these changes are required?

Previously if a URL was copied and pasted and the user then tried to change the tenant, the tenant from the copied URL would be remembered and would not allow the user to change to any other tenant.

What is the old behavior before changes and new behavior after changes?

Old Behaviour

1. URL is copied via share (not short URL)
2. URL pasted into a new window
3. Change the tenant
4. The tenant automatically changes back to the tenant that was originally used when copying the URL

New Behaviour

1. URL is copied via share (not short URL)
2. URL pasted into a new window
3. Change the tenant
4. The user can now continue on, with a new tenant, they can switch to another tenant, they can continue as normal and will not be erroneously taken back to the original tenant from the copied URL.

Note

The solution removes all information in the URL after the security tenant parameter

http://localhost:5601/app/dashboards?security_tenant=admin_tenant#/view/722b74f0-b882-11e8-a6d9-e546fe2bba5f?_g=(filters:!(),refreshInterval:(pause:!f,value:900000),time:(from:now-7d,to:now))&_a=(description:'Analyze%20mock%20eCommerce%20orders%20and%20revenue',filters:!(),fullScreenMode:!f,options:(hidePanelTitles:!f,useMargins:!t),query:(language:kuery,query:''),timeRestore:!t,title:'%5BeCommerce%5D%20Revenue%20Dashboard',viewMode:view)

In doing this, we loose a bit of "state", since
the url '/app/security-dashboards-plugin#/roles' becomes '/app/security-dashboards-plugin'

An alternative would be to reload as follows: 
const currentUrl = new URL(window.location.href);
currentUrl.searchParams.delete('security_tenant');
window.location.href = currentUrl.toString();

The solution was implemented in the way it was to prevent a user getting a broken link if trying to access a dashboard they do not have permissions/tenancy to see.

Issues Resolved

BUG Unable to switch tenants when visiting copied links #1204

Testing

To follow, would like to get the initial fix in for a look while tests are developed.

Check List

• New functionality includes testing
• New functionality has been documented
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[DarshitChanpura]

Hey @leanneeliatra, would you please signoff the commits with your github id. Seems like they were signed off with other id:

Expected "leanneeliatra [leanne.laceybyrne@eliatra.com](mailto:leanne.laceybyrne@eliatra.com)", but got "Leanne Lacey-Byrne [leanne.laceybyrne@eliatra.com](mailto:leanne.laceybyrne@eliatra.com)".

[codecov]

Codecov Report

Merging #1450 (ba17d04) into main (497c7f1) will increase coverage by 0.14%.
The diff coverage is 90.90%.

@@            Coverage Diff             @@
##             main    #1450      +/-   ##
==========================================
+ Coverage   65.47%   65.62%   +0.14%     
==========================================
  Files          93       93              
  Lines        2297     2307      +10     
  Branches      308      309       +1     
==========================================
+ Hits         1504     1514      +10     
  Misses        725      725              
  Partials       68       68              

Impacted Files	Coverage Δ
public/apps/account/account-nav-button.tsx	71.73% <90.90%> (+7.85%)	⬆️

[stephen-crawford]

Looks great! Just noticed there may be an extra file.

[leanneeliatra]

Codecov Report

Merging #1450 (4dd3eee) into main (497c7f1) will decrease coverage by 0.16%.
The diff coverage is 12.50%.

❗ Current head 4dd3eee differs from pull request most recent head 1a84c1d. Consider uploading reports for the commit 1a84c1d to get more accurate results

@@            Coverage Diff             @@
##             main    #1450      +/-   ##
==========================================
- Coverage   65.47%   65.32%   -0.16%     
==========================================
  Files          93       93              
  Lines        2297     2304       +7     
  Branches      308      314       +6     
==========================================
+ Hits         1504     1505       +1     
- Misses        725      731       +6     
  Partials       68       68              

Impacted Files Coverage Δ
public/apps/account/account-nav-button.tsx 55.81% <12.50%> (-8.08%) ⬇️

@DarshitChanpura / @scrawfor99 I think the tests aren't running again (evne though in 'edited', it does say it ran an hour ago, when I view the files, it's not the current code. Is there a way to manually trigger the bot again or how should I handle this please? Thanks.

[DarshitChanpura]

Hey @leanneeliatra, there are changes in this PR that are still coming from 2.6. I have raised a PR to your fork with the fix. https://github.com/leanneeliatra/security-dashboards-plugin-fork/pull/1/files Feel free to merge it.

[cwperks]

Thank you @leanneeliatra! I have a question around why its necessary to remove lastUrl from session storage when loading from a url. Can you please provide some more info?

[leanneeliatra]

To Note:

• Most recent efforts on the PR were to rebase & include changes from main, ensure tests are passing and address PR comments.

[peternied]

Could a test be added modified that uses exactly the user that was mentioned in the PR description, http://localhost:5601/app/dashboards?security_tenant=admin_tenant#/view/722b74f0-b882-11e8-a6d9-e546fe2bba5f?_g=(filters:!(),refreshInterval:(pause:!f,value:900000),time:(from:now-7d,to:now))&_a=(description:'Analyze%20mock%20eCommerce%20orders%20and%20revenue',filters:!(),fullScreenMode:!f,options:(hidePanelTitles:!f,useMargins:!t),query:(language:kuery,query:''),timeRestore:!t,title:'%5BeCommerce%5D%20Revenue%20Dashboard',viewMode:view)?

[leanneeliatra]

The same is valid here @DarshitChanpura do you have any ideas why the cypress and integration tests are not passing, is this something I need to change my end? Thanks any guidance would be greatly appreciated.

[DarshitChanpura]

Merging this. @leanneeliatra What do you think about adding a test in functional test repo?

[leanneeliatra]

Merging this. @leanneeliatra What do you think about adding a test in functional test repo?

Okay great @DarshitChanpura thanks, I'll do that.

[opensearch-trigger-bot]

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.x 1.x
# Navigate to the new working tree
cd .worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-1450-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 7f4e0f29f11668b09c5343da2cbc97ac1d6d0acf
# Push it to GitHub
git push --set-upstream origin backport/backport-1450-to-1.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-1450-to-1.x.

[opensearch-trigger-bot]

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.3 1.3
# Navigate to the new working tree
cd .worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-1450-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 7f4e0f29f11668b09c5343da2cbc97ac1d6d0acf
# Push it to GitHub
git push --set-upstream origin backport/backport-1450-to-1.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-1450-to-1.3.