Skip to content

Allow FCM to auto-generate typings, separate internal vs external APIs #982

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Aug 7, 2020

Conversation

MathBunny
Copy link
Contributor

@MathBunny MathBunny commented Aug 6, 2020

Context

The goal is to bridge the gap between today's Admin SDK (manually curated d.ts files, nested namespaces) and a modularized SDK that has auto-generated typings.

This is the sixth milestone from: go/firebase-node-auto-typing.

Goals for this PR

  1. Allow to auto-generated typings for FCM
  2. Split the internal and external APIs
  3. Still use the previous manually curated typings
  4. Be a non-breaking change

Prerequisites

None.

Test Plan

  1. Unit tests:

npm test

  1. Integration tests:

export TYPE_GENERATION_MODE=nonauto && npm run integration && export TYPE_GENERATION_MODE=auto && npm run integration

  1. Sanity tests:

export TYPE_GENERATION_MODE=nonauto && npm pack && ./.github/scripts/verify_package.sh firebase-* && export TYPE_GENERATION_MODE=auto && npm pack && ./.github/scripts/verify_package.sh firebase-*

restrictedPackageName?: string;
[other: string]: any;
[key: string]: any | undefined;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Inconsistent here

@MathBunny MathBunny requested a review from hiranya911 August 6, 2020 21:32
@MathBunny MathBunny marked this pull request as ready for review August 6, 2020 21:32
@MathBunny MathBunny assigned MathBunny and unassigned hiranya911 Aug 6, 2020
@MathBunny MathBunny assigned hiranya911 and unassigned MathBunny Aug 7, 2020
Copy link
Contributor

@hiranya911 hiranya911 left a comment

Choose a reason for hiding this comment

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

Looks pretty good. Just one change suggestion. Shouldn't we also need to modify the gulp file?

@hiranya911 hiranya911 assigned MathBunny and unassigned hiranya911 Aug 7, 2020
@MathBunny MathBunny requested a review from hiranya911 August 7, 2020 18:26
@MathBunny MathBunny assigned hiranya911 and unassigned MathBunny Aug 7, 2020
@MathBunny
Copy link
Contributor Author

Thanks for the feedback! Yes, I missed adding it to the gulpfile, that is required. Moreover, after running the sanity tests with the updated gulpfile it also uncovered a missing interface that wasn't exported 👍🏼

Copy link
Contributor

@hiranya911 hiranya911 left a comment

Choose a reason for hiding this comment

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

LGTM with a nit.

@hiranya911 hiranya911 assigned MathBunny and unassigned hiranya911 Aug 7, 2020
@MathBunny MathBunny merged commit 24ac03f into master Aug 7, 2020
@MathBunny MathBunny deleted the hlazu-modularizing-messaging branch August 12, 2020 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants