@application-kit/observability 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @application-kit/observability
 
+## 0.3.0
+
+### Minor Changes
+
+- 5311ebc: Входы `/logging`, `/health` (+ `/health/graphql`, `/health/cli`) и веб-часть `/metrics`.
+
+  - `/logging`: `PinoLoggerConfig` и `LoggerEnvironment` — опции nestjs-pino (уровень по исходу ответа, severity,
+    trace-миксин, redact, IP клиента через `resolveClientIp`), `resolveRequestId`/`REQUEST_ID_HEADER`, `resolveSupportId`,
+    `INFRASTRUCTURE_PATHS`/`isInfrastructurePath`.
+  - `/health`: `HealthModule.forRoot` (terminus + состав чека), `HealthHttpModule.forRoot` (`/health`, `/health/live`,
+    `/health/ready`), `HealthConfig`/`HealthEnvironment`, `MigrationsHealthIndicator`; носители GraphQL и CLI — подвходами.
+  - `/metrics`: `MetricsHttpModule.forRoot` с `GET /metrics` и `setupMetricsHooks(app)` — хуки Fastify и mercurius.
+
+  **Ломающее:** токен `OBSERVABILITY_LOGGER` и `ObservabilityLoggerInterface` переехали из `/cqrs` во вход `/logging` —
+  импорт потребителя меняется на `@application-kit/observability/logging`.
+
+## 0.2.0
+
+### Minor Changes
+
+- 06c0229: Вход `/cqrs`: `CqrsLoggerModule` и `CqrsLogger` — старт, длительность и исход каждой команды и запроса на шинах
+  `@nestjs/cqrs` (имя, а не полезная нагрузка); логгер приходит токеном `OBSERVABILITY_LOGGER` по контракту
+  `ObservabilityLoggerInterface`, `@nestjs/cqrs` — optional peer. Вход `/http`: `resolveClientIp(request, { trustedHeaders })` —
+  реальный IP клиента за прокси: доверенные заголовки по порядку, затем `request.ip` и адрес сокета; по умолчанию заголовкам
+  не доверяет.
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -1,8 +1,9 @@
 # @application-kit/observability
 
-Наблюдаемость NestJS-процесса. Первый вход — `/metrics`: реестр Prometheus с метриками процесса Node, RED-гистограммы
-HTTP и GraphQL и HTTP-сервер экспозиции для процессов без своего веб-слоя. Пакет не знает ни маршрутов, ни схемы,
-ни портов приложения: ярлыки и порт приходят параметрами, а хуки веб-сервера и контроллер скрейпа остаются у потребителя.
+Наблюдаемость NestJS-процесса: метрики Prometheus и контроллер скрейпа (`/metrics`), health-чек и пробы оркестратора
+(`/health`), опции pino с request-id и trace-контекстом (`/logging`), логирование команд и запросов CQRS-шин (`/cqrs`)
+и реальный IP клиента за прокси (`/http`). Пакет не знает ни продукта, ни guard'ов, ни прокси приложения: имя
+CLI-команды, декоратор публичного маршрута и доверенные заголовки приходят параметрами.
 
 ## Установка
 
@@ -10,14 +11,19 @@ HTTP и GraphQL и HTTP-сервер экспозиции для процесс
 yarn add @application-kit/observability
 ```
 
-Peer-зависимости: `@nestjs/common`, `@prometheus-io/client`; `graphql` — optional, нужен только GraphQL-гистограмме
-(из него берутся типы документа, сам вход грузится и без него).
+Peer-зависимости: `@nestjs/common`, `@prometheus-io/client`; остальные optional и нужны только своему входу — см. таблицу.
 
 ## Входы
 
 | Вход | Для чего | Тянет |
 |------|----------|-------|
-| `@application-kit/observability/metrics` | реестр, гистограммы HTTP и GraphQL, сервер `/metrics` | `@nestjs/common`, `@prometheus-io/client` |
+| `@application-kit/observability/cqrs` | логирование команд и запросов обеих шин | `@nestjs/common`, `@nestjs/cqrs` |
+| `@application-kit/observability/health` | состав чека, пробы `/health/live` и `/health/ready`, `GET /health` | `@nestjs/terminus`, `@nestjs/typeorm`, `typeorm`, `@application-kit/typeorm`, `class-validator`, `class-transformer` |
+| `@application-kit/observability/health/graphql` | `query { health { status } }` | `/health` + `@nestjs/graphql` |
+| `@application-kit/observability/health/cli` | CLI-команда `<группа> health` | `/health` + `nestjs-console` |
+| `@application-kit/observability/http` | `resolveClientIp` — IP клиента за прокси | ничего |
+| `@application-kit/observability/logging` | опции nestjs-pino, request-id, support-id, служебные пути, токен логгера | `@opentelemetry/api`, `class-validator`, `class-transformer`; типы — `nestjs-pino`, `pino` |
+| `@application-kit/observability/metrics` | реестр, гистограммы HTTP и GraphQL, `GET /metrics`, хуки Fastify, сервер `/metrics` | `@nestjs/common`, `@prometheus-io/client`; типы — `fastify`, `@nestjs/platform-fastify` |
 
 Корневого входа нет: каждый вход несёт свои peer-зависимости, и лишнего потребитель не ставит.
 
@@ -33,18 +39,16 @@ Peer-зависимости: `@nestjs/common`, `@prometheus-io/client`; `graphql
   `asMercuriusHook` оборачивает синхронный обработчик в async-хук Mercurius.
 - `DURATION_BUCKETS_SECONDS` — общие границы гистограмм, от 5 мс до 10 с.
 
+Web-процесс подключает `MetricsHttpModule.forRoot({ publicRoute })` — реестр, обе гистограммы и `GET /metrics`
+(путь — `METRICS_ROUTE` входа `/logging`), — и вешает хуки после создания приложения: HTTP — `onResponse` Fastify
+(видит и 404, и ошибки парсинга, которых не видит интерцептор Nest), GraphQL — хуки mercurius в `onReady`.
+
 ```ts
-app.register(async (instance) => {
-  instance.addHook('onResponse', (request, reply, done) => {
-    httpMetrics.observe({
-      durationSeconds: reply.elapsedTime / 1000,
-      method: request.method,
-      route: resolveRouteLabel(request.routeOptions.url),
-      status: reply.statusCode,
-    })
-    done()
-  })
-})
+@Module({ imports: [MetricsHttpModule.forRoot({ publicRoute: Public() })] })
+export class WebModule {}
+
+const app = await NestFactory.create<NestFastifyApplication>(AppModule, new FastifyAdapter())
+setupMetricsHooks(app)
 ```
 
 ## Сервер `/metrics` без веб-слоя
@@ -56,3 +60,80 @@ app.register(async (instance) => {
 ```ts
 const server = startMetricsServer({ onError: (error) => logger.error(error), port: 9464, registry })
 ```
+
+## Логирование CQRS-шин
+
+`CqrsLoggerModule` подключается корневым модулем процесса один раз. На каждую команду и запрос — запись о старте
+(подпиской на шину: видит все отправки) и о завершении с `durationMs` и `outcome` (обёрткой `execute` экземпляра шины:
+длительность и исход шина не публикует). В лог идёт ИМЯ класса, не полезная нагрузка; ошибка хендлера пишется на `error`
+и пробрасывается дальше.
+
+Логгер приложение приносит глобально токеном `OBSERVABILITY_LOGGER` (вход `/logging`; им же пишут носители health-чека)
+— подходит любой логгер с `info(payload, message)`
+и `error(payload, message)`, например `PinoLogger` из `nestjs-pino`:
+
+```ts
+@Global()
+@Module({
+  exports: [OBSERVABILITY_LOGGER],
+  providers: [AppLogger, { provide: OBSERVABILITY_LOGGER, useExisting: AppLogger }],
+})
+export class CommonModule {}
+
+@Module({ imports: [CommonModule, CqrsLoggerModule] })
+export class AppModule {}
+```
+
+## Логирование HTTP (`/logging`)
+
+- `PinoLoggerConfig.createOptions({ resolveClientIp })` — опции `LoggerModule` из nestjs-pino: уровень из
+  `LoggerEnvironment.LOG_LEVEL` (дефолт `warn`), уровень строки ответа по исходу (`responseLogLevel`: 5xx и исключение —
+  `error`, 4xx — `warn`, успешный служебный запрос — `debug`), `severity` для бэкенда логов, `trace_id`/`span_id` в каждой
+  строке (`traceContextMixin`), redact паролей и заголовков `authorization`/`cookie`, адрес клиента в `req.remoteAddress`.
+  Без `resolveClientIp` заголовкам не верят — см. «IP клиента за прокси».
+- `REQUEST_ID_HEADER` и `resolveRequestId` — `genReqId` Fastify: `x-request-id` от прокси либо свой UUID.
+- `resolveSupportId(request)` — идентификатор для пользователя и поддержки: trace_id активного спана, вне трассы — `request.id`.
+- `INFRASTRUCTURE_PATHS`, `isInfrastructurePath` — служебные маршруты (`/health`, `/metrics`) для тишины логов и трасс;
+  контроллеры входов `/health` и `/metrics` берут путь отсюда же.
+
+`LoggerEnvironment` и `HealthEnvironment` регистрирует приложение своим загрузчиком конфигов, как `DatabaseEnvironment`
+из `@application-kit/typeorm/nest`.
+
+## Health-чек (`/health`)
+
+`HealthModule.forRoot({ imports, logger })` — глобальное ядро процесса: terminus и `HealthChecks` (ping БД, heap, RSS,
+диск по корню; пороги — `HealthConfig`/`HealthEnvironment`). Носители подключаются там, где нужны, и берут состав
+отсюда — вердикт не зависит от того, каким путём спросили:
+
+- `HealthHttpModule.forRoot({ publicRoute })` — `GET /health` (полный чек), `/health/live` (пустая, без зависимостей) и
+  `/health/ready` (ping БД и применённые миграции). SQL проб идёт в области `runAsInfrastructureQuery` и логируется на `debug`.
+- `HealthGraphqlModule.forRoot({ publicRoute })` (вход `/health/graphql`) — `query { health { status } }`; отказ —
+  `status: "error"` и запись в лог.
+- `HealthCliModule.forRoot({ command })` (вход `/health/cli`) — `<command> health`, вердикт в лог.
+
+`publicRoute` — декоратор класса потребителя (например `Public()` его guard'а); он ложится на подкласс носителя,
+классы пакета не мутируются.
+
+```ts
+@Module({
+  imports: [
+    HealthModule.forRoot({ imports: [healthConfigsModule], logger: Logger }),
+    HealthHttpModule.forRoot({ publicRoute: Public() }),
+    HealthGraphqlModule.forRoot({ publicRoute: Public() }),
+  ],
+})
+export class WebModule {}
+```
+
+## IP клиента за прокси
+
+`resolveClientIp(request, { trustedHeaders })` принимает `IncomingMessage`, `FastifyRequest` или его обёртку из
+сериалайзера pino. Порядок: доверенные заголовки по порядку списка (первый непустой), затем `request.ip` (у Fastify —
+с учётом `trustProxy`), затем адрес сокета; источника нет — пустая строка.
+
+По умолчанию заголовкам не доверяет: в список кладётся только заголовок, который прокси перед процессом ставит и
+перезаписывает сам, — иначе клиент подставит в логи любой адрес.
+
+```ts
+const clientIp = resolveClientIp(request, { trustedHeaders: ['cf-connecting-ip'] })
+```

package/dist/cjs/cqrs/cqrs-logger.d.ts

@@ -0,0 +1,12 @@
+import { OnApplicationBootstrap } from '@nestjs/common';
+import { CommandBus, QueryBus } from '@nestjs/cqrs';
+import type { ObservabilityLoggerInterface } from '../logging/observability-logger.interface.js';
+export declare class CqrsLogger implements OnApplicationBootstrap {
+    private readonly commandBus;
+    private readonly queryBus;
+    private readonly logger;
+    private instrumented;
+    constructor(commandBus: CommandBus, queryBus: QueryBus, logger: ObservabilityLoggerInterface);
+    onApplicationBootstrap(): void;
+    private instrumentCompletion;
+}

package/dist/cjs/cqrs/cqrs-logger.js

@@ -0,0 +1,72 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CqrsLogger = void 0;
+const common_1 = require("@nestjs/common");
+const cqrs_1 = require("@nestjs/cqrs");
+const node_perf_hooks_1 = require("node:perf_hooks");
+const constants_js_1 = require("../logging/constants.js");
+const KIND_COMMAND = 'command';
+const KIND_QUERY = 'query';
+let CqrsLogger = class CqrsLogger {
+    commandBus;
+    queryBus;
+    logger;
+    instrumented = false;
+    constructor(commandBus, queryBus, logger) {
+        this.commandBus = commandBus;
+        this.queryBus = queryBus;
+        this.logger = logger;
+    }
+    onApplicationBootstrap() {
+        if (this.instrumented) {
+            return;
+        }
+        this.instrumented = true;
+        this.commandBus.subscribe((command) => {
+            this.logger.info({ [KIND_COMMAND]: command.constructor.name }, 'command started');
+        });
+        this.queryBus.subscribe((query) => {
+            this.logger.info({ [KIND_QUERY]: query.constructor.name }, 'query started');
+        });
+        this.instrumentCompletion(this.commandBus, KIND_COMMAND);
+        this.instrumentCompletion(this.queryBus, KIND_QUERY);
+    }
+    instrumentCompletion(bus, kind) {
+        const target = bus;
+        const original = target.execute.bind(target);
+        target.execute = async (payload, context) => {
+            const startedAt = node_perf_hooks_1.performance.now();
+            const { name } = payload.constructor;
+            try {
+                const result = await original(payload, context);
+                this.logger.info({ durationMs: node_perf_hooks_1.performance.now() - startedAt, [kind]: name, outcome: 'ok' }, `${kind} finished`);
+                return result;
+            }
+            catch (error) {
+                this.logger.error({ durationMs: node_perf_hooks_1.performance.now() - startedAt, err: error, [kind]: name, outcome: 'error' }, `${kind} failed`);
+                throw error;
+            }
+        };
+    }
+};
+exports.CqrsLogger = CqrsLogger;
+exports.CqrsLogger = CqrsLogger = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(cqrs_1.CommandBus)),
+    __param(1, (0, common_1.Inject)(cqrs_1.QueryBus)),
+    __param(2, (0, common_1.Inject)(constants_js_1.OBSERVABILITY_LOGGER)),
+    __metadata("design:paramtypes", [cqrs_1.CommandBus,
+        cqrs_1.QueryBus, Object])
+], CqrsLogger);

package/dist/cjs/cqrs/cqrs-logger.module.d.ts

@@ -0,0 +1,2 @@
+export declare class CqrsLoggerModule {
+}

package/dist/cjs/cqrs/cqrs-logger.module.js

@@ -0,0 +1,22 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CqrsLoggerModule = void 0;
+const common_1 = require("@nestjs/common");
+const cqrs_1 = require("@nestjs/cqrs");
+const cqrs_logger_js_1 = require("./cqrs-logger.js");
+let CqrsLoggerModule = class CqrsLoggerModule {
+};
+exports.CqrsLoggerModule = CqrsLoggerModule;
+exports.CqrsLoggerModule = CqrsLoggerModule = __decorate([
+    (0, common_1.Module)({
+        exports: [cqrs_logger_js_1.CqrsLogger],
+        imports: [cqrs_1.CqrsModule],
+        providers: [cqrs_logger_js_1.CqrsLogger],
+    })
+], CqrsLoggerModule);

package/dist/cjs/cqrs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './cqrs-logger.js';
+export * from './cqrs-logger.module.js';

package/dist/cjs/cqrs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cqrs-logger.js"), exports);
+__exportStar(require("./cqrs-logger.module.js"), exports);

package/dist/cjs/health/cli/health-cli-options.interface.d.ts

@@ -0,0 +1,3 @@
+export interface HealthCliOptionsInterface {
+    readonly command: string;
+}

package/dist/cjs/health/cli/health-cli-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/health/cli/health-cli.d.ts

@@ -0,0 +1,13 @@
+import type { Type } from '@nestjs/common';
+import { HealthCheckService } from '@nestjs/terminus';
+import type { ObservabilityLoggerInterface } from '../../logging/observability-logger.interface.js';
+import type { HealthCliOptionsInterface } from './health-cli-options.interface.js';
+import { HealthChecks } from '../health-checks.js';
+export declare class HealthCliCommands {
+    private readonly health;
+    private readonly logger;
+    private readonly healthChecks;
+    constructor(health: HealthCheckService, logger: ObservabilityLoggerInterface, healthChecks: HealthChecks);
+    getHealth(): Promise<void>;
+}
+export declare const createHealthCli: (options: HealthCliOptionsInterface) => Type<HealthCliCommands>;

package/dist/cjs/health/cli/health-cli.js

@@ -0,0 +1,56 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHealthCli = exports.HealthCliCommands = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const nestjs_console_1 = require("nestjs-console");
+const constants_js_1 = require("../../logging/constants.js");
+const with_class_decorator_js_1 = require("../../shared/with-class-decorator.js");
+const health_checks_js_1 = require("../health-checks.js");
+let HealthCliCommands = class HealthCliCommands {
+    health;
+    logger;
+    healthChecks;
+    constructor(health, logger, healthChecks) {
+        this.health = health;
+        this.logger = logger;
+        this.healthChecks = healthChecks;
+    }
+    async getHealth() {
+        try {
+            const healthResult = await this.health.check(this.healthChecks.build());
+            this.logger.info({ healthResult }, healthResult.status);
+        }
+        catch (error) {
+            const healthResult = error instanceof common_1.ServiceUnavailableException ? error.getResponse() : 'unknown';
+            this.logger.error({ healthResult }, 'error');
+        }
+    }
+};
+exports.HealthCliCommands = HealthCliCommands;
+__decorate([
+    (0, nestjs_console_1.Command)({ command: 'health' }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], HealthCliCommands.prototype, "getHealth", null);
+exports.HealthCliCommands = HealthCliCommands = __decorate([
+    __param(0, (0, common_1.Inject)(terminus_1.HealthCheckService)),
+    __param(1, (0, common_1.Inject)(constants_js_1.OBSERVABILITY_LOGGER)),
+    __param(2, (0, common_1.Inject)(health_checks_js_1.HealthChecks)),
+    __metadata("design:paramtypes", [terminus_1.HealthCheckService, Object, health_checks_js_1.HealthChecks])
+], HealthCliCommands);
+const createHealthCli = (options) => (0, with_class_decorator_js_1.withClassDecorator)(HealthCliCommands, (0, nestjs_console_1.Console)({ command: options.command }));
+exports.createHealthCli = createHealthCli;

package/dist/cjs/health/cli/health-cli.module.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { HealthCliOptionsInterface } from './health-cli-options.interface.js';
+export declare class HealthCliModule {
+    static forRoot(options: HealthCliOptionsInterface): DynamicModule;
+}

package/dist/cjs/health/cli/health-cli.module.js

@@ -0,0 +1,23 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCliModule = void 0;
+const common_1 = require("@nestjs/common");
+const health_cli_js_1 = require("./health-cli.js");
+let HealthCliModule = class HealthCliModule {
+    static forRoot(options) {
+        return {
+            module: this,
+            providers: [(0, health_cli_js_1.createHealthCli)(options)],
+        };
+    }
+};
+exports.HealthCliModule = HealthCliModule;
+exports.HealthCliModule = HealthCliModule = __decorate([
+    (0, common_1.Module)({})
+], HealthCliModule);

package/dist/cjs/health/cli/index.d.ts

@@ -0,0 +1,3 @@
+export * from './health-cli.js';
+export * from './health-cli-options.interface.js';
+export * from './health-cli.module.js';

package/dist/cjs/health/cli/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./health-cli.js"), exports);
+__exportStar(require("./health-cli-options.interface.js"), exports);
+__exportStar(require("./health-cli.module.js"), exports);

package/dist/cjs/health/graphql/health-check.type.d.ts

@@ -0,0 +1,3 @@
+export declare class HealthCheckType {
+    status: string;
+}

package/dist/cjs/health/graphql/health-check.type.js

@@ -0,0 +1,24 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckType = void 0;
+const graphql_1 = require("@nestjs/graphql");
+let HealthCheckType = class HealthCheckType {
+    status;
+};
+exports.HealthCheckType = HealthCheckType;
+__decorate([
+    (0, graphql_1.Field)(() => String),
+    __metadata("design:type", String)
+], HealthCheckType.prototype, "status", void 0);
+exports.HealthCheckType = HealthCheckType = __decorate([
+    (0, graphql_1.ObjectType)('HealthCheck')
+], HealthCheckType);

package/dist/cjs/health/graphql/health-graphql.module.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { HealthCarrierOptionsInterface } from '../health-module-options.interface.js';
+export declare class HealthGraphqlModule {
+    static forRoot(options?: HealthCarrierOptionsInterface): DynamicModule;
+}

package/dist/cjs/health/graphql/health-graphql.module.js

@@ -0,0 +1,26 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthGraphqlModule = void 0;
+const common_1 = require("@nestjs/common");
+const graphql_1 = require("@nestjs/graphql");
+const with_class_decorator_js_1 = require("../../shared/with-class-decorator.js");
+const health_resolver_js_1 = require("./health.resolver.js");
+let HealthGraphqlModule = class HealthGraphqlModule {
+    static forRoot(options = {}) {
+        const consumerDecorators = options.publicRoute === undefined ? [] : [options.publicRoute];
+        return {
+            module: this,
+            providers: [(0, with_class_decorator_js_1.withClassDecorator)(health_resolver_js_1.HealthResolver, (0, common_1.applyDecorators)((0, graphql_1.Resolver)(), ...consumerDecorators))],
+        };
+    }
+};
+exports.HealthGraphqlModule = HealthGraphqlModule;
+exports.HealthGraphqlModule = HealthGraphqlModule = __decorate([
+    (0, common_1.Module)({})
+], HealthGraphqlModule);

package/dist/cjs/health/graphql/health.resolver.d.ts

@@ -0,0 +1,11 @@
+import { HealthCheckService } from '@nestjs/terminus';
+import type { ObservabilityLoggerInterface } from '../../logging/observability-logger.interface.js';
+import { HealthChecks } from '../health-checks.js';
+import { HealthCheckType } from './health-check.type.js';
+export declare class HealthResolver {
+    private readonly healthCheck;
+    private readonly logger;
+    private readonly healthChecks;
+    constructor(healthCheck: HealthCheckService, logger: ObservabilityLoggerInterface, healthChecks: HealthChecks);
+    health(): Promise<HealthCheckType>;
+}

package/dist/cjs/health/graphql/health.resolver.js

@@ -0,0 +1,55 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthResolver = void 0;
+const common_1 = require("@nestjs/common");
+const graphql_1 = require("@nestjs/graphql");
+const terminus_1 = require("@nestjs/terminus");
+const constants_js_1 = require("../../logging/constants.js");
+const health_checks_js_1 = require("../health-checks.js");
+const health_check_type_js_1 = require("./health-check.type.js");
+let HealthResolver = class HealthResolver {
+    healthCheck;
+    logger;
+    healthChecks;
+    constructor(healthCheck, logger, healthChecks) {
+        this.healthCheck = healthCheck;
+        this.logger = logger;
+        this.healthChecks = healthChecks;
+    }
+    async health() {
+        try {
+            const health = await this.healthCheck.check(this.healthChecks.build());
+            return { status: health.status };
+        }
+        catch (error) {
+            this.logger.error({ err: error }, 'GraphQL health check failed');
+            return { status: 'error' };
+        }
+    }
+};
+exports.HealthResolver = HealthResolver;
+__decorate([
+    (0, graphql_1.Query)(() => health_check_type_js_1.HealthCheckType),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], HealthResolver.prototype, "health", null);
+exports.HealthResolver = HealthResolver = __decorate([
+    (0, graphql_1.Resolver)({ isAbstract: true }),
+    __param(0, (0, common_1.Inject)(terminus_1.HealthCheckService)),
+    __param(1, (0, common_1.Inject)(constants_js_1.OBSERVABILITY_LOGGER)),
+    __param(2, (0, common_1.Inject)(health_checks_js_1.HealthChecks)),
+    __metadata("design:paramtypes", [terminus_1.HealthCheckService, Object, health_checks_js_1.HealthChecks])
+], HealthResolver);

package/dist/cjs/health/graphql/index.d.ts

@@ -0,0 +1,3 @@
+export * from './health-check.type.js';
+export * from './health-graphql.module.js';
+export * from './health.resolver.js';

package/dist/cjs/health/graphql/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./health-check.type.js"), exports);
+__exportStar(require("./health-graphql.module.js"), exports);
+__exportStar(require("./health.resolver.js"), exports);

package/dist/cjs/health/health-checks.d.ts

@@ -0,0 +1,10 @@
+import { DiskHealthIndicator, HealthIndicatorFunction, MemoryHealthIndicator, TypeOrmHealthIndicator } from '@nestjs/terminus';
+import { HealthConfig } from './health.config.js';
+export declare class HealthChecks {
+    private readonly database;
+    private readonly memory;
+    private readonly disk;
+    private readonly config;
+    constructor(database: TypeOrmHealthIndicator, memory: MemoryHealthIndicator, disk: DiskHealthIndicator, config: HealthConfig);
+    build(): HealthIndicatorFunction[];
+}