@yolo-croket-dev/core 1.10.0-jun.0 → 1.10.0-jun.2

package/decorators/grpc-param.decorator.js

@@ -2,11 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GrpcParam = void 0;
 const common_1 = require("@nestjs/common");
+const grpc_param_metadata_function_1 = require("../functions/grpc-param-metadata.function");
 exports.GrpcParam = (0, common_1.createParamDecorator)((data, ctx) => {
     const metadata = ctx.switchToRpc().getContext();
-    const param = metadata.get('param');
-    if (!param || !param[0]) {
-        return null;
-    }
-    return JSON.parse(param[0]);
+    return (0, grpc_param_metadata_function_1.parseGrpcParamMetadata)(metadata);
 });

package/filters/grpc-exception.filter.js

@@ -39,6 +39,26 @@ const CroketExceptions = __importStar(require("@yolo-croket-dev/core/exceptions"
  */
 const getCroketExceptionClasses = () => Object.values(CroketExceptions).filter((value) => typeof value === 'function' && value.prototype && value.prototype.constructor === value);
 const croketExceptionClasses = getCroketExceptionClasses();
+const GRPC_DEBUG_ERROR_METADATA_KEY = 'debug-error';
+function isRecord(value) {
+    return !!value && typeof value === 'object' && !Array.isArray(value);
+}
+function getStringProperty(value, key) {
+    if (!isRecord(value)) {
+        return undefined;
+    }
+    const propertyValue = value[key];
+    return typeof propertyValue === 'string' ? propertyValue : undefined;
+}
+function buildDebugErrorMetadata(exception) {
+    var _a;
+    return {
+        type: ((_a = exception === null || exception === void 0 ? void 0 : exception.constructor) === null || _a === void 0 ? void 0 : _a.name) || 'Error',
+        name: getStringProperty(exception, 'name'),
+        message: getStringProperty(exception, 'message'),
+        kind: getStringProperty(exception, 'kind'),
+    };
+}
 let GrpcExceptionFilter = class GrpcExceptionFilter extends microservices_1.BaseRpcExceptionFilter {
     constructor() {
         super(...arguments);
@@ -88,6 +108,7 @@ let GrpcExceptionFilter = class GrpcExceptionFilter extends microservices_1.Base
         else {
             errorMessage = (exception === null || exception === void 0 ? void 0 : exception.message) || 'Internal Server Error';
             grpcStatus = grpc_js_1.status.INTERNAL;
+            metadata.set(GRPC_DEBUG_ERROR_METADATA_KEY, Buffer.from(JSON.stringify(buildDebugErrorMetadata(exception))).toString('base64'));
         }
         // BaseRpcExceptionFilter의 catch 메서드를 사용하여 metadata를 포함한 RpcException 생성
         const rpcException = new microservices_1.RpcException({
@@ -131,7 +152,7 @@ let GrpcExceptionFilter = class GrpcExceptionFilter extends microservices_1.Base
         }
     }
 };
-exports.GrpcExceptionFilter = GrpcExceptionFilter;
-exports.GrpcExceptionFilter = GrpcExceptionFilter = __decorate([
+GrpcExceptionFilter = __decorate([
     (0, common_1.Catch)()
 ], GrpcExceptionFilter);
+exports.GrpcExceptionFilter = GrpcExceptionFilter;

package/functions/grpc-param-metadata.function.d.ts

@@ -0,0 +1,22 @@
+import { Metadata } from '@grpc/grpc-js';
+import { AbstractParam } from '../interfaces';
+export declare const GRPC_PARAM_METADATA_KEY = "param";
+export declare type GrpcParamMetadata = AbstractParam;
+/**
+ * @author jun
+ * @description gRPC metadata에 AMQP param 호환 컨텍스트를 저장합니다.
+ * @process 1. AbstractParam 검증 -> 2. JSON 직렬화 -> 3. metadata param key에 저장
+ */
+export declare function setGrpcParamMetadata(metadata: Metadata, param: GrpcParamMetadata): void;
+/**
+ * @author jun
+ * @description gRPC metadata에서 AMQP param 호환 컨텍스트를 안전하게 읽습니다.
+ * @process 1. metadata param key 조회 -> 2. 문자열 검증 -> 3. JSON 파싱 실패 시 null 반환
+ */
+export declare function parseGrpcParamMetadata(metadata: Metadata): GrpcParamMetadata | null;
+/**
+ * @author jun
+ * @description gRPC metadata에서 필수 param 컨텍스트를 읽고 없거나 잘못되면 예외를 던집니다.
+ * @process 1. metadata param 파싱 -> 2. 유효성 확인 -> 3. 유효하지 않으면 BadRequest 발생
+ */
+export declare function assertGrpcParamMetadata(metadata: Metadata): GrpcParamMetadata;

package/functions/grpc-param-metadata.function.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertGrpcParamMetadata = exports.parseGrpcParamMetadata = exports.setGrpcParamMetadata = exports.GRPC_PARAM_METADATA_KEY = void 0;
+const bad_request_1 = require("../exceptions/bad-request");
+exports.GRPC_PARAM_METADATA_KEY = 'param';
+const OPTIONAL_STRING_KEYS = [
+    'userId',
+    'provider',
+    'clientId',
+    'requestIp',
+    'tossRequestId',
+    'from',
+];
+const OPTIONAL_BOOLEAN_KEYS = [
+    'isAdmin',
+    'isInternal',
+];
+const OPTIONAL_NUMBER_KEYS = [
+    'retryCount',
+    'timeout',
+];
+const OPTIONAL_OBJECT_KEYS = [
+    'device',
+    'externalTokenValue',
+    'requestLog',
+];
+/**
+ * @author jun
+ * @description gRPC param metadata 검증을 위한 record 타입 가드입니다.
+ * @process 1. object 여부 확인 -> 2. null/array 제외 -> 3. record로 좁힘
+ */
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function isValidOptionalStringArray(value) {
+    return value === undefined || (Array.isArray(value) && value.every(item => typeof item === 'string'));
+}
+function hasInvalidOptionalFields(param) {
+    const hasInvalidString = OPTIONAL_STRING_KEYS.some(key => param[key] !== undefined && typeof param[key] !== 'string');
+    if (hasInvalidString) {
+        return true;
+    }
+    const hasInvalidBoolean = OPTIONAL_BOOLEAN_KEYS.some(key => param[key] !== undefined && typeof param[key] !== 'boolean');
+    if (hasInvalidBoolean) {
+        return true;
+    }
+    const hasInvalidNumber = OPTIONAL_NUMBER_KEYS.some(key => (param[key] !== undefined
+        && (typeof param[key] !== 'number' || !Number.isFinite(param[key]))));
+    if (hasInvalidNumber) {
+        return true;
+    }
+    const hasInvalidObject = OPTIONAL_OBJECT_KEYS.some(key => param[key] !== undefined && !isRecord(param[key]));
+    if (hasInvalidObject) {
+        return true;
+    }
+    return !isValidOptionalStringArray(param.froms);
+}
+function toGrpcParamMetadata(value) {
+    if (!isRecord(value)) {
+        return null;
+    }
+    if (typeof value.traceId !== 'string' || value.traceId.length === 0) {
+        return null;
+    }
+    if (hasInvalidOptionalFields(value)) {
+        return null;
+    }
+    return value;
+}
+function getMetadataStringValue(metadata) {
+    const values = metadata.get(exports.GRPC_PARAM_METADATA_KEY);
+    const value = values[0];
+    if (!value) {
+        return null;
+    }
+    if (typeof value === 'string') {
+        return value;
+    }
+    return value.toString('utf8');
+}
+function createInvalidGrpcParamMetadataError() {
+    return new bad_request_1.BadRequest('INVALID_GRPC_PARAM_METADATA', 'gRPC param metadata가 올바르지 않습니다.');
+}
+/**
+ * @author jun
+ * @description gRPC metadata에 AMQP param 호환 컨텍스트를 저장합니다.
+ * @process 1. AbstractParam 검증 -> 2. JSON 직렬화 -> 3. metadata param key에 저장
+ */
+function setGrpcParamMetadata(metadata, param) {
+    const grpcParam = toGrpcParamMetadata(param);
+    if (!grpcParam) {
+        throw createInvalidGrpcParamMetadataError();
+    }
+    metadata.set(exports.GRPC_PARAM_METADATA_KEY, JSON.stringify(grpcParam));
+}
+exports.setGrpcParamMetadata = setGrpcParamMetadata;
+/**
+ * @author jun
+ * @description gRPC metadata에서 AMQP param 호환 컨텍스트를 안전하게 읽습니다.
+ * @process 1. metadata param key 조회 -> 2. 문자열 검증 -> 3. JSON 파싱 실패 시 null 반환
+ */
+function parseGrpcParamMetadata(metadata) {
+    const rawParam = getMetadataStringValue(metadata);
+    if (!rawParam) {
+        return null;
+    }
+    try {
+        return toGrpcParamMetadata(JSON.parse(rawParam));
+    }
+    catch (error) {
+        return null;
+    }
+}
+exports.parseGrpcParamMetadata = parseGrpcParamMetadata;
+/**
+ * @author jun
+ * @description gRPC metadata에서 필수 param 컨텍스트를 읽고 없거나 잘못되면 예외를 던집니다.
+ * @process 1. metadata param 파싱 -> 2. 유효성 확인 -> 3. 유효하지 않으면 BadRequest 발생
+ */
+function assertGrpcParamMetadata(metadata) {
+    const grpcParam = parseGrpcParamMetadata(metadata);
+    if (!grpcParam) {
+        throw createInvalidGrpcParamMetadataError();
+    }
+    return grpcParam;
+}
+exports.assertGrpcParamMetadata = assertGrpcParamMetadata;

package/functions/index.d.ts

@@ -3,6 +3,7 @@ export * from './generate-trace-id.function';
 export * from './amqp-publish.function';
 export * from './rewrite-file-value.function';
 export * from './amqp-call-manager.function';
+export * from './grpc-param-metadata.function';
 export * from './extract-redis-url.function';
 export * from './abort';
 export * from './uncaught-exception-handler';

package/functions/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./generate-trace-id.function"), exports);
 __exportStar(require("./amqp-publish.function"), exports);
 __exportStar(require("./rewrite-file-value.function"), exports);
 __exportStar(require("./amqp-call-manager.function"), exports);
+__exportStar(require("./grpc-param-metadata.function"), exports);
 __exportStar(require("./extract-redis-url.function"), exports);
 __exportStar(require("./abort"), exports);
 __exportStar(require("./uncaught-exception-handler"), exports);

package/interceptors/logging-service.interceptor.js

@@ -39,6 +39,7 @@ const common_1 = require("@nestjs/common");
 const msa_logger_1 = __importStar(require("@yolo-croket-dev/msa-logger"));
 const operators_1 = require("rxjs/operators");
 const dd_trace_1 = __importDefault(require("dd-trace"));
+const grpc_param_metadata_function_1 = require("../functions/grpc-param-metadata.function");
 const { SERVER_NAME } = process.env;
 const msaLogger = new msa_logger_1.default(msa_logger_1.ServerTypeEnum.SERVICE);
 const MAX_CUT_LENGTH = 500;
@@ -75,6 +76,7 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
         return data;
     }
     intercept(context, next) {
+        var _a;
         const now = Date.now();
         const args = context.getArgs();
         const rpcContext = context.switchToRpc();
@@ -87,13 +89,11 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
         let pattern; /** @xxx: Grpc: path , Mq: 메시지 패턴명 */
         let payload;
         if (isGrpc) {
-            const metadataParam = metadata.get('param')[0] || JSON.stringify({
-                param: {
-                    from: '-',
-                    froms: '-',
-                },
-            });
-            param = JSON.parse(metadataParam);
+            param = (_a = (0, grpc_param_metadata_function_1.parseGrpcParamMetadata)(metadata)) !== null && _a !== void 0 ? _a : {
+                traceId: '-',
+                from: '-',
+                froms: ['-'],
+            };
             originalMessage = args[0];
             const gRPCArg = args[2];
             pattern = gRPCArg.path;
@@ -116,11 +116,11 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
         const tmpFroms = JSON.parse(JSON.stringify(pastFroms));
         tmpFroms.push(tmpFrom);
         if (isGrpc) {
-            metadata.set('param', JSON.stringify({
+            (0, grpc_param_metadata_function_1.setGrpcParamMetadata)(metadata, {
                 ...pastParam,
                 from: tmpFrom,
                 froms: tmpFroms,
-            }));
+            });
         }
         else {
             data.param.from = tmpFrom;
@@ -219,7 +219,7 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
         }));
     }
 };
-exports.LoggingServiceInterceptor = LoggingServiceInterceptor;
-exports.LoggingServiceInterceptor = LoggingServiceInterceptor = __decorate([
+LoggingServiceInterceptor = __decorate([
     (0, common_1.Injectable)()
 ], LoggingServiceInterceptor);
+exports.LoggingServiceInterceptor = LoggingServiceInterceptor;

package/interceptors/rpc.interceptor.js

@@ -370,9 +370,9 @@ let RPCInterceptor = class RPCInterceptor {
         })));
     }
 };
-exports.RPCInterceptor = RPCInterceptor;
-exports.RPCInterceptor = RPCInterceptor = __decorate([
+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,10 +18,9 @@ var ErrActionTypeEnum;
     ErrActionTypeEnum["LEGACY_SHOW_TOAST"] = "LEGACY_SHOW_TOAST";
     ErrActionTypeEnum["FORCE_UPDATE"] = "FORCE_UPDATE";
     ErrActionTypeEnum["UPDATE_ACCESS_TOKEN"] = "UPDATE_ACCESS_TOKEN";
-})(ErrActionTypeEnum || (exports.ErrActionTypeEnum = ErrActionTypeEnum = {}));
+})(ErrActionTypeEnum = exports.ErrActionTypeEnum || (exports.ErrActionTypeEnum = {}));
 class ErrAction {
 }
-exports.ErrAction = ErrAction;
 __decorate([
     (0, swagger_1.ApiProperty)({
         description: '액션 타입',
@@ -58,9 +57,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: '에러 종류 식별자',
@@ -89,3 +88,4 @@ __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 = LogLevelEnum = {}));
+})(LogLevelEnum = exports.LogLevelEnum || (exports.LogLevelEnum = {}));

package/interfaces/msa-exception.d.ts

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

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

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

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

@@ -1,7 +1,7 @@
 import { RmqOptions, ServerRMQ } from '@nestjs/microservices';
 import { Channel } from 'amqp-connection-manager';
 import { ConsumeMessage } from 'amqplib';
-export type GracefulRmqOptions = RmqOptions['options'] & {
+export declare type GracefulRmqOptions = RmqOptions['options'] & {
     waitingEndingHandlersTimeoutMs?: number;
     waitingEndingHandlersIntervalMs?: number;
 };

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

@@ -133,7 +133,7 @@ let GracefulShutdownService = class GracefulShutdownService {
         });
     }
 };
-exports.GracefulShutdownService = GracefulShutdownService;
-exports.GracefulShutdownService = GracefulShutdownService = __decorate([
+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 {
 };
-exports.RedisModule = RedisModule;
-exports.RedisModule = RedisModule = __decorate([
+RedisModule = __decorate([
     (0, common_1.Module)({
         providers: [redisProvider],
         exports: [redisProvider],
     })
 ], RedisModule);
+exports.RedisModule = RedisModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yolo-croket-dev/core",
-  "version": "1.10.0-jun.0",
+  "version": "1.10.0-jun.2",
   "author": "Yolo Co., Ltd.",
   "description": "Yolo commonization module",
   "main": "index.js",

package/pipes/rpc-validation.pipe.js

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