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

package/src/cache/wrap-in-trace.js

@@ -1,57 +0,0 @@
-import { createService } from '../container';
-
-/**
- * Обертка методов кэша.
- * @param {Object} tracer Экземпляр jaeger-трейсера.
- * @param {Object} context Контекст спана.
- * @param {Object} cache  Кэш.
- * @return {Object} Объект с методами кэша.
- */
-export const wrapInTrace = (tracer, context, cache) => ({
-  /**
-   * Получение ключа из кэша.
-   * @param {string} key Ключ.
-   * @return {Promise} Промис для получения ответа.
-   */
-  get: async key => {
-    const span = tracer.startSpan(`Redis GET ${key}`, {
-      childOf: context,
-    });
-    const result = await cache.get(key);
-    span.finish();
-    return result;
-  },
-
-  /**
-   * Задаем значение в кэш.
-   * @param {string} key Ключ.
-   * @param {string} value Новое значение.
-   * @param {number} duration Длительность.
-   */
-  set: (key, value, duration = 3600) => {
-    const span = tracer.startSpan(`Redis SET ${key}`, {
-      childOf: context,
-    });
-    cache.set(key, value, duration);
-    span.finish();
-  },
-
-  /**
-   * Геттер статуса кэша.
-   * @return {string} Статус кэша.
-   */
-  get status () {
-    return cache.status;
-  },
-});
-
-/**
- * Преобразует опции сервиса в аргументы функции.
- * @param {Object} param Параметры.
- * @param {Object} param.tracer Экземпляр jaeger-трейсера.
- * @param {Object} param.context Контекст спана.
- * @param {Object} param.cache  Кэш.
- * @return {Object} Config Объект с параметрами Redis.
- */
-export const mapServiceOptionsToArgs = ({ tracer, context = {}, cache }) => [tracer, context, cache];
-export default createService(wrapInTrace, mapServiceOptionsToArgs);

package/src/config/create.js

@@ -1,33 +0,0 @@
-import isFunction from 'lodash/isFunction';
-import isPlainObject from 'lodash/isPlainObject';
-import formatObjectKeys from '../helpers/utils/format-object-keys';
-
-/**
- * Собирает объект конфигурации из переданных параметров.
- * @param {Object} data Объект с данными, которые нужно добавить в конфигурацию.
- * @param {Object} base Базовый объект на основе которого строится конфигурация.
- * @param {boolean} needFormatKeys Признак форматирования ключей объекта.
- * @return {Object} Объект конфигурации.
- */
-export default function createConfig (
-  data = {},
-  base = { ...process.env },
-  needFormatKeys = true
-) {
-  if (!isPlainObject(data)) {
-    throw new TypeError('Параметр "data" должен быть чистым объектом');
-  }
-
-  if (!isPlainObject(base)) {
-    throw new TypeError('Параметр "base" должен быть чистым объектом');
-  }
-
-  return Object.entries(data).reduce((config, current) => {
-    const [key, value] = current;
-
-    if (!(key in config)) {
-      config[key] = isFunction(value) ? value(base) : value;
-    }
-    return config;
-  }, needFormatKeys ? formatObjectKeys({ ...base }) : base);
-}

package/src/config/helpers.js

@@ -1,71 +0,0 @@
-import isString from 'lodash/isString';
-import isFunction from 'lodash/isFunction';
-import { RULE_TYPES } from './validate';
-
-/**
- * Станадртный валидатор, проверяет на непустую строку.
- * @param {*} value Значение, которое нужно провалидировать.
- * @return {boolean} Валидно ли значение.
- */
-export const defaultValidate = value => isString(value) && value.length > 0;
-
-/**
- * Возвращает текст ошибки про умолчанию.
- * @param {string} property Свойство для которого получена ошибка.
- * @return {string} Текст ошибки.
- */
-export const getDefaultError = property =>
-  `Ошибка конфигрурации приложения: Поле "${property}" заполнено некорректно`;
-
-/**
- * Возвращает текст ошибки для переданной строки ошибки.
- * @param {string} property Свойство для которого получена ошибка.
- * @param {string} error Текст ошибки.
- * @return {string} Полный текст ошибки.
- */
-export const getStringError = (property, error) =>
-  `Ошибка конфигурации. Поле "${property}": ${error}`;
-
-/**
- * Выбрасывает ошибку.
- * @param {string} errorText Текст ошибки.
- */
-export const throwError = errorText => {
-  throw new Error(errorText);
-};
-
-/**
- * Выводит в лог ошибку.
- * @param {string} errorText Текст ошибки.
- */
-export const consoleError = errorText => {
-  // eslint-disable-next-line no-console
-  console.error(errorText);
-};
-
-/**
- * Вызывает ошибку.
- * @param {Object} errorData Данные необходимые для вывода ошибки.
- * @param {string} errorData.property Проверяемое свойство конфига.
- * @param {*} errorData.value Проверяемое значение.
- * @param {Function|string} [errorData.error] Либо функция, вызвающая ошибку, либо текст ошибки.
- * @param {'error'|'warning'} errorData.type Тип валидации.
- */
-export const callError = ({
-  property,
-  value,
-  error,
-  type,
-}) => {
-  if (isFunction(error)) {
-    error(property, value);
-  } else {
-    const errorText = isString(error)
-      ? getStringError(property, error)
-      : getDefaultError(property);
-
-    type === RULE_TYPES.error
-      ? throwError(errorText)
-      : consoleError(errorText);
-  }
-};

package/src/config/validate.js

@@ -1,114 +0,0 @@
-import {
-  defaultValidate,
-  callError,
-} from './helpers';
-import isFunction from 'lodash/isFunction';
-import isPlainObject from 'lodash/isPlainObject';
-
-export const RULE_TYPES = Object.freeze({
-  error: 'error',
-  warning: 'warning',
-});
-
-/**
- * Возвращает массив валидаторов.
- * @param {Object|Array|Function} validation Функция-валидатор, либо объект-валидатор,
- * либо массив объектов-валидаторов.
- * @return {Array} Массив валидаторов.
- */
-export const getValidatorsList = validation => {
-  let result = validation;
-
-  if (isFunction(validation)) {
-    result = [{ validate: validation }];
-  } else if (isPlainObject(validation)) {
-    result = [validation];
-  }
-
-  return result;
-};
-
-/**
- * Проверяет значение на корректность.
- * @param {Function} validate Функция-валидатор.
- * @param {*} value Значение.
- * @return {boolean} Валидно ли значение.
- */
-export const checkValue = (validate, value) => isFunction(validate)
-  ? !validate(value)
-  : !defaultValidate(value);
-
-/**
- * Валидирует значение свойства конфигурации.
- * @param {string} property Название свойства.
- * @param {*} value Значение, которое нужно провалидировать.
- * @param {Object} rules Правила валидации,.
- * @param {Object|Array|Function} rules.validation Функция-валидатор, либо объект-валидатор,
- * либо массив объектов-валидаторов.
- */
-export const validateValue = (
-  property,
-  value,
-  {
-    validation = defaultValidate,
-    ...restRules
-  }
-) => {
-  const validatorsList = getValidatorsList(validation);
-  const failedValidator = validatorsList.find(({ validate }) =>
-    checkValue(validate, value));
-
-  failedValidator && callError({
-    property,
-    value,
-    ...restRules,
-    ...failedValidator,
-  });
-};
-
-/**
- * Валидирует определенное свойство конфигурации.
- * @param {Object} config Объект конфигурации.
- * @param {string} property Название свойства.
- * @param {Object} rules Объект с описанием правил валидидации свойство.
- */
-export const validateProperty = (config, property, rules) => {
-  const value = config[property];
-  const rulesList = Array.isArray(rules) ? rules : [rules];
-
-  if (value === undefined) {
-    const { error, type } = rules;
-    callError({ property, value, error, type });
-  } else {
-    rulesList.forEach(rule => {
-      validateValue(property, value, rule);
-    });
-  }
-};
-
-/**
- * Валидирует конфигурацию.
- * @param {Object} config Конфигурация, которую нужно провалидировать.
- * @param {Object} validationConfig Конфигурация валидатора.
- * @return {Object} Конфигурация приложения.
- */
-const validateConfig = (
-  config,
-  validationConfig
-) => {
-  if (!isPlainObject(config)) {
-    throw new TypeError('Конфигурация приложения должна быть чистым объектом');
-  }
-
-  if (!isPlainObject(validationConfig)) {
-    throw new TypeError('Конфигурация валидатора должна быть чистым объектом');
-  }
-
-  Object.entries(validationConfig).forEach(([property, rules]) => {
-    validateProperty(config, property, rules);
-  });
-
-  return config;
-};
-
-export default validateConfig;

package/src/container/create-inject.js

@@ -1,32 +0,0 @@
-import isFunction from 'lodash/isFunction';
-import getDependencies from './get-dependencies';
-import isContainer from './is-container';
-
-/**
- * Создаёт функцию для инъекции зависимостей из контейнера в функции.
- * @param {Function} getContainer Функция для получения экземпляра контейнера.
- * @return {Function} Функция для инъекции зависимостей из контейнера.
- */
-const createInject = getContainer => ({
-  target,
-  dependencies = [],
-  registerArgs,
-}) => async (...args) => {
-  const container = getContainer();
-
-  // Если не получили контейнера, то выходим с ошибкой.
-  if (!isContainer(container)) {
-    throw new TypeError('Полученный результат выполнения функции getContainer не реализует интерфейс контейнера.');
-  }
-
-  // Если требуется регистрируем аргументы функции как сервисы в контейнере.
-  if (isFunction(registerArgs)) {
-    registerArgs(container, ...args);
-  }
-  return target(
-    ...args,
-    ...Object.values(await getDependencies(container, dependencies))
-  );
-};
-
-export default createInject;

package/src/container/get-dependencies.js

@@ -1,46 +0,0 @@
-import isString from 'lodash/isString';
-import isPlainObject from 'lodash/isPlainObject';
-
-/**
- * Определяет, является ли зависимость статической, то есть не требующей инициализации.
- * @param {Object} dependency Конфигурация зависимости.
- * @param {string} dependency.name Название зависимости.
- * @param {*} dependency.value Значение зависимости.
- * @return {boolean} Является ли зависимость статической.
- */
-export const isStaticDependency = ({ name, value }) =>
-  typeof name === 'string'
-  && typeof value !== 'undefined';
-
-/**
- * Создает объект зависимостей на основе их названий.
- * @param {Object} container Экземпляр контейнера в котором должен осуществляться поиск зависимостей.
- * @param {Object} dependencies Список зависимостей.
- * @param {string} serviceName Названия сервиса.
- * @return {Object} Объект зависимостей.
- */
-const getDependencies = (
-  container,
-  dependencies = [],
-  serviceName
-) => dependencies.reduce(async (prevPromise, dependency) => {
-  const result = await prevPromise;
-  if (isString(dependency)) {
-    result[dependency] = await container.get(dependency, serviceName);
-  }
-
-  if (isPlainObject(dependency)) {
-    if (isStaticDependency(dependency)) {
-      result[dependency.name] = dependency.value;
-    } else {
-      const [necessaryName, necessaryDepName] = Object.entries(dependency).shift() || [];
-      if (necessaryName && necessaryDepName) {
-        result[necessaryName] = await container.get(necessaryDepName);
-      }
-    }
-  }
-
-  return result;
-}, Promise.resolve({}));
-
-export default getDependencies;

package/src/container/index.js

@@ -1,188 +0,0 @@
-import isString from 'lodash/isString';
-import isFunction from 'lodash/isFunction';
-import ServiceNotFoundError from './service-not-found-error';
-import getDependencies from './get-dependencies';
-import isContainer from './is-container';
-import isNotEmptyString from '../helpers/utils/is-not-empty-string';
-
-/**
- * Оборачивает функцию для использования в контейнере.
- * @param {Function} fn Функция, которую необходимо обернуть.
- * @param {Function} dependenciesToArgs Функция для преобразования зависимостей сервиса в аргументы функции.
- * @return {Function} Функция-сервис, для использования в контейнере.
- */
-export const createService = (
-  fn,
-  dependenciesToArgs
-) => (dependencies, ...args) => fn(...dependenciesToArgs(dependencies), ...args);
-
-/**
- * Создаёт функцию для получения синглтона контейнера с заданными параметрами.
- * @param {Object} options Опции для создания контейнера.
- * @return {function(): Object} Функция для получения контейнера-синглтона.
- */
-export const createSingleton = options => {
-  let container;
-  return () => {
-    if (!container) {
-      container = create(options);
-    }
-    return container;
-  };
-};
-
-/**
- * Создаёт функцию-фабрику для создания нового экземпляра контейнера при её вызове.
- * @param {Object} options Опции для создания контейнера.
- * @return {function(): Object} Функция-фабрика для получения экземпляра контейнера с заданными параметрами.
- */
-export const createFactory = options => () => create(options);
-
-/**
- * Реализует наследование контейнера от другого контейнера.
- * @param {Object} container Дочерний контейнер.
- * @param {Object} parentContainer Родительский контейнер.
- * @return {Object} Контейнер с поиском зависимости в родителе.
- */
-const inherit = (
-  container,
-  parentContainer
-) => {
-  let result = container;
-  if (isContainer(parentContainer)) {
-    result = {
-      ...container,
-
-      /**
-       * Оборачивает получение зависимости для добавления поиска в родительском контейнере.
-       * @param {string} name Название зависимости.
-       * @return {*} Зависимость.
-       * @throws {TypeError} Выдаст ошибку если параметр "name" не строка.
-       * @throws {Error} Выдаст ошибку если параметр "name" не строка или пустая строка.
-       * @throws {ServiceNotFoundError} Выдаст ошибку при попытке вызвать незарегистрированный сервис.
-       */
-      async get (name) {
-        let dependency;
-        try {
-          dependency = await container.get(name);
-        } catch (e) {
-          if (e instanceof ServiceNotFoundError) {
-            dependency = await parentContainer.get(name);
-          } else {
-            throw e;
-          }
-        }
-        return dependency;
-      },
-    };
-  }
-  return result;
-};
-
-/**
- * Функция создает IoC-контейнер.
- * @param {Object} options Дополнительные опции для IoC-контейнера.
- * @param {Array} options.services Массив сервисов, которые нужно зарегистрировать.
- * @param {Object} options.parent Родительский контейнер.
- * @return {Object} IoC Container.
- * @throws {TypeError} Выдаст ошибку если параметр "services" не массив.
- */
-export default function create ({ services = [], parent = null } = {}) {
-  if (!Array.isArray(services)) {
-    throw new TypeError('Параметр "services" должен быть массивом');
-  }
-
-  const registry = {};
-
-  const container = inherit({
-    /**
-     * Добавляет зависимость в список зависимостей.
-     * @param {Object} options Опции необходимые для добавления зависимости.
-     * @param {string} options.name Название зависимости.
-     * @param {Function} options.singleton Функция-синглтон.
-     * @param {Function} options.factory Функция-конструктор.
-     * @param {*} options.value Переданная зависимость.
-     * @param {Array} options.dependencies Массив зависимостей.
-     * @throws {Error} Выдаст ошибку если параметр "name" не строка или пустая строка.
-     * @throws {Error} Выдаст ошибку если не передан ни один из параметров "factory", "singleton" или "value".
-     */
-    set ({ name, singleton, factory, value, dependencies = [] } = {}) {
-      if (!isString(name) || name === '') {
-        throw new Error('Параметр "name" должен быть непустой строкой');
-      }
-
-      if (factory !== undefined && !isFunction(factory)) {
-        throw new TypeError('Параметр "factory" должен быть функцией');
-      }
-
-      if (singleton !== undefined && !isFunction(singleton)) {
-        throw new TypeError('Параметр "singleton" должен быть функцией');
-      }
-
-      if (factory === undefined && value === undefined && singleton === undefined) {
-        throw Error(`Сервис ${name} не зарегистрирован,
-так как обязательно должен быть передан один из параметров "factory", "singleton" или "value"`);
-      }
-
-      registry[name] = {
-        name,
-        singleton,
-        factory,
-        dependencies,
-        value,
-      };
-    },
-
-    /**
-     * Получает зависимость по ее названию.
-     * @param {string} name Название зависимости.
-     * @param {string} serviceName Название сервиса.
-     * @return {*} Зависимость.
-     * @throws {TypeError} Выдаст ошибку если параметр "name" не строка.
-     * @throws {Error} Выдаст ошибку если параметр "name" не строка или пустая строка.
-     * @throws {ServiceNotFoundError} Выдаст ошибку при попытке вызвать незарегистрированный сервис.
-     */
-    async get (name, serviceName = '') {
-      if (!isString(name) || name === '') {
-        throw new Error('Параметр "name" должен быть непустой строкой');
-      }
-
-      const service = registry[name];
-      let dependency;
-
-      if (!service) {
-        throw new ServiceNotFoundError(
-          isNotEmptyString(serviceName)
-            ? `Не найдена зависимость "${name}" в цепочке вызовов "${serviceName}"`
-            : `Сервис "${name}" не зарегистрирован`
-        );
-      }
-
-      if (service.singleton && !service.value) {
-        service.value = await service.singleton(
-          {
-            ...await getDependencies(container, service.dependencies, `${serviceName}/${name}`),
-          }
-        );
-      }
-
-      if (service.value !== undefined) {
-        dependency = service.value;
-      }
-
-      if (service.factory) {
-        dependency = await service.factory(
-          {
-            ...await getDependencies(container, service.dependencies, `${serviceName}/${name}`),
-          }
-        );
-      }
-
-      return dependency;
-    },
-  }, parent);
-
-  services.forEach(service => container.set(service));
-
-  return container;
-}

package/src/container/is-container.js

@@ -1,14 +0,0 @@
-import isPlainObject from 'lodash/isPlainObject';
-import isFunction from 'lodash/isFunction';
-
-/**
- * Проверяет является ли переданный экземпляр контейнером.
- * @param {*} instance Предполагаемый экземпляр контейнера.
- * @return {boolean} Является ли переданный экземпляр контейнером.
- */
-const isContainer = instance =>
-  isPlainObject(instance)
-  && isFunction(instance.get)
-  && isFunction(instance.set);
-
-export default isContainer;

package/src/container/service-not-found-error.js

@@ -1,14 +0,0 @@
-/**
- * Ошибка поиска сервиса в контейнере.
- */
-export default class ServiceNotFoundError extends Error {
-  /**
-   * Конструктор.
-   * @param {...*} args Аргументы.
-   */
-  constructor (...args) {
-    super(...args);
-    this.name = this.constructor.name;
-    Error.captureStackTrace && Error.captureStackTrace(this, this.constructor);
-  }
-}

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

@@ -1,47 +0,0 @@
-import get from 'lodash/get';
-import pipe from 'lodash/fp/pipe';
-import isFunction from 'lodash/isFunction';
-import expressProxy from 'express-http-proxy';
-
-const urlApi = require('url');
-
-/**
- * Получает обработчик с прокинутым path из config url.
- * @param {string} path Часть пути после хоста.
- * @return {Function} Обработчик для передачи URL запроса из оригинальной версии с клиента в проксирующий запрос.
- */
-export const getRequestPathResolver = path => request => request && path + request.originalUrl;
-
-/**
- * Функция создающая обработчик запроса.
- * @param {string} header Отслеживаемый заголовок.
- * @param {Array} map Массив обработчика.
- * @param {Object} config Конфигурация приложения.
- * @param {Object} proxyOptions Пользовательская конфигурация прокси.
- * @return {Function} Функция, обрабатывающая запрос.
- */
-export default function createProxyMiddleware (header, map, config, proxyOptions = {}) {
-  return (req, res, next) => {
-    const headerType = get(req, `headers['${header.toLowerCase()}']`, null);
-    const getUrl = headerType ? map[headerType] : null;
-    const proxyInstance = isFunction(getUrl) ? expressProxy(getUrl(config), {
-      proxyReqPathResolver: getRequestPathResolver(getUrlPath(getUrl(config))), ...proxyOptions,
-    }) : null;
-
-    if (proxyInstance) {
-      proxyInstance(req, res, next);
-    } else {
-      next();
-    }
-  };
-}
-
-/**
- * Получает path из url без слэша в конце.
- * @param {string} url Url.
- * @return {string} Path или пустую строку.
- */
-export const getUrlPath = pipe(
-  urlApi.parse,
-  url => url.path && url.path.replace(/\/$/, '')
-);

package/src/create-proxy/index.js

@@ -1,27 +0,0 @@
-import createProxyMiddleware from './create-proxy-middleware';
-
-/**
- * Конструктор сервиса проксирования.
- * @param {Object} param Параметры.
- * @param {Object} param.config Конфигурация приложения.
- * @param {Object} param.config.proxy Конфигурация прокси.
- * @return {Function} Функция-конструктор.
- */
-export default function createProxy (
-  {
-    config,
-    config: {
-      proxy,
-    },
-  }
-) {
-  return app => {
-    if (!Array.isArray(proxy)) {
-      throw TypeError('Параметр proxy должен быть массивом');
-    }
-
-    proxy.forEach(({ url, header, map, proxyOptions }) => {
-      app.use(url, createProxyMiddleware(header, map, config, proxyOptions));
-    });
-  };
-}