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

package/AGENTS.md

@@ -0,0 +1,52 @@
+# CORE KNOWLEDGE BASE
+
+## OVERVIEW
+
+요청 context, 예외, interceptor, AMQP helper, Redis provider, graceful shutdown을 노출하는 최고 영향도 공용 패키지다. `AbstractParam`은 Codegraph 기준 1,313개 reference를 가진다.
+
+## STRUCTURE
+
+```text
+core/
+├── index.ts
+├── interfaces/       # AbstractParam/Request/Response, exceptions
+├── exceptions/       # 공용 HTTP/MSA error contract
+├── functions/        # AMQP call/publish/handler, trace/error helper
+├── interceptors/     # request/RPC logging and active-call tracking
+├── modules/          # Redis, graceful shutdown
+└── tests/            # node:test CJS integration-style tests
+```
+
+## WHERE TO LOOK
+
+| 작업 | 위치 | 확인 |
+|---|---|---|
+| Trace/request shape | `interfaces/http.ts` | 모든 서비스 metadata 호환성 |
+| Error contract | `interfaces/msa-exception.ts`, `exceptions` | AMQP ACK/NACK와 consumer 변환 |
+| AMQP behavior | `functions/amqp-*` | timeout, publish/call error handling |
+| Shutdown | `modules/graceful-shutdown` | active interceptor drain, health file |
+| Redis injection | `modules/redis.module.ts` | `REDIS_PROVIDER` contract |
+
+## CONVENTIONS
+
+- Public shape 변경 전 package 내부뿐 아니라 `amqp-access`, `amqp-rabbit-mq`, `grpc`, 실제 서비스 import를 검색한다.
+- `AbstractParam.traceId`를 호출 경계에서 보존한다. 새 context 필드는 직렬화와 metadata 전달 경로를 함께 확인한다.
+- Exception은 status/type/message/action/errInfo 변환을 기존 handler와 일치시킨다.
+- Graceful shutdown은 active request/RPC drain과 `/tmp/healthy` lifecycle을 함께 유지한다.
+- Public export는 leaf barrel, category barrel, root `index.ts`를 모두 확인한다.
+
+## ANTI-PATTERNS
+
+- 한 소비자 전용 shape나 비즈니스 판단을 core에 올리지 않는다.
+- Trace/error field를 silent fallback으로 숨기거나 하위 호환 근거 없이 rename하지 않는다.
+- AMQP timeout/ACK behavior를 실제 caller/handler 검증 없이 변경하지 않는다.
+- Generated JS/d.ts를 source로 취급하지 않는다.
+
+## VERIFY
+
+```bash
+yarn workspace @yolo-croket-dev/core test
+yarn workspace @yolo-croket-dev/core lint
+```
+
+`test`가 먼저 build한 뒤 `tests/*.test.cjs`를 실행한다. 현재 lint glob은 `src/**/*.ts`지만 source는 package root에 있어 lint 결과가 변경 파일을 실제 포함하는지 별도로 확인한다.

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 1.10.0-jun.2-beta.1
+
+- 현재 소비 버전 1.10.0-jun.2의 gRPC metadata 및 예외 처리 동작을 유지합니다.
+- 비회원 인증 요청 로그의 민감 값을 마스킹하고 검증 오류에서 입력값을 제외합니다.
+- 인증 실패의 남은 입력 횟수와 재시도 대기시간 필드를 추가합니다.

package/functions/redact-auth-data.function.d.ts

@@ -0,0 +1,2 @@
+/** @author jun @description 인증 정보 로그 마스킹 @process 원본을 변경하지 않고 중첩 객체의 민감 값을 가린다. */
+export declare function redactAuthData(value: unknown, seen?: WeakSet<object>): unknown;

package/functions/redact-auth-data.function.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redactAuthData = void 0;
+const SENSITIVE_KEY = /password|secret|token|authorization|cookie|phone|verificationcode|verificationid|api.?key/i;
+/** @author jun @description 인증 정보 로그 마스킹 @process 원본을 변경하지 않고 중첩 객체의 민감 값을 가린다. */
+function redactAuthData(value, seen = new WeakSet()) {
+    if (!value || typeof value !== 'object')
+        return value;
+    if (seen.has(value))
+        return '[Circular]';
+    seen.add(value);
+    if (Array.isArray(value))
+        return value.map(item => redactAuthData(item, seen));
+    return Object.fromEntries(Object.entries(value).map(([key, item,]) => [
+        key,
+        SENSITIVE_KEY.test(key) ? '***MASKED***' : redactAuthData(item, seen),
+    ]));
+}
+exports.redactAuthData = redactAuthData;

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 redact_auth_data_function_1 = require("../functions/redact-auth-data.function");
 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);
@@ -130,9 +131,9 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
             traceId,
             messageBrokerInfo: {
                 messagePatten: pattern,
-                payload: JSON.stringify(this.keyCutter(JSON.stringify(payload))),
+                payload: JSON.stringify(this.keyCutter(JSON.stringify((0, redact_auth_data_function_1.redactAuthData)(payload)))),
             },
-            paramInfo: pastParam,
+            paramInfo: (0, redact_auth_data_function_1.redactAuthData)(pastParam),
             traceInfo: {
                 from: pastFrom,
                 froms: pastFroms,
@@ -159,7 +160,7 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
                 },
                 messageBrokerInfo: {
                     messagePatten: pattern,
-                    payload: JSON.stringify(this.keyCutter(JSON.stringify(payload))),
+                    payload: JSON.stringify(this.keyCutter(JSON.stringify((0, redact_auth_data_function_1.redactAuthData)(payload)))),
                 },
                 traceInfo: {
                     from: pastFrom,
@@ -189,7 +190,7 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
                 },
                 messageBrokerInfo: {
                     messagePatten: pattern,
-                    payload: JSON.stringify(this.keyCutter(JSON.stringify(payload))),
+                    payload: JSON.stringify(this.keyCutter(JSON.stringify((0, redact_auth_data_function_1.redactAuthData)(payload)))),
                 },
                 traceInfo: {
                     from: pastFrom,
@@ -205,7 +206,7 @@ let LoggingServiceInterceptor = class LoggingServiceInterceptor {
                 },
                 messageBrokerInfo: {
                     messagePatten: pattern,
-                    payload: JSON.stringify(this.keyCutter(JSON.stringify(payload))),
+                    payload: JSON.stringify(this.keyCutter(JSON.stringify((0, redact_auth_data_function_1.redactAuthData)(payload)))),
                 },
                 traceInfo: {
                     from: pastFrom,

package/interfaces/exception.d.ts

@@ -18,4 +18,6 @@ export declare class ErrInfo {
     message?: string;
     action?: ErrAction;
     errOption?: MsaExceptionOption;
+    remainingAttempts?: number;
+    retryAfterSeconds?: number;
 }

package/interfaces/exception.js

@@ -88,4 +88,18 @@ __decorate([
     }),
     __metadata("design:type", Object)
 ], ErrInfo.prototype, "errOption", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: '인증 코드의 남은 입력 횟수',
+        required: false,
+    }),
+    __metadata("design:type", Number)
+], ErrInfo.prototype, "remainingAttempts", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: '다음 요청까지 기다릴 초',
+        required: false,
+    }),
+    __metadata("design:type", Number)
+], ErrInfo.prototype, "retryAfterSeconds", void 0);
 exports.ErrInfo = ErrInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yolo-croket-dev/core",
-  "version": "1.10.0-jun.2",
+  "version": "1.10.0-jun.2-beta.1",
   "author": "Yolo Co., Ltd.",
   "description": "Yolo commonization module",
   "main": "index.js",
@@ -10,14 +10,15 @@
     "fix": "eslint --fix src/**/*.ts",
     "clean": "tsc --build --clean",
     "prepublishOnly": "npm run build",
-    "postpublish": "npm run clean"
+    "postpublish": "npm run clean",
+    "test": "yarn build && node --test tests/*.test.cjs"
   },
   "license": "UNLICENSED",
   "peerDependencies": {
+    "@grpc/grpc-js": "^1.14.3",
     "@nestjs/common": "^11.0.0",
     "@nestjs/microservices": "^11.0.0",
     "@nestjs/swagger": "^11.0.0",
-    "@grpc/grpc-js": "^1.14.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "dd-trace": "^5.0.0"
@@ -32,10 +33,11 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
+    "@grpc/grpc-js": "^1.14.3",
     "@nestjs/common": "^11.1.8",
-    "@nestjs/microservices": "^11.1.8",
+    "@nestjs/core": "^11.1.8",
+    "@nestjs/microservices": "11.0.13",
     "@nestjs/swagger": "^11.2.1",
-    "@grpc/grpc-js": "^1.14.3",
     "@types/node": "^24.9.1",
     "@types/randomstring": "^1.1.8",
     "@types/uuid": "^8.3.4"

package/pipes/rpc-validation.pipe.js

@@ -24,7 +24,12 @@ let ValidationPipe = class ValidationPipe {
             return value;
         }
         const object = (0, class_transformer_1.plainToInstance)(this.dto, value.payload);
-        const errors = await (0, class_validator_1.validate)(object);
+        const errors = await (0, class_validator_1.validate)(object, {
+            validationError: {
+                target: false,
+                value: false,
+            },
+        });
         if (errors.length > 0) {
             throw new exceptions_1.BadRequest('VALIDATION_ERROR', JSON.stringify(errors));
         }

package/tests/redact-auth-data.test.cjs

@@ -0,0 +1,17 @@
+const { test } = require('node:test');
+const assert = require('node:assert/strict');
+const { redactAuthData } = require('../functions/redact-auth-data.function');
+
+test('인증 요청·응답과 중첩 메타데이터를 원본 변경 없이 마스킹한다', () => {
+  const input = { payload: { verificationCode: '123456', phoneNumber: '01012345678', recaptchaToken: 'captcha' },
+    result: [{ access_token: 'jwt', refresh_token: 'refresh' }], param: { authorization: 'Bearer jwt', traceId: 'trace' } };
+  const output = redactAuthData(input);
+  assert.equal(output.payload.verificationCode, '***MASKED***');
+  assert.equal(output.payload.phoneNumber, '***MASKED***');
+  assert.equal(output.payload.recaptchaToken, '***MASKED***');
+  assert.equal(output.result[0].access_token, '***MASKED***');
+  assert.equal(output.result[0].refresh_token, '***MASKED***');
+  assert.equal(output.param.authorization, '***MASKED***');
+  assert.equal(output.param.traceId, 'trace');
+  assert.equal(input.payload.verificationCode, '123456');
+});

package/tests/rpc-validation-secrets.test.cjs

@@ -0,0 +1,17 @@
+const { test } = require('node:test');
+const assert = require('node:assert/strict');
+const { IsString } = require('class-validator');
+const { ValidationPipe } = require('../pipes/rpc-validation.pipe');
+
+test('검증 실패 예외는 다른 필드의 OTP·CAPTCHA와 target/value를 포함하지 않는다', async () => {
+  class Payload {}
+  IsString()(Payload.prototype, 'verificationId');
+  const pipe = new ValidationPipe(Payload);
+  await assert.rejects(pipe.transform({ payload: { verificationId: 123, verificationCode: '123456', recaptchaToken: 'captcha-secret' } }, { metatype: Object }), e => {
+    assert.ok(!e.subMessage.includes('123456'));
+    assert.ok(!e.subMessage.includes('captcha-secret'));
+    assert.ok(!e.subMessage.includes('target'));
+    assert.ok(!e.subMessage.includes('value'));
+    return true;
+  });
+});

package/functions/abort/enhanced-promise-patch.d.ts

@@ -1,17 +0,0 @@
-declare global {
-    var Promise: PromiseConstructor;
-}
-export declare class EnhancedPromisePatch {
-    private static isPatched;
-    private static originalPromise;
-    private static originalSetTimeout;
-    static patch(): void;
-    private static patchPromise;
-    private static patchSetTimeout;
-    static unpatch(): void;
-    /**
-     * 현재 패치 상태 확인
-     * @returns 패치 여부
-     */
-    static getPatchStatus(): boolean;
-}

package/functions/abort/enhanced-promise-patch.js

@@ -1,115 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnhancedPromisePatch = void 0;
-const abort_1 = require("./abort");
-class EnhancedPromisePatch {
-    static patch() {
-        if (this.isPatched) {
-            return;
-        }
-        this.patchPromise();
-        this.patchSetTimeout();
-        this.isPatched = true;
-    }
-    static patchPromise() {
-        this.originalPromise = global.Promise;
-        // Promise 생성자 패치
-        global.Promise = new Proxy(global.Promise, {
-            construct(target, args) {
-                const abortSignal = (0, abort_1.getCurrentAbortSignal)();
-                if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
-                    return Promise.reject(new Error('REQUEST_ABORTED: Promise가 중단되었습니다'));
-                }
-                // target은 Promise 생성자이므로, new 연산자와 함께 사용해야 하며, args는 [executor] 형태의 튜플임을 명시합니다.
-                const promise = Reflect.construct(target, args);
-                if (!abortSignal) {
-                    return promise;
-                }
-                // Promise 체인에 중단 확인 추가
-                return promise.then((result) => {
-                    if (abortSignal.aborted) {
-                        throw new Error('REQUEST_ABORTED: Promise 실행 중 중단되었습니다');
-                    }
-                    return result;
-                }, (error) => {
-                    if (abortSignal.aborted) {
-                        throw new Error('REQUEST_ABORTED: Promise 실행 중 중단되었습니다');
-                    }
-                    throw error;
-                });
-            },
-        });
-        // Promise.resolve 패치
-        const originalResolve = global.Promise.resolve;
-        global.Promise.resolve = (value) => {
-            const abortSignal = (0, abort_1.getCurrentAbortSignal)();
-            if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
-                return Promise.reject(new Error('REQUEST_ABORTED: Promise.resolve가 중단되었습니다'));
-            }
-            const promise = originalResolve.call(global.Promise, value);
-            if (!abortSignal) {
-                return promise;
-            }
-            return promise.then((result) => {
-                if (abortSignal.aborted) {
-                    throw new Error('REQUEST_ABORTED: Promise.resolve 실행 중 중단되었습니다');
-                }
-                return result;
-            }, (error) => {
-                if (abortSignal.aborted) {
-                    throw new Error('REQUEST_ABORTED: Promise.resolve 실행 중 중단되었습니다');
-                }
-                throw error;
-            });
-        };
-        // Promise.reject 패치
-        const originalReject = global.Promise.reject;
-        global.Promise.reject = (reason) => {
-            const abortSignal = (0, abort_1.getCurrentAbortSignal)();
-            if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
-                return Promise.reject(new Error('REQUEST_ABORTED: Promise.reject가 중단되었습니다'));
-            }
-            return originalReject.call(global.Promise, reason);
-        };
-    }
-    static patchSetTimeout() {
-        this.originalSetTimeout = global.setTimeout;
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        global.setTimeout = (callback, delay, ...args) => {
-            const abortSignal = (0, abort_1.getCurrentAbortSignal)();
-            if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
-                throw new Error('REQUEST_ABORTED: setTimeout이 중단되었습니다');
-            }
-            const timerId = this.originalSetTimeout(() => {
-                if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
-                    throw new Error('REQUEST_ABORTED: setTimeout 콜백이 중단되었습니다');
-                }
-                callback(...args);
-            }, delay);
-            if (abortSignal) {
-                const abortHandler = () => {
-                    clearTimeout(timerId);
-                };
-                abortSignal.addEventListener('abort', abortHandler, { once: true });
-            }
-            return timerId;
-        };
-    }
-    static unpatch() {
-        if (!this.isPatched) {
-            return;
-        }
-        global.Promise = this.originalPromise;
-        global.setTimeout = this.originalSetTimeout;
-        this.isPatched = false;
-    }
-    /**
-     * 현재 패치 상태 확인
-     * @returns 패치 여부
-     */
-    static getPatchStatus() {
-        return this.isPatched;
-    }
-}
-exports.EnhancedPromisePatch = EnhancedPromisePatch;
-EnhancedPromisePatch.isPatched = false;