@koalarx/nest 1.10.1 → 1.11.0

package/core/health-check/health-check.controller.d.ts

@@ -0,0 +1,5 @@
+export declare class HealthCheckController {
+    healthCheck(): {
+        status: string;
+    };
+}

package/core/health-check/health-check.controller.js

@@ -0,0 +1,27 @@
+"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.HealthCheckController = void 0;
+const common_1 = require("@nestjs/common");
+let HealthCheckController = exports.HealthCheckController = class HealthCheckController {
+    healthCheck() {
+        return { status: 'ok' };
+    }
+};
+__decorate([
+    (0, common_1.Get)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], HealthCheckController.prototype, "healthCheck", null);
+exports.HealthCheckController = HealthCheckController = __decorate([
+    (0, common_1.Controller)('health')
+], HealthCheckController);

package/core/health-check/health-check.module.d.ts

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

package/core/health-check/health-check.module.js

@@ -0,0 +1,18 @@
+"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.HealthCheckModule = void 0;
+const common_1 = require("@nestjs/common");
+const health_check_controller_1 = require("./health-check.controller");
+let HealthCheckModule = exports.HealthCheckModule = class HealthCheckModule {
+};
+exports.HealthCheckModule = HealthCheckModule = __decorate([
+    (0, common_1.Module)({
+        controllers: [health_check_controller_1.HealthCheckController],
+    })
+], HealthCheckModule);

package/core/koala-app.js

@@ -234,6 +234,7 @@ class KoalaApp {
         if (this._apiReferenceEndpoint) {
             consola.info('API Reference:', `http://localhost:${port}${this._apiReferenceEndpoint}`);
         }
+        consola.info('Health Check:', `http://localhost:${port}/health`);
         consola.info('Internal Host:', `http://localhost:${port}`);
         if (this._ngrokUrl) {
             consola.info('External Host:', this._ngrokUrl);

package/core/koala-nest.module.d.ts

@@ -7,6 +7,7 @@ interface KoalaNestModuleConfig {
     logging?: Provider<ILoggingService>;
     env?: ZodType;
     controllers?: Type<any>[];
+    healthCheck?: Type<any>;
     cronJobs?: Type<CronJobHandlerBase>[];
     eventJobs?: Type<EventHandlerBase<any>>[];
 }

package/core/koala-nest.module.js

@@ -19,9 +19,11 @@ const iredis_service_1 = require("../services/redis/iredis.service");
 const redis_service_1 = require("../services/redis/redis.service");
 const ired_lock_service_1 = require("../services/redlock/ired-lock.service");
 const red_lock_service_1 = require("../services/redlock/red-lock.service");
+const health_check_module_1 = require("./health-check/health-check.module");
 let KoalaNestModule = exports.KoalaNestModule = KoalaNestModule_1 = class KoalaNestModule {
     static register(config) {
         const controllers = config?.controllers ?? [];
+        const healthCheck = config?.healthCheck ?? health_check_module_1.HealthCheckModule;
         const cronJobsProviders = config?.cronJobs ?? [];
         const eventJobsProviders = config?.eventJobs ?? [];
         const loggingServiceClass = config?.logging ?? logging_service_1.LoggingService;
@@ -33,6 +35,7 @@ let KoalaNestModule = exports.KoalaNestModule = KoalaNestModule_1 = class KoalaN
                     isGlobal: true,
                 }),
                 env_module_1.EnvModule,
+                healthCheck,
                 ...controllers,
             ],
             providers: [

package/filters/global-exception.filter.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GlobalExceptionsFilter = void 0;
 const common_1 = require("@nestjs/common");
 const core_1 = require("@nestjs/core");
+const node_http_1 = require("node:http");
 const koala_global_vars_1 = require("../core/koala-global-vars");
 const env_config_1 = require("../core/utils/env.config");
 const filter_request_params_1 = require("../core/utils/filter-request-params");
@@ -26,6 +27,7 @@ let GlobalExceptionsFilter = exports.GlobalExceptionsFilter = class GlobalExcept
     }
     catch(exception, host) {
         const filterRequestParams = filter_request_params_1.FilterRequestParams.get(host);
+        const request = host.getArgs().find((arg) => arg instanceof node_http_1.IncomingMessage) ?? null;
         const statusCode = exception instanceof common_1.HttpException
             ? exception.getStatus()
             : common_1.HttpStatus.INTERNAL_SERVER_ERROR;
@@ -39,6 +41,7 @@ let GlobalExceptionsFilter = exports.GlobalExceptionsFilter = class GlobalExcept
         this.httpAdapter.reply(filterRequestParams.response, responseBody, statusCode);
         if (!exception.message?.includes('Cannot GET /socket.io') &&
             !exception.message?.includes('Cannot GET /favicon.ico') &&
+            !['/'].includes(request?.url ?? '') &&
             statusCode !== common_1.HttpStatus.UNAUTHORIZED) {
             if (!env_config_1.EnvConfig.isEnvTest) {
                 this.loggingService

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koalarx/nest",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "description": "",
   "repository": {
     "type": "git",