;
+ funcInfo?: FunctionInfo;
+ }) {
+ const { triggerInputs } = this.formatInputs({ region, inputs });
+ const res = await scf.apigwClient.deploy(triggerInputs);
+ return res;
+ }
+
+ /** Delete Apigateway trigger */
+ async delete({ scf, inputs }: { scf: Scf | TriggerManager; inputs: TriggerInputs }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ const res = await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return {
+ requestId: res.RequestId,
+ success: true,
+ };
+ } catch (e) {
+ console.log(e);
+ return false;
+ }
+ }
+}
+
+module.exports = ApigwTrigger;
diff --git a/src/modules/triggers/apis.ts b/src/modules/triggers/apis.ts
new file mode 100644
index 00000000..ffdf2d7f
--- /dev/null
+++ b/src/modules/triggers/apis.ts
@@ -0,0 +1,39 @@
+import { ApiFactory } from '../../utils/api';
+import { ApiError } from '../../utils/error';
+import { ApiServiceType } from '../interface';
+
+export const SCF = ApiFactory({
+ // debug: true,
+ serviceType: ApiServiceType.scf,
+ version: '2018-04-16',
+ actions: ['CreateTrigger', 'DeleteTrigger', 'ListTriggers'] as const,
+});
+
+export const APIGW = ApiFactory({
+ // debug: true,
+ serviceType: ApiServiceType.apigateway,
+ version: '2018-08-08',
+ actions: ['DescribeApi'] as const,
+ responseHandler(Response) {
+ return Response.Result || Response;
+ },
+ errorHandler(action, Response) {
+ if (Response.Error.Code.indexOf('ResourceNotFound') === -1) {
+ throw new ApiError({
+ type: `API_APIGW_${action}`,
+ message: `${Response.Error.Message} (reqId: ${Response.RequestId})`,
+ reqId: Response.RequestId,
+ code: Response.Error.Code,
+ });
+ }
+ return null;
+ },
+});
+
+export const MPS = ApiFactory({
+ // debug: true,
+ isV3: false,
+ serviceType: ApiServiceType.mps,
+ version: '2019-06-12',
+ actions: ['BindTrigger', 'UnbindTrigger'] as const,
+});
diff --git a/src/modules/triggers/base.ts b/src/modules/triggers/base.ts
new file mode 100644
index 00000000..150a06cb
--- /dev/null
+++ b/src/modules/triggers/base.ts
@@ -0,0 +1,119 @@
+import { Capi } from '@tencent-sdk/capi';
+import { RegionType, CapiCredentials, ApiServiceType } from '../interface';
+import { SCF } from './apis';
+import { TriggerInputs, TriggerInputsParams, CreateTriggerReq } from './interface';
+import Scf from '../scf';
+import { TriggerManager } from './manager';
+
+type Qualifier = string;
+
+export default abstract class BaseTrigger {
+ region!: RegionType;
+ credentials: CapiCredentials = {};
+ capi!: Capi;
+
+ constructor(options?: {
+ credentials?: CapiCredentials;
+ region?: RegionType;
+ serviceType: ApiServiceType;
+ }) {
+ if (options) {
+ const { credentials = {}, region = 'ap-guangzhou', serviceType } = options;
+
+ this.region = region;
+ this.credentials = credentials;
+
+ this.capi = new Capi({
+ Region: region,
+ ServiceType: serviceType,
+ SecretId: credentials.SecretId!,
+ SecretKey: credentials.SecretKey!,
+ Token: credentials.Token,
+ });
+ }
+ }
+
+ abstract getKey(triggerType: CreateTriggerReq): Promise | string;
+
+ abstract formatInputs({ region, inputs }: { region: RegionType; inputs: TriggerInputs }):
+ | {
+ triggerKey: string;
+ triggerInputs: P;
+ }
+ | Promise<{
+ triggerKey: string;
+ triggerInputs: P;
+ }>;
+
+ /** Get Trigger List */
+ async getTriggerList({
+ functionName,
+ namespace = 'default',
+ qualifier,
+ }: {
+ functionName?: string;
+ namespace: string;
+ qualifier: Qualifier;
+ }) {
+ const listOptions: {
+ FunctionName?: string;
+ Namespace: string;
+ Limit: number;
+ Filters: { Name: string; Values: Qualifier[] }[];
+ } = {
+ FunctionName: functionName,
+ Namespace: namespace,
+ Limit: 100,
+ Filters: [],
+ };
+ if (qualifier) {
+ listOptions.Filters = [
+ {
+ Name: 'Qualifier',
+ Values: [qualifier],
+ },
+ ];
+ }
+
+ /** 获取 Api 的触发器列表 */
+ const { Triggers, TotalCount } = await SCF.ListTriggers(this.capi, listOptions);
+
+ // FIXME: 触发器最多只获取 100 个，理论上不会运行这部分逻辑
+ if (TotalCount > 100) {
+ const res: any[] = await this.getTriggerList({ functionName, namespace, qualifier });
+ return Triggers.concat(res);
+ }
+
+ return Triggers;
+ }
+
+ abstract create({
+ scf,
+ region,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ region: string;
+ inputs: TriggerInputs
;
+ }): Promise;
+
+ /** delete scf trigger */
+ abstract delete({
+ scf,
+ region,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ region: RegionType;
+ inputs: TriggerInputs;
+ }): Promise;
+}
+
+export const TRIGGER_STATUS_MAP = {
+ OPEN: 'OPEN',
+ CLOSE: 'CLOSE',
+ 1: 'OPEN',
+ 0: 'CLOSE',
+};
+
+export const CAN_UPDATE_TRIGGER = ['apigw', 'cls', 'mps', 'clb','http','ckafka'];
\ No newline at end of file
diff --git a/src/modules/triggers/ckafka.ts b/src/modules/triggers/ckafka.ts
new file mode 100644
index 00000000..d25f8498
--- /dev/null
+++ b/src/modules/triggers/ckafka.ts
@@ -0,0 +1,111 @@
+import { CapiCredentials, RegionType } from './../interface';
+import { TriggerInputs, CkafkaTriggerInputsParams, CreateTriggerReq,TriggerAction } from './interface';
+import Scf from '../scf';
+import { TRIGGER_STATUS_MAP } from './base';
+import { TriggerManager } from './manager';
+import { getScfTriggerByName } from './utils';
+
+export default class CkafkaTrigger {
+ credentials: CapiCredentials;
+ region: RegionType;
+
+ constructor({ credentials, region }: { credentials: CapiCredentials; region: RegionType }) {
+ this.credentials = credentials;
+ this.region = region;
+ }
+
+ getKey(triggerInputs: CreateTriggerReq) {
+ const Enable = TRIGGER_STATUS_MAP[triggerInputs.Enable!];
+
+ let desc = triggerInputs.TriggerDesc;
+ if (triggerInputs.ResourceId) {
+ const detailDesc = JSON.parse(triggerInputs.TriggerDesc);
+ desc = JSON.stringify({
+ maxMsgNum: detailDesc.maxMsgNum,
+ offset: detailDesc.offset,
+ retry: detailDesc.retry,
+ timeOut: detailDesc.timeOut,
+ });
+ }
+ return `${triggerInputs.Type}-${triggerInputs.TriggerName}-${desc}-${Enable}-${triggerInputs.Qualifier}`;
+ }
+
+ formatInputs({ inputs,action = 'CreateTrigger'}: { inputs: TriggerInputs,action?: TriggerAction }) {
+ const { parameters } = inputs;
+ const triggerName = parameters?.name || `${parameters?.instanceId}-${parameters?.topic}`;
+ const triggerInputs: CreateTriggerReq = {
+ Action: action,
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: 'ckafka',
+ Qualifier: parameters?.qualifier ?? '$DEFAULT',
+ TriggerName: triggerName,
+ TriggerDesc: JSON.stringify({
+ maxMsgNum: parameters?.maxMsgNum ?? 100,
+ offset: parameters?.offset ?? 'latest',
+ retry: parameters?.retry ?? 10000,
+ timeOut: parameters?.timeout ?? 60,
+ consumerGroupName: parameters?.consumerGroupName ?? '',
+ }),
+ Enable: parameters?.enable ? 'OPEN' : 'CLOSE',
+ };
+
+ const triggerKey = this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ };
+ }
+ async create({
+ scf,
+ inputs,
+ region
+ }: {
+ scf: Scf | TriggerManager;
+ region: RegionType;
+ inputs: TriggerInputs;
+ }) {
+ // 查询当前触发器是否已存在
+ const existTrigger = await getScfTriggerByName({ scf, region, inputs });
+ // 更新触发器
+ if (existTrigger) {
+ const { triggerInputs } = this.formatInputs({ inputs, action: 'UpdateTrigger' });
+ console.log(`${triggerInputs.Type} trigger ${triggerInputs.TriggerName} is exist`)
+ console.log(`Updating ${triggerInputs.Type} trigger ${triggerInputs.TriggerName}`);
+ try {
+ // 更新触发器
+ await scf.request(triggerInputs as any);
+ // 更新成功后，查询最新的触发器信息
+ const trigger = await getScfTriggerByName({ scf, region, inputs });
+ return trigger;
+ } catch (error) {
+ return {}
+ }
+ } else { // 创建触发器
+ const { triggerInputs } = this.formatInputs({ inputs });
+ console.log(`Creating ${triggerInputs.Type} trigger ${triggerInputs.TriggerName}`);
+ const { TriggerInfo } = await scf.request(triggerInputs as any);
+ TriggerInfo.Qualifier = TriggerInfo.Qualifier || triggerInputs.Qualifier;
+ return TriggerInfo;
+ }
+ }
+ async delete({ scf, inputs }: { scf: Scf; inputs: TriggerInputs }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return true;
+ } catch (e) {
+ console.log(e);
+ return false;
+ }
+ }
+}
diff --git a/src/modules/triggers/clb.ts b/src/modules/triggers/clb.ts
new file mode 100644
index 00000000..e7ab9d6b
--- /dev/null
+++ b/src/modules/triggers/clb.ts
@@ -0,0 +1,182 @@
+import Clb from '../clb';
+import Scf from '../scf';
+
+import { ApiServiceType } from '../interface';
+import {
+ TriggerInputs,
+ ClbTriggerInputsParams,
+ CreateTriggerReq,
+ CreateClbTriggerOutput,
+} from './interface';
+import BaseTrigger from './base';
+import { CapiCredentials, RegionType } from '../interface';
+import { TriggerManager } from './manager';
+
+export default class clbTrigger extends BaseTrigger {
+ clb: Clb;
+
+ constructor({
+ credentials = {},
+ region = 'ap-guangzhou',
+ }: {
+ credentials?: CapiCredentials;
+ region?: RegionType;
+ }) {
+ super({ region, credentials, serviceType: ApiServiceType.clb });
+
+ this.clb = new Clb(credentials, region);
+ }
+
+ /**
+ * 创建 clb 触发器
+ * @param {ClbTriggerInputsParams} 创建 clb 触发器参数
+ */
+ async create({
+ inputs,
+ }: {
+ inputs: TriggerInputs;
+ }): Promise {
+ const { parameters, functionName, namespace = 'default', qualifier = '$DEFAULT' } = inputs;
+ const { loadBalanceId, domain, protocol, port, url, weight } = parameters!;
+
+ const output: CreateClbTriggerOutput = {
+ namespace,
+ functionName,
+ qualifier,
+ loadBalanceId,
+ listenerId: '',
+ locationId: '',
+ domain,
+ protocol,
+ port,
+ url,
+ weight,
+ };
+
+ const rule = await this.clb.createRule({
+ loadBalanceId: loadBalanceId,
+ domain: domain,
+ protocol: protocol,
+ port: port,
+ url: url,
+ });
+
+ console.log(
+ `[CLB] Binding rule(domain: ${domain}, url: ${url}) of ${loadBalanceId} for ${functionName}`,
+ );
+ await this.clb.bindTrigger({
+ loadBalanceId: rule.loadBalanceId,
+ listenerId: rule.listenerId,
+ locationId: rule.locationId,
+ functionName,
+ namespace,
+ qualifier,
+ weight,
+ });
+
+ output.listenerId = rule.listenerId;
+ output.locationId = rule.locationId;
+
+ console.log(
+ `[CLB] Bind rule(domain: ${domain}, url: ${url}) of ${loadBalanceId} for ${functionName} success`,
+ );
+
+ return output;
+ }
+
+ /**
+ * 删除 clb 触发器
+ * @param {scf: Scf, inputs: TriggerInputs} 删除 clb 触发器参数
+ */
+ async delete({
+ scf,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ inputs: TriggerInputs;
+ }) {
+ console.log(`[CLB] Removing clb trigger ${inputs.triggerName} for ${inputs.functionName}`);
+ try {
+ const { RequestId } = await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: 'clb',
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ console.log(
+ `[CLB] Remove clb trigger ${inputs.triggerName} for ${inputs.functionName} success`,
+ );
+ return {
+ requestId: RequestId,
+ success: true,
+ };
+ } catch (e) {
+ console.log(
+ `[CLB] Remove clb trigger ${inputs.triggerName} for ${inputs.functionName} error: ${e.message}`,
+ );
+ return false;
+ }
+ }
+
+ // //, 比如：lb-l6golr1k/lbl-6aocx3wi/loc-aoa0k3s0
+ async getKey(triggerInputs: CreateTriggerReq) {
+ const { TriggerDesc, ResourceId } = triggerInputs;
+ if (ResourceId) {
+ // ResourceId 格式：qcs::clb:gz:uin/100015854621:lb-l6golr1k/lbl-6aocx3wi/loc-aoa0k3s0
+ return ResourceId.slice(ResourceId.lastIndexOf(':') + 1);
+ }
+
+ const { loadBalanceId, protocol, port, domain, url } = TriggerDesc;
+ const rule = await this.clb.getRule({
+ loadBalanceId,
+ protocol,
+ port,
+ domain,
+ url,
+ });
+ let triggerKey = '';
+ if (rule) {
+ triggerKey = `${loadBalanceId}/${rule.ListenerId}/${rule.LocationId}`;
+ }
+
+ return triggerKey;
+ }
+
+ async formatInputs({ inputs }: { inputs: TriggerInputs }) {
+ const { parameters } = inputs;
+ const {
+ loadBalanceId,
+ domain,
+ protocol,
+ port,
+ url,
+ weight,
+ qualifier = '$DEFAULT',
+ enable,
+ } = parameters!;
+ const triggerInputs: CreateTriggerReq = {
+ Type: 'clb',
+ Qualifier: qualifier,
+ TriggerName: '',
+ TriggerDesc: {
+ loadBalanceId,
+ domain,
+ port,
+ protocol,
+ url,
+ weight,
+ },
+ Enable: enable ? 'OPEN' : 'CLOSE',
+ };
+
+ const triggerKey = await this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ } as any;
+ }
+}
diff --git a/src/modules/triggers/cls.ts b/src/modules/triggers/cls.ts
new file mode 100644
index 00000000..fd901483
--- /dev/null
+++ b/src/modules/triggers/cls.ts
@@ -0,0 +1,131 @@
+import { CapiCredentials, RegionType } from './../interface';
+import { Cls } from '@tencent-sdk/cls';
+import { ClsTriggerInputsParams, TriggerInputs, CreateTriggerReq } from './interface';
+import Scf from '../scf';
+import BaseTrigger from './base';
+import { createClsTrigger, deleteClsTrigger, getClsTrigger, updateClsTrigger } from '../cls/utils';
+import { TriggerManager } from './manager';
+
+export default class ClsTrigger extends BaseTrigger {
+ client: Cls;
+ constructor({ credentials, region }: { credentials: CapiCredentials; region: RegionType }) {
+ super();
+ this.client = new Cls({
+ region,
+ secretId: credentials.SecretId!,
+ secretKey: credentials.SecretKey!,
+ token: credentials.Token,
+ debug: false,
+ });
+ }
+
+ getKey(triggerInputs: CreateTriggerReq) {
+ if (triggerInputs.ResourceId) {
+ // from ListTriggers API
+ const rStrArr = triggerInputs.ResourceId.split('/');
+ return rStrArr[rStrArr.length - 1];
+ }
+
+ return triggerInputs.TriggerDesc?.topic_id ?? '';
+ }
+
+ formatInputs({ inputs }: { inputs: TriggerInputs }) {
+ const { parameters } = inputs;
+ const qualifier = parameters?.qualifier ?? inputs.Qualifier ?? '$DEFAULT';
+ const triggerInputs: CreateTriggerReq = {
+ Type: 'cls',
+ Qualifier: qualifier,
+ TriggerName: '',
+ TriggerDesc: {
+ effective: parameters?.enable,
+ // FIXME: casing
+ function_name: inputs.FunctionName,
+ max_size: parameters?.maxSize,
+ max_wait: parameters?.maxWait,
+ name_space: inputs.Namespace,
+ qualifier,
+ topic_id: parameters?.topicId,
+ },
+ Enable: parameters?.enable ? 'OPEN' : 'CLOSE',
+ };
+
+ const triggerKey = this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ } as any;
+ }
+
+ async get(data: { topicId?: string }) {
+ const exist = await getClsTrigger(this.client, {
+ topic_id: data.topicId,
+ });
+ return exist;
+ }
+
+ async create({ inputs }: { inputs: TriggerInputs }) {
+ const { parameters } = inputs;
+ const exist = await this.get({
+ topicId: parameters?.topicId,
+ });
+ const qualifier = parameters?.qualifier || '$DEFAULT';
+ const namespace = inputs.namespace || 'default';
+ const output = {
+ namespace,
+ functionName: inputs.functionName,
+ ...parameters,
+ qualifier,
+ };
+ const clsInputs = {
+ topic_id: parameters?.topicId,
+ name_space: namespace,
+ function_name: inputs.functionName || inputs.function?.name,
+ qualifier: qualifier,
+ max_wait: parameters?.maxWait,
+ max_size: parameters?.maxSize,
+ effective: parameters?.enable,
+ };
+ if (exist) {
+ await updateClsTrigger(this.client, clsInputs);
+ return output;
+ }
+ await createClsTrigger(this.client, clsInputs);
+ return output;
+ }
+
+ async deleteByTopicId({ topicId }: { topicId: string }) {
+ const res = await deleteClsTrigger(this.client, {
+ topic_id: topicId,
+ });
+ return res;
+ }
+
+ async delete({
+ scf,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ inputs: TriggerInputs;
+ }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ const res = await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return {
+ requestId: res.RequestId,
+ success: true,
+ };
+ } catch (e) {
+ console.log(e);
+ return false;
+ }
+ }
+}
diff --git a/src/modules/triggers/cmq.ts b/src/modules/triggers/cmq.ts
new file mode 100644
index 00000000..66180f02
--- /dev/null
+++ b/src/modules/triggers/cmq.ts
@@ -0,0 +1,87 @@
+import Scf from '../scf';
+import { TriggerManager } from './manager';
+import { CapiCredentials, RegionType } from './../interface';
+import BaseTrigger from './base';
+import { CmqTriggerInputsParams, TriggerInputs, CreateTriggerReq } from './interface';
+const { TRIGGER_STATUS_MAP } = require('./base');
+
+export default class CmqTrigger extends BaseTrigger {
+ credentials: CapiCredentials;
+ region: RegionType;
+
+ constructor({ credentials, region }: { credentials: CapiCredentials; region: RegionType }) {
+ super();
+ this.credentials = credentials;
+ this.region = region;
+ }
+
+ getKey(triggerInputs: CreateTriggerReq) {
+ const Enable = TRIGGER_STATUS_MAP[triggerInputs.Enable!];
+ return `${triggerInputs.Type}-${triggerInputs.TriggerName}-${triggerInputs.TriggerDesc}-${Enable}-${triggerInputs.Qualifier}`;
+ }
+
+ formatInputs({ inputs }: { region: RegionType; inputs: TriggerInputs }) {
+ const { parameters } = inputs;
+ const triggerInputs: CreateTriggerReq = {
+ Action: 'CreateTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+
+ Type: 'cmq',
+ Qualifier: parameters?.qualifier || '$DEFAULT',
+ TriggerName: parameters?.name,
+ TriggerDesc: JSON.stringify({
+ filterType: 1,
+ filterKey: parameters?.filterKey,
+ }),
+ Enable: parameters?.enable ? 'OPEN' : 'CLOSE',
+ };
+
+ const triggerKey = this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ } as any;
+ }
+ async create({
+ scf,
+ region,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ region: RegionType;
+ inputs: TriggerInputs;
+ }) {
+ const { triggerInputs } = this.formatInputs({ region, inputs });
+ console.log(`Creating ${triggerInputs.Type} trigger ${triggerInputs.TriggerName}`);
+ const { TriggerInfo } = await scf.request(triggerInputs);
+ TriggerInfo.Qualifier = TriggerInfo.Qualifier || triggerInputs.Qualifier;
+ return TriggerInfo;
+ }
+
+ async delete({
+ scf,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ inputs: TriggerInputs;
+ }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return true;
+ } catch (e) {
+ console.log(e);
+ return false;
+ }
+ }
+}
diff --git a/src/modules/triggers/cos.ts b/src/modules/triggers/cos.ts
new file mode 100644
index 00000000..773abbaa
--- /dev/null
+++ b/src/modules/triggers/cos.ts
@@ -0,0 +1,95 @@
+import Scf from '../scf';
+import { TriggerManager } from './manager';
+import { CapiCredentials, RegionType } from './../interface';
+import BaseTrigger, { TRIGGER_STATUS_MAP } from './base';
+import { CosTriggerInputsParams, TriggerInputs, CreateTriggerReq } from './interface';
+export default class CosTrigger extends BaseTrigger {
+ credentials: CapiCredentials;
+ region: RegionType;
+
+ constructor({ credentials, region }: { credentials: CapiCredentials; region: RegionType }) {
+ super();
+ this.credentials = credentials;
+ this.region = region;
+ }
+
+ getKey(triggerInputs: CreateTriggerReq) {
+ const tempDest = JSON.stringify({
+ bucketUrl: triggerInputs.TriggerName,
+ event: JSON.parse(triggerInputs.TriggerDesc!).event,
+ filter: JSON.parse(triggerInputs.TriggerDesc!).filter,
+ });
+ const Enable = TRIGGER_STATUS_MAP[triggerInputs.Enable!];
+ return `cos-${triggerInputs.TriggerName}-${tempDest}-${Enable}-${triggerInputs.Qualifier}`;
+ }
+
+ formatInputs({ inputs }: { region: RegionType; inputs: TriggerInputs }) {
+ const { parameters } = inputs;
+ const triggerInputs: CreateTriggerReq = {
+ Action: 'CreateTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+
+ Type: 'cos',
+ Qualifier: parameters?.qualifier || '$DEFAULT',
+ TriggerName: parameters?.bucket,
+ TriggerDesc: JSON.stringify({
+ event: parameters?.events,
+ filter: {
+ Prefix: parameters?.filter?.prefix ?? '',
+ Suffix: parameters?.filter?.suffix ?? '',
+ },
+ }),
+ Enable: parameters?.enable ? 'OPEN' : 'CLOSE',
+ };
+
+ const triggerKey = this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ } as any;
+ }
+
+ async create({
+ scf,
+ region,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ region: RegionType;
+ inputs: TriggerInputs;
+ }) {
+ const { triggerInputs } = this.formatInputs({ region, inputs });
+ console.log(`Creating ${triggerInputs.Type} trigger ${triggerInputs.TriggerName}`);
+ const { TriggerInfo } = await scf.request(triggerInputs);
+ TriggerInfo.Qualifier = TriggerInfo.Qualifier || triggerInputs.Qualifier;
+
+ return TriggerInfo;
+ }
+
+ async delete({
+ scf,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ inputs: TriggerInputs;
+ }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return true;
+ } catch (e) {
+ console.log(e);
+ return false;
+ }
+ }
+}
diff --git a/src/modules/triggers/http.ts b/src/modules/triggers/http.ts
new file mode 100644
index 00000000..f5e26f0f
--- /dev/null
+++ b/src/modules/triggers/http.ts
@@ -0,0 +1,116 @@
+import Scf from '../scf';
+import { TriggerManager } from './manager';
+import { CapiCredentials, RegionType } from './../interface';
+import BaseTrigger from './base';
+import { HttpTriggerInputsParams, TriggerInputs, CreateTriggerReq,TriggerAction } from './interface';
+import { caseForObject } from '../../utils';
+import { getScfTriggerByName } from './utils';
+
+export default class HttpTrigger extends BaseTrigger {
+ credentials: CapiCredentials;
+ region: RegionType;
+
+ constructor({ credentials, region }: { credentials: CapiCredentials; region: RegionType }) {
+ super();
+ this.credentials = credentials;
+ this.region = region;
+ }
+
+ getKey(triggerInputs: CreateTriggerReq) {
+ return `http-${triggerInputs?.TriggerName}`;
+ }
+
+ formatInputs({ inputs,action = 'CreateTrigger' }: { region: RegionType; inputs: TriggerInputs ,action?: TriggerAction}) {
+ const { parameters } = inputs;
+ const triggerName = parameters?.name || 'url-trigger';
+ const { origins,headers,methods,exposeHeaders } = parameters?.corsConfig || {}
+ const triggerInputs: CreateTriggerReq = {
+ Action: action,
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: 'http',
+ Qualifier: parameters?.qualifier || '$DEFAULT',
+ TriggerName: triggerName,
+ TriggerDesc: JSON.stringify({
+ AuthType: parameters?.authType || 'NONE',
+ NetConfig: {
+ EnableIntranet: parameters?.netConfig?.enableIntranet ?? false,
+ EnableExtranet: parameters?.netConfig?.enableExtranet ?? false,
+ },
+ CorsConfig: parameters?.corsConfig ? caseForObject({
+ ...parameters?.corsConfig,
+ origins: typeof origins === 'string' ? origins?.split(',') : origins,
+ methods: typeof methods === 'string' ? methods?.split(',') : methods,
+ headers: typeof headers === 'string' ? headers?.split(',') : headers,
+ exposeHeaders: typeof exposeHeaders === 'string' ? exposeHeaders?.split(',') : exposeHeaders,
+ },'upper') : undefined
+ }),
+ Enable: 'OPEN',
+ };
+
+ const triggerKey = this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ } as any;
+ }
+
+ async create({
+ scf,
+ region,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ region: RegionType;
+ inputs: TriggerInputs;
+ }) {
+ // 查询当前触发器是否已存在
+ const existTrigger = await getScfTriggerByName({ scf, region, inputs });
+ // 更新触发器
+ if (existTrigger) {
+ const { triggerInputs } = this.formatInputs({ region, inputs, action: 'UpdateTrigger' });
+ console.log(`${triggerInputs.Type} trigger ${triggerInputs.TriggerName} is exist`)
+ console.log(`Updating ${triggerInputs.Type} trigger ${triggerInputs.TriggerName}`);
+ try {
+ // 更新触发器
+ await scf.request(triggerInputs);
+ // 更新成功后，查询最新的触发器信息
+ const trigger = await getScfTriggerByName({ scf, region, inputs });
+ return trigger;
+ } catch (error) {
+ return {}
+ }
+ } else { // 创建触发器
+ const { triggerInputs } = this.formatInputs({ region, inputs });
+ console.log(`Creating ${triggerInputs.Type} trigger ${triggerInputs.TriggerName}`);
+ const { TriggerInfo } = await scf.request(triggerInputs);
+ TriggerInfo.Qualifier = TriggerInfo.Qualifier || triggerInputs.Qualifier;
+ return TriggerInfo;
+ }
+ }
+
+ async delete({
+ scf,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ inputs: TriggerInputs;
+ }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return true;
+ } catch (e) {
+ console.log(e);
+ return false;
+ }
+ }
+}
diff --git a/src/modules/triggers/index.ts b/src/modules/triggers/index.ts
new file mode 100644
index 00000000..45c07353
--- /dev/null
+++ b/src/modules/triggers/index.ts
@@ -0,0 +1,37 @@
+import TimerTrigger from './timer';
+import CosTrigger from './cos';
+import ApigwTrigger from './apigw';
+import HttpTrigger from './http';
+import CkafkaTrigger from './ckafka';
+import CmqTrigger from './cmq';
+import ClsTrigger from './cls';
+import MpsTrigger from './mps';
+import ClbTrigger from './clb';
+import BaseTrigger from './base';
+import { CapiCredentials, RegionType } from '../interface';
+
+export { default as TimerTrigger } from './timer';
+export { default as CosTrigger } from './cos';
+export { default as ApigwTrigger } from './apigw';
+export { default as HttpTrigger } from './http';
+export { default as CkafkaTrigger } from './ckafka';
+export { default as CmqTrigger } from './cmq';
+export { default as ClsTrigger } from './cls';
+export { default as MpsTrigger } from './mps';
+
+const TRIGGER = {
+ timer: TimerTrigger,
+ cos: CosTrigger,
+ apigw: ApigwTrigger,
+ http: HttpTrigger,
+ ckafka: CkafkaTrigger,
+ cmq: CmqTrigger,
+ cls: ClsTrigger,
+ mps: MpsTrigger,
+ clb: ClbTrigger,
+} as any as Record<
+ string,
+ BaseTrigger & { new (options: { credentials: CapiCredentials; region: RegionType }): BaseTrigger }
+>;
+
+export default TRIGGER;
diff --git a/src/modules/triggers/interface/clb.ts b/src/modules/triggers/interface/clb.ts
new file mode 100644
index 00000000..e79105cd
--- /dev/null
+++ b/src/modules/triggers/interface/clb.ts
@@ -0,0 +1,25 @@
+export interface ClbTriggerInputsParams {
+ loadBalanceId: string;
+ port: number;
+ protocol: string;
+ domain: string;
+ url: string;
+ qualifier?: string;
+ enable?: boolean;
+ weight?: number;
+}
+
+export interface CreateClbTriggerOutput {
+ loadBalanceId: string;
+ listenerId: string;
+ locationId: string;
+ port: number;
+ protocol: string;
+ domain: string;
+ url: string;
+ functionName: string;
+ namespace: string;
+ qualifier?: string;
+ enable?: boolean;
+ weight?: number;
+}
diff --git a/src/modules/triggers/interface/index.ts b/src/modules/triggers/interface/index.ts
new file mode 100644
index 00000000..20ce7e07
--- /dev/null
+++ b/src/modules/triggers/interface/index.ts
@@ -0,0 +1,211 @@
+import { ApigwDeployInputs, ApiEndpoint } from '../../apigw/interface';
+import { TagInput } from '../../interface';
+
+export type TriggerAction = 'CreateTrigger' | 'UpdateTrigger'
+export interface ApigwTriggerRemoveScfTriggerInputs {
+ serviceId: string;
+ apiId: string;
+ functionName: string;
+ namespace: string;
+ qualifier: string;
+}
+
+export interface ApigwTriggerRemoveInputs {
+ serviceId: string;
+ apiId: string;
+}
+
+export interface EndpointFunction extends ApiEndpoint {
+ functionName: string;
+ functionNamespace: string;
+ functionQualifier: string;
+}
+
+export interface TriggerInputsParams {
+ // Type?:string;
+ // TriggerDesc?:string;
+ // TriggerName?: string;
+ // Qualifier?: string
+}
+
+export interface ApigwTriggerInputsParams extends ApigwDeployInputs {
+ created: boolean;
+
+ TriggerDesc:
+ | {
+ serviceId: string;
+ path: string;
+ method: string;
+ }
+ | string;
+ ResourceId?: string;
+}
+
+export type TriggerType = 'scf' | 'timer' | string;
+export interface CreateTriggerReq {
+ Action?: TriggerAction;
+ ResourceId?: string;
+ FunctionName?: string;
+ Namespace?: string;
+ Type?: TriggerType;
+ Qualifier?: string;
+ TriggerName?: string;
+ TriggerDesc?: any;
+ Enable?: 'OPEN' | 'CLOSE' | 1 | 0;
+ CustomArgument?: any;
+}
+
+export interface CkafkaTriggerInputsParams extends TriggerInputsParams {
+ qualifier?: string;
+ name?: string;
+ instanceId?: string; //ckafka实例ID
+ topic?: string; //ckafka主题名称
+ maxMsgNum?: number;
+ offset?: number;
+ retry?: number;
+ timeout?: number;
+ consumerGroupName?: string;
+ enable?: boolean;
+}
+
+export interface CmqTriggerInputsParams {
+ qualifier?: string;
+ name?: string;
+ filterKey?: string;
+ enable?: boolean;
+}
+
+export interface ClsTriggerInputsParams {
+ qualifier?: string;
+ enable?: boolean;
+ maxSize?: number;
+ maxWait?: number;
+ topicId?: string;
+}
+
+export interface CosTriggerInputsParams {
+ qualifier?: string;
+ bucket?: string;
+ events?: string;
+ filter?: {
+ prefix?: string;
+ suffix?: string;
+ };
+ enable?: boolean;
+}
+
+/** 函数URL参数 */
+export interface HttpTriggerInputsParams {
+ qualifier?: string;
+ name?: string;
+ authType?: 'CAM' | 'NONE';
+ netConfig?: {
+ enableIntranet?: boolean;
+ enableExtranet?: boolean;
+ };
+ corsConfig: {
+ enable: boolean
+ origins: Array | string
+ methods: Array | string
+ headers: Array | string
+ exposeHeaders: Array | string
+ credentials: boolean
+ maxAge: number
+ }
+}
+
+export interface MpsTriggerInputsParams {
+ type?: string;
+ qualifier?: string;
+ namespace?: string;
+ enable?: boolean;
+}
+export interface TimerTriggerInputsParams {
+ name?: string;
+ qualifier?: string;
+ cronExpression?: string;
+ enable?: boolean;
+
+ argument?: string;
+ namespace?: string;
+}
+
+export interface TriggerInputs {
+ functionName: string;
+ Type?: string; // 兼容scf组件触发器类型字段
+ type?: string;
+ triggerDesc?: string;
+ triggerName?: string;
+ qualifier?: string;
+ name?: string;
+ namespace?: string;
+ parameters?: P;
+
+ function?: {
+ qualifier?: string;
+ name?: string;
+ namespace?: string;
+ };
+
+ // FIXME:
+ FunctionName?: string;
+ Namespace?: string;
+ Qualifier?: string;
+
+ // 是否自动发布服务（API 网关特有）
+ isAutoRelease?: boolean;
+
+ // 标签列表
+ tags?: TagInput[];
+}
+
+export interface TriggerDetail {
+ NeedCreate?: boolean;
+ Type: string;
+ TriggerDesc?: string;
+ TriggerName?: string;
+ Qualifier?: string;
+ compared?: boolean;
+
+ triggerType: string;
+
+ [key: string]: any;
+}
+
+export interface NewTriggerInputs {
+ type: string;
+
+ function?: {
+ name: string;
+ namespace?: string;
+ qualifier?: string;
+ };
+
+ parameters: {
+ endpoints?: ApiEndpoint[];
+ [key: string]: any;
+ };
+}
+
+export * from './clb';
+
+interface ApiOutput {
+ path: string;
+ method: string;
+
+ [key: string]: any;
+}
+export interface SimpleApigwDetail {
+ // 是否是通过 CLI 创建的
+ created?: boolean;
+ // 当前触发器关联函数名称
+ functionName: string;
+ // 服务 ID
+ serviceId: string;
+ // 服务名称
+ serviceName: string;
+ // 发布的环境
+ environment: string;
+ // api 列表
+ apiList: ApiOutput[];
+}
diff --git a/src/modules/triggers/manager.ts b/src/modules/triggers/manager.ts
new file mode 100644
index 00000000..e62f77d1
--- /dev/null
+++ b/src/modules/triggers/manager.ts
@@ -0,0 +1,595 @@
+import { SimpleApigwDetail } from './interface/index';
+import { Capi } from '@tencent-sdk/capi';
+import { ActionType } from '../scf/apis';
+import { RegionType, ApiServiceType, CapiCredentials } from '../interface';
+import { ApiError } from '../../utils/error';
+import { deepClone } from '../../utils';
+import TagsUtils from '../tag/index';
+import ApigwUtils from '../apigw';
+import APIS from '../scf/apis';
+import TRIGGERS from '.';
+import BaseTrigger, { CAN_UPDATE_TRIGGER } from './base';
+import { TriggerDetail, NewTriggerInputs } from './interface';
+import ScfEntity from '../scf/entities/scf';
+
+export interface ApiInputs {
+ path: string;
+ method: string;
+ function: {
+ name: string;
+ namespace?: string;
+ qualifier?: string;
+ // 兼容旧的配置
+ functionName?: string;
+ functionQualifier?: string;
+ functionNamespace?: string;
+ };
+
+ [key: string]: any;
+}
+
+/** 云函数组件 */
+export class TriggerManager {
+ tagClient: TagsUtils;
+ apigwClient: ApigwUtils;
+ capi: Capi;
+ region: RegionType;
+ credentials: CapiCredentials;
+
+ triggersCache: Record = {};
+ scfNameCache: Record = {};
+
+ scf: ScfEntity;
+
+ // 当前正在执行的触发器任务数
+ runningTasks = 0;
+ // 支持并行执行的最大触发器任务数
+ maxRunningTasks = 1;
+
+ constructor(credentials = {}, region: RegionType = 'ap-guangzhou') {
+ this.region = region;
+ this.credentials = credentials;
+ this.tagClient = new TagsUtils(this.credentials, this.region);
+ this.apigwClient = new ApigwUtils(this.credentials, this.region);
+
+ this.credentials = credentials;
+ this.capi = new Capi({
+ Region: this.region,
+ ServiceType: ApiServiceType.scf,
+ SecretId: this.credentials.SecretId!,
+ SecretKey: this.credentials.SecretKey!,
+ Token: this.credentials.Token,
+ });
+
+ this.scf = new ScfEntity(this.capi, region);
+ }
+
+ async request({ Action, ...data }: { Action: ActionType; [key: string]: any }) {
+ const result = await APIS[Action](this.capi, data);
+ return result;
+ }
+
+ // 获取函数下所有触发器
+ async getScfTriggers({
+ name,
+ namespace = 'default',
+ }: {
+ name: string;
+ namespace?: string;
+ }): Promise {
+ const { Triggers = [], TotalCount } = await this.request({
+ Action: 'ListTriggers',
+ FunctionName: name,
+ Namespace: namespace,
+ Limit: 100,
+ });
+ if (TotalCount > 100) {
+ const res = await this.getScfTriggers({ name, namespace });
+ return Triggers.concat(res);
+ }
+
+ return Triggers;
+ }
+
+ async filterTriggers({
+ name,
+ namespace,
+ events,
+ oldList,
+ }: {
+ name: string;
+ namespace: string;
+ events: NewTriggerInputs[];
+ oldList: TriggerDetail[];
+ }) {
+ const deleteList: (TriggerDetail | null)[] = deepClone(oldList);
+ const deployList: (TriggerDetail | null)[] = [];
+
+ const compareTriggerKey = async ({
+ triggerType,
+ newIndex,
+ newKey,
+ oldTriggerList,
+ }: {
+ triggerType: string;
+ newIndex: number;
+ newKey: string;
+ oldTriggerList: TriggerDetail[];
+ }) => {
+ for (let i = 0; i < oldTriggerList.length; i++) {
+ const oldTrigger = oldTriggerList[i];
+ // 如果类型不一致或者已经比较过（key值一致），则继续下一次循环
+ if (oldTrigger.Type !== triggerType || oldTrigger.compared === true) {
+ continue;
+ }
+ const OldTriggerClass = TRIGGERS[oldTrigger.Type];
+ const oldTriggerInstance = new OldTriggerClass({
+ credentials: this.credentials,
+ region: this.region,
+ });
+ const oldKey = await oldTriggerInstance.getKey(oldTrigger);
+
+ // 如果 key 不一致则继续下一次循环
+ if (oldKey !== newKey) {
+ continue;
+ }
+
+ oldList[i].compared = true;
+
+ deleteList[i] = null;
+
+ if (CAN_UPDATE_TRIGGER.indexOf(triggerType) === -1) {
+ deployList[newIndex] = {
+ NeedCreate: false,
+ ...oldTrigger,
+ };
+ }
+ // 如果找到 key 值一样的，直接跳出循环
+ break;
+ }
+ };
+
+ for (let index = 0; index < events.length; index++) {
+ const event = events[index];
+ const { type } = event;
+ const TriggerClass = TRIGGERS[type];
+ const triggerInstance: BaseTrigger = new TriggerClass({
+ credentials: this.credentials,
+ region: this.region,
+ });
+
+ deployList[index] = {
+ NeedCreate: true,
+ Type: type,
+ triggerType: type,
+ ...event,
+ };
+
+ // 需要特殊比较 API 网关触发器，因为一个触发器配置中，可能包含多个 API 触发器
+ if (type === 'apigw') {
+ const { parameters = {} } = event;
+ const { endpoints = [{ path: '/', method: 'ANY' }] } = parameters;
+ for (const item of endpoints) {
+ const newKey = await triggerInstance.getKey({
+ TriggerDesc: {
+ serviceId: parameters.serviceId,
+ path: item.path,
+ method: item.method,
+ },
+ });
+ await compareTriggerKey({
+ triggerType: type,
+ newIndex: index,
+ newKey: newKey,
+ oldTriggerList: oldList,
+ });
+ }
+ } else {
+ const { triggerKey } = await triggerInstance.formatInputs({
+ region: this.region,
+ inputs: {
+ namespace: namespace,
+ functionName: name,
+ ...event,
+ },
+ });
+ await compareTriggerKey({
+ triggerType: type,
+ newIndex: index,
+ newKey: triggerKey,
+ oldTriggerList: oldList,
+ });
+ }
+ }
+ return {
+ deleteList: deleteList
+ .filter((item) => item)
+ .map((item) => {
+ return {
+ ...item,
+ triggerType: item?.Type,
+ };
+ }) as TriggerDetail[],
+ deployList: deployList.map((item) => {
+ delete item?.compared;
+ return item as TriggerDetail;
+ }),
+ };
+ }
+
+ // 删除函数触发器
+ async removeTrigger({
+ trigger,
+ name,
+ namespace = 'default',
+ }: {
+ name: string;
+ namespace: string;
+ trigger: TriggerDetail;
+ }) {
+ const { triggerType } = trigger;
+ const TriggerClass = TRIGGERS[triggerType];
+
+ if (TriggerClass) {
+ const triggerInstance = new TriggerClass({
+ credentials: this.credentials,
+ region: this.region,
+ });
+
+ await triggerInstance.delete({
+ scf: this,
+ region: this.region,
+ inputs: {
+ functionName: name,
+ namespace,
+ type: trigger?.Type,
+ triggerDesc: trigger?.TriggerDesc,
+ triggerName: trigger?.TriggerName,
+ qualifier: trigger?.Qualifier,
+ },
+ });
+ }
+ }
+
+ // 部署函数触发器
+ async createTrigger({
+ name,
+ namespace = 'default',
+ events = [],
+ }: {
+ name: string;
+ namespace?: string;
+ events?: any[];
+ }) {
+ console.log(`Deploying triggers for function ${name}`);
+
+ const triggerList = await this.getScfTriggers({ name, namespace });
+
+ // 由于大部分触发器类型（除了 API网关触发器）是无法更新的
+ // 因此如果用户更新了触发器配置，就需要先删除再创建
+ const { deleteList, deployList } = await this.filterTriggers({
+ name,
+ namespace,
+ events,
+ oldList: triggerList,
+ });
+
+ // 1. 删除老的无法更新的触发器
+ for (let i = 0, len = deleteList.length; i < len; i++) {
+ const trigger = deleteList[i];
+ // 若类型触发器不支持编辑，需要先删除，后重新创建;
+ if (!CAN_UPDATE_TRIGGER.includes(trigger?.Type)) {
+ await this.removeTrigger({
+ name,
+ namespace,
+ trigger,
+ });
+ } else {
+ // 若触发器类型支持编辑，直接跳过删除
+ continue;
+ }
+ }
+
+ // 2. 创建新的触发器
+ const apigwServiceList: SimpleApigwDetail[] = [];
+ for (let i = 0; i < deployList.length; i++) {
+ const trigger = deployList[i];
+ const { Type } = trigger;
+ if (trigger?.NeedCreate === true) {
+ const TriggerClass = TRIGGERS[Type];
+ if (!TriggerClass) {
+ throw new ApiError({
+ type: 'PARAMETER_ERROR',
+ message: `[TRIGGER] 未知触发器类型： ${Type}`,
+ });
+ }
+ const triggerInstance = new TriggerClass({
+ credentials: this.credentials,
+ region: this.region,
+ });
+
+ const triggerOutput = await triggerInstance.create({
+ scf: this,
+ region: this.region,
+ inputs: {
+ namespace,
+ functionName: name,
+ // 禁用自动发布
+ isAutoRelease: false,
+ ...trigger,
+ },
+ });
+ // 筛选出 API 网关触发器，可以单独的进行发布
+ if (triggerOutput.serviceId) {
+ apigwServiceList.push({
+ created: triggerOutput.created,
+ functionName: name,
+ serviceId: triggerOutput.serviceId,
+ serviceName: triggerOutput.serviceName,
+ environment: triggerOutput.environment,
+ apiList: triggerOutput.apiList || [],
+ });
+ }
+ this.runningTasks--;
+
+ deployList[i] = {
+ ...triggerOutput,
+ triggerType: Type,
+ };
+ } else {
+ deployList[i] = {
+ ...deployList[i],
+ triggerType: Type,
+ };
+ delete deployList[i].NeedCreate;
+ }
+ }
+ const outputs: { name: string; triggers: TriggerDetail[] } = {
+ name,
+ triggers: deployList,
+ };
+ return { outputs, apigwServiceList };
+ }
+
+ /**
+ * 初始化 API 网关触发器配置
+ * 说明：如果配置了 serviceId，检查是否确实存在，如果不存在则自动创建
+ * 如果没有配置，则直接创建
+ * @param triggerInputs API 网关触发器配置
+ * @returns {string} serviceId API 网关 ID
+ */
+ async initializeApigwService(triggerInputs: NewTriggerInputs) {
+ const { parameters } = triggerInputs;
+ let isServiceExist = false;
+ const { serviceId } = parameters;
+ const outputs = {
+ serviceId,
+ created: false,
+ };
+ if (serviceId) {
+ const detail = await this.apigwClient.service.getById(serviceId);
+ if (detail) {
+ isServiceExist = true;
+ }
+ }
+ if (!isServiceExist) {
+ const res = await this.apigwClient.deploy({
+ oldState: triggerInputs.parameters.oldState,
+ region: this.region,
+ protocols: parameters.protocols,
+ environment: parameters.environment,
+ serviceId: parameters.serviceId,
+ serviceName: parameters.serviceName,
+ serviceDesc: parameters.serviceDesc,
+
+ // 定制化需求：是否在 yaml 文件中配置了 apigw 触发器的 serviceId
+ isInputServiceId: parameters.isInputServiceId,
+
+ // 定制化需求：是否是删除云函数的api网关触发器，跟api网关组件区分开
+ isRemoveTrigger: true,
+ netTypes: parameters?.netTypes,
+ });
+ outputs.created = true;
+ outputs.serviceId = res?.serviceId;
+ }
+ return outputs;
+ }
+
+ /**
+ * 通过触发器中配置的 function 字段，获取涉及到的所有函数
+ * @param triggers 触发器配置列表
+ * @returns 函数列表
+ */
+ async getScfsByTriggers(triggers: NewTriggerInputs[] = []) {
+ for (let i = 0; i < triggers.length; i++) {
+ const curTrigger = triggers[i];
+ if (curTrigger.type === 'apigw') {
+ const { parameters } = curTrigger;
+ // 创建 网关
+ const { serviceId, created } = await this.initializeApigwService(curTrigger);
+ curTrigger.parameters.serviceId = serviceId;
+ const oldState = curTrigger.parameters.oldState ?? {};
+ oldState.created = created;
+ curTrigger.parameters.oldState = oldState;
+
+ const { endpoints = [] } = parameters;
+ for (let j = 0; j < endpoints?.length; j++) {
+ const curApi = endpoints[j];
+ const { name } = curApi.function!;
+ if (name && !this.scfNameCache[name]) {
+ this.scfNameCache[name] = curApi.function;
+ }
+ }
+ } else {
+ const { name } = curTrigger.function!;
+ if (!this.scfNameCache[name]) {
+ this.scfNameCache[name] = curTrigger.function;
+ }
+ }
+ }
+ return Object.values(this.scfNameCache);
+ }
+
+ /**
+ * 通过函数名称和触发器列表，获取当前函数名称的触发器配置
+ * @param options 获取函数触发器配置参数
+ * @returns 触发器配置
+ */
+ getScfTriggersConfig({ name, triggers = [] }: { name: string; triggers: NewTriggerInputs[] }) {
+ const cloneTriggers = deepClone(triggers);
+ return cloneTriggers.filter((item) => {
+ if (item.type === 'apigw') {
+ const {
+ parameters: { endpoints = [] },
+ } = item;
+
+ const apiList = endpoints.filter((api) => {
+ return api.function!.name === name;
+ });
+ item.parameters.endpoints = apiList;
+
+ return apiList.length > 0;
+ }
+ return item.function!.name === name;
+ });
+ }
+
+ /**
+ * 批量删除 API 网关，防止重复删除同一个网关
+ * @param list API 网关列表
+ */
+ async bulkRemoveApigw(list: SimpleApigwDetail[]) {
+ // 筛选非重复的网关服务
+ const uniqueList: SimpleApigwDetail[] = [];
+ const map: { [key: string]: number } = {};
+ list.forEach((item) => {
+ if (!map[item.serviceId]) {
+ map[item.serviceId] = 1;
+ uniqueList.push(item);
+ }
+ });
+
+ const releaseTask: Promise[] = [];
+ for (let i = 0; i < uniqueList.length; i++) {
+ const temp = uniqueList[i];
+ const exist = await this.apigwClient.service.getById(temp.serviceId);
+ if (exist) {
+ releaseTask.push(this.apigwClient.service.release(temp));
+ }
+ }
+ await Promise.all(releaseTask);
+ }
+ /**
+ * 批量发布 API 网关，防止重复发布同一个网关
+ * @param list API 网关列表
+ */
+ async bulkReleaseApigw(list: SimpleApigwDetail[]) {
+ // 筛选非重复的网关服务
+ const uniqueList: SimpleApigwDetail[] = [];
+ const map: { [key: string]: number } = {};
+ list.forEach((item) => {
+ if (!map[item.serviceId]) {
+ map[item.serviceId] = 1;
+ uniqueList.push(item);
+ }
+ });
+
+ const releaseTask: Promise[] = [];
+ for (let i = 0; i < uniqueList.length; i++) {
+ const temp = uniqueList[i];
+ const exist = await this.apigwClient.service.getById(temp.serviceId);
+ if (exist) {
+ releaseTask.push(this.apigwClient.service.release(temp));
+ }
+ }
+ await Promise.all(releaseTask);
+ }
+
+ /**
+ * 批量处理多函数关联的触发器配置
+ * @param triggers 触发器列表
+ * @returns 触发器部署 outputs
+ */
+ async bulkCreateTriggers(triggers: NewTriggerInputs[] = [], namespace = 'default') {
+ const scfList = await this.getScfsByTriggers(triggers);
+
+ let apigwList: SimpleApigwDetail[] = [];
+ const res = [];
+ for (let i = 0; i < scfList.length; i++) {
+ const curScf = scfList[i];
+ const triggersConfig = this.getScfTriggersConfig({
+ name: curScf.name,
+ triggers,
+ });
+ const task = async () => {
+ const { outputs, apigwServiceList } = await this.createTrigger({
+ name: curScf.name,
+ namespace: namespace,
+ events: triggersConfig,
+ });
+ apigwList = apigwList.concat(apigwServiceList);
+ return outputs;
+ };
+ const temp = await task();
+ res.push(temp);
+ }
+
+ await this.bulkReleaseApigw(apigwList);
+
+ return {
+ triggerList: res,
+ apigwList,
+ };
+ }
+
+ /**
+ * 批量删除指定函数的触发器
+ * @param options 参数
+ */
+ async bulkRemoveTriggers({
+ name,
+ namespace = 'default',
+ triggers = [],
+ }: {
+ name: string;
+ namespace: string;
+ triggers: TriggerDetail[];
+ }) {
+ const removeTasks: Promise[] = [];
+
+ triggers.forEach((item) => {
+ const pms = async () => {
+ await this.request({
+ Action: 'DeleteTrigger',
+ FunctionName: name,
+ Namespace: namespace,
+ Type: item.Type,
+ TriggerDesc: item.TriggerDesc,
+ TriggerName: item.TriggerName,
+ Qualifier: item.Qualifier,
+ });
+ };
+ removeTasks.push(pms());
+ });
+
+ await Promise.all(removeTasks);
+
+ return true;
+ }
+
+ /**
+ * 清理指定函数所有触发器
+ * @param options 参数
+ */
+ async clearScfTriggers({ name, namespace }: { name: string; namespace: string }) {
+ const list = await this.getScfTriggers({ name, namespace });
+
+ await this.bulkRemoveTriggers({
+ name,
+ namespace,
+ triggers: list,
+ });
+
+ return true;
+ }
+}
diff --git a/src/modules/triggers/mps.ts b/src/modules/triggers/mps.ts
new file mode 100644
index 00000000..f3869425
--- /dev/null
+++ b/src/modules/triggers/mps.ts
@@ -0,0 +1,169 @@
+import { ApiServiceType } from './../interface';
+import Scf from '../scf';
+import { TriggerInputs, MpsTriggerInputsParams, CreateTriggerReq } from './interface';
+import { MPS } from './apis';
+import { pascalCaseProps } from '../../utils/index';
+import BaseTrigger from './base';
+import { CapiCredentials, RegionType } from '../interface';
+import { TriggerManager } from './manager';
+
+export default class MpsTrigger extends BaseTrigger {
+ constructor({
+ credentials = {},
+ region = 'ap-guangzhou',
+ }: {
+ credentials?: CapiCredentials;
+ region?: RegionType;
+ }) {
+ super({ region, credentials, serviceType: ApiServiceType.mps });
+ }
+
+ async request({
+ Action,
+ ...data
+ }: {
+ Action: 'BindTrigger' | 'UnbindTrigger';
+ [key: string]: any;
+ }) {
+ const result = await MPS[Action](this.capi, pascalCaseProps(data));
+ return result;
+ }
+
+ getKey(triggerInputs: CreateTriggerReq) {
+ if (triggerInputs.ResourceId) {
+ // from ListTriggers API
+ const rStrArr = triggerInputs.ResourceId.split('/');
+ return `${rStrArr[rStrArr.length - 1]}`;
+ }
+
+ return `${triggerInputs.TriggerDesc?.eventType}Event`;
+ }
+
+ formatInputs({ inputs }: { region?: RegionType; inputs: TriggerInputs }) {
+ const { parameters } = inputs;
+ const triggerInputs: CreateTriggerReq = {
+ Type: 'mps',
+ Qualifier: parameters?.qualifier ?? '$DEFAULT',
+ TriggerName: '',
+ TriggerDesc: {
+ eventType: parameters?.type,
+ },
+
+ Enable: parameters?.enable ? 'OPEN' : 'CLOSE',
+ };
+
+ const triggerKey = this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ } as any;
+ }
+
+ async getTypeTrigger({
+ eventType,
+ functionName,
+ namespace,
+ qualifier,
+ }: {
+ eventType?: string;
+ functionName?: string;
+ namespace: string;
+ qualifier: string;
+ }) {
+ const allList = await this.getTriggerList({
+ functionName,
+ namespace,
+ qualifier,
+ });
+ const [exist] = allList.filter(
+ (item: { ResourceId: string }) =>
+ item.ResourceId.indexOf(`TriggerType/${eventType}Event`) !== -1,
+ );
+ if (exist) {
+ return exist;
+ }
+ return null;
+ }
+
+ async create({ inputs }: { inputs: TriggerInputs }) {
+ const { parameters } = inputs;
+ const qualifier = parameters?.qualifier ?? '$DEFAULT';
+ const namespace = inputs.namespace ?? 'default';
+ const output = {
+ namespace: inputs.namespace || 'default',
+ functionName: inputs.functionName,
+ ...parameters,
+ resourceId: undefined as undefined | string,
+ Qualifier: qualifier,
+ };
+ // check exist type trigger
+ const existTypeTrigger = await this.getTypeTrigger({
+ eventType: parameters?.type,
+ qualifier,
+ namespace: inputs.namespace ?? 'default',
+ functionName: inputs.functionName,
+ });
+ let needBind = false;
+ if (existTypeTrigger) {
+ if (parameters?.enable === false) {
+ await this.request({
+ Action: 'UnbindTrigger',
+ Type: 'mps',
+ Qualifier: qualifier,
+ FunctionName: inputs.functionName,
+ Namespace: namespace,
+ ResourceId: existTypeTrigger.ResourceId,
+ });
+ } else if (existTypeTrigger.BindStatus === 'off') {
+ needBind = true;
+ }
+ output.resourceId = existTypeTrigger.ResourceId;
+ } else {
+ needBind = true;
+ }
+
+ if (needBind) {
+ const res = await this.request({
+ Action: 'BindTrigger',
+ ScfRegion: this.region,
+ EventType: parameters?.type,
+ Qualifier: qualifier,
+ FunctionName: inputs.functionName,
+ Namespace: namespace,
+ });
+
+ output.resourceId = res.ResourceId;
+ }
+
+ return output;
+ }
+
+ async delete({
+ scf,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ inputs: TriggerInputs;
+ }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ const res = await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return {
+ requestId: res.RequestId,
+ success: true,
+ };
+ } catch (e) {
+ // console.log(e);
+ return false;
+ }
+ }
+}
diff --git a/src/modules/triggers/timer.ts b/src/modules/triggers/timer.ts
new file mode 100644
index 00000000..4a9016e2
--- /dev/null
+++ b/src/modules/triggers/timer.ts
@@ -0,0 +1,96 @@
+import Scf from '../scf';
+import { TriggerManager } from './manager';
+import { CapiCredentials, RegionType } from './../interface';
+import BaseTrigger, { TRIGGER_STATUS_MAP } from './base';
+import { TimerTriggerInputsParams, TriggerInputs, CreateTriggerReq } from './interface';
+
+export default class TimerTrigger extends BaseTrigger {
+ constructor({ credentials, region }: { credentials: CapiCredentials; region: RegionType }) {
+ super();
+ this.credentials = credentials;
+ this.region = region;
+ }
+
+ getKey(triggerInputs: CreateTriggerReq) {
+ // Very strange logical for Enable, fe post Enable is 'OPEN' or 'CLOSE'
+ // but get 1 or 0, parameter type cnaged......
+ const Enable = TRIGGER_STATUS_MAP[triggerInputs.Enable!];
+ // Very strange logical for TriggerDesc, fe post TriggerDesc is "0 */6 * * * * *"
+ // but get "{"cron":"0 */6 * * * * *"}"
+ const Desc =
+ triggerInputs.TriggerDesc?.indexOf('cron') !== -1
+ ? triggerInputs.TriggerDesc
+ : JSON.stringify({
+ cron: triggerInputs.TriggerDesc,
+ });
+ return `${triggerInputs.Type}-${triggerInputs.TriggerName}-${Desc}-${triggerInputs.CustomArgument}-${Enable}-${triggerInputs.Qualifier}`;
+ }
+
+ formatInputs({
+ inputs,
+ }: {
+ region: RegionType;
+ inputs: TriggerInputs;
+ }) {
+ const { parameters, name } = inputs;
+ const triggerInputs: CreateTriggerReq = {
+ Action: 'CreateTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: 'timer',
+ Qualifier: parameters?.qualifier || '$DEFAULT',
+ TriggerName: parameters?.name || name,
+ TriggerDesc: parameters?.cronExpression,
+ Enable: (parameters?.enable ? 'OPEN' : 'CLOSE') as 'OPEN' | 'CLOSE',
+
+ CustomArgument: parameters?.argument ?? undefined,
+ };
+
+ const triggerKey = this.getKey(triggerInputs);
+
+ return {
+ triggerInputs,
+ triggerKey,
+ } as any;
+ }
+ async create({
+ scf,
+ region,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ region: RegionType;
+ inputs: TriggerInputs;
+ }) {
+ const { triggerInputs } = this.formatInputs({ region, inputs });
+ console.log(`Creating ${triggerInputs.Type} trigger ${triggerInputs.TriggerName}`);
+
+ const { TriggerInfo } = await scf.request(triggerInputs);
+ TriggerInfo.Qualifier = TriggerInfo.Qualifier || triggerInputs.Qualifier;
+ return TriggerInfo;
+ }
+ async delete({
+ scf,
+ inputs,
+ }: {
+ scf: Scf | TriggerManager;
+ inputs: TriggerInputs;
+ }) {
+ console.log(`Removing ${inputs.type} trigger ${inputs.triggerName}`);
+ try {
+ await scf.request({
+ Action: 'DeleteTrigger',
+ FunctionName: inputs.functionName,
+ Namespace: inputs.namespace,
+ Type: inputs.type,
+ TriggerDesc: inputs.triggerDesc,
+ TriggerName: inputs.triggerName,
+ Qualifier: inputs.qualifier,
+ });
+ return true;
+ } catch (e) {
+ console.log(e);
+ return false;
+ }
+ }
+}
diff --git a/src/modules/triggers/utils/index.ts b/src/modules/triggers/utils/index.ts
new file mode 100644
index 00000000..5b3e1e8a
--- /dev/null
+++ b/src/modules/triggers/utils/index.ts
@@ -0,0 +1,41 @@
+import { RegionType } from "../../interface";
+import Scf from "../../scf";
+import { CkafkaTriggerInputsParams, HttpTriggerInputsParams, TriggerDetail, TriggerInputs } from "../interface";
+import { TriggerManager } from "../manager";
+
+// 获取函数下指定类型以及指定触发器名称的触发器
+export async function getScfTriggerByName({
+ scf,
+ inputs
+ }: {
+ scf: Scf | TriggerManager;
+ region: RegionType;
+ inputs: TriggerInputs;
+ }): Promise {
+ const filters = [
+ {
+ Name: 'Type',
+ Values: [inputs?.type || inputs?.Type]
+ }
+ ]
+ if (inputs?.parameters?.name) {
+ filters.push({
+ Name: 'TriggerName',
+ Values: [inputs?.parameters?.name]
+ })
+ }
+ if (inputs?.parameters?.qualifier) {
+ filters.push({
+ Name: 'Qualifier',
+ Values: [inputs?.parameters?.qualifier?.toString()]
+ })
+ }
+ const response = await scf.request({
+ Action: 'ListTriggers',
+ FunctionName: inputs?.functionName,
+ Namespace: inputs?.namespace,
+ Limit: 1000,
+ Filters: filters
+ });
+ return response?.Triggers?.[0];
+}
\ No newline at end of file
diff --git a/src/modules/vpc/apis.js b/src/modules/vpc/apis.ts
similarity index 58%
rename from src/modules/vpc/apis.js
rename to src/modules/vpc/apis.ts
index 80dcbd0a..6ccfe809 100644
--- a/src/modules/vpc/apis.js
+++ b/src/modules/vpc/apis.ts
@@ -1,4 +1,5 @@
-const { ApiFactory } = require('../../utils/api');
+import { ApiFactory } from '../../utils/api';
+import { ApiServiceType } from '../interface';
const ACTIONS = [
'CreateDefaultVpc',
@@ -10,13 +11,15 @@ const ACTIONS = [
'DescribeSubnets',
'ModifyVpcAttribute',
'ModifySubnetAttribute',
-];
+] as const;
+
+export type ActionType = typeof ACTIONS[number];
const APIS = ApiFactory({
// debug: true,
- serviceType: 'vpc',
+ serviceType: ApiServiceType.vpc,
version: '2017-03-12',
actions: ACTIONS,
});
-module.exports = APIS;
+export default APIS;
diff --git a/src/modules/vpc/index.js b/src/modules/vpc/index.js
deleted file mode 100644
index 728ed95f..00000000
--- a/src/modules/vpc/index.js
+++ /dev/null
@@ -1,164 +0,0 @@
-const { Capi } = require('@tencent-sdk/capi');
-const utils = require('./utils');
-const { TypeError } = require('../../utils/error');
-
-class Vpc {
- constructor(credentials = {}, region) {
- this.region = region || 'ap-guangzhou';
- this.credentials = credentials;
- this.capi = new Capi({
- Region: region,
- AppId: credentials.AppId,
- SecretId: credentials.SecretId,
- SecretKey: credentials.SecretKey,
- Token: credentials.Token,
- });
- }
-
- async deploy(inputs) {
- const {
- zone,
- vpcName,
- subnetName,
- cidrBlock,
- enableMulticast,
- dnsServers,
- domainName,
- tags,
- subnetTags,
- enableSubnetBroadcast,
- } = inputs;
-
- let { vpcId, subnetId } = inputs;
-
- const handleVpc = async (vId) => {
- let existVpc = false;
- if (vId) {
- const detail = await utils.getVpcDetail(this.capi, vId);
- if (detail) {
- existVpc = true;
- }
- }
- const params = {
- VpcName: vpcName,
- };
- if (enableMulticast) {
- params.EnableMulticast = enableMulticast;
- }
- if (dnsServers) {
- params.DnsServers = dnsServers;
- }
- if (domainName) {
- params.DomainName = domainName;
- }
- if (existVpc) {
- console.log(`Updating vpc ${vId}...`);
- params.VpcId = vId;
- await utils.modifyVpc(this.capi, params);
- console.log(`Update vpc ${vId} success`);
- } else {
- if (!cidrBlock) {
- throw new TypeError('PARAMETER_VPC', 'cidrBlock is required');
- }
- params.CidrBlock = cidrBlock;
- if (tags) {
- params.Tags = tags;
- }
- console.log(`Creating vpc ${vpcName}...`);
- const res = await utils.createVpc(this.capi, params);
- console.log(`Create vpc ${vpcName} success.`);
- vId = res.VpcId;
- }
- return vId;
- };
-
- // check subnetId
- const handleSubnet = async (vId, sId) => {
- let existSubnet = false;
- if (sId) {
- const detail = await utils.getSubnetDetail(this.capi, sId);
- if (detail) {
- existSubnet = true;
- }
- }
- const params = {
- SubnetName: subnetName,
- };
- if (existSubnet) {
- console.log(`Updating subnet ${sId}...`);
- params.SubnetId = sId;
-
- if (enableSubnetBroadcast !== undefined) {
- params.EnableBroadcast = enableSubnetBroadcast;
- }
- await utils.modifySubnet(this.capi, params);
- console.log(`Update subnet ${sId} success.`);
- } else {
- if (vId) {
- console.log(`Creating subnet ${subnetName}...`);
- params.Zone = zone;
- params.VpcId = vId;
- params.CidrBlock = cidrBlock;
- if (subnetTags) {
- params.Tags = subnetTags;
- }
-
- const res = await utils.createSubnet(this.capi, params);
- sId = res.SubnetId;
-
- if (enableSubnetBroadcast === true) {
- await utils.modifySubnet(this.capi, {
- SubnetId: sId,
- EnableBroadcast: enableSubnetBroadcast,
- });
- }
- console.log(`Create subnet ${subnetName} success.`);
- }
- }
- return sId;
- };
-
- if (vpcName) {
- vpcId = await handleVpc(vpcId);
- }
-
- if (subnetName) {
- subnetId = await handleSubnet(vpcId, subnetId);
- }
-
- return {
- region: this.region,
- zone,
- vpcId,
- vpcName,
- subnetId,
- subnetName,
- };
- }
-
- async remove(inputs) {
- const { vpcId, subnetId } = inputs;
- if (subnetId) {
- console.log(`Start removing subnet ${subnetId}`);
- try {
- await utils.deleteSubnet(this.capi, subnetId);
- } catch (e) {
- console.log(e);
- }
- console.log(`Removed subnet ${subnetId}`);
- }
- if (vpcId) {
- console.log(`Start removing vpc ${vpcId}`);
- try {
- await utils.deleteVpc(this.capi, vpcId);
- } catch (e) {
- console.log(e);
- }
- console.log(`Removed vpc ${vpcId}`);
- }
-
- return {};
- }
-}
-
-module.exports = Vpc;
diff --git a/src/modules/vpc/index.test.js b/src/modules/vpc/index.test.js
deleted file mode 100644
index a507e555..00000000
--- a/src/modules/vpc/index.test.js
+++ /dev/null
@@ -1,25 +0,0 @@
-const Vpc = require('./index');
-
-async function runTest() {
- const credentials = {
- SecretId: '',
- SecretKey: '',
- };
- const inputs = {
- region: 'ap-guangzhou',
- zone: 'ap-guangzhou-2',
- subnetId: 'subnet-3ofyccsy',
- subnetName: 'serverless1',
- cidrBlock: '10.0.0.0/16',
- };
- const vpc = new Vpc(credentials, inputs.region);
- const outputs = await vpc.deploy(inputs);
-
- await vpc.remove(outputs);
-}
-
-runTest();
-
-process.on('unhandledRejection', (e) => {
- console.log(e);
-});
diff --git a/src/modules/vpc/index.ts b/src/modules/vpc/index.ts
new file mode 100644
index 00000000..1e658c0c
--- /dev/null
+++ b/src/modules/vpc/index.ts
@@ -0,0 +1,208 @@
+import { RegionType, CapiCredentials, ApiServiceType } from './../interface';
+import { Capi } from '@tencent-sdk/capi';
+import utils from './utils';
+import { ApiTypeError } from '../../utils/error';
+import { VpcDeployInputs, VpcRemoveInputs, VpcOutputs } from './interface';
+import TagClient from '../tag';
+
+export default class Vpc {
+ region: RegionType;
+ credentials: CapiCredentials;
+ capi: Capi;
+ tagClient: TagClient;
+
+ constructor(credentials: CapiCredentials = {}, region: RegionType = 'ap-guangzhou') {
+ this.region = region;
+ this.credentials = credentials;
+ this.capi = new Capi({
+ Region: this.region,
+ ServiceType: ApiServiceType.vpc,
+ SecretId: credentials.SecretId!,
+ SecretKey: credentials.SecretKey!,
+ Token: credentials.Token,
+ });
+
+ this.tagClient = new TagClient(this.credentials, this.region);
+ }
+
+ async deploy(inputs: VpcDeployInputs) {
+ const {
+ zone,
+ vpcName,
+ subnetName,
+ cidrBlock,
+ enableMulticast,
+ dnsServers,
+ domainName,
+ tags,
+ subnetTags,
+ enableSubnetBroadcast,
+ } = inputs;
+
+ let { vpcId, subnetId } = inputs;
+
+ const handleVpc = async (vId: string) => {
+ let existVpc = false;
+ if (vId) {
+ const detail = await utils.getVpcDetail(this.capi, vId);
+ if (detail) {
+ existVpc = true;
+ }
+ }
+ const params = {
+ VpcName: vpcName,
+ EnableMulticast: enableMulticast,
+ DnsServers: dnsServers,
+ DomainName: domainName,
+ VpcId: undefined as string | undefined,
+ };
+
+ /** 修改旧的 Vpc */
+ if (existVpc) {
+ console.log(`Updating vpc ${vId}...`);
+ params.VpcId = vId;
+ await utils.modifyVpc(this.capi, params);
+ console.log(`Update vpc ${vId} success`);
+ } else {
+ /** 添加新的 Vpc */
+ if (!cidrBlock) {
+ throw new ApiTypeError('PARAMETER_VPC', 'cidrBlock is required');
+ }
+
+ console.log(`Creating vpc ${vpcName}...`);
+ const res = await utils.createVpc(this.capi, {
+ ...params,
+ ...{ CidrBlock: cidrBlock },
+ });
+ console.log(`Create vpc ${vpcName} success.`);
+ vId = res.VpcId;
+ }
+
+ const formateTags = this.tagClient.formatInputTags(tags as any);
+ if (formateTags) {
+ try {
+ await this.tagClient.deployResourceTags({
+ tags: formateTags.map(({ key, value }) => ({ TagKey: key, TagValue: value })),
+ resourceId: vId,
+ serviceType: ApiServiceType.vpc,
+ resourcePrefix: 'vpc',
+ });
+ } catch (e) {
+ console.log(`[TAG] ${e.message}`);
+ }
+ }
+
+ return vId;
+ };
+
+ // check subnetId
+ const handleSubnet = async (vId: string, sId: string) => {
+ let existSubnet = false;
+ if (sId) {
+ const detail = await utils.getSubnetDetail(this.capi, sId);
+ if (detail) {
+ existSubnet = true;
+ }
+ }
+ const params = {
+ SubnetName: subnetName,
+ SubnetId: undefined as string | undefined,
+ EnableBroadcast: undefined as boolean | undefined,
+ Zone: undefined as string | undefined,
+ VpcId: undefined as string | undefined,
+ CidrBlock: undefined as string | undefined,
+ };
+
+ /** 子网已存在 */
+ if (existSubnet) {
+ console.log(`Updating subnet ${sId}...`);
+ params.SubnetId = sId;
+ params.EnableBroadcast = enableSubnetBroadcast;
+
+ await utils.modifySubnet(this.capi, params);
+ console.log(`Update subnet ${sId} success.`);
+ } else {
+ /** 子网不存在 */
+ if (vId) {
+ console.log(`Creating subnet ${subnetName}...`);
+ params.Zone = zone;
+ params.VpcId = vId;
+ params.CidrBlock = cidrBlock;
+
+ const res = await utils.createSubnet(this.capi, params);
+ sId = res.SubnetId;
+
+ if (enableSubnetBroadcast === true) {
+ await utils.modifySubnet(this.capi, {
+ SubnetId: sId,
+ EnableBroadcast: enableSubnetBroadcast,
+ });
+ }
+ console.log(`Create subnet ${subnetName} success.`);
+ }
+ }
+
+ const subnetTagList = this.tagClient.formatInputTags((subnetTags ? subnetTags : tags) as any);
+ if (subnetTagList) {
+ try {
+ await this.tagClient.deployResourceTags({
+ tags: subnetTagList.map(({ key, value }) => ({ TagKey: key, TagValue: value })),
+ resourceId: sId,
+ serviceType: ApiServiceType.vpc,
+ resourcePrefix: 'subnet',
+ });
+ } catch (e) {
+ console.log(`[TAG] ${e.message}`);
+ }
+ }
+ return sId;
+ };
+
+ if (vpcName) {
+ vpcId = await handleVpc(vpcId!);
+ }
+
+ if (subnetName) {
+ subnetId = await handleSubnet(vpcId!, subnetId!);
+ }
+
+ const outputs: VpcOutputs = {
+ region: this.region,
+ zone,
+ vpcId: vpcId!,
+ vpcName,
+ subnetId: subnetId!,
+ subnetName,
+ };
+
+ if (tags && tags.length > 0) {
+ outputs.tags = tags;
+ }
+
+ return outputs;
+ }
+
+ async remove(inputs: VpcRemoveInputs) {
+ const { vpcId, subnetId } = inputs;
+ if (subnetId) {
+ console.log(`Start removing subnet ${subnetId}`);
+ try {
+ await utils.deleteSubnet(this.capi, subnetId);
+ } catch (e) {
+ console.log(e);
+ }
+ console.log(`Removed subnet ${subnetId}`);
+ }
+ if (vpcId) {
+ console.log(`Start removing vpc ${vpcId}`);
+ try {
+ await utils.deleteVpc(this.capi, vpcId);
+ } catch (e) {
+ console.log(e);
+ }
+ console.log(`Removed vpc ${vpcId}`);
+ }
+
+ return {};
+ }
+}
diff --git a/src/modules/vpc/interface.ts b/src/modules/vpc/interface.ts
new file mode 100644
index 00000000..78078342
--- /dev/null
+++ b/src/modules/vpc/interface.ts
@@ -0,0 +1,82 @@
+import { RegionType, TagInput } from './../interface';
+export interface VpcDeployInputs {
+ region?: RegionType;
+ zone: string;
+ vpcName: string;
+ subnetName: string;
+
+ cidrBlock?: string;
+ enableMulticast?: boolean;
+ dnsServers?: string[];
+ domainName?: string;
+ tags?: TagInput[];
+ subnetTags?: TagInput[];
+ enableSubnetBroadcast?: boolean;
+
+ vpcId?: string;
+ subnetId?: string;
+}
+
+export interface VpcRemoveInputs {
+ vpcId: string;
+ subnetId: string;
+}
+
+export interface Tag {
+ Key: string;
+ Value: string;
+}
+
+export interface DefaultVpcItem {
+ VpcId: string;
+ SubnetId: string;
+ VpcName: string;
+ SubnetName: string;
+ CidrBlock: string;
+ DhcpOptionsId: string;
+ DnsServerSet: string[];
+ DomainName: string;
+}
+export interface VpcItem {
+ VpcId: string;
+ VpcName: string;
+ CidrBlock: string;
+ Ipv6CidrBlock: string;
+ IsDefault: boolean;
+ EnableMulticast: boolean;
+ EnableDhcp: boolean;
+ CreatedTime: string;
+ DhcpOptionsId: string;
+ DnsServerSet: string[];
+ DomainName: string;
+ TagSet: { Key: string; Value: string }[];
+ AssistantCidrSet: any[];
+}
+export interface SubnetItem {
+ NetworkAclId: string;
+ RouteTableId: string;
+ VpcId: string;
+ EnableBroadcast: boolean;
+ Zone: string;
+ Ipv6CidrBlock: string;
+ AvailableIpAddressCount: number;
+ IsRemoteVpcSnat: boolean;
+ SubnetName: string;
+ TotalIpAddressCount: number;
+ TagSet: { Key: string; Value: string }[];
+ CreatedTime: string;
+ SubnetId: string;
+ CidrBlock: string;
+ IsDefault: boolean;
+}
+
+export interface VpcOutputs {
+ region: string;
+ zone: string;
+ vpcId: string;
+ vpcName: string;
+ subnetId: string;
+ subnetName: string;
+
+ tags?: TagInput[];
+}
diff --git a/src/modules/vpc/utils.js b/src/modules/vpc/utils.js
deleted file mode 100644
index 9591cf90..00000000
--- a/src/modules/vpc/utils.js
+++ /dev/null
@@ -1,97 +0,0 @@
-const {
- DescribeVpcs,
- DescribeSubnets,
- CreateVpc,
- DeleteVpc,
- CreateSubnet,
- DeleteSubnet,
- ModifyVpcAttribute,
- ModifySubnetAttribute,
-} = require('./apis');
-
-const utils = {
- /**
- *
- * @param {object} capi capi instance
- * @param {string} vpcId
- */
- async getVpcDetail(capi, vpcId) {
- // get instance detail
- try {
- const res = await DescribeVpcs(capi, {
- VpcIds: [vpcId],
- });
- if (res.VpcSet) {
- const {
- VpcSet: [detail],
- } = res;
- return detail;
- }
- return null;
- } catch (e) {
- console.log(e);
- return null;
- }
- },
-
- /**
- *
- * @param {object} capi capi instance
- * @param {string} vpcId
- */
- async getSubnetDetail(capi, subnetId) {
- try {
- const res = await DescribeSubnets(capi, {
- SubnetIds: [subnetId],
- });
- if (res.SubnetSet) {
- const {
- SubnetSet: [detail],
- } = res;
- return detail;
- }
- return null;
- } catch (e) {
- console.log(e);
- return null;
- }
- },
-
- async createVpc(capi, inputs) {
- const res = await CreateVpc(capi, inputs);
- if (res.Vpc && res.Vpc.VpcId) {
- const { Vpc } = res;
- return Vpc;
- }
- },
-
- async modifyVpc(capi, inputs) {
- await ModifyVpcAttribute(capi, inputs);
- },
-
- async deleteVpc(capi, vpcId) {
- await DeleteVpc(capi, {
- VpcId: vpcId,
- });
- },
-
- async createSubnet(capi, inputs) {
- const res = await CreateSubnet(capi, inputs);
- if (res.Subnet && res.Subnet.SubnetId) {
- const { Subnet } = res;
- return Subnet;
- }
- },
-
- async modifySubnet(capi, inputs) {
- await ModifySubnetAttribute(capi, inputs);
- },
-
- async deleteSubnet(capi, subnetId) {
- await DeleteSubnet(capi, {
- SubnetId: subnetId,
- });
- },
-};
-
-module.exports = utils;
diff --git a/src/modules/vpc/utils.ts b/src/modules/vpc/utils.ts
new file mode 100644
index 00000000..80d496a6
--- /dev/null
+++ b/src/modules/vpc/utils.ts
@@ -0,0 +1,228 @@
+import { Capi } from '@tencent-sdk/capi';
+import { deepClone } from '../../utils';
+import APIS from './apis';
+import { VpcItem, SubnetItem, DefaultVpcItem } from './interface';
+
+const utils = {
+ /**
+ *
+ * @param {object} capi capi instance
+ * @param {string} vpcId
+ */
+ async getVpcDetail(capi: Capi, vpcId: string) {
+ // get instance detail
+ try {
+ const res = await APIS.DescribeVpcs(capi, {
+ VpcIds: [vpcId],
+ });
+ if (res.VpcSet) {
+ const {
+ VpcSet: [detail],
+ } = res;
+ return detail;
+ }
+ return null;
+ } catch (e) {
+ console.log(e);
+ return null;
+ }
+ },
+
+ /**
+ *
+ * @param {object} capi capi instance
+ * @param {string} vpcId
+ */
+ async getSubnetDetail(capi: Capi, subnetId: string) {
+ try {
+ const res = await APIS.DescribeSubnets(capi, {
+ SubnetIds: [subnetId],
+ });
+ if (res.SubnetSet) {
+ const {
+ SubnetSet: [detail],
+ } = res;
+ return detail;
+ }
+ return null;
+ } catch (e) {
+ console.log(e);
+ return null;
+ }
+ },
+
+ async createVpc(
+ capi: Capi,
+ inputs: {
+ VpcName: string;
+ EnableMulticast?: boolean;
+ DnsServers?: string[];
+ DomainName?: string;
+ VpcId?: string;
+ },
+ ) {
+ // clean undefined
+ inputs = deepClone(inputs);
+ const res = await APIS.CreateVpc(capi, inputs);
+ if (res.Vpc && res.Vpc.VpcId) {
+ const { Vpc } = res;
+ return Vpc;
+ }
+ },
+
+ async modifyVpc(
+ capi: Capi,
+ inputs: {
+ VpcName: string;
+ EnableMulticast?: boolean;
+ DnsServers?: string[];
+ DomainName?: string;
+ VpcId?: string;
+ },
+ ) {
+ // clean undefined
+ inputs = deepClone(inputs);
+ await APIS.ModifyVpcAttribute(capi, inputs);
+ },
+
+ async deleteVpc(capi: Capi, vpcId: string) {
+ await APIS.DeleteVpc(capi, {
+ VpcId: vpcId,
+ });
+ },
+
+ async createSubnet(
+ capi: Capi,
+ inputs: {
+ SubnetName: string;
+ SubnetId?: string;
+ EnableBroadcast?: boolean;
+ Zone?: string;
+ VpcId?: string;
+ CidrBlock?: string;
+ Tags?: string[];
+ },
+ ) {
+ // clean undefined
+ inputs = deepClone(inputs);
+ const res = await APIS.CreateSubnet(capi, inputs);
+ if (res.Subnet && res.Subnet.SubnetId) {
+ const { Subnet } = res;
+ return Subnet;
+ }
+ },
+
+ async modifySubnet(
+ capi: Capi,
+ inputs: {
+ SubnetName?: string;
+ SubnetId?: string;
+ EnableBroadcast?: boolean;
+ Zone?: string;
+ VpcId?: string;
+ CidrBlock?: string;
+ Tags?: string[];
+ },
+ ) {
+ // clean undefined
+ inputs = deepClone(inputs);
+ await APIS.ModifySubnetAttribute(capi, inputs);
+ },
+
+ async deleteSubnet(capi: Capi, subnetId: string) {
+ await APIS.DeleteSubnet(capi, {
+ SubnetId: subnetId,
+ });
+ },
+
+ /**
+ * get default vpc
+ * @param {object} capi capi instance
+ * @param {string} vpcId
+ */
+ async getDefaultVpc(capi: Capi): Promise {
+ try {
+ const res = await APIS.DescribeVpcs(capi, {
+ Offset: 0,
+ Limit: 100,
+ });
+
+ if (res.VpcSet) {
+ const [defaultVpc] = res.VpcSet.filter((item: VpcItem) => {
+ return item.IsDefault;
+ });
+ return defaultVpc || null;
+ }
+ return null;
+ } catch (e) {
+ console.log(e);
+ return null;
+ }
+ },
+
+ /**
+ * get default vpc
+ * @param {object} capi capi instance
+ * @param {string} vpcId
+ */
+ async getSubnetList(capi: Capi, vpcId: string) {
+ try {
+ const res = await APIS.DescribeSubnets(capi, {
+ Offset: 0,
+ Limit: 100,
+ Filters: [
+ {
+ Name: 'vpc-id',
+ Values: [vpcId],
+ },
+ ],
+ });
+ if (res.SubnetSet) {
+ return res.SubnetSet || null;
+ }
+ return null;
+ } catch (e) {
+ console.log(e);
+ return null;
+ }
+ },
+ /**
+ * get default subnet
+ * @param {object} capi capi instance
+ * @param {string} vpcId
+ */
+ async getDefaultSubnet(capi: Capi, vpcId: string): Promise {
+ const subnetList = await this.getSubnetList(capi, vpcId);
+ const [defaultSubnet] = (subnetList || []).filter((item: SubnetItem) => {
+ return item.IsDefault;
+ });
+
+ return defaultSubnet || null;
+ },
+
+ /**
+ * create default vpc
+ * @param capi capi instance
+ * @param zone zone
+ * @returns
+ */
+ async createDefaultVpc(capi: Capi, zone?: string): Promise {
+ // clean undefined
+ const params: { Zone?: string } = {};
+ if (zone) {
+ params.Zone = zone;
+ }
+ const { Vpc } = await APIS.CreateDefaultVpc(capi, params);
+ return Vpc;
+ },
+
+ async isDhcpEnable(capi: Capi, vpcId: string): Promise {
+ const res = await this.getVpcDetail(capi, vpcId);
+ if (res) {
+ return res.EnableDhcp;
+ }
+ return false;
+ },
+};
+
+export default utils;
diff --git a/src/utils/api.js b/src/utils/api.ts
similarity index 52%
rename from src/utils/api.js
rename to src/utils/api.ts
index 7b8586dd..cb6d497d 100644
--- a/src/utils/api.js
+++ b/src/utils/api.ts
@@ -1,11 +1,14 @@
-const { ApiError } = require('./error');
+import { Capi } from '@tencent-sdk/capi';
+import { deepClone } from '.';
+import { ApiServiceType } from '../modules/interface';
+import { ApiError } from './error';
-function isEmpty(val) {
+function isEmpty(val: T) {
return val === undefined || val === null || (typeof val === 'number' && isNaN(val));
}
-function cleanEmptyValue(obj) {
- const newObj = {};
+function cleanEmptyValue(obj: T): T {
+ const newObj: any = {};
for (const key in obj) {
const val = obj[key];
if (!isEmpty(val)) {
@@ -15,25 +18,40 @@ function cleanEmptyValue(obj) {
return newObj;
}
-function ApiFactory({
+interface ApiFactoryOptions {
+ serviceType: ApiServiceType;
+ version: string;
+ actions: ACTIONS_T;
+
+ debug?: boolean;
+ isV3?: boolean;
+ host?: string;
+ path?: string;
+ customHandler?: (action: string, res: any) => any;
+ responseHandler?: (res: any) => any;
+ errorHandler?: (action: string, res: any) => any;
+}
+
+export function ApiFactory({
debug = false,
- isV3 = true,
+ isV3 = false,
actions,
serviceType,
host,
path,
version,
customHandler,
- responseHandler = (res) => res,
+ responseHandler = (res: any) => res,
errorHandler,
-}) {
- const apis = {};
- actions.forEach((action) => {
- apis[action] = async (capi, inputs) => {
+}: ApiFactoryOptions) {
+ const SERVICE_TYPE = serviceType;
+ const APIS: Record any> = {} as any;
+ actions.forEach((action: ACTIONS_T[number]) => {
+ APIS[action] = async (capi: Capi, inputs: any) => {
+ inputs = deepClone(inputs);
const reqData = cleanEmptyValue({
Action: action,
Version: version,
- Token: capi.options.Token || null,
...inputs,
});
inputs = cleanEmptyValue(inputs);
@@ -42,7 +60,6 @@ function ApiFactory({
isV3: isV3,
debug: debug,
RequestClient: 'ServerlessComponentV2',
- ServiceType: serviceType,
host: host || `${serviceType}.tencentcloudapi.com`,
path: path || '/',
});
@@ -56,8 +73,8 @@ function ApiFactory({
return errorHandler(action, Response);
}
throw new ApiError({
- type: `API_${serviceType.toUpperCase()}_${action}`,
- message: `${Response.Error.Message} (reqId: ${Response.RequestId})`,
+ type: `API_${SERVICE_TYPE}_${action}`,
+ message: `[${SERVICE_TYPE}] ${Response.Error.Message} (reqId: ${Response.RequestId})`,
reqId: Response.RequestId,
code: Response.Error.Code,
});
@@ -65,8 +82,8 @@ function ApiFactory({
return responseHandler(Response);
} catch (e) {
throw new ApiError({
- type: `API_${serviceType.toUpperCase()}_${action}`,
- message: e.message,
+ type: `API_${SERVICE_TYPE}_${action}`,
+ message: `[${SERVICE_TYPE}] ${e.message}`,
stack: e.stack,
reqId: e.reqId,
code: e.code,
@@ -75,9 +92,5 @@ function ApiFactory({
};
});
- return apis;
+ return APIS;
}
-
-module.exports = {
- ApiFactory,
-};
diff --git a/src/utils/dayjs.ts b/src/utils/dayjs.ts
new file mode 100644
index 00000000..632295f2
--- /dev/null
+++ b/src/utils/dayjs.ts
@@ -0,0 +1,21 @@
+import dayjs, { Dayjs, ConfigType } from 'dayjs';
+import tz from 'dayjs/plugin/timezone';
+import utc from 'dayjs/plugin/utc';
+
+dayjs.extend(tz);
+dayjs.extend(utc);
+
+dayjs.tz.setDefault('Asia/Shanghai');
+
+const dtz = (date: ConfigType = Date.now()) => {
+ return dayjs.tz(date);
+};
+
+const TIME_FORMAT = 'YYYY-MM-DD HH:mm:ss';
+const TIME_FORMAT_TIMEZONE = 'YYYY-MM-DDTHH:mm:ssZ';
+
+function formatDate(date: ConfigType, withTimeout = false): string {
+ return dtz(date).format(withTimeout ? TIME_FORMAT_TIMEZONE : TIME_FORMAT);
+}
+
+export { dayjs, dtz, Dayjs, TIME_FORMAT, formatDate };
diff --git a/src/utils/error.js b/src/utils/error.js
deleted file mode 100644
index 7c2250e2..00000000
--- a/src/utils/error.js
+++ /dev/null
@@ -1,33 +0,0 @@
-function TypeError(type, msg, stack, reqId, displayMsg) {
- const err = new Error(msg);
- err.type = type;
- if (stack) {
- err.stack = stack;
- }
- if (reqId) {
- err.reqId = reqId;
- }
- err.displayMsg = displayMsg || msg;
- return err;
-}
-
-function ApiError({ type, message, stack, reqId, displayMsg, code }) {
- const err = new Error(message);
- err.type = type;
- if (stack) {
- err.stack = stack;
- }
- if (reqId) {
- err.reqId = reqId;
- }
- if (code) {
- err.code = code;
- }
- err.displayMsg = displayMsg || message;
- return err;
-}
-
-module.exports = {
- TypeError,
- ApiError,
-};
diff --git a/src/utils/error.test.js b/src/utils/error.test.js
deleted file mode 100644
index 582db9f0..00000000
--- a/src/utils/error.test.js
+++ /dev/null
@@ -1,12 +0,0 @@
-const assert = require('assert');
-const { TypeError } = require('./error');
-
-try {
- throw new TypeError('TEST_ERROR', 'This is a test error', null, 123, 'error test');
-} catch (e) {
- assert.equal(e.type, 'TEST_ERROR');
- assert.equal(e.message, 'This is a test error');
- assert.equal(typeof e.stack, 'string');
- assert.equal(e.reqId, 123);
- assert.equal(e.displayMsg, 'error test');
-}
diff --git a/src/utils/error.ts b/src/utils/error.ts
new file mode 100644
index 00000000..8b56492b
--- /dev/null
+++ b/src/utils/error.ts
@@ -0,0 +1,60 @@
+export class ApiTypeError extends Error {
+ type: string;
+ stack?: string;
+ reqId?: string | number;
+ displayMsg: string;
+
+ constructor(
+ type: string,
+ msg: string,
+ stack?: string,
+ reqId?: string | number,
+ displayMsg?: string,
+ ) {
+ super(msg);
+
+ this.type = type;
+ this.displayMsg = displayMsg ?? msg;
+ if (stack) {
+ this.stack = stack;
+ }
+ if (reqId) {
+ this.reqId = reqId;
+ }
+ }
+}
+
+/** @deprecated 不要使用和 JS 默认错误类型重名的 TypeError，可用 ApiTypeError 代替 */
+export const TypeError = ApiTypeError;
+
+interface ApiErrorOptions {
+ message: string;
+ stack?: string;
+ type: string;
+ reqId?: string | number;
+ code?: string;
+ displayMsg?: string;
+}
+
+export class ApiError extends Error {
+ type: string;
+ reqId?: string | number;
+ code?: string;
+ displayMsg: string;
+
+ constructor({ type, message, stack, reqId, displayMsg, code }: ApiErrorOptions) {
+ super(message);
+ this.type = type;
+ if (stack) {
+ this.stack = stack;
+ }
+ if (reqId) {
+ this.reqId = reqId;
+ }
+ if (code) {
+ this.code = code;
+ }
+ this.displayMsg = displayMsg ?? message;
+ return this;
+ }
+}
diff --git a/src/utils/index.js b/src/utils/index.js
deleted file mode 100644
index 8445a49e..00000000
--- a/src/utils/index.js
+++ /dev/null
@@ -1,183 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-
-/**
- * simple deep clone object
- * @param {object} obj object
- */
-function deepClone(obj) {
- return JSON.parse(JSON.stringify(obj));
-}
-
-/**
- * return variable real type
- * @param {any} obj input variable
- */
-function getRealType(obj) {
- return Object.prototype.toString.call(obj).slice(8, -1);
-}
-
-/**
- * is array
- * @param obj object
- */
-function isArray(obj) {
- return Object.prototype.toString.call(obj) == '[object Array]';
-}
-
-/**
- * is object
- * @param obj object
- */
-function isObject(obj) {
- return obj === Object(obj);
-}
-
-/**
- * iterate object or array
- * @param obj object or array
- * @param iterator iterator function
- */
-function _forEach(obj, iterator) {
- if (isArray(obj)) {
- const arr = obj;
- if (arr.forEach) {
- arr.forEach(iterator);
- return;
- }
- for (let i = 0; i < arr.length; i += 1) {
- iterator(arr[i], i, arr);
- }
- } else {
- const oo = obj;
- for (const key in oo) {
- if (obj.hasOwnProperty(key)) {
- iterator(oo[key], key, obj);
- }
- }
- }
-}
-
-/**
- * flatter request parameter
- * @param source target object or array
- */
-function flatten(source) {
- if (!isArray(source) && !isObject(source)) {
- return {};
- }
- const ret = {};
- const _dump = function(obj, prefix, parents) {
- const checkedParents = [];
- if (parents) {
- let i;
- for (i = 0; i < parents.length; i++) {
- if (parents[i] === obj) {
- throw new Error('object has circular references');
- }
- checkedParents.push(obj);
- }
- }
- checkedParents.push(obj);
- if (!isArray(obj) && !isObject(obj)) {
- if (!prefix) {
- throw obj + 'is not object or array';
- }
- ret[prefix] = obj;
- return {};
- }
-
- if (isArray(obj)) {
- // it's an array
- _forEach(obj, function(o, i) {
- _dump(o, prefix ? prefix + '.' + i : '' + i, checkedParents);
- });
- } else {
- // it's an object
- _forEach(obj, function(o, key) {
- _dump(o, prefix ? prefix + '.' + key : '' + key, checkedParents);
- });
- }
- };
-
- _dump(source, null);
- return ret;
-}
-
-function uniqueArray(arr) {
- return arr.filter((item, index, self) => {
- return self.indexOf(item) === index;
- });
-}
-
-function camelCase(str) {
- if (str.length <= 1) {
- return str.toUpperCase();
- }
- return `${str[0].toUpperCase()}${str.slice(1)}`;
-}
-
-function camelCaseProperty(obj) {
- let res = null;
- if (isObject(obj)) {
- res = {};
- Object.keys(obj).forEach((key) => {
- const val = obj[key];
- res[camelCase(key)] = isObject(val) || isArray(val) ? camelCaseProperty(val) : val;
- });
- }
- if (isArray(obj)) {
- res = [];
- obj.forEach((item) => {
- res.push(isObject(item) || isArray(item) ? camelCaseProperty(item) : item);
- });
- }
- return res;
-}
-
-function strip(num, precision = 12) {
- return +parseFloat(num.toPrecision(precision));
-}
-
-function traverseDirSync(dir, opts, ls) {
- if (!ls) {
- ls = [];
- dir = path.resolve(dir);
- opts = opts || {};
- if (opts.depthLimit > -1) {
- opts.rootDepth = dir.split(path.sep).length + 1;
- }
- }
- const paths = fs.readdirSync(dir).map((p) => dir + path.sep + p);
- for (let i = 0; i < paths.length; i++) {
- const pi = paths[i];
- const st = fs.statSync(pi);
- const item = { path: pi, stats: st };
- const isUnderDepthLimit =
- !opts.rootDepth || pi.split(path.sep).length - opts.rootDepth < opts.depthLimit;
- const filterResult = opts.filter ? opts.filter(item) : true;
- const isDir = st.isDirectory();
- const shouldAdd = filterResult && (isDir ? !opts.nodir : !opts.nofile);
- const shouldTraverse = isDir && isUnderDepthLimit && (opts.traverseAll || filterResult);
- if (shouldAdd) {
- ls.push(item);
- }
- if (shouldTraverse) {
- ls = traverseDirSync(pi, opts, ls);
- }
- }
- return ls;
-}
-
-module.exports = {
- isArray,
- isObject,
- _forEach,
- flatten,
- uniqueArray,
- camelCaseProperty,
- strip,
- traverseDirSync,
- getRealType,
- deepClone,
-};
diff --git a/src/utils/index.ts b/src/utils/index.ts
new file mode 100644
index 00000000..8446dc19
--- /dev/null
+++ b/src/utils/index.ts
@@ -0,0 +1,339 @@
+import fs from 'fs';
+import path from 'path';
+import camelCase from 'camelcase';
+import { PascalCase } from 'type-fest';
+import { CamelCasedProps, PascalCasedProps } from '../modules/interface';
+import crypto from 'crypto';
+import _ from 'lodash';
+
+
+// TODO: 将一些库换成 lodash
+
+/**
+ * simple deep clone object
+ * @param {object} obj object
+ */
+export function deepClone(obj: T): T {
+ return JSON.parse(JSON.stringify(obj));
+}
+
+/**
+ * return variable real type
+ * @param {any} obj input variable
+ */
+export function getRealType(obj: T): string {
+ return Object.prototype.toString.call(obj).slice(8, -1);
+}
+
+/**
+ * is array
+ * @param obj object
+ */
+export function isArray(obj: T[] | T): obj is T[] {
+ return Object.prototype.toString.call(obj) == '[object Array]';
+}
+
+/**
+ * is positive integer(正整数)
+ * @param obj object
+ */
+export function isPositiveInteger(value: string | number) {
+ return +value > 0 && Number.isInteger(+value);
+}
+
+/**
+ * is number（数字)
+ * @param obj object
+ */
+export function isNumber(value: string | number) {
+ return !Number.isNaN(+value);
+}
+
+/**
+ * is object
+ * @param obj object
+ */
+export function isObject(obj: T): obj is T {
+ return obj === Object(obj);
+}
+
+/**
+ * iterate object or array
+ * @param obj object or array
+ * @param iterator iterator function
+ */
+export function _forEach(
+ obj: T[],
+ iterator: (val: T, index: number, data?: T[]) => any,
+): void;
+export function _forEach(
+ obj: T,
+ iterator: (val: any, index: string, data?: T) => any,
+): void;
+export function _forEach(
+ obj: T | T[],
+ iterator: (val: any, index: any, data?: T | T[]) => any,
+): void {
+ if (isArray(obj)) {
+ if (obj.forEach) {
+ obj.forEach(iterator);
+ return;
+ }
+ for (let i = 0; i < obj.length; i += 1) {
+ iterator(obj[i], i, obj);
+ }
+ } else {
+ for (const key in obj) {
+ if (obj.hasOwnProperty(key)) {
+ iterator(obj[key], key, obj);
+ }
+ }
+ }
+}
+
+export function isPrimitive(obj: any): boolean {
+ return obj !== Object(obj);
+}
+
+export function deepEqual(obj1: any, obj2: any): boolean {
+ if (obj1 === obj2) {
+ return true;
+ }
+
+ if (isPrimitive(obj1) || isPrimitive(obj2)) {
+ return obj1 === obj2;
+ }
+
+ if (Object.keys(obj1).length !== Object.keys(obj2).length) {
+ return false;
+ }
+
+ // compare objects with same number of keys
+ for (const key in obj1) {
+ if (!(key in obj2)) {
+ return false;
+ }
+ if (!deepEqual(obj1[key], obj2[key])) {
+ return false;
+ }
+ }
+
+ return true;
+}
+
+/**
+ * flatter request parameter
+ * @param source target object or array
+ */
+export function flatten(source: T | T[]) {
+ if (!isArray(source) && !isObject(source)) {
+ return {};
+ }
+ const ret: Record = {};
+
+ function _dump(obj: any, prefix?: string, parents?: any[]) {
+ const checkedParents: any[] = [];
+ if (parents) {
+ let i;
+ for (i = 0; i < parents.length; i++) {
+ if (parents[i] === obj) {
+ throw new Error('object has circular references');
+ }
+ checkedParents.push(obj);
+ }
+ }
+ checkedParents.push(obj);
+ if (!isArray(obj as any) && !isObject(obj)) {
+ if (!prefix) {
+ throw obj + 'is not object or array';
+ }
+ ret[prefix] = obj;
+ return {};
+ }
+
+ if (isArray(obj)) {
+ // it's an array
+ _forEach(obj, function (o: any, i: number | string) {
+ _dump(o, prefix ? prefix + '.' + i : '' + i, checkedParents);
+ });
+ } else {
+ // it's an object
+ _forEach(obj, function (o: any, key: string | number) {
+ _dump(o, prefix ? prefix + '.' + key : '' + key, checkedParents);
+ });
+ }
+ }
+
+ _dump(source);
+ return ret;
+}
+
+export function uniqueArray(arr: T[]) {
+ return arr.filter((item, index, self) => {
+ return self.indexOf(item) === index;
+ });
+}
+
+export function camelCaseProps(obj: T): CamelCasedProps {
+ let res: Record = {};
+ if (isObject(obj)) {
+ res = {} as any;
+ Object.keys(obj).forEach((key: string) => {
+ const val = (obj as any)[key];
+ const k = camelCase(key);
+ res[k] = isObject(val) || isArray(val) ? camelCaseProps(val) : val;
+ });
+ }
+ if (isArray(obj as any)) {
+ res = [];
+ (obj as any).forEach((item: any) => {
+ res.push(isObject(item) || isArray(item) ? camelCaseProps(item) : item);
+ });
+ }
+ return res as CamelCasedProps;
+}
+
+export function pascalCase(str: T): PascalCase {
+ if (str.length <= 1) {
+ return str.toUpperCase() as any;
+ }
+ return `${str[0].toUpperCase()}${str.slice(1)}` as any;
+}
+
+export function pascalCaseProps(obj: T): PascalCasedProps {
+ let res: Record = {};
+ if (isObject(obj)) {
+ res = {} as any;
+ Object.keys(obj).forEach((key: string) => {
+ const val = (obj as any)[key];
+ const k = pascalCase(key);
+ res[k] = isObject(val) || isArray(val) ? pascalCaseProps(val) : val;
+ });
+ }
+ if (isArray(obj as any)) {
+ res = [];
+ (obj as any).forEach((item: any) => {
+ res.push(isObject(item) || isArray(item) ? pascalCaseProps(item) : item);
+ });
+ }
+ return res as PascalCasedProps;
+}
+
+export function strip(num: number, precision = 12) {
+ return +parseFloat(num.toPrecision(precision));
+}
+
+export interface TraverseDirOptions {
+ depthLimit?: number;
+ rootDepth?: number;
+ filter?: (item: { path: string; stats: fs.Stats }) => boolean;
+ nodir?: boolean;
+ nofile?: boolean;
+ traverseAll?: boolean;
+}
+
+export function traverseDirSync(
+ dir: string,
+ opts?: TraverseDirOptions,
+ ls?: { path: string; stats: fs.Stats }[],
+): { path: string; stats: fs.Stats }[] {
+ if (!ls) {
+ ls = [];
+ dir = path.resolve(dir);
+ opts = opts ?? {};
+ if (opts?.depthLimit ?? -1 > -1) {
+ opts.rootDepth = dir.split(path.sep).length + 1;
+ }
+ }
+ const paths: string[] = fs.readdirSync(dir).map((p: string) => dir + path.sep + p);
+ for (let i = 0; i < paths.length; i++) {
+ const pi = paths[i];
+ const st = fs.statSync(pi);
+ const item = { path: pi, stats: st };
+ const isUnderDepthLimit =
+ !opts?.rootDepth || pi.split(path.sep).length - opts.rootDepth < (opts?.depthLimit ?? -1);
+ const filterResult = opts?.filter ? opts.filter(item) : true;
+ const isDir = st.isDirectory();
+ const shouldAdd = filterResult && (isDir ? !opts?.nodir : !opts?.nofile);
+ const shouldTraverse = isDir && isUnderDepthLimit && (opts?.traverseAll || filterResult);
+ if (shouldAdd) {
+ ls?.push(item);
+ }
+ if (shouldTraverse) {
+ ls = traverseDirSync(pi, opts, ls);
+ }
+ }
+ return ls;
+}
+
+export function getToday(date?: Date) {
+ if (!date) {
+ date = new Date();
+ }
+ const year = date.getFullYear();
+ const month = date.getMonth() + 1;
+ const day = date.getDate();
+
+ return `${year}-${month < 10 ? '0' : ''}${month}-${day}`;
+}
+
+export function getYestoday() {
+ const timestamp = Date.now() - 24 * 60 * 60 * 1000;
+ const yestoday = getToday(new Date(timestamp));
+ return yestoday;
+}
+
+export const randomId = (len = 6) => {
+ const randomStr = Math.random().toString(36);
+ return randomStr.substr(-len);
+};
+
+export const getQcsResourceId = (service: string, region: string, uin: string, suffix: string) => {
+ // 云资源六段式
+ return `qcs::${service}:${region}:uin/${uin}:${suffix}`;
+};
+
+/**
+ * hmacSha1 加密HmacSHA1
+ * @param text 加密文本
+ * @param key 加密密钥
+ * @returns
+ */
+export const hmacSha1 = (text: string, key: string) => {
+ return crypto.createHmac('sha1', key).update(text).digest('hex');
+};
+
+/**
+ * getYunTiApiUrl 查询云梯API地址
+ * @returns 云梯API地址
+ */
+export const getYunTiApiUrl = (): string => {
+ const apiKey = process.env.SLS_YUNTI_API_KEY || '';
+ const apiSecret = process.env.SLS_YUNTI_API_SECRET || '';
+ const apiUrl = process.env.SLS_YUNTI_API_URL;
+ const timeStamp = Math.floor(Date.now() / 1000);
+ const apiSign = hmacSha1(`${timeStamp}${apiKey}`, apiSecret);
+ const url = `${apiUrl}?api_key=${apiKey}&api_ts=${timeStamp}&api_sign=${apiSign}`;
+ return url;
+};
+
+
+
+/**
+ * 首字母转换大小写
+ * @param {*} obj
+ * @param {*} type
+ * @returns
+ */
+export function caseForObject(obj: object,type : 'upper' | 'lower') {
+ if (!_.isPlainObject(obj)) return obj;
+ return _.transform(obj, (result: { [key: string]: any }, value, key) => {
+ let newKey:string = '';
+ if (type === 'upper') {
+ newKey = _.upperFirst(key)
+ } else {
+ newKey = _.lowerFirst(key);
+ }
+ result[newKey] = _.isPlainObject(value) ? caseForObject(value,type) : value;
+ }, {});
+}
\ No newline at end of file
diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644
index 00000000..2e396ba2
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,20 @@
+{
+ "compilerOptions": {
+ "target": "es2017",
+ "module": "commonjs",
+ "strict": true,
+ "moduleResolution": "node",
+ "noImplicitAny": true,
+ "rootDir": "./src",
+ "outDir": "./lib",
+ "skipLibCheck": true,
+ "allowJs": true,
+ "lib": ["es2015"],
+ "sourceMap": true,
+ "declaration": true,
+ "esModuleInterop": true,
+ "forceConsistentCasingInFileNames": true
+ },
+ "include": ["./src"],
+ "exclude": ["./lib"]
+}