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

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;

package/src/helpers/api/middlewares/trace-request-middleware.ts

@@ -1,86 +0,0 @@
-import type { AxiosRequestConfig } from 'axios';
-import type { Middleware } from 'middleware-axios';
-import { Tracer, Tags, FORMAT_HTTP_HEADERS, SpanContext } from 'opentracing';
-
-/**
- * Создаёт middleware для трассировки запросов в API.
- * @param options Параметры для создания middleware.
- * @param options.tracer Объект трейсера.
- * @param options.context Объект родительского контекста.
- * @return Middleware для трассировки запросов в API.
- */
-const createTraceRequestMiddleware = ({ tracer, context }: {
-  tracer: Tracer;
-  context: SpanContext;
-}): Middleware<any> => async function (config, next, defaults) {
-    const { method, url, foundId } = getRequestInfo(config, defaults);
-
-    const span = tracer.startSpan(`HTTP ${method} ${url}`, {
-      childOf: context,
-    });
-
-    if (!config.headers) {
-      config.headers = {};
-    }
-
-    span.addTags({
-      [Tags.HTTP_URL]: url,
-      [Tags.HTTP_METHOD]: method,
-      'request.params': { ...config.params },
-      'request.headers': { ...config.headers },
-
-      // если нашли id - добавляем в теги
-      ...(foundId && { 'request.id': foundId }),
-    });
-
-    tracer.inject(span, FORMAT_HTTP_HEADERS, config.headers);
-
-    const response = await next(config);
-
-    span.setTag(Tags.HTTP_STATUS_CODE, response.status);
-    span.finish();
-  };
-
-/**
- * Формирует базовые данные запроса.
- * Заменяет первое найденное число в url на "{id}", возвращая его в результате.
- * @param config Axios-конфиг запроса.
- * @param defaults Базовый конфиг экземпляра Axios.
- * @return Базовые данные запроса.
- */
-const getRequestInfo = (
-  config: AxiosRequestConfig,
-  defaults: AxiosRequestConfig
-): {
-  method: string;
-  url: string;
-  foundId?: number;
-} => {
-  const method = (config.method || 'GET').toUpperCase();
-  const baseURL = config.baseURL || defaults.baseURL || '';
-
-  // ВАЖНО: абстрагируем id только в url игнорируя baseURL
-  const [url, foundId] = hideFirstId(config.url || defaults.url || '');
-  const readyUrl = `${baseURL}${url}`;
-
-  return { method, url: readyUrl, foundId };
-};
-
-/**
- * Преобразует строку вида:
- * "/api/v2/something/123456/some-bff/123456"
- * в строку вида:
- * "/api/v2/something/{id}/some-bff/123456"
- * и возвращает кортеж с этой строкой и вырезанным числом в случае если оно найдено.
- * @param url Url.
- * @return Кортеж со строкой и результатом поиска числа.
- */
-export const hideFirstId = (url: string): [string, number | undefined] => {
-  const found = /\d{2,}/.exec(url);
-
-  return found
-    ? [url.replace(found[0], '{id}'), Number(found[0])]
-    : [url, undefined];
-};
-
-export default createTraceRequestMiddleware;

package/src/helpers/api/server-adapter/__fixtures__/fake-keys.js

@@ -1,58 +0,0 @@
-/**
- * Сертификат TLS для https.
- * @type {string}
- */
-export const fakeCert = `-----BEGIN CERTIFICATE-----
-MIIDazCCAlOgAwIBAgIUAufH+Il0B8cP7bvU8PedE9F0b9MwDQYJKoZIhvcNAQEL
-BQAwRTELMAkGA1UEBhMCUlUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
-GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yMDAyMTUwNzM5MzRaFw0yMDAz
-MTYwNzM5MzRaMEUxCzAJBgNVBAYTAlJVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw
-HwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEB
-AQUAA4IBDwAwggEKAoIBAQDFuY/Pld4KGeLtvbFrnwjjqPHdYiJw6UM6GjEuzAHN
-fLjYjzCxbsae/UO+QyyLlZ0apQKHiznBga8Bc3JNZQ2O9xZ9BTUnJdvfq2ZgyGE8
-9l4EWOd6I3MBLdzby9+NRs/mNSB10OkhOyYwcbjL8aR6QHzT570bg2Ab8mcLkKit
-aPD6Jtk+iOMdRdudKIcv3fvBxKPwYPsvDtpEaSIjysimQKF40uk7yTu1r0liuknE
-CObowqiH1zt+OTCutgpIAo7MuuE8ga7fQlq9IzlgIpgl2W12NjEYDB87jQ3FT7Dn
-qy5uZq4r9b5oQ4tRLgsP/yVLac0vCzwoA8EB2+0bxsiVAgMBAAGjUzBRMB0GA1Ud
-DgQWBBSQYsuIbKB5tOmH2hbLaWKkrfzLEzAfBgNVHSMEGDAWgBSQYsuIbKB5tOmH
-2hbLaWKkrfzLEzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBp
-HzTKEe5F81Mdqeb84/+TeR7H6GTMXE8jl/wIXprkapG7FizRQ/nlGQSYHJ/U9R2w
-lTvnr0logj2f4Hz1WdyRCaE5BMTwSVPlbIPjfXBzvB140jlJpGzr5qbnMkwjymZT
-nRydKP1DdwlYnl6BwgZ7xGCyB2k9bWSfYu9918AXE/AKcan5siHlYWhobP1uVMIl
-JksaKH9nnQ/oZK/KZA1YoTc47ZqIGbNnHHFLuQ7BEClXRL4ixxrLLK2Kjxtd6PXD
-r1LpsSnEDuQ3MzzeKNduPolMdct8ioKJ2OA81ts/cImB4t80TdWujbL/oUXkHbdN
-YyJK3ZaLm/5uzOOHIuSu
------END CERTIFICATE-----`;
-
-/**
- * Ключ TLS для https.
- * @type {string}
- */
-export const fakeKey = `-----BEGIN PRIVATE KEY-----
-MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDFuY/Pld4KGeLt
-vbFrnwjjqPHdYiJw6UM6GjEuzAHNfLjYjzCxbsae/UO+QyyLlZ0apQKHiznBga8B
-c3JNZQ2O9xZ9BTUnJdvfq2ZgyGE89l4EWOd6I3MBLdzby9+NRs/mNSB10OkhOyYw
-cbjL8aR6QHzT570bg2Ab8mcLkKitaPD6Jtk+iOMdRdudKIcv3fvBxKPwYPsvDtpE
-aSIjysimQKF40uk7yTu1r0liuknECObowqiH1zt+OTCutgpIAo7MuuE8ga7fQlq9
-IzlgIpgl2W12NjEYDB87jQ3FT7Dnqy5uZq4r9b5oQ4tRLgsP/yVLac0vCzwoA8EB
-2+0bxsiVAgMBAAECggEAEYBoW16PpeM+s/6LetQ77DLjHc527/mlyrnQyqyiKDc3
-AWxDSiFdEWunmGrHwZ8/pcEfZTIMrbU18XHvlywvtAzo/637U3jFapn4WO7DtKq2
-Dbp02tnSbzNJDmeQZSf0dRMUyXjxedCLg9Q9IEhGX8/ffL5RfeL2GeMt/dcTJy4v
-4Oo6GXP3YH/Ts+RxsHC9gWg3HukqwEycRYhaBCXSR4GEZE2wqhzkcVf9PxHpzHkT
-ktISa55bEMwhGtQewmXlCqlSiISLHQkJvkP83GOh6k/14jsPrToPasA+hBGNfj9K
-O+6fi4pxxmM8N7DgkLRHm9WQbYq5ZCCCklqkFxVJjQKBgQDxWjyC97U41dgFIoes
-JA++Nb39uyIHyh7s+JQt5miBNvns6KSKLqVql5lPeAa8Mj97orvLQUW/T0ogMTUJ
-JcwKTLF4TNqYMPKupoZk3fnrgGuclTVjjU2hSqrzp7XFP+vLNuktkVg2HoRrgT29
-qgDTQThZZQTTqEtgbIseaeqBXwKBgQDRuYGdeRaeTJVTVgmvAlfAvWuNUBvLNxHh
-0ObCLIiFbF9g8bSd/WeqLyUs1zBQslxIXvnhIO9dPcDGqX3u+SSUzcc//YGYFvAB
-6I1sTNPi+RsEz9bAM6/EpWQkbaaPpwHITz0YXGReou76nRirl0s5zqdbYWKkvk0n
-ZXgQVCe2iwKBgFv20k/lKzx431M1kRTauNT1jWt9Pr5RGe+Z2HyU6wUxeZH4I5oz
-o/w1v8k0JvzW+LGXlI8iU/1NrSUPGvJdYJ4cExOP1Utge1hpQ5RzsKM3z8leYXWJ
-hicLWJB3Ox/p92L7jWY7l60ne7WrDWeTu7TDiUEm6OvtmKspMOlp2l1pAoGBAMG1
-SdadJRsJOVNDwKX4z/yh+FkJiOJl9wpP3ROz9lTmCCKOnXjfuYQjD38fMu0WEM53
-iu05clz40LmtizfSvssCVerwx2YmqX/Zv+Yr//lAhIgpP/0+wDYtXRWYgaNlaewN
-5CxACiSu8XRg7YxvrXezPDjW9jmb279rpT3PvO6JAoGAMN3sEr5Utws14g3BDaIc
-9jHvYKKc05oqRbnfHkJmQBaphfj8DYwIgVrHc63RTadp6eK50gpEMk9cZiw3xu7I
-YQsOyH4x06NoPGelxkhX/rxOXOVtNmCNpMjgxoQJRm3WXNza476l3xDk2BltfTL6
-aawhzRoba6tWmXzyog3whEs=
------END PRIVATE KEY-----`;

package/src/helpers/api/server-adapter/constants.js

@@ -1,12 +0,0 @@
-/**
- * Стадии запроса к API.
- * @type {Object}
- */
-export const REQUEST_STAGES = Object.freeze({
-  start: 'start:request',
-  dnsLookupFinish: 'finish:DNS Lookup',
-  tcpConnectionConnect: 'finish:TCP Connection',
-  tlsHandshakeFinish: 'finish:TLS Handshake',
-  firstByteReceived: 'finish:Time to First Byte',
-  end: 'finish:Data Loading',
-});