Overload getAll function to allow array destructuring

[cxam]

Fixes #501

This PR overloads the getAll function in Firestore and Transaction class to allow passing in a destructured array of documents.

• Tests and linter pass
• Code coverage does not decrease
• Appropriate docs were updated

[mikelehen]

Thanks very much for digging in and taking a stab at overloads (and adding tests, etc.!) but looking closer I think overloads don't actually help here. So do you mind going dropping the "overload" and just using your more permissive function signature like you did in the original PR? Thanks!

[cxam]

@mikelehen I have just pushed an update to the PR that uses a tuple type along with the rest element. What this means is that the first parameter is required and must be of type DocumentReference followed by the rest. This is just an improvement over the original signature to prevent calling getAll() without any matching parameters or an incorrect one (getAll(ReadOptions)).

[mikelehen]

Thanks! Left a couple more comments. Sorry for so much back-forth.

[cxam]

No worries! Just updated the PR with single signature. This should hopefully maintain compatibility albeit being overly permissive.

[cxam]

@schmidt-sebastian JSDoc updated in latest commit. I have also fixed the failing test for Transaction class - getAll() supports array destructuring with field mask.

Also, I noticed that npm test doesn't actually run the system tests. I understand that this is due to the credentials needed to run this properly as it requires access to a Google Cloud Project. Should the contributing guide be updated to include instructions on how to run these (i.e. setting of GCLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS environment variables)?

[mikelehen]

Thanks! I think this looks good to me now. 😁

[mikelehen]

@JustinBeckwith @crwilcox Either of you know if there's a trick to making the CI run (for an externally contributed PR)?

[cxam]

@mikelehen I think last time this worked when @kinwa91 assigned the kokoro:force-run label (googleapis/sloth).

[jkwlui]

Anyone with write access can apply the kokoro:force-run label to jumpstart the test.

[mikelehen]

@cxam @kinwa91 Nice, thanks!