Skip to content

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

TypeScript

fix(ci): resolve a11y scope from canonical component owners (#6562)

Cindy Zhangebdea30e9069
diff --git a/.github/scripts/a11y-pr-scope.mjs b/.github/scripts/a11y-pr-scope.mjs
index a916aa6e1b..013791bc5a 100644
--- a/.github/scripts/a11y-pr-scope.mjs
+++ b/.github/scripts/a11y-pr-scope.mjs
@@ -2,8 +2,8 @@
/**
* @file Resolve explicit changed-component scope for fast PR accessibility.
- * @input Exact PR analysis and the canonical component package registry
- * @output Qualified component filters; an empty set never means a full audit
+ * @input Exact PR analysis and canonical public-component ownership
+ * @output Qualified filters matched like the audit consumer; empty never means full
* @position PR-only projection; exhaustive accessibility belongs to release-check
*/
@@ -11,7 +11,10 @@ import fs from 'node:fs';
import path from 'node:path';
import {pathToFileURL} from 'node:url';
import componentPackages from '../../scripts/component-packages.cjs';
-import {buildStoryComponentRoutes} from '../../apps/storybook/rtl-audit/rtl-audit-coverage.mjs';
+import {
+ buildStoryComponentRoutes,
+ componentRoutesForFilters,
+} from '../../apps/storybook/rtl-audit/rtl-audit-coverage.mjs';
import storyIdentity from './lib/a11y-story-identity.js';
const {
@@ -101,6 +104,7 @@ export function resolvePrA11yComponents(
}
// Analysis deliberately leaves multi-component folders (such as Chat)
// unresolved. Expand only that changed folder, not the whole package roster.
+ const publicComponentsByPackage = new Map();
for (const source of analysis.unresolvedComponentSources) {
const [packageName, directory, extra] = source.split('/');
const pkg = componentPackage(packageName);
@@ -116,11 +120,22 @@ export function resolvePrA11yComponents(
const changedDirectory = path.join(sourceRoot, directory);
const names = documentedComponentNames(changedDirectory);
if (names.length === 0) continue;
+ let publicComponents = publicComponentsByPackage.get(packageName);
+ if (publicComponents == null) {
+ publicComponents = new Set(
+ pkg.layout === 'flat'
+ ? flatPackageComponentNames(repoRoot, pkg)
+ : nestedPackageComponentNames(repoRoot, pkg),
+ );
+ publicComponentsByPackage.set(packageName, publicComponents);
+ }
const exports = componentExportsFromBarrel(
path.join(sourceRoot, 'index.ts'),
sourceRoot,
);
for (const name of names) {
+ // Utility docs in shared source directories do not create component owners.
+ if (!publicComponents.has(name)) continue;
const implementation = exports.get(name);
// A doc can mention a dependency such as Avatar; it does not make that
// component part of the changed folder's scope.
@@ -128,9 +143,9 @@ export function resolvePrA11yComponents(
routes ??= readPrA11yRoutes(repoRoot);
const owner = `${packageName}/${name}`;
const umbrella = `${packageName}/${directory}`;
- if (routes.some(route => route.component === owner)) {
+ if (componentRoutesForFilters(routes, [owner]).length > 0) {
owners.add(owner);
- } else if (routes.some(route => route.component === umbrella)) {
+ } else if (componentRoutesForFilters(routes, [umbrella]).length > 0) {
// Some grouped exports are exercised only by their family's stories.
owners.add(umbrella);
} else {
diff --git a/.github/scripts/a11y-pr-scope.test.mjs b/.github/scripts/a11y-pr-scope.test.mjs
index 544ef24d84..a7eaaefe4e 100644
--- a/.github/scripts/a11y-pr-scope.test.mjs
+++ b/.github/scripts/a11y-pr-scope.test.mjs
@@ -3,7 +3,7 @@
/**
* @file Fast PR accessibility scope contracts.
* @input Exact/invalid analysis fixtures and public component ownership
- * @output No full-suite fallback, qualified owners, and grouped-owner coverage
+ * @output No full-suite fallback, qualified owners, and normalized umbrella coverage
* @position Regression tests for the PR-only accessibility scope projection
*/
@@ -112,6 +112,50 @@ describe('fast PR accessibility scope', () => {
).toThrow('No scoped Storybook route');
});
+ it('routes NavHeadingMenu through its normalized NavMenu umbrella', () => {
+ const routes = buildStoryComponentRoutes({
+ stories: [
+ {id: 'core-navmenu--default', title: 'Core/NavMenu'},
+ {id: 'core-button--default', title: 'Core/Button'},
+ ],
+ publicComponentsByPackage: {core: ['NavHeadingMenu', 'Button']},
+ });
+ expect(routes[0]).toEqual({
+ id: 'core-navmenu--default',
+ component: 'core/navmenu',
+ });
+ const source = analysis({unresolvedComponentSources: ['core/NavMenu']});
+ const result = resolvePrA11yComponents(source, process.cwd(), routes);
+ expect(result).toEqual(['core/NavMenu']);
+ expect(unresolvedComponentFilters(routes, result)).toEqual([]);
+ expect(storyIdsForComponentFilters(routes, result)).toEqual([
+ 'core-navmenu--default',
+ ]);
+ expect(() =>
+ resolvePrA11yComponents(source, process.cwd(), routes.slice(1)),
+ ).toThrow('No scoped Storybook route for core/NavHeadingMenu or core/NavMenu');
+ });
+
+ it.each([
+ {modifiedComponentOwners: []},
+ {modifiedComponentOwners: ['core/Button']},
+ ])(
+ 'keeps shared theme utilities outside component scope while retaining $modifiedComponentOwners',
+ ({modifiedComponentOwners}) => {
+ expect(
+ resolvePrA11yComponents(
+ analysis({
+ modifiedComponentOwners,
+ unresolvedComponentSources: ['core/theme'],
+ forceFullComponentAudits: true,
+ }),
+ process.cwd(),
+ [{id: 'core-button--default', component: 'core/Button'}],
+ ),
+ ).toEqual(modifiedComponentOwners);
+ },
+ );
+
it('does not turn a shared source into a full audit', () => {
expect(
resolvePrA11yComponents(