Sentry Serverless types do not work with Firebase background functions

[jsakas]

Package + Version

@sentry/serverless

6.2.0

Description

Firebase offers a few extra types of cloud functions that do not implement the same interface as the existing GCPFunction options. It seems like these work as expected but the typings do not allow a typescript project to compile.

Primarily the ones I am most interested today are the Cloud Firestore triggers and Authentication triggers. The remaining can be found in the docs: https://firebase.google.com/docs/functions/firestore-event

Here are some examples:

const thingCreateHandler = (snap, context) => {}

export const thingCreated = functions.firestore
  .document('things/{id}')
  .onCreate(Sentry.GCPFunction.wrapEventFunction(thingCreateHandler))

Argument of type 'EventFunctionWithCallback' is not assignable to parameter of type '(snapshot: QueryDocumentSnapshot, context: EventContext) => any'.ts(2345)

const userCreateHandler = (user, context) => {}

export const userCreate = functions.auth.user().onCreate(
  Sentry.GCPFunction.wrapEventFunction(userCreateHandler)
);

Argument of type 'EventFunctionWithCallback' is not assignable to parameter of type '(user: UserRecord, context: EventContext) => any'.ts(2345)

This is what the interface looks like:

• Cloud Firestore Triggers:

  /** Respond to all document writes (creates, updates, or deletes). */
  onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
  /** Respond only to document updates. */
  onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
  /** Respond only to document creations. */
  onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
  /** Respond only to document deletions. */
  onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;

• Authentication Triggers:

    /** Respond to the creation of a Firebase Auth user. */
    onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;
    /** Respond to the deletion of a Firebase Auth user. */
    onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;

[jsakas]

After some more testing, I've found that the GCP wrappers don't work well for Firebase functions. I think this is actually more likely a feature request to support Firebase functions entirely - which might involve new wrapper types. I'd be willing to help implement this if it's something that the Sentry team is interested in bringing in.

[zanona]

Yes, it would be great to have support for firebase handlers in addition to GCP. I have created some wrappers myself which I am using. However, having something similar under Sentry.Firebase.wrapHttpsOnRequestHandler would be neat.

https://gist.github.com/zanona/0f3d42093eaa8ac5c33286cc7eca1166

[AbhiPrasad]

PRs are welcome if anyone wants to help contribute!

[github-actions[bot]]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

---

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

[teebu]

any updates on this?

[beardsleym]

I'd love to see Sentry <> FIrebase functions as well

[abierbaum]

@zanona Have you considered making a PR to add these into the core like @AbhiPrasad suggested?

[zanona]

Hey, @abierbaum. I am not entirely familiar with the structure Sentry expects for that add-on, and, unfortunately, I'm a little short in time to learn how to adapt that gist. However, if anyone would like to take the initial code and port into a PR form, I definitely wouldn't mind. :smiley:

[samatcodeapprove]

➕ another vote for this! Would be extremely useful for my team.

[Bogdan1988]

One more vote, this feature can be very useful for my team as well!

[michi88]

At least update the docs that firebase events are not supported (until they are) please!

[AbhiPrasad]

Hi @michi88 - docs PR here: https://github.com/getsentry/sentry-docs/pull/9789

Again PRs are welcome if anyone would like to contribute to this!