@tamagui/static 1.132.15 → 1.132.16-1754534218765

package/src/extractor/extractToClassNames.ts

@@ -1,31 +1,19 @@
-import * as path from 'node:path'
-import * as util from 'node:util'
-
 import generate from '@babel/generator'
+import type { NodePath } from '@babel/traverse'
 import * as t from '@babel/types'
-import * as helpers from '@tamagui/helpers'
-import type { ViewStyle } from 'react-native'
-
+import { StyleObjectIdentifier, StyleObjectRules } from '@tamagui/web'
+import * as path from 'node:path'
+import * as util from 'node:util'
 import { requireTamaguiCore } from '../helpers/requireTamaguiCore'
-import type { ClassNameObject, StyleObject, TamaguiOptions, Ternary } from '../types'
+import type { StyleObject, TamaguiOptions, Ternary } from '../types'
 import { babelParse } from './babelParse'
-import { buildClassName } from './buildClassName'
 import type { Extractor } from './createExtractor'
 import { createLogger } from './createLogger'
-import { ensureImportingConcat } from './ensureImportingConcat'
-import { isSimpleSpread } from './extractHelpers'
 import { extractMediaStyle } from './extractMediaStyle'
-import { hoistClassNames } from './hoistClassNames'
+import { normalizeTernaries } from './normalizeTernaries'
 import { getFontFamilyClassNameFromProps } from './propsToFontFamilyCache'
 import { timer } from './timer'
 
-const mergeStyleGroups = {
-  shadowOpacity: true,
-  shadowRadius: true,
-  shadowColor: true,
-  shadowOffset: true,
-}
-
 export type ExtractedResponse = {
   js: string | Buffer
   styles: string
@@ -42,6 +30,12 @@ export type ExtractToClassNamesProps = {
   shouldPrintDebug: boolean | 'verbose'
 }
 
+// we only expand into ternaries or plain attr, all style is turned into a always-true ternary
+// this lets us more easily combine everything easily
+// all ternaries in this array ONLY have consequent, they are normalized
+const remove = () => {} // we dont remove after this step
+const spaceString = t.stringLiteral(' ')
+
 export async function extractToClassNames({
   extractor,
   source,
@@ -50,7 +44,7 @@ export async function extractToClassNames({
   shouldPrintDebug,
 }: ExtractToClassNamesProps): Promise<ExtractedResponse | null> {
   const tm = timer()
-  const { getCSSStylesAtomic } = requireTamaguiCore('web')
+  const { getCSSStylesAtomic, mergeProps, createMediaStyle } = requireTamaguiCore('web')
 
   if (sourcePath.includes('node_modules')) {
     return null
@@ -93,9 +87,7 @@ export async function extractToClassNames({
   tm.mark(`babel-parse`, shouldPrintDebug === 'verbose')
 
   const cssMap = new Map<string, { css: string; commentTexts: string[] }>()
-  const existingHoists: { [key: string]: t.Identifier } = {}
-
-  let hasFlattened = false
+  const tamaguiConfig = extractor.getTamagui()!
 
   const res = await extractor.parse(ast, {
     shouldPrintDebug,
@@ -103,7 +95,7 @@ export async function extractToClassNames({
     platform: 'web',
     sourcePath,
     extractStyledDefinitions: true,
-    onStyleRule(identifier, rules) {
+    onStyledDefinitionRule(identifier, rules) {
       const css = rules.join(';')
       if (shouldPrintDebug) {
         console.info(`adding styled() rule: .${identifier} ${css}`)
@@ -111,7 +103,6 @@ export async function extractToClassNames({
       cssMap.set(`.${identifier}`, { css, commentTexts: [] })
     },
     getFlattenedNode: ({ tag }) => {
-      hasFlattened = true
       return tag
     },
     onExtractTag: ({
@@ -123,8 +114,6 @@ export async function extractToClassNames({
       originalNodeName,
       filePath,
       lineNumbers,
-      programPath,
-      isFlattened,
       staticConfig,
     }) => {
       // bail out of views that don't accept className (falls back to runtime + style={})
@@ -135,288 +124,330 @@ export async function extractToClassNames({
         return
       }
 
-      // reset hasFlattened
-      const didFlattenThisTag = hasFlattened
-      hasFlattened = false
+      // re-worked how we do this
+      // merging ternaries on top of base styles is not simple, because we need to ensure the final
+      // className has no duplicate style props and selector order is preserved
+      // before we tried to be smart and build a big binary expression
+      // instead, what we'll do now is pre-calculate the entire className for every possible path
+      // for super complex components that means we *will* output a lot of bigger classNames
+      // but its so much simpler than trying to implement a multi-stage solver here
+      // and in the end its just strings that gzip very well
+      // its also much easier to intuit/debug for end users and ourselves
+
+      // example:
+      //    a ? 'a' : 'b'
+      //    b ? 'c' : 'd'
+      // we want:
+      //    a && b ? 'a c' : ''
+      //    !a && b ? 'b c' : ''
+      //    a && !b ? 'a d' : ''
+      //    !a && !b ? 'b d' : ''
+
+      // we also simplified the compiler to only handle views that can be fully flattened
+      // this means we don't need to account for strange in-between spreads, so we can merge things
+      // fairly simply. first, we just merge forward all the non-ternary styles into ternaries.
+
+      // save for the end
+      const finalAttrs: t.JSXAttribute[] = []
+
+      let mergeForwardBaseStyle: Object | null = null
+      let attrClassName: t.Expression | null = null
+      let baseFontFamily = ''
+      let mediaStylesSeen = 1
 
-      let finalClassNames: ClassNameObject[] = []
-      const finalAttrs: (t.JSXAttribute | t.JSXSpreadAttribute)[] = []
-      let finalStyles: StyleObject[] = []
+      const comment = util.format(
+        '/* %s:%s (%s) */',
+        filePath,
+        lineNumbers,
+        originalNodeName
+      )
 
-      let viewStyles = {}
-      for (const attr of attrs) {
-        if (attr.type === 'style') {
-          viewStyles = {
-            ...viewStyles,
-            ...attr.value,
-          }
+      function addStyle(style: StyleObject) {
+        const identifier = style[StyleObjectIdentifier]
+        const rules = style[StyleObjectRules]
+        const selector = `.${identifier}`
+        if (cssMap.has(selector)) {
+          const val = cssMap.get(selector)!
+          val.commentTexts.push(comment)
+        } else if (rules.length) {
+          cssMap.set(selector, {
+            css: rules.join('\n'),
+            commentTexts: [comment],
+          })
         }
+        return identifier
       }
 
-      const ensureNeededPrevStyle = (style: ViewStyle) => {
-        // ensure all group keys are merged
-        const keys = Object.keys(style)
-        if (!keys.some((key) => mergeStyleGroups[key])) {
-          return style
-        }
-        for (const k in mergeStyleGroups) {
-          if (k in viewStyles) {
-            style[k] = style[k] ?? viewStyles[k]
+      function addStyles(style: Object) {
+        const cssStyles = getCSSStylesAtomic(style as any)
+        const classNames: string[] = []
+
+        for (const style of cssStyles) {
+          const mediaName = style[0].slice(1)
+          if (tamaguiConfig.media[mediaName]) {
+            const mediaStyle = createMediaStyle(
+              style,
+              mediaName,
+              extractor.getTamagui()!.media,
+              true,
+              false,
+              mediaStylesSeen
+            )
+            const identifier = addStyle(mediaStyle)
+            classNames.push(identifier)
+            continue
           }
-        }
-        return style
-      }
 
-      const addStyles = (style: ViewStyle | null): StyleObject[] => {
-        if (!style) return []
-        const styleWithPrev = ensureNeededPrevStyle(style)
-        const res = getCSSStylesAtomic(styleWithPrev as any)
-        if (res.length) {
-          finalStyles = [...finalStyles, ...res]
+          const identifier = addStyle(style)
+          classNames.push(identifier)
         }
-        return res
+
+        return classNames
       }
 
-      // 1 to start above any :hover styles
-      let lastMediaImportance = 1
-      for (const attr of attrs) {
-        switch (attr.type) {
-          case 'style': {
-            if (!isFlattened) {
-              const styles = getCSSStylesAtomic(attr.value as any)
-
-              finalStyles = [...finalStyles, ...styles]
-
-              for (const style of styles) {
-                //  leave them  as attributes
-                const prop = style[helpers.StyleObjectPseudo]
-                  ? `${style[helpers.StyleObjectProperty]}-${
-                      style[helpers.StyleObjectPseudo]
-                    }`
-                  : style[helpers.StyleObjectProperty]
-                finalAttrs.push(
-                  t.jsxAttribute(
-                    t.jsxIdentifier(prop),
-                    t.stringLiteral(style[helpers.StyleObjectIdentifier])
-                  )
-                )
-              }
-            } else {
-              const styles = addStyles(attr.value)
-              const newFontFamily = getFontFamilyClassNameFromProps(attr.value) || ''
-              const newClassNames = helpers.concatClassName(
-                styles.map((x) => x[helpers.StyleObjectIdentifier]).join(' ') +
-                  newFontFamily
-              )
-              const existing = finalClassNames.find(
-                (x) => x.type == 'StringLiteral'
-              ) as t.StringLiteral | null
-
-              if (existing) {
-                let previous = existing.value
-                // replace existing font_ with new one
-                if (newFontFamily) {
-                  if (shouldPrintDebug) {
-                    console.info(` newFontFamily: ${newFontFamily}`)
-                  }
-                  previous = previous.replace(/font_[a-z]+/i, '')
-                }
-                existing.value = `${previous} ${newClassNames}`
-              } else {
-                finalClassNames = [...finalClassNames, t.stringLiteral(newClassNames)]
-              }
-            }
+      const onlyTernaries: Ternary[] = attrs.flatMap((attr) => {
+        if (attr.type === 'attr') {
+          const value = attr.value
 
-            break
+          if (t.isJSXSpreadAttribute(value)) {
+            // we only handle flattened stuff now so skip this
+            console.error(`Should never happen`)
+            return []
           }
-          case 'attr': {
-            const val = attr.value
-            if (t.isJSXSpreadAttribute(val)) {
-              if (isSimpleSpread(val)) {
-                finalClassNames.push(
-                  t.logicalExpression(
-                    '&&',
-                    val.argument,
-                    t.memberExpression(val.argument, t.identifier('className'))
-                  )
-                )
-              }
-            } else if (val.name.name === 'className') {
-              const value = val.value
-              if (value) {
-                try {
-                  const evaluatedValue = attemptEval(value)
-                  finalClassNames.push(t.stringLiteral(evaluatedValue))
-                } catch (e) {
-                  finalClassNames.push(value['expression'])
-                }
-              }
-              continue
+
+          if (value.name.name === 'className') {
+            let inner: any = value.value
+            if (t.isJSXExpressionContainer(inner)) {
+              inner = inner.expression
             }
-            finalAttrs.push(val)
-            break
-          }
-          case 'ternary': {
-            const mediaExtraction = extractMediaStyle(
-              parserProps,
-              attr.value,
-              jsxPath,
-              extractor.getTamagui()!,
-              sourcePath || '',
-              lastMediaImportance,
-              shouldPrintDebug
-            )
-            if (shouldPrintDebug) {
-              if (mediaExtraction) {
-                console.info(
-                  'ternary (mediaStyles)',
-                  mediaExtraction.ternaryWithoutMedia?.inlineMediaQuery ?? '',
-                  mediaExtraction.mediaStyles
-                    .map((x) => x[helpers.StyleObjectIdentifier])
-                    .join('.')
-                )
+            try {
+              const evaluatedValue = inner ? attemptEval(inner) : null
+              if (typeof evaluatedValue === 'string') {
+                attrClassName = t.stringLiteral(evaluatedValue)
               }
-            }
-            if (!mediaExtraction) {
-              if (shouldPrintDebug) {
-                if (mediaExtraction) {
-                  console.info('add ternary')
-                }
+            } catch (e) {
+              if (inner) {
+                attrClassName ||= inner
               }
-              addTernaryStyle(
-                attr.value,
-                addStyles(attr.value.consequent),
-                addStyles(attr.value.alternate)
-              )
-              continue
             }
-            lastMediaImportance++
+            return []
+          }
+
+          finalAttrs.push(value)
+          return []
+        }
+
+        if (attr.type === 'style') {
+          mergeForwardBaseStyle = mergeProps(mergeForwardBaseStyle || {}, attr.value)
+          baseFontFamily = getFontFamilyClassNameFromProps(attr.value) || ''
+          return []
+        }
+
+        let ternary = attr.value
+
+        if (ternary.inlineMediaQuery) {
+          const mediaExtraction = extractMediaStyle(
+            parserProps,
+            attr.value,
+            jsxPath,
+            extractor.getTamagui()!,
+            sourcePath || '',
+            mediaStylesSeen++,
+            shouldPrintDebug
+          )
+
+          if (mediaExtraction) {
             if (mediaExtraction.mediaStyles) {
-              finalStyles = [...finalStyles, ...mediaExtraction.mediaStyles]
+              mergeForwardBaseStyle = mergeProps(mergeForwardBaseStyle || {}, {
+                [`$${ternary.inlineMediaQuery}`]: attr.value.consequent!,
+              })
             }
             if (mediaExtraction.ternaryWithoutMedia) {
-              addTernaryStyle(
-                mediaExtraction.ternaryWithoutMedia,
-                mediaExtraction.mediaStyles,
-                []
-              )
+              ternary = mediaExtraction.ternaryWithoutMedia
             } else {
-              finalClassNames = [
-                ...finalClassNames,
-                ...mediaExtraction.mediaStyles.map((x) =>
-                  t.stringLiteral(x[helpers.StyleObjectIdentifier])
-                ),
-              ]
+              return []
             }
-            break
           }
         }
+
+        // merge the base style forward into both sides
+        return {
+          ...ternary,
+          fontFamily: baseFontFamily,
+          alternate: mergeProps(mergeForwardBaseStyle || {}, ternary.alternate || {}),
+          consequent: mergeProps(mergeForwardBaseStyle || {}, ternary.consequent || {}),
+        }
+      })
+
+      const hasTernaries = Boolean(onlyTernaries.length)
+
+      const baseClassNames = mergeForwardBaseStyle
+        ? addStyles(mergeForwardBaseStyle)
+        : null
+
+      let baseClassNameStr =
+        hasTernaries || !baseClassNames ? '' : ` ${baseClassNames.join(' ')}`
+
+      if (!hasTernaries && baseFontFamily) {
+        baseClassNameStr = `font_${baseFontFamily} ${baseClassNameStr}`
       }
 
-      function addTernaryStyle(ternary: Ternary, a: StyleObject[], b: StyleObject[]) {
-        const cCN = a.map((x) => x[helpers.StyleObjectIdentifier]).join(' ')
-        const aCN = b.map((x) => x[helpers.StyleObjectIdentifier]).join(' ')
+      let base = staticConfig.componentName
+        ? t.stringLiteral(`is_${staticConfig.componentName}${baseClassNameStr}`)
+        : t.stringLiteral(baseClassNameStr || ' ')
 
-        if (a.length && b.length) {
-          finalClassNames.push(
-            t.conditionalExpression(
-              ternary.test,
-              t.stringLiteral(cCN),
-              t.stringLiteral(aCN)
+      attrClassName = attrClassName as t.Expression | null // actual typescript bug, flatMap doesn't update from never
+
+      const baseClassNameExpression: t.Expression = (() => {
+        if (attrClassName) {
+          if (t.isStringLiteral(attrClassName)) {
+            return t.stringLiteral(
+              base.value ? `${base.value} ${attrClassName.value}` : attrClassName.value
             )
-          )
-        } else {
-          finalClassNames.push(
-            t.conditionalExpression(
-              ternary.test,
-              t.stringLiteral(' ' + cCN),
-              t.stringLiteral(' ' + aCN)
+          } else {
+            // space after to ensure its a string and its spaced
+            return t.conditionalExpression(
+              attrClassName,
+              t.binaryExpression('+', attrClassName, spaceString),
+              base
             )
-          )
+          }
         }
-      }
+        return base
+      })()
 
-      if (shouldPrintDebug === 'verbose') {
-        console.info('  finalClassNames AST\n', JSON.stringify(finalClassNames, null, 2))
-      }
+      const expandedTernaries: Ternary[] = []
 
-      node.attributes = finalAttrs
+      if (onlyTernaries.length) {
+        // normalize tests to reduce duplicates
+        const normalizedTernaries = normalizeTernaries(onlyTernaries)
 
-      if (finalClassNames.length) {
-        const extraClassNames = (() => {
-          let value = ''
-          if (!isFlattened) {
-            return value
+        for (const ternary of normalizedTernaries) {
+          if (!expandedTernaries.length) {
+            expandTernary(ternary)
+            continue
           }
-
-          // helper to see how many get flattened
-          if (process.env.TAMAGUI_DEBUG_OPTIMIZATIONS) {
-            value += `is_tamagui_flattened`
+          for (const prev of [...expandedTernaries]) {
+            expandTernary(ternary, prev)
           }
+        }
+      }
 
-          // add is_Component className
-          if (staticConfig.componentName) {
-            value += ` is_${staticConfig.componentName}`
+      function expandTernary(ternary: Ternary, prev?: Ternary) {
+        // need to diverge into two (or four if alternate)
+        if (ternary.consequent && Object.keys(ternary.consequent).length) {
+          expandedTernaries.push({
+            // prevTest && test: merge consequent
+            test: prev
+              ? t.logicalExpression('&&', prev.test, ternary.test)
+              : ternary.test,
+            consequent: prev
+              ? mergeProps(prev.consequent!, ternary.consequent)
+              : ternary.consequent,
+            remove,
+            alternate: null,
+          })
+
+          if (prev) {
+            expandedTernaries.push({
+              // !prevTest && test: just consequent
+              test: t.logicalExpression(
+                '&&',
+                t.unaryExpression('!', prev.test),
+                ternary.test
+              ),
+              consequent: ternary.consequent,
+              alternate: null,
+              remove,
+            })
           }
+        }
 
-          return value
-        })()
+        if (ternary.alternate && Object.keys(ternary.alternate).length) {
+          const negated = t.unaryExpression('!', ternary.test)
+          expandedTernaries.push({
+            // prevTest && !test: merge alternate
+            test: prev ? t.logicalExpression('&&', prev.test, negated) : negated,
+            consequent: prev
+              ? mergeProps(prev.consequent!, ternary.alternate)
+              : ternary.alternate,
+            remove,
+            alternate: null,
+          })
 
-        // inserts the _cn variable and uses it for className
-        const names = buildClassName(finalClassNames, extraClassNames)
+          if (prev) {
+            expandedTernaries.push({
+              // !prevTest && !test: just alternate
+              test: t.logicalExpression(
+                '&&',
+                t.unaryExpression('!', prev.test),
+                ternary.test
+              ),
+              consequent: ternary.alternate,
+              remove,
+              alternate: null,
+            })
+          }
+        }
+      }
 
-        const nameExpr = names ? hoistClassNames(jsxPath, existingHoists, names) : null
-        let expr = nameExpr
+      let ternaryClassNameExpr: t.Expression | null = null
 
-        // if has some spreads, use concat helper
-        if (nameExpr && !t.isIdentifier(nameExpr)) {
-          if (!didFlattenThisTag) {
-            // not flat
+      // next: create all CSS, build className strings and hoist, and create final node with props
+      if (hasTernaries) {
+        for (const ternary of expandedTernaries) {
+          if (!ternary.consequent) continue
+          const classNames = addStyles(ternary.consequent)
+          if (ternary.fontFamily) {
+            classNames.unshift(`font_${ternary.fontFamily}`)
+          }
+          const baseString = t.isStringLiteral(baseClassNameExpression)
+            ? baseClassNameExpression.value
+            : ''
+          const fullClassName =
+            (baseString ? `${baseString} ` : '') + classNames.join(' ')
+          const classNameLiteral = t.stringLiteral(fullClassName)
+
+          if (!ternaryClassNameExpr) {
+            ternaryClassNameExpr = classNameLiteral
           } else {
-            ensureImportingConcat(programPath)
-            const simpleSpreads = attrs.filter((x) => {
-              return (
-                x.type === 'attr' &&
-                t.isJSXSpreadAttribute(x.value) &&
-                isSimpleSpread(x.value)
-              )
-            })
-            expr = t.callExpression(t.identifier('concatClassName'), [
-              expr,
-              ...simpleSpreads.map((val) => val.value['argument']),
-            ])
+            ternaryClassNameExpr = t.conditionalExpression(
+              ternary.test,
+              classNameLiteral,
+              ternaryClassNameExpr
+            )
           }
         }
+      }
 
-        node.attributes.push(
-          t.jsxAttribute(t.jsxIdentifier('className'), t.jsxExpressionContainer(expr))
-        )
+      let finalExpression: t.Expression | null =
+        !hasTernaries || !t.isStringLiteral(baseClassNameExpression)
+          ? baseClassNameExpression
+          : null
+
+      if (ternaryClassNameExpr) {
+        finalExpression =
+          baseClassNameExpression && baseClassNameExpression !== spaceString
+            ? t.binaryExpression('+', baseClassNameExpression, ternaryClassNameExpr)
+            : ternaryClassNameExpr
       }
 
-      const comment = util.format(
-        '/* %s:%s (%s) */',
-        filePath,
-        lineNumbers,
-        originalNodeName
-      )
+      // console.info('attrs', JSON.stringify(attrs, null, 2))
+      // console.info('expandedTernaries', JSON.stringify(expandedTernaries, null, 2))
+      // console.info('finalExpression', JSON.stringify(finalExpression, null, 2))
 
-      for (const styleObject of finalStyles) {
-        const identifier = styleObject[helpers.StyleObjectIdentifier]
-        const rules = styleObject[helpers.StyleObjectRules]
-        const className = `.${identifier}`
-        if (cssMap.has(className)) {
-          if (comment) {
-            const val = cssMap.get(className)!
-            val.commentTexts.push(comment)
-            cssMap.set(className, val)
-          }
-        } else if (rules.length) {
-          cssMap.set(className, {
-            css: rules.join('\n'),
-            commentTexts: [comment],
-          })
-        }
+      if (finalExpression) {
+        // hoist to global variables
+        finalExpression = hoistClassNames(jsxPath, finalExpression)
+
+        const classNameProp = t.jsxAttribute(
+          t.jsxIdentifier('className'),
+          t.jsxExpressionContainer(finalExpression!)
+        )
+        finalAttrs.unshift(classNameProp)
       }
+
+      node.attributes = finalAttrs
     },
   })
 
@@ -466,3 +497,46 @@ export async function extractToClassNames({
     map: result.map,
   }
 }
+
+function hoistClassNames(path: NodePath<t.JSXElement>, expr: t.Expression) {
+  if (t.isStringLiteral(expr)) {
+    return hoistClassName(path, expr.value)
+  }
+
+  if (t.isBinaryExpression(expr)) {
+    const left = t.isStringLiteral(expr.left)
+      ? hoistClassName(path, expr.left.value)
+      : expr.left
+    const right = t.isStringLiteral(expr.right)
+      ? hoistClassName(path, expr.right.value)
+      : hoistClassNames(path, expr.right)
+    return t.binaryExpression(expr.operator, left, right)
+  }
+
+  if (t.isConditionalExpression(expr)) {
+    const cons = t.isStringLiteral(expr.consequent)
+      ? hoistClassName(path, expr.consequent.value)
+      : hoistClassNames(path, expr.consequent)
+
+    const alt = t.isStringLiteral(expr.alternate)
+      ? hoistClassName(path, expr.alternate.value)
+      : hoistClassNames(path, expr.alternate)
+
+    return t.conditionalExpression(expr.test, cons, alt)
+  }
+
+  return expr
+}
+
+function hoistClassName(path: NodePath<t.JSXElement>, str: string) {
+  const uid = path.scope.generateUidIdentifier('cn')
+  const parent = path.findParent((path) => path.isProgram())
+  if (!parent) throw new Error(`no program?`)
+  const variable = t.variableDeclaration('const', [
+    // adding a space for extra safety
+    t.variableDeclarator(uid, t.stringLiteral(str)),
+  ])
+  // @ts-ignore
+  parent.unshiftContainer('body', variable)
+  return uid
+}