fix: change entry to sls.js

yugasun · yugasun · commit 61bd4820dfca · 2020-04-17T18:18:23.000+08:00
diff --git a/README.en.md b/README.en.md
@@ -97,22 +97,23 @@ Here's a complete reference of the `serverless.yml` file for the express compone
 
 ```yml
 component: express # (required) name of the component. In that case, it's express.
-name: express-api # (required) name of your express component instance.
-org: serverlessinc # (optional) serverless dashboard org. default is the first org you created during signup.
-app: myApp # (optional) serverless dashboard app. default is the same as the name property.
+name: expressDemo # (required) name of your express component instance.
+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.
 
 inputs:
   src: ./src # (optional) path to the source folder. default is a hello world app.
-  memory: 512 # (optional) lambda memory size.
-  timeout: 10 # (optional) lambda timeout.
-  description: My Express App # (optional) lambda & api gateway description.
-  env: # (optional) env vars.
-    DEBUG: 'express:*' #            this express specific env var will print express debug logs.
-  roleArn: arn:aws:abc # (optional) custom role arn.
-  traffic: 0.2 # (optional) traffic percentage to apply to this deployment.
-  domain: api.serverless.com # (optional) domain name.
-  region: us-east-2 # (optional) aws region to deploy to. default is us-east-1.
+  functionName: expressDemo
+  region: ap-guangzhou
+  runtime: Nodejs10.15
+  exclude:
+    - .env
+  apigatewayConf:
+    protocols:
+      - http
+      - https
+    environment: release
 ```
 
 Once you've chosen your configuration, run `serverless deploy` again (or simply just `serverless`) to deploy your changes.
diff --git a/README.md b/README.md
@@ -15,7 +15,6 @@
 - [x] **便捷协作** - 通过云端的状态信息和部署日志，方便的进行多人协作开发。
 - [x] **自定义域名** - 支持配置自定义域名及 HTTPS 访问
 
-
 <br/>
 
 <img align="right" width="400" src="https://scf-dev-tools-1253665819.cos.ap-guangzhou.myqcloud.com/express_demo_light_sm_resize.gif" />
@@ -31,26 +30,30 @@
 7. [**移除**](#7-移除)
 
 更多资源：
-* [**架构说明**](#架构说明)
-* [**账号配置**](#账号配置)
+
+- [**架构说明**](#架构说明)
+- [**账号配置**](#账号配置)
 
 &nbsp;
 
 ### 1. 安装
 
-通过 npm 安装最新版本的 Serverless Framework 
+通过 npm 安装最新版本的 Serverless Framework
+
 ```
 $ npm install -g serverless
 ```
 
 ### 2. 创建
 
 创建并进入一个全新目录：
+
 ```
 $ mkdir tencent-express && cd tencent-express
 ```
 
 通过如下命令和模板链接，快速创建一个 express 应用：
+
 ```
 $ serverless create --template-url https://github.com/serverless-components/tencent-express/tree/v2/example
 $ cd example
@@ -61,7 +64,9 @@ $ cd example
 ```
 $ cd src && npm install
 ```
+
 安装完毕后，目录结构如下所示：
+
 ```
 |- src
 |   ├── app.js
@@ -74,11 +79,11 @@ $ cd src && npm install
 
 在 `serverless.yml` 文件下的目录中运行 `serverless deploy` 进行 express 项目的部署。第一次部署可能耗时相对较久，但后续的二次部署会在几秒钟之内完成。部署完毕后，你可以在命令行的输出中查看到你 express 应用的 URL 地址，点击地址即可访问你的 express 项目。
 
-**注意：** 
+**注意：**
 
 如您的账号未[登陆](https://cloud.tencent.com/login)或[注册](https://cloud.tencent.com/register)腾讯云，您可以直接通过`微信`扫描命令行中的二维码进行授权登陆和注册。
 
-如果出现了 `internal server error` 的报错，请检查是否在创建模板后没有运行  `npm install`。
+如果出现了 `internal server error` 的报错，请检查是否在创建模板后没有运行 `npm install`。
 
 如果希望查看更多部署过程的信息，可以通过`sls deploy --debug` 命令查看部署过程中的实时日志信息，`sls`是 `serverless` 命令的缩写。
 
@@ -93,36 +98,24 @@ Express 组件支持 0 配置部署，也就是可以直接通过配置文件中
 ```yml
 # serverless.yml
 
-component: express # (必填) 引用 component 的名称，当前用到的是 express-tencent 组件
-name: express-api # (必填) 该 express 组件创建的实例名称
-org: test # (可选) 用于记录组织信息，默认值为您的腾讯云账户 appid
-app: expressApp # (可选) 该 express 应用名称
-stage: dev # (可选) 用于区分环境信息，默认值是 dev
+component: express # (required) name of the component. In that case, it's express.
+name: expressDemo # (required) name of your express component instance.
+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.
 
 inputs:
+  src: ./src # (optional) path to the source folder. default is a hello world app.
+  functionName: expressDemo
   region: ap-guangzhou
-  functionName: express-api
-  serviceName: mytest
-  runtime: Nodejs8.9
-  serviceId: service-np1uloxw
-  src: ./src
-  functionConf:
-    timeout: 10
-    memorySize: 128
-    environment:
-      variables:
-        TEST: vale
+  runtime: Nodejs10.15
+  exclude:
+    - .env
   apigatewayConf:
-    customDomains:
-      - domain: abc.com
-        certificateId: abcdefg
-        isDefaultMapping: 'FALSE'
-        pathMappingSet:
-          - path: /
-            environment: release
-        protocols:
-          - http
-          - https
+    protocols:
+      - http
+      - https
+    environment: release
 ```
 
 点此查看[全量配置及配置说明](https://github.com/serverless-components/tencent-express/blob/v2/docs/configure.md)
diff --git a/example/serverless.yml b/example/serverless.yml
@@ -1,11 +1,12 @@
 component: express # (required) name of the component. In that case, it's express.
-name: express-api # (required) name of your express component instance.
-org: test # (optional) serverless dashboard org. default is the first org you created during signup.
-app: expressApp # (optional) serverless dashboard app. default is the same as the name property.
+name: expressDemo # (required) name of your express component instance.
+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.
 
 inputs:
-  src: ./src # (optional) path to the source folder. default is a hello world app.
+  # src: ./src # (optional) path to the source folder. default is a hello world app.
+  functionName: expressDemo
   region: ap-guangzhou
   runtime: Nodejs10.15
   exclude:
diff --git a/example/src/sls.js b/example/src/sls.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@serverless/express",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "main": "src/serverless.js",
   "publishConfig": {
     "access": "public"
diff --git a/serverless.component.yml b/serverless.component.yml
@@ -1,5 +1,5 @@
 name: express
-version: 0.0.7
+version: 0.0.8
 author: Tencent Cloud Inc.
 org: Tencent Cloud Inc.
 description: Deploys a serverless Express.js application onto Tencent SCF and Tencent APIGateway.
diff --git a/src/_express/handler.js b/src/_express/handler.js
@@ -1,15 +1,16 @@
 const fs = require('fs')
+const path = require('path')
 const { createServer, proxy } = require('tencent-serverless-http')
 
 exports.handler = async (event, context) => {
-  // NOTICE: require() is relative to this file, while existsSync() is relative to the cwd, which is the root of lambda
+  const userSls = path.join(__dirname, '..', 'sls.js')
   let app
-  if (fs.existsSync('./app.js')) {
+  if (fs.existsSync(userSls)) {
     // load the user provided app
-    app = require('../app.js')
+    app = await require(userSls)
   } else {
     // load the built-in default app
-    app = require('../_src/app.js')
+    app = require('./sls.js')
   }
 
   const server = createServer(app)
diff --git a/src/_express/sls.js b/src/_express/sls.js
diff --git a/src/_src/package.json b/src/_src/package.json
diff --git a/src/package.json b/src/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@serverless/express",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "main": "./serverless.js",
   "publishConfig": {
     "access": "public"
@@ -12,6 +12,7 @@
   "author": "Tencent Cloud, Inc.",
   "license": "MIT",
   "dependencies": {
+    "download": "^8.0.0",
     "fs-extra": "^8.1.0",
     "tencent-component-toolkit": "^1.1.1",
     "type": "^2.0.0"
diff --git a/src/utils.js b/src/utils.js
@@ -5,6 +5,7 @@ const { Domain } = require('tencent-component-toolkit')
 const ensureObject = require('type/object/ensure')
 const ensureIterable = require('type/iterable/ensure')
 const ensureString = require('type/string/ensure')
+const download = require('download')
 const CONFIGS = require('./config')
 
 /*
@@ -32,7 +33,21 @@ const packageExpress = async (instance, inputs) => {
 
   // unzip source zip file
   console.log(`Unzipping ${inputs.code.src || 'files'}...`)
-  const sourceDirectory = await instance.unzip(inputs.code.src)
+  let sourceDirectory
+  if (!inputs.code.src) {
+    // add default nextjs template
+    const downloadPath = `/tmp/${generateId()}`
+    const filename = 'template'
+
+    console.log(`Installing Default Express.js App...`)
+    await download(CONFIGS.templateUrl, downloadPath, {
+      filename: `${filename}.zip`
+    })
+    const tempPath = await instance.unzip(`${downloadPath}/${filename}.zip`)
+    sourceDirectory = `${tempPath}/src`
+  } else {
+    sourceDirectory = await instance.unzip(inputs.code.src)
+  }
   console.log(`Files unzipped into ${sourceDirectory}...`)
 
   // add shim to the source directory
@@ -43,11 +58,6 @@ const packageExpress = async (instance, inputs) => {
   console.log(`Installing Serverless Framework SDK...`)
   instance.state.handler = await instance.addSDK(sourceDirectory, '_express/handler.handler')
 
-  if (!inputs.code.src) {
-    // add default express app
-    console.log(`Installing Default Express App...`)
-    copySync(path.join(__dirname, '_src'), path.join(sourceDirectory, '_src'))
-  }
   // zip the source directory with the shim and the sdk
 
   console.log(`Zipping files...`)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@serverless/express",`
`3`		`- "version": "0.0.7",`
	`3`	`+ "version": "0.0.8",`
`4`	`4`	`"main": "src/serverless.js",`
`5`	`5`	`"publishConfig": {`
`6`	`6`	`"access": "public"`