feat: support scf publish version and traffic setup

Author: yugasun

example/serverless.yml

@@ -1,7 +1,7 @@
 org: orgDemo # (optional) serverless dashboard org. default is the first org you created during signup.
 app: appDemo # (optional) serverless dashboard app. default is the same as the name property.
 stage: dev # (optional) serverless dashboard stage. default is dev.
-component: flask # (required) name of the component. In that case, it's flask.
+component: flask@dev # (required) name of the component. In that case, it's flask.
 name: flashDemo # (required) name of your flash component instance.
 
 inputs:

serverless.component.yml

@@ -2,9 +2,9 @@ name: flask
 version: 0.0.1
 author: Tencent Cloud, Inc
 org: Tencent Cloud, Inc
-description: Deploys a serverless Flask application onto Tencent SCF and Tencent APIGateway.
+description: Deploy a serverless Flask application onto Tencent SCF and APIGateway.
 keywords: tencent, serverless, flask
 repo: https://github.com/serverless-components/tencent-flask
-readme: https://github.com/serverless-components/tencent-flask/tree/v2/README.md
+readme: https://github.com/serverless-components/tencent-flask/tree/master/README.md
 license: MIT
 main: ./src

src/config.js

@@ -8,7 +8,7 @@ const CONFIGS = {
   timeout: 3,
   memorySize: 128,
   namespace: 'default',
-  description: 'Function created by serverless component'
+  description: 'Created by Serverless Component'
 }
 
 module.exports = CONFIGS

src/package.json

@@ -1,18 +1,7 @@
 {
-  "name": "@serverless/flask",
-  "main": "./serverless.js",
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint . --fix --cache"
-  },
-  "author": "Tencent Cloud, Inc.",
-  "license": "MIT",
   "dependencies": {
     "download": "^8.0.0",
-    "tencent-component-toolkit": "^1.11.4",
+    "tencent-component-toolkit": "^1.12.9",
     "type": "^2.0.0"
   }
 }

src/serverless.js

@@ -51,6 +51,26 @@ class ServerlessComponent extends Component {
           ...(this.state[curRegion] ? this.state[curRegion] : {}),
           ...outputs[curRegion]
         }
+
+        // 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
+          ? 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.lastVersion = outputs[curRegion].lastVersion
+        this.state.traffic = outputs[curRegion].traffic
       }
       uploadCodeHandler.push(funcDeployer())
     }

src/utils.js

@@ -8,13 +8,6 @@ const download = require('download')
 const { TypeError } = require('tencent-component-toolkit/src/utils/error')
 const CONFIGS = require('./config')
 
-/*
- * Pauses execution for the provided miliseconds
- *
- * @param ${number} wait - number of miliseconds to wait
- */
-const sleep = async (wait) => new Promise((resolve) => setTimeout(() => resolve(), wait))
-
 /*
  * Generates a random id
  */
@@ -23,18 +16,28 @@ const generateId = () =>
     .toString(36)
     .substring(6)
 
-const getDirFiles = async (dirPath) => {
-  const targetPath = path.resolve(dirPath)
-  const files = fs.readdirSync(targetPath)
-  const temp = {}
-  files.forEach((file) => {
-    temp[file] = path.join(targetPath, file)
-  })
-  return temp
+const getType = (obj) => {
+  return Object.prototype.toString.call(obj).slice(8, -1)
+}
+
+const validateTraffic = (num) => {
+  if (getType(num) !== 'Number') {
+    throw new TypeError(
+      `PARAMETER_${CONFIGS.compName.toUpperCase()}_TRAFFIC`,
+      'traffic must be a number'
+    )
+  }
+  if (num < 0 || num > 1) {
+    throw new TypeError(
+      `PARAMETER_${CONFIGS.compName.toUpperCase()}_TRAFFIC`,
+      'traffic must be a number between 0 and 1'
+    )
+  }
+  return true
 }
 
 const getCodeZipPath = async (instance, inputs) => {
-  console.log(`Packaging ${CONFIGS.compNameFullname} application...`)
+  console.log(`Packaging ${CONFIGS.compFullname} application...`)
 
   // unzip source zip file
   let zipPath
@@ -43,7 +46,7 @@ const getCodeZipPath = async (instance, inputs) => {
     const downloadPath = `/tmp/${generateId()}`
     const filename = 'template'
 
-    console.log(`Installing Default ${CONFIGS.compNameFullname} App...`)
+    console.log(`Installing Default ${CONFIGS.compFullname} App...`)
     try {
       await download(CONFIGS.templateUrl, downloadPath, {
         filename: `${filename}.zip`
@@ -59,6 +62,16 @@ const getCodeZipPath = async (instance, inputs) => {
   return zipPath
 }
 
+const getDirFiles = async (dirPath) => {
+  const targetPath = path.resolve(dirPath)
+  const files = fs.readdirSync(targetPath)
+  const temp = {}
+  files.forEach((file) => {
+    temp[file] = path.join(targetPath, file)
+  })
+  return temp
+}
+
 /**
  * Upload code to COS
  * @param {Component} instance serverless component instance
@@ -235,8 +248,18 @@ const prepareInputs = async (instance, credentials, inputs = {}) => {
     fromClientRemark,
     layers: ensureIterable(tempFunctionConf.layers ? tempFunctionConf.layers : inputs.layers, {
       default: []
-    })
+    }),
+    publish: inputs.publish,
+    traffic: inputs.traffic,
+    lastVersion: instance.state.lastVersion
   }
+
+  // validate traffic
+  if (inputs.traffic !== undefined) {
+    validateTraffic(inputs.traffic)
+  }
+  functionConf.needSetTraffic = inputs.traffic !== undefined && functionConf.lastVersion
+
   functionConf.tags = ensureObject(tempFunctionConf.tags ? tempFunctionConf.tags : inputs.tag, {
     default: null
   })
@@ -267,7 +290,7 @@ const prepareInputs = async (instance, credentials, inputs = {}) => {
 
   // 对apigw inputs进行标准化
   const apigatewayConf = inputs.apigatewayConf ? inputs.apigatewayConf : {}
-  apigatewayConf.isDisabled = apigatewayConf.isDisabled === true
+  apigatewayConf.isDisabled = inputs.apigatewayConf === true
   apigatewayConf.fromClientRemark = fromClientRemark
   apigatewayConf.serviceName = inputs.serviceName
   apigatewayConf.description = `Serverless Framework Tencent-${capitalString(
@@ -286,7 +309,8 @@ const prepareInputs = async (instance, credentials, inputs = {}) => {
       function: {
         isIntegratedResponse: apigatewayConf.isIntegratedResponse === false ? false : true,
         functionName: functionConf.name,
-        functionNamespace: functionConf.namespace
+        functionNamespace: functionConf.namespace,
+        functionQualifier: functionConf.needSetTraffic ? '$DEFAULT' : '$LATEST'
       }
     }
   ]
@@ -371,7 +395,6 @@ const prepareInputs = async (instance, credentials, inputs = {}) => {
 
 module.exports = {
   generateId,
-  sleep,
   uploadCodeToCos,
   mergeJson,
   capitalString,