Unit testing HTTP Callable functions

[ahaverty]

I'm currently moving a lot of our functions to the new HTTP callable functions, and noticed that the docs note:

Note: Testing of HTTP Callable Functions is not yet supported.

Is this something that might be added to the library soon or is there some long-term limitation?

[laurenzlong]

We're working on it!

[ahaverty]

@laurenzlong Sorry for github issue spam, but adding unit testing of https.onCall is now at the top of our companies firebase wish-list 🙏 We'd appreciate hearing about any updates 😄

[thorlukasz]

Any updates? :)

[laurenzlong]

Sorry for the delay, and thanks for the patience everyone! We've been busy working on launching regional support, Node 8 support, and configuration of timeouts and memory allocation, now that those are out the door, this is next up on our roadmap.

[jeanregisser]

Is there any workaround before official support for this gets released?

[joelgetaction]

I really need this since most of my functions are http callable. In fact I'd be happy to help with this if you can assign me some tasks or hints ... :-)

Any updates?

[laurenzlong]

Thanks for the patience everyone! Our team is stretched thin right now so we haven't had a chance to implement this yet. However, you can make use of the run method offered by the firebase-functions SDK, which exists on all cloud functions except HTTPS onRequest functions (see code for callable functions). This is in fact how firebase-functions-test works, it calls the run method.

For example, let's say you have a callable function called myCallableFunction

const myFunctions = require('../index');
const expect = require('chai').expect;

const data = {foo: 'bar'};
const callableContext = {auth: {uid: 'abc'}}; // you can also add "rawRequest" or "instanceIdToken" fields

expect(myFunctions.myCallableFunction.run(data, callableContext))
  .to.eventually.deep.equal({expected: "result"});

[sipersso]

@laurenzlong Do I understand it correctly that there is no way to test HTTPS callable?

[gustavopch]

@sipersso The firebase-functions-test package doesn't currently provide tools for testing Callable Functions, but you can test them anyways as @laurenzlong shows in the snippet right before your comment.

[sipersso]

@gustavopch yes, I tried it and myFunctions.myCallableFunction.run is not "not a function", hence my question.

Since @laurenzlong wrote that "which exists on all cloud functions except HTTPS onRequest functions", I figured that HTTPS was the key here and not onRequest, but it should work for HTTPS callables?

[abeisgoat]

Hey folks, I just opened up #34 which adds support for onCall functions. Please take a look and let me know if there's anything that's missing for your use-cases.