@hz-9/a5-core 0.2.0-alpha.1

package/dist/test/integration/core/with-logger-module.integration.spec.js

@@ -0,0 +1,401 @@
+"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 TestService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@nestjs/common");
+const supertest_1 = __importDefault(require("supertest"));
+const a5_console_logger_1 = require("../../../core/a5-console-logger");
+const a5_factory_1 = require("../../../core/a5-factory");
+const a5_console_logger_middleware_1 = require("../../../middleware/a5-console-logger.middleware");
+const index_1 = require("../../../module/log/index");
+const color_util_1 = require("../../../util/color.util");
+let TestController = class TestController {
+    get() {
+        return 'this is a get request';
+    }
+    post() {
+        return 'this is a post request';
+    }
+    put() {
+        return 'this is a put request';
+    }
+    patch() {
+        return 'this is a patch request';
+    }
+    delete() {
+        return 'this is a delete request';
+    }
+    all(req) {
+        return `this is a ${req.method.toLowerCase()} request to all route`;
+    }
+    uploadFile(body) {
+        return 'file uploaded successfully';
+    }
+};
+__decorate([
+    (0, common_1.Get)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", String)
+], TestController.prototype, "get", null);
+__decorate([
+    (0, common_1.Post)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", String)
+], TestController.prototype, "post", null);
+__decorate([
+    (0, common_1.Put)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", String)
+], TestController.prototype, "put", null);
+__decorate([
+    (0, common_1.Patch)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", String)
+], TestController.prototype, "patch", null);
+__decorate([
+    (0, common_1.Delete)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", String)
+], TestController.prototype, "delete", null);
+__decorate([
+    (0, common_1.All)('all'),
+    __param(0, (0, common_1.Req)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", String)
+], TestController.prototype, "all", null);
+__decorate([
+    (0, common_1.Put)('upload'),
+    __param(0, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", String)
+], TestController.prototype, "uploadFile", null);
+TestController = __decorate([
+    (0, common_1.Controller)()
+], TestController);
+let TestService = TestService_1 = class TestService {
+    constructor() {
+        this.logger = new common_1.Logger(TestService_1.name);
+    }
+    testLog() {
+        this.logger.log('Test log message');
+    }
+    testError() {
+        this.logger.error('Test error message');
+    }
+    testErrorWithStack() {
+        const error = new Error();
+        this.logger.error('Test error message', error.stack);
+    }
+    testWarn() {
+        this.logger.warn('Test warn message');
+    }
+    testDebug() {
+        this.logger.debug('Test debug message');
+    }
+    testVerbose() {
+        this.logger.verbose('Test verbose message');
+    }
+    testFatal() {
+        this.logger.fatal('Test fatal message');
+    }
+};
+TestService = TestService_1 = __decorate([
+    (0, common_1.Injectable)()
+], TestService);
+describe('Default for A5ConsoleLogger', () => {
+    const toClearLines = (lines) => lines.map(([text]) => color_util_1.ColorUtil.clear(text.trim()));
+    const originalEnv = process.env;
+    // eslint-disable-next-line init-declarations
+    let processStdoutWriteSpy;
+    // eslint-disable-next-line init-declarations
+    let processStderrWriteSpy;
+    beforeEach(async () => {
+        jest.resetModules();
+        process.env = { ...originalEnv };
+        processStdoutWriteSpy = jest.spyOn(process.stdout, 'write').mockImplementation();
+        processStderrWriteSpy = jest.spyOn(process.stderr, 'write').mockImplementation();
+        jest.clearAllMocks();
+    });
+    afterEach(async () => {
+        process.env = originalEnv;
+        processStdoutWriteSpy.mockRestore();
+        processStderrWriteSpy.mockRestore();
+        jest.restoreAllMocks();
+    });
+    describe('[[Module]]', () => {
+        it('default', async () => {
+            let AppModule = class AppModule {
+            };
+            AppModule = __decorate([
+                (0, common_1.Module)({})
+            ], AppModule);
+            // Create application using A5Factory
+            const app = await a5_factory_1.A5Factory.create(AppModule, { printLogo: false });
+            await app.close();
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines.length).toBe(4);
+            const [line0, line1, line2, line3] = lines;
+            expect(line0.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}    WARN \[A5Application \] Not loaded A5 Logger Provider, using 'A5ConsoleLogger'$/);
+            expect(line1.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Factory     \] Starting A5 application...$/);
+            expect(line2.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[InstanceLoader\] AppModule dependencies initialized$/);
+            expect(line3.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Application \] A5 application successfully started$/);
+        });
+        it('no content', async () => {
+            let AppModule = class AppModule {
+            };
+            AppModule = __decorate([
+                (0, common_1.Module)({
+                    providers: [
+                        {
+                            provide: index_1.GLOBAL_PROVIDE_TOKEN_A5_LOG_LOGGER,
+                            useValue: new a5_console_logger_1.A5ConsoleLogger(),
+                        },
+                    ],
+                })
+            ], AppModule);
+            // Create application using A5Factory
+            const app = await a5_factory_1.A5Factory.create(AppModule, { printLogo: false });
+            await app.close();
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines.length).toBe(5);
+            const [line0, line1, line2, line3, line4] = lines;
+            expect(line0.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Application \] Loaded A5 Logger Provider, using 'A5ConsoleLogger'$/);
+            expect(line1.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}   DEBUG \[A5Application \] 'A5ConsoleLogger' context is empty, automatically filled with 'A5Application' as default context$/);
+            expect(line2.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Factory     \] Starting A5 application...$/);
+            expect(line3.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[InstanceLoader\] AppModule dependencies initialized$/);
+            expect(line4.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Application \] A5 application successfully started$/);
+        });
+        it('has context', async () => {
+            let AppModule = class AppModule {
+            };
+            AppModule = __decorate([
+                (0, common_1.Module)({
+                    providers: [
+                        {
+                            provide: index_1.GLOBAL_PROVIDE_TOKEN_A5_LOG_LOGGER,
+                            useValue: new a5_console_logger_1.A5ConsoleLogger({
+                                context: 'Custom',
+                            }),
+                        },
+                    ],
+                })
+            ], AppModule);
+            const app = await a5_factory_1.A5Factory.create(AppModule, {
+                printLogo: false,
+            });
+            expect(app.options.logger).toBeInstanceOf(a5_console_logger_1.A5ConsoleLogger);
+            await app.close();
+            // 验证完整的日志输出格式（移除 ANSI 颜色代码后验证）
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines.length).toBe(4);
+            const [line0, line1, line2, line3] = lines;
+            expect(line0.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[Custom        \] Loaded A5 Logger Provider, using 'A5ConsoleLogger'$/);
+            expect(line1.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Factory     \] Starting A5 application...$/);
+            expect(line2.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[InstanceLoader\] AppModule dependencies initialized$/);
+            expect(line3.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Application \] A5 application successfully started$/);
+        });
+        it('has context and timestamp', async () => {
+            let AppModule = class AppModule {
+            };
+            AppModule = __decorate([
+                (0, common_1.Module)({
+                    providers: [
+                        {
+                            provide: index_1.GLOBAL_PROVIDE_TOKEN_A5_LOG_LOGGER,
+                            useValue: new a5_console_logger_1.A5ConsoleLogger({
+                                context: 'Custom',
+                                timestamp: true,
+                            }),
+                        },
+                    ],
+                })
+            ], AppModule);
+            const app = await a5_factory_1.A5Factory.create(AppModule, {
+                printLogo: false,
+            });
+            expect(app.options.logger).toBeInstanceOf(a5_console_logger_1.A5ConsoleLogger);
+            await app.close();
+            // 验证完整的日志输出格式（移除 ANSI 颜色代码后验证）
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines.length).toBe(4);
+            const [line0, line1, line2, line3] = lines;
+            expect(line0.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[Custom        \] Loaded A5 Logger Provider, using 'A5ConsoleLogger' \+\d+ms$/);
+            expect(line1.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Factory     \] Starting A5 application... \+\d+ms$/);
+            expect(line2.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[InstanceLoader\] AppModule dependencies initialized \+\d+ms$/);
+            expect(line3.trim()).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[A5Application \] A5 application successfully started \+\d+ms$/);
+        });
+    });
+    describe('[[Logger]]', () => {
+        // eslint-disable-next-line init-declarations
+        let app;
+        // eslint-disable-next-line init-declarations
+        let testService;
+        beforeEach(async () => {
+            let AppModule = class AppModule {
+            };
+            AppModule = __decorate([
+                (0, common_1.Module)({
+                    providers: [TestService],
+                })
+            ], AppModule);
+            app = await a5_factory_1.A5Factory.create(AppModule, {
+                printLogo: false,
+            });
+            testService = app.nestApp.get(TestService);
+        });
+        afterEach(async () => {
+            await app.close();
+        });
+        it('log message', async () => {
+            testService.testLog();
+            expect(processStdoutWriteSpy).toHaveBeenCalled();
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[TestService   \] Test log message$/);
+        });
+        it('error message', async () => {
+            testService.testError();
+            expect(processStderrWriteSpy).toHaveBeenCalled();
+            const lines = toClearLines(processStderrWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}   ERROR \[TestService   \] Test error message$/);
+        });
+        it('error message with stack', async () => {
+            testService.testErrorWithStack();
+            expect(processStderrWriteSpy).toHaveBeenCalled();
+            const lines = toClearLines(processStderrWriteSpy.mock.calls);
+            expect(lines[lines.length - 2]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}   ERROR \[TestService   \] Test error message$/);
+            expect(lines[lines.length - 1]).toMatch(/at TestService.testErrorWithStack \(/);
+        });
+        it('warn message', async () => {
+            testService.testWarn();
+            expect(processStdoutWriteSpy).toHaveBeenCalled();
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}    WARN \[TestService   \] Test warn message$/);
+        });
+        it('debug message', async () => {
+            testService.testDebug();
+            expect(processStdoutWriteSpy).toHaveBeenCalled();
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}   DEBUG \[TestService   \] Test debug message$/);
+        });
+        it('verbose message', async () => {
+            testService.testVerbose();
+            expect(processStdoutWriteSpy).toHaveBeenCalled();
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3} VERBOSE \[TestService   \] Test verbose message$/);
+        });
+        it('fatal message', async () => {
+            testService.testFatal();
+            expect(processStdoutWriteSpy).toHaveBeenCalled();
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}   FATAL \[TestService   \] Test fatal message$/);
+        });
+    });
+    describe('[[LoggerMiddleware]]', () => {
+        // eslint-disable-next-line init-declarations
+        let app;
+        beforeEach(async () => {
+            let AppModule = class AppModule {
+                configure(consumer) {
+                    consumer.apply(a5_console_logger_middleware_1.A5ConsoleLoggerMiddleware).forRoutes('*');
+                }
+            };
+            AppModule = __decorate([
+                (0, common_1.Module)({
+                    controllers: [TestController],
+                    providers: [a5_console_logger_middleware_1.A5ConsoleLoggerMiddleware],
+                })
+            ], AppModule);
+            app = await a5_factory_1.A5Factory.create(AppModule, {
+                printLogo: false,
+            });
+            await app.nestApp.getHttpAdapter().getInstance().ready();
+        });
+        afterEach(async () => {
+            await app.close();
+        });
+        it('Get request', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).get('/').expect(200).expect('this is a get request');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "GET \/ HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('Post request', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).post('/').expect(201).expect('this is a post request');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "POST \/ HTTP\/1.1" 201 \d+ \d+ms "-" "-"$/);
+        });
+        it('Put request', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).put('/').expect(200).expect('this is a put request');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "PUT \/ HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('Patch request', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).patch('/').expect(200).expect('this is a patch request');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "PATCH \/ HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('Delete request', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).delete('/').expect(200).expect('this is a delete request');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "DELETE \/ HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('All request with GET method', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).get('/all').expect(200).expect('this is a get request to all route');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "GET \/all HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('All request with POST method', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).post('/all').expect(200).expect('this is a post request to all route');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "POST \/all HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('All request with PUT method', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer()).put('/all').expect(200).expect('this is a put request to all route');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "PUT \/all HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('All request with DELETE method', async () => {
+            await (0, supertest_1.default)(app.nestApp.getHttpServer())
+                .delete('/all')
+                .expect(200)
+                .expect('this is a delete request to all route');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "DELETE \/all HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+        it('Put request for upload file', async () => {
+            const fileContent = {
+                name: 'test.txt',
+                size: 1024,
+                content: 'this is file content data for testing file upload functionality',
+            };
+            await (0, supertest_1.default)(app.nestApp.getHttpServer())
+                .put('/upload')
+                .send(fileContent)
+                .expect(200)
+                .expect('file uploaded successfully');
+            const lines = toClearLines(processStdoutWriteSpy.mock.calls);
+            expect(lines[lines.length - 1]).toMatch(/^\[A5\] \d+ +- \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}     LOG \[HttpRequest   \] ::ffff:127.0.0.1 - "PUT \/upload HTTP\/1.1" 200 \d+ \d+ms "-" "-"$/);
+        });
+    });
+});
+//# sourceMappingURL=with-logger-module.integration.spec.js.map

package/dist/test/unit/core/a5-application.unit.spec.d.ts

@@ -0,0 +1 @@
+export {};