如何在本地调试待部署的IBM Cloud Functions Node.js函数

一、基础环境准备 #

• 将你的函数代码保存为action.js
• 同目录下执行npm init -y初始化npm项目
• 安装代码依赖：npm install spark-md5

二、本地传参&查看输出 #

编写本地测试脚本local-test.js，模拟实际调用时传入的参数结构：

const { main } = require('./action');

// 模拟Cloudant返回的参数，可根据实际场景修改结构和值
const testParams = {
    rows: [
        {
            doc: {
                name: "测试用户1",
                email: "test1@example.com",
                comment: "测试评论1",
                createdAt: "2024-01-01T12:00:00Z"
            }
        },
        {
            doc: {
                name: "测试用户2",
                email: "test2@example.com",
                comment: "测试评论2",
                createdAt: "2024-01-02T13:00:00Z"
            }
        }
    ]
};

const result = main(testParams);
console.log('函数返回结果：\n', JSON.stringify(result, null, 2));

执行命令node local-test.js即可在终端看到函数输出结果。
注意：测试参数的结构需要和实际部署后Cloudant传入的结构完全一致，避免部署后出现结构不匹配报错

三、断点&逐行调试 #

方法1：VS Code 调试（推荐） #

1. 在action.js需要打断点的行左侧点击，添加红色断点标记
2. 按F5，选择Node.js运行环境，执行会自动停在断点位置
3. 使用调试工具栏的步进、步过、步出按钮即可完成逐行调试，鼠标悬停变量可直接查看实时值

如果需要固定调试配置，可在.vscode/launch.json中添加如下配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "调试Cloud Function",
            "program": "${workspaceFolder}/local-test.js"
        }
    ]
}

方法2：Chrome DevTools 调试 #

执行命令node --inspect-brk local-test.js，打开Chrome浏览器访问chrome://inspect，点击对应调试目标即可进入调试界面，操作逻辑和前端页面调试一致。

四、适配Postman测试习惯 #

如果习惯用Postman测试，可把函数包装为本地HTTP接口：

1. 安装express依赖：npm install express
2. 编写服务脚本server.js：

const express = require('express');
const { main } = require('./action');
const app = express();
const PORT = 3000;

app.use(express.json());

app.post('/test-function', (req, res) => {
    // Postman请求的Body直接作为参数传入函数
    const result = main(req.body);
    res.json(result);
});

app.listen(PORT, () => {
    console.log(`测试服务已启动，访问地址：http://localhost:${PORT}`);
});

3. 执行node server.js启动服务
4. 打开Postman，新建POST请求，地址填http://localhost:3000/test-function，Body选择JSON格式，填入你要测试的参数结构，发送请求即可看到返回结果，和平时测试后端接口操作完全一致。

内容的提问来源于stack exchange，提问作者Alessandro R