@rsdk/grpc.server 4.0.0-next.1 → 4.0.0-next.11

package/dist/grpc.transport.js

@@ -4,16 +4,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GrpcTransport = void 0;
+const core_1 = require("@nestjs/core");
 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 core_1 = require("@rsdk/core");
+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 core_2 = require("@rsdk/core");
 const grpc_loader_1 = require("@rsdk/grpc.loader");
 const logging_1 = require("@rsdk/logging");
 const controllers_1 = require("./controllers");
 const grpc_config_1 = require("./grpc.config");
+const grpc_utils_1 = require("./grpc.utils");
 const grpc_errors_formatter_1 = require("./grpc-errors.formatter");
 const grpc_errors_sender_1 = require("./grpc-errors.sender");
+const grpc_logger_interceptor_1 = require("./grpc-logger.interceptor");
+const reflection_module_1 = require("./reflection.module");
 class GrpcTransport {
+    systemPackages = [
+        grpc_health_v1_1.default,
+        grpc_metrics_v1_1.default,
+        grpc_reflection_v1_1.default,
+        grpc_reflection_v1alpha_1.default,
+    ];
     logger = logging_1.LoggerFactory.create(GrpcTransport);
     packages;
     address;
@@ -41,6 +53,20 @@ class GrpcTransport {
     getHealthController() {
         return controllers_1.HealthController;
     }
+    modules() {
+        return [
+            reflection_module_1.ReflectionModule.forRoot(this.packages),
+            {
+                module: GrpcTransport,
+                providers: [
+                    {
+                        provide: core_1.APP_INTERCEPTOR,
+                        useClass: grpc_logger_interceptor_1.GrpcLoggerInterceptor,
+                    },
+                ],
+            },
+        ];
+    }
     /**
      * Unfortunally we can't access GRPCConfig in constructor because
      * PlatformConfigModule is not initilalized yet
@@ -53,21 +79,17 @@ class GrpcTransport {
         this.isInitialized = true;
     }
     createMicroserviceOptions() {
-        this.checkIsInitialized();
-        const packages = [...this.packages];
-        if (!packages.some((x) => x.name === grpc_health_v1_1.default.name)) {
-            packages.push(grpc_health_v1_1.default);
-        }
-        if (!packages.some((x) => x.name === grpc_metrics_v1_1.default.name)) {
-            packages.push(grpc_metrics_v1_1.default);
-        }
+        const packages = this.getUniquePackages();
         for (const pkg of packages) {
             for (const service of Object.keys(pkg.definitions['grpc-js'])) {
                 this.logger.info(`Expose grpc-service: ${pkg.name}.${service}`);
             }
         }
+        this.checkIsInitialized();
+        this.assertIsDefined(this.address);
+        this.assertIsDefined(this.maxRecv);
+        this.assertIsDefined(this.maxSend);
         return (0, grpc_loader_1.createGrpcOptions)(packages, {
-            // FIXME добавить проверку
             address: this.address,
             maxRecv: this.maxRecv,
             maxSend: this.maxSend,
@@ -79,8 +101,30 @@ class GrpcTransport {
     }
     checkIsInitialized() {
         if (!this.isInitialized) {
-            throw new core_1.SequenceException('You should call init() method first!');
+            throw new core_2.SequenceException('You should call init() method first!');
+        }
+    }
+    /**
+     * Checks the value must be defined and not null
+     * @param value any value
+     */
+    assertIsDefined(value) {
+        if (value === undefined || value === null) {
+            throw new Error(`${value} is not defined`);
+        }
+    }
+    /**
+     * Merge user packages with system packages
+     * @returns array of unique packages
+     */
+    getUniquePackages() {
+        const packages = [...this.packages];
+        for (const pkg of this.systemPackages) {
+            if ((0, grpc_utils_1.isPackageNotIncluded)(packages, pkg)) {
+                packages.push(pkg);
+            }
         }
+        return packages;
     }
 }
 exports.GrpcTransport = GrpcTransport;

package/dist/grpc.transport.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc.transport.js","sourceRoot":"","sources":["../src/grpc.transport.ts"],"names":[],"mappings":";;;;;;AAEA,gGAA2E;AAC3E,kGAA6E;AAS7E,qCAA+C;AAE/C,mDAAsD;AACtD,2CAA8C;AAE9C,+CAAoE;AACpE,+CAA2C;AAC3C,mEAA8D;AAC9D,6DAAwD;AAExD,MAAa,aAAa;IACP,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC7C,QAAQ,CAAY;IAE7B,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IAEjB,aAAa,GAAG,KAAK,CAAC;IAE9B,YAAY,GAAG,QAAmB;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,WAAW;QACT,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,2CAAmB,EAAE,CAAC;IACnC,CAAC;IAED,eAAe;QACb,OAAO,IAAI,qCAAgB,EAAE,CAAC;IAChC,CAAC;IAED,oBAAoB;QAClB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,oBAAoB;QAClB,OAAO,+BAAiB,CAAC;IAC3B,CAAC;IAED,mBAAmB;QACjB,OAAO,8BAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,aAA4B;QAC/B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,wBAAU,CAAC,CAAC;QAExE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IAC5B,CAAC;IAED,yBAAyB;QACvB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEpC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,wBAAiB,CAAC,IAAI,CAAC,EAAE;YAC5D,QAAQ,CAAC,IAAI,CAAC,wBAAiB,CAAC,CAAC;SAClC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,yBAAkB,CAAC,IAAI,CAAC,EAAE;YAC7D,QAAQ,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAC;SACnC;QAED,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE;gBAC7D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,GAAG,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC,CAAC;aACjE;SACF;QAED,OAAO,IAAA,+BAAiB,EAAC,QAAQ,EAAE;YACjC,0BAA0B;YAC1B,OAAO,EAAE,IAAI,CAAC,OAAQ;YACtB,OAAO,EAAE,IAAI,CAAC,OAAQ;YACtB,OAAO,EAAE,IAAI,CAAC,OAAQ;SACvB,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oCAAoC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAEO,kBAAkB;QACxB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,MAAM,IAAI,wBAAiB,CAAC,sCAAsC,CAAC,CAAC;SACrE;IACH,CAAC;CACF;AAzFD,sCAyFC"}
+{"version":3,"file":"grpc.transport.js","sourceRoot":"","sources":["../src/grpc.transport.ts"],"names":[],"mappings":";;;;;;AACA,uCAA+C;AAE/C,gGAA2E;AAC3E,kGAA6E;AAC7E,wGAAqF;AACrF,kHAA+F;AAU/F,qCAA+C;AAE/C,mDAAsD;AACtD,2CAA8C;AAE9C,+CAAoE;AACpE,+CAA2C;AAC3C,6CAAoD;AACpD,mEAA8D;AAC9D,6DAAwD;AACxD,uEAAkE;AAClE,2DAAuD;AAEvD,MAAa,aAAa;IACP,cAAc,GAAc;QAC3C,wBAAiB;QACjB,yBAAkB;QAClB,4BAAuB;QACvB,iCAA4B;KAC7B,CAAC;IAEe,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC7C,QAAQ,CAAY;IAE7B,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IAEjB,aAAa,GAAG,KAAK,CAAC;IAE9B,YAAY,GAAG,QAAmB;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,WAAW;QACT,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,2CAAmB,EAAE,CAAC;IACnC,CAAC;IAED,eAAe;QACb,OAAO,IAAI,qCAAgB,EAAE,CAAC;IAChC,CAAC;IAED,oBAAoB;QAClB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,oBAAoB;QAClB,OAAO,+BAAiB,CAAC;IAC3B,CAAC;IAED,mBAAmB;QACjB,OAAO,8BAAgB,CAAC;IAC1B,CAAC;IAED,OAAO;QACL,OAAO;YACL,oCAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YACvC;gBACE,MAAM,EAAE,aAAa;gBACrB,SAAS,EAAE;oBACT;wBACE,OAAO,EAAE,sBAAe;wBACxB,QAAQ,EAAE,+CAAqB;qBAChC;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,aAA4B;QAC/B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,wBAAU,CAAC,CAAC;QAExE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IAC5B,CAAC;IAED,yBAAyB;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE1C,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE;gBAC7D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,GAAG,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC,CAAC;aACjE;SACF;QAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,IAAA,+BAAiB,EAAC,QAAQ,EAAE;YACjC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oCAAoC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAEO,kBAAkB;QACxB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,MAAM,IAAI,wBAAiB,CAAC,sCAAsC,CAAC,CAAC;SACrE;IACH,CAAC;IAED;;;OAGG;IACK,eAAe,CAAI,KAAQ;QACjC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;OAGG;IACK,iBAAiB;QACvB,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEpC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,cAAc,EAAE;YACrC,IAAI,IAAA,iCAAoB,EAAC,QAAQ,EAAE,GAAG,CAAC,EAAE;gBACvC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACpB;SACF;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAnID,sCAmIC"}

package/dist/grpc.utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 declare const isPackageNotIncluded: <T extends {
+    name: string;
+}>(packages: T[], pkg: T) => boolean;

package/dist/grpc.utils.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackageNotIncluded = void 0;
+/**
+ * Match packages name
+ * @param pkg
+ * @returns true if names is equal
+ */
+const isEqualPackageName = (pkg) => (x) => 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
+ */
+const isPackageNotIncluded = (packages, pkg) => !packages.some(isEqualPackageName(pkg));
+exports.isPackageNotIncluded = isPackageNotIncluded;
+//# sourceMappingURL=grpc.utils.js.map

package/dist/grpc.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grpc.utils.js","sourceRoot":"","sources":["../src/grpc.utils.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAM,kBAAkB,GACtB,CAA6B,GAAM,EAAE,EAAE,CACvC,CAAC,CAAI,EAAW,EAAE,CAChB,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC;AAExB;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,CAClC,QAAa,EACb,GAAM,EACG,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;AAHzC,QAAA,oBAAoB,wBAGqB"}

package/dist/reflection.module.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { Package } from '@rsdk/grpc.loader';
+export declare class ReflectionModule {
+    static forRoot(packages: Package[]): DynamicModule;
+}

package/dist/reflection.module.js

@@ -0,0 +1,33 @@
+"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 ReflectionModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReflectionModule = void 0;
+const common_1 = require("@nestjs/common");
+const controllers_1 = require("./controllers");
+const reflection_service_1 = require("./reflection.service");
+let ReflectionModule = ReflectionModule_1 = class ReflectionModule {
+    static forRoot(packages) {
+        return {
+            module: ReflectionModule_1,
+            controllers: [controllers_1.ReflectionV1alphaController, controllers_1.ReflectionV1Controller],
+            providers: [
+                reflection_service_1.ReflectionService,
+                {
+                    provide: 'GRPC_PACKAGES',
+                    useValue: packages,
+                },
+            ],
+        };
+    }
+};
+exports.ReflectionModule = ReflectionModule;
+exports.ReflectionModule = ReflectionModule = ReflectionModule_1 = __decorate([
+    (0, common_1.Module)({})
+], ReflectionModule);
+//# sourceMappingURL=reflection.module.js.map

package/dist/reflection.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reflection.module.js","sourceRoot":"","sources":["../src/reflection.module.ts"],"names":[],"mappings":";;;;;;;;;;AACA,2CAAwC;AAGxC,+CAGuB;AACvB,6DAAyD;AAGlD,IAAM,gBAAgB,wBAAtB,MAAM,gBAAgB;IAC3B,MAAM,CAAC,OAAO,CAAC,QAAmB;QAChC,OAAO;YACL,MAAM,EAAE,kBAAgB;YACxB,WAAW,EAAE,CAAC,yCAA2B,EAAE,oCAAsB,CAAC;YAClE,SAAS,EAAE;gBACT,sCAAiB;gBACjB;oBACE,OAAO,EAAE,eAAe;oBACxB,QAAQ,EAAE,QAAQ;iBACnB;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AAdY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,gBAAgB,CAc5B"}

package/dist/reflection.service.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="node" />
+import type { OnModuleInit } from '@nestjs/common';
+import type { Package } from '@rsdk/grpc.loader';
+export declare class ReflectionService implements OnModuleInit {
+    private readonly packages;
+    private readonly services;
+    private readonly files;
+    private readonly logger;
+    constructor(packages: Package[]);
+    onModuleInit(): void;
+    /**
+     * 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(): string[];
+    /**
+     * 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: string): Buffer;
+    /**
+     * Find a proto file by the file name
+     * @returns descriptors of the file which contains this symbol and its imports
+     */
+    fileByName(filename: string): Buffer;
+    /**
+     * 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: string, extensionNumber: number): Buffer;
+    allExtensionNumbersOfType(symbol: string): number[];
+    private findSymbol;
+}

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.1",
+  "version": "4.0.0-next.11",
   "description": "Grpc transport for platform, clients and common grpc stuff",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -15,17 +15,22 @@
   },
   "peerDependencies": {
     "@grpc/grpc-js": "^1.8.8",
-    "@nestjs/common": "^10.1.3",
-    "@nestjs/microservices": "^10.1.3",
-    "@rsdk/builtin-contract": "^3.5.0",
-    "@rsdk/common": "^3.5.0",
-    "@rsdk/core": "^4.0.0-next.1",
-    "@rsdk/grpc.common": "^4.0.0-next.1",
-    "@rsdk/grpc.loader": "^3.5.0",
-    "@rsdk/logging": "^4.0.0-next.1",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/microservices": "^10.0.0",
+    "@rsdk/builtin-contract": "^4.0.0-next.11",
+    "@rsdk/common": "^4.0.0-next.11",
+    "@rsdk/core": "^4.0.0-next.11",
+    "@rsdk/grpc.common": "^4.0.0-next.11",
+    "@rsdk/grpc.loader": "^4.0.0-next.11",
+    "@rsdk/logging": "^4.0.0-next.11",
     "nice-grpc": "^2.1.4",
-    "nice-grpc-opentelemetry": "^0.1.3",
-    "rxjs": "^7.0.0"
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.8.1"
   },
-  "gitHead": "d21a800ef5dd191b5effec59846c3a44a7ca3d1e"
+  "dependencies": {
+    "@bufbuild/protobuf": "^1.4.2",
+    "nice-grpc-opentelemetry": "^0.1.2"
+  },
+  "gitHead": "f1339ae22d78b41382b82a0feabacd49be19acd2"
 }

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);
+    };
+  }
+}