Fis modularization #3638

ChaoqunCHEN · 2020-08-14T18:40:51Z

No description provided.

changeset-bot · 2020-08-14T18:40:54Z

💥 No Changeset

Latest commit: 19bab1c

Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂

If these changes should be published to npm, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

google-oss-bot · 2020-08-14T21:02:06Z

Binary Size Report

Affected SDKs

No changes between base commit (57739ae) and head commit (1bd1c08).

Test Logs

Base (57739ae2): https://github.com/firebase/firebase-js-sdk/actions/runs/224342433
Head (1bd1c084): https://github.com/firebase/firebase-js-sdk/actions/runs/224389142

Feiyang1

The integration with app-exp looks pretty good. I didn't look into the implementation which, I assume, didn't change?

Can you please integrate with api-extractor, which generates api reports and documentation. You can look at functions-exp. You want to copy this file, and add these scripts in the package.json. Let me know if you need any help.

packages-exp/installations-exp/package.json

packages-exp/installations-exp/src/functions/config.ts

packages-exp/installations-types-exp/package.json

packages-exp/installations-exp/package.json

Co-authored-by: Feiyang <[email protected]>

…e place

Feiyang1

It seems you haven't integrated with api-extractor. Let me know if you need help

packages-exp/installations-types-exp/index.d.ts

packages-exp/installations-exp/src/index.ts

Feiyang1

Since installations is a dependency for other SDKs, we need to register another component for internal consumption. It should return an object with getId() and getToken().

So in the function/config.ts, you should register another component:

// define an internal API
interface InstallationsInternal {
  getId: () => Promise<string>
  getToken: (force?: boolean) => Promise<string>
}

// register an internal component
_registerComponent(new Component(
     'installations-internal-exp',
      container => {
        const installations = container.getProvider('installation-exp').getImmediate();
        const installationsInternalService: InstallationsInternal = {
          // bind to the correct installations instance
          getId: getId.bind(null, installations), 
          getToken: getToken.bind(null, installations)
        };

        return installationsService;
      },
      ComponentType.INTERNAL
    )
  );)

In FCM/Perf/RC, they will get the instance of the internal installations by:

const installations = _getProvider('installations-internal-exp').getImmediate();
installations.getId();
installations.getToken();

Does it make sense? Let me know if you want to chat offline

packages-exp/installations-exp/src/api/get-installations.ts

Feiyang1

I think there was some confusion on public component vs internal component. I added some comments to hopefully clear things up.

packages-exp/installations-types-exp/index.d.ts

packages-exp/installations-exp/src/functions/config.ts

packages-exp/installations-exp/src/api/get-installations.ts

packages-exp/installations-exp/src/interfaces/installation-internal.ts

packages-exp/installations-types-exp/index.d.ts

packages-exp/installations-exp/src/functions/config.ts

packages-exp/installations-types-exp/index.d.ts

packages-exp/installations-exp/src/api/get-id.ts

…3733) * integrate api-extractor into installations-exp * add release tag to APIs * add _ prefix to the internal interface * update api report

google-oss-bot · 2020-09-03T00:08:46Z

Size Analysis Report

Affected Products

`@firebase/installations-exp`

`deleteInstallations`

Size

Type	Base (`1df547b`)	Head (`2601106`)	Diff
size	?	8.90 kB	? (?)
size_with_ext_deps	?	17.3 kB	? (?)

Dependencies

Type	Base (`1df547b`)	Head (`2601106`)	Diff
functions	?	Click to show 52 deps `broadcastFidChange` `bufferToBase64UrlSafe` `callFidChangeCallbacks` `clearTimedOutRequest` `closeBroadcastChannel` `completeInstallationRegistration` `createInstallationRequest` `deleteInstallationRequest` `deleteInstallations` `encode` `extractAppConfig` `extractAuthTokenInfoFromResponse` `fetchAuthTokenFromServer` `fidChanged` `generateAuthTokenRequest` `generateFid` `getAuthorizationHeader` `getBroadcastChannel` `getDbPromise` `getDeleteEndpoint` `getErrorFromResponse` `getExpiresInFromResponseExpiresIn` `getGenerateAuthTokenEndpoint` `getHeaders` `getHeadersWithAuth` `getId` `getInstallationEntry` `getInstallationsEndpoint` `getKey` `getMissingValueError` `getToken` `hasAuthTokenRequestTimedOut` `hasInstallationRequestTimedOut` `isAuthTokenExpired` `isAuthTokenValid` `isEntryRegistered` `isServerError` `makeAuthTokenRequestInProgressEntry` `refreshAuthToken` `registerInstallation` `registerInstallations` `remove` `retryIfServerError` `set` `sleep` `triggerRegistrationIfNecessary` `update` `updateAuthTokenRequest` `updateInstallationRequest` `updateOrCreateInstallationEntry` `waitUntilAuthTokenRequest` `waitUntilFidRegistration`	?
variables	?	Click to show 23 deps `DATABASE_NAME` `DATABASE_VERSION` `ERROR_DESCRIPTION_MAP` `ERROR_FACTORY` `INSTALLATIONS_API_URL` `INSTALLATIONS_NAME` `INSTALLATIONS_NAME_INTERNAL` `INTERNAL_AUTH_VERSION` `INVALID_FID` `OBJECT_STORE_NAME` `PACKAGE_VERSION` `PENDING_TIMEOUT_MS` `SERVICE` `SERVICE_NAME` `TOKEN_EXPIRATION_BUFFER` `VALID_FID_PATTERN` `broadcastChannel` `dbPromise` `fidChangeCallbacks` `internalFactory` `name` `publicFactory` `version`	?

External Dependencies

Module	Base (`1df547b`)	Head (`2601106`)	Diff
`@firebase/util`	?	`ErrorFactory` `FirebaseError`	?
`idb`	?	`openDb`	?
`@firebase/app-exp`	?	`_getProvider` `_registerComponent` `registerVersion`	?
`@firebase/component`	?	`Component`	?

`getId`

Size

Type	Base (`1df547b`)	Head (`2601106`)	Diff
size	?	8.34 kB	? (?)
size_with_ext_deps	?	16.8 kB	? (?)

Dependencies

Type	Base (`1df547b`)	Head (`2601106`)	Diff
functions	?	Click to show 49 deps `broadcastFidChange` `bufferToBase64UrlSafe` `callFidChangeCallbacks` `clearTimedOutRequest` `closeBroadcastChannel` `completeInstallationRegistration` `createInstallationRequest` `encode` `extractAppConfig` `extractAuthTokenInfoFromResponse` `fetchAuthTokenFromServer` `fidChanged` `generateAuthTokenRequest` `generateFid` `getAuthorizationHeader` `getBroadcastChannel` `getDbPromise` `getErrorFromResponse` `getExpiresInFromResponseExpiresIn` `getGenerateAuthTokenEndpoint` `getHeaders` `getHeadersWithAuth` `getId` `getInstallationEntry` `getInstallationsEndpoint` `getKey` `getMissingValueError` `getToken` `hasAuthTokenRequestTimedOut` `hasInstallationRequestTimedOut` `isAuthTokenExpired` `isAuthTokenValid` `isEntryRegistered` `isServerError` `makeAuthTokenRequestInProgressEntry` `refreshAuthToken` `registerInstallation` `registerInstallations` `remove` `retryIfServerError` `set` `sleep` `triggerRegistrationIfNecessary` `update` `updateAuthTokenRequest` `updateInstallationRequest` `updateOrCreateInstallationEntry` `waitUntilAuthTokenRequest` `waitUntilFidRegistration`	?
variables	?	Click to show 23 deps `DATABASE_NAME` `DATABASE_VERSION` `ERROR_DESCRIPTION_MAP` `ERROR_FACTORY` `INSTALLATIONS_API_URL` `INSTALLATIONS_NAME` `INSTALLATIONS_NAME_INTERNAL` `INTERNAL_AUTH_VERSION` `INVALID_FID` `OBJECT_STORE_NAME` `PACKAGE_VERSION` `PENDING_TIMEOUT_MS` `SERVICE` `SERVICE_NAME` `TOKEN_EXPIRATION_BUFFER` `VALID_FID_PATTERN` `broadcastChannel` `dbPromise` `fidChangeCallbacks` `internalFactory` `name` `publicFactory` `version`	?

External Dependencies

Module	Base (`1df547b`)	Head (`2601106`)	Diff
`@firebase/util`	?	`ErrorFactory` `FirebaseError`	?
`idb`	?	`openDb`	?
`@firebase/app-exp`	?	`_getProvider` `_registerComponent` `registerVersion`	?
`@firebase/component`	?	`Component`	?

`getInstallations`

Size

Type	Base (`1df547b`)	Head (`2601106`)	Diff
size	?	8.43 kB	? (?)
size_with_ext_deps	?	16.9 kB	? (?)

Dependencies

Type	Base (`1df547b`)	Head (`2601106`)	Diff
functions	?	Click to show 50 deps `broadcastFidChange` `bufferToBase64UrlSafe` `callFidChangeCallbacks` `clearTimedOutRequest` `closeBroadcastChannel` `completeInstallationRegistration` `createInstallationRequest` `encode` `extractAppConfig` `extractAuthTokenInfoFromResponse` `fetchAuthTokenFromServer` `fidChanged` `generateAuthTokenRequest` `generateFid` `getAuthorizationHeader` `getBroadcastChannel` `getDbPromise` `getErrorFromResponse` `getExpiresInFromResponseExpiresIn` `getGenerateAuthTokenEndpoint` `getHeaders` `getHeadersWithAuth` `getId` `getInstallationEntry` `getInstallations` `getInstallationsEndpoint` `getKey` `getMissingValueError` `getToken` `hasAuthTokenRequestTimedOut` `hasInstallationRequestTimedOut` `isAuthTokenExpired` `isAuthTokenValid` `isEntryRegistered` `isServerError` `makeAuthTokenRequestInProgressEntry` `refreshAuthToken` `registerInstallation` `registerInstallations` `remove` `retryIfServerError` `set` `sleep` `triggerRegistrationIfNecessary` `update` `updateAuthTokenRequest` `updateInstallationRequest` `updateOrCreateInstallationEntry` `waitUntilAuthTokenRequest` `waitUntilFidRegistration`	?
variables	?	Click to show 23 deps `DATABASE_NAME` `DATABASE_VERSION` `ERROR_DESCRIPTION_MAP` `ERROR_FACTORY` `INSTALLATIONS_API_URL` `INSTALLATIONS_NAME` `INSTALLATIONS_NAME_INTERNAL` `INTERNAL_AUTH_VERSION` `INVALID_FID` `OBJECT_STORE_NAME` `PACKAGE_VERSION` `PENDING_TIMEOUT_MS` `SERVICE` `SERVICE_NAME` `TOKEN_EXPIRATION_BUFFER` `VALID_FID_PATTERN` `broadcastChannel` `dbPromise` `fidChangeCallbacks` `internalFactory` `name` `publicFactory` `version`	?

External Dependencies

Module	Base (`1df547b`)	Head (`2601106`)	Diff
`@firebase/util`	?	`ErrorFactory` `FirebaseError`	?
`idb`	?	`openDb`	?
`@firebase/app-exp`	?	`_getProvider` `_registerComponent` `registerVersion`	?
`@firebase/component`	?	`Component`	?

`getToken`

Size

Type	Base (`1df547b`)	Head (`2601106`)	Diff
size	?	8.35 kB	? (?)
size_with_ext_deps	?	16.8 kB	? (?)

Dependencies

Type	Base (`1df547b`)	Head (`2601106`)	Diff
functions	?	Click to show 49 deps `broadcastFidChange` `bufferToBase64UrlSafe` `callFidChangeCallbacks` `clearTimedOutRequest` `closeBroadcastChannel` `completeInstallationRegistration` `createInstallationRequest` `encode` `extractAppConfig` `extractAuthTokenInfoFromResponse` `fetchAuthTokenFromServer` `fidChanged` `generateAuthTokenRequest` `generateFid` `getAuthorizationHeader` `getBroadcastChannel` `getDbPromise` `getErrorFromResponse` `getExpiresInFromResponseExpiresIn` `getGenerateAuthTokenEndpoint` `getHeaders` `getHeadersWithAuth` `getId` `getInstallationEntry` `getInstallationsEndpoint` `getKey` `getMissingValueError` `getToken` `hasAuthTokenRequestTimedOut` `hasInstallationRequestTimedOut` `isAuthTokenExpired` `isAuthTokenValid` `isEntryRegistered` `isServerError` `makeAuthTokenRequestInProgressEntry` `refreshAuthToken` `registerInstallation` `registerInstallations` `remove` `retryIfServerError` `set` `sleep` `triggerRegistrationIfNecessary` `update` `updateAuthTokenRequest` `updateInstallationRequest` `updateOrCreateInstallationEntry` `waitUntilAuthTokenRequest` `waitUntilFidRegistration`	?
variables	?	Click to show 23 deps `DATABASE_NAME` `DATABASE_VERSION` `ERROR_DESCRIPTION_MAP` `ERROR_FACTORY` `INSTALLATIONS_API_URL` `INSTALLATIONS_NAME` `INSTALLATIONS_NAME_INTERNAL` `INTERNAL_AUTH_VERSION` `INVALID_FID` `OBJECT_STORE_NAME` `PACKAGE_VERSION` `PENDING_TIMEOUT_MS` `SERVICE` `SERVICE_NAME` `TOKEN_EXPIRATION_BUFFER` `VALID_FID_PATTERN` `broadcastChannel` `dbPromise` `fidChangeCallbacks` `internalFactory` `name` `publicFactory` `version`	?

External Dependencies

Module	Base (`1df547b`)	Head (`2601106`)	Diff
`@firebase/util`	?	`ErrorFactory` `FirebaseError`	?
`idb`	?	`openDb`	?
`@firebase/app-exp`	?	`_getProvider` `_registerComponent` `registerVersion`	?
`@firebase/component`	?	`Component`	?

`onIdChange`

Size

Type	Base (`1df547b`)	Head (`2601106`)	Diff
size	?	8.60 kB	? (?)
size_with_ext_deps	?	17.0 kB	? (?)

Dependencies

Type	Base (`1df547b`)	Head (`2601106`)	Diff
functions	?	Click to show 52 deps `addCallback` `broadcastFidChange` `bufferToBase64UrlSafe` `callFidChangeCallbacks` `clearTimedOutRequest` `closeBroadcastChannel` `completeInstallationRegistration` `createInstallationRequest` `encode` `extractAppConfig` `extractAuthTokenInfoFromResponse` `fetchAuthTokenFromServer` `fidChanged` `generateAuthTokenRequest` `generateFid` `getAuthorizationHeader` `getBroadcastChannel` `getDbPromise` `getErrorFromResponse` `getExpiresInFromResponseExpiresIn` `getGenerateAuthTokenEndpoint` `getHeaders` `getHeadersWithAuth` `getId` `getInstallationEntry` `getInstallationsEndpoint` `getKey` `getMissingValueError` `getToken` `hasAuthTokenRequestTimedOut` `hasInstallationRequestTimedOut` `isAuthTokenExpired` `isAuthTokenValid` `isEntryRegistered` `isServerError` `makeAuthTokenRequestInProgressEntry` `onIdChange` `refreshAuthToken` `registerInstallation` `registerInstallations` `remove` `removeCallback` `retryIfServerError` `set` `sleep` `triggerRegistrationIfNecessary` `update` `updateAuthTokenRequest` `updateInstallationRequest` `updateOrCreateInstallationEntry` `waitUntilAuthTokenRequest` `waitUntilFidRegistration`	?
variables	?	Click to show 23 deps `DATABASE_NAME` `DATABASE_VERSION` `ERROR_DESCRIPTION_MAP` `ERROR_FACTORY` `INSTALLATIONS_API_URL` `INSTALLATIONS_NAME` `INSTALLATIONS_NAME_INTERNAL` `INTERNAL_AUTH_VERSION` `INVALID_FID` `OBJECT_STORE_NAME` `PACKAGE_VERSION` `PENDING_TIMEOUT_MS` `SERVICE` `SERVICE_NAME` `TOKEN_EXPIRATION_BUFFER` `VALID_FID_PATTERN` `broadcastChannel` `dbPromise` `fidChangeCallbacks` `internalFactory` `name` `publicFactory` `version`	?

External Dependencies

Module	Base (`1df547b`)	Head (`2601106`)	Diff
`@firebase/util`	?	`ErrorFactory` `FirebaseError`	?
`idb`	?	`openDb`	?
`@firebase/app-exp`	?	`_getProvider` `_registerComponent` `registerVersion`	?
`@firebase/component`	?	`Component`	?

Test Logs

Base (1df547b2): https://github.com/firebase/firebase-js-sdk/actions/runs/234793364
Head (26011067): https://github.com/firebase/firebase-js-sdk/actions/runs/236904617

ChaoqunCHEN added 6 commits August 13, 2020 11:40

copied orginal FIS sdk into packages-expp and made unit tests passed

8b42af1

migrated test app and fixed a test app bug to make it worked

41cd275

made installations-exp depend on app-exp

4947925

Relocated public methods files into folder

a67daa4

Making installations mudularization step1, build success

5d5001a

Making installations mudularization step2, unit tests pass

3aa24dd

ChaoqunCHEN requested review from Feiyang1 and zwu52 August 14, 2020 18:40

ChaoqunCHEN requested review from hiranya911 and hsubox76 as code owners August 14, 2020 18:40

update dependency version, merge master

39c39eb

Merge branch 'master' into fis-modularization

0af33d4

Feiyang1 reviewed Aug 25, 2020

View reviewed changes

ChaoqunCHEN and others added 4 commits August 25, 2020 14:36

Apply suggestions from code review

bbc121c

Co-authored-by: Feiyang <[email protected]>

update dependencies' version

93e1215

Merge branch 'master' into fis-modularization

9570f71

add getInstallation(app)

aa2c9a0

ChaoqunCHEN requested a review from Feiyang1 August 26, 2020 00:07

ChaoqunCHEN added 2 commits August 25, 2020 17:17

correct deleteInstallations funciton name

e2a1930

Place the call to registerVerion and registerInstallations at the sam…

9b46a8f

…e place

Feiyang1 reviewed Aug 26, 2020

View reviewed changes

packages-exp/installations-types-exp/index.d.ts Outdated Show resolved Hide resolved

packages-exp/installations-exp/src/index.ts Outdated Show resolved Hide resolved

ChaoqunCHEN added 2 commits August 25, 2020 18:14

remove dead code

36e93da

add api extractor config

3d3d36c

Feiyang1 reviewed Aug 26, 2020

View reviewed changes

packages-exp/installations-exp/src/api/get-installations.ts Outdated Show resolved Hide resolved

ChaoqunCHEN added 3 commits August 26, 2020 14:46

rewrite the internal interface

8e36c93

Merge branch 'master' into fis-modularization

be162a3

fix build error

4aa04bc

ChaoqunCHEN requested a review from Feiyang1 August 27, 2020 20:02

Feiyang1 suggested changes Aug 28, 2020

View reviewed changes

Seperate internal interface from public interface.

ce48439

ChaoqunCHEN requested a review from Feiyang1 September 1, 2020 17:42

Feiyang1 suggested changes Sep 1, 2020

View reviewed changes

Feiyang1 reviewed Sep 1, 2020

View reviewed changes

packages-exp/installations-exp/src/api/get-id.ts Outdated Show resolved Hide resolved

ChaoqunCHEN added 2 commits September 1, 2020 17:06

Change public methods to accept public interface

1df33cc

Merge branch 'master' into fis-modularization

19bab1c

ChaoqunCHEN requested a review from Feiyang1 September 2, 2020 00:14

Fixes and api extractor integration for @firebase/installations-exp (#…

5876ea8

…3733) * integrate api-extractor into installations-exp * add release tag to APIs * add _ prefix to the internal interface * update api report

Feiyang1 approved these changes Sep 3, 2020

View reviewed changes

ChaoqunCHEN merged commit f506e18 into master Sep 3, 2020

firebase locked and limited conversation to collaborators Oct 4, 2020

Fis modularization #3638

Fis modularization #3638

Uh oh!

Conversation

ChaoqunCHEN commented Aug 14, 2020

Uh oh!

changeset-bot bot commented Aug 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💥 No Changeset

Uh oh!

google-oss-bot commented Aug 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Binary Size Report

Affected SDKs

Test Logs

Uh oh!

Feiyang1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Feiyang1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Feiyang1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Feiyang1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

google-oss-bot commented Sep 3, 2020

Size Analysis Report

Affected Products

@firebase/installations-exp

deleteInstallations

Size

Dependencies

External Dependencies

getId

Size

Dependencies

External Dependencies

getInstallations

Size

Dependencies

External Dependencies

getToken

Size

Dependencies

External Dependencies

onIdChange

Size

Dependencies

External Dependencies

Test Logs

Uh oh!

Uh oh!

changeset-bot bot commented Aug 14, 2020 •

edited

Loading

google-oss-bot commented Aug 14, 2020 •

edited

Loading

`@firebase/installations-exp`

`deleteInstallations`

`getId`

`getInstallations`

`getToken`

`onIdChange`