Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Remove @internal annotation from snapshot_ #1728

Merged

Conversation

TheIronDev
Copy link
Contributor

This commit removes the @internal annotation from snapshot_,
and fixes firebase/firebase-functions-test#87.

snapshot_ is currently referenced here.

More context here

I'm happy to work through better alternatives too.

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • [?] Appropriate docs were updated (if necessary)

Fixes firebase/firebase-functions-test#79 馃

@TheIronDev TheIronDev requested review from a team as code owners May 18, 2022 20:22
@product-auto-label product-auto-label bot added size: xs Pull request size is extra small. api: firestore Issues related to the googleapis/nodejs-firestore API. labels May 18, 2022
@TheIronDev TheIronDev force-pushed the tystark/make-snapshot_-non-internal branch from c3ade40 to 982e90b Compare August 24, 2022 18:58
@TheIronDev TheIronDev changed the title Remove @internal annotation from snapshot_ fix: Remove @internal annotation from snapshot_ Aug 24, 2022
@TheIronDev
Copy link
Contributor Author

Is there an appropriate person I should ping for review? 馃惣

Copy link
Contributor

@MarkDuckworth MarkDuckworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I'm not seeing nodejs-firestore make use of the @internal flag anyway. Perhaps something downstream is honoring the internal flag. The @private annotation and underscore in the name should convey the nature of this member, as something not for public consumption.

This commit removes the @internal annotation from snapshot_,
and fixes firebase/firebase-functions-test#87.

`snapshot_` is currently referenced [here](https://github.com/firebase/firebase-functions-test/blob/master/src/providers/firestore.ts#L99).

[More context here](
firebase/firebase-functions-test#87)

I'm happy to work through better alternatives too.
@MarkDuckworth MarkDuckworth added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 14, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 14, 2022
@bcoe bcoe added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Oct 4, 2022
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Oct 4, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 4, 2022
@MarkDuckworth MarkDuckworth merged commit 983ab89 into googleapis:main Oct 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: firestore Issues related to the googleapis/nodejs-firestore API. size: xs Pull request size is extra small.
Projects
None yet
4 participants