Skip to content

Change functions to use messaging interop component #5339

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 2 commits into from
Aug 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages-exp/functions-exp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"typings": "dist/functions-exp-public.d.ts",
"dependencies": {
"@firebase/component": "0.5.6",
"@firebase/messaging-types": "0.5.0",
"@firebase/messaging-interop-types": "0.0.1",
"@firebase/auth-interop-types": "0.1.6",
"@firebase/app-check-interop-types": "0.1.0",
"@firebase/util": "1.3.0",
Expand Down
24 changes: 14 additions & 10 deletions packages-exp/functions-exp/src/callable.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ import {
ComponentType
} from '@firebase/component';
import {
FirebaseMessaging,
FirebaseMessagingName
} from '@firebase/messaging-types';
MessagingInternal,
MessagingInternalComponentName
} from '@firebase/messaging-interop-types';
import {
FirebaseAuthInternal,
FirebaseAuthInternalName
Expand Down Expand Up @@ -108,9 +108,9 @@ describe('Firebase Functions > Call', () => {

it('token', async () => {
// mock auth-internal service
const authMock: FirebaseAuthInternal = ({
const authMock: FirebaseAuthInternal = {
getToken: async () => ({ accessToken: 'token' })
} as unknown) as FirebaseAuthInternal;
} as unknown as FirebaseAuthInternal;
const authProvider = new Provider<FirebaseAuthInternalName>(
'auth-internal',
new ComponentContainer('test')
Expand Down Expand Up @@ -139,15 +139,19 @@ describe('Firebase Functions > Call', () => {
return;
}
// mock firebase messaging
const messagingMock: FirebaseMessaging = ({
const messagingMock: MessagingInternal = {
getToken: async () => 'iid'
} as unknown) as FirebaseMessaging;
const messagingProvider = new Provider<FirebaseMessagingName>(
'messaging',
} as unknown as MessagingInternal;
const messagingProvider = new Provider<MessagingInternalComponentName>(
'messaging-internal',
new ComponentContainer('test')
);
messagingProvider.setComponent(
new Component('messaging', () => messagingMock, ComponentType.PRIVATE)
new Component(
'messaging-internal',
() => messagingMock,
ComponentType.PRIVATE
)
);

const functions = createTestService(
Expand Down
10 changes: 8 additions & 2 deletions packages-exp/functions-exp/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,25 @@ import {
InstanceFactory
} from '@firebase/component';
import { FUNCTIONS_TYPE } from './constants';
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
import { MessagingInternalComponentName } from '@firebase/messaging-interop-types';

const AUTH_INTERNAL_NAME: FirebaseAuthInternalName = 'auth-internal';
const APP_CHECK_INTERNAL_NAME: AppCheckInternalComponentName =
'app-check-internal';
const MESSAGING_INTERNAL_NAME: MessagingInternalComponentName =
'messaging-internal';

export function registerFunctions(fetchImpl: typeof fetch): void {
const factory: InstanceFactory<'functions-exp'> = (
container: ComponentContainer,
{ instanceIdentifier: regionOrCustomDomain }
) => {
// Dependencies
const app = container.getProvider('app-exp').getImmediate();
const authProvider = container.getProvider('auth-internal');
const messagingProvider = container.getProvider('messaging');
const authProvider = container.getProvider(AUTH_INTERNAL_NAME);
const messagingProvider = container.getProvider(MESSAGING_INTERNAL_NAME);
const appCheckProvider = container.getProvider(APP_CHECK_INTERNAL_NAME);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down
12 changes: 6 additions & 6 deletions packages-exp/functions-exp/src/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ import {
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
FirebaseMessaging,
FirebaseMessagingName
} from '@firebase/messaging-types';

import { Provider } from '@firebase/component';
import {
AppCheckInternalComponentName,
FirebaseAppCheckInternal
} from '@firebase/app-check-interop-types';
import {
MessagingInternal,
MessagingInternalComponentName
} from '@firebase/messaging-interop-types';

/**
* The metadata that should be supplied with function calls.
Expand All @@ -45,11 +45,11 @@ export interface Context {
*/
export class ContextProvider {
private auth: FirebaseAuthInternal | null = null;
private messaging: FirebaseMessaging | null = null;
private messaging: MessagingInternal | null = null;
private appCheck: FirebaseAppCheckInternal | null = null;
constructor(
authProvider: Provider<FirebaseAuthInternalName>,
messagingProvider: Provider<FirebaseMessagingName>,
messagingProvider: Provider<MessagingInternalComponentName>,
appCheckProvider: Provider<AppCheckInternalComponentName>
) {
this.auth = authProvider.getImmediate({ optional: true });
Expand Down
4 changes: 2 additions & 2 deletions packages-exp/functions-exp/src/service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import { ContextProvider } from './context';
import { encode, decode } from './serializer';
import { Provider } from '@firebase/component';
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
import { FirebaseMessagingName } from '@firebase/messaging-types';
import { MessagingInternalComponentName } from '@firebase/messaging-interop-types';
import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';

export const DEFAULT_REGION = 'us-central1';
Expand Down Expand Up @@ -86,7 +86,7 @@ export class FunctionsService implements _FirebaseService {
constructor(
readonly app: FirebaseApp,
authProvider: Provider<FirebaseAuthInternalName>,
messagingProvider: Provider<FirebaseMessagingName>,
messagingProvider: Provider<MessagingInternalComponentName>,
appCheckProvider: Provider<AppCheckInternalComponentName>,
regionOrCustomDomain: string = DEFAULT_REGION,
readonly fetchImpl: typeof fetch
Expand Down
6 changes: 3 additions & 3 deletions packages-exp/functions-exp/test/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@
import { FirebaseOptions, FirebaseApp } from '@firebase/app-exp';
import { Provider, ComponentContainer } from '@firebase/component';
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
import { FirebaseMessagingName } from '@firebase/messaging-types';
import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
import { FunctionsService } from '../src/service';
import { connectFunctionsEmulator } from '../src/api';
import nodeFetch from 'node-fetch';
import { MessagingInternalComponentName } from '../../../packages/messaging-interop-types';

export function makeFakeApp(options: FirebaseOptions = {}): FirebaseApp {
options = {
Expand All @@ -49,8 +49,8 @@ export function createTestService(
'auth-internal',
new ComponentContainer('test')
),
messagingProvider = new Provider<FirebaseMessagingName>(
'messaging',
messagingProvider = new Provider<MessagingInternalComponentName>(
'messaging-internal',
new ComponentContainer('test')
),
appCheckProvider = new Provider<AppCheckInternalComponentName>(
Expand Down