withAuthContext firestore functions cause error in emulator

[Bullfrog1234]

Related issues

No related issues found.
The capability was added through the firebase/firebase-functions#1519
 

[REQUIRED] Version info

node: v20.11.0

firebase-functions: v4.9.0

firebase-tools: v13.7.2

firebase-admin: v12.0.0

[REQUIRED] Test case

1. Create a new event trigger function for onDocumentCreatedWithAuthContext
2. Build the code if using typescript
3. Run the emulators
4. Watch it fail to run the emulators

The error returned from firebase-tools is:

[warn] !  Unexpected rules runtime error: Exception in thread "main" java.lang.NullPointerException: Cannot invoke "String.length()" because "line" is null
	at com.google.firebase.rules.tools.local.server.Server.processRequestsFromInputStream(Server.java:75)
	at com.google.firebase.rules.tools.local.server.Server.start(Server.java:57)
	at com.google.firebase.rules.tools.local.FirebaseRulesTooling.main(FirebaseRulesTooling.java:81)
 {"metadata":{"emulator":{"name":"storage"},"message":"Unexpected rules runtime error: Exception in thread \"main\" java.lang.NullPointerException: Cannot invoke \"String.length()\" because \"line\" is null\r\n\tat com.google.firebase.rules.tools.local.server.Server.processRequestsFromInputStream(Server.java:75)\r\n\tat com.google.firebase.rules.tools.local.server.Server.start(Server.java:57)\r\n\tat com.google.firebase.rules.tools.local.FirebaseRulesTooling.main(FirebaseRulesTooling.java:81)\r\n"}}
[info] i  logging: Stopping Logging Emulator {"metadata":{"emulator":{"name":"logging"},"message":"Stopping Logging Emulator"}}
[error] 
[error] Error: HTTP Error: 500, [object Object]
[debug] [2024-04-13T13:44:30.399Z] Error Context: {
  "body": {
    "error": {
      "code": 500,
      "status": "UNKNOWN"
    }
  },
  "response": {
    "statusCode": 500
  }
}

Inspecting the java error shows the issue:

 Unsupported eventType: google.cloud.firestore.document.v1.created.withAuthContext; Supported ones: [google.cloud.firestore.document.v1.created, google.cloud.firestore.document.v1.deleted, google.cloud.firestore.document.v1.updated, google.cloud.firestore.document.v1.written]

[REQUIRED] Steps to reproduce

As above

[REQUIRED] Expected behavior

Either:

• Warning in the emulator output that it is not supported and not load it and continue with emulating the rest
• Emulate the new Firestore triggers (Preferred)

[REQUIRED] Actual behavior

Errors are returned on emulator start. Have to disable new functions to get emulators to run.

Were you able to successfully deploy your functions?

Not relevant to this error as it relates to the emulators

[google-oss-bot]

I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.

[Bullfrog1234]

This could also be an issue for firebase tools. Not sure. If so let me know and will raise it there.

[benomatis]

I get the same error, despite importing the trigger like this:

import { onDocumentWrittenWithAuthContext } from 'firebase-functions/v2/firestore'

I get the following error

java.lang.IllegalArgumentException: Unsupported eventType: google.cloud.firestore.document.v1.written.withAuthContext; Supported ones: [google.cloud.firestore.document.v1.created, google.cloud.firestore.document.v1.deleted, google.cloud.firestore.document.v1.updated, google.cloud.firestore.document.v1.written]

For some reason it is trying to use Google Cloud Firestore triggers instead of Firebase Functions Firestore triggers despite the fact it's how it's been imported.

And I can confirm this is definitely an emulator problem only, the function otherwise deploys fine.

[blidd-google]

Hi all, I've flagged the issue to the Firestore team and we should have support for the new auth context event types in the next release. Will update this thread once we've released support. Thanks for your patience!

[Bullfrog1234]

Any news on the timeline for this?

[joehan]

@Bullfrog1234 This is in the works, we discovered some issues with our initial implementation that we're currently addressing. Unfortunately, due to upcoming code freezes for Google I/O, this will probably be a few more weeks we're able to ship it.

[Bullfrog1234]

@joehan Thanks for the update and understood about code freeze.

[Seanitzel]

Would be great if you can put a note about it in the docs in the meantime, to save people's time :)

[MutatedGamer]

Is there an ETA for when a release will be out? My use-case for wanting this support is I want to write unit tests for the functions that use Firebase Emulator (e.g. firebase emulators:exec --only firestore,functions "npm run test:functions"). Unfortunately, that's not possible if the emulator can't start ☹️

[benbrunyee]

Are there any suggested alternatives for the time being?
Local development for my web app is paused until firebase emulators:start works.

[bytewiz]

Same issue here using onDocumentWrittenWithAuthContext

[Bullfrog1234]

Hi @joehan,

I assume the code freeze is completed, so I am wishing for an update on this.

If the timeline is greater than 2 weeks from today can we follow @Seanitzel suggestion and add a note to the documentation. This will inform uses that this is not working in the emulators until it is fixed.

[ohld]

Hi @Bullfrog1234,

I still have the same issue once I add a new function that uses onDocumentWrittenWithAuthContext. My firebase-tools --version version is 13.14.2.

When I run the emulators I see in the logs that firestore emulator is downgraded from 1.19.7 back to 1.19.6 which doesn't have a fix.

startups-functions:serve: i  emulators: Starting emulators: functions, firestore
startups-functions:serve: ⚠  functions: The following emulators are not running, calls to these services from the Functions emulator will affect production: auth, database, hosting, pubsub, storage, dataconnect
startups-functions:serve: i  firestore: downloading cloud-firestore-emulator-v1.19.6.jar...
Progress: ===========================================================================> (100% of 67MB)
startups-functions:serve: i  firestore: Removing outdated emulator files: cloud-firestore-emulator-v1.19.7.jar```

UPD:

Resolved by updating firebase-tools package manually in all package.json files in the project.