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

package/dist/const/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @public
+ *
+ * 默认监听端口。
+ */
+export declare const A5_APP_LISTEN_PORT_DEFAULT: 16100;
+/**
+ * @public
+ *
+ *  `A5App.prototype.listen` 参数默认值。
+ *
+ */
+export declare const A5_APP_LISTEN_OPTIONS_DEFAULT: {
+    /**
+     * 是否自动退出。
+     */
+    readonly AUTO_EXIT: true;
+    /**
+     * 重试间隔。
+     */
+    readonly TRY_INTERVAL: 300;
+    /**
+     * 最大重试次数。
+     */
+    readonly TRY_TIMES: 20;
+};
+/**
+ * @public
+ */
+export declare const MAIN_STATIC_PATH: string;
+/**
+ * @public
+ */
+export declare const HOME_STATIC_PATH: string;
+/**
+ * @public
+ */
+export declare const ERROR_WELCOME_MSG: string;

package/dist/const/index.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_WELCOME_MSG = exports.HOME_STATIC_PATH = exports.MAIN_STATIC_PATH = exports.A5_APP_LISTEN_OPTIONS_DEFAULT = exports.A5_APP_LISTEN_PORT_DEFAULT = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+/**
+ * @public
+ *
+ * 默认监听端口。
+ */
+exports.A5_APP_LISTEN_PORT_DEFAULT = 16100;
+/**
+ * @public
+ *
+ *  `A5App.prototype.listen` 参数默认值。
+ *
+ */
+exports.A5_APP_LISTEN_OPTIONS_DEFAULT = {
+    /**
+     * 是否自动退出。
+     */
+    AUTO_EXIT: true,
+    /**
+     * 重试间隔。
+     */
+    TRY_INTERVAL: 300,
+    /**
+     * 最大重试次数。
+     */
+    TRY_TIMES: 20,
+};
+/**
+ * @public
+ */
+exports.MAIN_STATIC_PATH = node_path_1.default.resolve(__dirname, '../../public');
+/**
+ * @public
+ */
+exports.HOME_STATIC_PATH = node_path_1.default.resolve(__dirname, '../../public/home.pug');
+/**
+ * @public
+ */
+exports.ERROR_WELCOME_MSG = 'This is A4 service.';
+//# sourceMappingURL=index.js.map

package/dist/core/__import-reflect-metadata.d.ts

@@ -0,0 +1 @@
+import 'reflect-metadata';

package/dist/core/__import-reflect-metadata.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+//# sourceMappingURL=__import-reflect-metadata.js.map

package/dist/core/a5-application.d.ts

@@ -0,0 +1,154 @@
+import { Logger, LoggerService } from '@nestjs/common';
+import { NestFastifyApplication } from '@nestjs/platform-fastify';
+/**
+ * @public
+ *
+ *  A5App Constructor Options
+ *
+ */
+export interface A5AppConstructorOptions {
+    /**
+     * Logger 对象。
+     *
+     * 显性设置 Logger 对象。默认情况下，将会加载 A5LoggerModule 的 Logger 实例。
+     *
+     * 如果加载失败，将会使用 A5ConsoleLogger 的实例。
+     *
+     */
+    readonly logger?: LoggerService;
+}
+/**
+ * @public
+ *
+ *  A5App Options
+ *
+ */
+export type A5AppOptions = Required<A5AppConstructorOptions>;
+/**
+ *
+ * @public
+ *
+ *  `A5App.prototype.listen` 参数
+ *
+ */
+export interface A5AppListenOptions {
+    /**
+     *
+     * 若多次尝试失败，是否退出 NestApplication。
+     *
+     * 可选。默认值为 @see A5_APP_LISTEN_OPTIONS_DEFAULT.AUTO_EXIT
+     *
+     */
+    readonly autoExit?: boolean;
+    /**
+     *
+     * 若端口被占用，则重新获取端口的时间间隔。(单位 ms)
+     *
+     * 数值是正整数。
+     *
+     * 可选。默认值为 @see A5_APP_LISTEN_OPTIONS_DEFAULT.TRY_INTERVAL
+     *
+     * TODO 后续可以添加合适的时间范围。
+     *
+     */
+    readonly tryInterval?: number;
+    /**
+     *
+     * 若端口被占用，则重新获取端口的最大尝试次数。
+     *
+     * 数值是正整数。
+     *
+     * 可选。默认值为 @see A5_APP_LISTEN_OPTIONS_DEFAULT.TRY_TIMES
+     *
+     */
+    readonly tryTimes?: number;
+}
+/**
+ * @public
+ *
+ *  `A5` for `NestApplication`。服务应用类。
+ *
+ */
+export declare class A5Application {
+    protected readonly initTime: Date;
+    protected readonly logger: Logger;
+    /**
+     * setExtraUrl 及 getUrls 函数用于保存数据的数组
+     */
+    protected readonly extraUrls: string[];
+    /**
+     *
+     * 由 [nanoid](https://github.com/ai/nanoid) 生成的实例 ID。21 位长的字符串。
+     *
+     */
+    readonly instanceId: string;
+    readonly nestApp: NestFastifyApplication;
+    readonly options: A5AppOptions;
+    constructor(nestApp: NestFastifyApplication, options?: A5AppConstructorOptions);
+    init(): Promise<void>;
+    /**
+     *
+     * @public
+     *
+     *  `A5` 应用，对网络进行监听。
+     *
+     *  `A5` 增加了对端口获取失败的多次尝试。
+     *
+     *  如果想关闭自动重试，请传入 `listen({ tryTimes: 0 })`
+     *
+     *  TODO 未考虑采用哪种方案，进行多次尝试。
+     *
+     */
+    listen(options?: A5AppListenOptions): Promise<void>;
+    listen(port: number | string, options?: A5AppListenOptions): Promise<void>;
+    /**
+     *
+     * @public
+     *
+     *  添加额外的 urls, 便于 printAddress 进行输出
+     *
+     */
+    setExtraUrl(urlOrUrls: string | string[]): Promise<void>;
+    /**
+     *
+     * @public
+     *
+     *  输出可以访问当前服务的地址。
+     *
+     * TODO 需要精准判断 IPv4 和 IPv6 等各项情况。
+     *
+     */
+    getUrls(): Promise<string[]>;
+    /**
+     *
+     * @public
+     *
+     *  在正常获取 IP 与端口后，可通过此函数输出日志信息。
+     *
+     */
+    printAddress(): Promise<void>;
+    /**
+     *
+     * @public
+     *
+     *  关闭应用。
+     *  是 `NestApplication.prototype.close()` 的语法糖。
+     *
+     */
+    close(): Promise<void>;
+    /**
+     *
+     * @public
+     *
+     *  应用是否处于关闭状态
+     *
+     */
+    isClose(): boolean;
+    /**
+     * @internal
+     *
+     *  将会优先尝试 A5 内部的日志模块。如果没有的话，才会使用 A5ConsoleLogger
+     *
+     */
+    private _getA5LoggerService;
+}

package/dist/core/a5-application.js

@@ -0,0 +1,315 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.A5Application = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const nanoid_1 = require("nanoid");
+const index_1 = require("../const/index");
+const log_1 = require("../module/log");
+const util_1 = require("../util");
+const a5_console_logger_1 = require("./a5-console-logger");
+// /**
+//  *
+//  * @public
+//  *
+//  *  `A5App.prototype.staticFile` 传入参数
+//  *
+//  */
+// export interface IA5AppStaticFileOptions {
+//   /**
+//    * 请求路径。
+//    */
+//   requestPath: string
+//   /**
+//    * 发布文件的绝对路径。可选。
+//    *
+//    * filepath fileContent contentCallback 三个属性必选其一
+//    */
+//   filepath?: string
+//   /**
+//    * 发布文件的内容。可选。
+//    *
+//    * filepath fileContent contentCallback 三个属性必选其一
+//    */
+//   fileContent?: string
+//   /**
+//    * 通过回调函数返回文件内容。可选。
+//    *
+//    * filepath fileContent contentCallback 三个属性必选其一
+//    */
+//   contentCallback?: (req: Request, res: Response) => Promise<string> | string
+//   /**
+//    * 通过回调函数返回文件内容。可选。
+//    *
+//    * filepath fileContent contentCallback 三个属性必选其一
+//    */
+//   callback?: (req: Request, res: Response) => Promise<void> | void
+//   /**
+//    * 'Content-type' 属性。可选。默认为：'text/plain'
+//    */
+//   contentType?: string
+//   /**
+//    * 是否输出 logger.
+//    *
+//    * 默认：true
+//    */
+//   logger?: boolean
+//   /**
+//    * 日志输出时, logger 标记信息。可选。缺省时，使用 A5App 默认 Logger
+//    */
+//   loggerMarker?: string
+// }
+process.env.A5_INIT_TIME = `${Date.now()}`;
+/**
+ * @public
+ *
+ *  `A5` for `NestApplication`。服务应用类。
+ *
+ */
+class A5Application {
+    // public alive: boolean
+    constructor(nestApp, options = {}) {
+        this.initTime = new Date();
+        this.logger = new common_1.Logger(A5Application.name);
+        /**
+         * setExtraUrl 及 getUrls 函数用于保存数据的数组
+         */
+        this.extraUrls = [];
+        this.instanceId = (0, nanoid_1.nanoid)();
+        this.nestApp = nestApp;
+        this.options = {
+            logger: options.logger ?? this._getA5LoggerService(),
+        };
+    }
+    async init() {
+        this.nestApp.useLogger(this.options.logger);
+        await this.nestApp.init();
+        // 将 logBuffer 输出
+        await this.nestApp.flushLogs();
+    }
+    async listen(portOrOptions, maybeOptions) {
+        let port = index_1.A5_APP_LISTEN_PORT_DEFAULT;
+        const options = {
+            tryInterval: index_1.A5_APP_LISTEN_OPTIONS_DEFAULT.TRY_INTERVAL,
+            tryTimes: index_1.A5_APP_LISTEN_OPTIONS_DEFAULT.TRY_TIMES,
+            autoExit: index_1.A5_APP_LISTEN_OPTIONS_DEFAULT.AUTO_EXIT,
+        };
+        if (portOrOptions === undefined) {
+            // no options, use default
+        }
+        else if (typeof portOrOptions === 'number' || typeof portOrOptions === 'string') {
+            port = typeof portOrOptions === 'number' ? portOrOptions : parseInt(portOrOptions, 10);
+            if (maybeOptions) {
+                options.autoExit = maybeOptions.autoExit ?? options.autoExit;
+                options.tryInterval = maybeOptions.tryInterval ?? options.tryInterval;
+                options.tryTimes = maybeOptions.tryTimes ?? options.tryTimes;
+            }
+        }
+        else {
+            options.autoExit = portOrOptions.autoExit ?? options.autoExit;
+            options.tryInterval = portOrOptions.tryInterval ?? options.tryInterval;
+            options.tryTimes = portOrOptions.tryTimes ?? options.tryTimes;
+        }
+        let i = 0;
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            try {
+                if (i > 0) {
+                    this.logger.warn(`Retrying listen on port ${port}`);
+                }
+                /**
+                 * TODO 需要对 ipv6 的绑定进行测试
+                 */
+                await this.nestApp.listen(port);
+                break;
+            }
+            catch (error) {
+                i += 1;
+                if (i > options.tryTimes) {
+                    if (options.autoExit) {
+                        if (i > 1) {
+                            this.logger.error(`Try too many times, a5Application is automatically shutting down`);
+                        }
+                        else {
+                            this.logger.error(`A5Application is automatically shutting down`);
+                        }
+                        await this.close();
+                    }
+                    else {
+                        throw new Error(`A5Application.listen error: port ${port} has be used`);
+                    }
+                    break;
+                }
+                const errorMsg = error.message;
+                if (!errorMsg.includes('address already in use')) {
+                    this.logger.error(`A5Application.listen encountered an unknown error`, error);
+                    this.logger.error(error);
+                    if (options.autoExit) {
+                        this.logger.error(`A5Application is automatically shutting down`);
+                        await this.close();
+                    }
+                    else {
+                        throw new Error('A5Application.listen encountered an unknown error');
+                    }
+                    break;
+                }
+                // 端口号 16100 已被使用，300 ms 后将会再次尝试
+                this.logger.warn(`Port ${port} is be used, another attempt will be made in ${options.tryInterval} ms`);
+                await util_1.A5Util.sleep(options.tryInterval);
+            }
+        }
+    }
+    /**
+     *
+     * @public
+     *
+     *  添加额外的 urls, 便于 printAddress 进行输出
+     *
+     */
+    async setExtraUrl(urlOrUrls) {
+        if (Array.isArray(urlOrUrls)) {
+            this.extraUrls.push(...urlOrUrls);
+        }
+        else {
+            this.extraUrls.push(urlOrUrls);
+        }
+    }
+    /**
+     *
+     * @public
+     *
+     *  输出可以访问当前服务的地址。
+     *
+     * TODO 需要精准判断 IPv4 和 IPv6 等各项情况。
+     *
+     */
+    async getUrls() {
+        const url = await this.nestApp.getUrl();
+        const urls = [url, ...this.extraUrls];
+        return urls;
+    }
+    /**
+     *
+     * @public
+     *
+     *  在正常获取 IP 与端口后，可通过此函数输出日志信息。
+     *
+     */
+    async printAddress() {
+        const urls = await this.getUrls();
+        const timeDiffWithColor = util_1.ColorUtil.yellowBright(`${Date.now() - +process.env.A5_INIT_TIME} ms`);
+        const urlMaxLength = Math.max(...urls.map((i) => i.length));
+        urls.forEach((url, index) => {
+            const urlWithColor = util_1.ColorUtil.cyan(url.padEnd(urlMaxLength, ' '));
+            if (index === 0) {
+                this.logger.log(`Application runing at ${urlWithColor} (+${timeDiffWithColor})`);
+            }
+            else {
+                this.logger.log(`                      ${urlWithColor}`);
+            }
+        });
+    }
+    /**
+     *
+     * @public
+     *
+     *  关闭应用。
+     *  是 `NestApplication.prototype.close()` 的语法糖。
+     *
+     */
+    async close() {
+        await this.nestApp.close();
+    }
+    /**
+     *
+     * @public
+     *
+     *  应用是否处于关闭状态
+     *
+     */
+    isClose() {
+        return this.nestApp.getHttpServer().address() === null;
+    }
+    // /**
+    //  * @public
+    //  *
+    //  *  发布单个静态资源文件。
+    //  *
+    //  *  支持 文件路径、文件内容多种发布方案。
+    //  *  会按照以下流程读取资源：
+    //  *
+    //  *  1. 通过 filepath 使用流读取文件；
+    //  *  2. 直接返回 content 作为请求体；
+    //  *  3. 返回 404；
+    //  *
+    //  */
+    // public staticFile(options: IA5AppStaticFileOptions): void {
+    //   const logger: Logger = options.loggerMarker ? new Logger(options.loggerMarker) : this.logger
+    //   if (options.logger ?? true) logger.log(`Mapped {${options.requestPath}, GET} route`)
+    //   this.nestApp.getHttpAdapter().get(options.requestPath, async (req: Request, res: Response) => {
+    //     if (options.filepath) {
+    //       res.setHeader('Content-type', options.contentType ?? 'text/plain')
+    //       // 创建一个可读流来读取文件
+    //       const fileStream = createReadStream(options.filepath)
+    //       // 将文件流管道到响应对象，这样文件内容就会直接发送到客户端
+    //       fileStream.pipe(res)
+    //       // 处理可能发生的错误
+    //       fileStream.on('error', (err) => {
+    //         logger.error(`Get '${options.filepath}' error.`, err)
+    //         res.status(404).send()
+    //       })
+    //     } else if (options.fileContent) {
+    //       res.setHeader('Content-type', options.contentType ?? 'text/plain')
+    //       res.status(200).send(options.fileContent)
+    //     } else if (options.contentCallback) {
+    //       res.setHeader('Content-type', options.contentType ?? 'text/plain')
+    //       const a = options.contentCallback(req, res)
+    //       if (a instanceof Promise) {
+    //         a.then((b) => {
+    //           res.status(200).send(b)
+    //         }).catch(() => {
+    //           res.status(404).send()
+    //         })
+    //       } else {
+    //         res.status(200).send(a)
+    //       }
+    //     } else if (options.callback) {
+    //       await options.callback(req, res)
+    //     } else {
+    //       res.status(404).send()
+    //     }
+    //   })
+    // }
+    /**
+     * @internal
+     *
+     *  将会优先尝试 A5 内部的日志模块。如果没有的话，才会使用 A5ConsoleLogger
+     *
+     */
+    _getA5LoggerService() {
+        const moduleRef = this.nestApp.get(core_1.ModuleRef);
+        try {
+            const logger = moduleRef.get(log_1.GLOBAL_PROVIDE_TOKEN_A5_LOG_LOGGER, { strict: false });
+            if (logger.getContext() === '') {
+                logger.setContext(A5Application.name);
+                logger.log(`Loaded A5 Logger Provider, using '${logger.constructor.name}'`);
+                logger.debug(`'${logger.constructor.name}' context is empty, automatically filled with '${A5Application.name}' as default context`);
+            }
+            else {
+                logger.log(`Loaded A5 Logger Provider, using '${logger.constructor.name}'`);
+            }
+            return logger;
+        }
+        catch (error) {
+            // 这个地方，如果报错，解析的不够，如果是 GLOBAL_PROVIDE_TOKEN_A5_LOG_LOGGER 未找到，则使用 A5ConsoleLogger
+            // 否则，应该对此报错进行抛出！！！
+            const logger = new a5_console_logger_1.A5ConsoleLogger({
+                context: A5Application.name,
+            });
+            logger.warn(`Not loaded A5 Logger Provider, using 'A5ConsoleLogger'`);
+            return logger;
+        }
+    }
+}
+exports.A5Application = A5Application;
+//# sourceMappingURL=a5-application.js.map