@rsdk/grpc.server 4.0.0-next.3 → 4.0.0-next.5

package/dist/reflection.service.js

@@ -0,0 +1,151 @@
+"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); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var ReflectionService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReflectionService = void 0;
+const protobuf_1 = require("@bufbuild/protobuf");
+const common_1 = require("@nestjs/common");
+const grpc_health_v1_1 = __importDefault(require("@rsdk/builtin-contract/dist/grpc.health.v1"));
+const grpc_metrics_v1_1 = __importDefault(require("@rsdk/builtin-contract/dist/grpc.metrics.v1"));
+const grpc_reflection_v1_1 = __importDefault(require("@rsdk/builtin-contract/dist/grpc.reflection.v1"));
+const grpc_reflection_v1alpha_1 = __importDefault(require("@rsdk/builtin-contract/dist/grpc.reflection.v1alpha"));
+const logging_1 = require("@rsdk/logging");
+let ReflectionService = ReflectionService_1 = class ReflectionService {
+    packages;
+    services = new Set();
+    files = [];
+    logger = logging_1.LoggerFactory.create(ReflectionService_1);
+    constructor(packages) {
+        this.packages = packages;
+    }
+    onModuleInit() {
+        const allPackages = [
+            ...this.packages,
+            grpc_health_v1_1.default,
+            grpc_metrics_v1_1.default,
+            grpc_reflection_v1_1.default,
+            grpc_reflection_v1alpha_1.default,
+        ];
+        const allPackagesNames = new Set(allPackages.map((pkg) => pkg.name));
+        for (const pkg of allPackages) {
+            if (pkg.descriptor) {
+                for (const service of Object.keys(pkg.definitions['grpc-js'])) {
+                    this.logger.info(`GRPC descriptor loaded for service: ${pkg.name}.${service}`);
+                }
+                for (const file of protobuf_1.FileDescriptorSet.fromBinary(pkg.descriptor).file) {
+                    this.files.push(file);
+                    if (allPackagesNames.has(`${file.package}`)) {
+                        for (const service of file.service) {
+                            this.services.add(`${file.package}.${service.name}`);
+                        }
+                    }
+                }
+            }
+        }
+    }
+    /**
+     * List the full names of registered gRPC services
+     *
+     * note: the spec is unclear as to what the 'listServices' param can be; most
+     * clients seem to only pass '*' but unsure if this should behave like a
+     * filter. Until we know how this should behave with different inputs this
+     * just always returns *all* services.
+     *
+     * @returns full-qualified service names (eg. 'sample.SampleService')
+     */
+    listServices() {
+        return [...this.services];
+    }
+    /**
+     * Find the proto file(s) that declares the given fully-qualified symbol name
+     *
+     * @param symbol fully-qualified name of the symbol to lookup
+     * (e.g. package.service[.method] or package.type)
+     *
+     * @returns descriptors of the file which contains this symbol and its imports
+     */
+    fileBySymbol(symbol) {
+        const file = this.files.find((file) => this.findSymbol(symbol, file));
+        if (file) {
+            return Buffer.from(file.toBinary());
+        }
+        throw new Error(`symbol: ${symbol} not found`);
+    }
+    /**
+     * Find a proto file by the file name
+     * @returns descriptors of the file which contains this symbol and its imports
+     */
+    fileByName(filename) {
+        const file = this.files.find((file) => file.name === filename);
+        if (file) {
+            return Buffer.from(file.toBinary());
+        }
+        throw new Error(`file: ${filename} not found`);
+    }
+    /**
+     * Find a proto file containing an extension to a message type
+     * @returns descriptors of the file which contains this symbol and its imports
+     */
+    fileContainingExtension(containingType, extensionNumber) {
+        const extension = this.files.find((file) => {
+            const descriptor = this.findSymbol(containingType, file);
+            return (descriptor instanceof protobuf_1.DescriptorProto &&
+                descriptor.extension.some((extension) => extensionNumber === extension.number));
+        });
+        if (extension) {
+            return Buffer.from(extension.toBinary());
+        }
+        throw new Error(`containingType: ${containingType}, extensionNumber: ${extensionNumber} not found`);
+    }
+    allExtensionNumbersOfType(symbol) {
+        return [
+            ...new Set(this.files.flatMap((file) => file.extension.flatMap((_fqn, _file, ext) => ext
+                .filter((e) => e.extendee === symbol)
+                .flatMap((e) => Number(e.number))))),
+        ];
+    }
+    findSymbol(symbol, descriptor, prefix = '') {
+        if (descriptor instanceof protobuf_1.FileDescriptorProto) {
+            const packageName = descriptor.package;
+            const packagePrefix = packageName ? `${packageName}.` : '';
+            return (descriptor.messageType.find((type) => this.findSymbol(symbol, type, packagePrefix)) ??
+                descriptor.enumType.find((type) => this.findSymbol(symbol, type, packagePrefix)) ??
+                descriptor.service.find((type) => this.findSymbol(symbol, type, packagePrefix)));
+        }
+        const fullName = prefix + descriptor.name;
+        if (symbol === fullName) {
+            return descriptor;
+        }
+        if (descriptor instanceof protobuf_1.DescriptorProto) {
+            const messagePrefix = `${fullName}.`;
+            return (descriptor.nestedType.find((type) => this.findSymbol(symbol, type, messagePrefix)) ??
+                descriptor.enumType.find((type) => this.findSymbol(symbol, type, messagePrefix)));
+        }
+        if (descriptor instanceof protobuf_1.ServiceDescriptorProto) {
+            const servicePrefix = `${fullName}.`;
+            return descriptor.method.find((method) => this.findSymbol(symbol, method, servicePrefix));
+        }
+        return undefined;
+    }
+};
+exports.ReflectionService = ReflectionService;
+exports.ReflectionService = ReflectionService = ReflectionService_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)('GRPC_PACKAGES')),
+    __metadata("design:paramtypes", [Array])
+], ReflectionService);
+//# sourceMappingURL=reflection.service.js.map

package/dist/reflection.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reflection.service.js","sourceRoot":"","sources":["../src/reflection.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAIA,iDAK4B;AAE5B,2CAAoD;AACpD,gGAA2E;AAC3E,kGAA6E;AAC7E,wGAAqF;AACrF,kHAA+F;AAE/F,2CAA8C;AAGvC,IAAM,iBAAiB,yBAAvB,MAAM,iBAAiB;IAK0B;IAJrC,QAAQ,GAAgB,IAAI,GAAG,EAAE,CAAC;IAClC,KAAK,GAA0B,EAAE,CAAC;IAClC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,mBAAiB,CAAC,CAAC;IAElE,YAAsD,QAAmB;QAAnB,aAAQ,GAAR,QAAQ,CAAW;IAAG,CAAC;IAE7E,YAAY;QACV,MAAM,WAAW,GAAG;YAClB,GAAG,IAAI,CAAC,QAAQ;YAChB,wBAAiB;YACjB,yBAAkB;YAClB,4BAAuB;YACvB,iCAA4B;SAC7B,CAAC;QAEF,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAErE,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;YAC7B,IAAI,GAAG,CAAC,UAAU,EAAE;gBAClB,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE;oBAC7D,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,uCAAuC,GAAG,CAAC,IAAI,IAAI,OAAO,EAAE,CAC7D,CAAC;iBACH;gBAED,KAAK,MAAM,IAAI,IAAI,4BAAiB,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE;oBACpE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAEtB,IAAI,gBAAgB,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE;wBAC3C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;4BAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;yBACtD;qBACF;iBACF;aACF;SACF;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY;QACV,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,MAAc;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAEtE,IAAI,IAAI,EAAE;YACR,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;SACrC;QAED,MAAM,IAAI,KAAK,CAAC,WAAW,MAAM,YAAY,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,QAAgB;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QAE/D,IAAI,IAAI,EAAE;YACR,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;SACrC;QAED,MAAM,IAAI,KAAK,CAAC,SAAS,QAAQ,YAAY,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,uBAAuB,CACrB,cAAsB,EACtB,eAAuB;QAEvB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YAEzD,OAAO,CACL,UAAU,YAAY,0BAAe;gBACrC,UAAU,CAAC,SAAS,CAAC,IAAI,CACvB,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,KAAK,SAAS,CAAC,MAAM,CACpD,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,SAAS,EAAE;YACb,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;SAC1C;QAED,MAAM,IAAI,KAAK,CACb,mBAAmB,cAAc,sBAAsB,eAAe,YAAY,CACnF,CAAC;IACJ,CAAC;IAED,yBAAyB,CAAC,MAAc;QACtC,OAAO;YACL,GAAG,IAAI,GAAG,CACR,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC1B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAC1C,GAAG;iBACA,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC;iBACpC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CACpC,CACF,CACF;SACF,CAAC;IACJ,CAAC;IAEO,UAAU,CAChB,MAAc,EACd,UAKyB,EACzB,MAAM,GAAG,EAAE;QAOX,IAAI,UAAU,YAAY,8BAAmB,EAAE;YAC7C,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC;YAEvC,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAE3D,OAAO,CACL,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACnC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAC7C;gBACD,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAChC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAC7C;gBACD,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC/B,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAC7C,CACF,CAAC;SACH;QAED,MAAM,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC;QAE1C,IAAI,MAAM,KAAK,QAAQ,EAAE;YACvB,OAAO,UAAU,CAAC;SACnB;QAED,IAAI,UAAU,YAAY,0BAAe,EAAE;YACzC,MAAM,aAAa,GAAG,GAAG,QAAQ,GAAG,CAAC;YAErC,OAAO,CACL,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAC7C;gBACD,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAChC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAC7C,CACF,CAAC;SACH;QAED,IAAI,UAAU,YAAY,iCAAsB,EAAE;YAChD,MAAM,aAAa,GAAG,GAAG,QAAQ,GAAG,CAAC;YAErC,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACvC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,CAC/C,CAAC;SACH;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF,CAAA;AA7LY,8CAAiB;4BAAjB,iBAAiB;IAD7B,IAAA,mBAAU,GAAE;IAME,WAAA,IAAA,eAAM,EAAC,eAAe,CAAC,CAAA;;GALzB,iBAAiB,CA6L7B"}

package/jest.config.js

@@ -0,0 +1,11 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { resolve } = require('node:path');
+
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+
+  setupFiles: ['dotenv/config'],
+  rootDir: resolve(__dirname, 'src'),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/grpc.server",
-  "version": "4.0.0-next.3",
+  "version": "4.0.0-next.5",
   "description": "Grpc transport for platform, clients and common grpc stuff",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -18,18 +18,19 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/microservices": "^10.0.0",
-    "@rsdk/builtin-contract": "^4.0.0-next.2",
+    "@rsdk/builtin-contract": "^4.0.0-next.5",
     "@rsdk/common": "^4.0.0-next.3",
-    "@rsdk/core": "^4.0.0-next.3",
-    "@rsdk/grpc.common": "^4.0.0-next.3",
-    "@rsdk/grpc.loader": "^4.0.0-next.2",
+    "@rsdk/core": "^4.0.0-next.5",
+    "@rsdk/grpc.common": "^4.0.0-next.5",
+    "@rsdk/grpc.loader": "^4.0.0-next.5",
     "@rsdk/logging": "^4.0.0-next.3",
     "nice-grpc": "^2.1.4",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1"
   },
   "dependencies": {
+    "@bufbuild/protobuf": "^1.4.2",
     "nice-grpc-opentelemetry": "^0.1.2"
   },
-  "gitHead": "313c39a379ea9ace9d94939223a53c46c12d77f9"
+  "gitHead": "aaccdd91f43b75ceb64b03595e830f558f5aa30c"
 }

package/src/controllers/index.ts

@@ -1,2 +1,4 @@
 export * from './health.controller';
 export * from './metrics.controller';
+export * from './reflection/v1.controller';
+export * from './reflection/v1alpha.controller';

package/src/controllers/reflection/v1.base.controller.ts

@@ -0,0 +1,173 @@
+import * as grpc from '@grpc/grpc-js';
+import { Inject, NotImplementedException } from '@nestjs/common';
+import type {
+  ServerReflectionGrpcController,
+  ServerReflectionRequest,
+  ServerReflectionResponse,
+} from '@rsdk/builtin-contract/dist/grpc.reflection.v1';
+import { InjectLogger } from '@rsdk/core';
+import { ILogger } from '@rsdk/logging';
+import type { Observable } from 'rxjs';
+import { Subject } from 'rxjs';
+
+import { GRPCConfig } from '../../grpc.config';
+import { ReflectionService } from '../../reflection.service';
+
+/**
+ * Base class for alpha and final 'v1' versions of the gRPC reflection API
+ *
+ * note: the final version of the v1 spec was identical to the alpha version, so
+ * this common class is used in order to share logic across multiple controllers
+ * (this class itself is *not* a controller). See child classes for actual APIs
+ *
+ * @see {@link https://github.com/grpc/grpc/blob/master/doc/server-reflection.md}
+ */
+export class BaseV1GrpcReflectionController
+  implements ServerReflectionGrpcController
+{
+  constructor(
+    private readonly config: GRPCConfig,
+    @InjectLogger(ReflectionService) private readonly logger: ILogger,
+    @Inject(ReflectionService) private readonly service: ReflectionService,
+  ) {}
+
+  /** Main method for providing information about the running gRPC server
+   *
+   * The spec defines this as a single streaming method so that the connection
+   * stays open to the same running instance of the server for all follow-up
+   * requests. This means that we can keep some kind of state about what we've
+   * already to that client or not if we need to.
+   */
+  serverReflectionInfo(
+    request$: Observable<ServerReflectionRequest>,
+  ): Observable<ServerReflectionResponse> {
+    const response$ = new Subject<ServerReflectionResponse>();
+
+    request$.subscribe({
+      next: this.config.reflection
+        ? this.resolveReflection(response$)
+        : this.reflectionIsDisabled(response$),
+      complete: (): void => response$.complete(),
+    });
+
+    return response$.asObservable();
+  }
+
+  private makeResponse(
+    request: ServerReflectionRequest,
+  ): ServerReflectionResponse {
+    if (request.messageRequest?.$case === 'listServices') {
+      return this.createServerReflectionResponse(request, {
+        $case: 'listServicesResponse',
+        listServicesResponse: {
+          service: this.service.listServices().map((name) => ({ name })),
+        },
+      });
+    }
+
+    if (request.messageRequest?.$case === 'fileContainingSymbol') {
+      return this.createServerReflectionResponse(request, {
+        $case: 'fileDescriptorResponse',
+        fileDescriptorResponse: {
+          fileDescriptorProto: [
+            this.service.fileBySymbol(
+              request.messageRequest.fileContainingSymbol,
+            ),
+          ],
+        },
+      });
+    }
+
+    if (request.messageRequest?.$case === 'fileByFilename') {
+      return this.createServerReflectionResponse(request, {
+        $case: 'fileDescriptorResponse',
+        fileDescriptorResponse: {
+          fileDescriptorProto: [
+            this.service.fileByName(request.messageRequest.fileByFilename),
+          ],
+        },
+      });
+    }
+
+    if (request.messageRequest?.$case === 'fileContainingExtension') {
+      return this.createServerReflectionResponse(request, {
+        $case: 'fileDescriptorResponse',
+        fileDescriptorResponse: {
+          fileDescriptorProto: [
+            this.service.fileContainingExtension(
+              request.messageRequest.fileContainingExtension.containingType,
+              request.messageRequest.fileContainingExtension.extensionNumber,
+            ),
+          ],
+        },
+      });
+    }
+
+    if (request.messageRequest?.$case === 'allExtensionNumbersOfType') {
+      return this.createServerReflectionResponse(request, {
+        $case: 'allExtensionNumbersResponse',
+        allExtensionNumbersResponse: {
+          baseTypeName: request.messageRequest.allExtensionNumbersOfType,
+          extensionNumber: this.service.allExtensionNumbersOfType(
+            request.messageRequest.allExtensionNumbersOfType,
+          ),
+        },
+      });
+    }
+
+    this.logger.error('NotImplementedException', { request });
+
+    throw new NotImplementedException(request.messageRequest);
+  }
+
+  private createServerReflectionResponse(
+    request: ServerReflectionRequest,
+    message: ServerReflectionResponse['messageResponse'],
+  ): ServerReflectionResponse {
+    return {
+      validHost: request.host,
+      originalRequest: request,
+      messageResponse: message,
+    };
+  }
+
+  private resolveReflection(
+    response$: Subject<ServerReflectionResponse>,
+  ): (message: ServerReflectionRequest) => void {
+    return (message: ServerReflectionRequest): void => {
+      try {
+        response$.next(this.makeResponse(message));
+      } catch (error) {
+        if (error instanceof Error) {
+          this.logger.error(error);
+        }
+
+        const response = this.createServerReflectionResponse(message, {
+          $case: 'errorResponse',
+          errorResponse: {
+            errorCode: grpc.status.UNKNOWN,
+            errorMessage: `Failed to process gRPC reflection request: ${error}`,
+          },
+        });
+
+        response$.next(response);
+      }
+    };
+  }
+
+  private reflectionIsDisabled(
+    response$: Subject<ServerReflectionResponse>,
+  ): (message: ServerReflectionRequest) => void {
+    return (message: ServerReflectionRequest): void => {
+      const response = this.createServerReflectionResponse(message, {
+        $case: 'errorResponse',
+        errorResponse: {
+          errorCode: grpc.status.UNAVAILABLE,
+          errorMessage: `Reflection is disabled by config`,
+        },
+      });
+
+      return response$.next(response);
+    };
+  }
+}

package/src/controllers/reflection/v1.controller.ts

@@ -0,0 +1,25 @@
+import type {
+  ServerReflectionGrpcController,
+  ServerReflectionRequest,
+  ServerReflectionResponse,
+} from '@rsdk/builtin-contract/dist/grpc.reflection.v1';
+import { ServerReflectionGrpcMethods } from '@rsdk/builtin-contract/dist/grpc.reflection.v1';
+import type { Observable } from 'rxjs';
+
+import { BaseV1GrpcReflectionController } from './v1.base.controller';
+
+/** Implements the 'v1' (final) version of the gRPC Reflection API spec
+ *
+ * @see {@link https://github.com/grpc/grpc/blob/master/doc/server-reflection.md}
+ */
+@ServerReflectionGrpcMethods()
+export class ReflectionV1Controller
+  extends BaseV1GrpcReflectionController
+  implements ServerReflectionGrpcController
+{
+  override serverReflectionInfo(
+    request: Observable<ServerReflectionRequest>,
+  ): Observable<ServerReflectionResponse> {
+    return super.serverReflectionInfo(request);
+  }
+}

package/src/controllers/reflection/v1alpha.controller.ts

@@ -0,0 +1,25 @@
+import { ServerReflectionGrpcMethods } from '@rsdk/builtin-contract/dist/grpc.reflection.v1';
+import type {
+  ServerReflectionGrpcController,
+  ServerReflectionRequest,
+  ServerReflectionResponse,
+} from '@rsdk/builtin-contract/dist/grpc.reflection.v1alpha';
+import type { Observable } from 'rxjs';
+
+import { BaseV1GrpcReflectionController } from './v1.base.controller';
+
+/** Implements the 'v1alpha' version of the gRPC Reflection API spec
+ *
+ * @see {@link https://github.com/grpc/grpc/blob/master/doc/server-reflection.md}
+ */
+@ServerReflectionGrpcMethods()
+export class ReflectionV1alphaController
+  extends BaseV1GrpcReflectionController
+  implements ServerReflectionGrpcController
+{
+  override serverReflectionInfo(
+    request: Observable<ServerReflectionRequest>,
+  ): Observable<ServerReflectionResponse> {
+    return super.serverReflectionInfo(request);
+  }
+}

package/src/grpc.config.ts

@@ -4,6 +4,7 @@ import {
 } from '@grpc/grpc-js/build/src/constants';
 import { text } from '@rsdk/common';
 import {
+  BoolParser,
   Config,
   ConfigSection,
   ConfigTag,
@@ -36,4 +37,10 @@ export class GRPCConfig extends Config {
     description: 'Max gRPC message size (send)',
   })
   readonly maxSend!: number;
+
+  @Property('GRPC_REFLECTION', new BoolParser(), {
+    defaultValue: false,
+    description: 'Enable reflection',
+  })
+  readonly reflection!: boolean;
 }

package/src/grpc.transport.ts

@@ -2,6 +2,8 @@ import type { Controller } from '@nestjs/common/interfaces';
 import type { MicroserviceOptions } from '@nestjs/microservices';
 import HealthGrpcPackage from '@rsdk/builtin-contract/dist/grpc.health.v1';
 import MetricsGrpcPackage from '@rsdk/builtin-contract/dist/grpc.metrics.v1';
+import ReflectionGrpcPackageV1 from '@rsdk/builtin-contract/dist/grpc.reflection.v1';
+import ReflectionGrpcPackageV1alpha from '@rsdk/builtin-contract/dist/grpc.reflection.v1alpha';
 import type { Constructor } from '@rsdk/common';
 import type {
   ConfigContext,
@@ -9,6 +11,7 @@ import type {
   IErrorsSender,
   IErrorsTransformer,
   IMicroserviceTransport,
+  NestModuleDefinitions,
 } from '@rsdk/core';
 import { SequenceException } from '@rsdk/core';
 import type { Package } from '@rsdk/grpc.loader';
@@ -17,10 +20,19 @@ import { LoggerFactory } from '@rsdk/logging';
 
 import { HealthController, MetricsController } from './controllers';
 import { GRPCConfig } from './grpc.config';
+import { isPackageNotIncluded } from './grpc.utils';
 import { GrpcErrorsFormatter } from './grpc-errors.formatter';
 import { GrpcErrorsSender } from './grpc-errors.sender';
+import { ReflectionModule } from './reflection.module';
 
 export class GrpcTransport implements IMicroserviceTransport {
+  private readonly systemPackages: Package[] = [
+    HealthGrpcPackage,
+    MetricsGrpcPackage,
+    ReflectionGrpcPackageV1,
+    ReflectionGrpcPackageV1alpha,
+  ];
+
   private readonly logger = LoggerFactory.create(GrpcTransport);
   private readonly packages: Package[];
 
@@ -72,17 +84,7 @@ export class GrpcTransport implements IMicroserviceTransport {
   }
 
   createMicroserviceOptions(): MicroserviceOptions {
-    this.checkIsInitialized();
-
-    const packages = [...this.packages];
-
-    if (!packages.some((x) => x.name === HealthGrpcPackage.name)) {
-      packages.push(HealthGrpcPackage);
-    }
-
-    if (!packages.some((x) => x.name === MetricsGrpcPackage.name)) {
-      packages.push(MetricsGrpcPackage);
-    }
+    const packages = this.getUniquePackages();
 
     for (const pkg of packages) {
       for (const service of Object.keys(pkg.definitions['grpc-js'])) {
@@ -90,14 +92,22 @@ export class GrpcTransport implements IMicroserviceTransport {
       }
     }
 
+    this.checkIsInitialized();
+    this.assertIsDefined(this.address);
+    this.assertIsDefined(this.maxRecv);
+    this.assertIsDefined(this.maxSend);
+
     return createGrpcOptions(packages, {
-      // FIXME добавить проверку
-      address: this.address!,
-      maxRecv: this.maxRecv!,
-      maxSend: this.maxSend!,
+      address: this.address,
+      maxRecv: this.maxRecv,
+      maxSend: this.maxSend,
     });
   }
 
+  modules(): NestModuleDefinitions {
+    return [ReflectionModule.forRoot(this.packages)];
+  }
+
   onStart(): void {
     this.checkIsInitialized();
 
@@ -109,4 +119,30 @@ export class GrpcTransport implements IMicroserviceTransport {
       throw new SequenceException('You should call init() method first!');
     }
   }
+
+  /**
+   * Checks the value must be defined and not null
+   * @param value any value
+   */
+  private assertIsDefined<T>(value: T): asserts value is NonNullable<T> {
+    if (value === undefined || value === null) {
+      throw new Error(`${value} is not defined`);
+    }
+  }
+
+  /**
+   * Merge user packages with system packages
+   * @returns array of unique packages
+   */
+  private getUniquePackages(): Package[] {
+    const packages = [...this.packages];
+
+    for (const pkg of this.systemPackages) {
+      if (isPackageNotIncluded(packages, pkg)) {
+        packages.push(pkg);
+      }
+    }
+
+    return packages;
+  }
 }

package/src/grpc.utils.ts

@@ -0,0 +1,20 @@
+/**
+ * Match packages name
+ * @param pkg
+ * @returns true if names is equal
+ */
+const isEqualPackageName =
+  <T extends { name: string }>(pkg: T) =>
+  (x: T): boolean =>
+    x.name === pkg.name;
+
+/**
+ * Checks whether a pkg is in the array
+ * @param packages array of packages
+ * @param pkg package you are looking for
+ * @returns true if pkg exists in packages
+ */
+export const isPackageNotIncluded = <T extends { name: string }>(
+  packages: T[],
+  pkg: T,
+): boolean => !packages.some(isEqualPackageName(pkg));

package/src/reflection.module.ts

@@ -0,0 +1,26 @@
+import type { DynamicModule } from '@nestjs/common';
+import { Module } from '@nestjs/common';
+import type { Package } from '@rsdk/grpc.loader';
+
+import {
+  ReflectionV1alphaController,
+  ReflectionV1Controller,
+} from './controllers';
+import { ReflectionService } from './reflection.service';
+
+@Module({})
+export class ReflectionModule {
+  static forRoot(packages: Package[]): DynamicModule {
+    return {
+      module: ReflectionModule,
+      controllers: [ReflectionV1alphaController, ReflectionV1Controller],
+      providers: [
+        ReflectionService,
+        {
+          provide: 'GRPC_PACKAGES',
+          useValue: packages,
+        },
+      ],
+    };
+  }
+}