@sima-land/isomorph 10.0.0 → 11.0.0-alpha.1

package/src/helpers/saga/cache-result.js

@@ -1,77 +0,0 @@
-import { call } from 'redux-saga/effects';
-import isFunction from 'lodash/isFunction';
-import isPlainObject from 'lodash/isPlainObject';
-import doSafeRequest from './do-safe-request';
-
-/**
- * Проверяет наличие данных, запрошенных из кэша.
- * @param {*} data Данные, запрошенных из кэша.
- * @return {boolean} Получен ли ответ.
- */
-export const validateCacheDefault = data => Boolean(data);
-
-/**
- * Проверяет валидность ответа API.
- * @param {Object} response Ответ API.
- * @return {boolean} Результат проверки.
- */
-export const validateResultDefault = response =>
-  Boolean(response) && isPlainObject(response) && Boolean(response.ok);
-
-/**
- * @typedef {Object} Cache Объект кэша.
- * @property {Function} get Функция, получающая данные из кэша.
- * @property {Function} set Функция, записывающая данные в кэш.
- * @property {boolean} status Статус доступности кэша.
- */
-
-/**
- * Запрашивает данные с сервера с кэшированием.
- * @param {Object} options Настройки кэширования.
- * @param {Cache} options.cache Объект кэша.
- * @param {string} options.key Ключ для сохранения.
- * @param {Function} options.captureException Обработчик ошибки.
- * @param {Function} options.validateCache Функция для проверки валидности данных кэша.
- * @param {Function} options.validateResult Функция для проверки валидности результата при сохранении в кэш.
- * @param {Function} options.fn Функция для получения данных.
- * @param {Array} options.args Аргументы функции для запроса данных.
- * @return {import('./do-safe-request').ServerResponse} Результат.
- */
-export default function * cacheResult ({
-  cache,
-  key,
-  captureException,
-  validateCache = validateCacheDefault,
-  validateResult = validateResultDefault,
-  fn = doSafeRequest,
-  args = [],
-  duration = 3600,
-}) {
-  const { get, set, status } = cache || {};
-  let isCacheAvailable = status && isFunction(get) && isFunction(set);
-  const canDoRequest = isFunction(validateCache) && isFunction(fn);
-  let result;
-  try {
-    result = isCacheAvailable && (yield call(get, key));
-    if (validateCache(result)) {
-      result = JSON.parse(result);
-    }
-  } catch (error) {
-    if (isFunction(captureException)) {
-      captureException(error);
-    }
-    isCacheAvailable = false;
-    result = null;
-  }
-
-  if (canDoRequest && !validateCache(result)) {
-    result = yield call(fn, ...args);
-    const isResultValid = isFunction(validateResult) && validateResult(result);
-
-    if (isCacheAvailable && isResultValid) {
-      yield call(set, key, JSON.stringify(result), duration);
-    }
-  }
-
-  return result;
-}

package/src/helpers/saga/create-store.js

@@ -1,102 +0,0 @@
-import { applyMiddleware, createStore as createReduxStore } from 'redux';
-import createSagaMiddleware, { END } from 'redux-saga';
-import isFunction from 'lodash/isFunction';
-import { createService } from '../../container';
-import waitOnStoreReadiness from '../redux/wait-on-store-readiness';
-
-/**
- * Создаёт функцию для обработки успешного завершения подготовки стора.
- * @param {Function} onReady Опциональный обработчик успешного завершения.
- * @return {Function} Функция для обработки успешного завершения подготовки стора.
- */
-export const createSagaReadyHandler = onReady => store => {
-  store.dispatch(END);
-  isFunction(onReady) && onReady(store);
-};
-
-/**
- * Создаёт store с применённым middleware саг.
- * @param {Function} reducer Редьюсер.
- * @param {Function} initialSaga Инициализирующая сага.
- * @param {Object} options Необязательные опции.
- * @param {Function} options.isReady Функция для определения готовности store.
- * @param {Object} options.initialState Начальное состояние.
- * @param {Function} options.compose Функция для применения middleware.
- * @param {Array} options.middleware Список дополнительных middleware.
- * @param {Function} options.onReady Функция которая будет выполнена по готовности store.
- * @param {number} options.timeout Максимальное время ожидания готовности store.
- * @param {Function} [options.onTimeout] Функция обработчик события таймаута ожидания готовности store.
- * @param {Function} [options.onSagasErrorHandler] Корневой обработчик ошибок в сагах.
- * @return {Object} Объект со store и функцией runSaga для запуска саг.
- */
-export const createStore = (
-  reducer,
-  initialSaga,
-  {
-    isReady,
-    initialState = {},
-    compose = input => input,
-    middleware = [],
-    onReady,
-    timeout,
-    onTimeout,
-    onSagasErrorHandler,
-  } = {}
-) => {
-  const sagaMiddleware = createSagaMiddleware(
-    isFunction(onSagasErrorHandler)
-      ? { onError: onSagasErrorHandler }
-      : {}
-  );
-  let store = createReduxStore(
-    reducer,
-    initialState,
-    compose(applyMiddleware(sagaMiddleware, ...middleware))
-  );
-  if (isFunction(isReady)) {
-    store = waitOnStoreReadiness(
-      store,
-      isReady,
-      createSagaReadyHandler(onReady),
-      onTimeout,
-      timeout
-    );
-  } else if (isFunction(onReady)) {
-    throw new TypeError(
-      'Third argument property "onReady" is a function, when property "isReady" is not a function. '
-      + 'The "onReady" function will never be called.'
-    );
-  }
-  return {
-    store,
-    runSaga: () => sagaMiddleware.run(initialSaga).toPromise(),
-  };
-};
-
-/**
- * Преобразует опции сервиса в аргументы функции.
- * @param {Object} param Параметры.
- * @param {Function} param.reducer Редьюсер.
- * @param {Function} param.initialSaga Инициализирующая сага.
- * @param {Object} param.options Остальные, необязательные опции.
- * @return {Array} Массив агрументов для использования в функции.
- */
-export const mapServiceOptionsToArgs = (
-  {
-    reducer,
-    initialSaga,
-    ...options
-  }
-) => [
-  reducer,
-  initialSaga,
-  options,
-];
-
-/**
- * @type {Function} Сервис создания store для использования совместно с контейнером
- */
-export const createStoreService = createService(
-  createStore,
-  mapServiceOptionsToArgs
-);

package/src/helpers/saga/do-safe-request.js

@@ -1,47 +0,0 @@
-import { call } from 'redux-saga/effects';
-import get from 'lodash/get';
-
-/**
- * @typedef {Object} ServerResponse Ответ сервера.
- * @property {boolean} ok Были ли запрос совершен успешно.
- * @property {Object|null} error Объект ошибки.
- * @property {Object|string|null} data Данные ответа.
- * @property {number|null} status Статус ответа.
- */
-
-/**
- * Безопасно запрашивает данные c сервера, с обработкой и логированием ошибок, обрабатывает ответ.
- * @param {Function} performRequest Функция, выполняющая запрос.
- * @param {Object} [options] Опции.
- * @param {Array} [options.args] Аргументы функции, выполняющей запрос.
- * @return {ServerResponse} Ответ сервера.
- */
-export default function * doSafeRequest (
-  performRequest,
-  options
-) {
-  const {
-    args = [],
-  } = options || {};
-
-  let response;
-  let ok = false;
-  let originalError = null;
-
-  try {
-    response = yield call(performRequest, ...args);
-    ok = true;
-  } catch (error) {
-    // пытаемся получить данные ответа из ошибки
-    response = error.response;
-
-    // добавляем в результат объект ошибки
-    originalError = error;
-  }
-  return {
-    ok,
-    error: originalError,
-    data: get(response, 'data', null),
-    status: get(response, 'status', null),
-  };
-}

package/src/helpers/saga/safe-request.js

@@ -1,11 +0,0 @@
-import { call } from 'redux-saga/effects';
-import doSafeRequest from './do-safe-request';
-
-/**
- * Обёрнутая в эффект call сага doSafeRequest.
- * @param {Array} args Аргументы для вызова саги.
- * @return {import('@redux-saga/core/effects').CallEffect} Эффект.
- */
-const safeRequest = (...args) => call(doSafeRequest, ...args);
-
-export default safeRequest;

package/src/helpers/saga/take-chain.js

@@ -1,53 +0,0 @@
-import { delay, fork, put, race, take } from 'redux-saga/effects';
-import propEq from 'lodash/fp/propEq';
-import now from 'lodash/now';
-
-/**
- * Накапливает экшены и генерирует эффект по таймауту.
- * @param {number} timeout Время задержки в мс.
- * @param {Array} types Массив с типами экшенов.
- * @param {Function} task Генератор.
- * @param {...*} args Аргументы для генератора.
- * @return {Object} Эффект.
- */
-export const takeChain = (timeout, types, task, ...args) =>
-  fork(generateTakeChain, timeout, types, task, ...args);
-
-/**
- * Генерирует эффект по таймауту.
- * @param {number} timeout Время задержки в мс.
- * @param {Array} types Массив с типами экшенов.
- * @param {Function} task Генератор.
- * @param {...*} args Аргументы для генератора.
- */
-export function * generateTakeChain (timeout, types, task, ...args) {
-  while (true) {
-    const BREAK_TYPE = `BREAK_${now()}`;
-    const collectedActions = [yield take(types)];
-
-    yield fork(putDelayed, timeout, BREAK_TYPE);
-
-    while (true) {
-      const { action, canceled } = yield race({
-        action: take(types),
-        canceled: take(BREAK_TYPE),
-      });
-
-      action && collectedActions.push(action);
-      if (canceled || types.every(type => collectedActions.some(propEq('type', type)))) {
-        yield fork(task, ...args, collectedActions);
-        break;
-      }
-    }
-  }
-}
-
-/**
- * Вызывает экшен с заданной задержкой.
- * @param {number} timeout Время задержки в мс.
- * @param {string} type Тип экшена.
- */
-export function * putDelayed (timeout, type) {
-  yield delay(timeout);
-  yield put({ type });
-}

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;