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

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);
-      });
-    },
-  };
-}

package/src/module-federation/__example__/webpack-config.example.js

@@ -1,64 +0,0 @@
-/**
- * Пример конфигурации webpack c использованием EnhancedModuleFederationPlugin.
- */
-const ExtendedMFPlugin = require('../enhanced-module-federation-plugin');
-
-/**
- * Пример конфигурации удаленного приложения.
- */
-const RemoteServiceConfig = {
-  entry: {},
-  mode: process.env.NODE_ENV === 'production' ? 'production' : 'development',
-  plugins: [
-    new ExtendedMFPlugin(
-      {
-        name: 'remote-service-name',
-        filename:
-            `remote-service-name/${process.env.CI_COMMIT_REF_NAME}/remoteEntry.${process.env.CI_COMMIT_SHORT_SHA}.js`,
-        exposes: {
-          './Modal': './src/desktop/index.tsx',
-          './Screen': './src/mobile/index.tsx',
-        },
-      }
-    ),
-  ],
-};
-
-/**
- * Пример конфигурации приложения-хоста.
- */
-const HostServiceConfig = {
-  entry: './src/index.js',
-  mode: process.env.NODE_ENV === 'production' ? 'production' : 'development',
-  plugins: [
-    new ExtendedMFPlugin(
-      {
-        name: 'host-service-name',
-        remotes: {
-          firstRemoteService: 'first-remote-service-name', // Путь к remote entry определяется в рантайме
-          secondRemoteService: {
-            name: 'second-remote-service-name', // Путь к remote entry определяется в рантайме
-          },
-          thirdRemoteService: {
-            name: 'third-remote-service-name',
-            remoteEntryPath: '//path/to/remoteEntry.js', // Путь к remote entry задан явно
-          },
-        },
-      }
-    ),
-  ],
-  resolve: {
-    /**
-     * В дев версии или SSR удаленные модули недоступны, указываем компонент-заглушку.
-     */
-    fallback: {
-      'remoteService/Modal': './src/__mocks__/stub-component.js',
-      'remoteService/Screen': './src/__mocks__/stub-component.js',
-    },
-  },
-};
-
-module.exports = [
-  RemoteServiceConfig,
-  HostServiceConfig,
-];

package/src/module-federation/enhanced-module-federation-plugin.js

@@ -1,119 +0,0 @@
-const { ModuleFederationPlugin } = require('webpack').container;
-const WebpackError = require('webpack').WebpackError;
-const { createExternalConfig } = require('./utils');
-
-const LIBRARY_ERROR_TEXT = [
-  'Property "library" set internally as "global" and not overridden.',
-  'For override global variable name use "containersGlobalKey" property.',
-  'For override "library" type use ModuleFederationPlugin.',
-].join(' ');
-
-const REMOTE_ERROR_TEXT = [
-  'The value of the remote element must be a string,',
-  'or an object with field `name` for dynamic resolution of `remoteEntry`.',
-  'Set `remoteEntryPath` field to object for a static path to `remoteEntry`.',
-].join(' ');
-
-/** @typedef {string} RemoteName Имя удаленного сервиса (обычно совпадает с именем в git). */
-
-/**
- * @typedef {Object} RemoteProperty Опции подключения удаленного сервиса.
- * @property {RemoteName} name Имя удаленного сервиса.
- * @property {string} remoteEntryPath Статический путь к remoteEntry удаленного сервиса.
- * @property {string} [version] Версия удаленного сервиса в формате semver.
- */
-
-/** @typedef {import('webpack').ModuleFederationPluginOptions} MFPluginOriginalOptions Опции. */
-
-/**
- * @typedef EnhancedModuleFederationPluginOptions Опции.
- * @param {string} name Имя сервиса.
- * @param {string} filename Имя удаленной точки входа.
- * @param {Object<string, RemoteName | RemoteProperty>} [remotes] Удаленные сервисы.
- * @param {MFPluginOriginalOptions.exposes} [exposes] Предоставляемые сервисы.
- * @param {MFPluginOriginalOptions.shared} [shared] Общие зависимости.
- * @param {string} [remoteEntriesGlobalKey = '__RemoteEntriesList__'] Ключ свойства в глобальном объекте,
- * в котором хранится карта точек входа в удаленные сервисы.
- * @param {string} [containersGlobalKey = '__FederationContainers__'] Ключ свойства в глобальном объекте,
- * в который добавляются контейнеры удаленных сервисов.
- * @param {boolean} [useInDevelopment = false] Требуется ли подключение ModuleFederationPlugin в среде разработки.
- */
-
-/**
- * Создает плагин ModuleFederation с опциями, необходимыми для оркестрации удаленных модулей на клиенте.
- * Плагин ModuleFederation будет добавлен в production режиме.
- */
-class EnhancedModuleFederationPlugin {
-  /**
-   * @param {EnhancedModuleFederationPluginOptions} options Опции.
-   */
-  constructor (options) {
-    const {
-      name,
-      library,
-      remotes,
-      remoteEntriesGlobalKey = '__RemoteEntriesList__',
-      containersGlobalKey = '__FederationContainers__',
-    } = options;
-
-    if (library) {
-      throw new WebpackError(LIBRARY_ERROR_TEXT);
-    }
-
-    if (remotes) {
-      Object.values(remotes).forEach(value => {
-        if (typeof value !== 'string' && !value?.name) {
-          throw new WebpackError(REMOTE_ERROR_TEXT);
-        }
-      });
-    }
-
-    this._options = {
-      ...options,
-      remoteEntriesGlobalKey,
-      containersGlobalKey,
-      library: {
-        type: 'global',
-        name: [containersGlobalKey, name],
-      },
-    };
-  }
-
-  /**
-   * @param {import('webpack').Compiler} compiler Компилятор.
-   */
-  apply (compiler) {
-    const {
-      remotes,
-      remoteEntriesGlobalKey,
-      containersGlobalKey,
-      useInDevelopment = false,
-      ...originalOptions
-    } = this._options;
-
-    const configuredRemotes = {};
-
-    remotes && Object.entries(remotes).forEach(([key, value]) => {
-      const serviceName = value?.name || value;
-      const remoteEntryPath = value?.remoteEntryPath;
-
-      configuredRemotes[key] = { external: createExternalConfig({
-        serviceName,
-        remoteEntryPath,
-        remoteEntriesGlobalKey,
-        containersGlobalKey,
-      }) };
-    });
-
-    compiler.hooks.environment.tap('EnhancedModuleFederationPlugin', () => {
-      if (useInDevelopment || compiler.options.mode === 'production') {
-        new ModuleFederationPlugin({
-          ...remotes && { remotes: configuredRemotes },
-          ...originalOptions,
-        }).apply(compiler);
-      }
-    });
-  }
-}
-
-module.exports = EnhancedModuleFederationPlugin;

package/src/module-federation/utils/index.js

@@ -1,39 +0,0 @@
-/**
- * Возвращает скрипт инициализации удаленного модуля.
- * @param {Object} params Параметры.
- * @param {string} params.serviceName Имя сервиса, содержащего удаленные модули.
- * @param {string} params.remoteEntriesGlobalKey Глобальная переменная,
- * в которой хранятся пути к удаленным точкам входа.
- * @param {string} params.containersGlobalKey Глобальная переменная, в которую добавляются удаленные контейнеры.
- * @param {string} params.remoteEntryPath Путь к remoteEntry, если его не надо получать в рантайме.
- * @return {string} Скрипт инициализации.
- */
-const createExternalConfig = ({
-  serviceName,
-  remoteEntryPath,
-  remoteEntriesGlobalKey,
-  containersGlobalKey,
-}) =>
-    `promise new Promise((resolve, reject) => {
-  if (window['${remoteEntriesGlobalKey}']) {
-    const scriptElement = document.createElement('script');
-    scriptElement.onload = () => {
-      scriptElement.remove();
-      resolve(window['${containersGlobalKey}']['${serviceName}']);
-    };
-    scriptElement.onerror = () => {
-      scriptElement.remove();
-      reject(new Error('Failed loading remoteEntry for "${serviceName}".'));
-    };
-    scriptElement.src = ${remoteEntryPath
-        ? `'${remoteEntryPath}'`
-        : `window['${remoteEntriesGlobalKey}']['${serviceName}']`
-    };
-    scriptElement.async = true;
-    document.head.append(scriptElement);
-  } else {
-    reject(new ReferenceError('Object "${remoteEntriesGlobalKey}" unavailable.'));
-  }
-})`;
-
-module.exports = { createExternalConfig };

package/src/observe-middleware/index.js

@@ -1,70 +0,0 @@
-import isFunction from 'lodash/isFunction';
-import getMsFromHRT from '../helpers/utils/get-ms-from-hrt';
-
-/**
- * Немедленно выполняет функцию-обработчик при старте middleware.
- * @param {Function} callback Функция обработчик.
- * @return {*} Результат выполнения функции-обработчика.
- */
-export const defaultStartSubscriber = ({ callback }) => callback();
-
-/**
- * Подписчик на событие завершения процесса.
- * @param {Object} param Параметры.
- * @param {import('http').ServerResponse} param.response Ответ сервера.
- * @param {Function} param.callback Функция-обработчик события.
- * @return {import('http').ServerResponse} Имеет ли событие другие обработчики.
- */
-export const defaultFinishSubscriber = ({ response, callback }) => response.once('finish', callback);
-
-/**
- * Возвращает новую функцию - промежуточный слой для Express-приложения.
- * @param {Object} options Опции.
- * @param {Function} options.onStart Сработает при старте запроса, получит временную отметку старта, запрос и ответ.
- * @param {Function} options.onFinish Сработает при отправке ответа, получит временную отметку старта, запрос и ответ.
- * @return {Function} Функция - промежуточный слой для Express.
- */
-export const createObserveMiddleware = (
-  {
-    onStart,
-    onFinish,
-    startSubscriber = defaultStartSubscriber,
-    finishSubscriber = defaultFinishSubscriber,
-  } = {}
-) => {
-  const hasStartHandler = isFunction(onStart);
-  const hasFinishHandler = isFunction(onFinish);
-  const hasStartSubscriber = isFunction(startSubscriber);
-  const hasFinishSubscriber = isFunction(finishSubscriber);
-
-  return (request, response, next) => {
-    let startTime = process.hrtime();
-    if (hasStartSubscriber) {
-      startSubscriber({
-        request,
-        response,
-        callback: () => {
-          startTime = process.hrtime();
-          if (hasStartHandler) {
-            onStart(getMsFromHRT(startTime), request, response);
-          }
-        },
-      });
-    }
-
-    if (hasFinishSubscriber) {
-      finishSubscriber({
-        request,
-        response,
-        callback: () => {
-          const duration = process.hrtime(startTime);
-          if (hasFinishHandler) {
-            onFinish(getMsFromHRT(duration), request, response);
-          }
-        },
-      });
-    }
-
-    next();
-  };
-};

package/src/set-header-middleware/create.js

@@ -1,17 +0,0 @@
-/**
- * Фабрика для промежуточного слоя устанавливающего заголовки.
- * @param {Object} dependencies Объект зависимостей.
- * @param {Object} [dependencies.headers] Объект заголовков.
- * @return {Function} Промежуточный слой приложения для установки заголовков со ссылками на клиентские ресурсы.
- */
-const createSetHeaderMiddleware = ({
-  headers = {},
-}) => (request, response, next) => {
-  Object.entries(headers).forEach(([key, value]) => {
-    response.set({ [key]: value });
-  });
-
-  next();
-};
-
-export default createSetHeaderMiddleware;