@tencent-rtc/mcp 1.0.0

package/@tencent/polaris/dist/consumer/health.d.ts

@@ -0,0 +1,126 @@
+import { Instance, InstanceStatus } from "../instance";
+import { Location } from "../location";
+import { Logger } from "../logging";
+import { Metadata } from "../metadata";
+import { LoadBalancerPlugin, OutlierDetectorPlugin, StatReporterPlugin } from "../plugins";
+import { LocalRegistry } from "../registry";
+declare const kDefaultOptions: {
+    /**
+     * 检查间隔
+     *
+     * 此值确定了，探活子系统的最小分辨率
+     */
+    detectInterval: number;
+    /**
+     * 熔断超时时间
+     *
+     * 未配置任何探活模块时生效
+     */
+    fusingTimeout: number;
+    /**
+     * 状态变更上报间隔
+     */
+    reportInterval: number;
+    /**
+     * 状态变更上报阈值
+     */
+    reportThreshold: number;
+};
+export declare type HealthOptions = typeof kDefaultOptions;
+/**
+ * 实例集合的共同信息
+ */
+export interface IntersectionInstance {
+    location: Location;
+    metadata: Metadata;
+}
+/**
+ * 状态变更历史
+ */
+export interface StatusChangelog {
+    /**
+     * 各实例状态变更历史
+     */
+    status: Map<Instance, StatusLog[]>;
+    /**
+     * 全局 `全死 ---> 全活` 变更历史
+     */
+    recover: RecoverLog[];
+}
+/**
+ * 全死 ---> 全活变更记录
+ */
+export interface RecoverLog {
+    /**
+     * 发生时间 (ms)
+     */
+    time: number;
+    /**
+     * 实例集合的共同信息
+     */
+    intersection: IntersectionInstance;
+}
+/**
+ * 实例状态变更请求
+ */
+export interface StatusChangeRequest {
+    /**
+     * 变更后（目标）状态
+     */
+    status: InstanceStatus;
+    /**
+     * 变更原因
+     */
+    reason: string;
+}
+/**
+ * 实例状态变更记录
+ */
+export interface StatusLog {
+    /**
+     * 变更时间 (ms)
+     */
+    time: number;
+    /**
+     * 变更前（原）状态
+     */
+    before: InstanceStatus;
+    /**
+     * 变更后（目标）状态
+     */
+    after: InstanceStatus;
+    /**
+     * 变更原因
+     */
+    reason: string;
+}
+export declare class Health {
+    private readonly logger;
+    private readonly registry;
+    private readonly lb;
+    private readonly detectors;
+    private readonly reporters;
+    private detectTimer;
+    private reportTimer;
+    private readonly pending;
+    private readonly options;
+    private history;
+    private countOfHistory;
+    private readonly needReport;
+    private disposed;
+    constructor(logger: Logger, registry: LocalRegistry, lb: LoadBalancerPlugin, detectors: OutlierDetectorPlugin[], reporters: StatReporterPlugin[], options?: Partial<HealthOptions>);
+    dispose(): void;
+    changeStatus(namespace: string, service: string, collections: Map<Instance, StatusChangeRequest>): void; /** batch - for performance */
+    changeStatus(namespace: string, service: string, instance: Instance, status: InstanceStatus, reason: string): void; /** single - for convenient */
+    recoverAll(namespace: string, service: string, instances: Instance[]): void;
+    private scheduleReport;
+    private report;
+    private getServiceChangelog;
+    private performStatusChange;
+    private detect;
+    private procDetectResult;
+    private successfulDetection;
+    private detectInstance;
+    private run;
+}
+export {};

package/@tencent/polaris/dist/consumer/health.js

@@ -0,0 +1,283 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Health = void 0;
+const location_1 = require("../location");
+const metadata_1 = require("../metadata");
+const plugins_1 = require("../plugins");
+const utils_1 = require("../utils");
+const kDefaultOptions = {
+    /**
+     * 检查间隔
+     *
+     * 此值确定了，探活子系统的最小分辨率
+     */
+    detectInterval: 10 * utils_1.kSeconds,
+    /**
+     * 熔断超时时间
+     *
+     * 未配置任何探活模块时生效
+     */
+    fusingTimeout: 5 * utils_1.kSeconds,
+    /**
+     * 状态变更上报间隔
+     */
+    reportInterval: 5 * utils_1.kMinutes,
+    /**
+     * 状态变更上报阈值
+     */
+    reportThreshold: 10000
+};
+class Health {
+    constructor(logger, registry, lb, detectors, reporters, options) {
+        this.logger = logger;
+        this.registry = registry;
+        this.lb = lb;
+        this.detectors = detectors;
+        this.reporters = reporters;
+        this.pending = new WeakSet();
+        this.history = Object.create(null);
+        this.countOfHistory = 0;
+        this.disposed = false;
+        this.options = Object.assign(Object.assign({}, kDefaultOptions), options);
+        this.needReport = reporters.some(report => typeof report.statusChangelog === "function");
+        this.run();
+    }
+    dispose() {
+        if (this.reportTimer) {
+            clearTimeout(this.reportTimer);
+            this.reportTimer = undefined;
+        }
+        if (this.detectTimer) {
+            clearTimeout(this.detectTimer);
+            this.detectTimer = undefined;
+        }
+        this.disposed = true;
+    }
+    /* eslint-enable max-len */
+    changeStatus(namespace, service, ...args) {
+        if (this.disposed) {
+            return;
+        }
+        const statusLogger = this.needReport ? this.getServiceChangelog(namespace, service).status : undefined;
+        if (args.length === 1) {
+            args[0].forEach((change, instance) => {
+                this.performStatusChange(namespace, service, instance, change.status, change.reason, statusLogger);
+            });
+        }
+        else {
+            this.performStatusChange(namespace, service, args[0], args[1], args[2], statusLogger);
+        }
+        if (this.needReport) {
+            this.scheduleReport();
+        }
+    }
+    recoverAll(namespace, service, instances) {
+        if (this.disposed || !this.needReport) {
+            return;
+        }
+        let intersection;
+        instances.forEach((instance) => {
+            if (instance.status !== 0 /* Normal */) {
+                /**
+                 * 计算实例相交的部分
+                 */
+                if (intersection === undefined) {
+                    intersection = {
+                        location: instance.location,
+                        metadata: instance.metadata
+                    };
+                }
+                else {
+                    if (!(0, location_1.isEmptyLocation)(intersection.location)) {
+                        intersection.location = (0, location_1.intersectionLocation)(intersection.location, instance.location);
+                    }
+                    if (!(0, metadata_1.isEmptyMetadata)(intersection.metadata)) {
+                        intersection.metadata = (0, metadata_1.intersectionMetadata)(intersection.metadata, instance.metadata);
+                    }
+                }
+            }
+        });
+        if (intersection !== undefined) {
+            this.getServiceChangelog(namespace, service).recover.push({
+                intersection,
+                time: Date.now()
+            });
+            this.countOfHistory += 1;
+            this.scheduleReport();
+        }
+    }
+    scheduleReport() {
+        if (this.countOfHistory >= this.options.reportThreshold) {
+            if (this.reportTimer !== undefined) {
+                clearTimeout(this.reportTimer);
+                this.reportTimer = undefined;
+            }
+            this.report();
+        }
+        else if (this.reportTimer === undefined) {
+            this.reportTimer = setTimeout(() => {
+                this.reportTimer = undefined;
+                this.report();
+            }, this.options.reportInterval).unref();
+        }
+    }
+    report() {
+        const { history } = this;
+        this.history = Object.create(null);
+        this.countOfHistory = 0;
+        Object.keys(history).forEach((namespace) => {
+            const serviceHistory = history[namespace];
+            Object.keys(serviceHistory).forEach((service) => {
+                this.reporters.forEach((reporter) => {
+                    var _a;
+                    (_a = reporter.statusChangelog) === null || _a === void 0 ? void 0 : _a.call(reporter, namespace, service, serviceHistory[service]).catch(err => this.disposed || this.logger.error(`[${reporter.name}] [statusChangelog]`, err));
+                });
+            });
+        });
+    }
+    getServiceChangelog(namespace, service) {
+        let ns = this.history[namespace];
+        if (!ns) {
+            ns = Object.create(null);
+            this.history[namespace] = ns;
+        }
+        let changelog = ns[service];
+        if (!changelog) {
+            changelog = {
+                recover: [],
+                status: new Map()
+            };
+            ns[service] = changelog;
+        }
+        return changelog;
+    }
+    performStatusChange(namespace, service, instance, status, reason, statusLogger) {
+        var _a, _b;
+        if (instance.status === status) {
+            return;
+        }
+        const before = instance.status;
+        if (statusLogger !== undefined) {
+            let statusHistory = statusLogger.get(instance);
+            if (statusHistory === undefined) {
+                statusHistory = [];
+                statusLogger.set(instance, statusHistory);
+            }
+            statusHistory.push({
+                time: Date.now(),
+                after: status,
+                before,
+                reason
+            });
+            this.countOfHistory += 1;
+        }
+        instance.status = status;
+        (_b = (_a = this.lb).onStatusChange) === null || _b === void 0 ? void 0 : _b.call(_a, namespace, service, instance, before);
+    }
+    // #endregion
+    // #region detector
+    async detect() {
+        const promises = [];
+        const instanceStorage = this.registry.local(plugins_1.RegistryCategory.Instance);
+        for (const namespace of Object.keys(instanceStorage)) {
+            const namespaceInstance = instanceStorage[namespace];
+            for (const service of Object.keys(namespaceInstance)) {
+                const instances = namespaceInstance[service].data;
+                for (const instance of instances) {
+                    if (instance.status === 3 /* Fused */ && !this.pending.has(instance)) {
+                        instance.dynamicWeight = 0;
+                        promises.push(this.detectInstance(instance)
+                            .then(result => this.procDetectResult(namespace, service, instance, result), err => this.logger.error("[health] [detect]", err)));
+                    }
+                }
+            }
+        }
+        await Promise.all(promises);
+    }
+    procDetectResult(namespace, service, instance, result) {
+        if (instance.status !== 3 /* Fused */) {
+            return;
+        }
+        const totalDetectors = this.detectors.length;
+        /**
+         * 根据所有探活模块的探测结果切换当前实例状态：
+         * * 成功：`Fused` ==(立即)==> `HalfOpen`
+         * * 未知：`Fused` ==(fusingTimeout)==> `HalfOpen`
+         * * 失败：保持当前实例状态，等待下次继续探测
+         */
+        switch (result) {
+            case 0 /* Success */: {
+                this.successfulDetection(namespace, service, instance, `[health] [detect], one of detectors(${totalDetectors}) successfully detected`);
+                break;
+            }
+            case 2 /* Other */: {
+                setTimeout(() => {
+                    this.successfulDetection(namespace, service, instance, `[health] [detect], ${totalDetectors > 0 ? `one of detectors(${totalDetectors}) detected result is unknown, and ` : ""}has exceeded the fusing timeout(${this.options.fusingTimeout}ms)`);
+                }, this.options.fusingTimeout).unref();
+                break;
+            }
+            case 1 /* Failure */: {
+                break;
+            }
+            default: {
+                (0, utils_1.UNREACHABLE)();
+            }
+        }
+    }
+    successfulDetection(namespace, service, instance, reason) {
+        /**
+         * 由于为异步探活，实例状态可能已被其它模块修改，
+         * 如果当前状态不为 `Fused` 则不进行切换。
+         */
+        if (instance.status === 3 /* Fused */) {
+            this.changeStatus(namespace, service, instance, 1 /* HalfOpen */, reason);
+        }
+    }
+    async detectInstance(instance) {
+        const totalDetectors = this.detectors.length;
+        for (let i = 0; i < totalDetectors; i += 1) {
+            const result = await this.detectors[i].detect(instance);
+            switch (result) {
+                case 1 /* Failure */:
+                case 2 /* Other */: {
+                    return result;
+                }
+                case 0 /* Success */: {
+                    break;
+                }
+                default: {
+                    (0, utils_1.UNREACHABLE)();
+                }
+            }
+        }
+        if (totalDetectors > 0) {
+            return 0 /* Success */;
+        }
+        return 2 /* Other */;
+    }
+    run() {
+        if (this.detectTimer) {
+            return;
+        }
+        /*
+         * 为了性能考虑 `Health` 流程采用同一定时器驱动
+         * tradeoff:
+         *   在最坏的情况下（未配置任何探活模块时），
+         *   由 `Fused` ---> `Normal` 至少需要等待 `detectInterval + fusingTimeout`
+         *   而非 `fusingTimeout` 中指定的值。
+         */
+        this.detectTimer = setTimeout(() => {
+            this.detect().then(() => {
+                if (this.disposed) {
+                    return;
+                }
+                this.detectTimer = undefined;
+                this.run();
+            }, () => {
+                (0, utils_1.UNREACHABLE)();
+            });
+        }, this.options.detectInterval).unref();
+    }
+}
+exports.Health = Health;
+//# sourceMappingURL=health.js.map

package/@tencent/polaris/dist/consumer/health.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.js","sourceRoot":"","sources":["../../src/consumer/health.ts"],"names":[],"mappings":";;;AACA,0CAA8E;AAE9E,0CAA8E;AAC9E,wCAA2I;AAE3I,oCAA2D;AAE3D,MAAM,eAAe,GAAG;IACtB;;;;OAIG;IACH,cAAc,EAAE,EAAE,GAAG,gBAAQ;IAE7B;;;;OAIG;IACH,aAAa,EAAE,CAAC,GAAG,gBAAQ;IAE3B;;OAEG;IACH,cAAc,EAAE,CAAC,GAAG,gBAAQ;IAE5B;;OAEG;IACH,eAAe,EAAE,KAAM;CACxB,CAAC;AAkFF,MAAa,MAAM;IAUjB,YACmB,MAAc,EACd,QAAuB,EACvB,EAAsB,EACtB,SAAkC,EAClC,SAA+B,EAChD,OAAgC;QALf,WAAM,GAAN,MAAM,CAAQ;QACd,aAAQ,GAAR,QAAQ,CAAe;QACvB,OAAE,GAAF,EAAE,CAAoB;QACtB,cAAS,GAAT,SAAS,CAAyB;QAClC,cAAS,GAAT,SAAS,CAAsB;QAZjC,YAAO,GAAsB,IAAI,OAAO,EAAE,CAAC;QAEpD,YAAO,GAAoC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAoC,CAAC;QAClG,mBAAc,GAAG,CAAC,CAAC;QAEnB,aAAQ,GAAG,KAAK,CAAC;QAUvB,IAAI,CAAC,OAAO,mCACP,eAAe,GACf,OAAO,CACX,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,MAAM,CAAC,eAAe,KAAK,UAAU,CAAC,CAAC;QACzF,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;SAC9B;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;SAC9B;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAMD,2BAA2B;IAC3B,YAAY,CAAC,SAAiB,EAAE,OAAe,EAAE,GAAG,IAAW;QAC7D,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,OAAO;SACR;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACvG,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACpB,IAAI,CAAC,CAAC,CAAwC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;gBAC3E,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YACrG,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,IAAI,CAAC,mBAAmB,CACtB,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAa,EAAE,IAAI,CAAC,CAAC,CAAmB,EAAE,IAAI,CAAC,CAAC,CAAW,EAAE,YAAY,CACpG,CAAC;SACH;QAED,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,cAAc,EAAE,CAAC;SACvB;IACH,CAAC;IAED,UAAU,CAAC,SAAiB,EAAE,OAAe,EAAE,SAAqB;QAClE,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACrC,OAAO;SACR;QAED,IAAI,YAA8C,CAAC;QAEnD,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7B,IAAI,QAAQ,CAAC,MAAM,mBAA0B,EAAE;gBAC7C;;mBAEG;gBACH,IAAI,YAAY,KAAK,SAAS,EAAE;oBAC9B,YAAY,GAAG;wBACb,QAAQ,EAAE,QAAQ,CAAC,QAAQ;wBAC3B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;qBAC5B,CAAC;iBACH;qBAAM;oBACL,IAAI,CAAC,IAAA,0BAAe,EAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;wBAC3C,YAAY,CAAC,QAAQ,GAAG,IAAA,+BAAoB,EAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;qBACxF;oBACD,IAAI,CAAC,IAAA,0BAAe,EAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;wBAC3C,YAAY,CAAC,QAAQ,GAAG,IAAA,+BAAoB,EAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;qBACxF;iBACF;aACF;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACxD,YAAY;gBACZ,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;aACjB,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,cAAc,EAAE,CAAC;SACvB;IACH,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YACvD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC/B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;aAC9B;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;SACf;aAAM,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE;gBACjC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;gBAC7B,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC;SACzC;IACH,CAAC;IAEO,MAAM;QACZ,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAoC,CAAC;QACtE,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;QAExB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YACzC,MAAM,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,cAAe,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC/C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;;oBAClC,MAAA,QAAQ,CAAC,eAAe,yDAAG,SAAS,EAAE,OAAO,EAAE,cAAe,CAAC,OAAO,CAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,qBAAqB,EAAE,GAAG,CAAC,CAAC,CAAC;gBAC1K,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,SAAiB,EAAE,OAAe;QAC5D,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,EAAE;YACP,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAoC,CAAC;YAC5D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;SAC9B;QAED,IAAI,SAAS,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,EAAE;YACd,SAAS,GAAG;gBACV,OAAO,EAAE,EAAE;gBACX,MAAM,EAAE,IAAI,GAAG,EAAyB;aACzC,CAAC;YACF,EAAE,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;SACzB;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,mBAAmB,CAAC,SAAiB,EAAE,OAAe,EAAE,QAAkB,EAAE,MAAsB,EAAE,MAAc,EAAE,YAAwC;;QAClK,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,EAAE;YAC9B,OAAO;SACR;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAE/B,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,IAAI,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC/C,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,aAAa,GAAG,EAAE,CAAC;gBACnB,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;aAC3C;YAED,aAAa,CAAC,IAAI,CAAC;gBACjB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;gBAChB,KAAK,EAAE,MAAM;gBACb,MAAM;gBACN,MAAM;aACP,CAAC,CAAC;YAEH,IAAI,CAAC,cAAc,IAAI,CAAC,CAAC;SAC1B;QAED,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,MAAA,MAAA,IAAI,CAAC,EAAE,EAAC,cAAc,mDAAG,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IACD,aAAa;IAEb,mBAAmB;IACX,KAAK,CAAC,MAAM;QAClB,MAAM,QAAQ,GAAoB,EAAE,CAAC;QAErC,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,0BAAgB,CAAC,QAAQ,CAAC,CAAC;QACvE,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;YACpD,MAAM,iBAAiB,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YACrD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAkB,CAAC,EAAE;gBACrD,MAAM,SAAS,GAAG,iBAAkB,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC;gBACpD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;oBAChC,IAAI,QAAQ,CAAC,MAAM,kBAAyB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;wBAC3E,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC;wBAC3B,QAAQ,CAAC,IAAI,CACX,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;6BAC1B,IAAI,CACH,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,EACrE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CACnD,CACJ,CAAC;qBACH;iBACF;aACF;SACF;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAEO,gBAAgB,CAAC,SAAiB,EAAE,OAAe,EAAE,QAAkB,EAAE,MAAoB;QACnG,IAAI,QAAQ,CAAC,MAAM,kBAAyB,EAAE;YAC5C,OAAO;SACR;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QAC7C;;;;;WAKG;QACH,QAAQ,MAAM,EAAE;YACd,oBAAyB,CAAC,CAAC;gBACzB,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,uCAAuC,cAAc,yBAAyB,CAAC,CAAC;gBACvI,MAAM;aACP;YACD,kBAAuB,CAAC,CAAC;gBACvB,UAAU,CAAC,GAAG,EAAE;oBACd,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,sBAAsB,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,oBAAoB,cAAc,oCAAoC,CAAC,CAAC,CAAC,EAAE,mCAAmC,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,CAAC,CAAC;gBACnP,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,CAAC;gBACvC,MAAM;aACP;YACD,oBAAyB,CAAC,CAAC;gBACzB,MAAM;aACP;YACD,OAAO,CAAC,CAAC;gBACP,IAAA,mBAAW,GAAE,CAAC;aACf;SACF;IACH,CAAC;IAEO,mBAAmB,CAAC,SAAiB,EAAE,OAAe,EAAE,QAAkB,EAAE,MAAc;QAChG;;;WAGG;QACH,IAAI,QAAQ,CAAC,MAAM,kBAAyB,EAAE;YAC5C,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,oBAA2B,MAAM,CAAC,CAAC;SAClF;IACH,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,QAAkB;QAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QAE7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,IAAI,CAAC,EAAE;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACxD,QAAQ,MAAM,EAAE;gBACd,qBAA0B;gBAC1B,kBAAuB,CAAC,CAAC;oBACvB,OAAO,MAAM,CAAC;iBACf;gBACD,oBAAyB,CAAC,CAAC;oBACzB,MAAM;iBACP;gBACD,OAAO,CAAC,CAAC;oBACP,IAAA,mBAAW,GAAE,CAAC;iBACf;aACF;SACF;QAED,IAAI,cAAc,GAAG,CAAC,EAAE;YACtB,uBAA4B;SAC7B;QACD,qBAA0B;IAC5B,CAAC;IAEO,GAAG;QACT,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO;SACR;QAED;;;;;;WAMG;QACH,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE;YACjC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtB,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACjB,OAAO;iBACR;gBAED,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;gBAC7B,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,CAAC,EAAE,GAAG,EAAE;gBACN,IAAA,mBAAW,GAAE,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC;IAC1C,CAAC;CAEF;AA5SD,wBA4SC"}

package/@tencent/polaris/dist/consumer/index.d.ts

@@ -0,0 +1,120 @@
+import { GlobalOptions } from "../global";
+import { Instance } from "../instance";
+import { Logger, LoggerOptions } from "../logging";
+import { Metadata } from "../metadata";
+import { PluginList, PluginType, RegistryCategory, ServiceRules } from "../plugins";
+import { LocalRegistryOptions } from "../registry";
+import { Service } from "../service";
+import { SkeletonClass } from "../skeleton";
+import { PartialKeys, RequireKeys } from "../utils";
+import { HealthOptions } from "./health";
+import { Monitor, MonitorOptions } from "./monitor";
+import { CallArgsType, CombinatedArgs, SelectorOptions } from "./selector";
+export { CallArgsType } from "./selector";
+export { ComputedStat, ComputeStatKey, StatProp } from "./monitor";
+export { StatusChangelog, StatusChangeRequest } from "./health";
+declare const kSelector: unique symbol;
+declare const kMonitor: unique symbol;
+declare const kHealth: unique symbol;
+declare const kRegistry: unique symbol;
+export declare class SelectResponse {
+    readonly callee: Service;
+    readonly instance: Instance;
+    private readonly [kMonitor];
+    constructor(callee: Service, instance: Instance, monitor: Monitor);
+    /**
+     * 上报调用结果
+     * @param success 是否调用成功
+     * @param cost 调用耗时（需大于等于 0，默认为 0）
+     * @param code 返回码（可选）
+     */
+    update(success: boolean, cost?: number, code?: string): void;
+}
+export declare type ConsumerOptions = GlobalOptions & MonitorOptions & HealthOptions & SelectorOptions & LoggerOptions & LocalRegistryOptions;
+declare type ConsumerPluginList = PartialKeys<Omit<PluginList, PluginType.RatelimitService | PluginType.TrafficShaping>, PluginType.CircuitBreaker>;
+export declare type OptionalConsumerPluginList = RequireKeys<Partial<ConsumerPluginList>, PluginType.NamingService>;
+/**
+ * For internal use only.
+ * Use `Consumer` instead of `InternalConsumer`.
+ */
+export declare class InternalConsumer extends SkeletonClass<ConsumerPluginList> {
+    private static mergePluginList;
+    private readonly [kSelector];
+    private readonly [kMonitor];
+    private readonly [kHealth];
+    private readonly [kRegistry];
+    /**
+     * Create Consumer
+     * @param plugins 插件
+     * @param options 配置参数（可选）
+     * @param logger Logger 对象共享，如不传则会自动创建
+     */
+    constructor(plugins: OptionalConsumerPluginList, options?: Partial<ConsumerOptions>, logger?: Logger);
+    /**
+     * 销毁（释放）所占资源
+     *
+     * @description
+     * dispose order:
+     *  Monitor -> Health -> Selector -> Registry -> [plguins]
+     *
+     * @param sync 是否同步释放（可选）
+     */
+    dispose(sync?: boolean): void;
+    /**
+     * 获取单个服务实例
+     * @param namespace 被调方名字空间
+     * @param service 被调方服务名
+     * @param metadata 主调方服务元数据（可选）
+     * @param args 本次调用附加参数（可选）
+     */
+    select<ServiceRouterArgs extends CombinatedArgs, LoadBalancerArgs = unknown>(namespace: string, service: string, metadata?: Metadata, args?: CallArgsType<ServiceRouterArgs, LoadBalancerArgs>): Promise<SelectResponse | null>;
+    /**
+     * 获取单个服务实例
+     * @param callee 被调方服务信息
+     * @param caller 主调方服务信息（可选）
+     * @param args 本次调用附加参数（可选）
+     */
+    select<ServiceRouterArgs extends CombinatedArgs, LoadBalancerArgs = unknown>(callee: Service, caller?: Service, args?: CallArgsType<ServiceRouterArgs, LoadBalancerArgs>): Promise<SelectResponse | null>;
+    /**
+     * 获取全部服务实例
+     * @param namespace 服务名字空间
+     * @param service 服务名
+     */
+    list(namespace: string, service: string): Promise<Instance[]>;
+    /**
+     * 获取服务规则路由
+     * @param namespace 服务名字空间
+     * @param service 服务名
+     */
+    rules(namespace: string, service: string): Promise<ServiceRules>;
+    /**
+     * 强制刷新缓存
+     * @param namespace 服务名字空间
+     * @param service 服务名
+     * @param type 数据存储类别
+     */
+    update(namespace: string, service: string, type: RegistryCategory): Promise<boolean>;
+}
+export declare class Consumer extends InternalConsumer {
+    #private;
+    /**
+     * 当前可实例化的最大次数
+     */
+    static get maxInstances(): number;
+    /**
+     * 设置可实例化的最大次数
+     * @param n 最大次数
+     */
+    static setMaxInstances(n: number): void;
+    /**
+     * Create Consumer
+     * @param plugins 插件
+     * @param options 配置参数（可选）
+     */
+    constructor(plugins: OptionalConsumerPluginList, options?: Partial<ConsumerOptions>);
+    /**
+     * 销毁（释放）所占资源
+     * @param sync 是否同步释放（可选）
+     */
+    dispose(sync?: boolean): void;
+}