@react-native-firebase/app-check 17.1.0 → 17.3.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.3.0](https://github.com/invertase/react-native-firebase/compare/v17.2.0...v17.3.0) (2023-02-15)
+
+### Features
+
+- **app-check:** Expose modular API that matches the Firebase web JS SDK v9 API ([#6912](https://github.com/invertase/react-native-firebase/issues/6912)) ([bf02676](https://github.com/invertase/react-native-firebase/commit/bf0267609251a5b8e4245c300678fe7d7ea53d92))
+
+### Bug Fixes
+
+- **app-check, types:** Correct ReactNativeFirebaseAppCheckProvider options type ([#6911](https://github.com/invertase/react-native-firebase/issues/6911)) ([5d7241b](https://github.com/invertase/react-native-firebase/commit/5d7241b124dc283852efb4c549f6888005101ecd))
+
+## [17.2.0](https://github.com/invertase/react-native-firebase/compare/v17.1.0...v17.2.0) (2023-02-15)
+
+### Features
+
+- **app, android:** firebase-android-sdk 31.2.0 ([87156e7](https://github.com/invertase/react-native-firebase/commit/87156e75e16775db14ef8f9bf6b0049b15ee1277))
+
+### Bug Fixes
+
+- **app-check, ios:** debugToken in config on iOS works now ([04615e5](https://github.com/invertase/react-native-firebase/commit/04615e5568af549fb79d8b1ed59dbbce29ddb5f9))
+- **app-check, types:** add `newReactNativeFirebaseAppCheckProvider` function type ([9f5f231](https://github.com/invertase/react-native-firebase/commit/9f5f231e06ebe3f75e553b898eef173395954ae8))
+- **app-check:** better validation of configuration ([df60d83](https://github.com/invertase/react-native-firebase/commit/df60d834c897e55c7c62b4850be12a2a396ac21f))
+
 ## [17.1.0](https://github.com/invertase/react-native-firebase/compare/v17.0.0...v17.1.0) (2023-02-09)
 
 **Note:** Version bump only for package @react-native-firebase/app-check

package/__tests__/appcheck.test.ts

@@ -20,4 +20,10 @@ describe('appCheck()', function () {
       );
     });
   });
+
+  describe('react-native-firebase provider', function () {
+    it('correctly creates a provider instance', function () {
+      expect(firebase.appCheck().newReactNativeFirebaseAppCheckProvider()).toBeDefined();
+    });
+  });
 });

package/android/src/main/java/io/invertase/firebase/appcheck/ReactNativeFirebaseAppCheckProvider.java

@@ -18,15 +18,19 @@ package io.invertase.firebase.appcheck;
  */
 
 import android.util.Log;
+import androidx.annotation.NonNull;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appcheck.AppCheckProvider;
-import com.google.firebase.appcheck.AppCheckProviderFactory;
 import com.google.firebase.appcheck.AppCheckToken;
 import com.google.firebase.appcheck.debug.DebugAppCheckProviderFactory;
+import com.google.firebase.appcheck.debug.InternalDebugSecretProvider;
+import com.google.firebase.appcheck.debug.internal.DebugAppCheckProvider;
 import com.google.firebase.appcheck.playintegrity.PlayIntegrityAppCheckProviderFactory;
 import com.google.firebase.appcheck.safetynet.SafetyNetAppCheckProviderFactory;
-import java.lang.reflect.Constructor;
+import com.google.firebase.inject.Provider;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
 
 // Facade for all possible provider factory delegates,
 // configurable dynamically instead of at startup
@@ -35,6 +39,7 @@ public class ReactNativeFirebaseAppCheckProvider implements AppCheckProvider {
 
   AppCheckProvider delegateProvider;
 
+  @NonNull
   @Override
   public Task<AppCheckToken> getToken() {
     Log.d(LOGTAG, "Provider::getToken - delegating to native provider");
@@ -58,13 +63,25 @@ public class ReactNativeFirebaseAppCheckProvider implements AppCheckProvider {
 
         // the debug configuration may have a token, or may not
         if (debugToken != null) {
-          // Create a debug provider using hidden factory constructor and our debug token
-          Class<DebugAppCheckProviderFactory> debugACFactoryClass =
-              DebugAppCheckProviderFactory.class;
-          Class<?>[] argType = {String.class};
-          Constructor c = debugACFactoryClass.getDeclaredConstructor(argType);
-          Object[] cArgs = {debugToken};
-          delegateProvider = ((AppCheckProviderFactory) c.newInstance(cArgs)).create(app);
+          // To use this token, create debug provider using local secret provider + standard thread
+          // pool
+          ExecutorService executor = Executors.newCachedThreadPool();
+          delegateProvider =
+              new DebugAppCheckProvider(
+                  app,
+                  new Provider<InternalDebugSecretProvider>() {
+                    public InternalDebugSecretProvider get() {
+                      return new InternalDebugSecretProvider() {
+                        public String getDebugSecret() {
+                          return debugToken;
+                        }
+                      };
+                    }
+                  },
+                  executor,
+                  executor,
+                  executor);
+
         } else {
           delegateProvider = DebugAppCheckProviderFactory.getInstance().create(app);
         }

package/android/src/main/java/io/invertase/firebase/appcheck/ReactNativeFirebaseAppCheckProviderFactory.java

@@ -18,17 +18,17 @@ package io.invertase.firebase.appcheck;
  */
 
 import android.util.Log;
+import androidx.annotation.NonNull;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appcheck.AppCheckProvider;
 import com.google.firebase.appcheck.AppCheckProviderFactory;
 import java.util.HashMap;
-import java.util.Map;
 
 public class ReactNativeFirebaseAppCheckProviderFactory implements AppCheckProviderFactory {
   private static final String LOGTAG = "RNFBAppCheck";
 
   // This object has one job - create + maintain control over one provider per app
-  public Map<String, ReactNativeFirebaseAppCheckProvider> providers = new HashMap();
+  public HashMap<String, ReactNativeFirebaseAppCheckProvider> providers = new HashMap<>();
 
   // Our provider will serve as a facade to all the supported native providers,
   // we will just pass through configuration calls to it
@@ -41,7 +41,7 @@ public class ReactNativeFirebaseAppCheckProviderFactory implements AppCheckProvi
             + providerName
             + (debugToken != null ? "/(not shown)" : "/null"));
 
-    ReactNativeFirebaseAppCheckProvider provider = null;
+    ReactNativeFirebaseAppCheckProvider provider;
 
     // Look up the correct provider for the given appName, create it if not created
     provider = providers.get(appName);
@@ -52,6 +52,7 @@ public class ReactNativeFirebaseAppCheckProviderFactory implements AppCheckProvi
     provider.configure(appName, providerName, debugToken);
   }
 
+  @NonNull
   public AppCheckProvider create(FirebaseApp firebaseApp) {
     String appName = firebaseApp.getName();
     Log.d(LOGTAG, "ProviderFactory::create - fetching provider for app " + appName);

package/ios/RNFBAppCheck/RNFBAppCheckProvider.m

@@ -38,18 +38,14 @@
 
   // - determine if debugToken is provided via nullable arg
   if ([providerName isEqualToString:@"debug"]) {
-    // TODO: Currently not handling debugToken argument, relying on existing environment
-    //       variable configuration style.
-    //     - maybe directly setting an environment variable could work?
-    //     https://stackoverflow.com/questions/27139589/whats-the-idiomatic-way-of-setting-an-environment-variable-in-objective-c-coco
-    //     - ...otherwise if env var does not work
-    //       - subclass style: RNFBAppCheckDebugProvider, and we should print local token
-    //       - if a debugToken parameter was supplied, set
-    //       RNFBAppCheckDebugProvider.configuredDebugToken
-    //     - print local token
-    //     https://github.com/firebase/firebase-ios-sdk/blob/c7e95996ff/FirebaseAppCheck/Sources/DebugProvider/FIRAppCheckDebugProviderFactory.m
-    //     - print if current token in provided by configuration, by environment variable, or local
-    //     token?
+    // The firebase-ios-sdk debug app check provider will take a token from environment if it
+    // exists:
+    if (debugToken != nil) {
+      // We have a debug token, so just need to stuff it in the environment and it will hook up
+      char *key = "FIRAAppCheckDebugToken", *value = [debugToken UTF8String];
+      int overwrite = 1;
+      setenv(key, value, overwrite);
+    }
 
     self.delegateProvider = [[FIRAppCheckDebugProvider new] initWithApp:app];
   }

package/lib/index.d.ts

@@ -135,12 +135,12 @@ export namespace FirebaseAppCheckTypes {
      * so AppCheck has the same experience across all platforms, with the only difference being the native
      * providers you choose to use on each platform.
      */
-    configure(
-      web?: ReactNativeFirebaseAppCheckProviderWebOptions,
-      android?: ReactNativeFirebaseAppCheckProviderAndroidOptions,
-      apple?: ReactNativeFirebaseAppCheckProviderAppleOptions,
-      isTokenAutoRefreshEnabled?: boolean,
-    ): Promise<void>;
+    configure(options: {
+      web?: ReactNativeFirebaseAppCheckProviderWebOptions;
+      android?: ReactNativeFirebaseAppCheckProviderAndroidOptions;
+      apple?: ReactNativeFirebaseAppCheckProviderAppleOptions;
+      isTokenAutoRefreshEnabled?: boolean;
+    }): Promise<void>;
   }
 
   /**
@@ -193,6 +193,11 @@ export namespace FirebaseAppCheckTypes {
    *
    */
   export class Module extends FirebaseModule {
+    /**
+     * create a ReactNativeFirebaseAppCheckProvider option for use in react-native-firebase
+     */
+    newReactNativeFirebaseAppCheckProvider(): ReactNativeFirebaseAppCheckProvider;
+
     /**
      * initialize the AppCheck module. Note that in react-native-firebase AppCheckOptions must always
      * be an object with a `provider` member containing `ReactNativeFirebaseAppCheckProvider` that has returned successfully

package/lib/index.js

@@ -26,6 +26,13 @@ import ReactNativeFirebaseAppCheckProvider from './ReactNativeFirebaseAppCheckPr
 
 import version from './version';
 
+export {
+  addTokenListener,
+  getToken,
+  initializeAppCheck,
+  setTokenAutoRefreshEnabled,
+} from './modular/index';
+
 const statics = {};
 
 const namespace = 'appCheck';
@@ -61,13 +68,26 @@ class FirebaseAppCheckModule extends FirebaseModule {
     }
     this.native.setTokenAutoRefreshEnabled(options.isTokenAutoRefreshEnabled);
 
+    if (options.provider === undefined || options.provider.providerOptions === undefined) {
+      throw new Error('Invalid configuration: no provider or no provider options defined.');
+    }
     if (Platform.OS === 'android') {
+      if (!isString(options.provider.providerOptions.android.provider)) {
+        throw new Error(
+          'Invalid configuration: no android provider configured while on android platform.',
+        );
+      }
       return this.native.configureProvider(
         options.provider.providerOptions.android.provider,
         options.provider.providerOptions.android.debugToken,
       );
     }
     if (Platform.OS === 'ios' || Platform.OS === 'macos') {
+      if (!isString(options.provider.providerOptions.apple.provider)) {
+        throw new Error(
+          'Invalid configuration: no apple provider configured while on apple platform.',
+        );
+      }
       return this.native.configureProvider(
         options.provider.providerOptions.apple.provider,
         options.provider.providerOptions.apple.debugToken,

package/lib/modular/index.js

@@ -0,0 +1,70 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library 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 { firebase } from '..';
+
+/**
+ * Activate App Check for the given app. Can be called only once per app.
+ * @param app - FirebaseApp. Optional.
+ * @param options - AppCheckOptions
+ * @returns {AppCheck}
+ */
+export async function initializeAppCheck(app, options) {
+  if (app) {
+    await firebase.app(app.name).appCheck().initializeAppCheck(options);
+    return { app: firebase.app(app.name) };
+  }
+
+  await firebase.app().appCheck().initializeAppCheck(options);
+  return { app: firebase.app() };
+}
+
+/**
+ * Get the current App Check token. Attaches to the most recent in-flight request if one is present.
+ * Returns null if no token is present and no token requests are in-flight.
+ * @param appCheckInstance - AppCheck
+ * @param forceRefresh - boolean
+ * @returns {Promise<AppCheckTokenResult>}
+ */
+export function getToken(appCheckInstance, forceRefresh) {
+  return appCheckInstance.app.appCheck().getToken(forceRefresh);
+}
+
+/**
+ * Registers a listener to changes in the token state.
+ * There can be more than one listener registered at the same time for one or more App Check instances.
+ * The listeners call back on the UI thread whenever the current
+ * token associated with this App Check instance changes.
+ * @param appCheckInstance - AppCheck
+ * @param listener - PartialObserver<AppCheckTokenResult>
+ * @returns {Unsubscribe}
+ */
+export function addTokenListener(appCheckInstance, listener) {
+  // Not implemented on React Native
+  // See packages/app-check/lib/index.js:127
+  throw new Error('addTokenListener is not implemented on React Native');
+}
+
+/**
+ * Set whether App Check will automatically refresh tokens as needed.
+ * @param appCheckInstance - AppCheck
+ * @param isAutoRefreshEnabled - boolean
+ */
+export function setTokenAutoRefreshEnabled(appCheckInstance, isAutoRefreshEnabled) {
+  return appCheckInstance.app.appCheck().setTokenAutoRefreshEnabled(isAutoRefreshEnabled);
+}

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '17.1.0';
+module.exports = '17.3.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/app-check",
-  "version": "17.1.0",
+  "version": "17.3.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - App Check",
   "main": "lib/index.js",
@@ -23,10 +23,10 @@
     "appCheck"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "17.1.0"
+    "@react-native-firebase/app": "17.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "635d595389bfb224fc530681627fb2180fea6e26"
+  "gitHead": "2e51817c937247ffe51fb6234c164744c2a71693"
 }