@sun-asterisk/sungen 3.2.6 → 3.2.8

package/src/cli/commands/delivery.ts

@@ -12,7 +12,7 @@ import { parseFeatureMetadata } from '../../exporters/feature-parser';
 import { parseSpecFile } from '../../exporters/spec-parser';
 import { loadTestData } from '../../exporters/test-data-resolver';
 import { loadSelectorKeyMap } from '../../exporters/selector-key-resolver';
-import { loadPlaywrightReport } from '../../exporters/playwright-report-parser';
+import { loadPlaywrightReport, resolveResultsPath as resolveResultsPathShared } from '../../exporters/playwright-report-parser';
 import { mergeFeatureAndSpec } from '../../exporters/scenario-merger';
 import {
   buildTestCaseRows,
@@ -21,6 +21,7 @@ import {
   writeCsv,
 } from '../../exporters/csv-exporter';
 import { renderXlsxMultiSheet, writeXlsx, buildApiDetailRows, addApiDetailSheet } from '../../exporters/xlsx-exporter';
+import { loadApiCatalog } from '../../exporters/api-catalog-loader';
 import { resolvePlatformAppId } from '../../exporters/mobile-app-id';
 import { EnvironmentInfo, PreflightCheck, ScreenSummary, TestCaseRow, ApiCatalogEntry } from '../../exporters/types';
 
@@ -57,7 +58,7 @@ type UnitKind = 'screen' | 'flow' | 'api';
 /** qa/ subfolder for a unit kind. */
 const qaParent = (kind: UnitKind): string => (kind === 'flow' ? 'flows' : kind === 'api' ? 'api' : 'screens');
 
-interface DeliveryTarget {
+export interface DeliveryTarget {
   screen: string;
   featureBaseName: string;
   /** Alias of `featureBaseName` — preserves the old `target.name` call sites. */
@@ -136,35 +137,8 @@ function qaDir(cwd: string, target: DeliveryTarget): string {
   return path.join(cwd, 'qa', qaParent(target.kind), target.screen);
 }
 
-/**
- * Load the apis.yaml catalog for an api-kind unit, merging the shared catalog under
- * the unit catalog. The runtime resolves an endpoint unit-scope-first then falls back
- * to the shared catalog (driver-api api-catalog.ts), so an endpoint defined only in
- * `qa/api/apis.yaml` still runs — we must load it too, or its request block would come
- * back empty (the very bug this feature fixes). Unit wins on a name collision.
- * Returns an empty object when neither file is present (graceful degradation).
- */
-function loadApiCatalog(cwd: string, target: DeliveryTarget): Record<string, ApiCatalogEntry> {
-  if (target.kind !== 'api') return {};
-  const shared = readApiCatalogFile(path.join(cwd, 'qa', 'api', 'apis.yaml'));
-  const unit = readApiCatalogFile(path.join(cwd, 'qa', 'api', target.screen, 'api', 'apis.yaml'));
-  return { ...shared, ...unit };
-}
-
-/** Parse one apis.yaml file into an endpoint map, unwrapping the optional `apis:` wrapper. */
-function readApiCatalogFile(catalogPath: string): Record<string, ApiCatalogEntry> {
-  if (!fs.existsSync(catalogPath)) return {};
-  try {
-    const parsed = parseYaml(fs.readFileSync(catalogPath, 'utf-8')) as Record<string, unknown> | null;
-    if (parsed && typeof parsed === 'object') {
-      // The runtime loader accepts both a flat map and an `apis:` wrapper — unwrap it
-      // here too so both loaders read the same file identically.
-      const root = parsed.apis && typeof parsed.apis === 'object' ? parsed.apis : parsed;
-      return root as Record<string, ApiCatalogEntry>;
-    }
-  } catch { /* malformed yaml — skip */ }
-  return {};
-}
+// apis.yaml catalog loading moved to ../../exporters/api-catalog-loader so the
+// dashboard snapshot builder loads the identical contract (shared + unit merge).
 
 function generatedDir(cwd: string, target: DeliveryTarget): string {
   const sub = target.kind === 'flow' ? path.join('flows', target.screen) : target.kind === 'api' ? path.join('api', target.screen) : target.screen;
@@ -188,17 +162,9 @@ function generatedDir(cwd: string, target: DeliveryTarget): string {
  * `SUNGEN_ENV` is set, so each locale run keeps its own results file.
  */
 function resolveResultsPath(cwd: string, target: DeliveryTarget): string | null {
-  const genDir = generatedDir(cwd, target);
-  const env = process.env.SUNGEN_ENV;
-  const candidates: string[] = [];
-  if (env) candidates.push(path.join(genDir, `${target.featureBaseName}-test-result.${env}.json`));
-  candidates.push(path.join(genDir, `${target.featureBaseName}-test-result.json`));
-  if (env) candidates.push(path.join(cwd, 'test-results', `results.${env}.json`));
-  candidates.push(path.join(cwd, 'test-results', 'results.json'));
-  for (const c of candidates) {
-    if (fs.existsSync(c)) return c;
-  }
-  return null;
+  // Shared with the dashboard snapshot builder (same candidate order incl. the
+  // test-results/results.json fallback) so the two surfaces can't drift.
+  return resolveResultsPathShared(cwd, generatedDir(cwd, target), target.featureBaseName);
 }
 
 /**
@@ -290,7 +256,7 @@ function readFlowPagePath(selectorsFile: string): string | undefined {
   return undefined;
 }
 
-function runPreflight(cwd: string, target: DeliveryTarget): PreflightCheck {
+export function runPreflight(cwd: string, target: DeliveryTarget): PreflightCheck {
   const base = qaDir(cwd, target);
   const genBase = generatedDir(cwd, target);
   const featureFile = path.join(base, 'features', `${target.featureBaseName}.feature`);
@@ -300,7 +266,13 @@ function runPreflight(cwd: string, target: DeliveryTarget): PreflightCheck {
   const resultsFile = resolveResultsPath(cwd, target);
 
   const featureOk = checkFeatureReal(featureFile);
-  const testDataOk = checkTestDataHasVars(testDataFile);
+  // test-data is only REQUIRED when the feature actually references a
+  // {{var}} placeholder. A static screen (e.g. a fixed bottom-navigation bar)
+  // legitimately has zero test-data variables — blocking its export was a
+  // false positive (issue: preflight blocked static screens).
+  const testDataOk = featureReferencesTestData(featureFile)
+    ? checkTestDataHasVars(testDataFile)
+    : true;
   // API units have no DOM → no selectors; the catalog (apis.yaml) is the contract. N/A, not missing.
   const selectorsOk = target.kind === 'api' ? true : checkSelectorsHasEntries(selectorsFile, target.featureBaseName);
   const specOk = fs.existsSync(specFile);
@@ -367,6 +339,20 @@ function checkTestDataHasVars(testDataFile: string): boolean {
   return lines.length > 0;
 }
 
+/**
+ * True when the .feature references at least one test-data variable — a
+ * `{{var}}` placeholder that is not a runtime-generated `{{$...}}` var
+ * (e.g. `{{$uuid}}`, resolved at execution time, never from test-data.yaml).
+ * Comment-only or reference-free features need no test-data entries.
+ */
+function featureReferencesTestData(featureFile: string): boolean {
+  if (!fs.existsSync(featureFile)) return false;
+  const content = fs.readFileSync(featureFile, 'utf-8');
+  // Strip Gherkin comment lines so a {{var}} inside a `# ...` note doesn't count.
+  const code = content.split('\n').filter((l) => !l.trim().startsWith('#')).join('\n');
+  return /\{\{\s*[^$}\s][^}]*\}\}/.test(code);
+}
+
 function checkSelectorsHasEntries(selectorsFile: string, screen: string): boolean {
   if (!fs.existsSync(selectorsFile)) return false;
   const content = fs.readFileSync(selectorsFile, 'utf-8');
@@ -376,7 +362,7 @@ function checkSelectorsHasEntries(selectorsFile: string, screen: string): boolea
   return topLevelKeys > 1;
 }
 
-function hasBlockingMissing(p: PreflightCheck): boolean {
+export function hasBlockingMissing(p: PreflightCheck): boolean {
   return !p.featureOk || !p.testDataOk || !p.selectorsOk || !p.specOk;
 }
 
@@ -477,7 +463,7 @@ async function exportTarget(
     const explicitEnv = process.env.SUNGEN_ENV;
 
     // For api-kind units, load the endpoint catalog so we can add the API detail sheet.
-    const apiCatalog = loadApiCatalog(cwd, target);
+    const apiCatalog = loadApiCatalog(cwd, target.kind, target.screen);
     const hasApiCatalog = target.kind === 'api' && Object.keys(apiCatalog).length > 0;
 
     // Decide between single-locale and aggregated multi-locale flows.

package/src/dashboard/snapshot-builder.ts

@@ -19,12 +19,14 @@ import { parseFeatureMetadata } from '../exporters/feature-parser';
 import { parseSpecFile } from '../exporters/spec-parser';
 import { loadTestData } from '../exporters/test-data-resolver';
 import { loadSelectorKeyMap } from '../exporters/selector-key-resolver';
-import { loadPlaywrightReport } from '../exporters/playwright-report-parser';
+import { loadPlaywrightReport, resolveResultsPath } from '../exporters/playwright-report-parser';
 import { mergeFeatureAndSpec } from '../exporters/scenario-merger';
 import { buildScreenSnapshot } from '../exporters/json-exporter';
+import { loadApiCatalog } from '../exporters/api-catalog-loader';
+import { buildApiDetailRows } from '../exporters/xlsx-exporter';
 import { resolvePlatformAppId } from '../exporters/mobile-app-id';
 import { getPackageVersion } from '../exporters/package-info';
-import { EnvironmentInfo } from '../exporters/types';
+import { ApiCatalogEntry, EnvironmentInfo } from '../exporters/types';
 import {
   AggregateSummary,
   DashboardSnapshot,
@@ -126,9 +128,13 @@ function buildOneScreen(
   const specLink = fs.existsSync(specMdFile) ? path.relative(cwd, specMdFile) : undefined;
 
   const mobile = isMobileProject(cwd);
+  // api-kind units: load the endpoint catalog once per target — the same
+  // shared+unit merge delivery.ts uses — so Steps/Expected cells and the API
+  // detail sheet match the delivery CSV/XLSX exactly.
+  const apiCatalog = loadApiCatalog(cwd, target.kind, target.name);
   const features: FeatureSnapshot[] = [];
   for (const featureBaseName of featureBaseNames) {
-    features.push(...buildOneFeature(cwd, target, featureBaseName, env, specLink, mobile));
+    features.push(...buildOneFeature(cwd, target, featureBaseName, env, specLink, mobile, apiCatalog));
   }
   if (features.length === 0) return null;
 
@@ -183,6 +189,7 @@ function buildOneFeature(
   env: EnvironmentInfo,
   specLink: string | undefined,
   mobile: boolean,
+  apiCatalog: Record<string, ApiCatalogEntry>,
 ): FeatureSnapshot[] {
   const base = qaDir(cwd, target);
   const genBase = generatedDir(cwd, target);
@@ -210,7 +217,7 @@ function buildOneFeature(
   // Discover locale variants by scanning <feature>-test-result*.json files.
   // Always includes base ('') as the first entry, even if its results file
   // is missing — UI still needs to render the feature.
-  const variants = discoverLocaleVariants(genBase, featureBaseName);
+  const variants = discoverLocaleVariants(cwd, genBase, featureBaseName);
 
   // Build one per-variant ScreenSnapshot (test-data overlay + results + OS-precise
   // env column). Reused by both the web/i18n (locale-axis) and mobile (platform-axis) paths.
@@ -233,10 +240,21 @@ function buildOneFeature(
       env,
       featureBaseName,
       selectorKeyMap,
+      kind: target.kind,
+      apiCatalog,
     });
   };
   type Built = ReturnType<typeof buildVariant>;
 
+  // API detail sheet rows — the identical buildApiDetailRows call delivery.ts
+  // makes before addApiDetailSheet, precomputed so the (browser-side) XLSX
+  // export just passes them to the shared builder. Endpoint contract is
+  // locale-invariant → computed once per feature.
+  const apiDetailRows = target.kind === 'api' && Object.keys(apiCatalog).length > 0
+    ? buildApiDetailRows(apiCatalog, feature.scenarios)
+    : [];
+  const apiDetail = apiDetailRows.length > 0 ? apiDetailRows : undefined;
+
   // -- Mobile (platform axis): the per-OS runs (android / ios) are their own
   //    FeatureSnapshot entries — one per OS, `platform` tagged — NOT locale tabs.
   //    Locale overlays for a given OS (e.g. `android.ja`) nest inside that OS's
@@ -272,6 +290,7 @@ function buildOneFeature(
           platform: os,
           executedPlatforms,
           locales: localeSnaps.length >= 2 ? localeSnaps : undefined,
+          apiDetail,
         });
       }
       if (feats.length > 0) return feats;
@@ -318,6 +337,7 @@ function buildOneFeature(
     // Only expose `locales` array when 2+ variants exist — single-locale
     // features stay slimmer and UI can skip the locale tab UI entirely.
     locales: locales.length >= 2 ? locales : undefined,
+    apiDetail,
   }];
 }
 
@@ -342,15 +362,19 @@ interface FeatureLocaleVariant {
  * dashboard and the CSV/XLSX delivery agree on what locales exist for a
  * given feature.
  */
-function discoverLocaleVariants(genDir: string, featureBaseName: string): FeatureLocaleVariant[] {
+function discoverLocaleVariants(cwd: string, genDir: string, featureBaseName: string): FeatureLocaleVariant[] {
   const prefix = `${featureBaseName}-test-result`;
   const variants: FeatureLocaleVariant[] = [];
 
-  const basePath = path.join(genDir, `${prefix}.json`);
+  // Base variant resolves through the SHARED candidate chain (per-feature file
+  // first, then the global test-results/results.json playwright writes by
+  // default) — the same resolution delivery.ts uses. Without the fallback the
+  // dashboard showed every scenario Pending on projects that only have the
+  // global results file, while delivery correctly reported Passed.
   variants.push({
     locale: '',
     displayCode: DEFAULT_BASE_LOCALE.toUpperCase(),
-    resultsPath: fs.existsSync(basePath) ? basePath : null,
+    resultsPath: resolveResultsPath(cwd, genDir, featureBaseName),
   });
 
   if (fs.existsSync(genDir)) {