Мои заметки

Express JS

2020-07-13T05:55:20+00:00

Тестирование Supertest — это библиотека, созданная исключительно с целью проводить функциональное тестирование http интерфейса.

// __tests__/app.test.js
import request from 'supertest';
import app from '../src/app.js';

test('request', async () => {
  const res = await request(app).get('/');
  if (res.error) {
    throw error;
  }
  expect(res.status).toBe(200);
});

В основе библиотeки supertest лежит другая библиотека - superagent. Именно она позволяет формировать произвольные запросы к серверу.

import request from 'superagent';

const res = await request
   .post('/api/pet')
   .type('form')
   .send({ name: 'Manny', species: 'cat' })
   .set('X-API-Key', 'foobar')
   .set('Accept', 'application/json');

https://github.com/visionmedia/superagent https://github.com/visionmedia/supertest

Логирование Правильная отладка — это хорошо настроенное логирование.

В javascript особой популярностью пользуется библиотека morgan.

import Express from 'express';
import morgan from 'morgan';

const app = new Express();
const logger = morgan('combined');
app.use(logger);

https://github.com/expressjs/morgan

Так сложилось, что 99% самых популярных библиотек на js уже поставляются со встроенным логированием через debug. По сути, нам не очень-то и оставили выбор. На картинке выше как раз видно кусок лога express. https://github.com/visionmedia/debug#readme

Интеграция pug с express:

Шаблонизатор PUG

// npm install pug
app.set('view engine', 'pug');

app.get('/', (req, res) => {
  const data = { title: 'Hey', message: 'Hello there!' };
  res.render('index', data);
})
// index.pug
html
  head
    title= title
  body
    h1= message

Шаблоны и чистота

Ни в коем случае шаблон не должен порождать побочных эффектов. В шаблоне нельзя писать в базу, изменять данные на диске и вообще любым способом пытаться влиять на окружающую среду. Шаблон это исключительно чтение.
Шаблоны должны быть декларативны, никакого изменения состояний, другими словами, если вы начинаете внутри шаблона вводить переменные и изменять их, то, по сути, шаблон превращается в полноценный скрипт, который вы программируете. Не допускайте этого.
Использовать логику, влияющую на вывод внутри шаблона — это нормально. Если у вас, с точки зрения ui, блок показывается по определённому условию, то вы не сможете этого избежать, единственное о чем нужно помнить, это создавать вовремя правильные абстракции (функции) для избежания дублирования, а так же для выделения бизнес-правил.

Технологии

REST

Требование REST:

Единообразие интерфейса

Кэширование

Отсутствие состояния

Клиент-серверная архитектура

Слои

Код по требованию (необязательное ограничение)

Дейстие в REST определяется глаголом (GET, POST, DELETE …)

JSONAPI

JSONAPI

Middleware

Connect

connect - ядро микрофреймворка express.

Connect представляет из себя механизм, который расширяется функциями, называемыми middleware. Каждый раз, когда мы используем use, очередная middleware добавляется в общую очередь. В конечном счёте получается объект, наполненный мидлварами. Каждый запрос, отправляемый на обработку в connect, проходит через цепочку этих middleware пока не наткнётся на терминальную мидлвару.

В свою очередь каждая мидлвара принимает на вход три параметра: request, response и next. Она может поменять их и в конце должна вызвать next для передачи управления следующей по списку мидлваре. В этом и заключается вся мощь микрофреймворков. Удачный дизайн позволяет легко разбивать систему на модули-мидлвары и расширять за счёт мидлвар, которые, в большом количестве, пишут сторонние разработчики.

app.use((req, res, next) => {
  req.newProperty = 'hello from my middleware';
  next();
});

// вызов methodOverride возвращает функцию вида (req, res, next) => ...
app.use(methodOverride('_method'));
В Connect нет ничего кроме метода use добавляющего очередную мидлвару в стек.

Mount middleware

Самое интересное в Connect, что обработчики конкретных маршрутов — это тоже, всего навсего, мидлвары. Их особенностью является привязка к конкретному маршруту, в отличие от мидлвар, которые выполняются для всех запросов.

app.use('/foo', (req, res, next) => {
  // req.url starts with "/foo"
  next();
});

app.use('/bar', (req, res, next) => {
  // req.url starts with "/bar"
  next();
});

Такие мидлвары позволяют реализовывать базовый роутинг без привязки к конкретному глаголу http и без поддержки динамических маршрутов. В Express роутинг реализован без привязки к Mount Middlewares.

JS: Продвинутое тестирование, заметки

2020-02-20T05:55:20+00:00

Метчер jest для отлова исключений:

test('boom!', () => {
  expect(() => {
    functionWithException(0);
  }).toThrow();
})

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

Иногда важно не просто поймать исключение, но и убедиться в том, что это ожидаемое исключение. Сделать это можно передав в матчер toThrow() строку, которая должна присутствовать в сообщении исключения.

test('boom!', () => {
  expect(() => {
    functionWithException(0);
  }).toThrow('divide by zero');
})

Фикстуры:

const { promises: fs } = require('fs');
const path = require('path');
const getFunction = require('../functions');

const toHtmlList = getFunction();

// BEGIN (write your solution here)
const formats = ['csv', 'json', 'yml'];
const getFixturePath = (name) => path.join(__dirname, '..', '__fixtures__', name);

let expected;

beforeAll(async () => {
  expected = await fs.readFile(getFixturePath('result.html'), 'utf-8');
});

test.each(formats)('%s', async (format) => {
  const filePath = getFixturePath(`list.${format}`);
  const actual = await toHtmlList(filePath);
  expect(actual).toEqual(expected.trim());
});
// END

Побочные эффекты

Библиотека для генерации данных: Faker

Любое взаимодействие с внешней средой не детерминировано.

Библиотека для создания виртуальной ФС: mock-fs

Инверсия зависимостей

Программу можно изменить так, чтобы она вызывала функцию sendEmail не напрямую, а принимала её как параметр:

import sendEmail from './emailSender.js';

// Ставим значение по умолчанию, чтобы не пришлось постоянно указывать функцию
const registerUser = (params, send = sendEmail) => {
  const user = new User(params);
  if (user.save()) {
    send('registration', { user });
    return true;
  }
  return false;
}

Тест:

const fakeSendEmail = (...args) => {
  /* Например письмо можно вывести в лог для удобства отладки */
};

test('registerUser', () => {
  const id = registerUser({ name: 'Mike' }, fakeSendEmail);
  const user = User.find(id)
  expect(user).toHaveProperty('name', 'Mike');
});

Манкипатчинг

nock - библиотека для перехвата сетевых запросов. Эта библиотека работает так. Она берет стандартный модуль Node.js http и заменяет внутри него некоторые методы, которые используются разными библиотеками для выполнения HTTP-запросов. Причём не просто заменяет, а позволяет гибко настраивать то, какие запросы и как перехватывать, какие возвращать данные, заголовки и коды ответа.

import nock from nock;
import { getPrivateForkNames } from '../src.js'; 

test('getPrivateForkNames', async () => {
  nock(/api\.github\.com/)
    .log(console.log) // для удобства отладки можно удалить, если не нужно
    // get – для GET-запросов, post – для POST-запросов и так далее
    .get(/\/orgs\/hexlet\/repos/)
    .reply(200, [{ fork: true, name: 'one' }, { fork: false, name: 'second' }]);

  const names = await getPrivateForkNames('hexlet');
  expect(names).toEqual(['one']);
});

У Nock есть метод, запрещающий любые HTTP-запросы из кода: nock.disableNetConnect(). Рекомендуется вызывать его в начале файла с тестами для предотвращения случайных запросов.

Кассеты для Axios

Моки и стабы

Стаб устраняет побочный эффект, чтобы не мешать проверке результата работы кода, например, возврату данных из функции. Мок фокусируется на том, как конкретно работает код, что он делает внутри. При этом чисто технически мок и стаб создаются одинаково, за исключением того, что на мок вешают ожидания, проверяющие вызовы. Это приводит к путанице, потому что часто моками называют стабы. С этим ничего уже не поделать, но для себя всегда пытайтесь понять, о чём идет речь. Это важно, от этого зависит фокус тестов.

Курс «JS: Автоматическое тестирование», заметки

2020-01-29T05:55:20+00:00

У обычных утверждений есть мощная альтернатива: power-assert. Эта библиотека добавляет магию в привычный инструмент.

Jest - фраймворк для запуска тестов

(Документация jest)[https://jestjs.io/docs/en/getting-started]

Матчеры Jest: Документация

функция test не запускает тест на выполнение. Она добавляет его во внутрь Jest, а вот он уже решает, когда выполнить этот тест. Поэтому между загрузкой модуля и отработкой тестов проходит неопределённое время.

import assert from 'power-assert';

// Весь код остаётся тем же самым
const user = {
  name: 'Madonna',
  friends: ['Kate', 'Michel'],
  email: 'madonna@example.com',
};

// Интерфейс библиотеки power-assert на 100% совместим со встроенным модулем assert.
assert(user.name === 'Michel');
И посмотреть вывод:

AssertionError [ERR_ASSERTION]:   # test.js:10

  assert(user.name === 'Michel')
         |    |    |
         |    |    false
         |    "Madonna"
         Object{name:"Madonna",friends:#Array#,email:"madonna@example.com"}

  --- [string] 'Michel'
  +++ [string] user.name
  @@ -1,6 +1,7 @@
   M
  -ichel
  +adonna

–watch Watch files for changes and rerun tests related to changed files. If you want to re-run all tests when a file has changed, use the –watchAll option instead.

Хуки

Тестовые фреймворки предоставляют хуки — специальные функции, которые запускаются до или после тестов. Ниже пример того, как создавать дату перед каждым тестом:

(Документация по хукам)[https://jestjs.io/docs/en/api#testeachtable-name-fn-timeout]

let now;
let counter = 0;

// Запускается перед каждым тестом
beforeEach(() => {
  now = new Date();
  counter += 1;
});

test('first example', () => console.log(now, counter));
test('second example', () => console.log(now, counter));

Плохие и хорошие практики тестирования

Нет условным конструкциям внутри тестов. Любое ветвление внутри тестов это фактически несколько тестов в рамках одного теста. От этого надо избавляться и никогда так не писать.
Исключать взаимное влияние тестов

Так как же лучше написать тест? Нужно найти достаточно высокую точку входа в нашу программу, которая не зависит от внутренней реализации, и при этом выполняет поставленную задачу.

Покрытие кода тестами

В Jest покрытие меряется крайне просто. Достаточно запустить тесты с флагом –coverage:

nodejs-package$ npx jest --coverage

Большинство разработчиков сходится во мнении, что 80% — это достаточно хорошее покрытие. На этом можно и остановиться.

Примеры тестов

  test('Cart', () => {
  const cart = makeCart();
  expect(cart.getItems()).toHaveLength(0);

  cart.addItem({ name: 'car', price: 3 }, 5);
  expect(cart.getItems()).toHaveLength(1);
  expect(cart.getCost()).toBe(15);
  expect(cart.getCount()).toBe(5);

  cart.addItem({ name: 'house', price: 10 }, 2);
  expect(cart.getItems()).toHaveLength(2);
  expect(cart.getCost()).toBe(35);
  expect(cart.getCount()).toBe(7);
});

Прочее:

Приложение двенадцати факторов

Чек-лист хороших инженерных практик в компаниях

Начинаем писать тесты правильно (видео)

Начинаем писать тесты правильно (статья)

Среды разработки. Мужики, выкатывай!

Создание базового проекта NodeJS с Babel 7, eslint, jest.

Jest

2020-01-20T00:00:00+00:00

Jest Когда тестов и файлов с тестами становится много, возникают новые вопросы. Как группировать тесты? Как запустить на выполнение все тесты из одной директории? Если их очень много и они долгие, можно ли запустить их параллельно?

Для решения этих вопросов используют специальные тестовые фреймворки. Они помогают организовать структуру тестов и дают много полезного, например, удобный вывод. С большинством из этих возможностей мы познакомимся далее по курсу. В JavaScript мире наиболее популярен фреймворк Jest, разрабатываемый компанией Facebook. К слову, с помощью него мы тестируем все практики на Хекслете.

Ниже находится инструкция, в которой мы создадим с нуля npm-проект и добавим в него тесты.

Настройка и запуск Создайте где-нибудь на вашем компьютере директорию с названием hexlet-jest. Зайдите в неё и выполните команду:

hexlet-jest $ npm init Ответьте на все вопросы запущенного скрипта инициализации проекта. Убедитесь, что в корне проекта появился файл package.json.

Теперь добавим немного исходного кода. Создайте файл src/index.js с таким содержимым:

// Эта функция переворачивает переданную строку export default str => str.split(‘’).reverse().join(‘’); Jest — обычный npm-пакет, который локально подключается в разрабатываемый проект. Jest нужен только во время разработки, поэтому лучше установить его в секцию devDependencies:

В директории с проектом

hexlet-jest $ npm i –save-dev jest По умолчанию Jest не использует Babel, поэтому код с импортами внутри Jest не заработает. Для поддержки Babel нужно установить несколько дополнительных пакетов:

hexlet-jest $ npm i –save-dev babel-jest @babel/core @babel/preset-env Далее создайте в корне проекта файл babel.config.js с таким содержимым:

module.exports = { presets: [[‘@babel/preset-env’, {targets: {node: ‘current’}}]], }; После установки этих пакетов и настройки babel.config.js (подробнее в нашем курсе JS: Настройка окружения), Jest начнёт использовать Babel при запуске тестов. Никакая конфигурация больше не требуется.

Jest ожидает, что тесты находятся в директории tests, которую обычно располагают в корне проекта. Внутри этого каталога, можно создавать любую структуру, Jest найдёт все тесты, которые там лежат. Именование файлов с тестами должно быть таким: .test.js. Где , как правило, соответствует имени модуля, который тестируется.

Напишем наш первый тест. Создайте файл tests/index.test.js со следующими содержимым:

import reverse from ‘../src’;

test(‘reverse’, () => { expect(reverse(‘hello’)).toEqual(‘olleh’); expect(reverse(‘’)).toEqual(‘’); }); Далее мы разберём структуру этого файла, а пока попробуем запустить тест на выполнение:

hexlet-jest $ npx jest PASS tests/index.test.js ✓ reverse (11ms)

Test Suites: 1 passed, 1 total Tests: 1 passed, 1 total Snapshots: 0 total Time: 1.166s Ran all test suites. Ура! Тесты прошли успешно.

Структура Давайте ещё раз посмотрим на файл с тестом:

import reverse from ‘../src’;

test(‘reverse’, () => { const str = ‘hello’; expect(reverse(str)).toEqual(‘olleh’); expect(reverse(‘’)).toEqual(‘’); }) Для тестов Jest предоставляет две глобальные функции: test и expect. Они доступны без какого-либо импорта, так как Jest делает их глобальными функциями.

Функция test нужна для описания конкретного теста и его проверок. Самих тестовых функций может быть любое количество. Первым параметром эта функция принимает произвольную строчку, которая должна описывать сам тест. Эта строчка потом отображается на экране во время запуска тестов для упрощения отладки.

hexlet-jest $ npx jest PASS tests/index.test.js ✓ reverse (11ms) # название теста Второй параметр — функция, внутри которой описан проверочный код. Обратите внимание на то, что этот код не выполняется сразу. Функция test добавляет его внутри Jest, который уже решает как и когда запускать тесты. Это позволяет проводить различные оптимизации например, выполнять тесты параллельно.

Самое необычное в этом коде — проверки. Jest использует “матчеры” (matchers). Это утверждения, имеющие особую структуру, напоминающую обращение к объекту. Общий принцип работы матчеров такой:

Вызывается функция expect куда передаётся актуальное (фактическое) значение. На результате, возвращаемом функцией expect, вызывается подходящий матчер, например, toEqual. Матчеры позволяют читать текст, практически, как английский язык:

// Ожидается, что результат выражения reverse(‘hello’) равен ‘olleh’ expect(reverse(‘hello’)).toEqual(‘olleh’); Подробнее о матчерах в следующем уроке.

Одна из приятнейших особенностей Jest — то, как он выводит сообщения о проваленных проверках. Попробуйте внести ошибку в исходную функцию и запустите тесты заново:

hexlet-jest$ npx jest FAIL tests/index.test.js ✕ reverse (9ms)

● reverse

expect(received).toEqual(expected) // Object.is equality

Expected: "olleh"
Received: "o|l|l|e|h"

  3 | test('reverse', () => {
  4 |   const str = 'hello';
> 5 |   expect(reverse(str)).toEqual('olleh');
    |                        ^
  6 | })
  7 |

  at Object.toEqual (__tests__/index.test.js:5:24)

Test Suites: 1 failed, 1 total Tests: 1 failed, 1 total Snapshots: 0 total Time: 1.683s Ran all test suites. В этом выводе показаны не только ожидаемое и фактическое значение, но и исходный код файла с тестами с указанием на конкретную проверку. Это невероятная и очень полезная фишка, которая значительно ускоряет анализ результатов тестирования и помогает в отладке.

Самостоятельная работа Выполните все шаги из этого урока Залейте код на Гитхаб

Чистый код, Боб Мартин

2019-07-17T05:55:20+00:00

Мелочи важны. Повышенное внимание к мелочам характерно для великих творцов. Стихотворение никогда не бывает законченным. Фальшивая монета всегда возвращается владельцу.

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

Функция должна выполнять только одну операцию, она должна выполнять ее хорошо и ничего другого делать не должна.

Один уровень абстракции на функцию

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

Объекты предоставляют поведение и скрывают данные Не возвращайте null

Принцип единой ответственности - класс или модуль должен иметь одну причину для изменения.

Используйте самое простое решение из всех возможных.

Чтобы написать чистый код, мы сначала пишем грязный код, а затем очищаем его.

Комментарии должны говорить то, что не скажет сам код.

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

Длина имени должна соответствовать его области видимости.

Не используйте имена, передающие информацию о реализации. Имена должны отражать уровень абстракции, на котором работает класс или функция.

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

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

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

Изучение чужого кода – непростая задача. Интеграция чужого кода тоже сложна. Одновременное решение обоих задач создает двойственные сложности. А что, если пойти по другому пути? Вместо того, чтобы экспериментировать и опробовать новую библиотеку в коде продукта, можно написать тесты. Проверяющие наше понимание стороннего кода. Джим Ньюкирк (JimNewkirk) называет такие тесты «учебными тестами».

Welcome to Jekyll!

2019-07-17T05:55:20+00:00

You’ll find this post in your _posts directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run jekyll serve, which launches a web server and auto-regenerates your site when a file is updated.

To add new posts, simply add a file in the _posts directory that follows the convention YYYY-MM-DD-name-of-post.ext and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.

Jekyll also offers powerful support for code snippets:

def print_hi(name)
  puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.

Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekyll’s GitHub repo. If you have questions, you can ask them on Jekyll Talk.