feat: optmize code zip flow

Author: yugasun

src/_shims/handler.js

@@ -15,6 +15,9 @@ exports.handler = async (event, context) => {
     app = require('./sls.js')
   }
 
+  app.request.__SLS_EVENT__ = event
+  app.request.__SLS_CONTEXT__ = context
+
   // cache server, not create repeatly
   if (!server) {
     server = createServer(app.callback(), null, app.binaryTypes || [])
@@ -23,5 +26,10 @@ exports.handler = async (event, context) => {
   context.callbackWaitsForEmptyEventLoop =
     app.callbackWaitsForEmptyEventLoop === true ? true : false
 
-  return proxy(server, event, context, 'PROMISE').promise
+  if (app.slsInitialize && typeof app.slsInitialize === 'function') {
+    await app.slsInitialize()
+  }
+
+  const result = await proxy(server, event, context, 'PROMISE')
+  return result.promise
 }

src/package.json

@@ -12,8 +12,7 @@
   "license": "MIT",
   "dependencies": {
     "download": "^8.0.0",
-    "fs-extra": "^8.1.0",
-    "tencent-component-toolkit": "^1.5.5",
+    "tencent-component-toolkit": "^1.8.3",
     "type": "^2.0.0"
   }
 }

src/serverless.js

@@ -1,6 +1,6 @@
 const { Component } = require('@serverless/core')
-const { MultiApigw, Scf, Apigw, Cos, Cns } = require('tencent-component-toolkit')
-const { packageCode, getDefaultProtocol, deleteRecord, prepareInputs } = require('./utils')
+const { MultiApigw, Scf, Apigw, Cns } = require('tencent-component-toolkit')
+const { uploadCodeToCos, getDefaultProtocol, deleteRecord, prepareInputs } = require('./utils')
 const CONFIGS = require('./config')
 
 class ServerlessComponent extends Component {
@@ -20,62 +20,19 @@ class ServerlessComponent extends Component {
     }
   }
 
-  async uploadCodeToCos(credentials, inputs, region, filePath) {
-    const { appId } = this.credentials.tencent.tmpSecrets
-    // 创建cos对象
-    const cos = new Cos(credentials, region)
-    // 创建存储桶 + 设置生命周期
-    if (!inputs.code.bucket) {
-      inputs.code.bucket = `sls-cloudfunction-${region}-code`
-      await cos.deploy({
-        bucket: inputs.code.bucket + '-' + appId,
-        force: true,
-        lifecycle: [
-          {
-            status: 'Enabled',
-            id: 'deleteObject',
-            filter: '',
-            expiration: { days: '10' },
-            abortIncompleteMultipartUpload: { daysAfterInitiation: '10' }
-          }
-        ]
-      })
-    }
-
-    // 上传代码
-    if (!inputs.code.object) {
-      const object = `${inputs.name}-${Math.floor(Date.now() / 1000)}.zip`
-      inputs.code.object = object
-      await cos.upload({
-        bucket: inputs.code.bucket + '-' + appId,
-        file: filePath,
-        key: inputs.code.object
-      })
-    }
-    this.state.bucket = inputs.code.bucket
-    this.state.object = inputs.code.object
-
-    return {
-      bucket: inputs.code.bucket,
-      object: inputs.code.object
-    }
+  getAppId() {
+    return this.credentials.tencent.tmpSecrets.appId
   }
 
   async deployFunction(credentials, inputs, regionList) {
-    // if set bucket and object not pack code
-    let packageDir
-    if (!inputs.code.bucket || !inputs.code.object) {
-      packageDir = await packageCode(this, inputs)
-    }
-
-    // 上传代码到COS
     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 this.uploadCodeToCos(credentials, inputs, curRegion, packageDir)
+        const code = await uploadCodeToCos(this, appId, credentials, inputs, curRegion)
         const scf = new Scf(credentials, curRegion)
         const tempInputs = {
           ...inputs,

src/utils.js

@@ -1,6 +1,5 @@
 const path = require('path')
-const { copySync } = require('fs-extra')
-const { Domain } = require('tencent-component-toolkit')
+const { Domain, Cos } = require('tencent-component-toolkit')
 const ensureObject = require('type/object/ensure')
 const ensureIterable = require('type/iterable/ensure')
 const ensureString = require('type/string/ensure')
@@ -21,52 +20,93 @@ const generateId = () =>
   Math.random()
     .toString(36)
     .substring(6)
-/*
- * Packages framework app and injects shims and sdk
- *
- * @param ${instance} instance - the component instance
- * @param ${object} config - the component config
- */
-const packageCode = async (instance, inputs) => {
+
+const getCodeZipPath = async (instance, inputs) => {
   console.log(`Packaging ${CONFIGS.frameworkFullname} application...`)
 
   // unzip source zip file
-  console.log(`Unzipping ${inputs.code.src || 'files'}...`)
-  let sourceDirectory
+  let zipPath
   if (!inputs.code.src) {
-    // add default nextjs template
+    // add default template
     const downloadPath = `/tmp/${generateId()}`
     const filename = 'template'
 
     console.log(`Installing Default ${CONFIGS.frameworkFullname} App...`)
     await download(CONFIGS.templateUrl, downloadPath, {
       filename: `${filename}.zip`
     })
-    const tempPath = await instance.unzip(`${downloadPath}/${filename}.zip`)
-    sourceDirectory = `${tempPath}/src`
+    zipPath = `${downloadPath}/${filename}.zip`
   } else {
-    sourceDirectory = await instance.unzip(inputs.code.src)
+    zipPath = inputs.code.src
   }
-  console.log(`Files unzipped into ${sourceDirectory}...`)
 
-  // add shim to the source directory
-  console.log(`Installing ${CONFIGS.frameworkFullname} + SCF handler...`)
-  copySync(path.join(__dirname, '_shims'), path.join(sourceDirectory, '_shims'))
+  return zipPath
+}
 
-  // add sdk to the source directory, add original handler
-  console.log(`Installing Serverless Framework SDK...`)
-  instance.state.handler = await instance.addSDK(sourceDirectory, '_shims/handler.handler')
+/**
+ * Upload code to COS
+ * @param {Component} instance serverless component instance
+ * @param {string} appId app id
+ * @param {object} credentials credentials
+ * @param {object} inputs component inputs parameters
+ * @param {string} region region
+ */
+const uploadCodeToCos = async (instance, appId, credentials, inputs, region) => {
+  const bucketName = inputs.code.bucket || `sls-cloudfunction-${region}-code`
+  const objectName = inputs.code.object || `${inputs.name}-${Math.floor(Date.now() / 1000)}.zip`
+  // if set bucket and object not pack code
+  if (!inputs.code.bucket || !inputs.code.object) {
+    const zipPath = await getCodeZipPath(instance, inputs)
+    console.log(`Code zip path ${zipPath}`)
 
-  // zip the source directory with the shim and the sdk
+    // save the zip path to state for lambda to use it
+    instance.state.zipPath = zipPath
 
-  console.log(`Zipping files...`)
-  const zipPath = await instance.zip(sourceDirectory)
-  console.log(`Files zipped into ${zipPath}...`)
+    const cos = new Cos(credentials, region)
 
-  // save the zip path to state for lambda to use it
-  instance.state.zipPath = zipPath
+    if (!inputs.code.bucket) {
+      // create default bucket
+      await cos.deploy({
+        bucket: bucketName + '-' + appId,
+        force: true,
+        lifecycle: [
+          {
+            status: 'Enabled',
+            id: 'deleteObject',
+            filter: '',
+            expiration: { days: '10' },
+            abortIncompleteMultipartUpload: { daysAfterInitiation: '10' }
+          }
+        ]
+      })
+    }
 
-  return zipPath
+    // upload code to cos
+    if (!inputs.code.object) {
+      console.log(`Getting cos upload url for bucket ${bucketName}`)
+      const uploadUrl = await cos.getObjectUrl({
+        bucket: bucketName + '-' + appId,
+        object: objectName,
+        method: 'PUT'
+      })
+      const slsSDKEntries = instance.getSDKEntries('_shims/handler.handler')
+
+      console.log(`Uploading code to bucket ${bucketName}`)
+      await instance.uploadSourceZipToCOS(zipPath, uploadUrl, slsSDKEntries, {
+        _shims: path.join(__dirname, '_shims')
+      })
+      console.log(`Upload ${objectName} to bucket ${bucketName} success`)
+    }
+  }
+
+  // save bucket state
+  instance.state.bucket = bucketName
+  instance.state.object = objectName
+
+  return {
+    bucket: bucketName,
+    object: objectName
+  }
 }
 
 const mergeJson = (sourceJson, targetJson) => {
@@ -300,7 +340,7 @@ const prepareInputs = async (instance, credentials, inputs = {}) => {
 module.exports = {
   generateId,
   sleep,
-  packageCode,
+  uploadCodeToCos,
   mergeJson,
   capitalString,
   getDefaultProtocol,