clava 0.4.0 → 0.4.2

package/src/index.ts

@@ -1,4 +1,12 @@
 import clsx, { type ClassValue as ClsxClassValue } from "clsx";
+import {
+  REFINE_UNSTABLE_TRACKING_WINDOW,
+  type RefineRunState,
+  type VariantChange,
+  accumulateUnstableVariantChanges,
+  captureCreationFrame,
+  warnRefineLimit,
+} from "./refine-warning.ts";
 import type {
   AnyComponent,
   CVComponent,
@@ -57,11 +65,6 @@ type ResolveRefineFn = (
   protectedVariantKeys?: Set<string> | null,
 ) => Record<string, unknown>;
 
-interface RefineRunState {
-  remaining: number;
-  warned: boolean;
-}
-
 // Internal metadata stored on components but hidden from public types.
 interface ComponentMeta {
   baseClass: string;
@@ -94,6 +97,10 @@ interface ComponentMeta {
 
 const META_KEY = "__meta";
 
+interface ComponentWithMeta {
+  [META_KEY]?: ComponentMeta;
+}
+
 const EMPTY_DEFAULTS: Record<string, unknown> = Object.freeze({}) as Record<
   string,
   unknown
@@ -116,18 +123,6 @@ function areVariantsEqual(
   return true;
 }
 
-function warnRefineLimit(runState: RefineRunState): void {
-  if (runState.warned) return;
-  runState.warned = true;
-  if (process.env.NODE_ENV !== "production") {
-    console.warn(
-      "Clava: Maximum refine iterations exceeded. This can happen when a " +
-        "refine callback calls setVariants or setDefaultVariants, but one " +
-        "of the variants changes on every run.",
-    );
-  }
-}
-
 function getExtUserVariantProps(
   userVariantProps: Record<string, unknown>,
   protectedVariants: Record<string, unknown> | null,
@@ -154,7 +149,9 @@ function mergeVariants(
     for (const key in source) {
       if (!Object.hasOwn(source, key)) continue;
       const value = source[key];
-      if (!Object.is(target[key], value)) changed = true;
+      if (!Object.is(target[key], value)) {
+        changed = true;
+      }
       target[key] = value;
     }
     return changed;
@@ -163,21 +160,22 @@ function mergeVariants(
     if (!Object.hasOwn(source, key)) continue;
     if (skipKeys.has(key)) continue;
     const value = source[key];
-    if (!Object.is(target[key], value)) changed = true;
+    if (!Object.is(target[key], value)) {
+      changed = true;
+    }
     target[key] = value;
   }
   return changed;
 }
 
-// Dynamic property access on function requires cast through unknown.
+// Components carry internal metadata on a non-public property so user-facing
+// component types stay clean.
 function getComponentMeta(component: AnyComponent): ComponentMeta | undefined {
-  return (component as unknown as Record<string, unknown>)[META_KEY] as
-    | ComponentMeta
-    | undefined;
+  return (component as AnyComponent & ComponentWithMeta)[META_KEY];
 }
 
 function setComponentMeta(component: AnyComponent, meta: ComponentMeta): void {
-  (component as unknown as Record<string, unknown>)[META_KEY] = meta;
+  (component as AnyComponent & ComponentWithMeta)[META_KEY] = meta;
 }
 
 export type {
@@ -321,9 +319,15 @@ function isVariantDisabled(
 }
 
 function getVariantValueKey(value: unknown): string | undefined {
-  if (typeof value === "string") return value;
-  if (typeof value === "number") return String(value);
-  if (typeof value === "boolean") return String(value);
+  if (typeof value === "string") {
+    return value;
+  }
+  if (typeof value === "number") {
+    return String(value);
+  }
+  if (typeof value === "boolean") {
+    return String(value);
+  }
   return undefined;
 }
 
@@ -343,7 +347,9 @@ function collectDisabledVariantKeys(
   config: CVConfig<Variants, AnyComponent[]>,
 ): Set<string> {
   const keys = new Set<string>();
-  if (!config.variants) return keys;
+  if (!config.variants) {
+    return keys;
+  }
   for (const key in config.variants) {
     if (!Object.hasOwn(config.variants, key)) continue;
     if ((config.variants as Record<string, unknown>)[key] === null) {
@@ -357,7 +363,9 @@ function collectDisabledVariantValues(
   config: CVConfig<Variants, AnyComponent[]>,
 ): Record<string, Set<string>> {
   const values: Record<string, Set<string>> = {};
-  if (!config.variants) return values;
+  if (!config.variants) {
+    return values;
+  }
   for (const key in config.variants) {
     if (!Object.hasOwn(config.variants, key)) continue;
     const variant = (config.variants as Record<string, unknown>)[key];
@@ -397,14 +405,22 @@ function normalizeKeySource(source: unknown): NormalizedSource {
     };
   }
 
-  if (!source) return EMPTY_SOURCE;
+  if (!source) {
+    return EMPTY_SOURCE;
+  }
   if (typeof source !== "object" && typeof source !== "function") {
     return EMPTY_SOURCE;
   }
   const typed = source as Record<string, unknown>;
-  if (typeof typed.getVariants !== "function") return EMPTY_SOURCE;
-  if (!Array.isArray(typed.propKeys)) return EMPTY_SOURCE;
-  if (!Array.isArray(typed.variantKeys)) return EMPTY_SOURCE;
+  if (typeof typed.getVariants !== "function") {
+    return EMPTY_SOURCE;
+  }
+  if (!Array.isArray(typed.propKeys)) {
+    return EMPTY_SOURCE;
+  }
+  if (!Array.isArray(typed.variantKeys)) {
+    return EMPTY_SOURCE;
+  }
 
   return {
     propKeys: typed.propKeys as string[],
@@ -540,7 +556,9 @@ function buildPrebuiltVariant(variantDef: unknown): PrebuiltVariant {
     if (!Object.hasOwn(variantDef, key)) continue;
     const value = variantDef[key];
     if (value === null) {
-      if (!disabledValues) disabledValues = new Set<string>();
+      if (!disabledValues) {
+        disabledValues = new Set<string>();
+      }
       disabledValues.add(key);
       continue;
     }
@@ -619,7 +637,9 @@ export function create({
     if (extend) {
       for (const ext of extend) {
         const meta = getComponentMeta(ext);
-        if (meta) Object.assign(staticDefaults, meta.staticDefaults);
+        if (meta) {
+          Object.assign(staticDefaults, meta.staticDefaults);
+        }
       }
     }
     if (variants) {
@@ -700,6 +720,18 @@ export function create({
     const extMetasWithRefineCount = extMetasWithRefine.length;
     const shouldCollectChangedVariants = extMetasWithRefineCount > 0;
 
+    // Call-site frame captured at the `cv()` call site so refine-limit warnings
+    // can point developers at the component definition. Skipped entirely for
+    // components that can never enter the refine loop, and stripped in
+    // production via the NODE_ENV guard inside `captureCreationFrame`. The
+    // frame is captured at creation time but the underlying `.stack` string is
+    // formatted lazily on first access, so component creation stays cheap
+    // unless the warning actually fires.
+    const canTriggerRefineWarning = !!refine || extMetasWithRefineCount > 0;
+    const creationFrame = canTriggerRefineWarning
+      ? captureCreationFrame(cv)
+      : undefined;
+
     // Function variant keys inherited from extends, filtered through this
     // component's own variants: a static (object/shorthand) variant in this
     // component replaces an inherited function variant for the same key.
@@ -753,7 +785,9 @@ export function create({
       staticVariantsOverridingExtFn !== null
     ) {
       staticExtSkipKeys = new Set<string>();
-      for (const k of disabledVariantKeys) staticExtSkipKeys.add(k);
+      for (const k of disabledVariantKeys) {
+        staticExtSkipKeys.add(k);
+      }
       for (let i = 0; i < functionVariantCount; i++) {
         staticExtSkipKeys.add(functionVariantNames[i]);
       }
@@ -777,7 +811,9 @@ export function create({
     ): void {
       if (!hasAnyDisabled) {
         for (const key in input) {
-          if (Object.hasOwn(input, key)) out[key] = input[key];
+          if (Object.hasOwn(input, key)) {
+            out[key] = input[key];
+          }
         }
         return;
       }
@@ -901,7 +937,9 @@ export function create({
         defaults[k] = v;
       }
 
-      if (!hasAnyDisabled) return defaults;
+      if (!hasAnyDisabled) {
+        return defaults;
+      }
 
       // Filter disabled
       const result: Record<string, unknown> = {};
@@ -938,7 +976,9 @@ export function create({
           const filteredVariants: Record<string, unknown> = {};
           for (let i = 0; i < variantKeysLength; i++) {
             const k = variantKeys[i];
-            if (Object.hasOwn(resolved, k)) filteredVariants[k] = resolved[k];
+            if (Object.hasOwn(resolved, k)) {
+              filteredVariants[k] = resolved[k];
+            }
           }
           ownVariants = filteredVariants;
         }
@@ -949,7 +989,9 @@ export function create({
         const localCClasses: ClassValue[] | null = collectOutput ? [] : null;
         let localCStyle: StyleValue | null = null;
         const ensureUpdated = (): Record<string, unknown> => {
-          if (updatedVariants) return updatedVariants;
+          if (updatedVariants) {
+            return updatedVariants;
+          }
           const u: Record<string, unknown> = {};
           Object.assign(u, ownVariants);
           updatedVariants = u;
@@ -961,7 +1003,9 @@ export function create({
           protect = false,
         ) => {
           if (shouldCollectChangedVariants) {
-            if (!changedVariants) changedVariants = {};
+            if (!changedVariants) {
+              changedVariants = {};
+            }
             changedVariants[key] = value;
           }
           if (protect && protectedVariants) {
@@ -982,7 +1026,7 @@ export function create({
                 if (!Object.hasOwn(newVariants, key)) continue;
                 const value = (newVariants as Record<string, unknown>)[key];
                 setChangedVariant(key, value, true);
-                if (getCurrentVariantValue(key) === value) continue;
+                if (Object.is(getCurrentVariantValue(key), value)) continue;
                 ensureUpdated()[key] = value;
               }
               return;
@@ -1001,7 +1045,7 @@ export function create({
                 }
               }
               setChangedVariant(key, value, true);
-              if (getCurrentVariantValue(key) === value) continue;
+              if (Object.is(getCurrentVariantValue(key), value)) continue;
               ensureUpdated()[key] = value;
             }
           },
@@ -1023,11 +1067,11 @@ export function create({
                   continue;
                 }
               }
+              if (Object.is(getCurrentVariantValue(key), value)) continue;
               setChangedVariant(key, value);
               if (pendingProtectedVariants) {
                 pendingProtectedVariants[key] = value;
               }
-              if (getCurrentVariantValue(key) === value) continue;
               ensureUpdated()[key] = value;
             }
           },
@@ -1036,16 +1080,22 @@ export function create({
           },
           addStyle: (newStyle: StyleValue) => {
             if (!collectOutput) return;
-            if (!localCStyle) localCStyle = {};
+            if (!localCStyle) {
+              localCStyle = {};
+            }
             Object.assign(localCStyle, newStyle);
           },
         };
         const result = refine(ctx);
         if (collectOutput && result != null) {
           const r = extractClassAndStylePrebuilt(result);
-          if (r.class != null) localCClasses?.push(r.class);
+          if (r.class != null) {
+            localCClasses?.push(r.class);
+          }
           if (r.style) {
-            if (!localCStyle) localCStyle = {};
+            if (!localCStyle) {
+              localCStyle = {};
+            }
             Object.assign(localCStyle, r.style);
           }
         }
@@ -1129,7 +1179,9 @@ export function create({
           extSkipKeys = skipKeys;
         } else {
           extSkipKeys = new Set(skipKeys);
-          for (const k of staticExtSkipKeys) extSkipKeys.add(k);
+          for (const k of staticExtSkipKeys) {
+            extSkipKeys.add(k);
+          }
         }
 
         let extSkipVals: Record<string, Set<string>> | null;
@@ -1146,7 +1198,9 @@ export function create({
             const existing = extSkipVals[k];
             if (existing) {
               const merged = new Set<string>(existing);
-              for (const v of staticExtSkipValues[k]) merged.add(v);
+              for (const v of staticExtSkipValues[k]) {
+                merged.add(v);
+              }
               extSkipVals[k] = merged;
             } else {
               extSkipVals[k] = staticExtSkipValues[k];
@@ -1211,7 +1265,9 @@ export function create({
       }
 
       // Apply own base style (after extends' styles, matching original order).
-      if (hasBaseStyle) Object.assign(styleOut, baseStyle);
+      if (hasBaseStyle) {
+        Object.assign(styleOut, baseStyle);
+      }
 
       // Apply own variants. Skip keys/values come from caller (e.g., parent
       // wants its own function variant to override this variant).
@@ -1246,12 +1302,20 @@ export function create({
           if (selectedKey == null) continue;
           const v = variant.values[selectedKey];
           if (!v) continue;
-          if (v.class != null) classesOut.push(v.class as ClsxClassValue);
-          if (v.style) Object.assign(styleOut, v.style);
+          if (v.class != null) {
+            classesOut.push(v.class as ClsxClassValue);
+          }
+          if (v.style) {
+            Object.assign(styleOut, v.style);
+          }
         } else if (variant.shorthand && selectedValue === true) {
           const v = variant.shorthand;
-          if (v.class != null) classesOut.push(v.class as ClsxClassValue);
-          if (v.style) Object.assign(styleOut, v.style);
+          if (v.class != null) {
+            classesOut.push(v.class as ClsxClassValue);
+          }
+          if (v.style) {
+            Object.assign(styleOut, v.style);
+          }
         }
       }
 
@@ -1275,8 +1339,12 @@ export function create({
         const computedResult = fn(selectedValue);
         if (computedResult == null) continue;
         const r = extractClassAndStylePrebuilt(computedResult);
-        if (r.class != null) classesOut.push(r.class as ClsxClassValue);
-        if (r.style) Object.assign(styleOut, r.style);
+        if (r.class != null) {
+          classesOut.push(r.class as ClsxClassValue);
+        }
+        if (r.style) {
+          Object.assign(styleOut, r.style);
+        }
       }
 
       // Apply `refine` results — must come after own variants (static and
@@ -1286,38 +1354,16 @@ export function create({
           classesOut.push(cClasses[i] as ClsxClassValue);
         }
       }
-      if (cStyle) Object.assign(styleOut, cStyle);
+      if (cStyle) {
+        Object.assign(styleOut, cStyle);
+      }
 
       return workingResolved;
     };
 
     const compute: ComputeFn =
       !refine && extMetasWithRefineCount === 0
-        ? (
-            resolved,
-            userVariantProps,
-            skipKeys,
-            skipValues,
-            classesOut,
-            styleOut,
-            runState,
-            protectedVariants,
-            pendingProtectedVariants,
-            protectedVariantKeys,
-          ) => {
-            return computeOnce(
-              resolved,
-              userVariantProps,
-              skipKeys,
-              skipValues,
-              classesOut,
-              styleOut,
-              runState,
-              protectedVariants,
-              pendingProtectedVariants,
-              protectedVariantKeys,
-            );
-          }
+        ? computeOnce
         : (
             resolved,
             userVariantProps,
@@ -1330,10 +1376,13 @@ export function create({
             pendingProtectedVariants,
             protectedVariantKeys,
           ) => {
-            runState ??= { remaining: MAX_REFINE_RUNS, warned: false };
+            runState ??= { remaining: MAX_REFINE_RUNS };
             protectedVariants ??= {};
             protectedVariantKeys ??= new Set<string>();
             let workingResolved = resolved;
+            // Latest variant changes from non-converging iterations inside the
+            // tracking window. Lazy-init keeps convergent loops allocation-free.
+            let unstableChanges: Map<string, VariantChange> | null = null;
             let lastClasses: ClsxClassValue[] = [];
             let lastStyle: StyleValue = {};
             let isFirstRun = true;
@@ -1397,10 +1446,28 @@ export function create({
                 return nextResolved;
               }
 
+              if (
+                process.env.NODE_ENV !== "production" &&
+                runState.remaining < REFINE_UNSTABLE_TRACKING_WINDOW
+              ) {
+                if (!unstableChanges) {
+                  unstableChanges = new Map<string, VariantChange>();
+                }
+                accumulateUnstableVariantChanges(
+                  unstableChanges,
+                  workingResolved,
+                  nextResolved,
+                );
+              }
+
               if (useDirectOutput && runState.remaining === 0) {
                 // Keep the direct output from the last allowed run. Rolling
                 // back here would drop it before the fallback copy below.
-                warnRefineLimit(runState);
+                warnRefineLimit({
+                  runState,
+                  creationFrame,
+                  unstableChanges,
+                });
                 return nextResolved;
               }
 
@@ -1420,7 +1487,11 @@ export function create({
               isFirstRun = false;
             }
 
-            warnRefineLimit(runState);
+            warnRefineLimit({
+              runState,
+              creationFrame,
+              unstableChanges,
+            });
 
             for (let i = 0; i < lastClasses.length; i++) {
               classesOut.push(lastClasses[i]);
@@ -1493,10 +1564,14 @@ export function create({
             pendingProtectedVariants,
             protectedVariantKeys,
           ) => {
-            runState ??= { remaining: MAX_REFINE_RUNS, warned: false };
+            runState ??= { remaining: MAX_REFINE_RUNS };
             protectedVariants ??= {};
             protectedVariantKeys ??= new Set<string>();
             let workingResolved = resolved;
+            // Latest variant changes from non-converging iterations inside the
+            // tracking window. See the compute loop above for the shared
+            // rationale.
+            let unstableChanges: Map<string, VariantChange> | null = null;
             let reachedLimit = true;
 
             while (runState.remaining > 0) {
@@ -1536,11 +1611,28 @@ export function create({
                 break;
               }
 
+              if (
+                process.env.NODE_ENV !== "production" &&
+                runState.remaining < REFINE_UNSTABLE_TRACKING_WINDOW
+              ) {
+                if (!unstableChanges) {
+                  unstableChanges = new Map<string, VariantChange>();
+                }
+                accumulateUnstableVariantChanges(
+                  unstableChanges,
+                  workingResolved,
+                  nextResolved,
+                );
+              }
               workingResolved = nextResolved;
             }
 
             if (reachedLimit) {
-              warnRefineLimit(runState);
+              warnRefineLimit({
+                runState,
+                creationFrame,
+                unstableChanges,
+              });
             }
 
             return workingResolved;

package/src/refine-warning.ts

@@ -0,0 +1,161 @@
+export interface RefineRunState {
+  remaining: number;
+  warned?: boolean;
+}
+
+export interface CreationFrame {
+  stack?: string;
+}
+
+export interface VariantChange {
+  from: unknown;
+  to: unknown;
+}
+
+// Once a refine loop is within this many iterations of the cap, start tracking
+// the latest value transition for every variant key that changes between
+// iterations so the warning can report every key that contributed to the
+// oscillation, not just the keys that happened to flip on the final step.
+// Convergent loops (the common case) exit well before this threshold and pay no
+// per-iteration tracking cost.
+export const REFINE_UNSTABLE_TRACKING_WINDOW = 10;
+
+// Captures the call site of the function passed in `skipFn` so refine-limit
+// warnings can point developers at the originating `cv()` call. Returns
+// `undefined` in production so bundlers that replace `process.env.NODE_ENV` at
+// build time can drop the entire warning machinery. The underlying `.stack`
+// string is formatted lazily on first access in every major engine (V8,
+// SpiderMonkey, JavaScriptCore), so holding the captured frame for the
+// lifetime of the component is cheap when no warning fires.
+export function captureCreationFrame(
+  skipFn: Function,
+): CreationFrame | undefined {
+  if (process.env.NODE_ENV === "production") return undefined;
+  if (typeof Error.captureStackTrace === "function") {
+    const holder: CreationFrame = {};
+    Error.captureStackTrace(holder, skipFn);
+    return holder;
+  }
+  // Engines without `Error.captureStackTrace` (SpiderMonkey, JavaScriptCore)
+  // can't strip internal frames, but their `Error.stack` getter is still
+  // lazy, so returning the Error instance defers the format cost. The
+  // resulting trace includes 1–2 extra frames at the top from this helper and
+  // `cv` itself.
+  return new Error();
+}
+
+export function formatCreationStack(frame: CreationFrame): string | undefined {
+  let stack = frame.stack;
+  if (!stack) return undefined;
+  // V8 prefixes the stack with a leading "Error" / "Error: message" line that
+  // isn't meaningful for a captured location — drop it.
+  const newlineIdx = stack.indexOf("\n");
+  if (newlineIdx > 0) {
+    const firstLine = stack.slice(0, newlineIdx);
+    if (firstLine === "Error" || firstLine.startsWith("Error:")) {
+      stack = stack.slice(newlineIdx + 1);
+    }
+  }
+  const frames = stack.split("\n");
+  for (let i = 0; i < frames.length; i++) {
+    const line = frames[i]?.trim();
+    if (!line) continue;
+    if (isInternalCreationFrame(line)) continue;
+    if (line.includes("/node_modules/")) continue;
+    if (line.includes("\\node_modules\\")) continue;
+    if (line.includes("node:internal")) continue;
+    return `    ${line}`;
+  }
+  return undefined;
+}
+
+function isInternalCreationFrame(line: string): boolean {
+  if (line.includes("captureCreationFrame")) return true;
+  if (line.startsWith("at cv ")) return true;
+  if (line.startsWith("at cv(")) return true;
+  if (line.startsWith("cv@")) return true;
+  return false;
+}
+
+function formatVariantValue(value: unknown): string {
+  if (typeof value === "string") return JSON.stringify(value);
+  if (typeof value === "number") {
+    if (Number.isNaN(value)) return "NaN";
+    return String(value);
+  }
+  if (typeof value === "bigint") return `${value}n`;
+  if (value === undefined) return "undefined";
+  if (value === null) return "null";
+  if (typeof value === "boolean") return String(value);
+  if (typeof value === "symbol") return String(value);
+  if (typeof value === "function") return "[function]";
+  return "[object]";
+}
+
+function setVariantChange(
+  into: Map<string, VariantChange>,
+  key: string,
+  from: unknown,
+  to: unknown,
+): void {
+  into.set(key, { from, to });
+}
+
+export function accumulateUnstableVariantChanges(
+  into: Map<string, VariantChange>,
+  prev: Record<string, unknown>,
+  next: Record<string, unknown>,
+): void {
+  for (const key in next) {
+    if (!Object.hasOwn(next, key)) continue;
+    if (!Object.is(prev[key], next[key])) {
+      setVariantChange(into, key, prev[key], next[key]);
+    }
+  }
+  for (const key in prev) {
+    if (!Object.hasOwn(prev, key)) continue;
+    if (Object.hasOwn(next, key)) continue;
+    setVariantChange(into, key, prev[key], undefined);
+  }
+}
+
+function formatVariantChanges(changes: Map<string, VariantChange>): string {
+  return Array.from(changes)
+    .map(([key, { from, to }]) => {
+      return `${key}: ${formatVariantValue(from)} -> ${formatVariantValue(to)}`;
+    })
+    .join(", ");
+}
+
+interface WarnRefineLimitParams {
+  runState: RefineRunState;
+  creationFrame: CreationFrame | undefined;
+  unstableChanges: Map<string, VariantChange> | null;
+}
+
+export function warnRefineLimit({
+  runState,
+  creationFrame,
+  unstableChanges,
+}: WarnRefineLimitParams): void {
+  // Bundlers are expected to replace this branch with a production literal,
+  // allowing warning-only code below to be removed from consumer bundles.
+  if (process.env.NODE_ENV === "production") return;
+  if (runState.warned) return;
+  runState.warned = true;
+  let message =
+    "Clava: Maximum refine iterations exceeded. This can happen when a " +
+    "refine callback calls setVariants or setDefaultVariants, but one " +
+    "of the variants changes on every run.";
+  if (unstableChanges && unstableChanges.size > 0) {
+    message += `\nVariant(s) that did not stabilize: ${Array.from(unstableChanges.keys()).join(", ")}.`;
+    message += `\nLatest variant changes before warning: ${formatVariantChanges(unstableChanges)}.`;
+  }
+  if (creationFrame) {
+    const creationStack = formatCreationStack(creationFrame);
+    if (creationStack) {
+      message += `\nComponent created at:\n${creationStack}`;
+    }
+  }
+  console.warn(message);
+}