Merge branch 'crashlytics/anrs' into td/anr

Author: tejasd

README.md

@@ -61,6 +61,9 @@ https://firebase.google.com.
     submodules by running `git submodule update --init --recursive`.
 * Import the firebase-android-sdk gradle project into Android Studio using the
   **Import project(Gradle, Eclipse ADT, etc.)** option.
+* `firebase-crashlytics-ndk` must be built with NDK 21. See
+  [firebase-crashlytics-ndk](firebase-crashlytics-ndk/README.md) for more 
+  details.
 
 ## Testing
 

appcheck/firebase-appcheck-debug-testing/src/main/java/com/google/firebase/appcheck/debug/testing/DebugAppCheckTestHelper.java

@@ -29,31 +29,31 @@
  *
  * <p>Example Usage:
  *
- * <pre>{@code
- * @RunWith(AndroidJunit4.class)
+ * <pre>
+ * &#64;RunWith(AndroidJunit4.class)
  * public class MyTests {
  *   private final DebugAppCheckTestHelper debugAppCheckTestHelper =
  *       DebugAppCheckTestHelper.fromInstrumentationArgs();
  *
- *   @Test
- *   public testWithDefaultApp() {
+ *   &#64;Test
+ *   public void testWithDefaultApp() {
  *     debugAppCheckTestHelper.withDebugProvider(() -> {
  *       // Test code that requires a debug AppCheckToken
  *     });
  *   }
  *
- *   @Test
- *   public testWithNonDefaultApp() {
+ *   &#64;Test
+ *   public void testWithNonDefaultApp() {
  *     debugAppCheckTestHelper.withDebugProvider(
  *         FirebaseApp.getInstance("nonDefaultApp"),
  *         () -> {
  *           // Test code that requires a debug AppCheckToken
  *         });
  *   }
  * }
- * }</pre>
+ * </pre>
  *
- * <pre>{@code
+ * <pre>
  * // In build.gradle.kts
  * android {
  *   defaultConfig {
@@ -63,15 +63,15 @@
  *     }
  *   }
  * }
- * }</pre>
+ * </pre>
  */
 public final class DebugAppCheckTestHelper {
   private static final String DEBUG_SECRET_KEY = "firebaseAppCheckDebugSecret";
 
   private final String debugSecret;
 
   /**
-   * Create a {@link DebugAppCheckTestHelper} instance with the debug secret obtained from {@link
+   * Creates a {@link DebugAppCheckTestHelper} instance with the debug secret obtained from {@link
    * InstrumentationRegistry} arguments.
    */
   @NonNull

appcheck/firebase-appcheck-safetynet/src/main/java/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.java

@@ -22,7 +22,7 @@
 
 /**
  * Implementation of an {@link AppCheckProviderFactory} that builds {@link
- * SafetyNetAppCheckProvider}s. This is the default implementation
+ * SafetyNetAppCheckProvider}s. This is the default implementation.
  */
 public class SafetyNetAppCheckProviderFactory implements AppCheckProviderFactory {
 
@@ -31,6 +31,10 @@ public class SafetyNetAppCheckProviderFactory implements AppCheckProviderFactory
 
   private SafetyNetAppCheckProviderFactory() {}
 
+  /**
+   * Gets an instance of this class for installation into a {@link
+   * com.google.firebase.appcheck.FirebaseAppCheck} instance.
+   */
   @NonNull
   public static SafetyNetAppCheckProviderFactory getInstance() {
     return instance;

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/AppCheckProvider.java

@@ -26,9 +26,8 @@
 public interface AppCheckProvider {
 
   /**
-   * Returns a {@link Task} which resolves to one of three things: (1) A valid {@link
-   * AppCheckToken}. (2) {@code null} in the event that a token is unavailable. (3) An {@link
-   * Exception} in the case that an unexpected failure occurred while getting the token.
+   * Returns a {@link Task} which resolves to a valid {@link AppCheckToken} or an {@link Exception}
+   * in the case that an unexpected failure occurred while getting the token.
    */
   @NonNull
   Task<AppCheckToken> getToken();

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/AppCheckProviderFactory.java

@@ -21,8 +21,8 @@
 public interface AppCheckProviderFactory {
 
   /**
-   * Gets the {@link AppCheckProvider} associated with the given FirebaseApp instance, or creates
-   * one if none already exists.
+   * Gets the {@link AppCheckProvider} associated with the given {@link FirebaseApp} instance, or
+   * creates one if none already exists.
    */
   @NonNull
   AppCheckProvider create(@NonNull FirebaseApp firebaseApp);

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/FirebaseAppCheck.java

@@ -22,14 +22,15 @@
 
 public abstract class FirebaseAppCheck implements InternalAppCheckTokenProvider {
 
-  /** Get the default instance of FirebaseAppCheck. */
+  /** Gets the default instance of {@code FirebaseAppCheck}. */
   @NonNull
   public static FirebaseAppCheck getInstance() {
     return getInstance(FirebaseApp.getInstance());
   }
 
   /**
-   * Get the instance of FirebaseAppCheck associated with the given {@link FirebaseApp} instance.
+   * Gets the instance of {@code FirebaseAppCheck} associated with the given {@link FirebaseApp}
+   * instance.
    */
   @NonNull
   public static FirebaseAppCheck getInstance(@NonNull FirebaseApp firebaseApp) {
@@ -38,9 +39,9 @@ public static FirebaseAppCheck getInstance(@NonNull FirebaseApp firebaseApp) {
 
   /**
    * Installs the given {@link AppCheckProviderFactory}, overwriting any that were previously
-   * associated with this FirebaseAppCheck instance. Any {@link AppCheckTokenListener}s attached to
-   * this FirebaseAppCheck instance will be transferred from existing factories to the newly
-   * installed one.
+   * associated with this {@code FirebaseAppCheck} instance. Any {@link AppCheckTokenListener}s
+   * attached to this {@code FirebaseAppCheck} instance will be transferred from existing factories
+   * to the newly installed one.
    *
    * <p>Automatic token refreshing will only occur if the global {@code
    * isDataCollectionDefaultEnabled} flag is set to true. To allow automatic token refreshing for
@@ -53,14 +54,14 @@ public static FirebaseAppCheck getInstance(@NonNull FirebaseApp firebaseApp) {
 
   /**
    * Installs the given {@link AppCheckProviderFactory}, overwriting any that were previously
-   * associated with this FirebaseAppCheck instance. Any {@link AppCheckTokenListener}s attached to
-   * this FirebaseAppCheck instance will be transferred from existing factories to the newly
-   * installed one.
+   * associated with this {@code FirebaseAppCheck} instance. Any {@link AppCheckTokenListener}s
+   * attached to this {@code FirebaseAppCheck} instance will be transferred from existing factories
+   * to the newly installed one.
    *
    * <p>Automatic token refreshing will only occur if the {@code isTokenAutoRefreshEnabled} field is
    * set to true. To use the global {@code isDataCollectionDefaultEnabled} flag for determining
-   * automatic token refreshing, {@link #installAppCheckProviderFactory(AppCheckProviderFactory)}
-   * should be called instead.
+   * automatic token refreshing, call {@link
+   * #installAppCheckProviderFactory(AppCheckProviderFactory)} instead.
    */
   @SuppressLint("FirebaseLambdaLast")
   public abstract void installAppCheckProviderFactory(

ci/fireci/fireciplugins/macrobenchmark.py

@@ -40,10 +40,11 @@ def macrobenchmark():
 async def _launch_macrobenchmark_test():
   _logger.info('Starting macrobenchmark test...')
 
-  artifact_versions, config, _ = await asyncio.gather(
+  artifact_versions, config, _, _ = await asyncio.gather(
     _parse_artifact_versions(),
     _parse_config_yaml(),
-    _create_gradle_wrapper()
+    _create_gradle_wrapper(),
+    _copy_google_services(),
   )
 
   with chdir('macrobenchmark'):
@@ -84,13 +85,21 @@ async def _create_gradle_wrapper():
     './gradlew',
     'wrapper',
     '--gradle-version',
-    '7.0',
+    '6.9',
     '--project-dir',
     'macrobenchmark'
   )
   await proc.wait()
 
 
+async def _copy_google_services():
+  if 'FIREBASE_CI' in os.environ:
+    src = os.environ['FIREBASE_GOOGLE_SERVICES_PATH']
+    dst = 'macrobenchmark/template/app/google-services.json'
+    _logger.info(f'Running on CI. Copying "{src}" to "{dst}"...')
+    shutil.copyfile(src, dst)
+
+
 class MacrobenchmarkTest:
   """Builds the test based on configurations and runs the test on FTL."""
   def __init__(
@@ -117,19 +126,7 @@ async def _create_test_src(self):
     app_id = self.test_app_config['application-id']
     self.logger.info(f'Creating test app "{app_name}" with application-id "{app_id}"...')
 
-    mustache_context = {
-      'application-id': app_id,
-      'plugins': self.test_app_config['plugins'] if 'plugins' in self.test_app_config else [],
-      'dependencies': [
-        {
-          'key': x,
-          'version': self.artifact_versions[x]
-        } for x in self.test_app_config['dependencies']
-      ] if 'dependencies' in self.test_app_config else [],
-    }
-
-    if app_name != 'baseline':
-      mustache_context['plugins'].append('com.google.gms.google-services')
+    mustache_context = await self._prepare_mustache_context()
 
     shutil.copytree('template', self.test_app_dir)
     with chdir(self.test_app_dir):
@@ -172,6 +169,33 @@ async def _upload_apks_to_ftl(self):
 
     await self._exec_subprocess(executable, args)
 
+  async def _prepare_mustache_context(self):
+    app_name = self.test_app_config['name']
+    app_id = self.test_app_config['application-id']
+
+    mustache_context = {
+      'application-id': app_id,
+      'plugins': [],
+      'dependencies': [],
+    }
+
+    if app_name != 'baseline':
+      mustache_context['plugins'].append('com.google.gms.google-services')
+
+    if 'plugins' in self.test_app_config:
+      mustache_context['plugins'].extend(self.test_app_config['plugins'])
+
+    if 'dependencies' in self.test_app_config:
+      for dep in self.test_app_config['dependencies']:
+        if '@' in dep:
+          key, version = dep.split('@', 1)
+          dependency = {'key': key, 'version': version}
+        else:
+          dependency = {'key': dep, 'version': self.artifact_versions[dep]}
+        mustache_context['dependencies'].append(dependency)
+
+    return mustache_context
+
   async def _exec_subprocess(self, executable, args):
     command = " ".join([executable, *args])
     self.logger.info(f'Executing command: "{command}"...')

firebase-crashlytics-ndk/README.md

@@ -11,9 +11,13 @@ Initialize them by running the following commands:
 
 ## Building
 
-All Gradle commands should be run from the root of this repository.
-
-`./gradlew :firebase-crashlytics-ndk:assemble`
+* `firebase-crashlytics-ndk` must be built with NDK 21. Use Android Studio's
+  SDK Manager to ensure you have the appropriate NDK version installed, and
+  edit `../local.properties` to specify which NDK version to use when building
+  this project. For example:
+  `ndk.dir=$USER_HOME/Library/Android/sdk/ndk/21.4.7075529`
+* All Gradle commands should be run from the root of this repository:
+  `./gradlew :firebase-crashlytics-ndk:assemble`
 
 ## Running Tests
 

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/FirebaseCrashlytics.java

@@ -349,8 +349,8 @@ public void setCustomKey(@NonNull String key, @NonNull String value) {
 
   /**
    * Sets multiple custom keys and values that are associated with subsequent fatal and non-fatal
-   * reports. This method is intended as an alternative to `setCustomKey` in order to reduce the
-   * computational load of writing out multiple key/value pairs at the same time.
+   * reports. This method is intended as an alternative to {@code setCustomKey} in order to reduce
+   * the computational load of writing out multiple key/value pairs at the same time.
    *
    * <p>Multiple calls to this method with the same key update the value for that key.
    *
@@ -425,10 +425,10 @@ public boolean didCrashOnPreviousExecution() {
    * disabled. Use {@link #deleteUnsentReports()} to delete any reports stored on the device without
    * sending them to Crashlytics.
    *
-   * @param enabled whether to enable automatic data collection. When set to `false`, the new value
-   *     does not apply until the next run of the app. To disable data collection by default for all
-   *     app runs, add the `firebase_crashlytics_collection_enabled` flag to your app's
-   *     AndroidManifest.xml.
+   * @param enabled whether to enable automatic data collection. When set to {@code false}, the new
+   *     value does not apply until the next run of the app. To disable data collection by default
+   *     for all app runs, add the {@code firebase_crashlytics_collection_enabled} flag to your
+   *     app's AndroidManifest.xml.
    */
   public void setCrashlyticsCollectionEnabled(boolean enabled) {
     core.setCrashlyticsCollectionEnabled(enabled);
@@ -438,19 +438,19 @@ public void setCrashlyticsCollectionEnabled(boolean enabled) {
    * Enables or disables the automatic data collection configuration for Crashlytics.
    *
    * <p>If this is set, it overrides any automatic data collection settings configured in the
-   * AndroidManifest.xml as well as any Firebase-wide settings. If set to `null`, the override is
-   * cleared.
+   * AndroidManifest.xml as well as any Firebase-wide settings. If set to {@code null}, the override
+   * is cleared.
    *
    * <p>If automatic data collection is disabled for Crashlytics, crash reports are stored on the
    * device. To check for reports, use the {@link #checkForUnsentReports()} method. Use {@link
    * #sendUnsentReports()} to upload existing reports even when automatic data collection is
    * disabled. Use {@link #deleteUnsentReports()} to delete any reports stored on the device without
    * sending them to Crashlytics.
    *
-   * @param enabled whether to enable or disable automatic data collection. When set to `false`, the
-   *     new value does not apply until the next run of the app. When set to `null`, the override is
-   *     cleared and automatic data collection settings are determined by the configuration in your
-   *     AndroidManifest.xml or other Firebase-wide settings.
+   * @param enabled whether to enable or disable automatic data collection. When set to {@code
+   *     false}, the new value does not apply until the next run of the app. When set to {@code
+   *     null}, the override is cleared and automatic data collection settings are determined by the
+   *     configuration in your AndroidManifest.xml or other Firebase-wide settings.
    */
   public void setCrashlyticsCollectionEnabled(@Nullable Boolean enabled) {
     core.setCrashlyticsCollectionEnabled(enabled);

macrobenchmark/config.yaml

@@ -44,6 +44,7 @@ firebase-inappmessaging-display:
   name: inappmessaging
   application-id: com.google.firebase.benchmark.inappmessaging
   dependencies:
+    - com.google.firebase:[email protected]
     - com.google.firebase:firebase-inappmessaging-ktx
     - com.google.firebase:firebase-inappmessaging-display-ktx