@rsdk/core 1.0.8 → 1.0.10

package/src/metrics/metadata/types.ts

@@ -0,0 +1,11 @@
+import type { Constructor } from '@rsdk/common';
+
+import type { AnyMetric, MetricMetadata, OmitType } from '../types';
+
+import type { MetricType } from './decorators';
+
+export type MetricRsdkMetadata = {
+  type: MetricType;
+  metadata: OmitType<MetricMetadata>;
+  metricController: Constructor<AnyMetric>;
+};

package/src/metrics/metrics.config.ts

@@ -1,6 +1,10 @@
 import { BoolParser, Config, ConfigSection, Property } from '../config';
+import { ConfigTag } from '../config/config.const';
 
-@ConfigSection({ name: 'Metrics configuration' })
+@ConfigSection({
+  name: 'Metrics configuration',
+  tags: [ConfigTag.infrastructure, ConfigTag.metric],
+})
 export class MetricsModuleConfig extends Config {
   @Property('METRICS_ENABLED', new BoolParser(), {
     defaultValue: true,

package/src/metrics/metrics.module.ts

@@ -4,12 +4,15 @@ import type {
   Provider,
 } from '@nestjs/common';
 import { Module } from '@nestjs/common';
+import { AutodocMetadata } from '@rsdk/autodoc-protocol';
 import type { Constructor } from '@rsdk/common';
+import { RsdkMetadata } from '@rsdk/metadata';
 import client from 'prom-client';
 
 import { PlatformConfigModule } from '../config';
 
-import { MetricsRegistry } from './metadata';
+import type { MetricRsdkMetadata } from './metadata';
+import { MetricAutodocResolver, MetricsRegistry } from './metadata';
 import { MetricsModuleConfig } from './metrics.config';
 import type { AnyMetric, MetricsModuleOptions } from './types';
 
@@ -65,10 +68,28 @@ export class MetricsModule implements OnApplicationBootstrap {
 
       const metadata = MetricsRegistry.getOne(ctor);
 
-      providers.push({
+      const provider = {
         provide: ctor,
         useValue: new ctor(metadata),
+      };
+
+      const rsdkMetadata = new RsdkMetadata<MetricRsdkMetadata>(
+        provider,
+        'metrics',
+      );
+
+      rsdkMetadata.add({
+        type: metadata.type,
+        metricController: ctor,
+        metadata,
       });
+
+      const autodocMetadata = new AutodocMetadata(rsdkMetadata);
+
+      const metricsDocumentResolver = new MetricAutodocResolver(rsdkMetadata);
+
+      autodocMetadata.defineResolver(metricsDocumentResolver);
+      providers.push(provider);
     }
 
     return {

package/src/platform.context.ts

@@ -2,10 +2,12 @@ import type { DynamicModule, INestMicroservice } from '@nestjs/common';
 import type { INestApplication } from '@nestjs/common/interfaces';
 import type { NestApplicationOptions } from '@nestjs/common/interfaces/nest-application-options.interface';
 import type { AbstractHttpAdapter } from '@nestjs/core';
+import type { Constructor } from '@rsdk/common';
 import { LoggerFactory } from '@rsdk/logging';
 import { groupBy, intersection } from 'lodash';
 
 import { Manifest } from './manifest/manifest';
+import type { Config, SectionMetadata } from './config';
 import { ConfigMetadataRegistry, PlatformConfigModule } from './config';
 import {
   DuplicateProtocolException,
@@ -34,12 +36,11 @@ import {
  */
 export class PlatformContext {
   readonly logger = LoggerFactory.create('App');
-  readonly root: DynamicModule;
-
   private microservices: Map<INestMicroservice, IMicroserviceTransport>;
   private readonly httpTransport: IHttpTransport | undefined;
   private readonly httpAdapter: AbstractHttpAdapter;
-  private readonly extendedOptions: PlatformExtendedOptions;
+  private _extendedOptions: PlatformExtendedOptions;
+  private _root: DynamicModule;
 
   /**
    * Создаёт контекст проводя базовые проверки
@@ -53,28 +54,39 @@ export class PlatformContext {
     PlatformContext.assertTransportCompatability(options);
     PlatformContext.assertPluginCompatability(options);
 
-    const { name, description, version } = Manifest.getData(
-      options.manifestPath,
-    );
+    this.httpTransport = options.transports?.find?.(isHttpTransport);
+    this.httpAdapter =
+      this.httpTransport?.getAdapter() ?? new NoopHttpAdapter();
+  }
+
+  get root(): DynamicModule {
+    if (this._root) {
+      return this._root;
+    }
+    PlatformConfigModule.bootstrap({
+      ...(this.extendedOptions.config ?? {}),
+      appName: this.extendedOptions.name,
+    });
+    this._root = PlatformModule.forRoot(this.extendedOptions);
+    return this._root;
+  }
+
+  get extendedOptions(): PlatformExtendedOptions {
+    if (this._extendedOptions) {
+      return this._extendedOptions;
+    }
+    const manifestData = Manifest.getData(this.options.manifestPath);
+    const { name, description, version } = manifestData;
 
     const extendedOptions: PlatformExtendedOptions = {
       description,
       name,
       version,
-      ...options,
+      ...this.options,
     };
 
-    this.extendedOptions = extendedOptions;
-
-    PlatformConfigModule.bootstrap({
-      ...(extendedOptions.config ?? {}),
-      appName: extendedOptions.name,
-    });
-    this.httpTransport = options.transports?.find?.(isHttpTransport);
-    this.httpAdapter =
-      this.httpTransport?.getAdapter() ?? new NoopHttpAdapter();
-
-    this.root = PlatformModule.forRoot(this.extendedOptions);
+    this._extendedOptions = extendedOptions;
+    return this._extendedOptions;
   }
 
   private static assertPluginCompatability(options: PlatformOptions): void {
@@ -115,14 +127,21 @@ export class PlatformContext {
 
     return {
       name: options.name,
-
+      version: options.version,
       description: options.description,
       protocols: protocols,
 
       config: {
         prefix: options.name,
-        sections: [...confMetadata.sections.values()].map(
-          transformSectionMetadata,
+        sections: [...confMetadata.sections.entries()].map(
+          ([section, metadata]: [
+            section: Constructor<Config>,
+            metadata: SectionMetadata,
+          ]) =>
+            transformSectionMetadata({
+              ...metadata,
+              constructorName: section.name,
+            }),
         ),
         sources: [...confMetadata.sources.values()],
 

package/src/tracing/tracing.config.ts

@@ -5,8 +5,11 @@ import {
   Property,
   UrlParser,
 } from '../config';
+import { ConfigTag } from '../config/config.const';
 
-@ConfigSection()
+@ConfigSection({
+  tags: [ConfigTag.infrastructure, ConfigTag.tracing],
+})
 export class TracingModuleConfig extends Config {
   @Property('TRACING_ENABLED', new BoolParser(), {
     defaultValue: false,

package/src/types/metadata.ts

@@ -49,7 +49,9 @@ export type SerializableSectionMetadata = Omit<
 export const transformSectionMetadata = ({
   properties,
   ...rest
-}: SectionMetadata): SerializableSectionMetadata => ({
+}: SectionMetadata & {
+  constructorName: string;
+}): SerializableSectionMetadata => ({
   ...rest,
   // TODO: Если properties переделается в мапу, может быть проблема
   properties: Object.values(properties).map(serializePropertyMetadata),
@@ -76,6 +78,11 @@ export interface PlatformAppMetadata {
    */
   description: string;
 
+  /**
+   * Application version
+   */
+  version: string;
+
   /**
    * Supported protocols
    */

package/src/types/options.ts

@@ -1,3 +1,4 @@
+import type { DynamicModule } from '@nestjs/common';
 import type { Constructor, RequiredFields } from '@rsdk/common';
 
 import type { ConfigModuleOptions } from '../config';
@@ -8,7 +9,8 @@ import type { IPrimaryTransport, ITransport } from './transports';
 /**
  * Not empty collection of modules
  */
-type Modules = [Constructor, ...Constructor[]];
+type Module = DynamicModule | Constructor;
+type Modules = [Module, ...Module[]];
 
 export interface ManifestData {
   /**

package/tsconfig.json

@@ -1,5 +1,4 @@
 {
-
   "extends": "@rsdk/tsconfig/base.json",
   "compilerOptions": {
     "declaration": true,