alicloud-fc-ts-template

A template reposistory for Serverless project using Aliyun(AliCloud) Function Compute service.

This project is a Work In Progress(WIP) and changes as well as bugs are expected.

Please feel free to submit an issue or pull request where you deem fit.

Requirement

In this project, we operate under the following assumptions:

• You have an AliCloud account with at least Function Compute and SLS (for logging related features) enabled
• You decided that you will be using Nodejs8 runtime
• You have setup TypeScript
• You have setup FCli, the official tooling for function compute.
  • Official Documentation (CN)
  • Official Documentation (EN) (less information)

How to use

git clone https://github.com/sluongng/alicloud-fc-ts-template

0. Update env-setup.sh with appropriate names so npm run <script-name> will work properly
1. Development happen in ./src folder
2. Compile codes to *.js with npm run build
3. Test the function locally with npm test
4. Create/Update the function using npm run func-create / npm run func-update commands
5. Invoke the function online with npm run func-invoke
6. (Assuming you have SLS setup for FC service) Check logs of function in the last 5 minutes using npm run func-logs
7. Create/Update trigger with npm run trigger-create / npm run trigger-update
8. Run whole live cycle with npm run all

Debugging

• This repository also included ts-node and the launch.json configurations for debugging on VSCode.

  • Use eventFunc.test.ts file for debugging.

• TODO: Include Docker setup

Http Trigger

As noted in official documentation [CN] [EN], the Http Triggered function has different interface compare to normal event-based functions

function(request, response, context) {}

In this repository, I have also provided a working example via httpFunc.ts and neccessary models via httpModels.ts.

The example functionality here is based on the official example on Aliyun/AlibabaCloud website.

An example of httpTrigger.yml file is also included.

To Do

• Provided basic setup of event driven function
• Provided basic npm scripts to assit with building, testing and deploy code
• Provided standard TypeScript Compiler and TSlint configurations
• Provided simple VSCode launch.json configuration for debugging locally
• Provided basic setup of http driven function
• To provide setup/scripts for local docker testing with aliyun/fc-docker
• To provide more event models for OSS, CDN and SLS based events
• To provide more event models for Gateway, TableStore, IoT and DataHub based events
• Reimplement models with toJSON() and fromJSON() so that it works better with JSON. More information here