@wcag-checkr/ci 1.0.0-rc.366 → 1.0.0-rc.367

package/dist/side-panel/wire-messaging.ts

@@ -1,521 +0,0 @@
-// Subscribe Zustand store to messaging events. Open keepalive port to SW.
-// Also handles last-audit persistence so closing/reopening the side panel preserves results.
-
-import { on, request } from '../shared/messaging';
-import { useStore } from './store';
-import { announcer } from '../shared/announcer';
-import { getAuditTargetTabId } from '../shared/active-tab';
-import type { BaselineListResponse, SettingsResponse, TierGetResponse, ExportResponse } from '../shared/messages';
-import type { UserMode } from './store';
-import type { AuditResult, DeltaResult } from '../types/audit';
-import {
-  getAutoExportSettings,
-  recordLastAutoExport,
-} from '../shared/auto-export-settings';
-import { triggerDownload, bundleFilename } from '../shared/download-helper';
-import { isFeatureAllowed } from '../shared/tier-rules';
-import { isLockoutInEffectForTier } from '../shared/headless-build-lockdown';
-import {
-  getCachedRubricConfig,
-  setResolvedRubrics,
-  freshness as rubricFreshness,
-} from '../shared/rubric-config-cache';
-
-const LAST_AUDIT_KEY = 'sidePanel:lastAudit';
-
-type PersistedAudit = {
-  results: AuditResult[];
-  delta: DeltaResult | null;
-  componentId: string | null;
-};
-
-export function wireMessaging(): () => void {
-  const offs: Array<() => void> = [];
-
-  offs.push(
-    on('AUDIT_PROGRESS_EVENT', (msg) => {
-      const s = useStore.getState();
-      const wasRunning = s.status === 'running';
-      const inCrawl = s.siteCrawlStatus === 'running';
-      s.setProgress({
-        current: msg.current,
-        total: msg.total,
-        currentState: msg.currentState,
-      });
-      // rc.288 — During a crawl, AUDIT_PROGRESS_EVENT fires per page
-      // per state so the side panel can show inner matrix progress
-      // underneath the crawl's page counter. Don't flip s.status to
-      // 'running' in that case — the crawl's own siteCrawlStatus is
-      // the lifecycle signal, and we'd leave status='running' dangling
-      // after the crawl ends (AUDIT_COMPLETE is suppressed by
-      // asSubroutine). For genuine single-page runs, status='running'
-      // is still the right signal.
-      if (!inCrawl) {
-        s.setStatus('running');
-        if (!wasRunning) {
-          announcer.polite(`Audit running, scanning ${msg.total} state${msg.total === 1 ? '' : 's'}.`);
-        }
-      }
-    })
-  );
-
-  offs.push(
-    on('AUDIT_COMPLETE_EVENT', (msg) => {
-      useStore.getState().setResults(msg.results, msg.delta, msg.componentId);
-      const violationCount = msg.results.reduce((acc, r) => acc + r.violations.length, 0);
-      const newCount = msg.delta?.newCount ?? 0;
-      const summary = msg.delta
-        ? `Audit complete. ${newCount} new violation${newCount === 1 ? '' : 's'} versus baseline.`
-        : `Audit complete. ${violationCount} violation${violationCount === 1 ? '' : 's'} found across ${msg.results.length} state${msg.results.length === 1 ? '' : 's'}.`;
-      announcer.polite(summary);
-      // rc.159 — Auto-navigate to Findings on audit completion. The user
-      // most likely wants to see the results, not stay on the Dashboard
-      // / specialized tool they kicked the audit off from. Exception: if
-      // they're mid-flow on Compliance (multi-step report builder),
-      // Guided (interactive workflow session), or Crawl (multi-page scan
-      // in progress), don't yank them out of context.
-      const currentView = useStore.getState().view;
-      const stickyViews: Array<typeof currentView> = ['compliance', 'guided', 'crawl'];
-      if (!stickyViews.includes(currentView)) {
-        useStore.getState().setView('report');
-        useStore.getState().setFindingsLens('overview');
-      }
-      void persistLastAudit({
-        results: msg.results,
-        delta: msg.delta,
-        componentId: msg.componentId,
-      });
-      // rc.201 — Auto-export the audit report if the user has the
-      // "auto-export after each audit" setting on AND their tier
-      // allows it. Fires AFTER setResults so the rest of the UI has
-      // updated. Errors are best-effort + silent — the user already
-      // has the in-app result; failing to write a file is logged but
-      // doesn't disrupt the audit flow.
-      void maybeAutoExport(msg.results, msg.delta, msg.componentId);
-    })
-  );
-
-  offs.push(
-    on('AUDIT_FAILED_EVENT', (msg) => {
-      // ErrorBanner has role="alert" (implicit assertive live region) so the SR
-      // announcement fires when the banner mounts. No need for an extra
-      // announcer.assertive — that would double-speak.
-      useStore.getState().setError(msg.error.message);
-    })
-  );
-
-  offs.push(
-    on('AI_AUGMENTATION_PROGRESS_EVENT', (msg) => {
-      const prev = useStore.getState().aiProgress;
-      useStore.getState().setAiProgress({
-        currentCheckLabel: msg.currentCheckLabel,
-        current: msg.current,
-        total: msg.total,
-        candidatesDone: msg.candidatesDone,
-        candidatesTotal: msg.candidatesTotal,
-      });
-      // Announce only on the first AI check so SR users hear the phase
-      // transition once, not 8 times. Sub-progress events fire often;
-      // don't speak those.
-      if (!prev) {
-        announcer.polite(`AI augmentation running ${msg.total} check${msg.total === 1 ? '' : 's'}.`);
-      }
-    })
-  );
-
-  offs.push(
-    on('AI_AUGMENTATION_FAILED_EVENT', (msg) => {
-      useStore.getState().setAiFailure({
-        severity: msg.severity,
-        reason: msg.reason,
-        checksAttempted: msg.checksAttempted,
-        checksSucceeded: msg.checksSucceeded,
-        checksErrored: msg.checksErrored,
-        errorDetails: msg.errorDetails,
-      });
-      // The banner has role="alert" — the SR announcement fires on mount.
-      // Don't also call announcer.assertive (would double-speak).
-    })
-  );
-
-  offs.push(
-    on('SCORECARD_UPDATED_EVENT', () => {
-      void refreshBaselineList();
-    })
-  );
-
-  // The license tier can change when the user activates a new token in another context;
-  // refresh on broadcast so the tier badge is current.
-  offs.push(
-    on('LICENSE_CHANGED_EVENT', () => {
-      void refreshLicenseTier();
-    })
-  );
-
-  // ─── Site crawl events ─────────────────────────────────────────────────
-  offs.push(
-    on('SITE_CRAWL_PROGRESS_EVENT', (msg) => {
-      const s = useStore.getState();
-      s.setSiteCrawlStatus('running');
-      s.setSiteCrawlProgress({
-        current: msg.current,
-        total: msg.total,
-        url: msg.url,
-        lastViolations: msg.violations,
-      });
-      if (msg.status === 'auditing' && msg.current === 1) {
-        announcer.polite(`Site crawl started, scanning up to ${msg.total} pages.`);
-      }
-    })
-  );
-
-  offs.push(
-    on('SITE_CRAWL_COMPLETE_EVENT', (msg) => {
-      const s = useStore.getState();
-      s.setSiteCrawlStatus('complete');
-      s.setSiteCrawlReport(msg.report);
-      s.setSiteCrawlProgress(null);
-      announcer.polite(
-        `Site crawl complete. Grade ${msg.report.siteGrade}, ${msg.report.totalUniqueViolations} unique violation${msg.report.totalUniqueViolations === 1 ? '' : 's'}.`
-      );
-      // rc.236 — Pre-warm resolutions cache for every crawled URL so
-      // that when the user clicks a page in the do-the-work report
-      // and drills into its Findings, the AI-resolved-fails count is
-      // correct on FIRST render (no two-render flicker like rc.235
-      // fixed for the now-removed aggregate view). Pre-rc.236 we also
-      // flattened all crawled results into the main `results` store
-      // to feed an aggregate "View site-wide Findings" button — that
-      // button is gone (the Crawl panel itself is the report now),
-      // and the aggregate-Findings view's broken math was what
-      // confused users. Drill-in setResults still happens, just only
-      // when the user clicks a specific page.
-      void (async () => {
-        try {
-          const { loadSiteCrawlPerUrlResults } = await import('../shared/site-crawl-storage');
-          const { getResolutionsForPage } = await import('../shared/incomplete-resolutions');
-          const perUrl = await loadSiteCrawlPerUrlResults();
-          if (!perUrl || perUrl.length === 0) return;
-          const setResolutionsForUrl = useStore.getState().setResolutionsForUrl;
-          await Promise.all(
-            perUrl.map(async (p) => {
-              try {
-                const r = await getResolutionsForPage(p.url);
-                setResolutionsForUrl(p.url, r);
-              } catch {
-                // best-effort
-              }
-            }),
-          );
-        } catch (err) {
-          // eslint-disable-next-line no-console
-          console.warn('[site-crawl] failed to pre-warm resolutions cache', err);
-        }
-      })();
-    })
-  );
-
-  offs.push(
-    on('SITE_CRAWL_FAILED_EVENT', (msg) => {
-      const s = useStore.getState();
-      s.setSiteCrawlStatus('failed');
-      s.setSiteCrawlError(msg.error.message);
-      s.setSiteCrawlProgress(null);
-      announcer.assertive(`Site crawl failed: ${msg.error.message}`);
-    })
-  );
-
-  // ─── Crawl discovery (review-before-audit) events ──────────────────────
-  offs.push(
-    on('CRAWL_DISCOVERY_PROGRESS_EVENT', (msg) => {
-      const s = useStore.getState();
-      if (s.crawlDiscoveryStatus !== 'discovering') s.setCrawlDiscoveryStatus('discovering');
-      s.setCrawlDiscoveryProgress(msg.found, msg.url);
-      if (msg.found === 1) announcer.polite('Discovering pages to review.');
-    })
-  );
-
-  offs.push(
-    on('CRAWL_DISCOVERY_COMPLETE_EVENT', (msg) => {
-      const s = useStore.getState();
-      s.setCrawlDiscoveryUrls(msg.urls);
-      s.setCrawlDiscoveryStatus('reviewing');
-      announcer.polite(
-        `Discovery complete. ${msg.urls.length} page${msg.urls.length === 1 ? '' : 's'} found — review and choose which to audit.`
-      );
-    })
-  );
-
-  offs.push(
-    on('CRAWL_DISCOVERY_FAILED_EVENT', (msg) => {
-      const s = useStore.getState();
-      s.resetCrawlDiscovery();
-      s.setSiteCrawlStatus('failed');
-      s.setSiteCrawlError(msg.error.message);
-      announcer.assertive(`Page discovery failed: ${msg.error.message}`);
-    })
-  );
-
-  return () => offs.forEach((off) => off());
-}
-
-/** rc.201 — Auto-export the just-completed audit if the user opted in.
- *  Silent + best-effort. Errors are logged but never thrown — the audit
- *  itself completed successfully even if file-system write fails. */
-async function maybeAutoExport(
-  results: AuditResult[],
-  delta: DeltaResult | null | undefined,
-  componentId: string | null | undefined,
-): Promise<void> {
-  if (results.length === 0) return;
-  try {
-    const settings = await getAutoExportSettings();
-    if (!settings.enabled) return;
-    // Tier-gate. Free tier won't get the toggle exposed post-launch;
-    // even if a tier change happens between toggle-on and audit-complete,
-    // the gate re-checks here.
-    const tier = useStore.getState().tier;
-    if (isLockoutInEffectForTier(tier)) return;
-    if (!isFeatureAllowed(tier, 'autoExportAuditReports')) return;
-
-    // rc.221 — Loop every enabled format. Each completed audit produces
-    // each requested artifact (defense-bundle for legal + ai-prompt for
-    // dev handoff + html-print for sharing — pick the set that matches
-    // the workflow).
-    const url = results[0]?.pageUrl ?? results[0]?.scope ?? '';
-    const exported: string[] = [];
-    // rc.228 — Snapshot wall-clock now so all formats in this auto-
-    // export round see the same value.
-    const wallClockMs = useStore.getState().lastAuditWallClockMs ?? undefined;
-    for (const format of settings.formats) {
-      try {
-        const res = await request<ExportResponse>({
-          type: 'EXPORT_REQUEST',
-          format,
-          results,
-          delta: delta ?? undefined,
-          wallClockMs,
-        });
-        // EXPORT_REQUEST returns a lockout error string when the SW-side
-        // gate refuses. Treat any very-short body as "refused."
-        if (typeof res.content !== 'string' || res.content.length < 200) continue;
-        const filename = bundleFilename(format, componentId ?? null);
-        triggerDownload(res.content, filename);
-        if (url) {
-          await recordLastAutoExport({
-            url,
-            exportedAt: new Date().toISOString(),
-            format,
-            filename,
-          });
-        }
-        exported.push(filename);
-      } catch (formatErr) {
-        console.warn(`[auto-export] format ${format} failed:`, formatErr);
-      }
-    }
-    if (exported.length > 0) {
-      announcer.polite(`Audit auto-exported ${exported.length} file${exported.length === 1 ? '' : 's'}.`);
-    }
-  } catch (err) {
-    // Silent failure — surface in console for debugging but don't
-    // interrupt the user's audit-review flow with a modal.
-    console.warn('[auto-export] failed:', err);
-  }
-}
-
-async function persistLastAudit(payload: PersistedAudit): Promise<void> {
-  // Strip screenshotDataUrl from each result before persisting. With a full
-  // state matrix (up to 144 states), 144 base64 JPEGs at ~50-200KB each blow
-  // chrome.storage.local's 10MB MV3 quota — manifestly observed in panel
-  // unhandled rejections with "Resource::kQuotaBytes quota exceeded".
-  //
-  // Trade-off: screenshots remain in-memory for the current panel session
-  // (export bundles run in this session still have them). After a panel
-  // reopen / SW restart, violations + delta + componentId are restored but
-  // screenshots aren't — the user would need to re-audit to regenerate them.
-  const stripped: PersistedAudit = {
-    ...payload,
-    results: payload.results.map(({ screenshotDataUrl: _drop, ...rest }) => rest),
-  };
-  try {
-    await chrome.storage.local.set({ [LAST_AUDIT_KEY]: stripped });
-  } catch (err) {
-    // Even stripped, a very-large violation set could still exceed quota.
-    // Better to leave the in-memory results intact than crash the panel on
-    // a non-essential persistence step.
-    console.warn('[wire-messaging] persistLastAudit failed; results stay in-memory only', err);
-  }
-}
-
-export async function loadLastAudit(): Promise<void> {
-  const r = await chrome.storage.local.get(LAST_AUDIT_KEY);
-  const last = r[LAST_AUDIT_KEY] as PersistedAudit | undefined;
-  if (!last) return;
-  useStore.setState({
-    results: last.results,
-    delta: last.delta,
-    componentId: last.componentId,
-    status: 'complete',
-  });
-}
-
-export async function clearLastAudit(): Promise<void> {
-  await chrome.storage.local.remove(LAST_AUDIT_KEY);
-}
-
-/** Wipe the SINGLE-PAGE slice only — store results + the persisted
- *  last-audit cache. Reused by the navigation auto-clear path
- *  (clearIfTargetUrlChanged), which must NOT touch a crawl: navigating the
- *  audited tab away should drop the stale single-page audit but leave a
- *  separate site-crawl alone. User-triggered "Clear results" buttons want a
- *  COMPLETE wipe instead — use clearAllResults() for those. */
-export async function clearAudit(): Promise<void> {
-  useStore.getState().clearResults();
-  await clearLastAudit();
-}
-
-/** rc.360 — Full user-triggered wipe: the single-page slice AND the shared
- *  crawl pool (in-memory siteCrawlReport, the persisted `siteCrawlReport`
- *  key, and the per-URL IDB store). Before the single-data-pool work
- *  (rc.351/353/354) only the single-page slice rendered a grade, so a bare
- *  clearAudit() was enough. Now the v1 LastRunBanner and owner-mode
- *  CrawlResultGrade both derive a grade from the crawl pool — so unless
- *  Clear wipes that pool too, the grade reappears the instant after Clear is
- *  clicked. Every "Clear results"/"Clear" button across all three UIs routes
- *  through here so the wipe is uniform regardless of which UI triggers it. */
-export async function clearAllResults(): Promise<void> {
-  const store = useStore.getState();
-  store.clearResults();
-  store.setSiteCrawlReport(null); // in-memory; also fires a persist-null
-  store.setSiteCrawlError(null);
-  store.setSiteCrawlStatus('idle');
-  await clearLastAudit();
-  // Await the persisted wipe (removes the storage key AND deletes the
-  // per-URL IDB record) so a quick panel close/reopen right after Clear
-  // cannot rehydrate the old grade from a half-finished fire-and-forget.
-  const { saveSiteCrawlReport } = await import('../shared/site-crawl-storage');
-  await saveSiteCrawlReport(null);
-  // rc.361 — Also invalidate the audit-cache (flows.ts fast-path). Without
-  // this, re-auditing a page whose DOM fingerprint is unchanged replays the
-  // cached results in ~10ms (broadcasts AUDIT_COMPLETE, skips the whole state
-  // matrix) — so right after Clear the user gets the SAME grade back
-  // "instantly instead of actually running the check." Clear means start
-  // fresh, so the next audit must actually run. (Cliff's ".org instant grade":
-  // .org was cached from constant re-auditing; a freshly-visited site wasn't,
-  // which is why it only happened on .org.)
-  const { clearAllCachedAudits } = await import('../shared/audit-cache');
-  await clearAllCachedAudits();
-}
-
-/** Strip the URL fragment so anchor-only changes (#section) don't read as
- *  navigation. Path + querystring + host all still count. */
-function normalizeUrl(u: string): string {
-  try {
-    const url = new URL(u);
-    url.hash = '';
-    return url.toString();
-  } catch {
-    return u;
-  }
-}
-
-/** If the currently-loaded audit's pageUrl no longer matches the audit target
- *  tab's URL, clear the audit. Called on side-panel mount AND whenever the
- *  target tab navigates or the active tab changes (see App.tsx). */
-export async function clearIfTargetUrlChanged(): Promise<void> {
-  const { results } = useStore.getState();
-  if (results.length === 0) return;
-  const audited = results[0]?.pageUrl;
-  if (!audited) return; // legacy result without pageUrl — leave alone
-
-  const tabId = await getAuditTargetTabId();
-  if (!tabId) {
-    // No usable target tab anymore (e.g. only chrome:// pages open) — treat
-    // as a navigation away from the audited page.
-    await clearAudit();
-    return;
-  }
-  try {
-    const tab = await chrome.tabs.get(tabId);
-    if (normalizeUrl(tab.url ?? '') !== normalizeUrl(audited)) {
-      await clearAudit();
-    }
-  } catch {
-    // tab gone — also stale
-    await clearAudit();
-  }
-}
-
-export async function refreshBaselineList(): Promise<void> {
-  const res = await request<BaselineListResponse>({ type: 'BASELINE_LIST' });
-  useStore.getState().setBaselineList(res.items);
-}
-
-export async function refreshLicenseTier(opts?: { forceRefresh?: boolean }): Promise<void> {
-  const res = await request<TierGetResponse>({
-    type: 'TIER_GET',
-    forceRefresh: opts?.forceRefresh === true,
-  });
-  useStore.getState().setTier(res.tier, {
-    trialDaysRemaining: res.trialDaysRemaining,
-    seatsUsed: res.seatsUsed,
-    seatsTotal: res.seatsTotal,
-    planCode: res.planCode,
-    licenseDaysRemaining: res.licenseDaysRemaining,
-    pastDue: res.pastDue,
-  });
-  // Fold the in-app messages refresh into the same wake-up so the bell
-  // stays in sync with the license-validate cadence. Failures are silent
-  // — the bell just stays in its last-known state.
-  void refreshInAppMessages();
-}
-
-export async function refreshInAppMessages(): Promise<void> {
-  // Dynamic import keeps the messages-client out of the initial chunk —
-  // bell content is only ever painted after the panel mounts.
-  const { fetchMessages } = await import('../modules/messages-client');
-  const mode = useStore.getState().userMode;
-  const res = await fetchMessages(mode);
-  if (!res) return;
-  useStore.getState().setMessages(res.messages, res.unreadCount, res.criticalUnacked);
-}
-
-/** Load the user's persona setting. rc.333 — 'power' added as a
- *  first-class persona; first-launch defaults to 'owner' (no
- *  wizard). The Root component in main.tsx handles the storage-
- *  to-mode mapping; this hydrates the side-panel store from the
- *  same persisted value. */
-/** rc.337 — Warm the side-panel's in-memory rubric snapshot from
- *  chrome.storage.local. The SW polls the server hourly and writes
- *  to storage; this reads the latest cached config so synchronous
- *  consumers (computeLawfareRisk in OwnerView, etc.) see the
- *  server-fetched curated lists rather than the bundled fallback.
- *  Also subscribes to storage changes so server-pushed updates
- *  propagate live without panel reload. */
-export async function warmAndWatchRubrics(): Promise<void> {
-  async function apply(): Promise<void> {
-    const entry = await getCachedRubricConfig();
-    if (!entry || rubricFreshness(entry) === 'expired') {
-      setResolvedRubrics(null);
-      return;
-    }
-    setResolvedRubrics(entry.config);
-  }
-  await apply();
-  chrome.storage.onChanged.addListener((changes, area) => {
-    if (area !== 'local' || !('rubricConfigCache' in changes)) return;
-    void apply();
-  });
-}
-
-export async function refreshUserMode(): Promise<void> {
-  const res = await request<SettingsResponse>({ type: 'SETTINGS_GET', key: 'userMode' });
-  const v = res.data;
-  const mode: UserMode | null =
-    v === 'owner' || v === 'power' || v === 'dev' ? v : null;
-  useStore.getState().setUserMode(mode);
-}
-
-export function startKeepalive(): chrome.runtime.Port {
-  return chrome.runtime.connect({ name: 'audit-keepalive' });
-}