Storybook: Add mechanism to redirect moved stories #59181
Conversation
mirka
added
[Type] Enhancement
| title: 'Components (Deprecated)/RadioGroup', | ||
| id: 'components-radiogroup', |
There was a problem hiding this comment.
The plan is to move all the "Components (Experimental)" components into the main "Components" grouping, while keeping the "Components (Deprecated)" grouping separate so outdated components don't clutter the list.
The id is for overriding the id that will be auto-generated from the title. Although it's a hassle to have to manually set this id, I don't expect us having to do it often, because:
- Not a lot of components are actually going to be deprecated.
- When we move all the "Components (Experimental)" components to "Components", they will automatically get the simple ids that we want, so we won't need to specify the
ids manually.
There was a problem hiding this comment.
With #58518 adding the idea of status-* tags, it would be nice if we didn't have to do this at all. Ideally, both the id and title could be auto-generated by some build step, and we should rarely if ever have to do anything except set the component.
id is easy enough to generate from the package and component, and title could equally be based on the package name, any relevant status tag, and the component name.
| from: /\/components-deprecated-/, | ||
| to: '/components-', |
There was a problem hiding this comment.
Next step will be to add a components-experimental- redirect rule to this list.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
| @@ -0,0 +1,35 @@ | |||
| <script> | |||
| ( function redirectIfStoryMoved() { | |||
| const REDIRECTS = [ | |||
There was a problem hiding this comment.
Nit: Seems like this could be declared a single time outside of the function (while still kept private from the global scope in a closure)?
There was a problem hiding this comment.
Like in an additional wrapper function? Not exactly sure what you had in mind here.
Though I do think we should extract this into a separate script file if things get more complicated, or if we want to put more JS in this template part file.
There was a problem hiding this comment.
Yeah, an additional wrapper function. Fine to leave it as-is, this is quite a nitpick at this level.
| 'path', | ||
| params | ||
| .get( 'path' ) | ||
| .replace( matchedRedirect.from, matchedRedirect.to ) |
There was a problem hiding this comment.
Do we need a check for .from and .to just in case they weren't defined?
There was a problem hiding this comment.
I think it's fine at this scale. Maybe add some type checking if the list gets longer, but at this moment I only expect two or three entries.
Part of #33111
What?
Adds a mechanism to "redirect" outdated Storybook URLs to the new canonical URL.
Why?
With the way we are currently structuring our stories, the sidebar grouping names such as "Components (Experimental)" and "Components (Deprecated)" become part of the story URL. This is bad for permalinks because the URL will change if the grouping of a component changes over time. Now with better labeling systems like sidebar icons and status badges in place, as well as the "Experimental" grouping not being meaningful anymore, we want to move to a structure where all wp-components components have a straightforward, stable ID for permalinks (
components-my-component).This PR lays the groundwork so we can move forward with the ID normalization.
How?
I considered some approaches suggested in the Storybook repo.
The Express middleware seemed clean, but it won't work for us because the Node server only runs when in dev mode, and is irrelevant for static deploys.
So I ended up with a modified version of the
manager-head.htmlapproach. Instead of listening for allnavigationevents (since the Navigation API is not ready for production use), we simply run a IIFE on the initial load of the SPA which immediately redirects if applicable. This should be good enough for us, since we can assume there are no outdated links within the SPA — it's only on the initial page load where a user could be arriving from an outdated link somewhere.Testing Instructions
Accessing the
RadioGroupdocs or stories from an outdated URL (e.g.?path=/docs/components-deprecated-radiogroup--docs) should redirect to their new canonical URL.