Сложно недооценить важность инструментов использующих [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) трансформации в современном фронтенде:

* мы используем `babel`

  * чтобы *транспилировать* современные версии *ECMAScript* в те, что совместимы с более старыми версиями браузеров
  * чтобы [оптимизировать наш код](https://github.com/jamiebuilds/babel-react-optimize)
  * чтобы [получить новые возможности](https://emotion.sh/docs/css-prop)
* закрепляем общие подходы и избегаем багов с помощью `eslint`
* форматируем код `prettier`'ом

Но сегодня мы поговорим о AST трансформациях для рефакторинга кода. Вы возможно уже использовали так называемые *codemods*.

##  Предыстория

Мы в [tourlane](https://www.tourlane.de/) используем [styled-components](https://styled-components.com/) (вероятно, одно из самых популярных *CSS-IN-JS* решений в react сообществе) и [styled-system](https://styled-system.com/) (очень крутой набор утилит для написания адаптивных стилей), благодаря которым мы можем писать что-то вроде этого:

```jsx
let User = ({ avatar, name }) => (
  <Flex flexDirection={['column', 'row']}>
    <Box as="img" mb={[1, 0]} mr={[0, 1]} src={avatar} />
    <Box p={1}>{name}</Box>
  </Flex>
)
```

И хотя кому-то синтаксис может показаться неоднозназначным, да и не сильно относится к сути статьи (но важен для предыстории), я всё-таки воспользуюсь моментом и поделюсь списком статей, которые раскрывают идеи за ним скрывающиеся (к сожалению все на английском):

* [Two steps forward, one step back](https://jxnblk.com/blog/two-steps-forward/)
* [Styles and Naming](<* [https://www.christopherbiscardi.com/post/styles-and-naming](https://www.christopherbiscardi.com/post/styles-and-naming/)/>)
* [Old and new ideas in React UI](https://react-ui.dev/core-concepts/ideas)

Нас конкретно интересуют адаптивные атрибуты, как этот `jsx±flexDirection={['column', 'row']}`. Под капотом он, используя заданные нами контрольные точки (breakpoints), превратит вот в такой css с медиа-выражениями:

```css
.some-generated-class {
  flex-direction: column;
}

@media screen and (min-width: 64em) {
  .some-generated-class {
    flex-direction: row;
  }
}
```

> Для первого значения медиа-выражение не требуется, т.е. используется mobile-first подход - стили в первую очередь пишутся для мобильных устройств.

## Проблема

Когда мы только начинали разрабатывать один из наших проектов, у нас не было специфических стилей  для планшетов:

```jsx
let breakpoints = [
   // всё что меньше - мобильное утройство
  '64em', // десктоп
  '80em', // широкие экраны
]

let Layout = ({ children }) => (
  <ThemeProvider theme={{ breakpoints }}>
    <Header />
    {children}
    <Footer />
  </ThemeProvider>
)
```

Но спустя некоторое время, нам понадобилось разработать страницу, у которой раскладка для смартфонов и планшетов существенно различалась. И как вы уже догадались, наша конфигурация это не поддерживала 😧: мы более не могли использовать адаптивные атрибуты к которым так привыкли 😨. Добавление новой контрольной точки сломало бы все существующие компоненты 😰.

Я уверен каждый рано или поздно оказывается в подобной ситуации: может вы что-то не предусмотрели, может изменили взгляды относительно каких-то общих подходов или синтаксиса, а может вышла новая версия библиотеки с ломающими изменениями (несовместимыми с тем как вы используете её сейчас). И если в последнем случае часто сами разработчики библиотек предоставляют те самые *codemods*, вместе с релизом (команды *angular* и *react*, во всяком случае так делают). То во всех остальных ситуациях спасение утопающих будет сами знаете что.

## jscodeshift  спешит на помощь

Хотя наша ситуация не была безвыходной: мы всё-ещё могли писать стили для планшетов используя обычные медиа-выражения. Мириться мы с этим не собирались: очень уж нам полюбился этот лаконичный способ описания интерфейсов. Да и множить количество подходов к написанию адаптивных стилей на проекте нам не хотелось. Но в тоже время перспектива изменения сотен мест руками нас пугала.

И тут я подумал, а ведь это отличный повод для того чтобы разобраться с тем, как самому писать *codemode
s*!

От твиторских я слышал, что [jscodeshift](https://github.com/facebook/jscodeshift) хороший инструмент для их создания, команда реакта [использует именно его](https://github.com/reactjs/react-codemod). Благодаря ему вам нужно лишь написать `js/ts` файл который будет экспортировать функцию *transform,* ответственную за модификацию вашего *AST*.

Другая важная вещь это собственно понимание самого *AST*: что это, из чего состоит и как вообще его менять. Сразу после википедии я рекомендую смотреть [руководство babel](https://github.com/jamiebuilds/babel-handbook/blob/master/translations/ru/README.md): там очень хорошо расписано, что можно делать как. Ну и инструмент без которого просто не обойтись это [AST explorer](https://astexplorer.net/): там можно писать код и смотреть что в какую ноду дерева превращается и тут же писать плагин с трансформациями и смотреть результат!

Ах да, ещё одним хорошим помощником будет `typescript`: получать подсказки о нодах и свойствах прямо в IDE гораздо приятнее, чем постоянное переключение на документацию или эксплорер. Поэтому помимо *jscodeshift*'а сразу ставьте и типы (`@types/jscodeshift`).

Ну и собственно, вооружившись всеми этими инструментами, я сделал что-то такое:

```typescript
import { Transform } from 'jscodeshift';

let directions = ['', 't', 'r', 'b', 'l', 'x', 'y'];
// это как раз адаптивные атрибуты, предоставленные styled-system
let spaceAttributes = [
  ...directions.map(d => `m${d}`),
  ...directions.map(d => `p${d}`),
  'flexDirection', 'justifyContent', // ...
];

let transform: Transform = (fileInfo, { j }) =>
  j(fileInfo.source)
    .find(j.JSXAttribute)
    .forEach(({ node }) => {
      let attributeName =
        typeof node.name.name === 'string' ? node.name.name : `¯\\_(ツ)_/¯`;
      let { value } = node;

      if (
        spaceAttributes.includes(attributeName) &&
        // we are interested only array expressions which has more then 1 value
        // like <Box m={[8, 16, 24]}>
        value?.type === 'JSXExpressionContainer' &&
        value.expression.type === 'ArrayExpression' &&
        value.expression.elements.length > 1
      ) {
        let [xs, ...otherMedias] = value.expression.elements;

        // null в styled-system означает - не создавай медиа-выражение
        // для этой контрольной точки, так благодаря нашему
        // mobile-first подходу значения для планшетов "унаследуются"
        // от мобильных значений.
        // Того же самое можно было бы достичь написав: [xs, xs, ...otherMedias],
        // но и результирующий css был бы больше.
        value.expression.elements = [xs, j.identifier('null'), ...otherMedias];
      }
    })
    .toSource();

export default transform;
```

Можете посмотреть и поиграться с "живым" примером в [AST explorer](https://astexplorer.net/#/gist/d76e9a0c6e5f0cea12c039bc1b3f0d4c/4a5c9afcfda6967a4d0205ba8093e2b0c363ac4c).

Как видите скрипт получился не очень большим, но очень наглядным - по коду не так сложно понять чего мы добиваемся (да ведь?). Понятное дело что я покрыл далеко не все кейсы (например в качестве значения атрибута мы могли передать переменную или тернарное выражение или...), но идею он раскрывает.

И ещё одно крутое достоинство *codemode*'ов это то, что вы можете их запускать ➡️откатывать с помощью git ➡️дорабатывать 🔁1000 раз, пока результат вас не удовлетворит.

## Возьмите codemods себе на вооружение

Это всё, чем я хотел поделиться в этой статье. Я надеюсь после прочтения вы (как и я) будете рассматривать *codemods* не просто как мощный инструмент, но и как штуку которую легко можно освоить и применять на своих проектах. Если у вас остались какие-то вопросы, пишите комментарии или лично мне (в [twitter](https://twitter.com/kitos_kirsanov) например). Спасибо!


Рефактори как будто никто не видит


## Мистика

Недавно, при миграции части страниц [нашего главного сайта](https://tourlane.de) на [gatsby](http://gatsbyjs.org) мы столкнулись со странной проблемой: одна из ссылок в главной навигации была нестилизована при первоначальной загрузке страницы. Что-то вроде:

![Навигационное меню с нестилизованной ссылкой](/uploads/broken-link.jpg 'Нестилизованная ссылка')

После первого же перехода на любую другую страницу стили появлялись 🤯.

Ситуацию ещё более усугублял тот факт, что компонент, ответственный за отображение навигации, использовался и в старом приложении, использующем _nextjs_, но работал он там прекрасно 👻.

## Расследование

Недолго думая я полез в DOM и обнаружил, что у этой ссылки css-классы относились к мобильной разметке, хотя смотрел я всё это на десктопе 🤪.

В голове крутилась мысль: react косячит при [гидрации](https://ru.reactjs.org/docs/react-dom.html#hydrate). Верить в неё конечно не хотелось: такую серьёзную проблему бы уже давно нашли, да и старом приложении ВСЁ РАБОТАЕТ.

Вспоминаю требование к гидрации:

> React ожидает, что отрендеренное содержимое идентично на сервере, и на клиенте.

Бегу смотреть исходный код компонента 🕵️‍♂️:

```jsx
// упрощённый NavBar.js
import React from 'react'
import Media from 'react-media'

export const NavBar = () => (
  <Media queries={{ maxWidth: 599 }}>
    {matches => (matches ? <MobileNav /> : <DesktopNav />)}
  </Media>
)
```

## Вердикт

Видите здесь проблему?

- В компоненте используется [react-media](https://github.com/ReactTraining/react-media), за счёт которого для мобильных и десктопных экранов отдаётся разная разметка
- Мы переходим на статическую генерацию страниц (используем _gatsby_), т.е. SSR у нас происходит во время сборки сайта. И на этом этапе мы, конечно, не знаем на каком устройстве будет отображаться страница, а `react-media` при SSR по умолчанию считает все медиа запросы истинными (в нашем случае отдаст мобильную разметку).
- Ну и получается, что пользователь с большим экраном:
  1. открывает страницу и получает с сервера html c мобильной вёрсткой (непродолжительное время видит её)
  2. видит десктопный лейаут с нестилизованной ссылкой, т.к. во время _гидрации_ react генерирует кашу из 2-х разных лейаутов

## Как быть?

Чтобы избежать таких проблем нужно:

- Отдавать предпочтение обычным css медиа выражениям.\
  \
  Даже если с помощью CSS не получается привести одну и ту же разметку к необходимому виду на разных устройствах, можно разделить и DOM под разные разрешения/устройства и одновременно выдать все варианты, а с помощью медиа выражений отображать нужные:

  ```jsx
  let DesktopOnly = styled.div`
    @media (max-width: 599px) {
      display: none;
    }
  `

  let MobileOnly = styled.div`...`

  export const NavBar = () => (
    <>
      <MobileOnly>
        <MobileNav />
      </MobileOnly>

      <DesktopOnly>
        <DesktopNav />
      </DesktopOnly>
    </>
  )
  ```

  В этом случае вы сможете не только избежать проблем с гидрацией, но и пользователь получит лучший опыт при работе с вашим сайтом: разметка не будет прыгать при загрузке. Т.к. браузер ещё до исполнения JavaScript отрисует сайт согласно CSS и HTML, а гидрация лишь вдохнёт в него жизнь.

- В случае когда прибегнуть к вышеупомянутому подходу нельзя - прибегнуть к использованию `react-media` и аналогичных решений. Например когда:
  - может пострадать SEO (не сталкивался с подобной проблемой, но подозреваю что дублирование контента, увеличение размера страницы... может к этому привести. напишите в комментариях, если знаете кейсы)
  - может пострадать производительность (например для десктопа вы отображаете какой-то сложный элемент)
    **ВНИМАНИЕ!** Обязательно измеряйте производительность перед тем как делать подобные оптимизации. Факт того, что react'у придётся отрисовать на 50 html-блоков больше, не должен вас пугать.
  - может пострадать что-то ещё 🤷‍♂️

А как же проблема с гидрацией при использовании второго подхода?

Как я заметил в начале, эта проблема не могла остаться незамеченной и решение у неё есть - отрисовка в 2 прохода:

- выберете раскладку которую хотите использовать по умолчанию:
  - если вы используете не статический сайт, то можете выбрать его на основе _User Agent_
  - для статических сайтов можете отталкиваться от статистики использования вашего сайта
- рендерите это состояние во время серверной отрисовки и гидрации
- запускаете дополнительную перерисовку на клиенте, если актуальное состояние отличается от того, что предполагали

Официальная документация [предлагает](https://ru.reactjs.org/docs/react-dom.html#hydrate) использовать для этого флаг в стейте, и `react-media` [такое умеет](https://github.com/ReactTraining/react-media#server-side-rendering-ssr), нужно лишь указать свойство `defaultMatches`:

```jsx{3-8}
export const NavBar = () => (
  <Media
    queries={{ mobile: { maxWidth: 599 } }}
    // мы знаем что большинство наших пользователей
    // используют мобильные устройства
    defaultMatches={{ mobile: true }}
  >
    {matches => (matches.mobile ? <MobileNav /> : <DesktopNav />)}
  </Media>
)
```

### З.Ы.

"А почему же мы не столкнулись с этой проблемой в старом приложении?" - заметит внимательный читатель. Действительно, ведь оно тоже использует SSR и не использует знание о браузере (_User Agent_). Если честно, я не стал тревожить легаси проект, чтобы познать его тайну 💀. Но полагаю, что дело в какой-нидь лишней перерисовке которая инициируется вышележащими компонентами.


Hi, I'm Nikita!

Recent posts