Чек-лист для ревью пулл-реквеста

Ревью пулл реквестов является неотъемлемой частью процесса разработки программного обеспечения. Оно позволяет команде разработчиков обмениваться мнениями, обсуждать и улучшать код, а также обнаруживать потенциальные ошибки и проблемы. Однако, чтобы провести качественное ревью, необходимо иметь чеклист, который позволит систематизировать процесс и убедиться, что все важные аспекты кода были рассмотрены. В этой статье мы рассмотрим основные пункты, которые должны быть включены в чеклист для проведения ревью пулл реквестов.

Функциональность

Проверьте, что код выполняет требования из задачи или спецификации. Убедитесь, что все функции работают корректно и не вызывают ошибок.

Архитектура и структура кода

Рассмотрите, соответствует ли код принципам SOLID и лучшим практикам проектирования. Проверьте, что код хорошо организован, читаем и понятен другим разработчикам.

Комментарии и документация

Проверьте наличие комментариев и документации. Комментарии должны быть четкими и информативными, а документация должна объяснять, как использовать код и его функции.

Тестирование

Убедитесь, что код сопровождается достаточным количеством тестов. Проверьте, что все тесты проходят успешно и покрывают основные сценарии использования.

Надежность и безопасность

Рассмотрите код с точки зрения безопасности и надежности. Убедитесь, что применены соответствующие меры безопасности и механизмы обработки ошибок.

Производительность

Проверьте, что код работает эффективно и не содержит узких мест. Рассмотрите возможные оптимизации и их реализацию.

Стиль кода

Проверьте, соответствует ли код стандартам оформления и стилю, принятым в команде или проекте. Убедитесь, что переменные и функции имеют осмысленные имена, и что код написан согласно соглашениям о наименовании.

Зависимости

Убедитесь, что код правильно использует и управляет зависимостями. Проверьте версии и совместимость используемых библиотек.

Развертывание

Рассмотрите, как код будет развертываться на сервере или установлен на конечном устройстве. Убедитесь, что весь необходимый функционал для развертывания присутствует.

Обратная связь

Не забывайте предоставлять конструктивную обратную связь разработчикам. Делитесь своими мыслями, идеями и предложениями по улучшению кода. Конечно, этот чеклист может быть адаптирован и дополнен в зависимости от специфики проекта и команды разработчиков. Главное - следовать основным принципам проведения ревью и стремиться к повышению качества кода.

Это серия статей о функциональном программировании:

1. Парадигмы программирования
2. Композиция
3. Функторы
4. Каррирование
5. Чистые функции (рассматривается в этой статье)
6. Функции первого класса

Что такое чистая функция?

Чистая функция — это функция, которая является детерминированной и не производит побочных эффектов.

Характеристики чистой функции

️1. Чистые функции должны быть детерминированными

Детерминированная функция — это функция, которая при одном и том же входе x всегда должна иметь один и тот же результат y.

Примеры недетерминированных функций

1. Math.random

const getRandom = () => Math.random()

2. ФункцииDate

const getDate = () => Date.now()

3. getUsers

const getUsers = await fetch('/users')

Функция getUsers недетерминирована, потому что пользователи могли обновиться, нет подключения к интернету, сервер может быть недоступен или что-то еще.

Комментарии к примерам

Эти примеры считаются недетерминированными, потому что для одних и тех же входных данных выходные данные будут отличаться. Детерминизм означает, что функция никогда не изменит результат при одних и тех же входных данных.

️2. Чистые функции не должна иметь побочных эффектов

Побочным эффектом может быть:

• Внешняя зависимость (доступ к внешним переменным, потокам ввода/вывода, чтение/запись файлов или выполнение HTTP-вызовов).
• Мутация (мутации локальных/внешних переменных или переданных аргументов по ссылке).

Чистые функции должны быть детерминированными и не должны давать никаких побочных эффектов. При этом невозможно иметь приложения с состоянием без побочных эффектов (запрос к базе данных, выполнение http-вызова, чтение пользовательского ввода или даже отображение результатов в пользовательском интерфейсе). Но в функциональном программировании есть еще несколько концепций/исправлений для этого.

Примеры побочных эффектов

1. Функция isLessThanMin

Функция с побочным эффектом

const min = 60
const isLessThanMin = value => value < min

Чистая функция

const isLessThanMin = (min, value) => value > min

Побочный эффект заключается во внешней зависимости. Для исправления используется внедрение зависимости (dependency injection).

2. Функция для вычисления квадратов чисел

Функция с побочным эффектом

const squares = (nums) => {
  for(let i = 0; i < nums.length; i++) {
    nums[i] **= 2;
  }
}

Чистая функция

const squares = (nums) => nums.map(num => num * num)

Побочный эффект заключается в наличии императивного кода, который выполняет мутации в исходном массиве по ссылке. Для исправления используется функциональный .map, который создает новый массив.

3. Функция updateUserAge

Функция с побочным эффектом

const updateUserAge = (user, age) => {
  user.age = age
}

Чистая функция

const updateUserAge = (user, age) => ({ ...user, age })

Побочный эффект заключается в мутации объекта user по ссылке. Нужно избегать изменения объектов по ссылке, вместо этого следует вернуть новый объект с новыми/обновленными свойствами.

4. Функция getFirst2Elements

Функция с побочным эффектом

const getFirst2Elements = (arr) => arr.splice(0, 2)

Чистая функция

const getFirst2Elements = (arr) => arr.slice(0, 2)

Побочный эффект заключается в мутировании arr, переданного по ссылке методом .splice. Для исправления используется функциональный метод .slice, который не изменяет сам массив.

Почему функции с побочными эффектами - плохо?

У функций с побочными эффектами есть несколько очевидных недостатков:

• Это делает функции тесно связанными с окружающей средой
• Увеличивает когнитивную нагрузку на разработчика
• Вызывает неочевидные изменения состояния
• Увеличивает кривую обучения кодовой базы разработчика
• Невозможность параллелизации
• Высокая непредсказуемость
• + потеря преимуществ чистых функций

Почему чистые функции - хорошо?

Можно вывести две основные категории улучшений. Улучшение опыта разработки (developer experience) и улучшение производительности приложений.

Улучшение опыта разработки

Принимая во внимание тот факт, что наши функции теперь детерминированы, независимы и самодостаточны. Улучшения будут очевидны.

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

Улучшение производительности

• Способность к кэшированию (мемоизация): детерминизм функций даст нам возможность предсказывать, каким будет вывод для определенного ввода, затем мы можем кэшировать функции на основе вводов.
• Возможность распараллеливания: поскольку функции теперь свободны от побочных эффектов и независимы, их можно легко распараллелить.