@mui/internal-code-infra 0.0.4-canary.1 → 0.0.4-canary.100

package/src/brokenLinksChecker/crawlWorker.mjs

@@ -0,0 +1,240 @@
+import { workerData, parentPort } from 'node:worker_threads';
+import { parse } from 'node-html-parser';
+import { parse as parseContentType } from 'content-type';
+import { HtmlValidate, StaticConfigLoader, staticResolver } from 'html-validate';
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkGfm from 'remark-gfm';
+import remarkRehype from 'remark-rehype';
+import rehypeSlug from 'rehype-slug';
+import rehypeStringify from 'rehype-stringify';
+
+/** @type {import('./index.mjs').CrawlWorkerInput} */
+const { pageUrl, options } = workerData;
+
+/**
+ * Tests if a value matches any of the patterns in the array.
+ * Returns true if patterns is undefined/empty (wildcard behavior).
+ * Strings use exact match, RegExp uses .test().
+ * @param {string} value
+ * @param {(string | RegExp)[] | undefined} patterns
+ * @returns {boolean}
+ */
+function matchesAnyPattern(value, patterns) {
+  if (!patterns || patterns.length === 0) {
+    return true;
+  }
+  return patterns.some((pattern) =>
+    typeof pattern === 'string' ? value === pattern : pattern.test(value),
+  );
+}
+
+/**
+ * Posts the crawl result back to the parent thread.
+ * @param {import('./index.mjs').CrawlWorkerOutput} output
+ */
+function postResult(output) {
+  if (!parentPort) {
+    throw new Error('crawlWorker must be run as a worker thread');
+  }
+  parentPort.postMessage(output);
+}
+
+/**
+ * Computes the accessible name of an element according to ARIA rules.
+ * @param {import('node-html-parser').HTMLElement | null} elm
+ * @param {import('node-html-parser').HTMLElement} ownerDocument
+ * @returns {string}
+ */
+function getAccessibleName(elm, ownerDocument) {
+  if (!elm) {
+    return '';
+  }
+
+  const ariaLabel = elm.getAttribute('aria-label')?.trim();
+  if (ariaLabel) {
+    return ariaLabel;
+  }
+
+  const labelledby = elm.getAttribute('aria-labelledby');
+  if (labelledby) {
+    const labels = [];
+    for (const id of labelledby.split(/\s+/)) {
+      const label = getAccessibleName(ownerDocument.getElementById(id), ownerDocument);
+      if (label) {
+        labels.push(label);
+      }
+    }
+    const label = labels.join(' ').trim();
+    if (label) {
+      return label;
+    }
+  }
+
+  if (elm.id) {
+    const label = ownerDocument.querySelector(`label[for="${elm.id}"]`);
+    if (label) {
+      return getAccessibleName(label, ownerDocument);
+    }
+  }
+
+  if (elm.tagName === 'IMG') {
+    const alt = elm.getAttribute('alt')?.trim();
+    if (alt) {
+      return alt;
+    }
+  }
+
+  return elm.innerText.trim();
+}
+
+/**
+ * Converts markdown content to HTML using unified pipeline.
+ * @param {string} markdown
+ * @returns {Promise<string>}
+ */
+async function markdownToHtml(markdown) {
+  const result = await unified()
+    .use(remarkParse)
+    .use(remarkGfm)
+    .use(remarkRehype)
+    .use(rehypeSlug)
+    .use(rehypeStringify)
+    .process(markdown);
+  return String(result);
+}
+
+const res = await fetch(new URL(pageUrl, options.host));
+
+const contentTypeHeader = res.headers.get('content-type');
+let type = 'text/html';
+
+if (contentTypeHeader) {
+  try {
+    const parsed = parseContentType(contentTypeHeader);
+    type = parsed.type;
+  } catch {
+    // invalid content-type, default to text/html
+  }
+}
+
+/** @type {import('./index.mjs').CrawlWorkerPageData} */
+const pageData = {
+  url: pageUrl,
+  status: res.status,
+  targets: [],
+  contentType: type,
+};
+
+if (pageData.status < 200 || pageData.status >= 400) {
+  postResult({ pageData, links: [], htmlValidateResults: null });
+} else if (type.startsWith('image/') || (type !== 'text/html' && type !== 'text/markdown')) {
+  postResult({ pageData, links: [], htmlValidateResults: null });
+} else {
+  const rawContent = await res.text();
+
+  const content = type === 'text/markdown' ? await markdownToHtml(rawContent) : rawContent;
+
+  const dom = parse(content, { parseNoneClosedTags: true });
+
+  // Extract targets
+  for (const target of dom.querySelectorAll('*[id]')) {
+    if (!options.ignoredTargets.has(target.id)) {
+      pageData.targets.push(`#${target.id}`);
+    }
+  }
+
+  // Extract links
+  let ignoredSelector = ':not(*)';
+  if (options.ignoredContent.length > 0) {
+    ignoredSelector = Array.from(options.ignoredContent)
+      .flatMap((selector) => [selector, `${selector} *`])
+      .join(',');
+  }
+  const linksSelector = `a[href]:not(${ignoredSelector})`;
+
+  const links = dom.querySelectorAll(linksSelector).map((a) => ({
+    src: pageUrl,
+    text: getAccessibleName(a, dom),
+    href: a.getAttribute('href') ?? '',
+    contentType: type,
+  }));
+
+  // HTML validation. Every entry whose path matches contributes to the
+  // page's config: each is registered as a synthetic preset and the page's
+  // root config `extends` `mui:recommended` first, then the matched presets
+  // in order. When override configs do not specify their own `extends`,
+  // they behave as pure rule patches layered on top of `mui:recommended`,
+  // so a later entry can only change the rules it names directly. Override
+  // configs are passed through as-is, though, so an entry that declares its
+  // own `extends` can still pull in additional presets (including
+  // `mui:recommended`) and affect earlier downgrades. html-validate merges
+  // `extends` left to right.
+  /** @type {{ pageUrl: string, results: import('html-validate').Result[] } | null} */
+  let htmlValidateResults = null;
+  if (type === 'text/html' && options.htmlValidate.length > 0) {
+    const matchedEntries = options.htmlValidate.filter((entry) =>
+      matchesAnyPattern(pageUrl, entry.path),
+    );
+
+    if (matchedEntries.length > 0) {
+      const overridePresets = Object.fromEntries(
+        matchedEntries.map((entry, index) => [`mui:override-${index}`, entry.config]),
+      );
+
+      const muiHtmlValidateResolver = staticResolver({
+        configs: {
+          'mui:recommended': {
+            extends: ['html-validate:standard', 'html-validate:document', 'html-validate:browser'],
+            rules: {
+              // TODO: Enable when subresource integrity is adopted across projects
+              'require-sri': 'off',
+              // Components that portal their content (menus, selects, listboxes,
+              // etc.) wire up aria-controls/aria-labelledby targets only after
+              // client hydration, so those targets are absent from the
+              // statically rendered HTML. Disable rather than report false
+              // positives.
+              'no-missing-references': 'off',
+            },
+            elements: [
+              'html5',
+              {
+                form: {
+                  attributes: {
+                    // React renders `action="javascript:throw new Error(...)"` on
+                    // a <form> with a function action during SSR (a sentinel that
+                    // throws if the form is submitted before hydration wires up
+                    // the real handler). Permit that value while keeping the
+                    // default check (`^\s*\S+\s*$`) for every other action value.
+                    action: {
+                      enum: ['/^\\s*\\S+\\s*$/', '/^\\s*javascript:throw new Error\\(/'],
+                    },
+                  },
+                },
+              },
+            ],
+          },
+          ...overridePresets,
+        },
+      });
+
+      const htmlValidator = new HtmlValidate(
+        new StaticConfigLoader([muiHtmlValidateResolver], {
+          extends: ['mui:recommended', ...Object.keys(overridePresets)],
+        }),
+      );
+
+      if (options.verbose) {
+        const resolved = await htmlValidator.getConfigFor(pageUrl);
+        console.warn(
+          `[html-validate config] ${pageUrl}\n${JSON.stringify(resolved.getConfigData(), null, 2)}`,
+        );
+      }
+
+      const report = await htmlValidator.validateString(rawContent, pageUrl);
+      htmlValidateResults = { pageUrl, results: report.results };
+    }
+  }
+
+  postResult({ pageData, links, htmlValidateResults });
+}