FIX Remove current active tab from session storage after use

satrun77 commented 4 months ago

Description

The PR fixes the code that attempts to remember the tab state in the page edit screen. Currently, the tab state is stored in browser session storage but never removed, so the next time a CMS author edits the same page, it loads another tab instead of the main tab.

The fix is to remove the tab state after navigating away from the page. Note that the state is not removed if the URL from the address bar is changed manually.

https://github.com/silverstripe/silverstripe-admin/assets/166450/44141843-cc67-498d-b254-e982f9cf5a18

Manual testing steps

Go to a CMS page with tabs.
Access a tab different from Main.
Save the page.
You stay on the same tab.
Navigate to a different page in the CMS.
Come back to your original page.

Issues

1684

Pull request checklist

[x] The target branch is correct
- See picking the right version
[x] All commits are relevant to the purpose of the PR (e.g. no debug statements, unrelated refactoring, or arbitrary linting)
- Small amounts of additional linting are usually okay, but if it makes it hard to concentrate on the relevant changes, ask for the unrelated changes to be reverted, and submitted as a separate PR.
[x] The commit messages follow our commit message guidelines
[x] The PR follows our contribution guidelines
[x] Code changes follow our coding conventions
[x] This change is covered with tests (or tests aren't necessary for this change)
[x] Any relevant User Help/Developer documentation is updated; for impactful changes, information is added to the changelog for the intended release
[x] CI is green

Parent issue

https://github.com/silverstripe/silverstripe-cms/issues/2924

michalkleiner commented 4 months ago

The change looks ok to me, haven't tested it.

For the situation when the URL is changed manually, could we add a TTL to the saved value and if it's expired, reset the saved tab to the default? Could be quite short lived I'd say.

Alternatively, could it be safe to assume there should only be one tab stored for the current session, so any other URL can remove the saved state for other pages? Do we need to index the storage by the URL at all?