@yolo-croket-dev/core 1.9.12 → 1.9.13-beta.1

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 1.9.13-beta.1
+
+- AMQP 요청의 `param.timeout`을 최대 29분 범위에서 적용해 timeout 시 클라이언트 Observable 구독을 해제합니다.
+
+## 1.9.12-beta.1
+
+- `GracefulServerRMQ`가 RabbitMQ 연결에 queue, environment, owner, hostname, process ID 기반 `connection_name`을 자동으로 추가합니다.
+- 호출자가 지정한 `connectionOptions`, `clientProperties`, 유효한 문자열 `connection_name`은 그대로 보존합니다.
+- 문자열이 아닌 `connection_name`은 런타임 오류 없이 자동 생성값으로 대체합니다.

package/filters/grpc-exception.filter.js

@@ -130,7 +130,7 @@ let GrpcExceptionFilter = class GrpcExceptionFilter extends microservices_1.Base
         }
     }
 };
-GrpcExceptionFilter = __decorate([
+exports.GrpcExceptionFilter = GrpcExceptionFilter;
+exports.GrpcExceptionFilter = GrpcExceptionFilter = __decorate([
     (0, common_1.Catch)()
 ], GrpcExceptionFilter);
-exports.GrpcExceptionFilter = GrpcExceptionFilter;

package/functions/amqp-handler.function.js

@@ -17,11 +17,18 @@ class HttpExceptionCustom extends common_1.HttpException {
     }
 }
 exports.HttpExceptionCustom = HttpExceptionCustom;
+function resolveAmqpTimeout(timeoutMs) {
+    if (typeof timeoutMs !== 'number' || !Number.isFinite(timeoutMs) || timeoutMs <= 0) {
+        return DEFAULT_TIMEOUT;
+    }
+    return Math.min(timeoutMs, DEFAULT_TIMEOUT);
+}
 async function AmqpHandler(client, messagePattern, payload) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     let data;
+    const timeoutMs = resolveAmqpTimeout((_a = payload === null || payload === void 0 ? void 0 : payload.param) === null || _a === void 0 ? void 0 : _a.timeout);
     try {
-        data = await (0, rxjs_1.lastValueFrom)(client.send(messagePattern, payload).pipe((0, operators_1.timeout)(DEFAULT_TIMEOUT)));
+        data = await (0, rxjs_1.lastValueFrom)(client.send(messagePattern, payload).pipe((0, operators_1.timeout)(timeoutMs)));
         if (data.isError) {
             const status = data.status || 500;
             const subMessage = data.subMessage;
@@ -29,7 +36,7 @@ async function AmqpHandler(client, messagePattern, payload) {
              * 파일 객체 처리
              * 다른 서비스에서 이미 처리가 될 수 있음
              * */
-            (0, _1.reWriteFileValue)((_a = data === null || data === void 0 ? void 0 : data.arg) === null || _a === void 0 ? void 0 : _a.file);
+            (0, _1.reWriteFileValue)((_b = data === null || data === void 0 ? void 0 : data.arg) === null || _b === void 0 ? void 0 : _b.file);
             const errInfo = data.errInfo ? data.errInfo : {
                 message: data.errMessage,
                 type: data.errType,
@@ -50,7 +57,7 @@ async function AmqpHandler(client, messagePattern, payload) {
     catch (err) {
         if (typeof err === 'string' && err.includes('There is no matching message handler defined in the remote service.')) {
             msaLogger.error('NOT_EXISTS_MESSAGE_PATTERN', {
-                traceId: ((_b = payload === null || payload === void 0 ? void 0 : payload.param) === null || _b === void 0 ? void 0 : _b.traceId) || '-',
+                traceId: ((_c = payload === null || payload === void 0 ? void 0 : payload.param) === null || _c === void 0 ? void 0 : _c.traceId) || '-',
                 errInfo: {
                     errType: 'NOT_EXISTS_MESSAGE_PATTERN',
                     message: `${messagePattern} 해당 메시지 패턴은 존재하지 않습니다.`,
@@ -64,7 +71,7 @@ async function AmqpHandler(client, messagePattern, payload) {
         }
         else if (err instanceof rxjs_1.TimeoutError || err.message === DEFAULT_TIMEOUT_MESSAGE) {
             msaLogger.error('TIMEOUT_ERROR', {
-                traceId: ((_c = payload === null || payload === void 0 ? void 0 : payload.param) === null || _c === void 0 ? void 0 : _c.traceId) || '-',
+                traceId: ((_d = payload === null || payload === void 0 ? void 0 : payload.param) === null || _d === void 0 ? void 0 : _d.traceId) || '-',
                 errInfo: {
                     errType: 'TIMEOUT_ERROR',
                     message: DEFAULT_TIMEOUT_MESSAGE,
@@ -77,7 +84,7 @@ async function AmqpHandler(client, messagePattern, payload) {
             });
         }
         else {
-            msaLogger.warn('AMQP_HANDLER_ERROR', { traceId: ((_d = payload === null || payload === void 0 ? void 0 : payload.param) === null || _d === void 0 ? void 0 : _d.traceId) || '-' }, { err });
+            msaLogger.warn('AMQP_HANDLER_ERROR', { traceId: ((_e = payload === null || payload === void 0 ? void 0 : payload.param) === null || _e === void 0 ? void 0 : _e.traceId) || '-' }, { err });
             throw err;
         }
     }

package/interceptors/logging-service.interceptor.js

@@ -219,7 +219,7 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
         }));
     }
 };
-LoggingServiceInterceptor = __decorate([
+exports.LoggingServiceInterceptor = LoggingServiceInterceptor;
+exports.LoggingServiceInterceptor = LoggingServiceInterceptor = __decorate([
     (0, common_1.Injectable)()
 ], LoggingServiceInterceptor);
-exports.LoggingServiceInterceptor = LoggingServiceInterceptor;

package/interceptors/rpc.interceptor.js

@@ -370,9 +370,9 @@ let RPCInterceptor = class RPCInterceptor {
         })));
     }
 };
-RPCInterceptor = __decorate([
+exports.RPCInterceptor = RPCInterceptor;
+exports.RPCInterceptor = RPCInterceptor = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [core_1.Reflector,
         graceful_shutdown_service_1.GracefulShutdownService])
 ], RPCInterceptor);
-exports.RPCInterceptor = RPCInterceptor;

package/interfaces/exception.js

@@ -18,9 +18,10 @@ var ErrActionTypeEnum;
     ErrActionTypeEnum["LEGACY_SHOW_TOAST"] = "LEGACY_SHOW_TOAST";
     ErrActionTypeEnum["FORCE_UPDATE"] = "FORCE_UPDATE";
     ErrActionTypeEnum["UPDATE_ACCESS_TOKEN"] = "UPDATE_ACCESS_TOKEN";
-})(ErrActionTypeEnum = exports.ErrActionTypeEnum || (exports.ErrActionTypeEnum = {}));
+})(ErrActionTypeEnum || (exports.ErrActionTypeEnum = ErrActionTypeEnum = {}));
 class ErrAction {
 }
+exports.ErrAction = ErrAction;
 __decorate([
     (0, swagger_1.ApiProperty)({
         description: '액션 타입',
@@ -57,9 +58,9 @@ __decorate([
     }),
     __metadata("design:type", String)
 ], ErrAction.prototype, "webViewUrl", void 0);
-exports.ErrAction = ErrAction;
 class ErrInfo {
 }
+exports.ErrInfo = ErrInfo;
 __decorate([
     (0, swagger_1.ApiProperty)({
         description: '에러 종류 식별자',
@@ -88,4 +89,3 @@ __decorate([
     }),
     __metadata("design:type", Object)
 ], ErrInfo.prototype, "errOption", void 0);
-exports.ErrInfo = ErrInfo;

package/interfaces/log-level.enum.js

@@ -21,4 +21,4 @@ var LogLevelEnum;
     LogLevelEnum["DEBUG"] = "debug";
     LogLevelEnum["WARN"] = "warn";
     LogLevelEnum["ERROR"] = "error";
-})(LogLevelEnum = exports.LogLevelEnum || (exports.LogLevelEnum = {}));
+})(LogLevelEnum || (exports.LogLevelEnum = LogLevelEnum = {}));

package/interfaces/msa-exception.d.ts

@@ -37,7 +37,7 @@ export interface MsaException {
     errOption?: MsaExceptionOption;
 }
 /** HttpException과 MsaException을 결합한 타입 */
-export declare type MsaHttpException = MsaException & HttpException;
+export type MsaHttpException = MsaException & HttpException;
 /**
  * @description MsaException 타입 가드
  * @param error 검사할 에러 객체

package/interfaces/msa-exception.js

@@ -6,7 +6,7 @@ var MsaExceptionMessageAckBehaviorEnum;
 (function (MsaExceptionMessageAckBehaviorEnum) {
     MsaExceptionMessageAckBehaviorEnum["ACK"] = "ACK";
     MsaExceptionMessageAckBehaviorEnum["NACK"] = "NACK";
-})(MsaExceptionMessageAckBehaviorEnum = exports.MsaExceptionMessageAckBehaviorEnum || (exports.MsaExceptionMessageAckBehaviorEnum = {}));
+})(MsaExceptionMessageAckBehaviorEnum || (exports.MsaExceptionMessageAckBehaviorEnum = MsaExceptionMessageAckBehaviorEnum = {}));
 /**
  * @description MsaException 타입 가드
  * @param error 검사할 에러 객체

package/modules/graceful-shutdown/graceful-shutdown.module.js

@@ -48,7 +48,8 @@ let GracefulShutdownModule = class GracefulShutdownModule {
         msaLogger.info('GracefulShutdownService.onModuleDestroy: all interceptors finished, shutting down', { traceId: 'ON_MODULE_DESTROY' });
     }
 };
-GracefulShutdownModule = __decorate([
+exports.GracefulShutdownModule = GracefulShutdownModule;
+exports.GracefulShutdownModule = GracefulShutdownModule = __decorate([
     (0, common_1.Global)(),
     (0, common_1.Module)({
         providers: [graceful_shutdown_service_1.GracefulShutdownService],
@@ -56,4 +57,3 @@ GracefulShutdownModule = __decorate([
     }),
     __metadata("design:paramtypes", [graceful_shutdown_service_1.GracefulShutdownService])
 ], GracefulShutdownModule);
-exports.GracefulShutdownModule = GracefulShutdownModule;

package/modules/graceful-shutdown/graceful-shutdown.rmq.d.ts

@@ -1,10 +1,16 @@
-import { RmqOptions, ServerRMQ } from '@nestjs/microservices';
-import { Channel } from 'amqp-connection-manager';
-import { ConsumeMessage } from 'amqplib';
-export declare type GracefulRmqOptions = RmqOptions['options'] & {
+import { ServerRMQ } from '@nestjs/microservices';
+import type { RmqOptions } from '@nestjs/microservices';
+import type { Channel } from 'amqp-connection-manager';
+import type { ConsumeMessage } from 'amqplib';
+export type GracefulRmqOptions = RmqOptions['options'] & {
     waitingEndingHandlersTimeoutMs?: number;
     waitingEndingHandlersIntervalMs?: number;
 };
+/**
+ * @author jun
+ * @description RabbitMQ 연결 식별 정보와 graceful shutdown을 제공하는 RMQ 서버
+ * @process 연결 옵션에 추적 가능한 connection_name을 추가한 뒤 메시지 종료를 보장한다.
+ */
 export declare class GracefulServerRMQ extends ServerRMQ {
     protected readonly options: GracefulRmqOptions;
     protected runningMessages: number;

package/modules/graceful-shutdown/graceful-shutdown.rmq.js

@@ -1,18 +1,67 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GracefulServerRMQ = void 0;
 const microservices_1 = require("@nestjs/microservices");
+const os_1 = __importDefault(require("os"));
 const node_util_1 = require("node:util");
 const sleep = (0, node_util_1.promisify)(setTimeout);
 const RMQ_DEFAULT_WAITING_ENDING_HANDLERS_TIMEOUT_MS = 5000;
 const RMQ_DEFAULT_WAITING_ENDING_HANDLERS_INTERVAL_MS = 500;
+const RMQ_UNKNOWN_CONNECTION_IDENTITY = 'unknown';
+function createRmqConnectionName(queue) {
+    const environment = process.env.ENV || process.env.NODE_ENV || RMQ_UNKNOWN_CONNECTION_IDENTITY;
+    const owner = process.env.RMQ_OWNER || process.env.USER || process.env.USERNAME || RMQ_UNKNOWN_CONNECTION_IDENTITY;
+    return [
+        queue || RMQ_UNKNOWN_CONNECTION_IDENTITY,
+        environment,
+        owner,
+        os_1.default.hostname(),
+        `pid-${process.pid}`,
+    ].join('/');
+}
+function addRmqConnectionName(options) {
+    var _a;
+    const connectionOptions = (_a = options.socketOptions) === null || _a === void 0 ? void 0 : _a.connectionOptions;
+    const configuredClientProperties = connectionOptions === null || connectionOptions === void 0 ? void 0 : connectionOptions.clientProperties;
+    const clientProperties = configuredClientProperties
+        && typeof configuredClientProperties === 'object'
+        && !Array.isArray(configuredClientProperties)
+        ? configuredClientProperties
+        : {};
+    const configuredConnectionName = clientProperties.connection_name;
+    const connectionName = typeof configuredConnectionName === 'string' && configuredConnectionName.trim()
+        ? configuredConnectionName
+        : createRmqConnectionName(options.queue);
+    return {
+        ...options,
+        socketOptions: {
+            ...options.socketOptions,
+            connectionOptions: {
+                ...connectionOptions,
+                clientProperties: {
+                    ...clientProperties,
+                    connection_name: connectionName,
+                },
+            },
+        },
+    };
+}
+/**
+ * @author jun
+ * @description RabbitMQ 연결 식별 정보와 graceful shutdown을 제공하는 RMQ 서버
+ * @process 연결 옵션에 추적 가능한 connection_name을 추가한 뒤 메시지 종료를 보장한다.
+ */
 class GracefulServerRMQ extends microservices_1.ServerRMQ {
     constructor(options) {
-        super(options);
-        this.options = options;
+        const optionsWithConnectionName = addRmqConnectionName(options);
+        super(optionsWithConnectionName);
         this.runningMessages = 0;
         this.closing = false;
         this.consumerTag = null;
+        this.options = optionsWithConnectionName;
         this.waitingEndingHandlersTimeoutMs = this.getOptionsProp(this.options, 'waitingEndingHandlersTimeoutMs')
             || RMQ_DEFAULT_WAITING_ENDING_HANDLERS_TIMEOUT_MS;
         this.waitingEndingHandlersIntervalMs = this.getOptionsProp(this.options, 'waitingEndingHandlersIntervalMs')

package/modules/graceful-shutdown/graceful-shutdown.service.js

@@ -133,7 +133,7 @@ let GracefulShutdownService = class GracefulShutdownService {
         });
     }
 };
-GracefulShutdownService = __decorate([
+exports.GracefulShutdownService = GracefulShutdownService;
+exports.GracefulShutdownService = GracefulShutdownService = __decorate([
     (0, common_1.Injectable)()
 ], GracefulShutdownService);
-exports.GracefulShutdownService = GracefulShutdownService;

package/modules/redis.module.js

@@ -15,10 +15,10 @@ const redisProvider = {
 };
 let RedisModule = class RedisModule {
 };
-RedisModule = __decorate([
+exports.RedisModule = RedisModule;
+exports.RedisModule = RedisModule = __decorate([
     (0, common_1.Module)({
         providers: [redisProvider],
         exports: [redisProvider],
     })
 ], RedisModule);
-exports.RedisModule = RedisModule;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@yolo-croket-dev/core",
-  "version": "1.9.12",
+  "version": "1.9.13-beta.1",
   "author": "Yolo Co., Ltd.",
   "description": "Yolo commonization module",
   "main": "index.js",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src/**/*.ts",
+    "test": "yarn build && node --test tests/*.test.cjs",
     "fix": "eslint --fix src/**/*.ts",
     "clean": "tsc --build --clean",
     "prepublishOnly": "npm run build",

package/pipes/rpc-validation.pipe.js

@@ -31,8 +31,8 @@ let ValidationPipe = class ValidationPipe {
         return value;
     }
 };
-ValidationPipe = __decorate([
+exports.ValidationPipe = ValidationPipe;
+exports.ValidationPipe = ValidationPipe = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [Object])
 ], ValidationPipe);
-exports.ValidationPipe = ValidationPipe;

package/tests/amqp-handler-timeout.test.cjs

@@ -0,0 +1,47 @@
+const assert = require('node:assert/strict');
+const test = require('node:test');
+const { Observable } = require('rxjs');
+
+const { AmqpHandler, HttpExceptionCustom } = require('../functions/amqp-handler.function.js');
+
+test('param.timeout이 지나면 AMQP Observable 구독을 해제한다', async () => {
+  let isUnsubscribed = false;
+  const client = {
+    send() {
+      return new Observable(() => () => {
+        isUnsubscribed = true;
+      });
+    },
+  };
+
+  await assert.rejects(
+    AmqpHandler(client, 'test.timeout', {
+      payload: {},
+      param: {
+        traceId: 'trace-id',
+        timeout: 5,
+      },
+    }),
+    (error) => {
+      assert.equal(error instanceof HttpExceptionCustom, true);
+      assert.equal(error.errInfo.type, 'TIMEOUT_ERROR');
+      return true;
+    },
+  );
+
+  assert.equal(isUnsubscribed, true);
+});
+
+test('응답이 먼저 완료되면 기존 AMQP 응답을 반환한다', async () => {
+  const client = {
+    send() {
+      return new Observable((subscriber) => {
+        subscriber.next({ isError: false, data: { ok: true } });
+        subscriber.complete();
+      });
+    },
+  };
+
+  const result = await AmqpHandler(client, 'test.success', { payload: {}, param: { traceId: 'trace-id', timeout: 50 } });
+  assert.deepEqual(result, { data: { ok: true } });
+});

package/tests/graceful-shutdown-rmq.test.cjs

@@ -0,0 +1,102 @@
+const assert = require('node:assert/strict');
+const os = require('node:os');
+const test = require('node:test');
+
+const {
+  GracefulServerRMQ,
+} = require('../modules/graceful-shutdown/graceful-shutdown.rmq.js');
+
+const CONNECTION_NAME_ENV_KEYS = [
+  'ENV',
+  'NODE_ENV',
+  'RMQ_OWNER',
+  'USER',
+  'USERNAME',
+];
+
+function getClientProperties(options) {
+  const server = new GracefulServerRMQ(options);
+  return server.options.socketOptions.connectionOptions.clientProperties;
+}
+
+function runWithEnvironment(environment, callback) {
+  const originalEnvironment = Object.fromEntries(
+    CONNECTION_NAME_ENV_KEYS.map((key) => [key, process.env[key]]),
+  );
+  try {
+    for (const key of CONNECTION_NAME_ENV_KEYS) {
+      delete process.env[key];
+    }
+    Object.assign(process.env, environment);
+    callback();
+  } finally {
+    for (const key of CONNECTION_NAME_ENV_KEYS) {
+      const originalValue = originalEnvironment[key];
+      if (originalValue === undefined) {
+        delete process.env[key];
+      } else {
+        process.env[key] = originalValue;
+      }
+    }
+  }
+}
+
+test('자동 connection_name에 큐와 실행 주체 정보를 포함한다', () => {
+  runWithEnvironment({ ENV: 'release', RMQ_OWNER: 'jun' }, () => {
+    const actualClientProperties = getClientProperties({ queue: 'STORE_ITEM_SERVER' });
+    const expectedConnectionName = `STORE_ITEM_SERVER/release/jun/${os.hostname()}/pid-${process.pid}`;
+    assert.equal(actualClientProperties.connection_name, expectedConnectionName);
+  });
+});
+
+test('기존 connectionOptions와 clientProperties를 보존한다', () => {
+  runWithEnvironment({ NODE_ENV: 'production', USER: 'deploy' }, () => {
+    const inputOptions = {
+      queue: 'USER_SERVICE',
+      socketOptions: {
+        noDelay: true,
+        connectionOptions: {
+          locale: 'ko_KR',
+          clientProperties: {
+            product: 'croket',
+          },
+        },
+      },
+    };
+    const server = new GracefulServerRMQ(inputOptions);
+    assert.equal(server.options.socketOptions.noDelay, true);
+    assert.equal(server.options.socketOptions.connectionOptions.locale, 'ko_KR');
+    assert.equal(server.options.socketOptions.connectionOptions.clientProperties.product, 'croket');
+  });
+});
+
+test('명시적으로 설정한 문자열 connection_name을 보존한다', () => {
+  const actualClientProperties = getClientProperties({
+    queue: 'USER_SERVICE',
+    socketOptions: {
+      connectionOptions: {
+        clientProperties: {
+          connection_name: 'custom-connection-name',
+        },
+      },
+    },
+  });
+  assert.equal(actualClientProperties.connection_name, 'custom-connection-name');
+});
+
+test('문자열이 아닌 connection_name은 자동 생성값으로 대체한다', () => {
+  runWithEnvironment({ ENV: 'release', RMQ_OWNER: 'jun' }, () => {
+    const actualClientProperties = getClientProperties({
+      queue: 'STORE_ITEM_SERVER',
+      socketOptions: {
+        connectionOptions: {
+          clientProperties: {
+            connection_name: 123,
+          },
+        },
+      },
+    });
+    const expectedConnectionName = `STORE_ITEM_SERVER/release/jun/${os.hostname()}/pid-${process.pid}`;
+    assert.equal(actualClientProperties.connection_name, expectedConnectionName);
+  });
+});