@tencent-rtc/mcp 1.0.0

package/@tencent/polaris/dist/logging.d.ts

@@ -0,0 +1,106 @@
+import { TraceLoggingPlugin } from "./plugins";
+export declare enum LogVerbosity {
+    NONE = 0,
+    ERROR = 1,
+    INFO = 2,
+    DEBUG = 3
+}
+export declare const enum TraceCategory {
+    Plugins = "Plugins",
+    Consumer = "Consumer",
+    Provider = "Provider",
+    Limiter = "Limiter"
+}
+/**
+ * 1. background: 日志信息的获取与组装一般较为消耗性能。
+ * 2. case: 在正式环境中，一般配置的日志级别较高（≥ ERROR），组装好的日志最终由于级别不足而未输出。
+ * 3. optimization: 将耗时的处理过程（日志获取与组装）包装在闭包内，仅在最终确定需要输出（日志级别满足）时才执行，以优化性能。
+ */
+export declare type LoggingFunc = (logging: (message?: unknown, ...optionalParams: unknown[]) => void) => void;
+declare const kDefaultOptions: {
+    /**
+     * 日志级别
+     */
+    logVerbosity: LogVerbosity;
+    /**
+     * 跟踪日志开关环境变量名
+     */
+    tracingEnv: string;
+    /**
+     * 日志级别环境变量名
+     */
+    verbosityEnv: string;
+    /**
+     * 日志前缀
+     * 不影响跟踪日志
+     */
+    prefix: unknown;
+};
+export declare type LoggerOptions = typeof kDefaultOptions;
+export declare type Logger = Required<DefaultLogger>;
+export declare class DefaultLogger {
+    private readonly loggers;
+    tracingEnabled: boolean;
+    private readonly options;
+    private transactionId;
+    constructor(loggers: TraceLoggingPlugin[], options?: Partial<LoggerOptions>);
+    /**
+     * 开启追踪日志
+     */
+    enableTracing(): void;
+    /**
+     * 关闭追踪日志
+     */
+    disableTracing(): void;
+    /**
+     * 跟踪 ID 生成器
+     * 每次取值均不重复
+     */
+    get transaction(): string;
+    /**
+     * 跟踪日志
+     * @param category 类别
+     * @param klass 类名
+     * @param method 方法名
+     * @param transaction 跟踪 ID
+     * @param message 日志内容（可选）
+     * @param optionalParams 附加参数
+     */
+    trace(category: TraceCategory, klass: string, method: string, transaction?: unknown, message?: unknown, ...optionalParams: unknown[]): void;
+    setVerbosity(verbosity: LogVerbosity): void;
+    /**
+     * 输出 debug 级别日志
+     * @param logging 日志生成函数
+     */
+    debug(logging: LoggingFunc): void;
+    /**
+     * 输出 debug 级别日志
+     * @param message 日志内容（可选）
+     * @param optionalParams 附加参数
+     */
+    debug(message?: unknown, ...optionalParams: unknown[]): void;
+    /**
+     * 输出 info 级别日志
+     * @param logging 日志生成函数
+     */
+    info(logging: LoggingFunc): void;
+    /**
+     * 输出 info 级别日志
+     * @param message 日志内容（可选）
+     * @param optionalParams 附加参数
+     */
+    info(message?: unknown, ...optionalParams: unknown[]): void;
+    /**
+     * 输出 error 级别日志
+     * @param logging 日志生成函数
+     */
+    error(logging: LoggingFunc): void;
+    /**
+     * 输出 error 级别日志
+     * @param message 日志内容（可选）
+     * @param optionalParams 附加参数
+     */
+    error(message?: unknown, ...optionalParams: unknown[]): void;
+    private log;
+}
+export {};

package/@tencent/polaris/dist/logging.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultLogger = exports.LogVerbosity = void 0;
+const utils_1 = require("./utils");
+var LogVerbosity;
+(function (LogVerbosity) {
+    LogVerbosity[LogVerbosity["NONE"] = 0] = "NONE";
+    LogVerbosity[LogVerbosity["ERROR"] = 1] = "ERROR";
+    LogVerbosity[LogVerbosity["INFO"] = 2] = "INFO";
+    LogVerbosity[LogVerbosity["DEBUG"] = 3] = "DEBUG";
+})(LogVerbosity = exports.LogVerbosity || (exports.LogVerbosity = {}));
+const isLoggingFunc = (arg) => typeof arg === "function";
+const kDefaultOptions = {
+    /**
+     * 日志级别
+     */
+    logVerbosity: LogVerbosity.ERROR,
+    /**
+     * 跟踪日志开关环境变量名
+     */
+    tracingEnv: "POLARIS_LOGGING_TRACING",
+    /**
+     * 日志级别环境变量名
+     */
+    verbosityEnv: "POLARIS_LOGGING_VERBOSITY",
+    /**
+     * 日志前缀
+     * 不影响跟踪日志
+     */
+    prefix: `[${utils_1.kModuleName}@${utils_1.kModuleVersion}]`
+};
+class DefaultLogger {
+    constructor(loggers, options) {
+        this.loggers = loggers;
+        this.tracingEnabled = false;
+        this.transactionId = 0;
+        this.options = Object.assign(Object.assign({}, kDefaultOptions), options);
+        /**
+         * 配置优先级大于环境变量
+         */
+        if ((options === null || options === void 0 ? void 0 : options.logVerbosity) === undefined) {
+            const verbosity = process.env[this.options.verbosityEnv];
+            if (typeof verbosity === "string") {
+                const severity = LogVerbosity[verbosity];
+                switch (typeof severity) {
+                    case "string": {
+                        this.options.logVerbosity = LogVerbosity[severity];
+                        break;
+                    }
+                    case "number": {
+                        this.options.logVerbosity = severity;
+                        break;
+                    }
+                    default: {
+                        break;
+                    }
+                }
+            }
+        }
+        if ((0, utils_1.on)(process.env[this.options.tracingEnv])) {
+            this.tracingEnabled = true;
+        }
+    }
+    // #region tracing
+    /**
+     * 开启追踪日志
+     */
+    enableTracing() {
+        this.tracingEnabled = true;
+    }
+    /**
+     * 关闭追踪日志
+     */
+    disableTracing() {
+        this.tracingEnabled = false;
+    }
+    /**
+     * 跟踪 ID 生成器
+     * 每次取值均不重复
+     */
+    get transaction() {
+        if (this.tracingEnabled) {
+            return (this.transactionId++).toString(); // eslint-disable-line no-plusplus
+        }
+        return "";
+    }
+    /**
+     * 跟踪日志
+     * @param category 类别
+     * @param klass 类名
+     * @param method 方法名
+     * @param transaction 跟踪 ID
+     * @param message 日志内容（可选）
+     * @param optionalParams 附加参数
+     */
+    trace(category, klass, method, transaction, message, ...optionalParams) {
+        if (this.tracingEnabled) {
+            const { loggers } = this;
+            const tracer = `Polaris::${category}:${klass}.${method}`;
+            loggers.forEach(logger => process.nextTick(logger.trace.bind(logger), tracer, transaction, message, ...optionalParams));
+        }
+    }
+    // #endregion
+    // #region log
+    setVerbosity(verbosity) {
+        this.options.logVerbosity = verbosity;
+    }
+    debug(message, ...optionalParams) {
+        this.log(LogVerbosity.DEBUG, message, optionalParams);
+    }
+    info(message, ...optionalParams) {
+        this.log(LogVerbosity.INFO, message, optionalParams);
+    }
+    error(message, ...optionalParams) {
+        this.log(LogVerbosity.ERROR, message, optionalParams);
+    }
+    log(severity, message, ...optionalParams) {
+        if (severity <= this.options.logVerbosity) {
+            const { loggers, options: { prefix } } = this;
+            if (optionalParams.length === 1 && isLoggingFunc(message)) {
+                loggers.forEach(logger => process.nextTick(message, logger.log.bind(logger, severity, prefix)));
+            }
+            else {
+                loggers.forEach(logger => process.nextTick(logger.log.bind(logger), severity, prefix, message, ...optionalParams));
+            }
+        }
+    }
+}
+exports.DefaultLogger = DefaultLogger;
+//# sourceMappingURL=logging.js.map

package/@tencent/polaris/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;;AACA,mCAA0D;AAE1D,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,+CAAQ,CAAA;IACR,iDAAK,CAAA;IACL,+CAAI,CAAA;IACJ,iDAAK,CAAA;AACP,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAUD,MAAM,aAAa,GAAG,CAAC,GAAY,EAAsB,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,CAAC;AAStF,MAAM,eAAe,GAAG;IACtB;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,KAAK;IAEhC;;OAEG;IACH,UAAU,EAAE,yBAAyB;IAErC;;OAEG;IACH,YAAY,EAAE,2BAA2B;IAEzC;;;OAGG;IACH,MAAM,EAAE,IAAI,mBAAW,IAAI,sBAAc,GAAc;CACxD,CAAC;AAMF,MAAa,aAAa;IAKxB,YACmB,OAA6B,EAC9C,OAAgC;QADf,YAAO,GAAP,OAAO,CAAsB;QALhD,mBAAc,GAAG,KAAK,CAAC;QAEf,kBAAa,GAAG,CAAC,CAAC;QAMxB,IAAI,CAAC,OAAO,mCACP,eAAe,GACf,OAAO,CACX,CAAC;QAEF;;WAEG;QACH,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,MAAK,SAAS,EAAE;YACvC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YACzD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;gBACjC,MAAM,QAAQ,GAAsC,YAAY,CAAC,SAA6B,CAAC,CAAC;gBAChG,QAAQ,OAAO,QAAQ,EAAE;oBACvB,KAAK,QAAQ,CAAC,CAAC;wBACb,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,YAAY,CAAC,QAAqC,CAAC,CAAC;wBAChF,MAAM;qBACP;oBACD,KAAK,QAAQ,CAAC,CAAC;wBACb,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,QAAQ,CAAC;wBACrC,MAAM;qBACP;oBACD,OAAO,CAAC,CAAC;wBACP,MAAM;qBACP;iBACF;aACF;SACF;QAED,IAAI,IAAA,UAAE,EAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE;YAC5C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;SAC5B;IACH,CAAC;IAED,kBAAkB;IAClB;;OAEG;IACH,aAAa;QACX,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,kCAAkC;SAC7E;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CACH,QAAuB,EACvB,KAAa,EACb,MAAc,EACd,WAAqB,EACrB,OAAiB,EAAE,GAAG,cAAyB;QAE/C,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACzB,MAAM,MAAM,GAAG,YAAY,QAAQ,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;YAEzD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CACxC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,cAAc,CAC3E,CAAC,CAAC;SACJ;IACH,CAAC;IACD,aAAa;IAEb,cAAc;IACd,YAAY,CAAC,SAAuB;QAClC,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IACxC,CAAC;IAaD,KAAK,CAAC,OAAiB,EAAE,GAAG,cAAyB;QACnD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAaD,IAAI,CAAC,OAAiB,EAAE,GAAG,cAAyB;QAClD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC;IAaD,KAAK,CAAC,OAAiB,EAAE,GAAG,cAAyB;QACnD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAEO,GAAG,CAAC,QAAsB,EAAE,OAAiB,EAAE,GAAG,cAAyB;QACjF,IAAI,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;YACzC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC;YAC9C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE;gBACzD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;aACjG;iBAAM;gBACL,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CACxC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CACtE,CAAC,CAAC;aACJ;SACF;IACH,CAAC;CAEF;AA9JD,sCA8JC"}

package/@tencent/polaris/dist/metadata.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 元数据
+ */
+export declare type Metadata = Record<string, string>;
+/**
+ * 元数据匹配条件，实际值来源
+ */
+export declare enum MetadataDynamicValueSource {
+    /**
+     * 来源于 `Payload` 字段
+     */
+    Payload = 0,
+    /**
+     * 来源于请求传入的值
+     */
+    Parameter = 1,
+    /**
+     * 来源于配置或环境变量中获取的值
+     */
+    Variable = 2
+}
+/**
+ * 元数据匹配条件
+ */
+export declare type MetadataDynamicValue = {
+    /**
+     * 实际值来源
+     */
+    source: MetadataDynamicValueSource.Payload | MetadataDynamicValueSource.Variable;
+    /**
+     * 换取实际值所需信息
+     */
+    payload: string | RegExp;
+} | {
+    /**
+     * 实际值来源
+     */
+    source: MetadataDynamicValueSource.Parameter;
+};
+/**
+ * @deprecated 使用 MetadataDynamicValue 替代
+ */
+export declare type MetadataDeprecatedValue = string | RegExp;
+/**
+ * 元数据匹配条件
+ */
+export declare type MetadataCondition = Record<string, MetadataDeprecatedValue | MetadataDynamicValue>;
+/**
+ * 判断两个元数据是否匹配条件
+ *
+ * @param val 元数据
+ * @param cond 元数据匹配条件
+ * @param variables 变量列表
+ * @param parameters 参数列表
+ * @returns 是否匹配
+ */
+export declare function isMetadataMatch(val: Metadata, cond: MetadataCondition, variables: Record<string, string>, parameters: Record<string, string>): boolean;
+/**
+ * 判断两个元数据是否匹配条件
+ *
+ * @param val 元数据
+ * @param cond 元数据匹配条件
+ * @param variables 变量列表
+ * @returns 如不匹配返回 `false`，否则返回所匹配到的参数列表
+ */
+export declare function isMetadataMatch(val: Metadata, cond: MetadataCondition, variables: Record<string, string>): Record<string, string> | false;
+/**
+ * 判断元数据是否为空
+ * @param metadata 元数据
+ */
+export declare function isEmptyMetadata(metadata: Metadata): boolean;
+/**
+ * 找到两个元数据相交的部分
+ * @param a 元数据 A
+ * @param b 元数据 B
+ * @returns 交集
+ */
+export declare function intersectionMetadata(a: Metadata, b: Metadata): Metadata;

package/@tencent/polaris/dist/metadata.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.intersectionMetadata = exports.isEmptyMetadata = exports.isMetadataMatch = exports.MetadataDynamicValueSource = void 0;
+const errors_1 = require("./errors");
+const utils_1 = require("./utils");
+// #region MedataCondition
+/**
+ * 元数据匹配条件，实际值来源
+ */
+var MetadataDynamicValueSource;
+(function (MetadataDynamicValueSource) {
+    /**
+     * 来源于 `Payload` 字段
+     */
+    MetadataDynamicValueSource[MetadataDynamicValueSource["Payload"] = 0] = "Payload";
+    /**
+     * 来源于请求传入的值
+     */
+    MetadataDynamicValueSource[MetadataDynamicValueSource["Parameter"] = 1] = "Parameter";
+    /**
+     * 来源于配置或环境变量中获取的值
+     */
+    MetadataDynamicValueSource[MetadataDynamicValueSource["Variable"] = 2] = "Variable";
+})(MetadataDynamicValueSource = exports.MetadataDynamicValueSource || (exports.MetadataDynamicValueSource = {}));
+// #endregion
+// #region isMetadataMatch
+const isContainsPairs = (dict, key, value) => Object.keys(dict).some(name => key.test(name) && dict[name] === value);
+function isMetadataMatch(val, cond, variables, parameters) {
+    let matches;
+    if (parameters === undefined) {
+        matches = Object.create(null);
+    }
+    const result = Object.keys(cond).every((key) => {
+        const value = val[key];
+        const condition = cond[key];
+        switch (typeof condition) {
+            case "string": {
+                return value === condition;
+            }
+            case "object": {
+                if (condition instanceof RegExp) {
+                    return condition.test(value);
+                }
+                switch (condition.source) {
+                    case MetadataDynamicValueSource.Payload: {
+                        const { payload } = condition;
+                        if (typeof payload === "string") {
+                            return value === payload;
+                        }
+                        if (payload instanceof RegExp) {
+                            return payload.test(value);
+                        }
+                        break;
+                    }
+                    case MetadataDynamicValueSource.Parameter: {
+                        if (parameters === undefined) {
+                            if (value !== undefined) {
+                                matches[key] = value;
+                                return true;
+                            }
+                            return false;
+                        }
+                        return parameters[key] === value;
+                    }
+                    case MetadataDynamicValueSource.Variable: {
+                        const { payload } = condition;
+                        if (typeof payload === "string") {
+                            return variables[payload] === value || process.env[payload] === value;
+                        }
+                        if (payload instanceof RegExp) {
+                            return isContainsPairs(variables, payload, value) || isContainsPairs(process.env, payload, value);
+                        }
+                        break;
+                    }
+                    default: {
+                        (0, utils_1.UNREACHABLE)();
+                    }
+                }
+                throw new errors_1.ArgumentError(`|payload| fields expected [string|RegExp] type, but reveived ${typeof condition.payload}`);
+            }
+            default: {
+                throw new errors_1.ArgumentError(`MetadataConditionValue expected [string|RegExp|object] type, but reveived ${typeof condition}`);
+            }
+        }
+    });
+    if (result && parameters === undefined) {
+        return matches;
+    }
+    return result;
+}
+exports.isMetadataMatch = isMetadataMatch;
+// #endregion
+/**
+ * 判断元数据是否为空
+ * @param metadata 元数据
+ */
+function isEmptyMetadata(metadata) {
+    return Object.keys(metadata).length === 0;
+}
+exports.isEmptyMetadata = isEmptyMetadata;
+/**
+ * 找到两个元数据相交的部分
+ * @param a 元数据 A
+ * @param b 元数据 B
+ * @returns 交集
+ */
+function intersectionMetadata(a, b) {
+    const intersection = {};
+    Object.keys(a).forEach((key) => {
+        const valueB = b[key];
+        const valueA = a[key];
+        if (valueA === valueB) {
+            intersection[key] = valueA;
+        }
+    });
+    return intersection;
+}
+exports.intersectionMetadata = intersectionMetadata;
+//# sourceMappingURL=metadata.js.map

package/@tencent/polaris/dist/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":";;;AAAA,qCAAyC;AACzC,mCAAsC;AAOtC,0BAA0B;AAC1B;;GAEG;AACH,IAAY,0BAeX;AAfD,WAAY,0BAA0B;IACpC;;OAEG;IACH,iFAAO,CAAA;IAEP;;OAEG;IACH,qFAAS,CAAA;IAET;;OAEG;IACH,mFAAQ,CAAA;AACV,CAAC,EAfW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAerC;AA+BD,aAAa;AAEb,0BAA0B;AAC1B,MAAM,eAAe,GAAG,CACtB,IAAwC,EAAE,GAAW,EAAE,KAAa,EACpE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC;AAgC5E,SAAgB,eAAe,CAC7B,GAAa,EACb,IAAuB,EACvB,SAAiC,EACjC,UAAmC;IAEnC,IAAI,OAA2C,CAAC;IAEhD,IAAI,UAAU,KAAK,SAAS,EAAE;QAC5B,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAA2B,CAAC;KACzD;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QAC7C,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAA6B,CAAC;QACnD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAsC,CAAC;QAEjE,QAAQ,OAAO,SAAS,EAAE;YACxB,KAAK,QAAQ,CAAC,CAAC;gBACb,OAAO,KAAK,KAAK,SAAS,CAAC;aAC5B;YACD,KAAK,QAAQ,CAAC,CAAC;gBACb,IAAI,SAAS,YAAY,MAAM,EAAE;oBAC/B,OAAO,SAAS,CAAC,IAAI,CAAC,KAAM,CAAC,CAAC;iBAC/B;gBAED,QAAQ,SAAS,CAAC,MAAM,EAAE;oBACxB,KAAK,0BAA0B,CAAC,OAAO,CAAC,CAAC;wBACvC,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;wBAC9B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;4BAC/B,OAAO,KAAK,KAAK,OAAO,CAAC;yBAC1B;wBACD,IAAI,OAAO,YAAY,MAAM,EAAE;4BAC7B,OAAO,OAAO,CAAC,IAAI,CAAC,KAAM,CAAC,CAAC;yBAC7B;wBACD,MAAM;qBACP;oBACD,KAAK,0BAA0B,CAAC,SAAS,CAAC,CAAC;wBACzC,IAAI,UAAU,KAAK,SAAS,EAAE;4BAC5B,IAAI,KAAK,KAAK,SAAS,EAAE;gCACvB,OAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gCACtB,OAAO,IAAI,CAAC;6BACb;4BACD,OAAO,KAAK,CAAC;yBACd;wBACD,OAAO,UAAU,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;qBAClC;oBACD,KAAK,0BAA0B,CAAC,QAAQ,CAAC,CAAC;wBACxC,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;wBAC9B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;4BAC/B,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC;yBACvE;wBACD,IAAI,OAAO,YAAY,MAAM,EAAE;4BAC7B,OAAO,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,KAAM,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,KAAM,CAAC,CAAC;yBACrG;wBACD,MAAM;qBACP;oBACD,OAAO,CAAC,CAAC;wBACP,IAAA,mBAAW,GAAE,CAAC;qBACf;iBACF;gBAED,MAAM,IAAI,sBAAa,CAAC,gEAAgE,OAAO,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;aACrH;YACD,OAAO,CAAC,CAAC;gBACP,MAAM,IAAI,sBAAa,CAAC,6EAA6E,OAAO,SAAS,EAAE,CAAC,CAAC;aAC1H;SACF;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,IAAI,UAAU,KAAK,SAAS,EAAE;QACtC,OAAO,OAAQ,CAAC;KACjB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAzED,0CAyEC;AACD,aAAa;AAEb;;;GAGG;AACH,SAAgB,eAAe,CAAC,QAAkB;IAChD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AAC5C,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,CAAW,EAAE,CAAW;IAC3D,MAAM,YAAY,GAAa,EAAE,CAAC;IAElC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACtB,IAAI,MAAM,KAAK,MAAM,EAAE;YACrB,YAAY,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;SAC5B;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC;AAZD,oDAYC"}

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

@@ -0,0 +1,47 @@
+import { ComputedStat, StatusChangeRequest } from "../../consumer";
+import { Instance } from "../../instance";
+import { CircuitBreakerPlugin, PluginType } from "../../plugins";
+declare const kDefaultOptions: {
+    /**
+     * 连续失败统计周期
+     */
+    continuousWindow: number;
+    /**
+     * 连续失败次数阈值
+     */
+    continuousErrors: number;
+    /**
+     * 触发熔断的最低请求阈值
+     */
+    fuseThreshold: number;
+    /**
+     * 熔断错误率阈值
+     */
+    fuseRate: number;
+    /**
+     * 半开恢复 `HalfClose` ---> `Normal` 所需的最小成功请求数
+     * 值不能大于探活任务的最大探测次数
+     */
+    halfClose2Normal: number;
+    /**
+     * 半开熔断 `HalfClose` ---> `Fused` 所需的最小失败请求数
+     * 值不能大于探活任务的最大探测次数
+     */
+    halfClose2Fused: number;
+};
+export declare type PolarisCircuitBreakerOptions = typeof kDefaultOptions;
+export declare class PolarisCircuitBreaker implements CircuitBreakerPlugin {
+    readonly type = PluginType.CircuitBreaker;
+    readonly name: string;
+    private readonly options;
+    private disposed;
+    private readonly periodStat;
+    private realtimeStat;
+    private timer;
+    constructor(options?: Partial<PolarisCircuitBreakerOptions>);
+    dispose(): void;
+    get isDisposed(): boolean;
+    period(namespace: string, service: string, instances: Instance[], stat: ComputedStat): Map<Instance, StatusChangeRequest>;
+    realtime(namespace: string, service: string, instance: Instance, success: boolean): StatusChangeRequest | undefined;
+}
+export {};

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

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolarisCircuitBreaker = void 0;
+const plugins_1 = require("../../plugins");
+const utils_1 = require("../../utils");
+const kDefaultOptions = {
+    /**
+     * 连续失败统计周期
+     */
+    continuousWindow: 1 * utils_1.kMinutes,
+    /**
+     * 连续失败次数阈值
+     */
+    continuousErrors: 10,
+    /**
+     * 触发熔断的最低请求阈值
+     */
+    fuseThreshold: 10,
+    /**
+     * 熔断错误率阈值
+     */
+    fuseRate: 0.5,
+    /**
+     * 半开恢复 `HalfClose` ---> `Normal` 所需的最小成功请求数
+     * 值不能大于探活任务的最大探测次数
+     */
+    halfClose2Normal: 2,
+    /**
+     * 半开熔断 `HalfClose` ---> `Fused` 所需的最小失败请求数
+     * 值不能大于探活任务的最大探测次数
+     */
+    halfClose2Fused: 2
+};
+class PolarisCircuitBreaker {
+    // #endregion
+    constructor(options) {
+        this.type = plugins_1.PluginType.CircuitBreaker;
+        this.name = "PolarisCircuitBreaker";
+        this.disposed = false;
+        this.periodStat = new WeakMap();
+        // #region realtime
+        this.realtimeStat = new WeakMap();
+        this.timer = null;
+        this.options = Object.assign(Object.assign({}, kDefaultOptions), options);
+    }
+    // #region dispose
+    dispose() {
+        if (this.timer) {
+            clearTimeout(this.timer);
+            this.timer = null;
+        }
+        this.disposed = true;
+    }
+    get isDisposed() {
+        return this.disposed;
+    }
+    // #endregion
+    period(namespace, service, instances, stat) {
+        const changeList = new Map();
+        stat.summaryStat.forEach((computed, instance) => {
+            let errCalls = 0;
+            let succCalls = 0;
+            computed.forEach(({ count }, { success }) => {
+                if (success) {
+                    succCalls += count;
+                }
+                else {
+                    errCalls += count;
+                }
+            });
+            switch (instance.status) {
+                case 0 /* Normal */: {
+                    const rspCalls = errCalls + succCalls;
+                    if (rspCalls > this.options.fuseThreshold) {
+                        /*
+                         *  为防止用户漏报了调用结果导致计算的成功率为 0，
+                         *  使用 `1 - errRate(k)` 作为成功率。
+                         */
+                        const succRate = 1 - (errCalls / rspCalls);
+                        if (succRate <= this.options.fuseRate) {
+                            /** `Normal` ---> `Fused` */
+                            changeList.set(instance, {
+                                status: 3 /* Fused */,
+                                reason: `[${this.name}] [period], succRate(${succRate}) <= fuseRate(${this.options.fuseRate})`
+                            });
+                        }
+                    }
+                    break;
+                }
+                case 2 /* HalfClose */: {
+                    let callStat = this.periodStat.get(instance);
+                    if (!callStat) {
+                        callStat = {
+                            succCalls,
+                            errCalls
+                        };
+                        this.periodStat.set(instance, callStat);
+                    }
+                    else {
+                        callStat.succCalls += succCalls;
+                        callStat.errCalls += errCalls;
+                    }
+                    if (callStat.succCalls >= this.options.halfClose2Normal) {
+                        /** `HalfClose` ---> `Normal` */
+                        changeList.set(instance, {
+                            status: 0 /* Normal */,
+                            reason: `[${this.name}] [period], succCalls(${callStat.succCalls}) >= halfClose2Normal(${this.options.halfClose2Normal})`
+                        });
+                        this.periodStat.delete(instance);
+                    }
+                    else if (callStat.errCalls >= this.options.halfClose2Fused) {
+                        /** `HalfClose` ---> `Fused` */
+                        changeList.set(instance, {
+                            status: 3 /* Fused */,
+                            reason: `[${this.name}] [period], errCalls(${callStat.errCalls}) >= halfClose2Fused(${this.options.halfClose2Fused})`
+                        });
+                        this.periodStat.delete(instance);
+                    }
+                    break;
+                }
+                case 1 /* HalfOpen */: {
+                    break;
+                }
+                case 3 /* Fused */: // [[fallthrough]]
+                default: {
+                    (0, utils_1.UNREACHABLE)();
+                }
+            }
+        });
+        return changeList;
+    }
+    realtime(namespace, service, instance, success) {
+        /**
+         * 为了性能考虑所有实时熔断流程采用同一定时器驱动
+         * tradeoff: 第一个统计周期中的统计数据可能是不精确的。
+         */
+        if (!this.timer) {
+            this.timer = setTimeout(() => {
+                this.realtimeStat = new WeakMap();
+                this.timer = null;
+            }, this.options.continuousWindow).unref();
+        }
+        let count = this.realtimeStat.get(instance);
+        if (success) {
+            if (count !== undefined) {
+                this.realtimeStat.delete(instance);
+            }
+            return;
+        }
+        count = (count || 0) + 1;
+        if (count >= this.options.continuousErrors) {
+            this.realtimeStat.delete(instance);
+            return {
+                status: 3 /* Fused */,
+                reason: `[${this.name}] [realtime], found ${count} times failed >= continuousErrors(${this.options.continuousErrors})`
+            };
+        }
+        this.realtimeStat.set(instance, count);
+    }
+}
+exports.PolarisCircuitBreaker = PolarisCircuitBreaker;
+//# sourceMappingURL=polaris.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"polaris.js","sourceRoot":"","sources":["../../../src/plugins/breaker/polaris.ts"],"names":[],"mappings":";;;AAEA,2CAAiE;AACjE,uCAAoD;AAEpD,MAAM,eAAe,GAAG;IACtB;;OAEG;IACH,gBAAgB,EAAE,CAAC,GAAG,gBAAQ;IAE9B;;OAEG;IACH,gBAAgB,EAAE,EAAE;IAEpB;;OAEG;IACH,aAAa,EAAE,EAAE;IAEjB;;OAEG;IACH,QAAQ,EAAE,GAAG;IAEb;;;OAGG;IACH,gBAAgB,EAAE,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,CAAC;CACnB,CAAC;AAIF,MAAa,qBAAqB;IAahC,aAAa;IAEb,YAAY,OAA+C;QAdlD,SAAI,GAAG,oBAAU,CAAC,cAAc,CAAC;QACjC,SAAI,GAAW,uBAAuB,CAAC;QAExC,aAAQ,GAAG,KAAK,CAAC;QACR,eAAU,GAGtB,IAAI,OAAO,EAAE,CAAC;QAEnB,mBAAmB;QACX,iBAAY,GAA8B,IAAI,OAAO,EAAE,CAAC;QACxD,UAAK,GAA0B,IAAI,CAAC;QAI1C,IAAI,CAAC,OAAO,mCACP,eAAe,GACf,OAAO,CACX,CAAC;IACJ,CAAC;IAED,kBAAkB;IAClB,OAAO;QACL,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACD,aAAa;IAEb,MAAM,CACJ,SAAiB,EAAE,OAAe,EAAE,SAAqB,EAAE,IAAkB;QAE7E,MAAM,UAAU,GAAG,IAAI,GAAG,EAAiC,CAAC;QAE5D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE;YAC9C,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;gBAC1C,IAAI,OAAO,EAAE;oBACX,SAAS,IAAI,KAAK,CAAC;iBACpB;qBAAM;oBACL,QAAQ,IAAI,KAAK,CAAC;iBACnB;YACH,CAAC,CAAC,CAAC;YACH,QAAQ,QAAQ,CAAC,MAAM,EAAE;gBACvB,mBAA0B,CAAC,CAAC;oBAC1B,MAAM,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;oBACtC,IAAI,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;wBACzC;;;2BAGG;wBACH,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;wBAC3C,IAAI,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;4BACrC,4BAA4B;4BAC5B,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE;gCACvB,MAAM,eAAsB;gCAC5B,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,wBAAwB,QAAQ,iBAAiB,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG;6BAC/F,CAAC,CAAC;yBACJ;qBACF;oBAED,MAAM;iBACP;gBACD,sBAA6B,CAAC,CAAC;oBAC7B,IAAI,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBAE7C,IAAI,CAAC,QAAQ,EAAE;wBACb,QAAQ,GAAG;4BACT,SAAS;4BACT,QAAQ;yBACT,CAAC;wBACF,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;qBACzC;yBAAM;wBACL,QAAQ,CAAC,SAAS,IAAI,SAAS,CAAC;wBAChC,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC;qBAC/B;oBAED,IAAI,QAAQ,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;wBACvD,gCAAgC;wBAChC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE;4BACvB,MAAM,gBAAuB;4BAC7B,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,yBAAyB,QAAQ,CAAC,SAAS,yBAAyB,IAAI,CAAC,OAAO,CAAC,gBAAgB,GAAG;yBAC1H,CAAC,CAAC;wBACH,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;qBAClC;yBAAM,IAAI,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;wBAC5D,+BAA+B;wBAC/B,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE;4BACvB,MAAM,eAAsB;4BAC5B,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,wBAAwB,QAAQ,CAAC,QAAQ,wBAAwB,IAAI,CAAC,OAAO,CAAC,eAAe,GAAG;yBACtH,CAAC,CAAC;wBACH,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;qBAClC;oBAED,MAAM;iBACP;gBACD,qBAA4B,CAAC,CAAC;oBAC5B,MAAM;iBACP;gBACD,mBAA0B,CAAC,kBAAkB;gBAC7C,OAAO,CAAC,CAAC;oBACP,IAAA,mBAAW,GAAE,CAAC;iBACf;aACF;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,QAAQ,CAAC,SAAiB,EAAE,OAAe,EAAE,QAAkB,EAAE,OAAgB;QAC/E;;;WAGG;QACH,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,OAAO,EAAoB,CAAC;gBACpD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YACpB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE,CAAC;SAC3C;QAED,IAAI,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE5C,IAAI,OAAO,EAAE;YACX,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aACpC;YACD,OAAO;SACR;QAED,KAAK,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YAC1C,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACnC,OAAO;gBACL,MAAM,eAAsB;gBAC5B,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,uBAAuB,KAAK,qCAAqC,IAAI,CAAC,OAAO,CAAC,gBAAgB,GAAG;aACvH,CAAC;SACH;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AApJD,sDAoJC"}