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

package/src/http-client/utils.ts

@@ -1,76 +0,0 @@
-import { getServiceHeaders, getXClientIp } from '../http-server/utils';
-import type { Request } from 'express';
-import type { BaseConfig } from '../config/types';
-import type { AxiosInstance } from 'axios';
-import type { AxiosInstanceWrapper, MethodName } from 'middleware-axios';
-
-// @todo передавать заголовки
-export type SauceResponse<T = any> =
-  | {
-      ok: true;
-      data: T;
-    }
-  | {
-      ok: false;
-      error: any;
-    };
-
-export interface SauceMethod<K extends MethodName> {
-  <T>(...args: Parameters<AxiosInstanceWrapper[K]>): Promise<SauceResponse<T>>;
-}
-
-export interface Sauce {
-  readonly get: SauceMethod<'get'>;
-  readonly delete: SauceMethod<'delete'>;
-  readonly head: SauceMethod<'head'>;
-  readonly options: SauceMethod<'options'>;
-  readonly post: SauceMethod<'post'>;
-  readonly put: SauceMethod<'put'>;
-  readonly patch: SauceMethod<'patch'>;
-}
-
-/**
- * Оборачивает экземпляр axios. Все методы обертки возвращают promise, который никогда не попадают в состояние rejected.
- * @param instance Экземпляр axios или AxiosInstanceWrapper.
- * @return Обертка.
- */
-export function sauce(instance: AxiosInstance | AxiosInstanceWrapper): Sauce {
-  // eslint-disable-next-line require-jsdoc, jsdoc/require-jsdoc
-  function createMethod<Key extends MethodName>(methodName: Key) {
-    return async function <Data = any>(
-      ...args: Parameters<AxiosInstance[Key]>
-    ): Promise<SauceResponse<Data>> {
-      try {
-        const response = await instance[methodName](...(args as [any]));
-        return { ok: true, data: response.data };
-      } catch (error) {
-        return { ok: false, error };
-      }
-    };
-  }
-
-  return {
-    get: createMethod('get'),
-    delete: createMethod('delete'),
-    head: createMethod('head'),
-    options: createMethod('options'),
-    post: createMethod('post'),
-    put: createMethod('put'),
-    patch: createMethod('patch'),
-  };
-}
-
-/**
- * Формирует заголовки для исходящих запросов с сервера по соглашению.
- * @param config Конфиг.
- * @param request Входящий запрос.
- * @return Заголовки для исходящих запросов.
- */
-export function getRequestHeaders(config: BaseConfig, request: Request): Record<string, string> {
-  return {
-    'X-Client-Ip': getXClientIp(request),
-    'User-Agent': `simaland-${config.appName}/${config.appVersion}`,
-    Cookie: request.get('cookie') || '',
-    ...getServiceHeaders(request),
-  };
-}

package/src/http-server/constants.ts

@@ -1,4 +0,0 @@
-export const RESPONSE_EVENT = {
-  renderStart: Symbol('render:start'),
-  renderFinish: Symbol('render:finish'),
-} as const;

package/src/http-server/handler/health-check.ts

@@ -1,13 +0,0 @@
-import type { Handler } from 'express';
-
-/**
- * Обработчик, отвечающий данными о времени работы приложения.
- * @return Обработчик http-запроса.
- */
-export function healthCheck(): Handler {
-  const startTime = Date.now();
-
-  return (req, res) => {
-    res.json({ uptime: Date.now() - startTime });
-  };
-}

package/src/http-server/middleware/logging.ts

@@ -1,34 +0,0 @@
-import type { Handler } from 'express';
-import type { BaseConfig } from '../../config/types';
-import type { Logger, ConventionalFluentInfo } from '../../logger/types';
-import { getXClientIp } from '../utils';
-import { toMilliseconds } from '../../utils/number';
-
-/**
- * Возвращает новый middleware для логирования запросов.
- * @param config Конфиг.
- * @param logger Logger.
- * @return Middleware.
- */
-export function loggingMiddleware(config: BaseConfig, logger: Logger): Handler {
-  return function (req, res, next) {
-    const start = process.hrtime.bigint();
-
-    res.once('finish', () => {
-      const finish = process.hrtime.bigint();
-
-      const message: ConventionalFluentInfo = {
-        version: config.appVersion,
-        route: req.originalUrl,
-        method: req.method,
-        status: res.statusCode,
-        remote_ip: getXClientIp(req),
-        latency: toMilliseconds(finish - start),
-      };
-
-      logger.info(message);
-    });
-
-    next();
-  };
-}

package/src/http-server/middleware/metrics.ts

@@ -1,87 +0,0 @@
-import type { Request, Response, Handler } from 'express';
-import type { BaseConfig } from '../../config/types';
-import * as PromClient from 'prom-client';
-import { toMilliseconds } from '../../utils/number';
-import { RESPONSE_EVENT } from '../constants';
-import { ConventionalLabels } from '../../metrics/constants';
-
-/**
- * Возвращает новый middleware для формирования метрик входящего запроса.
- * @param config Конфиг.
- * @param metrics Метрики - счетчик запросов и гистограмма длительности ответа.
- * @return Middleware.
- */
-export function responseMetricsMiddleware(
-  config: BaseConfig,
-  metrics: {
-    counter: PromClient.Counter<typeof ConventionalLabels.HTTP_RESPONSE[number]>;
-    histogram: PromClient.Histogram<typeof ConventionalLabels.HTTP_RESPONSE[number]>;
-  },
-): Handler {
-  // eslint-disable-next-line require-jsdoc, jsdoc/require-jsdoc
-  function resolveLabels(
-    req: Request,
-    res: Response,
-  ): Record<typeof ConventionalLabels.HTTP_RESPONSE[number], string | number> {
-    return {
-      version: config.appVersion,
-      route: req.baseUrl + req.path,
-      code: res.statusCode,
-      method: req.method,
-    };
-  }
-
-  return (req, res, next) => {
-    const start = process.hrtime.bigint();
-
-    metrics.counter.inc(resolveLabels(req, res), 1);
-
-    res.once('finish', () => {
-      const finish = process.hrtime.bigint();
-
-      metrics.histogram.observe(resolveLabels(req, res), toMilliseconds(finish - start));
-    });
-
-    next();
-  };
-}
-
-/**
- * Возвращает новый middleware для формирования метрик рендеринга верстки.
- * @param config Конфиг.
- * @param metrics Метрики - гистограмма длительности рендеринга.
- * @return Middleware.
- */
-export function renderMetricsMiddleware(
-  config: BaseConfig,
-  metrics: {
-    histogram: PromClient.Histogram<typeof ConventionalLabels.SSR[number]>;
-  },
-): Handler {
-  return (req, res, next) => {
-    let start: bigint | undefined;
-
-    res.once(RESPONSE_EVENT.renderStart, () => {
-      start = process.hrtime.bigint();
-    });
-
-    res.once(RESPONSE_EVENT.renderFinish, () => {
-      if (typeof start !== 'bigint') {
-        throw Error('Looks like "render start" event not emitted');
-      }
-
-      const finish = process.hrtime.bigint();
-
-      metrics.histogram.observe(
-        {
-          version: config.appVersion,
-          method: req.method,
-          route: req.baseUrl + req.path,
-        },
-        toMilliseconds(finish - start),
-      );
-    });
-
-    next();
-  };
-}

package/src/http-server/middleware/tracing.ts

@@ -1,35 +0,0 @@
-import { RESPONSE_EVENT } from '../constants';
-import { propagation, ROOT_CONTEXT } from '@opentelemetry/api';
-import type { Tracer } from '../../tracer/types';
-import type { Handler } from 'express';
-
-/**
- * Возвращает новый middleware для трассировки стадий входящего запроса.
- * @param tracer Tracer.
- * @return Middleware.
- */
-export function tracingMiddleware(tracer: Tracer): Handler {
-  return (req, res, next) => {
-    const rootContext = propagation.extract(ROOT_CONTEXT, req.headers);
-    const rootSpan = tracer.startSpan('response', undefined, rootContext);
-
-    res.locals.tracing = {
-      rootSpan,
-      rootContext,
-    };
-
-    res.once(RESPONSE_EVENT.renderStart, () => {
-      res.locals.tracing.renderSpan = tracer.startSpan('render', undefined, rootContext);
-    });
-
-    res.once(RESPONSE_EVENT.renderFinish, () => {
-      res.locals.tracing.renderSpan.end();
-    });
-
-    res.once('finish', () => {
-      rootSpan.end();
-    });
-
-    next();
-  };
-}

package/src/http-server/types.ts

@@ -1,29 +0,0 @@
-import type { Request, Response, NextFunction, Handler, ErrorRequestHandler } from 'express';
-
-export interface ResponseContext {
-  req: Request;
-  res: Response;
-  next: NextFunction;
-}
-
-export interface PageAssets {
-  js: string;
-  css: string;
-}
-
-export interface ConventionalJson {
-  markup: string;
-  bundle_js: string;
-  bundle_css: string;
-  critical_js?: string;
-  critical_css?: string;
-  meta?: any;
-}
-
-export interface DefaultMiddleware {
-  start: Handler[];
-  logging: Handler[];
-  tracing: Handler[];
-  metrics: Handler[];
-  finish: Array<Handler | ErrorRequestHandler>;
-}

package/src/http-server/utils.ts

@@ -1,105 +0,0 @@
-import type { Request, Response } from 'express';
-import type { ConventionalJson, PageAssets } from './types';
-import { isIP } from 'net';
-
-/**
- * Определяет IP входящего запроса.
- * @param req Входящий запрос.
- * @return IP.
- */
-export function getXClientIp(req: Request): string {
-  const headerValue =
-    req.get('x-client-ip') || req.get('x-forwarded-for') || req.socket.remoteAddress || '';
-
-  return isIP(headerValue) ? headerValue : '';
-}
-
-/**
- * Определяет служебные заголовки по соглашению.
- * @param req Входящий запрос.
- * @return Служебные заголовки.
- */
-export function getServiceHeaders(req: Request): Record<string, string | undefined> {
-  const result: Record<string, string | undefined> = {};
-
-  for (const [key] of Object.entries(req.headers)) {
-    if (key.toLowerCase().indexOf('simaland-') === 0) {
-      result[key] = req.header(key);
-    }
-  }
-
-  return result;
-}
-
-/* eslint-disable require-jsdoc, jsdoc/require-jsdoc */
-export class PageResponse {
-  private type: 'html' | 'json';
-  private html: string;
-  private assets: PageAssets;
-
-  static create() {
-    return new PageResponse();
-  }
-
-  static defineFormat(req: Request): PageResponse['type'] {
-    let result: PageResponse['type'] = 'html';
-
-    if ((req.header('accept') || '').toLowerCase().includes('application/json')) {
-      result = 'json';
-    }
-
-    return result;
-  }
-
-  constructor() {
-    this.type = 'html';
-    this.html = '';
-    this.assets = { js: '', css: '' };
-  }
-
-  markup(html: string) {
-    this.html = html;
-    return this;
-  }
-
-  script(url: string) {
-    this.assets.js = url;
-    return this;
-  }
-
-  style(url: string) {
-    this.assets.css = url;
-    return this;
-  }
-
-  format(type: PageResponse['type']) {
-    this.type = type;
-    return this;
-  }
-
-  send(res: Response) {
-    switch (this.type) {
-      case 'json': {
-        const result: ConventionalJson = {
-          markup: this.html,
-          bundle_js: this.assets.js,
-          bundle_css: this.assets.css,
-        };
-
-        res.json(result);
-        break;
-      }
-      case 'html': {
-        res.setHeader('simaland-bundle-js', this.assets.js);
-        res.setHeader('simaland-bundle-css', this.assets.css);
-
-        // @todo dev-шаблон?
-        res.send(this.html);
-        break;
-      }
-      default:
-        throw Error(`Unknown response format ${String(this.type)}`);
-    }
-  }
-}
-/* eslint-enable require-jsdoc, jsdoc/require-jsdoc */

package/src/logger/handler/console.ts

@@ -1,35 +0,0 @@
-import type { BaseConfig } from '../../config/types';
-import pino from 'pino';
-import pinoPretty from 'pino-pretty';
-import { LoggerEventHandler } from '../types';
-
-/**
- * Возвращает новый handler для logger'а для вывода событий в терминал.
- * @param config Конфиг.
- * @return Handler.
- */
-export function createConsoleHandler(config: BaseConfig): LoggerEventHandler {
-  const isProd = config.env === 'production';
-
-  const logger = pino(
-    isProd
-      ? {
-          formatters: {
-            // ВАЖНО: для Fluent необходимо наличие поля level: string
-            level: label => ({ level: label }),
-          },
-        }
-      : pinoPretty({ colorize: true }),
-  );
-
-  return function (event) {
-    switch (event.type) {
-      case 'info':
-        logger.info(event.data);
-        break;
-      case 'error':
-        logger.error(event.data);
-        break;
-    }
-  };
-}

package/src/logger/handler/sentry.ts

@@ -1,38 +0,0 @@
-import type { SentryLib } from '../../error-tracker/types';
-import type { LoggerEventHandler } from '../types';
-import { SentryError } from '../../error-tracker/utils';
-
-/**
- * Возвращает новый handler для logger'а для отправки событий в Sentry.
- * @param sentry Набор данных для работы с Sentry.
- * @return Handler.
- */
-export function createSentryHandler(sentry: SentryLib): LoggerEventHandler {
-  return event => {
-    if (event.type === 'error') {
-      const error = event.data;
-
-      if (error instanceof SentryError) {
-        const { level, context, extra } = error.data;
-
-        sentry.withScope(scope => {
-          if (level) {
-            scope.setLevel(level);
-          }
-
-          if (context) {
-            scope.setContext(context.key, context.data);
-          }
-
-          if (extra) {
-            scope.setExtra(extra.key, extra.data);
-          }
-
-          sentry.client.captureException(error);
-        });
-      } else {
-        sentry.client.captureException(error);
-      }
-    }
-  };
-}

package/src/logger/index.ts

@@ -1,31 +0,0 @@
-import type { Logger, LoggerEvent, LoggerEventType, LoggerEventHandler } from './types';
-
-/**
- * Возвращает новый logger - объект для журналирования событий подобно console.
- * @return Logger.
- */
-export function createLogger(): Logger {
-  const handlers: LoggerEventHandler[] = [];
-
-  // eslint-disable-next-line require-jsdoc, jsdoc/require-jsdoc
-  function createMethod(type: LoggerEventType) {
-    return function (data: any) {
-      const event: LoggerEvent = { type, data };
-      for (const handler of handlers) {
-        handler(event);
-      }
-    };
-  }
-
-  return {
-    log: createMethod('log'),
-    info: createMethod('info'),
-    warn: createMethod('warn'),
-    error: createMethod('error'),
-    debug: createMethod('debug'),
-
-    subscribe: handler => {
-      handlers.push(handler);
-    },
-  };
-}

package/src/logger/types.ts

@@ -1,28 +0,0 @@
-export type LoggerEventType = 'error' | 'log' | 'info' | 'warn' | 'debug';
-
-export interface LoggerEvent {
-  type: LoggerEventType;
-  data: unknown;
-}
-
-export interface LoggerEventHandler {
-  (event: LoggerEvent): void;
-}
-
-export interface Logger {
-  error(data: any): void;
-  log(data: any): void;
-  info(data: any): void;
-  warn(data: any): void;
-  debug(data: any): void;
-  subscribe(handler: LoggerEventHandler): void;
-}
-
-export interface ConventionalFluentInfo {
-  version: string;
-  latency: number;
-  method: string;
-  remote_ip: string;
-  route: string;
-  status: number;
-}

package/src/metrics/constants.ts

@@ -1,4 +0,0 @@
-export const ConventionalLabels = {
-  HTTP_RESPONSE: ['version', 'route', 'code', 'method'],
-  SSR: ['version', 'route', 'method'],
-} as const;

package/src/metrics/node.ts

@@ -1,54 +0,0 @@
-import express, { Application } from 'express';
-import * as PromClient from 'prom-client';
-import { ConventionalLabels } from './constants';
-
-export interface DefaultNodeMetrics {
-  requestCount: PromClient.Counter<typeof ConventionalLabels.HTTP_RESPONSE[number]>;
-  responseDuration: PromClient.Histogram<typeof ConventionalLabels.HTTP_RESPONSE[number]>;
-  renderDuration: PromClient.Histogram<typeof ConventionalLabels.SSR[number]>;
-}
-
-/**
- * Возвращает новое express-приложение, настроенное для выдачи информации о метриках.
- * @return Приложение.
- */
-export function createMetricsHttpApp(): Application {
-  const app = express();
-
-  PromClient.collectDefaultMetrics();
-
-  app.get('/', async function (req, res) {
-    const metrics = await PromClient.register.metrics();
-
-    res.setHeader('Content-Type', PromClient.register.contentType);
-    res.send(metrics);
-  });
-
-  return app;
-}
-
-/**
- * Возвращает набор готовых метрик по умолчанию для приложений.
- * @return Набор метрик.
- */
-export function createDefaultMetrics(): DefaultNodeMetrics {
-  return {
-    requestCount: new PromClient.Counter({
-      name: 'http_request_count',
-      help: 'Incoming HTTP request count',
-      labelNames: ConventionalLabels.HTTP_RESPONSE,
-    }),
-    responseDuration: new PromClient.Histogram({
-      name: 'http_response_duration_ms',
-      help: 'Duration of incoming HTTP requests in ms',
-      labelNames: ConventionalLabels.HTTP_RESPONSE,
-      buckets: [30, 100, 200, 500, 1000, 2500, 5000, 10000],
-    }),
-    renderDuration: new PromClient.Histogram({
-      name: 'render_duration_ms',
-      help: 'Duration of SSR ms',
-      labelNames: ConventionalLabels.SSR,
-      buckets: [0.1, 15, 50, 100, 250, 500, 800, 1500],
-    }),
-  };
-}

package/src/preset/index.ts

@@ -1,24 +0,0 @@
-import type { Application } from '../container/application';
-import type { Provider, Token } from '../container/types';
-import type { Preset, PresetEntry } from './types';
-
-/**
- * Возвращает новый "preset" приложения - набор предустановленных компонентов которые можно переопределять.
- * @param defaults Предустановленные зависимости.
- * @return Preset.
- */
-export function createPreset(defaults: PresetEntry[]): Preset {
-  const registry = new Map<Token<any>, Provider<any>>(defaults);
-
-  return {
-    override: <T>(token: Token<T>, provider: Provider<T>) => {
-      registry.set(token, provider);
-    },
-
-    apply: (container: Application) => {
-      for (const [token, provider] of registry) {
-        container.bind(token).toProvider(provider);
-      }
-    },
-  };
-}