Firebase Cloud Functions 中的返回值是否重要

Question

我正在使用 TypeScript 编写 Firebase 可以函数，以下是更新文档的简单方法。

import * as functions from 'firebase-functions';
import * as admin from 'firebase-admin';
admin.initializeApp(functions.config().firebase);

export const handleTestData = functions.firestore.document('test/{docID}').onCreate(async (snap, context) => {
    const data = snap.data();
    if (data) {
        try {
                await admin.firestore().doc('test1/' + context.params.docID + '/').update({duplicate : true});
            } catch (error) {}
    }
});

在此方法中，promise 由async await 处理，并且没有return 语句，它工作正常。我见过的大多数示例/教程在每种方法中总是有一个return 语句。 我在 Firebase Cloud Functions 中没有返回任何内容是否有任何影响/差异？如果我应该返回一些东西，我可以返回null吗？

Answer 1

Firebase Cloud Functions 中的返回值重要吗？

是的，确实是关键，在执行异步处理的云函数（也称为“后台函数”）中，当所有异步处理完成时返回一个 JavaScript 承诺，如中所述documentation。

这样做很重要，主要有两个原因（摘自文档）：

1. 您确保运行您的 Cloud Function 的 Cloud Functions 实例在您的函数成功达到其终止条件或状态之前不会关闭。
2. 您可以避免从运行时间过长或无限循环的 Cloud Functions 收取过多费用。

---

为什么即使你没有返回 Promise，你的 Cloud Function 也能正常运行？

通常，您的 Cloud Functions 应该在异步操作完成之前终止，因为您不返回 Promise 并因此向 Cloud Functions 平台指示它可以终止运行 Cloud Functions 的 Cloud Functions 实例。

但有时，Cloud Functions 平台不会立即终止 Function，异步操作可以完成。这根本无法保证并且完全不受您的控制。

经验表明，对于短的异步操作，最后一种情况经常发生，开发人员认为一切正常。但是，突然之间，有一天，云函数不起作用……有时它确实起作用了：开发人员面临着一种没有任何明确逻辑的“不稳定”行为，这使得调试变得非常困难。您会在 Stack Overflow 中找到很多问题来说明这种情况。

---

因此，具体而言，在您的情况下，您可以像这样调整您的代码：

export const handleTestData = functions.firestore.document('test/{docID}').onCreate(async (snap, context) => {
    const data = snap.data();
    if (data) {
        try {   
                // See the return below: we return the Promise returned by update()
                return admin.firestore().doc('test1/' + context.params.docID + '/').update({duplicate : true});
         } catch (error) {
               return null;  // <- See the return
        }
    } else {
       return null;  // <- See the return
    }
});

或喜欢

export const handleTestData = functions.firestore.document('test/{docID}').onCreate(async (snap, context) => {
    const data = snap.data();
    if (data) {
        try {
                await admin.firestore().doc('test1/' + context.params.docID + '/').update({duplicate : true});
                return null;  // <- See the return
         } catch (error) {
               return null;  // <- See the return
        }
    } else {
       return null;  // <- See the return
    }
});

返回null（或true，或1...）是有效的，因为async 函数总是返回一个Promise。