Function Compute:Deploy a code package

Preparations

1. Create a code directory for tests and specify a name for the directory. In this example, mycode is used.

   • Linux and macOS

     Run the mkdir -p /tmp/mycode command to create the directory.

   • Windows

     Create a folder and name it mycode.

2. Create the index.mjs or index.js file in the mycode directory.

   The following code shows an example:

   ECMAScript modules

   Note

   This example supports only Node.js 18 or 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 modules

   // 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 the code

Prerequisites

• npm is installed on your on-premises machine, and the permissions to execute npm commands are obtained.

• A Node.js function is created in the Function Compute console. For more information, see Create an event function.

Procedure

1. Run the npm install node-emoji command in the mycode directory to install the emoji dependency library to the current directory.

2. Package all files in the mycode directory.

   • Linux and macOS

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

     Note

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

   • Windows

     Go to the mycode directory, select all files, right-click the files, and then compress the files into a .zip file.

   Note

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

3. In the Function Compute console, find the function that you want to manage. In the upper-right corner of the function details page, click Upload Code and upload the ZIP package that you prepared.

   After the code is uploaded, you can click Test Function on the Code tab to check whether the code is correct.

Use Serverless Devs to install dependencies and deploy the code

Prerequisites

• Serverless Devs and dependencies are installed. For more information, see Quick start.

• Serverless Devs is configured. For more information, see Configure Serverless Devs.

Procedure

1. Run the cd /tmp/mycode command to go to the mycode directory.

2. Create the s.yaml file.

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

   edition: 3.0.0
   name: fcDeployApp
   access: "default"
   
   vars: # The global variables.
     region: "cn-hangzhou"
   
   resources:
     hello_world:
       component: fc3 # The name of the component.
       props:
         region: ${vars.region}              # For information about how to use variables, visit: 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 the package.json file.

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

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

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

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

5. Run sudo s deploy to deploy the project.

   After the execution, you can deploy your function to Function Compute.

Important note

When using a custom runtime for Node.js and specifying a compiled executable as the startup command, modifying the source code directly in WebIDE will not take effect, as the function will continue to run the previously compiled executable. To apply code changes, you must update the source code locally, recompile and package the executable, upload the updated package to WebIDE, and then re-run the function.

More information