feat: optimize inputs initial

Author: yugasun

.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc.js

@@ -66,7 +66,7 @@ module.exports = {
     ],
     semi: ['error', 'never'],
     'spaced-comment': 'error',
-    strict: ['error', 'never'],
+    strict: ['error', 'global'],
     'prettier/prettier': 'error'
   }
 }

README.en.md

@@ -61,7 +61,7 @@ MyComponent:
   inputs:
     region: ap-guangzhou 
     functionName: flask-function
-    codeUri: ./
+    code: ./
     functionConf:
       timeout: 10
       memorySize: 128

README.md

@@ -48,7 +48,7 @@ MyComponent:
   inputs:
     region: ap-guangzhou 
     functionName: flask-function
-    codeUri: ./
+    code: ./
     functionConf:
       timeout: 10
       memorySize: 128

package.json

@@ -15,6 +15,7 @@
   ],
   "scripts": {
     "commitlint": "commitlint -f HEAD@{15}",
+    "test": "tape *.test.js",
     "lint": "eslint --ext .js,.ts,.tsx .",
     "lint:fix": "eslint --fix --ext .js,.ts,.tsx .",
     "prettier": "prettier --check **/*.{css,html,js,json,md,yaml,yml}",
@@ -46,10 +47,12 @@
     }
   },
   "dependencies": {
-    "@serverless/core": "^1.0.0",
-    "@serverless/tencent-apigateway": "^1.2.0",
-    "@serverless/tencent-scf": "^1.1.0",
-    "@yugasun/python-requirements": "^0.1.1"
+    "@serverless/core": "^1.1.1",
+    "@serverless/tencent-apigateway": "^2.0.0",
+    "@serverless/tencent-scf": "^2.0.1",
+    "@yugasun/python-requirements": "^0.1.2",
+    "ext": "^1.4.0",
+    "type": "^2.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^8.2.0",
@@ -63,6 +66,7 @@
     "husky": "^3.1.0",
     "lint-staged": "^9.5.0",
     "prettier": "^1.15.3",
-    "standard-version": "^7.0.1"
+    "standard-version": "^7.0.1",
+    "tape": "^4.12.0"
   }
 }

serverless.test.js

@@ -0,0 +1,14 @@
+const test = require('tape')
+
+const Component = require('./serverless')
+
+test('getDefaultProtocol()', (t) => {
+  t.plan(5)
+
+  const comp = new Component()
+  t.equal(comp.getDefaultProtocol(['http']), 'http')
+  t.equal(comp.getDefaultProtocol(['https']), 'https')
+  t.equal(comp.getDefaultProtocol(['http', 'https']), 'https')
+  t.equal(comp.getDefaultProtocol(['HTTP', 'hTTpS']), 'https')
+  t.equal(comp.getDefaultProtocol(['http', 'ftp']), 'http')
+})

src/index.js

@@ -1,3 +1,7 @@
+const ensureIterable = require('type/iterable/ensure')
+const ensurePlainObject = require('type/plain-object/ensure')
+const ensureString = require('type/string/ensure')
+const random = require('ext/string/random')
 const path = require('path')
 const { Component, utils } = require('@serverless/core')
 
@@ -8,32 +12,40 @@ const DEFAULTS = {
 }
 
 class TencentFlask extends Component {
+  getDefaultProtocol(protocols) {
+    if (protocols.map((i) => i.toLowerCase()).includes('https')) {
+      return 'https'
+    }
+    return 'http'
+  }
+
   /**
    * prepare create function inputs
    * @param {object} inputs inputs
    */
   async prepareInputs(inputs = {}) {
-    const len = 6
-    const chars = 'ABCDEFGHJKMNPQRSTWXYZabcdefhijkmnprstwxyz2345678'
-    const maxPos = chars.length
-    let result = ''
-    for (let i = 0; i < len; i++) {
-      result += chars.charAt(Math.floor(Math.random() * maxPos))
-    }
+    inputs.name =
+      ensureString(inputs.functionName, { isOptional: true }) ||
+      this.state.functionName ||
+      `FlaskComponent_${random({ length: 6 })}`
+    inputs.codeUri = ensureString(inputs.code, { isOptional: true }) || process.cwd()
+    inputs.region = ensureString(inputs.region, { default: 'ap-guangzhou' })
+    inputs.include = ensureIterable(inputs.include, { default: [], ensureItem: ensureString })
+    inputs.exclude = ensureIterable(inputs.exclude, { default: [], ensureItem: ensureString })
+    inputs.apigatewayConf = ensurePlainObject(inputs.apigatewayConf, { default: {} })
 
     const shimsDir = path.join(__dirname, 'shims')
     inputs.include = [
       path.join(shimsDir, 'severless_wsgi.py'),
       path.join(shimsDir, 'api_service.py')
     ]
-    inputs.exclude = inputs.exclude || ['.git/**', '.gitignore', '.serverless', '.DS_Store']
-    inputs.handler = inputs.handler || DEFAULTS.handler
-    inputs.runtime = inputs.runtime || DEFAULTS.runtime
-    inputs.name = inputs.functionName || 'FlaskComponent_' + result
-    inputs.codeUri = inputs.codeUri || process.cwd()
+    inputs.exclude.push('.git/**', '.gitignore', '.serverless', '.DS_Store')
 
-    const appFile = path.join(path.resolve(inputs.codeUri), 'app.py')
+    inputs.handler = ensureString(inputs.handler, { default: DEFAULTS.handler })
+    inputs.runtime = ensureString(inputs.runtime, { default: DEFAULTS.runtime })
+    inputs.apigatewayConf = ensurePlainObject(inputs.apigatewayConf, { default: {} })
 
+    const appFile = path.join(path.resolve(inputs.codeUri), 'app.py')
     if (!(await utils.fileExists(appFile))) {
       throw new Error(`app.py not found in ${inputs.codeUri}`)
     }
@@ -48,9 +60,8 @@ class TencentFlask extends Component {
         inputs.vpcConfig = inputs.functionConf.vpcConfig
       }
     }
-    if (!inputs.requirements) {
-      inputs.requirements = {}
-    }
+
+    inputs.requirements = ensurePlainObject(inputs.apigatewayConf, { default: {} })
     inputs.requirements.include = inputs.include
     inputs.requirements.runtime = inputs.runtime.toLowerCase()
     inputs.requirements.codeUri = inputs.codeUri
@@ -78,10 +89,7 @@ class TencentFlask extends Component {
       description: 'Serverless Framework tencent-flask Component',
       serviceId: inputs.serviceId,
       region: inputs.region,
-      protocol:
-        inputs.apigatewayConf && inputs.apigatewayConf.protocol
-          ? inputs.apigatewayConf.protocol
-          : 'http',
+      protocols: inputs.apigatewayConf.protocols || ['http'],
       environment:
         inputs.apigatewayConf && inputs.apigatewayConf.environment
           ? inputs.apigatewayConf.environment
@@ -110,7 +118,9 @@ class TencentFlask extends Component {
       region: inputs.region,
       functionName: inputs.name,
       apiGatewayServiceId: tencentApiGatewayOutputs.serviceId,
-      url: `${tencentApiGatewayOutputs.protocol}://${tencentApiGatewayOutputs.subDomain}/${tencentApiGatewayOutputs.environment}/`
+      url: `${this.getDefaultProtocol(tencentApiGatewayOutputs.protocols)}://${
+        tencentApiGatewayOutputs.subDomain
+      }/${tencentApiGatewayOutputs.environment}/`
     }
 
     await this.save()

src/requirements.txt

@@ -3,7 +3,7 @@ MyFlask:
   inputs:
     region: ap-guangzhou
     functionName: flask-function
-    codeUri: ./
+    code: ./
     functionConf:
       timeout: 10
       memorySize: 128
@@ -14,5 +14,6 @@ MyFlask:
         subnetId: ''
         vpcId: ''
     apigatewayConf:
-      protocol: https
+      protocols:
+        - https
       environment: release