firebase / firebase/firebase-admin-node

[FR] Cloud Tasks Testing, Emulation, Management

Open
#1,830 1 comment 4 reactions 1 assignee Claimed by @inlined View on GitHub
api: functions type: feature request
Dominant language
TypeScript
Stars
1.7k
Forks
419
Avg merge
3d 10h
Merged PRs (30d)
16

Description

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:
- identify tasks
- cancel tasks
- check their status

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.