feat: support multi region and cls config

yugasun · yugasun · commit 3dd0c8fd4a0a · 2020-09-28T11:45:37.000+08:00
diff --git a/docs/configure.md b/docs/configure.md
@@ -33,6 +33,9 @@ inputs:
   functionConf: # 函数配置相关
     timeout: 10 # 超时时间，单位秒
     eip: false # 是否固定出口IP
+    cls: # CLS 日志投递配置
+      logsetId: abcdef # 所属日志集ID
+      topicId: abcdef # 日志主题ID
     memorySize: 128 # 内存大小，单位MB
     environment: #  环境变量
       variables: #  环境变量数组
@@ -133,6 +136,7 @@ inputs:
 | environment |    否    | Object  |         | 函数的环境变量, 参考 [环境变量](#环境变量)                                      |
 | vpcConfig   |    否    | Object  |         | 函数的 VPC 配置, 参考 [VPC 配置](#VPC-配置)                                     |
 | eip         |    否    | Boolean | `false` | 是否固定出口 IP                                                                 |
+| cls         |    否    | Object  |         | CLS 日志投递配置，参考 [CLS 配置](#CLS-配置)                                    |
 
 ##### 环境变量
 
@@ -147,6 +151,13 @@ inputs:
 | subnetId | String | 子网 ID |
 | vpcId    | String | VPC ID  |
 
+##### CLS 配置
+
+| 参数名称 | 类型   | 描述          |
+| -------- | ------ | :------------ |
+| logsetId | String | 所属日志集 ID |
+| topicId  | String | 日志主题 ID   |
+
 ### API 网关配置
 
 | 参数名称       | 是否必选 | 类型     | 默认值   | 描述                                                                               |
diff --git a/package.json b/package.json
@@ -5,8 +5,7 @@
     "access": "public"
   },
   "scripts": {
-    "int-test": "jest ./tests/integration.test.js --testEnvironment node",
-    "test": "npm run lint && npm run prettier && npm run int-test",
+    "test": "jest ./tests/integration.test.js --testEnvironment node",
     "commitlint": "commitlint -f HEAD@{15}",
     "lint": "eslint --ext .js,.ts,.tsx .",
     "lint:fix": "eslint --fix --ext .js,.ts,.tsx .",
diff --git a/serverless.component.yml b/serverless.component.yml
@@ -1,5 +1,5 @@
 name: koa
-version: 0.0.13
+version: 0.1.0
 author: 'Tencent Cloud, Inc.'
 org: 'Tencent Cloud, Inc.'
 description: Deploy a serverless Koa.js application onto Tencent SCF and API Gateway.
diff --git a/src/_shims/package.json b/src/_shims/package.json
@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "tencent-serverless-http": "^1.2.0"
+    "tencent-serverless-http": "^1.3.1"
   }
 }
diff --git a/src/package.json b/src/package.json
@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "download": "^8.0.0",
-    "tencent-component-toolkit": "^1.16.4",
+    "tencent-component-toolkit": "^1.16.8",
     "type": "^2.1.0"
   }
 }
diff --git a/src/serverless.js b/src/serverless.js
@@ -1,7 +1,7 @@
 const { Component } = require('@serverless/core')
-const { MultiApigw, Scf, Apigw, Cns } = require('tencent-component-toolkit')
+const { Scf, Apigw, Cns } = require('tencent-component-toolkit')
 const { TypeError } = require('tencent-component-toolkit/src/utils/error')
-const { uploadCodeToCos, getDefaultProtocol, deleteRecord, prepareInputs } = require('./utils')
+const { uploadCodeToCos, getDefaultProtocol, prepareInputs, deepClone } = require('./utils')
 const CONFIGS = require('./config')
 
 class ServerlessComponent extends Component {
@@ -27,135 +27,141 @@ class ServerlessComponent extends Component {
   }
 
   async deployFunction(credentials, inputs, regionList) {
-    const uploadCodeHandler = []
     const outputs = {}
     const appId = this.getAppId()
 
-    for (let eveRegionIndex = 0; eveRegionIndex < regionList.length; eveRegionIndex++) {
-      const curRegion = regionList[eveRegionIndex]
-      const funcDeployer = async () => {
-        const code = await uploadCodeToCos(this, appId, credentials, inputs, curRegion)
-        const scf = new Scf(credentials, curRegion)
-        const tempInputs = {
-          ...inputs,
-          code
-        }
-        const scfOutput = await scf.deploy(tempInputs)
-        outputs[curRegion] = {
-          functionName: scfOutput.FunctionName,
-          runtime: scfOutput.Runtime,
-          namespace: scfOutput.Namespace
-        }
-
-        this.state[curRegion] = {
-          ...(this.state[curRegion] ? this.state[curRegion] : {}),
-          ...outputs[curRegion]
-        }
+    const funcDeployer = async (curRegion) => {
+      const code = await uploadCodeToCos(this, appId, credentials, inputs, curRegion)
+      const scf = new Scf(credentials, curRegion)
+      const tempInputs = {
+        ...inputs,
+        code
+      }
+      const scfOutput = await scf.deploy(deepClone(tempInputs))
+      outputs[curRegion] = {
+        functionName: scfOutput.FunctionName,
+        runtime: scfOutput.Runtime,
+        namespace: scfOutput.Namespace
+      }
 
-        // default version is $LATEST
-        outputs[curRegion].lastVersion = scfOutput.LastVersion
-          ? scfOutput.LastVersion
-          : this.state.lastVersion || '$LATEST'
-
-        // default traffic is 1.0, it can also be 0, so we should compare to undefined
-        outputs[curRegion].traffic =
-          scfOutput.Traffic !== undefined
-            ? scfOutput.Traffic
-            : this.state.traffic !== undefined
-            ? this.state.traffic
-            : 1
-
-        if (outputs[curRegion].traffic !== 1 && scfOutput.ConfigTrafficVersion) {
-          outputs[curRegion].configTrafficVersion = scfOutput.ConfigTrafficVersion
-          this.state.configTrafficVersion = scfOutput.ConfigTrafficVersion
-        }
+      this.state[curRegion] = {
+        ...(this.state[curRegion] ? this.state[curRegion] : {}),
+        ...outputs[curRegion]
+      }
 
-        this.state.lastVersion = outputs[curRegion].lastVersion
-        this.state.traffic = outputs[curRegion].traffic
+      // default version is $LATEST
+      outputs[curRegion].lastVersion = scfOutput.LastVersion
+        ? scfOutput.LastVersion
+        : this.state.lastVersion || '$LATEST'
+
+      // default traffic is 1.0, it can also be 0, so we should compare to undefined
+      outputs[curRegion].traffic =
+        scfOutput.Traffic !== undefined
+          ? scfOutput.Traffic
+          : this.state.traffic !== undefined
+          ? this.state.traffic
+          : 1
+
+      if (outputs[curRegion].traffic !== 1 && scfOutput.ConfigTrafficVersion) {
+        outputs[curRegion].configTrafficVersion = scfOutput.ConfigTrafficVersion
+        this.state.configTrafficVersion = scfOutput.ConfigTrafficVersion
       }
-      uploadCodeHandler.push(funcDeployer())
+
+      this.state.lastVersion = outputs[curRegion].lastVersion
+      this.state.traffic = outputs[curRegion].traffic
+    }
+
+    for (let i = 0; i < regionList.length; i++) {
+      const curRegion = regionList[i]
+      await funcDeployer(curRegion)
     }
-    await Promise.all(uploadCodeHandler)
     this.save()
     return outputs
   }
 
+  // try to add dns record
+  async tryToAddDnsRecord(credentials, customDomains) {
+    try {
+      const cns = new Cns(credentials)
+      for (let i = 0; i < customDomains.length; i++) {
+        const item = customDomains[i]
+        if (item.domainPrefix) {
+          await cns.deploy({
+            domain: item.subDomain.replace(`${item.domainPrefix}.`, ''),
+            records: [
+              {
+                subDomain: item.domainPrefix,
+                recordType: 'CNAME',
+                recordLine: '默认',
+                value: item.cname,
+                ttl: 600,
+                mx: 10,
+                status: 'enable'
+              }
+            ]
+          })
+        }
+      }
+    } catch (e) {
+      console.log('METHOD_tryToAddDnsRecord', e.message)
+    }
+  }
+
   async deployApigateway(credentials, inputs, regionList) {
     if (inputs.isDisabled) {
       return {}
     }
-    const apigw = new MultiApigw(credentials, regionList)
-    const oldState = this.state[regionList[0]] || {}
-    inputs.oldState = {
-      apiList: oldState.apiList || [],
-      customDomains: oldState.customDomains || []
+
+    const getServiceId = (instance, region) => {
+      const regionState = instance.state[region]
+      return inputs.serviceId || (regionState && regionState.serviceId)
     }
-    const apigwOutputs = await apigw.deploy(inputs)
-    const outputs = {}
-    Object.keys(apigwOutputs).forEach((curRegion) => {
-      const curOutput = apigwOutputs[curRegion]
-      outputs[curRegion] = {
-        serviceId: curOutput.serviceId,
-        subDomain: curOutput.subDomain,
-        environment: curOutput.environment,
-        url: `${getDefaultProtocol(inputs.protocols)}://${curOutput.subDomain}/${
-          curOutput.environment
-        }/`
-      }
-      if (curOutput.customDomains) {
-        outputs[curRegion].customDomains = curOutput.customDomains
-      }
-      this.state[curRegion] = {
-        created: curOutput.created,
-        ...(this.state[curRegion] ? this.state[curRegion] : {}),
-        ...outputs[curRegion],
-        apiList: curOutput.apiList
-      }
-    })
-    this.save()
-    return outputs
-  }
 
-  async deployCns(credentials, inputs, regionList, apigwOutputs) {
-    const cns = new Cns(credentials)
-    const cnsRegion = {}
+    const deployTasks = []
+    const outputs = {}
     regionList.forEach((curRegion) => {
-      const curApigwOutput = apigwOutputs[curRegion]
-      cnsRegion[curRegion] = curApigwOutput.subDomain
-    })
+      const apigwDeployer = async () => {
+        const apigw = new Apigw(credentials, curRegion)
 
-    const state = []
-    const outputs = {}
-    const tempJson = {}
-    for (let i = 0; i < inputs.length; i++) {
-      const curCns = inputs[i]
-      for (let j = 0; j < curCns.records.length; j++) {
-        curCns.records[j].value =
-          cnsRegion[curCns.records[j].value.replace('temp_value_about_', '')]
-      }
-      const tencentCnsOutputs = await cns.deploy(curCns)
-      outputs[curCns.domain] = tencentCnsOutputs.DNS
-        ? tencentCnsOutputs.DNS
-        : 'The domain name has already been added.'
-      tencentCnsOutputs.domain = curCns.domain
-      state.push(tencentCnsOutputs)
-    }
+        const oldState = this.state[curRegion] || {}
+        const apigwInputs = {
+          ...inputs,
+          oldState: {
+            apiList: oldState.apiList || [],
+            customDomains: oldState.customDomains || []
+          }
+        }
+        // different region deployment has different service id
+        apigwInputs.serviceId = getServiceId(this, curRegion)
+        const apigwOutput = await apigw.deploy(deepClone(apigwInputs))
+        outputs[curRegion] = {
+          serviceId: apigwOutput.serviceId,
+          subDomain: apigwOutput.subDomain,
+          environment: apigwOutput.environment,
+          url: `${getDefaultProtocol(inputs.protocols)}://${apigwOutput.subDomain}/${
+            apigwOutput.environment
+          }/`
+        }
 
-    // 删除serverless创建的但是不在本次列表中
-    try {
-      for (let i = 0; i < state.length; i++) {
-        tempJson[state[i].domain] = state[i].records
-      }
-      const recordHistory = this.state.cns || []
-      for (let i = 0; i < recordHistory.length; i++) {
-        const delList = deleteRecord(tempJson[recordHistory[i].domain], recordHistory[i].records)
-        if (delList && delList.length > 0) {
-          await cns.remove({ deleteList: delList })
+        if (apigwOutput.customDomains) {
+          // TODO: need confirm add cns authentication
+          if (inputs.autoAddDnsRecord === true) {
+            // await this.tryToAddDnsRecord(credentials, apigwOutput.customDomains)
+          }
+          outputs[curRegion].customDomains = apigwOutput.customDomains
+        }
+        this.state[curRegion] = {
+          created: true,
+          ...(this.state[curRegion] ? this.state[curRegion] : {}),
+          ...outputs[curRegion],
+          apiList: apigwOutput.apiList
         }
       }
-    } catch (e) {}
+      deployTasks.push(apigwDeployer())
+    })
+
+    await Promise.all(deployTasks)
 
-    this.state['cns'] = state
     this.save()
     return outputs
   }
@@ -166,7 +172,7 @@ class ServerlessComponent extends Component {
     const credentials = this.getCredentials()
 
     // 对Inputs内容进行标准化
-    const { regionList, functionConf, apigatewayConf, cnsConf } = await prepareInputs(
+    const { regionList, functionConf, apigatewayConf } = await prepareInputs(
       this,
       credentials,
       inputs
@@ -198,11 +204,6 @@ class ServerlessComponent extends Component {
       outputs['scf'] = functionOutputs
     }
 
-    // cns depends on apigw, so if disabled apigw, just ignore it.
-    if (cnsConf.length > 0 && apigatewayConf.isDisabled !== true) {
-      outputs['cns'] = await this.deployCns(credentials, cnsConf, regionList, apigwOutputs)
-    }
-
     this.state.region = regionList[0]
     this.state.regionList = regionList
     this.state.lambdaArn = functionConf.name
diff --git a/src/utils.js b/src/utils.js
diff --git a/tests/integration.test.js b/tests/integration.test.js

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"dependencies": {`
`3`		`- "tencent-serverless-http": "^1.2.0"`
	`3`	`+ "tencent-serverless-http": "^1.3.1"`
`4`	`4`	`}`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"dependencies": {`
`3`	`3`	`"download": "^8.0.0",`
`4`		`- "tencent-component-toolkit": "^1.16.4",`
	`4`	`+ "tencent-component-toolkit": "^1.16.8",`
`5`	`5`	`"type": "^2.1.0"`
`6`	`6`	`}`
`7`	`7`	`}`