@tencent-rtc/mcp 1.0.0

package/@tencent/polaris/dist/plugins/shaping/unirate.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnirateTrafficShaping = void 0;
+const __1 = require("../..");
+const plugins_1 = require("../../plugins");
+const kDefaultOptions = {
+    /**
+     * 最长等待时间 (ms)
+     */
+    maxWaitingTime: Infinity,
+    /**
+     * 空闲回收周期
+     */
+    idlePeriod: 3
+};
+/**
+ * Leaky bucket
+ * (https://en.wikipedia.org/wiki/Leaky_bucket)
+ */
+class UnirateTrafficShaping {
+    constructor(options) {
+        this.type = plugins_1.PluginType.TrafficShaping;
+        this.name = "unirate";
+        this.buckets = new WeakMap();
+        this.disposed = false;
+        this.options = Object.assign(Object.assign({}, kDefaultOptions), options);
+    }
+    // #region dispose
+    dispose() {
+        this.disposed = true;
+    }
+    get isDisposed() {
+        return this.disposed;
+    }
+    // #endregion
+    inFlow(rule, partition) {
+        if (this.disposed) {
+            return Promise.reject(new __1.StateError("Already disposed"));
+        }
+        let bucket = this.buckets.get(rule);
+        if (typeof bucket === "undefined") {
+            bucket = this.buildBucket(rule, partition);
+            this.buckets.set(rule, bucket);
+        }
+        if (bucket.partition !== partition) {
+            const { capacity, interval, rate } = this.buildBucket(rule, partition);
+            bucket.capacity = capacity;
+            bucket.interval = interval;
+            bucket.rate = rate;
+            bucket.partition = partition;
+            if (bucket.timer !== undefined) {
+                clearInterval(bucket.timer);
+                bucket.timer = undefined;
+            }
+        }
+        if (bucket.queue.length === bucket.capacity) {
+            return Promise.reject(new __1.StateError(`[plugin] [unirate], timeout(${this.options.maxWaitingTime}ms)`));
+        }
+        const quota = new Promise((...args) => {
+            bucket.queue.push(args);
+        });
+        if (bucket.timer === undefined) {
+            this.allocate(bucket);
+            bucket.timer = setInterval(() => {
+                if (this.disposed) {
+                    bucket.queue.forEach(([, reject]) => process.nextTick(reject, new __1.StateError("Already disposed")));
+                    bucket.queue = [];
+                    clearInterval(bucket.timer);
+                    bucket.timer = undefined;
+                    bucket.sleepPeriod = 0;
+                    return;
+                }
+                if (!this.allocate(bucket)) {
+                    bucket.sleepPeriod += 1;
+                }
+                else {
+                    bucket.sleepPeriod = 0;
+                }
+                if (bucket.sleepPeriod > this.options.idlePeriod) {
+                    clearInterval(bucket.timer);
+                    bucket.timer = undefined;
+                }
+            }, bucket.interval).unref();
+        }
+        return quota;
+    }
+    allocate(bucket) {
+        const { queue, rate } = bucket;
+        const hasRequest = queue.length > 0;
+        /*
+         * note:
+         *  这里在下一个 tick 内调用 `resolve`，以避免用户代码异常造成流程中断
+         */
+        queue.splice(0, rate).forEach(([reslove]) => process.nextTick(reslove));
+        return hasRequest;
+    }
+    buildBucket(rule, partition) {
+        let interval = rule.amounts.reduce((acc, { amount, duration }) => {
+            const rate = duration / (amount / partition);
+            if (rate > acc) {
+                return rate;
+            }
+            return acc;
+        }, 0);
+        let rate = 1;
+        if (interval < 1) {
+            rate = ~~(1 / interval);
+            interval = 1;
+        }
+        else {
+            interval = Math.floor(interval);
+        }
+        return {
+            queue: [],
+            interval,
+            rate,
+            capacity: Math.floor(rate * Math.floor(this.options.maxWaitingTime / interval)),
+            sleepPeriod: 0,
+            partition
+        };
+    }
+}
+exports.UnirateTrafficShaping = UnirateTrafficShaping;
+//# sourceMappingURL=unirate.js.map

package/@tencent/polaris/dist/plugins/shaping/unirate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unirate.js","sourceRoot":"","sources":["../../../src/plugins/shaping/unirate.ts"],"names":[],"mappings":";;;AAAA,6BAAmC;AACnC,2CAAiE;AAIjE,MAAM,eAAe,GAAG;IACtB;;OAEG;IACH,cAAc,EAAE,QAAQ;IAExB;;OAEG;IACH,UAAU,EAAE,CAAC;CACd,CAAC;AA8BF;;;GAGG;AACH,MAAa,qBAAqB;IAOhC,YAAY,OAA+C;QANlD,SAAI,GAAG,oBAAU,CAAC,cAAc,CAAC;QACjC,SAAI,GAAW,SAAS,CAAC;QAEjB,YAAO,GAAuC,IAAI,OAAO,EAAE,CAAC;QACrE,aAAQ,GAAG,KAAK,CAAC;QAGvB,IAAI,CAAC,OAAO,mCACP,eAAe,GACf,OAAO,CACX,CAAC;IACJ,CAAC;IAED,kBAAkB;IAClB,OAAO;QACL,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACD,aAAa;IAEb,MAAM,CAAC,IAAmB,EAAE,SAAiB;QAC3C,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,cAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC;SAC3D;QAED,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;YACjC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SAChC;QACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE;YAClC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACvE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC3B,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC3B,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;YACnB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;YAC7B,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC9B,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC5B,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC;aAC1B;SACF;QAED,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,QAAQ,EAAE;YAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,cAAU,CAAC,+BAA+B,IAAI,CAAC,OAAO,CAAC,cAAc,KAAK,CAAC,CAAC,CAAC;SACxG;QAED,MAAM,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;YACpC,MAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;YAC9B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACtB,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;gBAC9B,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACjB,MAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,cAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;oBACpG,MAAO,CAAC,KAAK,GAAG,EAAE,CAAC;oBACnB,aAAa,CAAC,MAAO,CAAC,KAAM,CAAC,CAAC;oBAC9B,MAAO,CAAC,KAAK,GAAG,SAAS,CAAC;oBAC1B,MAAO,CAAC,WAAW,GAAG,CAAC,CAAC;oBACxB,OAAO;iBACR;gBAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAO,CAAC,EAAE;oBAC3B,MAAO,CAAC,WAAW,IAAI,CAAC,CAAC;iBAC1B;qBAAM;oBACL,MAAO,CAAC,WAAW,GAAG,CAAC,CAAC;iBACzB;gBAED,IAAI,MAAO,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;oBACjD,aAAa,CAAC,MAAO,CAAC,KAAM,CAAC,CAAC;oBAC9B,MAAO,CAAC,KAAK,GAAG,SAAS,CAAC;iBAC3B;YACH,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;SAC7B;QAED,OAAO,KAAsB,CAAC;IAChC,CAAC;IAEO,QAAQ,CAAC,MAAkB;QACjC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACpC;;;WAGG;QACH,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QACxE,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,WAAW,CAAC,IAAmB,EAAE,SAAiB;QACxD,IAAI,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC/D,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;YAC7C,IAAI,IAAI,GAAG,GAAG,EAAE;gBACd,OAAO,IAAI,CAAC;aACb;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,CAAC,CAAC,CAAC;QAEN,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,QAAQ,GAAG,CAAC,EAAE;YAChB,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;YACxB,QAAQ,GAAG,CAAC,CAAC;SACd;aAAM;YACL,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACjC;QAED,OAAO;YACL,KAAK,EAAE,EAAE;YACT,QAAQ;YACR,IAAI;YACJ,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,QAAQ,CAAC,CAAC;YAC/E,WAAW,EAAE,CAAC;YACd,SAAS;SACV,CAAC;IACJ,CAAC;CACF;AAvHD,sDAuHC"}

package/@tencent/polaris/dist/plugins/shaping/warmup.d.ts

@@ -0,0 +1,61 @@
+import { PluginType, TrafficShapingPlugin } from "../../plugins";
+import { RatelimitRule } from "../../rules";
+declare const kDefaultOptions: {
+    /**
+     * 预热时间 (s)
+     */
+    warmTime: number;
+    /**
+     * 预警因子
+     * 需大于等于 2
+     */
+    warnFactor: number;
+    /**
+     * 空闲回收周期
+     */
+    idlePeriod: number;
+};
+export declare type WarmUpTrafficShapingOptions = typeof kDefaultOptions;
+/**
+ *
+ * 预热算法是一个另类的令牌桶算法，此算法实现（描述）了下述函数图像：
+ *
+ * ```
+ *             ^ 1/QPS
+ *             |
+ *   1/coldQPS +                   /
+ *             |                  / .
+ *             |                 /  .
+ *             |                /   .
+ *             |               /    .
+ *             |              /     .
+ *             |             /      .
+ *             |            /       .
+ *             |           /        .
+ * 1/stableQPS +----------/         .
+ *             |          .  Warm   .  ← `warmTime` = `warningTokens` 与 `maxTokens` 之间的面积
+ *             |          .  Time   .
+ *             |          .         .
+ *           0 +----------+---------+---------------→ currentTokens
+ *             0   warningTokens maxTokens
+ * ```
+ *
+ * 函数各变量满足如下关系：
+ * * coldQPS = stableQPS/warnFactor
+ * * (warningTokens/stableQPS)/(warmTime) = 1/(warnFactor-1)
+ */
+export declare class WarmUpTrafficShaping implements TrafficShapingPlugin {
+    readonly type = PluginType.TrafficShaping;
+    readonly name: string;
+    private readonly options;
+    private readonly buckets;
+    private disposed;
+    constructor(options?: Partial<WarmUpTrafficShapingOptions>);
+    dispose(): void;
+    get isDisposed(): boolean;
+    inFlow(rule: RatelimitRule, partition: number): Promise<void>;
+    private timerTask;
+    private calculateQPS;
+    private buildBucket;
+}
+export {};

package/@tencent/polaris/dist/plugins/shaping/warmup.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WarmUpTrafficShaping = void 0;
+const __1 = require("../..");
+const plugins_1 = require("../../plugins");
+const utils_1 = require("../../utils");
+const kDefaultOptions = {
+    /**
+     * 预热时间 (s)
+     */
+    warmTime: 10,
+    /**
+     * 预警因子
+     * 需大于等于 2
+     */
+    warnFactor: 3,
+    /**
+     * 空闲回收周期
+     */
+    idlePeriod: 3
+};
+/**
+ *
+ * 预热算法是一个另类的令牌桶算法，此算法实现（描述）了下述函数图像：
+ *
+ * ```
+ *             ^ 1/QPS
+ *             |
+ *   1/coldQPS +                   /
+ *             |                  / .
+ *             |                 /  .
+ *             |                /   .
+ *             |               /    .
+ *             |              /     .
+ *             |             /      .
+ *             |            /       .
+ *             |           /        .
+ * 1/stableQPS +----------/         .
+ *             |          .  Warm   .  ← `warmTime` = `warningTokens` 与 `maxTokens` 之间的面积
+ *             |          .  Time   .
+ *             |          .         .
+ *           0 +----------+---------+---------------→ currentTokens
+ *             0   warningTokens maxTokens
+ * ```
+ *
+ * 函数各变量满足如下关系：
+ * * coldQPS = stableQPS/warnFactor
+ * * (warningTokens/stableQPS)/(warmTime) = 1/(warnFactor-1)
+ */
+class WarmUpTrafficShaping {
+    constructor(options) {
+        this.type = plugins_1.PluginType.TrafficShaping;
+        this.name = "warmup";
+        this.buckets = new WeakMap();
+        this.disposed = false;
+        this.options = Object.assign(Object.assign({}, kDefaultOptions), options);
+    }
+    // #region dispose
+    dispose() {
+        this.disposed = true;
+    }
+    get isDisposed() {
+        return this.disposed;
+    }
+    // #endregion
+    inFlow(rule, partition) {
+        if (this.disposed) {
+            return Promise.reject(new __1.StateError("Already disposed"));
+        }
+        let bucket = this.buckets.get(rule);
+        if (typeof bucket === "undefined") {
+            bucket = this.buildBucket(rule, partition);
+            this.buckets.set(rule, bucket);
+        }
+        if (bucket.partition !== partition) { /** few case */
+            const { maxTokens, remainingTokens, warningTokens, stableQPS, remainingQPS, coldQPS, slope } = this.buildBucket(rule, partition);
+            bucket.maxTokens = maxTokens;
+            bucket.warningTokens = warningTokens;
+            bucket.stableQPS = stableQPS;
+            bucket.coldQPS = coldQPS;
+            bucket.slope = slope;
+            bucket.remainingTokens = remainingTokens;
+            bucket.remainingQPS = remainingQPS - bucket.usedQPS;
+            if (bucket.remainingQPS < 0) {
+                bucket.remainingQPS = 0;
+                bucket.usedQPS = remainingQPS;
+            }
+            bucket.partition = partition;
+        }
+        if (bucket.timer === undefined) {
+            bucket.timer = setInterval(() => {
+                if (bucket === undefined) {
+                    (0, utils_1.UNREACHABLE)();
+                }
+                if (this.disposed) {
+                    clearInterval(bucket.timer);
+                    bucket.timer = undefined;
+                    return;
+                }
+                this.timerTask(bucket);
+                /**
+                 * 与初始状态相同时，可进入休眠
+                 */
+                if (bucket.remainingTokens === bucket.maxTokens) {
+                    bucket.sleepPeriod += 1;
+                }
+                else {
+                    bucket.sleepPeriod = 0;
+                }
+                if (bucket.sleepPeriod > this.options.idlePeriod) {
+                    clearInterval(bucket.timer);
+                    bucket.timer = undefined;
+                }
+            }, 1 * utils_1.kSeconds).unref();
+        }
+        if (bucket.remainingQPS >= 1) {
+            bucket.remainingQPS -= 1;
+            bucket.usedQPS += 1;
+            return Promise.resolve();
+        }
+        return Promise.reject(new __1.StateError("[plugin] [warmup], quota is limited"));
+    }
+    timerTask(bucket) {
+        const { remainingTokens, warningTokens, stableQPS, coldQPS, usedQPS, slope } = bucket;
+        if (remainingTokens < warningTokens /** 服务实例处于 "热" 状态 */
+            || (remainingTokens > warningTokens && usedQPS < coldQPS) /** 服务实例处于 "冷" 状态，并且当前一秒的 QPS 小于 `coldQPS` */) {
+            // 增加 stableQPS 个 tokens，但总数不能超过 maxTokens
+            bucket.remainingTokens += stableQPS;
+            if (bucket.remainingTokens > bucket.maxTokens) {
+                bucket.remainingTokens = bucket.maxTokens;
+            }
+        }
+        bucket.remainingTokens -= usedQPS;
+        bucket.usedQPS = 0;
+        bucket.remainingQPS = this.calculateQPS(slope, warningTokens, bucket.remainingTokens, stableQPS);
+    }
+    calculateQPS(slope, warningTokens, remainingTokens, stableQPS) {
+        if (remainingTokens <= warningTokens) {
+            return stableQPS;
+        }
+        return stableQPS / (1 + (slope * stableQPS * (remainingTokens - warningTokens)));
+    }
+    buildBucket(rule, partition) {
+        // 取 rules 中最小的 qps 作为 stableQPS
+        const stableQPS = rule.amounts.reduce((acc, { amount, duration }) => {
+            const qps = (amount / partition) / (duration / utils_1.kSeconds);
+            if (qps < acc) {
+                return qps;
+            }
+            return acc;
+        }, Infinity);
+        const coldQPS = stableQPS / this.options.warnFactor;
+        const warningTokens = stableQPS * (this.options.warmTime / (this.options.warnFactor - 1));
+        const maxTokens = warningTokens + ((2 * this.options.warmTime) / ((1 / stableQPS) + (1 / coldQPS)));
+        const slope = ((1 / coldQPS) - (1 / stableQPS)) / (maxTokens - warningTokens);
+        return {
+            remainingTokens: maxTokens,
+            warningTokens,
+            maxTokens,
+            remainingQPS: this.calculateQPS(slope, warningTokens, maxTokens, stableQPS),
+            usedQPS: 0,
+            coldQPS,
+            stableQPS,
+            slope,
+            partition,
+            sleepPeriod: 0
+        };
+    }
+}
+exports.WarmUpTrafficShaping = WarmUpTrafficShaping;
+//# sourceMappingURL=warmup.js.map

package/@tencent/polaris/dist/plugins/shaping/warmup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"warmup.js","sourceRoot":"","sources":["../../../src/plugins/shaping/warmup.ts"],"names":[],"mappings":";;;AAAA,6BAAmC;AACnC,2CAAiE;AAEjE,uCAAoD;AAEpD,MAAM,eAAe,GAAG;IACtB;;OAEG;IACH,QAAQ,EAAE,EAAE;IAEZ;;;OAGG;IACH,UAAU,EAAE,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,CAAC;CACd,CAAC;AA2BF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,oBAAoB;IAO/B,YAAY,OAA8C;QANjD,SAAI,GAAG,oBAAU,CAAC,cAAc,CAAC;QACjC,SAAI,GAAW,QAAQ,CAAC;QAEhB,YAAO,GAAuC,IAAI,OAAO,EAAE,CAAC;QACrE,aAAQ,GAAG,KAAK,CAAC;QAGvB,IAAI,CAAC,OAAO,mCACP,eAAe,GACf,OAAO,CACX,CAAC;IACJ,CAAC;IAED,kBAAkB;IAClB,OAAO;QACL,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACD,aAAa;IAEb,MAAM,CAAC,IAAmB,EAAE,SAAiB;QAC3C,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,cAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC;SAC3D;QAED,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;YACjC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SAChC;QACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,EAAE,eAAe;YACnD,MAAM,EACJ,SAAS,EAAE,eAAe,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EACnF,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACtC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;YAC7B,MAAM,CAAC,aAAa,GAAG,aAAa,CAAC;YACrC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;YAC7B,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;YACzB,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;YACrB,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC;YACzC,MAAM,CAAC,YAAY,GAAG,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC;YACpD,IAAI,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE;gBAC3B,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;gBACxB,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC;aAC/B;YACD,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;SAC9B;QAED,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;YAC9B,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;gBAC9B,IAAI,MAAM,KAAK,SAAS,EAAE;oBACxB,IAAA,mBAAW,GAAE,CAAC;iBACf;gBAED,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACjB,aAAa,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC;oBAC7B,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC;oBACzB,OAAO;iBACR;gBAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAEvB;;mBAEG;gBACH,IAAI,MAAM,CAAC,eAAe,KAAK,MAAM,CAAC,SAAS,EAAE;oBAC/C,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;iBACzB;qBAAM;oBACL,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC;iBACxB;gBAED,IAAI,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;oBAChD,aAAa,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC;oBAC7B,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC;iBAC1B;YACH,CAAC,EAAE,CAAC,GAAG,gBAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;SAC1B;QAED,IAAI,MAAM,CAAC,YAAY,IAAI,CAAC,EAAE;YAC5B,MAAM,CAAC,YAAY,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;YACpB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,cAAU,CAAC,qCAAqC,CAAC,CAAC,CAAC;IAC/E,CAAC;IAEO,SAAS,CAAC,MAAkB;QAClC,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACtF,IACE,eAAe,GAAG,aAAa,CAAC,oBAAoB;eACjD,CAAC,eAAe,GAAG,aAAa,IAAI,OAAO,GAAG,OAAO,CAAC,CAAC,6CAA6C,EACvG;YACA,0CAA0C;YAC1C,MAAM,CAAC,eAAe,IAAI,SAAS,CAAC;YACpC,IAAI,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,SAAS,EAAE;gBAC7C,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC;aAC3C;SACF;QACD,MAAM,CAAC,eAAe,IAAI,OAAO,CAAC;QAClC,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC;QACnB,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IACnG,CAAC;IAEO,YAAY,CAAC,KAAa,EAAE,aAAqB,EAAE,eAAuB,EAAE,SAAiB;QACnG,IAAI,eAAe,IAAI,aAAa,EAAE;YACpC,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,SAAS,GAAG,CAAC,eAAe,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IACnF,CAAC;IAEO,WAAW,CAAC,IAAmB,EAAE,SAAiB;QACxD,gCAAgC;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE;YAClE,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,GAAG,gBAAQ,CAAC,CAAC;YACzD,IAAI,GAAG,GAAG,GAAG,EAAE;gBACb,OAAO,GAAG,CAAC;aACZ;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,QAAQ,CAAC,CAAC;QACb,MAAM,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;QACpD,MAAM,aAAa,GAAG,SAAS,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1F,MAAM,SAAS,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACpG,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,SAAS,GAAG,aAAa,CAAC,CAAC;QAE9E,OAAO;YACL,eAAe,EAAE,SAAS;YAC1B,aAAa;YACb,SAAS;YACT,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,CAAC;YAC3E,OAAO,EAAE,CAAC;YACV,OAAO;YACP,SAAS;YACT,KAAK;YACL,SAAS;YACT,WAAW,EAAE,CAAC;SACf,CAAC;IACJ,CAAC;CACF;AA7ID,oDA6IC"}

package/@tencent/polaris/dist/plugins/weight/polaris.d.ts

@@ -0,0 +1,23 @@
+import { ComputedStat } from "../../consumer";
+import { Instance } from "../../instance";
+import { PluginType, WeightAdjusterPlugin } from "../../plugins";
+declare const kDefaultOptions: {
+    /**
+     * 成功率倍率
+     */
+    okRatio: number;
+    /**
+     * 延迟倍率
+     */
+    delayRatio: number;
+};
+export declare type PolarisDynamicWeightOptions = typeof kDefaultOptions;
+export declare class PolarisDynamicWeight implements WeightAdjusterPlugin {
+    readonly type = PluginType.WeightAdjuster;
+    readonly name: string;
+    private previous;
+    private readonly options;
+    constructor(options?: Partial<PolarisDynamicWeightOptions>);
+    adjust(namespace: string, service: string, instances: Instance[], { statWindow, summaryStat }: ComputedStat): void;
+}
+export {};

package/@tencent/polaris/dist/plugins/weight/polaris.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolarisDynamicWeight = void 0;
+const plugins_1 = require("../../plugins");
+const utils_1 = require("../../utils");
+const kMaxEstCalls = 2000;
+const kDefaultOptions = {
+    /**
+     * 成功率倍率
+     */
+    okRatio: 7,
+    /**
+     * 延迟倍率
+     */
+    delayRatio: 3
+};
+const mergeDimensions = (computed) => {
+    const mergedStat = new Map();
+    computed.forEach((stat, instance) => {
+        let errCalls = 0;
+        let succCalls = 0;
+        let succDelay = 0;
+        stat.forEach(({ cost, count }, { success }) => {
+            if (success) {
+                succCalls += count;
+                succDelay += cost;
+            }
+            else {
+                errCalls += count;
+            }
+        });
+        mergedStat.set(instance, { errCalls, succCalls, succDelay });
+    });
+    return mergedStat;
+};
+class PolarisDynamicWeight {
+    constructor(options) {
+        this.type = plugins_1.PluginType.WeightAdjuster;
+        this.name = "PolarisDynamicWeight";
+        this.previous = Object.create(null);
+        this.options = Object.assign(Object.assign({}, kDefaultOptions), options);
+    }
+    adjust(namespace, service, instances, { statWindow, summaryStat }) {
+        let minDelay = Infinity;
+        let maxRate = 0;
+        let maxWeight = 0;
+        let sumLoad = 0;
+        let minWeight = Infinity;
+        const secondsRatio = statWindow / utils_1.kSeconds;
+        /**
+         * 无法计算权重的实例（没有至少一次的成功调用）
+         */
+        const skippedInstances = [];
+        /**
+         * 合并后的调用数据（合并未使用维度）
+         */
+        const mergedStat = mergeDimensions(summaryStat);
+        // #region Round 1
+        /*
+         * Round 1:
+         *  找到服务下各节点的元数据：
+         *    * `minDelay`: 最小延迟
+         *    * `maxRate`: 最大成功率
+         *    * `maxWeight`: 最大静态权重
+         */
+        mergedStat.forEach((stat, instance) => {
+            const { errCalls, succCalls, succDelay } = stat;
+            if (!(succCalls > 0)) {
+                skippedInstances.push(instance);
+                return;
+            }
+            const avgDelay = succDelay / succCalls;
+            if (avgDelay < minDelay) {
+                minDelay = avgDelay;
+            }
+            const okRate = succCalls / (succCalls + errCalls);
+            if (okRate > maxRate) {
+                maxRate = okRate;
+            }
+            if (instance.staticWeight > maxWeight) {
+                maxWeight = instance.staticWeight;
+            }
+        });
+        // #endregion
+        // #region Round 2
+        /*
+         * Round 2:
+         *  通过各节点的元数据，计算负载值 `load(k)`
+         */
+        const loadInfo = new Map();
+        mergedStat.forEach((stat, instance) => {
+            const { errCalls, succCalls, succDelay } = stat;
+            if (!(succCalls > 0)) {
+                return;
+            }
+            const okRate = succCalls / (succCalls + errCalls);
+            const delayLoad = ((succDelay / succCalls) / minDelay) || 0 /** NaN ===> 0 */;
+            const okLoad = maxRate / okRate;
+            const weightLoad = maxWeight / instance.staticWeight;
+            const load = ((delayLoad * this.options.delayRatio) + (okLoad * this.options.okRatio)) * weightLoad;
+            sumLoad += 1 / load;
+            loadInfo.set(instance, load);
+        });
+        // #endregion
+        // #region Round 3
+        /*
+         * Round 3:
+         *  通过负载值 `load(k)` 与 `estCalls` 计算各节点动态权重，并统计最小权重 `minWeight`
+         *  `estCalls` ∈ [有效节点数, `kMaxEstCalls`]
+         */
+        const latestStat = new WeakMap();
+        const prevStat = this.previous[`${namespace}.${service}`];
+        mergedStat.forEach((stat, instance) => {
+            const { errCalls, succCalls } = stat;
+            if (!(succCalls > 0)) {
+                return;
+            }
+            let prevCalls;
+            if (prevStat) {
+                prevCalls = prevStat.get(instance) || 0;
+            }
+            else {
+                prevCalls = instances.length;
+            }
+            const currCalls = succCalls + errCalls;
+            let nextCalls = (2 * currCalls) - prevCalls; /** est_call_num(t+1) = call_num(t) + (call_num(t)-call_num(t-1)) */
+            if (nextCalls > kMaxEstCalls) {
+                nextCalls = kMaxEstCalls;
+            }
+            else if (nextCalls < instances.length) {
+                nextCalls = instances.length;
+            }
+            const callsPerSecond = nextCalls / secondsRatio;
+            let dynamicWeight = Math.floor((callsPerSecond * (1 / loadInfo.get(instance) / sumLoad)) + 0.5);
+            /**
+             * 如动态权重计算结果为无穷数，则设置动态权重为最大静态权重
+             */
+            dynamicWeight = Number.isFinite(dynamicWeight) ? dynamicWeight : maxWeight;
+            instance.dynamicWeight = dynamicWeight;
+            if (dynamicWeight < minWeight) {
+                minWeight = dynamicWeight;
+            }
+            latestStat.set(instance, currCalls);
+        });
+        this.previous[`${namespace}.${service}`] = latestStat;
+        // #endregion
+        // #region Round 4
+        /*
+         * Round 4:
+         *  设置 _无法计算权重的实例_ 的动态权重为：`min(min_weight, 实例当前动态权重值)`;
+         */
+        skippedInstances.forEach((instance) => {
+            instance.dynamicWeight = Math.min(minWeight, instance.dynamicWeight);
+        });
+        // #endregion
+    }
+}
+exports.PolarisDynamicWeight = PolarisDynamicWeight;
+//# sourceMappingURL=polaris.js.map

package/@tencent/polaris/dist/plugins/weight/polaris.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polaris.js","sourceRoot":"","sources":["../../../src/plugins/weight/polaris.ts"],"names":[],"mappings":";;;AAEA,2CAAiE;AACjE,uCAAuC;AAEvC,MAAM,YAAY,GAAG,IAAK,CAAC;AAE3B,MAAM,eAAe,GAAG;IACtB;;OAEG;IACH,OAAO,EAAE,CAAC;IAEV;;OAEG;IACH,UAAU,EAAE,CAAC;CACd,CAAC;AAIF,MAAM,eAAe,GAAG,CAAC,QAAqC,EAAE,EAAE;IAChE,MAAM,UAAU,GAAG,IAAI,GAAG,EAItB,CAAC;IAEL,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;QAClC,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;YAC5C,IAAI,OAAO,EAAE;gBACX,SAAS,IAAI,KAAK,CAAC;gBACnB,SAAS,IAAI,IAAI,CAAC;aACnB;iBAAM;gBACL,QAAQ,IAAI,KAAK,CAAC;aACnB;QACH,CAAC,CAAC,CAAC;QACH,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAa,oBAAoB;IAM/B,YAAY,OAA8C;QALjD,SAAI,GAAG,oBAAU,CAAC,cAAc,CAAC;QACjC,SAAI,GAAW,sBAAsB,CAAC;QACvC,aAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAuD,CAAC;QAI3F,IAAI,CAAC,OAAO,mCACP,eAAe,GACf,OAAO,CACX,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,SAAiB,EAAE,OAAe,EAAE,SAAqB,EAAE,EAAE,UAAU,EAAE,WAAW,EAAgB;QACzG,IAAI,QAAQ,GAAG,QAAQ,CAAC;QACxB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,SAAS,GAAG,QAAQ,CAAC;QACzB,MAAM,YAAY,GAAG,UAAU,GAAG,gBAAQ,CAAC;QAE3C;;WAEG;QACH,MAAM,gBAAgB,GAAe,EAAE,CAAC;QAExC;;WAEG;QACH,MAAM,UAAU,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;QAEhD,kBAAkB;QAClB;;;;;;WAMG;QACH,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YACpC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;YAEhD,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE;gBACpB,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAChC,OAAO;aACR;YAED,MAAM,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;YACvC,IAAI,QAAQ,GAAG,QAAQ,EAAE;gBACvB,QAAQ,GAAG,QAAQ,CAAC;aACrB;YAED,MAAM,MAAM,GAAG,SAAS,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC;YAClD,IAAI,MAAM,GAAG,OAAO,EAAE;gBACpB,OAAO,GAAG,MAAM,CAAC;aAClB;YAED,IAAI,QAAQ,CAAC,YAAY,GAAG,SAAS,EAAE;gBACrC,SAAS,GAAG,QAAQ,CAAC,YAAY,CAAC;aACnC;QACH,CAAC,CAAC,CAAC;QACH,aAAa;QAEb,kBAAkB;QAClB;;;WAGG;QACH,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC7C,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YACpC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;YAEhD,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE;gBACpB,OAAO;aACR;YAED,MAAM,MAAM,GAAG,SAAS,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA,iBAAiB,CAAC;YAC7E,MAAM,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;YAChC,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC,YAAY,CAAC;YACrD,MAAM,IAAI,GAAG,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,UAAU,CAAC;YAEpG,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC;YACpB,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,aAAa;QAEb,kBAAkB;QAClB;;;;WAIG;QACH,MAAM,UAAU,GAAG,IAAI,OAAO,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,SAAS,IAAI,OAAO,EAAE,CAAC,CAAC;QAC1D,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YACpC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;YAErC,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE;gBACpB,OAAO;aACR;YAED,IAAI,SAAS,CAAC;YACd,IAAI,QAAQ,EAAE;gBACZ,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACzC;iBAAM;gBACL,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;aAC9B;YAED,MAAM,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;YACvC,IAAI,SAAS,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC,oEAAoE;YAEjH,IAAI,SAAS,GAAG,YAAY,EAAE;gBAC5B,SAAS,GAAG,YAAY,CAAC;aAC1B;iBAAM,IAAI,SAAS,GAAG,SAAS,CAAC,MAAM,EAAE;gBACvC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;aAC9B;YAED,MAAM,cAAc,GAAG,SAAS,GAAG,YAAY,CAAC;YAChD,IAAI,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAE,GAAG,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;YACjG;;eAEG;YACH,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAE3E,QAAQ,CAAC,aAAa,GAAG,aAAa,CAAC;YACvC,IAAI,aAAa,GAAG,SAAS,EAAE;gBAC7B,SAAS,GAAG,aAAa,CAAC;aAC3B;YAED,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,GAAG,SAAS,IAAI,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC;QACtD,aAAa;QAEb,kBAAkB;QAClB;;;WAGG;QACH,gBAAgB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACpC,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,aAAa;IACf,CAAC;CACF;AAjJD,oDAiJC"}