@sima-land/isomorph 9.0.7 → 11.0.0-alpha.0

package/src/helpers/tracer/create-child-tracing-middleware.js

@@ -1,42 +0,0 @@
-import { createObserveMiddleware } from '../../observe-middleware';
-import isString from 'lodash/isString';
-
-/**
- * Возвращает функцию, создающую middleware для добавления в трэйсер длительности внутреннего процесса
- * при обработке запроса.
- * @param {Object} dependencies Опции.
- * @param {string} dependencies.spanName Имя span'а.
- * @param {Object} dependencies.tracer Экземпляр трэйсера.
- * @param {Function} dependencies.startSubscriber Подписчик на событие начала рендеринга.
- * @param {Function} dependencies.finishSubscriber Подписчик на событие конца рендеринга.
- * @param {string} [dependencies.parentSpan='span'] Иимя родительского спана в response.locals.
- * @return {Function} Middleware приложения Express.
- */
-export const createChildTracingMiddleware = ({
-  spanName,
-  tracer,
-  startSubscriber,
-  finishSubscriber,
-  parentSpan = 'span',
-}) => {
-  if (!isString(spanName)) {
-    throw new TypeError('"spanName" properties must be a string');
-  }
-  return createObserveMiddleware({
-    onStart: (timestamp, request, response) => {
-      response.locals[spanName] = tracer.startSpan(
-        spanName,
-        {
-          childOf: response.locals[parentSpan],
-        }
-      );
-    },
-    onFinish: (duration, request, response) => {
-      response.locals[spanName]
-        .setTag(`${spanName} duration`, `${duration} ms`)
-        .finish();
-    },
-    startSubscriber,
-    finishSubscriber,
-  });
-};

package/src/helpers/tracer/index.js

@@ -1,171 +0,0 @@
-import { initTracerFromEnv } from 'jaeger-client';
-import { FORMAT_HTTP_HEADERS } from 'opentracing';
-import { createObserveMiddleware } from '../../observe-middleware/';
-import isFunction from 'lodash/isFunction';
-import get from 'lodash/get';
-import { createService } from '../../container';
-import isPlainObject from 'lodash/isPlainObject';
-import { getOriginalUrl } from '../http/request-getters';
-import mapValues from 'lodash/fp/mapValues';
-
-const mapValuesWithKey = mapValues.convert({ cap: false });
-
-/**
- * Возвращает новый объект, в котором заменено значение свойств, имена которых содержат 'Password'.
- */
-const filterSecrets = mapValuesWithKey((value, key) => key.includes('Password') ? '[Filtered]' : value);
-
-/**
- * Запускает трассировку входящего http-запроса.
- * @param {Object} tracer Экземпляр трейсера.
- * @param {string} key Ключ.
- * @param {Object} httpRequest Запрос.
- * @param {Object} [payload] Дополнительная информация для добавления к спану.
- * @return {Object} Спан.
- */
-export const traceIncomingRequest = (tracer, key, httpRequest, payload) =>
-  tracer
-    .startSpan(
-      key,
-      {
-        childOf: tracer.extract(FORMAT_HTTP_HEADERS, httpRequest.headers),
-      }
-    )
-    .addTags(isPlainObject(payload) ? payload : {});
-
-/**
- * Создаёт новый или возвращает существующий экземпляр jaeger-трейсера.
- * @param {Object} dependencies Зависимости.
- * @param {Object} dependencies.tracerConfig Основные параметры конфигурации трейсера.
- * @param {string} dependencies.tracerConfig.serviceName Название сервиса.
- * @param {number} dependencies.tracerConfig.version Версия сборки.
- * @param {Object} [dependencies.additionalConfig={}] Дополнительные параметры конфигурации трейсера.
- * @return {import('opentracing').Tracer} Объект трейсера.
- */
-export const getTracer = ({
-  tracerConfig: {
-    version,
-    serviceName,
-  },
-  additionalConfig = {},
-}) => initTracerFromEnv(
-  {
-    serviceName,
-    ...additionalConfig,
-  },
-  {
-    tags: {
-      [`${serviceName}.version`]: version,
-    },
-  }
-);
-
-/**
- * Возвращает функцию - промежуточный слой для маршрутов express-приложения.
- * Сигнализирует о начале и конце запроса.
- * @param {Function} createSpan Функция возвращающая новый объект span, вызываемая при старте запроса.
- * @param {Function} onSpanFinish Функция получающая созданный span, вызываемая при ответе.
- * @param {Object} [options] Необязательные опции.
- * @param {string} [options.spanKey='span'] Ключ, под которым будет сохранен span в response.locals.
- * @return {Function} Функция - промежуточный слой для маршрутов.
- * @private
- */
-export const _createTracingMiddleware = (
-  createSpan,
-  onSpanFinish,
-  { spanKey = 'span' } = {}
-) => {
-  const hasSpanCreator = isFunction(createSpan);
-  const hasFinishHandler = isFunction(onSpanFinish);
-
-  return createObserveMiddleware({
-    onStart: (startTime, request, response) => {
-      if (hasSpanCreator) {
-        response.locals[spanKey] = createSpan(request, response);
-      }
-    },
-    onFinish: (duration, request, response) => {
-      if (hasFinishHandler) {
-        onSpanFinish(request, response, response.locals[spanKey]);
-      }
-    },
-  });
-};
-
-/**
- * Получает контекст из объекта текущего ответа.
- * @param {Object} response Объект с параметрами текущего ответа.
- * @return {Object|null} Текущий контекст.
- */
-export const getSpanContext = ({ response }) => {
-  let context;
-  if (isFunction(get(response, 'locals.span.context'))) {
-    context = response.locals.span.context();
-  }
-  return context || null;
-};
-
-/**
- * Функция преобразования зависимостей сервиса в аргументы функции.
- * @param {Object} dependencies Зависимости.
- * @return {Array} Массив аргументов.
- * @private
- */
-export const _deptToArg = ({ createSpan, onSpanFinish, options }) => [createSpan, onSpanFinish, options];
-
-/**
- * Возвращает сервис для создания промежуточного слоя трассировки.
- * @return {Function} Сервис.
- */
-export const tracingMiddlewareCreator = createService(
-  _createTracingMiddleware,
-  _deptToArg
-);
-
-/**
- * Сервис для создания span-ов трейсинга.
- * @param {Object} dependencies Параметры сервиса.
- * @param {Object} dependencies.jaegerTracer Трейсер.
- * @param {Object} dependencies.config Конфигурация приложения.
- * @return {Function} Функция для создания спана.
- */
-export const createSpanCreator = ({ jaegerTracer, config }) => request => traceIncomingRequest(
-  jaegerTracer,
-  'incoming-http-request',
-  request,
-  _getRequestContext(request, config)
-);
-
-/**
- * Обработчик завершения трейса.
- * @param {import('http').IncomingMessage} req Запрос.
- * @param {import('http').ServerResponse} res Ответ.
- * @param {import('opentracing').Span} span Спан.
- */
-export const spanFinishHandler = (req, res, span) => {
-  span.finish();
-};
-
-/**
- * Возвращает контекст, в котором обрабатывается запрос к сервису, для добавления в span.
- * @param {import('http').IncomingMessage} request Запрос.
- * @param {Object} config Конфигурация приложения.
- * @return {Object} Контекст.
- * @private
- */
-export const _getRequestContext = (request, config) => {
-  const context = {
-    'request.path': getOriginalUrl({ request }),
-    'app.config': isPlainObject(config) ? filterSecrets(config) : '',
-  };
-
-  if (isPlainObject(request.headers) && isFunction(request.get)) {
-    Object.keys(request.headers).forEach(key => {
-      if (key.toLowerCase().startsWith('simaland-')) {
-        context[`request.headers.${key}`] = request.get(key);
-      }
-    });
-  }
-
-  return context;
-};

package/src/helpers/utils/check-feature-by-segment.js

@@ -1,32 +0,0 @@
-import pipe from 'lodash/fp/pipe';
-import isString from 'lodash/isString';
-import split from 'lodash/fp/split';
-import map from 'lodash/fp/map';
-import compact from 'lodash/compact';
-import get from 'lodash/get';
-import trim from 'lodash/trim';
-
-/**
- * Конвертирует строку со списком сегментов в массив.
- * @param {string} segments Строка со списком сегментов.
- * @return {Array} Массив со списком сегментов.
- */
-const convertSegmentsToArray = pipe(
-  value => isString(value) ? value : '',
-  split(','),
-  compact,
-  map(trim)
-);
-
-/**
- * Возвращает функцию, определяющую включена ли заданная фича.
- * @param {string} feature Название фичи.
- * @return {function(string, string[]): boolean} Функция.
- */
-export const checkFeatureBySegment = feature => (userSegment, allFeatures) => {
-  const segments = convertSegmentsToArray(get(allFeatures, feature));
-
-  return segments.includes('ALL') || segments.includes(userSegment);
-};
-
-export default checkFeatureBySegment;

package/src/helpers/utils/format-object-keys.js

@@ -1,23 +0,0 @@
-import isPlainObject from 'lodash/isPlainObject';
-import camelCase from 'lodash/camelCase';
-
-/**
- * Переводит ключи объекта в camelCase.
- * @param {Object} object Объект ключи которого нужно отформатировать.
- * @return {Object} Отформатированный объект.
- */
-export default function formatObjectKeys (object) {
-  if (!isPlainObject(object)) {
-    throw new TypeError('Параметр "object" должен быть чистым объектом');
-  }
-
-  return Object.entries(object).reduce((formattedObject, current) => {
-    const [key, value] = current;
-    const formattedKey = camelCase(key);
-
-    if (formattedKey) {
-      formattedObject[formattedKey] = value;
-    }
-    return formattedObject;
-  }, {});
-}

package/src/helpers/utils/get-ms-from-hrt.js

@@ -1,16 +0,0 @@
-import isNumber from 'lodash/isNumber';
-
-/**
- * Возвращает количество миллисекунд по переданному результату вызова process.hrtime.
- * @param {Array<number>} hrtime Результат вызова process.hrtime.
- * @return {number} Количество миллисекунд.
- */
-export const getMsFromHRT = hrtime => {
-  let result = NaN;
-  if (Array.isArray(hrtime) && hrtime.every(isNumber)) {
-    result = (hrtime[0] * 1000) + (hrtime[1] / 1e6);
-  }
-  return result;
-};
-
-export default getMsFromHRT;

package/src/helpers/utils/is-match-pattern-list.js

@@ -1,13 +0,0 @@
-import isArray from 'lodash/isArray';
-import isString from 'lodash/isString';
-
-/**
- * Проверяет, соответствует ли переданная строка одному из паттернов в переданном масиве.
- * @param {string} str Строка для проверки.
- * @param {string[]} patternList Массив строк.
- * @return {boolean} Соответствует или нет.
- */
-const isMatchPatternList = (str, patternList) =>
-  isString(str) && isArray(patternList) && patternList.some(pattern => RegExp(pattern).test(str));
-
-export default isMatchPatternList;

package/src/helpers/utils/is-not-empty-array.js

@@ -1,8 +0,0 @@
-/**
- * Проверяет, является ли переданное значение НЕ пустым массивом.
- * @param {*} data Проверяемое значение.
- * @return {boolean} Переданное значение является НЕ пустым массивом?
- */
-export const isNotEmptyArray = data => Array.isArray(data) && data.length > 0;
-
-export default isNotEmptyArray;

package/src/helpers/utils/is-not-empty-string.js

@@ -1,11 +0,0 @@
-/**
- * Проверяет, является ли переданное значение НЕ пустой строкой (или строкой содержащей только пробельные символы).
- * @param {*} value Проверяемое значение.
- * @param {*} trim Обрезка пробельных символов.
- * Если передано false - к строке не будет применена функция trim() перед проверкой на длину.
- * @return {boolean} Переданное значение является НЕ пустой строкой?
- */
-export const isNotEmptyString = (value, trim = true) => typeof value === 'string'
-  && (trim ? value.trim().length > 0 : value.length > 0);
-
-export default isNotEmptyString;

package/src/helpers/utils/is-numeric.ts

@@ -1,12 +0,0 @@
-/**
- * Проверяет, является ли переданное значение числовым (может иметь строковый или числовой тип).
- * @param value Проверяемое значение.
- * @return Переданное значение является числовым?
- */
-export const isNumeric = (value: any): value is string | number => {
-  const validTypes = ['string', 'number', 'bigint'];
-  const hasValidType = validTypes.some(type => typeof value === type);
-  return hasValidType && !isNaN(parseFloat(value)) && isFinite(Number(value));
-};
-
-export default isNumeric;

package/src/helpers/utils/wrap-in-measure-event.js

@@ -1,35 +0,0 @@
-import EventEmitter from 'events';
-import isFunction from 'lodash/isFunction';
-import isString from 'lodash/isString';
-
-/**
- * Оборачивает выполнение какой-либо функции в отправку событий начала и конца выполнения.
- * @param {Object} param Параметры.
- * @param {Function} param.fn Функция, которую необходимо обернуть.
- * @param {string} param.startEvent Название события начала измерения.
- * @param {string} param.endEvent Название события конца измерения.
- * @param {EventEmitter} param.emitter Объект на котором будут отправляться события.
- * @return {Function} Функция обёрнутая в отправку событий.
- */
-export const wrapInMeasureEvent = ({ fn, startEvent, endEvent, emitter }) => {
-  if (!isFunction(fn)) {
-    throw new TypeError('First argument property "fn" must be a function');
-  }
-  if (!isString(startEvent)) {
-    throw new TypeError('First argument property "startEvent" must be a string');
-  }
-  if (!isString(endEvent)) {
-    throw new TypeError('First argument property "endEvent" must be a string');
-  }
-  if (!(emitter instanceof EventEmitter)) {
-    throw new TypeError('First argument property "emitter" must be an instance of EventEmitter');
-  }
-  return async (...args) => {
-    emitter.emit(startEvent);
-    const result = await fn(...args);
-    emitter.emit(endEvent);
-    return result;
-  };
-};
-
-export default wrapInMeasureEvent;

package/src/logger/create-logger-middleware/index.js

@@ -1,46 +0,0 @@
-import isFunction from 'lodash/isFunction';
-import isArray from 'lodash/isArray';
-import { createObserveMiddleware } from '../../observe-middleware';
-import { getOriginalUrl } from '../../helpers/http/request-getters';
-import isMatchPatternList from '../../helpers/utils/is-match-pattern-list';
-
-/**
- * Конструктор для создания middleware для express-приложения.
- * @param {Object} dependencies Зависимости.
- * @param {Function} dependencies.pinoLogger Экземпляр логгера.
- * @param {Function} dependencies.getDynamicData
- * Функция, формирующая данные, которые нужно получить после завершения запроса.
- * @param {string[]} dependencies.exclusions Массив шаблонов url для исключения из логирования.
- * @return {Function} Middleware для express-приложения.
- */
-export default function createLoggerMiddleware (dependencies = {}) {
-  const {
-    pinoLogger,
-    getDynamicData,
-    exclusions = [],
-  } = dependencies;
-
-  if (!pinoLogger) {
-    throw Error('First argument property "pinoLogger" is empty.');
-  }
-
-  if (!isFunction(getDynamicData)) {
-    throw TypeError('"getDynamicData" must be Function.');
-  }
-
-  if (!isArray(exclusions)) {
-    throw TypeError('"exclusions" must be array.');
-  }
-
-  return createObserveMiddleware({
-    onFinish: (timestamp, request, response) => {
-      const url = getOriginalUrl({ request });
-      if (!isMatchPatternList(url, exclusions)) {
-        pinoLogger.info({
-          ...getDynamicData(request, response),
-          latency: timestamp,
-        });
-      }
-    },
-  });
-}

package/src/logger/create-sentry-instance/index.js

@@ -1,74 +0,0 @@
-import { createService } from '../../container';
-import isFunction from 'lodash/isFunction';
-import negate from 'lodash/negate';
-
-const notFunc = negate(isFunction);
-
-// Ключи перехватчиков, которые должен имплементировать экземпляр.
-const CAPTURE_METHODS_KEYS = [
-  'captureException',
-  'captureMessage',
-  'addBreadcrumb',
-  'withScope',
-  'configureScope',
-];
-
-/**
- * @typedef {Object} SentryInstance Экземпляр Sentry.
- * @property {Function} init Были ли запрос совершен успешно.
- * @property {Function} captureException  Функция отправки ошибки.
- * @property {Function} captureMessage Функция отправки сообщения.
- * @property {Function} addBreadcrumb Функция прикрепления последовательности действий.
- */
-
-/**
- * Создает новый экземпляр Sentry.
- * @param {Object} sentry Объект Sentry, имплементирующий методы для создания экземпляра.
- * @param {Function} [sentry.BrowserClient] Конструктор экземпляра в sdk браузера.
- * @param {Function} [sentry.NodeClient] Конструктор экземпляра в sdk Node.
- * @param {Function} sentry.Hub Конструктор концентратора (связывает экземпляр с областью видимости).
- * @return {SentryInstance} Экземпляр Sentry.
- */
-export const createSentryInstance = ({ BrowserClient, NodeClient, Hub }) => {
-  const CurrentClient = BrowserClient || NodeClient;
-
-  if (notFunc(CurrentClient)) {
-    throw new TypeError('Параметр "BrowserClient"/"NodeClient" должен быть функцией');
-  }
-
-  if (notFunc(Hub)) {
-    throw new TypeError('Параметр "Hub" должен быть функцией');
-  }
-
-  const hub = new Hub();
-
-  /**
-   * Функция инициализации нового экземпляра Sentry.
-   * @param {Object} options Опции инициализации.
-   */
-  const init = options => {
-    const client = new CurrentClient(options);
-    hub.bindClient(client);
-  };
-
-  const captureMethods = Object.fromEntries(
-    CAPTURE_METHODS_KEYS.map(key => [key, (...args) => hub[key](...args)])
-  );
-
-  return {
-    init,
-    ...captureMethods,
-  };
-};
-
-/**
- * Функция преобразования зависимостей сервиса в аргументы функции.
- * @param {Object} dependencies Зависимости.
- * @return {Array} Массив аргументов.
- */
-export const deptToArg = ({ sentry }) => [sentry];
-
-export default createService(
-  createSentryInstance,
-  deptToArg
-);

package/src/logger/create-sentry-middleware/index.js

@@ -1,16 +0,0 @@
-import { Handlers } from '@sentry/node';
-
-/**
- * @typedef {Object} SentryMiddleware Объект middlewares Sentry.
- * @property {Function} request Middleware, добавляющий данные запроса в scope Sentry.
- * @property {Function} failure Middleware, обрабатывающий ошибки.
- */
-
-/**
- * Конструктор для создания middleware для Sentry.
- * @return {SentryMiddleware} Объект middleware для Sentry.
- */
-export const createSentryMiddleware = () => ({
-  request: Handlers.requestHandler(),
-  failure: Handlers.errorHandler(),
-});

package/src/logger/handler-creators/index.js

@@ -1,38 +0,0 @@
-/**
- * Возвращает обработчик ошибки, передающий ошибку Sentry.
- * @param {Function} captureExtendedException Метод захвата ошибки Sentry.
- * @return {Function} Обработчик ошибки.
- */
-export const createSentryHandlerForSagas = ({ sentry: { captureExtendedException } }) =>
-
-  /**
-   * Обработчик ошибки, передающий ошибку методу Sentry.
-   * @param {Error} error Объект ошибки.
-   * @param {string} sagaStack Стек вызовов саг.
-   */
-  (error, { sagaStack }) => captureExtendedException(error, sagaStack, { dataName: 'Sagas stack' });
-
-/**
- * Возвращает обработчик ошибки, передающий ошибку Sentry.
- * @param {Function} captureException Метод захвата ошибки Sentry.
- * @return {Function} Обработчик ошибки.
- */
-export const createSentryHandlerForStore = ({ sentry: { captureException } }) =>
-  () => captureException(new Error('Ожидание готовности store было прервано по таймауту'));
-
-/**
- * Возвращает функцию для базовой конфигурации области действия экземпляра Sentry.
- * @param {Object} options Опции сервиса.
- * @param {Object} options.config Конфигурация приложения.
- * @return {Function} Функция, конфигурирующая область действия.
- */
-export const createDefaultScopeConfigurator = ({ config }) => scope => {
-  /**
-   * Добавляем к области действия контекст с текущей конфигурацией приложения.
-   * Если передается большой объект (например, если не отфильтрованы ненужные переменные окружения
-   * при создании конфига), то лучше использовать метод `setExtra`, иначе Sentry обрежет часть данных в GUI,
-   * но они все еще будут доступны в "сырых" данных.
-   * @see https://docs.sentry.io/enriching-error-data/additional-data/?platform=javascript#debugging-additional-data
-   */
-  scope.setContext('App config', config);
-};

package/src/logger/initialize-sentry-creator/index.js

@@ -1,43 +0,0 @@
-import isFunction from 'lodash/isFunction';
-
-/**
- * Выполняет конфигурацию переданного сервиса Sentry.
- * @param {Object} options Опции.
- * @param {Object} options.sentryLoggerService Сервис Sentry.
- * @param {Function} options.getSentryDsn Функция, возвращающая DSN Sentry.
- * @param {Function} [options.getSentryOptions] Функция, возвращающая объект опций Sentry.
- * @param {Function} [options.configureMainScope] Функция конфигурации основной области действия
- * экземпляра/глобального экземпляра Sentry.
- * @return {Function} Функция, возвращающая сконфигурированный сервис Sentry.
- */
-const initializeSentryCreator = (
-  {
-    sentryLoggerService,
-    getSentryDsn,
-    getSentryOptions,
-    configureMainScope,
-  }
-) => () => {
-  if (!isFunction(getSentryDsn)) {
-    throw new TypeError('"getSentryDsn" must be a function');
-  }
-  if (getSentryOptions && !isFunction(getSentryOptions)) {
-    throw new TypeError('"getSentryOptions" must be a function');
-  }
-  if (configureMainScope && !isFunction(configureMainScope)) {
-    throw new TypeError('"configureMainScope" must be a function');
-  }
-
-  const sentryDSN = getSentryDsn() || '';
-  const sentryOptions = (getSentryOptions && getSentryOptions()) || {};
-  sentryLoggerService.init({
-    dsn: sentryDSN,
-    ...sentryOptions,
-  });
-
-  if (isFunction(sentryLoggerService.configureScope) && isFunction(configureMainScope)) {
-    sentryLoggerService.configureScope(configureMainScope);
-  }
-};
-
-export default initializeSentryCreator;

package/src/logger/sentry-logger/index.js

@@ -1,33 +0,0 @@
-/**
- * Сервис для логирования ошибок в Sentry.
- * @param {Object} [options] Опции.
- * @param {Object} [options.sentryLoggerService] Сервис Sentry.
- * @return {Object} Сервис.
- */
-export default function sentryLogger ({ sentryLoggerService } = {}) {
-  return {
-    captureException: (...args) => sentryLoggerService.captureException(...args),
-    captureMessage: (...args) => sentryLoggerService.captureMessage(...args),
-    captureBreadcrumb: (...args) => sentryLoggerService.addBreadcrumb(...args),
-
-    /**
-     * Метод перехвата ошибки с дополнительными данными об ошибке.
-     * @param {Error} error Ошибка.
-     * @param {*} extendedData Дополнительные данные.
-     * @param {Object} [options] Опции.
-     * @param {string} [options.dataName] = 'details' Наименование дополнительных данных.
-     * @param {boolean} [options.dataAsContext] = false Прикрепить ли дополнительные данные как контекст ошибки.
-     * @param {string} [options.level] Уровень логирования.
-     */
-    captureExtendedException: (error, extendedData, options) => {
-      const { dataName = 'details', dataAsContext = false, level } = options || {};
-      sentryLoggerService.withScope(scope => {
-        dataAsContext
-          ? scope.setContext(dataName, extendedData)
-          : scope.setExtra(dataName, extendedData);
-        level && scope.setLevel(level);
-        sentryLoggerService.captureException(error);
-      });
-    },
-  };
-}