firebase / firebase-admin-node

Firebase Admin Node.js SDK
https://firebase.google.com/docs/admin/setup
Apache License 2.0
1.59k stars 358 forks source link

[FR] Cloud Tasks Testing, Emulation, Management #1830

Open r-dev-limited opened 1 year ago

r-dev-limited commented 1 year ago

First of all, thx for improvements made for Firebase users with regards to Cloud Tasks product.

However there are few crucial missing pieces:

Emulator support

Based on current documentation, only way to use cloud tasks within emulated environment is to call them via HTTP endpoint.

We can exploit this and make basic function to enqueue tasks in our code:

export async function enqueueTask(functionName: string, data: any) {
    const url = `http://0.0.0.0:5001/${process.env.GCLOUD_PROJECT}/${process.env.FUNCTION_REGION}/${functionName}`;
    console.log(url);
    const res = await axios.default({
        method: 'POST', url: url, data: {
            'data': data,
        }
    },);

    return res;
}

But this requires flags inside code, to not use internal SDK but this function. Surely we can have emulator support calling it in same manner, at least.

Testing

Cloud Tasks cannot be "wrapped" in same manner as triggers / cloud functions to write integration tests. Again, only option is to use function mentioned above to "call" task, but HTTP endpoint DOES NOT return any meaningful response.

It waits until task is completed, BUT it does NOT return task's payload, nor rejects/handles thrown Errors.

Tasks Management

And finally, current equeue menthod DOES NOT return TaskID, and SDK does not provide any methods to:

google-oss-bot commented 1 year ago

I found a few problems with this issue: