feat: add layer deploy feature

Author: yugasun

.env.example

@@ -1,6 +1,17 @@
+# 腾讯云授权密钥
 TENCENT_SECRET_ID=xxx
 TENCENT_SECRET_KEY=xxx
 
+# 部署地区
+REGION=ap-guangzhou
 
+# 静态资源上传 COS 桶名称
 BUCKET=serverless-cnode
-REGION=ap-guangzhou
+
+# API 网关自定义域名 和 证书 ID
+APIGW_CUSTOM_DOMAIN=cnode.yuga.chat
+APIGW_CUSTOM_DOMAIN_CERTID=xxx
+
+# CDN 域名，证书 ID
+CDN_DOMAIN=static.cnode.yuga.chat
+CDN_DOMAIN_CERTID=xxx

README.md

@@ -15,8 +15,9 @@
 - [x] Express 自定义服务
 - [x] LRU 渲染缓存
 - [x] 基于 Next.js 的 Serverless 组件部署
-- [x] 静态资源分离，自动部署到 COS
-- [x] 自动为静态 COS 配置 CDN
+- [x] **静态资源分离，自动部署到 COS**
+- [x] **自动为静态 COS 配置 CDN**
+- [x] **node_modules 基于层部署，大大提高部署效率**
 
 ## 本地开发
 
@@ -32,8 +33,49 @@ $ npm run dev
 $ npm run build
 ```
 
+## 配置
+
+在部署到 Serverless 前，将 `.env.example` 重命名为 `.env`，并请完成如下配置：
+
+```dotenv
+# 腾讯云授权密钥
+TENCENT_SECRET_ID=xxx
+TENCENT_SECRET_KEY=xxx
+
+# 部署地区
+REGION=ap-guangzhou
+
+# 静态资源上传 COS 桶名称
+BUCKET=serverless-cnode
+
+# API 网关自定义域名 和 证书 ID
+APIGW_CUSTOM_DOMAIN=cnode.yuga.chat
+APIGW_CUSTOM_DOMAIN_CERTID=xxx
+
+# CDN 域名，证书 ID
+CDN_DOMAIN=static.cnode.yuga.chat
+CDN_DOMAIN_CERTID=xxx
+```
+
+> 注意：如果不需要使用 CDN，直接使用 COS 自动生成的域名，也是可以的，只需要删除
+> `serverless.yml` 中的 `cdnConf` 即可。
+
 ## 部署
 
+此项目会先将 `node_modules` 部署到 [层]()，然后在部署项目代码，这样下次部署项目
+时，如果 `node_modules` 没有修改，我们就不需要部署庞大的 `node_modules` 文件夹了
+。
+
+1. 部署层:
+
+```bash
+$ npm run deploy:layer
+```
+
+> 注意：如果项目 `node_modules` 没有变更，就不需要执行此命令。
+
+2. 部署业务代码：
+
 ```bash
 $ npm run deploy
 ```

layer/serverless.yml

@@ -0,0 +1,13 @@
+org: serverless-cnode
+app: serverless-cnode
+stage: dev
+component: layer
+name: serverless-cnode-layer
+
+inputs:
+  region: ${env:REGION}
+  name: ${name}
+  src: ../node_modules
+  runtimes:
+    - Nodejs10.15
+    - Nodejs12.16

package.json

@@ -3,9 +3,11 @@
   "version": "0.0.1",
   "scripts": {
     "dev": "nodemon",
-    "build": "cross-env NODE_ENV=production next build && tsc --project tsconfig.server.json",
+    "build": "rimraf .next && cross-env NODE_ENV=production next build && tsc --project tsconfig.server.json",
+    "build:sls": "rimraf .next && cross-env NODE_ENV=production SERVERLESS=true next build && tsc --project tsconfig.server.json",
     "start": "cross-env NODE_ENV=production node ./dist/index.js",
-    "deploy": "sls deploy"
+    "deploy": "sls deploy",
+    "deploy:layer": "sls deploy --target=./layer"
   },
   "keywords": [
     "next.js",
@@ -63,6 +65,7 @@
     "nodemon": "^2.0.4",
     "postcss-loader": "^3.0.0",
     "postcss-pxtransform": "^2.2.9",
+    "rimraf": "^3.0.2",
     "sass-loader": "^8.0.2",
     "ts-node": "^8.10.2",
     "tslint": "^6.1.2",

server/index.ts

@@ -38,6 +38,9 @@ async function cacheRender(req, res) {
   }
 }
 
+// not report route for custom monitor
+const noReportRoutes = ['/_next', '/static'];
+
 async function startServer() {
   await app.prepare();
 
@@ -73,18 +76,33 @@ async function startServer() {
   });
 
   server.get('*', (req, res) => {
+    noReportRoutes.forEach((route) => {
+      if (req.path.indexOf(route) === 0) {
+        req['__SLS_NO_REPORT__'] = true;
+      }
+    });
     return handle(req, res);
   });
 
-  server.listen(port, () => {
-    console.log(`> Ready on http://localhost:${port}`);
-  });
+  // define binary type for response
+  // if includes, will return base64 encoded, very useful for images
+  server['binaryTypes'] = ['*/*'];
+
+  return server;
 }
 
-try {
-  startServer();
-} catch (e) {
-  throw e;
+if (process.env.SERVERLESS) {
+  module.exports = startServer;
+} else {
+  try {
+    startServer().then((server) => {
+      server.listen(port, () => {
+        console.log(`> Ready on http://localhost:${port}`);
+      });
+    });
+  } catch (e) {
+    throw e;
+  }
 }
 
 process.on('unhandledRejection', (e) => {

serverless.yml

@@ -7,24 +7,34 @@ name: serverless-cnode
 inputs:
   src:
     dist: ./
-    hook: npm run build
+    hook: npm run build:sls
     exclude:
       - .env
+      - '.git/**'
+      - 'docs/**'
       - '.next/cache/**'
-  region: ap-guangzhou
+      - 'node_modules/**'
+  region: ${env:REGION}
   runtime: Nodejs10.15
   functionName: serverless-cnode
+  layers:
+    - name: ${output:${stage}:${app}:${name}-layer.name}
+      version: ${output:${stage}:${app}:${name}-layer.version}
   functionConf:
     timeout: 10
+    environment:
+      variables:
+        NODE_ENV: production
+        SERVERLESS: true
   apigatewayConf:
     protocols:
       - http
       - https
     environment: release
     enableCORS: true
     customDomains:
-      - domain: cnode.yuga.chat
-        certificateId: eGesL28k
+      - domain: ${env.APIGW_CUSTOM_DOMAIN}
+        certificateId: ${env.APIGW_CUSTOM_DOMAIN_CERTID}
         pathMappingSet:
           - path: /
             environment: release
@@ -33,10 +43,10 @@ inputs:
           - https
   staticCdn:
     cosConf:
-      bucket: serverless-cnode
+      bucket: ${env:BUCKET}
     cdnConf:
       # after you deploy CDN once, just set onlyRefresh to true for refresh CDN cache
       onlyRefresh: true
-      domain: static.cnode.yuga.chat
+      domain: ${env.CDN_DOMAIN}
       https:
-        certId: eGkM75xv
+        certId: ${env.CDN_DOMAIN_CERTID}

sls.js

@@ -0,0 +1,6 @@
+process.env.NODE_ENV = 'production';
+process.env.SERVERLESS = true;
+
+const createServer = require('./dist')
+
+module.exports = createServer

yarn.lock

@@ -7154,6 +7154,13 @@ rimraf@2, rimraf@^2.5.4, rimraf@^2.6.3, rimraf@^2.7.1:
   dependencies:
     glob "^7.1.3"
 
+rimraf@^3.0.2:
+  version "3.0.2"
+  resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a"
+  integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==
+  dependencies:
+    glob "^7.1.3"
+
 ripemd160@^2.0.0, ripemd160@^2.0.1:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/ripemd160/-/ripemd160-2.0.2.tgz#a1c1a6f624751577ba5d07914cbc92850585890c"