Function Compute:Deploy a code package

Preparations

1. Create a code directory for testing, such as mycode.

   • Linux or macOS operating system

     You can execute mkdir -p /tmp/mycode to create it.

   • Windows operating system

     Create a new folder in any location and name it mycode.

2. In the mycode directory, create a code file named index.mjs or index.js.

   The following sample code provides an example.

   ES module

   Note

   This example supports only Node.js 18 and later.

   // index.mjs
   'use strict';
   import * as emoji from 'node-emoji'
   
   export const handler = async (event, context) => {
     console.log('hello world');
     return emoji.get(':unicorn:');
   }
   

   CommonJS module

   // index.js
   'use strict';
   var emoji = require('node-emoji')
   
   exports.handler = (event, context, callback) => {
     console.log('hello world');
     callback(null, emoji.get(':unicorn:'));
   }
   

Use npm to install dependencies and deploy code

Prerequisites

• npm is installed on your on-premises machine, and you have permissions to execute npm commands.

• You have created a Node.js function in the Function Compute console. For more information, see Create an event function.

Procedure

1. In the mycode directory, execute npm install node-emoji to install the emoji dependency library to the current directory.

2. Package all files in the mycode directory.

   • Linux or macOS operating system

     Go to the mycode directory and execute zip code.zip -r ./*.

     Note

     Make sure that you have the read and write permissions on the directory.

   • Windows operating system

     Go to the mycode directory, select all files, right-click, and select to package them as a ZIP package.

   Note

   Make sure that the index.js file you created is located in the root directory of the package.

3. In the Function Compute console, find the target function. Then, on the Function Details page, click the Code tab, click Upload Code in the upper-right corner to upload the ZIP package that you packaged in the previous step. After the upload is complete, click Test Function to verify the correctness of the code.

Use Serverless Devs to install dependencies and deploy the project

Prerequisites

• Quick Start

• Configure Serverless Devs

Procedure

1. Execute cd /tmp/mycode to go to the mycode directory.

2. Add an s.yaml file.

   The following sample code provides an example of the file:

   edition: 3.0.0
   name: fcDeployApp
   access: "default"
   
   vars: # Global variables
     region: "cn-hangzhou"
   
   resources:
     hello_world:
       component: fc3 # The component name
       props:
         region: ${vars.region}              # For more information about how to use variables, see: https://docs.serverless-devs.com/serverless-devs/yaml#%E5%8F%98%E9%87%8F%E8%B5%8B%E5%80%BC
         functionName: "emoji"
         description: 'this is emoji'
         runtime: "nodejs18"
         code: ./
         handler: index.handler
         memorySize: 128
         timeout: 30

3. Add a package.json file.

   The following sample code provides an example of how to edit the file:

   {
     "dependencies": {
       "node-emoji": "^1.11.0"
     }
   }

4. Execute sudo s build --use-docker to install dependencies.

   After the execution is complete, an .s directory is generated in the mycode directory, and the dependencies are installed in the .s/build/artifacts/{functionName} directory.

5. Execute sudo s deploy to deploy the project.

   After the execution is complete, the function is deployed to Function Compute.

Important notes

When you use the custom runtime Node.js language and the startup command executes a compiled executable file, directly modifying the source code in WebIDE will not take effect because the actual running file is still the old executable file. To make the code modifications take effect, you need to update the code locally, recompile and package it, upload the code package to WebIDE, and then re-execute the function.

More information