Firestore Functions Triggers Breaks

[displayDev-spec]

Related issues

[REQUIRED] Version info

node: 22

firebase-functions: "7.2.5", was also tested with 7.2.6-rc0

firebase-tools:

firebase-admin: 13.10.0

[REQUIRED] Test case

exports.onDocWriteTest = onDocumentWritten({document: "collectionName/{docID}"}, async (event) => {

})

If the document end with empty space " ", for example the document name is "Test Document " with a space in the end, the trigger will results in a crash/error.
For any other document that does NOT end with an empty space, the trigger works as usual.

[REQUIRED] Steps to reproduce

1. Create a trigger function for any type of document/collection
2. Create a document in the collection where the document ID has a space in the end of it, for example Document ID
3. The function will crash upon document write/create

[REQUIRED] Expected behavior

The trigger should work as intended without crashing

[REQUIRED] Actual behavior

The function trigger crashes with the following error:

Error: Resource name '//pubsub.googleapis.com/' is not valid.
    at QualifiedResourcePath.fromSlashSeparatedString (/workspace/node_modules/@google-cloud/firestore/build/src/path.js:368:15)
    at Firestore.snapshot_ (/workspace/node_modules/@google-cloud/firestore/build/src/index.js:846:97)
    at Object.createBeforeSnapshotFromJson (/workspace/node_modules/firebase-functions/lib/common/providers/firestore.js:77:27)
    at createBeforeSnapshot (/workspace/node_modules/firebase-functions/lib/v2/providers/firestore.js:180:45)
    at makeChangedFirestoreEvent (/workspace/node_modules/firebase-functions/lib/v2/providers/firestore.js:214:69)
    at func (/workspace/node_modules/firebase-functions/lib/v2/providers/firestore.js:313:26)
    at /layers/google.nodejs.functions-framework/functions-framework/node_modules/@google-cloud/functions-framework/build/src/function_wrappers.js:119:25
    at process.processTicksAndRejections (node:internal/process/task_queues:103:5)

It seems the path extraction breaks at fromSlashSeparatedString

Were you able to successfully deploy your functions?

Yes

[IzaakGough]

Hi @displayDev-spec, thanks for raising this. We will review as soon as possible.

[IzaakGough]

I was able to reproduce this with your setup. I will continue investigating and keep you updated.

[IzaakGough]

Hi @displayDev-spec, update on this one.

I traced the crash and confirmed it's not something we can fix in firebase-functions. The CloudEvent delivered to your function already has a malformed source attribute (//pubsub.googleapis.com/ instead of a valid Firestore resource path) by the time it reaches your code; this is set by the Eventarc delivery pipeline before the event ever hits firebase-functions or the Functions Framework. We tried a client-side workaround (#1935) but closed it since it would just mask bad data from the platform rather than fix the actual cause.

I will bring this up internally with the Eventarc/Firestore triggers team, since the real fix needs to happen in how Firestore document events with trailing-whitespace document IDs are published. I'll update this issue when I hear back.

In the meantime, the safe workaround is to avoid trailing whitespace in document IDs (e.g. trim before writing), since that reliably avoids the malformed event.

[ajperel]

As a first step, since I wasn't sure, I confirmed that Firestore does allow document IDs with trailing whitespace per https://firebase.google.com/docs/firestore/quotas#collections_documents_and_fields

[ajperel]

I have a partial fix in #1942 which will fix the crash. My test function is of the form:

exports.onDocWriteTest = onDocumentWritten({
  document: "collectionName/{docID}",
  database: "testing",
}, async (event) => {
  logger.log("onDocWriteTest2 triggered for", event.params.docID);
});

After this PR things don't crash but the event isn't correct and event.params.docID is undefined. There's some problems deeper in the stack.

[ajperel]

@IzaakGough my partial fix is the same as yours #1935 was. I think it is correct to do, but not sufficient.

[ajperel]

Across those two PRs it does fix the issue. But I'm not particularly familiar with functions-framework-nodejs... this may not be an acceptable fix.

[ajperel]

I landed part 1. I don't expect GoogleCloudPlatform/functions-framework-nodejs#786 to be accepted but some folks there if they have time may find a better solution.