Merge branch 'dataconnect' of github.com:Firebase/firebase-js-sdk into dataconnect

Author: maneesht

packages/data-connect/CHANGELOG.md

@@ -1,7 +1,10 @@
-# @firebase/data-connect
+## Unreleased
+* Added app check support # @firebase/data-connect
+
 ## 0.0.3
 * Updated reporting to use @firebase/data-connect instead of @firebase/connect.
 * Added functionality to retry queries and mutations if the server responds with UNAUTHENTICATED.
 * Moved `validateArgs` to core SDK.
 * Updated errors to only show relevant details to the user.
 * Added ability to track whether user is calling core sdk or generated sdk.
+

packages/data-connect/src/api/DataConnect.ts

@@ -35,6 +35,11 @@ import { DataConnectTransport, TransportClass } from '../network';
 import { RESTTransport } from '../network/transport/rest';
 
 import { MutationManager } from './Mutation';
+import { AppCheckTokenProvider } from '../core/AppCheckTokenProvider';
+import {
+  AppCheckInternalComponentName,
+  FirebaseAppCheckInternal
+} from '@firebase/app-check-interop-types';
 
 /**
  * Connector Config for calling Data Connect backend.
@@ -90,11 +95,13 @@ export class DataConnect {
   private _transportOptions?: TransportOptions;
   private _authTokenProvider?: AuthTokenProvider;
   _isUsingGeneratedSdk: boolean = false;
+  private _appCheckTokenProvider?: AppCheckTokenProvider;
   constructor(
     public readonly app: FirebaseApp,
     // TODO(mtewani): Replace with _dataConnectOptions in the future
     private readonly dataConnectOptions: DataConnectOptions,
-    private readonly _authProvider: Provider<FirebaseAuthInternalName>
+    private readonly _authProvider: Provider<FirebaseAuthInternalName>,
+    private readonly _appCheckProvider: Provider<AppCheckInternalComponentName>
   ) {
     if (typeof process !== 'undefined' && process.env) {
       const host = process.env[FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR];
@@ -144,12 +151,19 @@ export class DataConnect {
         this._authProvider
       );
     }
+    if (this._appCheckProvider) {
+      this._appCheckTokenProvider = new AppCheckTokenProvider(
+        this.app.name,
+        this._appCheckProvider
+      );
+    }
 
     this.initialized = true;
     this._transport = new this._transportClass(
       this.dataConnectOptions,
       this.app.options.apiKey,
       this._authTokenProvider,
+      this._appCheckTokenProvider,
       undefined,
       this._isUsingGeneratedSdk
     );

packages/data-connect/src/core/AppCheckTokenProvider.ts

@@ -0,0 +1,73 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  AppCheckInternalComponentName,
+  AppCheckTokenListener,
+  AppCheckTokenResult,
+  FirebaseAppCheckInternal
+} from '@firebase/app-check-interop-types';
+import { Provider } from '@firebase/component';
+
+/**
+ * Abstraction around AppCheck's token fetching capabilities.
+ */
+export class AppCheckTokenProvider {
+  private appCheck?: FirebaseAppCheckInternal;
+  constructor(
+    private appName_: string,
+    private appCheckProvider?: Provider<AppCheckInternalComponentName>
+  ) {
+    this.appCheck = appCheckProvider?.getImmediate({ optional: true });
+    if (!this.appCheck) {
+      appCheckProvider?.get().then(appCheck => (this.appCheck = appCheck));
+    }
+  }
+
+  getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult> {
+    if (!this.appCheck) {
+      return new Promise<AppCheckTokenResult>((resolve, reject) => {
+        // Support delayed initialization of FirebaseAppCheck. This allows our
+        // customers to initialize the RTDB SDK before initializing Firebase
+        // AppCheck and ensures that all requests are authenticated if a token
+        // becomes available before the timoeout below expires.
+        setTimeout(() => {
+          if (this.appCheck) {
+            this.getToken(forceRefresh).then(resolve, reject);
+          } else {
+            resolve(null);
+          }
+        }, 0);
+      });
+    }
+    return this.appCheck.getToken(forceRefresh);
+  }
+
+  addTokenChangeListener(listener: AppCheckTokenListener) {
+    this.appCheckProvider
+      ?.get()
+      .then(appCheck => appCheck.addTokenListener(listener));
+  }
+
+  // Not currently used at the moment. Will update if needed.
+  // notifyForInvalidToken(): void {
+  //   warn(
+  //     `Provided AppCheck credentials for the app named "${this.appName_}" ` +
+  //       'are invalid. This usually indicates your app was not initialized correctly.'
+  //   );
+  // }
+}

packages/data-connect/src/network/fetch.ts

@@ -35,6 +35,7 @@ export function dcFetch<T, U>(
   body: U,
   { signal }: AbortController,
   accessToken: string | null,
+  appCheckToken: string | null,
   _isUsingGen: boolean
 ): Promise<{ data: T; errors: Error[] }> {
   if (!connectFetch) {
@@ -47,6 +48,9 @@ export function dcFetch<T, U>(
   if (accessToken) {
     headers['X-Firebase-Auth-Token'] = accessToken;
   }
+  if (appCheckToken) {
+    headers['X-Firebase-AppCheck'] = appCheckToken;
+  }
   const bodyStr = JSON.stringify(body);
   logDebug(`Making request out to ${url} with body: ${bodyStr}`);
 

packages/data-connect/src/network/transport/index.ts

@@ -16,6 +16,7 @@
  */
 
 import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
+import { AppCheckTokenProvider } from '../../core/AppCheckTokenProvider';
 import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
 
 // Change this to only specify specific args.
@@ -52,6 +53,7 @@ export type TransportClass = new (
   options: DataConnectOptions,
   apiKey?: string,
   authProvider?: AuthTokenProvider,
+  appCheckProvider?: AppCheckTokenProvider,
   transportOptions?: TransportOptions,
   _isUsingGen?: boolean
 ) => DataConnectTransport;

packages/data-connect/src/network/transport/rest.ts

@@ -23,6 +23,7 @@ import { addToken, urlBuilder } from '../../util/url';
 import { dcFetch } from '../fetch';
 
 import { DataConnectTransport } from '.';
+import { AppCheckTokenProvider } from '../../core/AppCheckTokenProvider';
 
 export class RESTTransport implements DataConnectTransport {
   private _host = '';
@@ -33,14 +34,16 @@ export class RESTTransport implements DataConnectTransport {
   private _project = 'p';
   private _serviceName: string;
   private _accessToken: string | null = null;
+  private _appCheckToken: string | null = null;
   private _authInitialized = false;
   private _lastToken: string | null = null;
   constructor(
     options: DataConnectOptions,
     private apiKey?: string | undefined,
     private authProvider?: AuthTokenProvider | undefined,
+    private appCheckProvider?: AppCheckTokenProvider | undefined,
     transportOptions?: TransportOptions | undefined,
-    private _isUsingGen = false
+    private _isUsingGen = false,
   ) {
     if (transportOptions) {
       if (typeof transportOptions.port === 'number') {
@@ -70,6 +73,11 @@ export class RESTTransport implements DataConnectTransport {
       logDebug(`New Token Available: ${token}`);
       this._accessToken = token;
     });
+    this.appCheckProvider?.addTokenChangeListener(result => {
+      const { token } = result;
+      logDebug(`New App Check Token Available: ${token}`);
+      this._appCheckToken = token;
+    });
   }
   get endpointUrl(): string {
     return urlBuilder(
@@ -168,6 +176,7 @@ export class RESTTransport implements DataConnectTransport {
         } as unknown as U, // TODO(mtewani): This is a patch, fix this.
         abortController,
         this._accessToken,
+        this._appCheckToken,
         this._isUsingGen
       )
     );
@@ -195,6 +204,7 @@ export class RESTTransport implements DataConnectTransport {
         } as unknown as U,
         abortController,
         this._accessToken,
+        this._appCheckToken,
         this._isUsingGen
       );
     });

packages/data-connect/src/register.ts

@@ -36,6 +36,7 @@ export function registerDataConnect(variant?: string): void {
       (container, { instanceIdentifier: settings, options }) => {
         const app = container.getProvider('app').getImmediate()!;
         const authProvider = container.getProvider('auth-internal');
+        const appCheckProvider = container.getProvider('app-check-internal');
         let newOpts = options as ConnectorConfig;
         if (settings) {
           newOpts = JSON.parse(settings);
@@ -49,7 +50,8 @@ export function registerDataConnect(variant?: string): void {
         return new DataConnect(
           app,
           { ...newOpts, projectId: app.options.projectId! },
-          authProvider
+          authProvider,
+          appCheckProvider
         );
       },
       ComponentType.PUBLIC