@sima-land/isomorph 10.1.0 → 11.0.0-alpha.2

package/src/create-response-sender/index.js

@@ -1,48 +0,0 @@
-import propOr from 'lodash/fp/propOr';
-
-const getDataLayer = propOr({}, ['app', 'dataLayer']);
-
-/**
- * Возвращает функцию ответа на запрос, подходящую для текущего окружения.
- * @param {Object} dependencies Зависимости.
- * @param {boolean} dependencies.config.isProduction Флаг production среды.
- * @param {Object} dependencies.response Объект ответа.
- * @return {Function} Функция ответа на запрос.
- */
-export default function createResponseSender ({ config: { isProduction }, response }) {
-  /**
-   * Функция ответа на запрос в формате HTML.
-   * @param {Object} options Опции.
-   * @param {string} options.markup Разметка.
-   */
-  const htmlSender = ({ markup }) => { response.send(markup); };
-
-  /**
-   * Функция ответа на запрос в формате JSON.
-   * @param {Object} options Опции.
-   * @param {string} options.markup Разметка.
-   * @param {{css: string, js: string, criticalJs: string[]}} options.assets Ссылки на ресурсы приложения.
-   * @param {Object} options.store Стор приложения.
-   */
-  const jsonSender = ({
-    markup,
-    assets: {
-      css,
-      js,
-      criticalJs,
-    },
-    store,
-  }) => {
-    const payload = {
-      markup,
-      bundle_css: css || '',
-      bundle_js: js || '',
-      critical_js: criticalJs || [],
-      meta: getDataLayer(store.getState()),
-    };
-
-    response.json(payload);
-  };
-
-  return isProduction ? jsonSender : htmlSender;
-}

package/src/get-dynamic-data/index.js

@@ -1,26 +0,0 @@
-import { getMethod, getStatus, getXClientIp, getOriginalUrl } from '../helpers/http/request-getters';
-
-/**
- * Получает данные API для логирования.
- * @param {Object} params Входные параметры.
- * @param {Object} params.response Ответ.
- * @param {string} params.timeDataKey Поле в response.local, из которого следует запрашивать log data.
- * @return {number} Статус ответа.
- */
-export const getApiLogData = ({ response, timeDataKey }) => response.locals[timeDataKey] || {};
-
-/**
- * Возвращает динамически получаемые данные.
- * @param {Object} dependencies Зависимости.
- * @param {Object} dependencies.config Конфигурация.
- * @param {string} dependencies.timeDataKey Поле в response.local, из которого следует запрашивать log data.
- * @return {Object} Объект с данными.
- */
-export const getDynamicData = ({ config, timeDataKey = 'logData' }) => (request, response) => ({
-  remote_ip: getXClientIp({ request }),
-  method: getMethod({ request }),
-  status: getStatus({ response }),
-  route: getOriginalUrl({ request }),
-  ...getApiLogData({ response, timeDataKey }),
-  version: config.version,
-});

package/src/graceful-shutdown/index.js

@@ -1,97 +0,0 @@
-import isFunction from 'lodash/isFunction';
-import isNumeric from '../helpers/utils/is-numeric';
-
-/**
- * Время ожидания до принудительного завершения процесса приложения по умолчанию.
- * @type {number}
- */
-export const defaultExitTimeout = 20000;
-
-/**
- * Декорирует http-сервер, добавляя остановку при завершении процесса node-приложения.
- * @param {import('http').Server} server Экземпляр класса http.Server.
- * @param {Object} [options] Экземпляр класса http.Server.
- * @param {Function} [options.onSuccess] Будет вызвана перед завершением процесса в случае успешного завершения.
- * @param {Function} [options.onError] Будет вызвана перед принудительным завершением процесса.
- * @param {number} [options.timeout=20000] Время ожидания остановки, после которого выполнится принудительная остановка.
- */
-export const decorateGracefulShutdown = (server, options) => {
-  const handleShutdown = createShutdownHandler(server, options);
-
-  // e.g. kill
-  process.on('SIGTERM', handleShutdown);
-
-  // e.g. Ctrl + C
-  process.on('SIGINT', handleShutdown);
-};
-
-/**
- * Возвращает функцию, которая запускает остановку http-сервера и завершает процесс приложения принудительно.
- * @param {import('http').Server} server Экземпляр класса http.Server.
- * @param {Object} [options] Экземпляр класса http.Server.
- * @param {Function} [options.onSuccess] Будет вызвана перед завершением процесса.
- * @param {Function} [options.onError] Будет вызвана перед завершением процесса.
- * @param {number} [options.timeout=20000] Время ожидания остановки, после которого выполнится принудительная остановка.
- * @return {Function} Функция, запускающая остановку http-сервера и завершающая процесс приложения принудительно.
- */
-export const createShutdownHandler = (
-  server,
-  {
-    onError,
-    onSuccess,
-    timeout = defaultExitTimeout,
-  } = {}
-) => {
-  const validTimeout = isNumeric(timeout)
-    ? Number(timeout)
-    : defaultExitTimeout;
-
-  return () => {
-    server.close(createCloseHandler(0, onSuccess));
-    setTimeout(createCloseHandler(1, onError), validTimeout); // принудительное завершение
-  };
-};
-
-/**
- * Возвращает функцию, которая завершает процесс node-приложения с определенным кодом.
- * @param {number} [exitCode=0] Код завершения процесса.
- * @param {Function} [onClose] Функция, которая будет вызвана перед завершением процесса.
- * @return {Function} Функция завершения процесса.
- */
-export const createCloseHandler = (exitCode = 0, onClose) => () => {
-  isFunction(onClose) && onClose(exitCode);
-  process.exit(exitCode);
-};
-
-/**
- * Создаёт обработчики событий завершения приложения.
- * @param {Object} options Опции.
- * @param {Object} options.logger Логгер.
- * @param {Object} [options.config] Конфигурация приложения.
- * @param {string} options.message Сообщение, которое будет залоггировано в консоль.
- * @return {Function} Обработчик завершения приложения.
- */
-export const onExitHandlerCreator = ({ logger, config, message }) => () => {
-  const { isDevelopment = true } = config || {};
-  isDevelopment && logger.info(message);
-};
-
-/**
- * Сервис для реализации лёгкого завершения приложения.
- * @param {Object} options Опции.
- * @param {Function} options.onExitError Обработчик завершения с ошибкой.
- * @param {Function} options.onExitSuccess Обработчик успешного завершения.
- * @param {number} options.processExitTimeout Максимальное время, отведённое приложению на завершение.
- * @return {Function} Функция, реализующая лёгкое завершение приложения.
- */
-export const gracefulShutdownCreator = (
-  {
-    onExitError: onError,
-    onExitSuccess: onSuccess,
-    processExitTimeout: timeout,
-  }
-) => server => decorateGracefulShutdown(server, {
-  onError,
-  onSuccess,
-  timeout,
-});

package/src/helpers/add-error-handling/index.js

@@ -1,24 +0,0 @@
-import isFunction from 'lodash/isFunction';
-
-/**
- * Возвращает функцию с обработкой ошибки обработчика роута Express.
- * @param {Function} handler Обработчик роута Express.
- * @param {Function} [errorHandler] Обработчик ошибки роута Express.
- * @return {Function} Обработчик роута обернутого для отлова ошибок.
- */
-export const addErrorHandling = (handler, errorHandler) => {
-  if (!isFunction(handler)) {
-    throw new Error('Аргумент "handler" должен быть функцией.');
-  }
-  return async (request, response, next, ...args) => {
-    try {
-      await handler(request, response, next, ...args);
-    } catch (err) {
-      if (isFunction(errorHandler)) {
-        await errorHandler(err, request, response, next, ...args);
-      } else {
-        await next(err);
-      }
-    }
-  };
-};

package/src/helpers/api/create-enhancer.js

@@ -1,52 +0,0 @@
-import { createService } from '../../container';
-
-/**
- * Конструктор для создания функции для применения middleware к экземпляру axios.
- * @param {Array} middlewares Middleware, которые должны быть применены.
- * @return {function(Object): Object} Функция для применения middleware к экземпляру axios.
- */
-export const applyMiddleware = (...middlewares) =>
-  instance =>
-    middlewares.reduce(
-      (currentInstance, middleware) => currentInstance.use(middleware),
-      instance
-    );
-
-/**
- * Функция для сборки middleware в функцию для применения к экземпляру axios.
- * @param {Array<Function>} constructors Функции-конструкторы middleware.
- * @param {Object} params Параметры для конструкторов.
- * @return {function(Object): Object} Функция для применения созданных middleware к экземпляру axios.
- */
-export const createEnhancer = (constructors, params) =>
-  applyMiddleware(
-    ...Array.isArray(constructors) ? constructors.map(constructor => constructor(params)) : []
-  );
-
-/**
- * Преобразует опции сервиса в аргументы функции.
- * @param {Object} param Параметры.
- * @param {Array<Function>} param.constructors Функции-конструкторы middleware.
- * @param {Object} param.params Параметры для конструкторов.
- * @return {Array} Массив агрументов для использования в функции.
- */
-export const mapServiceOptionsToArgs = (
-  {
-    constructors,
-    ...params
-  }
-) => [
-  constructors,
-  params,
-];
-
-/**
- * Функция для сборки middleware в функцию для применения к экземпляру axios для использования в контейнере.
- * @type {Function}
- */
-const enhancerConstructor = createService(
-  createEnhancer,
-  mapServiceOptionsToArgs
-);
-
-export default enhancerConstructor;

package/src/helpers/api/create-instance.js

@@ -1,42 +0,0 @@
-import { create } from 'middleware-axios';
-import isFunction from 'lodash/isFunction';
-import { createService } from '../../container';
-
-/**
- * Функция для создания экземпляра axios с возможностью передать обработчик для применения middleware.
- * @param {Object} config Конфигурация для axios.
- * @param {Function} enhancer Функция для применения middleware к экземпляру.
- * @return {Object} Экземпляр axios с применёнными middleware.
- */
-export const createInstance = (config, enhancer) => {
-  const instance = create(config);
-  return isFunction(enhancer) ? enhancer(instance) : instance;
-};
-
-/**
- * Преобразует опции сервиса в аргументы функции.
- * @param {Object} param Параметры.
- * @param {Object} param.config Конфигурация для axios.
- * @param {Function} param.enhancer Функция для применения middleware к экземпляру.
- * @return {Array} Массив агрументов для использования в функции.
- */
-export const mapServiceOptionsToArgs = (
-  {
-    config,
-    enhancer,
-  }
-) => [
-  config,
-  enhancer,
-];
-
-/**
- * Конструктор экземпляра axios для использования в контейнере.
- * @type {Function}
- */
-const instanceConstructor = createService(
-  createInstance,
-  mapServiceOptionsToArgs
-);
-
-export default instanceConstructor;

package/src/helpers/api/middlewares/collect-cookie-middleware.js

@@ -1,27 +0,0 @@
-import uniq from 'lodash/uniq';
-import get from 'lodash/get';
-
-/**
- * Создаёт middleware для сбора cookie со всех запросов в API и их передачи в ответ сервера.
- * @param {Object} options Параметры для создания middleware.
- * @param {Object} options.response Ответ на запрос в сервис.
- * @return {function(Object, Function): Promise} Middleware для сбора cookie со всех запросов в API.
- */
-const createCollectCookieMiddleware = ({ response }) =>
-
-  /**
-   * Middleware для сбора cookie со всех запросов в API.
-   * @param {Object} requestConfig Конфигурация запроса API.
-   * @param {Function} next Функция для передачи контекста выполнения следующему middleware.
-   * @return {Promise} Промис.
-   */
-  async (requestConfig, next) => {
-    const apiResponse = await next(requestConfig);
-    const initialCookie = response.get('set-cookie') || [];
-    const additionalCookie = get(apiResponse, 'headers.set-cookie', []);
-    if (additionalCookie.length) {
-      response.set('set-cookie', uniq([...initialCookie, ...additionalCookie]));
-    }
-  };
-
-export default createCollectCookieMiddleware;

package/src/helpers/api/middlewares/count-api-response-time.js

@@ -1,31 +0,0 @@
-import { getMsFromHRT } from '../../utils/get-ms-from-hrt';
-
-/**
- * Создаёт middleware, собирающий данные о времени ответа запросов в API.
- * @param {Object} param Параметры.
- * @param {Object} param.response Ответ.
- * @param {string} param.timeDataKey Ключ свойства в response.locals для сохранения замеров времени.
- * @return {function(Object, Function)} Middleware для сохранения времени ответа API.
- */
-const createCountApiResponseTimeMiddleware = ({ response, timeDataKey }) =>
-
-  /**
-   * Middleware для сбора данных о времени ответа запросов в API.
-   * @param {Object} requestConfig Конфигурация запроса API.
-   * @param {Function} next Функция для передачи контекста выполнения следующему middleware.
-   * @return {Promise} Промис.
-   */
-  async (requestConfig, next) => {
-    const startTime = process.hrtime();
-    const apiResponse = await next(requestConfig);
-    const url = apiResponse.config.url.replace(/\/\d+/gi, '/ID');
-    const method = apiResponse.config.method.toUpperCase();
-
-    if (!response.locals[timeDataKey]) {
-      response.locals[timeDataKey] = {};
-    }
-    response.locals[timeDataKey][`${method} ${url}`] = getMsFromHRT(process.hrtime(startTime));
-    return response;
-  };
-
-export default createCountApiResponseTimeMiddleware;

package/src/helpers/api/middlewares/error-handlers-middlewares.js

@@ -1,124 +0,0 @@
-import { createService } from '../../../container';
-import pick from 'lodash/pick';
-
-/**
- * Отправляет крошки http запроса.
- * @param {Function} sendBreadcrumb Функция отправки крошек.
- * @param {Object} response Объект в формате ответа Axios, содержащий данные об ответе.
- * @param {boolean} asRequest Обработать как событие запроса.
- * @private
- */
-export const _sendHttpBreadcrumb = (sendBreadcrumb, response, asRequest = false) => {
-  const statusCode = asRequest ? 'FETCHING' : response?.status || 'UNKNOWN';
-  const { url, baseURL, method, params } = response?.config || {};
-
-  const fullURL = baseURL ? `${baseURL.replace(/\/$/, '')}${url}` : url;
-
-  const breadcrumb = {
-    category: asRequest ? 'http.request' : 'http.response',
-    type: 'http',
-    data: {
-      url: fullURL,
-      status_code: statusCode,
-      method: method && method.toUpperCase(),
-      params,
-    },
-    level: asRequest || (statusCode >= 200 && statusCode < 300) ? 'info' : 'error',
-  };
-
-  sendBreadcrumb && sendBreadcrumb(breadcrumb);
-};
-
-/**
- * Создаёт middleware, добавляющий хлебные крошки о запросе в API в сервис логирования ошибок.
- * @param {Object} sentry Сервис логирования.
- * @param {Function} sentry.captureBreadcrumb Функция сбора хлебных крошек.
- * @return {function(Object, Function)} Middleware для добавления крошек.
- * @private
- */
-const _createAttachBreadcrumbsMiddleware = ({ captureBreadcrumb }) =>
-
-  /**
-   * Middleware добавления крошек в сервис логирования.
-   * @param {Object} requestConfig Конфигурация запроса API.
-   * @param {Function} next Функция для передачи контекста выполнения следующему middleware.
-   * @return {Promise} Промис.
-   */
-  async (config, next, defaults) => {
-    try {
-      _sendHttpBreadcrumb(captureBreadcrumb, { config: { ...defaults, ...config } }, true);
-
-      const apiResponse = await next(config);
-
-      _sendHttpBreadcrumb(captureBreadcrumb, apiResponse);
-    } catch (error) {
-      error.isAxiosError && error.response && _sendHttpBreadcrumb(captureBreadcrumb, error.response);
-
-      throw error;
-    }
-  };
-
-/**
- * Создаёт middleware, отправляющий исключения при запросе в API в сервис логирования ошибок.
- * @param {Object} sentry Сервис логирования.
- * @param {Function} sentry.captureExtendedException Функция отправки исключения.
- * @return {function(Object, Function)} Middleware для захвата исключения.
- * @private
- */
-const _createHandleExceptionMiddleware = ({ captureExtendedException }) =>
-  async (config, next, defaults) => {
-    try {
-      await next(config);
-    } catch (error) {
-      const { status } = error.response || {};
-      const { logLevelConfig } = config;
-
-      captureExtendedException && captureExtendedException(
-        error,
-        pick(
-          { ...defaults, ...config },
-          ['url', 'baseURL', 'method', 'headers', 'params', 'data']
-        ),
-        {
-          dataName: 'Request details',
-          dataAsContext: true,
-          level: _getLevelFromConfig(status, logLevelConfig),
-        }
-      );
-    }
-  };
-
-/**
- * Функция преобразования конфига уровней логирования запроса в уровень логирования Sentry.
- * @param {number} statusCode Код ответа сервера.
- * @param {Object} logLevelConfig Конфиг уровней логирования. `{ default: 'error', 422: 'warning', 419: 'error' }`.
- * @return {string} Log level.
- * @private
- */
-export const _getLevelFromConfig = (statusCode, logLevelConfig = {}) => {
-  let level = logLevelConfig.default || 'warning';
-
-  if (statusCode && logLevelConfig[statusCode]) {
-    level = logLevelConfig[statusCode];
-  }
-
-  return level;
-};
-
-/**
- * Функция преобразования зависимостей сервиса в аргументы функции.
- * @param {Object} dependencies Зависимости.
- * @return {Array} Массив аргументов.
- * @private
- */
-export const _deptToArg = ({ sentry }) => [sentry];
-
-export const createAttachBreadcrumbsMiddleware = createService(
-  _createAttachBreadcrumbsMiddleware,
-  _deptToArg
-);
-
-export const createHandleExceptionMiddleware = createService(
-  _createHandleExceptionMiddleware,
-  _deptToArg
-);

package/src/helpers/api/middlewares/helpers.js

@@ -1,26 +0,0 @@
-import pipe from 'lodash/fp/pipe';
-import path from 'lodash/fp/path';
-import pickBy from 'lodash/fp/pickBy';
-
-// Префикс сервисных заголовков.
-const SERVICE_PREFIX = 'Simaland-';
-
-/**
- * Возвращает объект заголовков, содержащих в своем названии префикс сервисных заголовков.
- * @param {import('http').IncomingMessage} request Запрос приложения.
- * @param {Object} request.headers Заголовки запроса.
- * @return {Object.<string, string>} Коллекция сервисных заголовков.
- */
-export const getServiceHeaders = pipe(
-  path('headers'),
-  pickBy((value, key) => key.toLowerCase().indexOf(SERVICE_PREFIX.toLowerCase()) === 0)
-);
-
-/** Формирует из параметров конфигурации и возвращает User-Agent.
- * @param {Object} config Конфигурация приложения.
- * @param {string} config.serviceName Название сервиса из конфигурации.
- * @param {string} config.version Версия приложения.
- * @return {string} User-Agent.
- */
-export const getServiceUserAgent = ({ serviceName, version } = {}) =>
-  serviceName && version ? `simaland-${serviceName}/${version}` : '';

package/src/helpers/api/middlewares/pass-headers-middleware.js

@@ -1,19 +0,0 @@
-/**
- * Создаёт middleware для добавления заголовков в запросы API.
- * @param {Object} options Параметры для создания middleware.
- * @param {Object} options.headers Объект заголовков для добавления к запросу в API.
- * @return {function(Object, Function): Promise} Middleware для использования в API.
- */
-export const createPassHeadersMiddleware = ({ headers }) =>
-  async (requestConfig, next) => {
-    if (!requestConfig.headers) {
-      requestConfig.headers = {};
-    }
-
-    requestConfig.headers = {
-      ...requestConfig.headers,
-      ...headers,
-    };
-
-    await next(requestConfig);
-  };

package/src/helpers/api/middlewares/prepare-request-headers.js

@@ -1,18 +0,0 @@
-import omit from 'lodash/omit';
-import { getCookie, getXClientIp } from '../../http/request-getters';
-import { getServiceHeaders, getServiceUserAgent } from './helpers';
-
-/**
- * Формирует объект заголовков из конфигурации приложения и запроса к приложению.
- * @param {Object} options Опции сервиса.
- * @param {Object} options.config Конфигурация приложения.
- * @param {import('http').IncomingMessage} options.request Запрос приложения.
- * @param {string|string[]} options.exclude Заголовки, которые требуется исключить из итогового списка.
- * @return {Object} Заголовки.
- */
-export const prepareRequestHeaders = ({ config, request, exclude = [] }) => omit({
-  'X-Client-Ip': getXClientIp({ request }),
-  'User-Agent': getServiceUserAgent(config),
-  Cookie: getCookie(request),
-  ...getServiceHeaders(request),
-}, exclude);

package/src/helpers/api/middlewares/set-http-agents-middleware.js

@@ -1,22 +0,0 @@
-import http from 'http';
-import https from 'https';
-
-/**
- * Добавляет в конфигурацию запроса опции httpAgent и httpsAgent.
- * @param {Object} options Параметры для создания middleware.
- * @param {https.Agent} options.httpsAgent Кастомизированный экземпляр https.Agent.
- * @param {http.Agent} options.httpAgent Кастомизированный экземпляр  http.Agent.
- * @return {function(Object, Function):Promise} Middleware для использования в API.
- */
-const createSetHttpAgentsMiddleware = ({ httpsAgent, httpAgent }) =>
-  async (requestConfig, next) => {
-    if (httpAgent instanceof http.Agent) {
-      requestConfig.httpAgent = httpAgent;
-    }
-    if (httpsAgent instanceof https.Agent) {
-      requestConfig.httpsAgent = httpsAgent;
-    }
-    await next(requestConfig);
-  };
-
-export default createSetHttpAgentsMiddleware;

package/src/helpers/api/middlewares/stages-trace-middleware.js

@@ -1,46 +0,0 @@
-import EventEmitter from 'events';
-import { REQUEST_STAGES } from '../server-adapter/constants';
-import { FORMAT_HTTP_HEADERS } from 'opentracing';
-
-/**
- * Класс, наследующий от EventEmitter.
- */
-export class StageRequestEmitter extends EventEmitter {}
-
-/**
- * Создаёт middleware для трассировки этапов запроса в API.
- * @param {Object} options Параметры для создания middleware.
- * @param {Object} options.tracer Объект трейсера.
- * @return {function(Object, Function): Promise} Middleware для трассироваки запросов в API.
- */
-const createStagesTraceRequestMiddleware = ({ tracer }) =>
-
-  /**
-   * Middleware для трассировки этапов запроса в API.
-   * @param {Object} requestConfig Параметры для создания middleware.
-   * @param {Function} next Функция для получения данных.
-   * @return {Promise} Promise.
-   */
-  async (requestConfig, next) => {
-    const parentSpanContext = tracer.extract(FORMAT_HTTP_HEADERS, requestConfig.headers);
-    const emitter = new StageRequestEmitter();
-
-    let currentSpan;
-    Object.values(REQUEST_STAGES).map(stage => emitter.on(stage, () => {
-      if (currentSpan) {
-        currentSpan
-          .setOperationName(stage.replace('finish:', ''))
-          .finish();
-      }
-      if (stage !== REQUEST_STAGES.end) {
-        currentSpan = tracer.startSpan('', { childOf: parentSpanContext });
-      }
-    }));
-    requestConfig.emitter = emitter;
-
-    await next(requestConfig);
-
-    emitter.removeAllListeners();
-  };
-
-export default createStagesTraceRequestMiddleware;