Перейти к основному содержимому

Пресеты

Preset - набор провайдеров. Пресеты можно применить к приложениям. Сам по себе пресет не хранит компоненты и не инициализирует их. Он только предоставляет провайдеры.

Обычно в проектах не придется самостоятельно создавать пресеты. В будущем функциональность пресетов может перейти к самому приложению.

Пакет isomorph предоставляет несколько пресетов, цель которых унифицировать похожие по функционалу микросервисы.

Пример использования​

Возьмем пресет Node.js-приложения из пакета.

import { createApplication } from '@sima-land/isomorph/di';
import { PresetNode } from '@sima-land/isomorph/preset/node';

const app = createApplication();

app.preset(PresetNode());

Пресеты позволяют переопределять заложенные в них провайдеры в отличие от приложений и DI-контейнеров.

import { createApplication } from '@sima-land/isomorph/di';
import { PresetNode } from '@sima-land/isomorph/preset/node';

const app = createApplication();

const preset = PresetNode()
  .set(TOKEN.foo, provideFoo)
  .set(TOKEN.bar, provideBar)
  .set(TOKEN.baz, provideBaz);

app.preset(preset);

В библиотеке @sima-land/isomorph есть доступные пресеты приложений:​

PresetWeb - Возвращает preset с зависимостями для frontend-микросервисов в браузере.​

app.ts
import { createApplication } from '@sima-land/isomorph/di';
import { PresetWeb } from '../index';
import { KnownToken } from '@sima-land/isomorph/tokens';
import { BaseConfig } from '@sima-land/isomorph/config';

export interface AppConfig extends BaseConfig {
  devtoolsEnabled: boolean;
}

export const TOKEN = {
  config: createToken<AppConfig>('app/config'),
  Known: KnownToken,
} as const;

/* Возвращает браузерное приложение с уже готовым набором провайдеров. */
export function BrowserApp() {
  const app = createApplication();
  app.preset(PresetWeb());

  // регистрируем компонент с помощью провайдера
  app.bind(TOKEN.config).toProvider(provideConfig);

  return app;
}

function provideConfig(resolve: Resolve): AppConfig {
  const source = resolve(TOKEN.Known.Config.source);
  const baseConfig = resolve(TOKEN.Known.Config.base);

  return {
    ...baseConfig,
    devtoolsEnabled: source.require('PUBLIC_DEVTOOLS_ENABLED') !== '0',
  };
}

Встроенный функционал, который предоставляет PresetWeb:​

  • Провайдер источника конфигурации. [KnownToken.Config.source]
  • Провайдер базовой конфигурации приложения. [KnownToken.Config.base]
  • Провайдер Logger'а. [KnownToken.logger]
  • Провайдер промежуточного слоя redux-saga для redux-хранилища. [KnownToken.Redux.Middleware.saga]
  • Провайдер фабрики экземпляров AxiosInstanceWrapper. [KnownToken.Axios.factory]
  • Провайдер фабрики http-клиентов. [KnownToken.Axios.middleware]
  • Провайдер обработчика логирования исходящих http-запросов. [KnownToken.Axios.Middleware.Log.handler]
  • Провайдер клиентской части "моста" для передачи данных между сервером и клиентом. [KnownToken.SsrBridge.clientSide]
  • Провайдер известных http-хостов. [KnownToken.Http.Api.knownHosts]
  • Провайдер функции fetch. [KnownToken.Http.fetch]
  • Провайдер промежуточных слоев для fetch. [KnownToken.Http.Fetch.middleware]

После регистрации мы можем использовать компоненты, как из пресета, так и добавленные:

index.ts
import { app } from './app';

app.invoke([TOKEN.config, TOKEN.Known.logger], (config, logger) => {
  logger.info(config.appName);
});

PresetNode - Возвращает preset с зависимостями по умолчанию для frontend-микросервисов на Node.​

Встроенный функционал, который предоставляет PresetNode:​

  • Провайдер источника конфигурации. [KnownToken.Config.source]
  • Провайдер базовой конфигурации приложения. [KnownToken.Config.base]
  • Провайдер публичных переменных окружения. [KnownToken.Config.publicEnvs]
  • Провайдер Logger'а. [KnownToken.logger]
  • Провайдер объекта Tracer. [KnownToken.Tracing.tracer]
  • Провайдер объекта SpanExporter. [KnownToken.Tracing.spanExporter]
  • Провайдер объекта BasicTracerProvider. [KnownToken.Tracing.tracerProvider]
  • Провайдер объекта Resource. [KnownToken.Tracing.tracerProviderResource]
  • Провайдер express-приложения метрик. [KnownToken.Metrics.expressApp]
  • Провайдер функции fetch. [KnownToken.Http.fetch]
  • Провайдер фабрики экземпляров AxiosInstanceWrapper. [KnownToken.Axios.factory]
  • Провайдер основного express-приложения. [KnownToken.Express.app]
  • [KnownToken.Express.middleware] Возвращает токены на:
    • Провайдер промежуточного слоя учета входящих http-запросов. [KnownToken.Express.Middleware.request]
    • Провайдер промежуточного слоя логирования входящих http-запросов. [KnownToken.Express.Middleware.log]
    • Провайдер промежуточного слоя сбора метрик входящих http-запросов. [KnownToken.Express.Middleware.metrics]
    • Провайдер промежуточного слоя трассировки входящих http-запросов. [KnownToken.Express.Middleware.tracing]
  • [KnownToken.Express.endMiddleware] Возвращает токены на:
    • Провайдер промежуточного слоя обработки ошибок в рамках ответ на http-запросы. [KnownToken.Express.Middleware.error]
  • Провайдер фабрики http-серверов. [KnownToken.Express.factory]
  • Провайдер известных http-хостов. [KnownToken.Http.Api.knownHosts]
  • Провайдер серверной части "моста" для передачи данных между сервером и клиентом. [KnownToken.SsrBridge.serverSide]

PresetHandler - Возвращает preset с зависимостями по умолчанию для работы в рамках ответа на http-запрос.​

Встроенный функционал, который предоставляет PresetHandler:​

  • Провайдер функции fetch. [KnownToken.Http.fetch]
  • Провайдер промежуточных слоев для fetch. [KnownToken.Http.Fetch.middleware]
  • Провайдер AbortController. [KnownToken.Http.Fetch.abortController]
  • Провайдер обработчика логирования axios. [KnownToken.Http.Fetch.Middleware.Log.handler]
  • Провайдер промежуточного слоя redux-saga для redux-хранилища. [KnownToken.Redux.Middleware.saga]
  • Провайдер фабрики экземпляров AxiosInstanceWrapper. [KnownToken.Axios.factory]
  • Провайдер фабрики http-клиентов. [KnownToken.Axios.middleware]
  • Провайдер обработчика логирования axios. [KnownToken.Axios.Middleware.Log.handler]
  • Провайдер главной функции обработчика входящего http-запроса. [KnownToken.ExpressHandler.main]
  • Провайдер функции, которая определяет возможные типы ответа и их приоритет. [KnownToken.Http.Handler.Request.acceptType]
  • Провайдер специфичных параметров, которые frontend-микросервис будет получать в запросе. [KnownToken.Http.Handler.Request.specificParams]
  • Специфичные для наших микросервисов дополнительные данные ответа. [KnownToken.Http.Handler.Response.specificExtras]
  • Провайдер объекта событий ответа. [KnownToken.Http.Handler.Response.events]
  • Объект { js: '', css: '' } [KnownToken.Http.Handler.Page.assets]
  • Провайдер helmet-компонента. Этот компонент является контейнером для результата render-функции. [KnownToken.Http.Handler.Page.helmet]
  • Провайдер render-функции. [KnownToken.Http.Handler.Page.render]
  • Провайдер функции рендера элемента в строку. [KnownToken.Http.Handler.Page.elementToString]
  • Провайдер функции форматирования ответа. Функция форматирования вернёт данные ответа на запрос страницы в нужном формате в зависимости от заголовка Accept. [KnownToken.Http.Handler.Page.formatResponse]