Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(rtl-audit): the full audit adopts orphan stories as a filtered run does (#9391)

Cindy Zhang0b0cc52b11ff
diff --git a/.github/scripts/rtl-audit-coverage.test.mjs b/.github/scripts/rtl-audit-coverage.test.mjs
index 30abd5342c..b0b4f2f788 100644
--- a/.github/scripts/rtl-audit-coverage.test.mjs
+++ b/.github/scripts/rtl-audit-coverage.test.mjs
@@ -1405,8 +1405,37 @@ describe('resolveFilterRoutes (filters resolve through the Storybook index)', ()
expect(resolve(['core/nosuchthing']).routes).toEqual([]);
});
- it('is the whole route list when no filter is given', () => {
- expect(resolve([]).routes).toBe(routes);
+ it('keeps every route in a full run and adopts the same orphan stories there', () => {
+ const full = resolve([]);
+ // Every existing route stays, including the orphan route itself.
+ for (const route of routes) expect(full.routes).toContainEqual(route);
+ expect(full.adopted).toEqual({
+ 'core/ResizeHandle': [
+ 'core-resizable--horizontal-split',
+ 'core-resizable--snap-points',
+ ],
+ });
+ });
+
+ it('agrees with a filtered run on ResizeHandle and ChatLayoutScrollButton', () => {
+ const owned = (result, component) =>
+ result.routes
+ .filter(route => route.component === component)
+ .map(route => route.id)
+ .sort();
+ const full = resolve([]);
+ expect(owned(full, 'core/ResizeHandle')).toEqual(
+ owned(resolve(['core/resizehandle']), 'core/ResizeHandle'),
+ );
+ // Core/Chat never renders the scroll button: no adoption in either run,
+ // so its verified-N/A record still stands.
+ expect(owned(full, 'core/ChatLayoutScrollButton')).toEqual([]);
+ expect(
+ owned(
+ resolve(['core/chatlayoutscrollbutton']),
+ 'core/ChatLayoutScrollButton',
+ ),
+ ).toEqual([]);
});
});
diff --git a/apps/storybook/rtl-audit/rtl-audit-coverage.mjs b/apps/storybook/rtl-audit/rtl-audit-coverage.mjs
index 0012a00df9..49daa9044e 100644
--- a/apps/storybook/rtl-audit/rtl-audit-coverage.mjs
+++ b/apps/storybook/rtl-audit/rtl-audit-coverage.mjs
@@ -218,6 +218,10 @@ export function componentRoutesForFilters(routes, filters) {
* own component, so it keeps its own coverage entry and verified-N/A record.
* A filter with neither selects nothing and stays a coverage gap
* (`architecture:rtl-audit-evidence` INV5).
+ *
+ * A run with no filters (the release check's full audit) keeps every route
+ * and applies the same adoption to every known component no route names, so
+ * a full run and a filtered run audit ResizeHandle through the same stories.
* @param {{
* routes: {id: string, component: string}[],
* filters: string[],
@@ -235,20 +239,14 @@ export function resolveFilterRoutes({
ownerOf,
renders,
}) {
- if (filters.length === 0) return {routes, adopted: {}};
const known = new Set(knownComponents.map(name => name.toLowerCase()));
const selected = new Map();
const adopted = {};
- for (const filter of filters) {
- const direct = routes.filter(route =>
- routeMatchesComponentFilter(route, filter),
- );
- for (const route of direct) {
- selected.set(`${route.component}::${route.id}`, route);
- }
- if (direct.length > 0) continue;
+ const keep = route => selected.set(`${route.component}::${route.id}`, route);
+ /** Route a filter's folder's orphan stories that render it to its component. */
+ const adopt = filter => {
const owner = ownerOf(filter);
- if (owner == null) continue;
+ if (owner == null) return;
const orphans = routes.filter(
route =>
!known.has(route.component.toLowerCase()) &&
@@ -257,14 +255,25 @@ export function resolveFilterRoutes({
.startsWith(`${owner.folder}/`) &&
renders(route.id, owner.component),
);
- if (orphans.length === 0) continue;
+ if (orphans.length === 0) return;
adopted[owner.component] = orphans.map(route => route.id).sort();
- for (const {id} of orphans) {
- selected.set(`${owner.component}::${id}`, {
- id,
- component: owner.component,
- });
+ for (const {id} of orphans) keep({id, component: owner.component});
+ };
+ if (filters.length === 0) {
+ routes.forEach(keep);
+ const named = new Set(routes.map(route => route.component.toLowerCase()));
+ for (const component of knownComponents) {
+ const filter = component.toLowerCase();
+ if (!named.has(filter)) adopt(filter);
}
+ return {routes: [...selected.values()], adopted};
+ }
+ for (const filter of filters) {
+ const direct = routes.filter(route =>
+ routeMatchesComponentFilter(route, filter),
+ );
+ direct.forEach(keep);
+ if (direct.length === 0) adopt(filter);
}
return {routes: [...selected.values()], adopted};
}
diff --git a/apps/storybook/rtl-audit/rtl-audit.mjs b/apps/storybook/rtl-audit/rtl-audit.mjs
index 64d118e6b9..b8913f5965 100644
--- a/apps/storybook/rtl-audit/rtl-audit.mjs
+++ b/apps/storybook/rtl-audit/rtl-audit.mjs
@@ -1286,6 +1286,8 @@ function readVerifiedNa() {
* its package's barrel (`core/resizehandle` → core/ResizeHandle in
* packages/core/src/Resizable), or null.
*/
+const barrelExportsByPackage = new Map();
+
function sourceOwnerOf(filter, publicComponentsByPackage) {
const [packageName, requested] = filter.includes('/')
? filter.split('/')
@@ -1298,10 +1300,14 @@ function sourceOwnerOf(filter, publicComponentsByPackage) {
);
if (!component) continue;
const sourceRoot = path.join(PROJECT_ROOT, pkg.src);
- const implementation = componentExportsFromBarrel(
- path.join(sourceRoot, 'index.ts'),
- sourceRoot,
- ).get(component);
+ // A full run asks for every storyless component, so read each barrel once.
+ if (!barrelExportsByPackage.has(name)) {
+ barrelExportsByPackage.set(
+ name,
+ componentExportsFromBarrel(path.join(sourceRoot, 'index.ts'), sourceRoot),
+ );
+ }
+ const implementation = barrelExportsByPackage.get(name).get(component);
if (!implementation) continue;
const folder = path
.relative(PROJECT_ROOT, path.dirname(implementation))
@@ -1394,7 +1400,8 @@ async function cleanupRuntime() {
}).filter(belongsToActivePackage);
// Filters resolve through the index: a sub-component whose stories carry
// its parent folder's non-component title (ResizeHandle under
- // Core/Resizable) audits them under its own name.
+ // Core/Resizable) audits them under its own name, in a filtered run and in
+ // the full run alike.
const resolvedFilters = resolveFilterRoutes({
routes: storyRoutes,
filters: FILTER,