Merge 0ae206b into 1d344e8

Author: leotianlizhan

firebase-perf/dev-app/src/main/AndroidManifest.xml

@@ -38,6 +38,9 @@
         <meta-data
             android:name="fragment_sampling_percentage"
             android:value="100.0" />
+        <meta-data
+            android:name="experiment_app_start_ttid"
+            android:value="true" />
 
         <receiver
             android:name=".FirebasePerfTestReceiver"

firebase-perf/src/main/java/com/google/firebase/perf/config/ConfigResolver.java

@@ -23,6 +23,7 @@
 import com.google.firebase.perf.BuildConfig;
 import com.google.firebase.perf.config.ConfigurationConstants.CollectionDeactivated;
 import com.google.firebase.perf.config.ConfigurationConstants.CollectionEnabled;
+import com.google.firebase.perf.config.ConfigurationConstants.ExperimentTTID;
 import com.google.firebase.perf.config.ConfigurationConstants.FragmentSamplingRate;
 import com.google.firebase.perf.config.ConfigurationConstants.LogSourceName;
 import com.google.firebase.perf.config.ConfigurationConstants.NetworkEventCountBackground;
@@ -767,6 +768,38 @@ public float getFragmentSamplingRate() {
     return config.getDefault();
   }
 
+  /** Returns if _experiment_app_start_ttid should be captured. */
+  public boolean getIsExperimentTTIDEnabled() {
+    // Order of precedence is:
+    // 1. If the value exists in Android Manifest, return this value.
+    // 2. If the value exists through Firebase Remote Config, cache and return this value.
+    // 3. If the value exists in device cache, return this value.
+    // 4. Otherwise, return default value.
+    ExperimentTTID config = ExperimentTTID.getInstance();
+
+    // 1. Reads value in Android Manifest (it is set by developers during build time).
+    Optional<Boolean> metadataValue = getMetadataBoolean(config);
+    if (metadataValue.isAvailable()) {
+      return metadataValue.get();
+    }
+
+    // 2. Reads value from Firebase Remote Config, saves this value in cache layer if valid.
+    Optional<Boolean> rcValue = getRemoteConfigBoolean(config);
+    if (rcValue.isAvailable()) {
+      deviceCacheManager.setValue(config.getDeviceCacheFlag(), rcValue.get());
+      return rcValue.get();
+    }
+
+    // 3. Reads value from cache layer.
+    Optional<Boolean> deviceCacheValue = getDeviceCacheBoolean(config);
+    if (deviceCacheValue.isAvailable()) {
+      return deviceCacheValue.get();
+    }
+
+    // 4. Returns default value if there is no valid value from above approaches.
+    return config.getDefault();
+  }
+
   // endregion
 
   // Helper functions for interaction with Metadata layer.

firebase-perf/src/main/java/com/google/firebase/perf/config/ConfigurationConstants.java

@@ -661,4 +661,39 @@ protected String getMetadataFlag() {
       return "fragment_sampling_percentage";
     }
   }
+
+  protected static final class ExperimentTTID extends ConfigurationFlag<Boolean> {
+    private static ExperimentTTID instance;
+
+    private ExperimentTTID() {
+      super();
+    }
+
+    protected static synchronized ExperimentTTID getInstance() {
+      if (instance == null) {
+        instance = new ExperimentTTID();
+      }
+      return instance;
+    }
+
+    @Override
+    protected Boolean getDefault() {
+      return false;
+    }
+
+    @Override
+    protected String getRemoteConfigFlag() {
+      return "fpr_experiment_app_start_ttid";
+    }
+
+    @Override
+    protected String getDeviceCacheFlag() {
+      return "com.google.firebase.perf.ExperimentTTID";
+    }
+
+    @Override
+    protected String getMetadataFlag() {
+      return "experiment_app_start_ttid";
+    }
+  }
 }

firebase-perf/src/main/java/com/google/firebase/perf/config/RemoteConfigManager.java

@@ -14,6 +14,8 @@
 
 package com.google.firebase.perf.config;
 
+import static com.google.firebase.perf.config.ConfigurationConstants.ExperimentTTID;
+
 import android.content.Context;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager.NameNotFoundException;
@@ -53,6 +55,7 @@ public class RemoteConfigManager {
   private static final long MIN_APP_START_CONFIG_FETCH_DELAY_MS = 5000;
   private static final int RANDOM_APP_START_CONFIG_FETCH_DELAY_MS = 25000;
 
+  private final DeviceCacheManager cache;
   private final ConcurrentHashMap<String, FirebaseRemoteConfigValue> allRcConfigMap;
   private final Executor executor;
   private final long appStartTimeInMs;
@@ -65,29 +68,25 @@ public class RemoteConfigManager {
 
   private RemoteConfigManager() {
     this(
+        DeviceCacheManager.getInstance(),
         new ThreadPoolExecutor(
             /* corePoolSize= */ 0,
             /* maximumPoolSize= */ 1,
             /* keepAliveTime= */ 0L,
             TimeUnit.SECONDS,
             new LinkedBlockingQueue<Runnable>()),
-        /* firebaseRemoteConfig= */ null // set once FirebaseRemoteConfig is initialized
-        );
-  }
-
-  RemoteConfigManager(Executor executor, FirebaseRemoteConfig firebaseRemoteConfig) {
-    this(
-        executor,
-        firebaseRemoteConfig,
+        /* firebaseRemoteConfig= */ null, // set once FirebaseRemoteConfig is initialized
         MIN_APP_START_CONFIG_FETCH_DELAY_MS
             + new Random().nextInt(RANDOM_APP_START_CONFIG_FETCH_DELAY_MS));
   }
 
   @VisibleForTesting
   RemoteConfigManager(
+      DeviceCacheManager cache,
       Executor executor,
       FirebaseRemoteConfig firebaseRemoteConfig,
       long appStartConfigFetchDelayInMs) {
+    this.cache = cache;
     this.executor = executor;
     this.firebaseRemoteConfig = firebaseRemoteConfig;
     this.allRcConfigMap =
@@ -315,7 +314,7 @@ private void triggerRemoteConfigFetchIfNecessary() {
       return;
     }
     if (allRcConfigMap.isEmpty()) { // Initial fetch.
-      syncConfigValues(firebaseRemoteConfig.getAll());
+      allRcConfigMap.putAll(firebaseRemoteConfig.getAll());
     }
     if (shouldFetchAndActivateRemoteConfigValues()) {
       triggerFirebaseRemoteConfigFetchAndActivateOnSuccessfulFetch();
@@ -342,6 +341,21 @@ protected void syncConfigValues(Map<String, FirebaseRemoteConfigValue> newlyFetc
         allRcConfigMap.remove(existingKey);
       }
     }
+
+    // TODO: remove after experiment is over and experiment RC flag is no longer needed
+    // Save ExperimentTTID flag to device cache upon successful RC fetchAndActivate, because reading
+    // is done quite early and it is possible that RC isn't initialized yet.
+    ExperimentTTID flag = ExperimentTTID.getInstance();
+    FirebaseRemoteConfigValue rcValue = allRcConfigMap.get(flag.getRemoteConfigFlag());
+    if (rcValue != null) {
+      try {
+        cache.setValue(flag.getDeviceCacheFlag(), rcValue.asBoolean());
+      } catch (Exception exception) {
+        logger.debug("ExperimentTTID remote config flag has invalid value, expected boolean.");
+      }
+    } else {
+      logger.debug("ExperimentTTID remote config flag does not exist.");
+    }
   }
 
   @VisibleForTesting

firebase-perf/src/main/java/com/google/firebase/perf/metrics/AppStartTrace.java

@@ -18,18 +18,23 @@
 import android.app.Application;
 import android.app.Application.ActivityLifecycleCallbacks;
 import android.content.Context;
+import android.os.Build;
 import android.os.Bundle;
+import android.os.Process;
+import android.view.View;
 import androidx.annotation.Keep;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.android.gms.common.util.VisibleForTesting;
+import com.google.firebase.perf.config.ConfigResolver;
 import com.google.firebase.perf.logging.AndroidLogger;
 import com.google.firebase.perf.provider.FirebasePerfProvider;
 import com.google.firebase.perf.session.PerfSession;
 import com.google.firebase.perf.session.SessionManager;
 import com.google.firebase.perf.transport.TransportManager;
 import com.google.firebase.perf.util.Clock;
 import com.google.firebase.perf.util.Constants;
+import com.google.firebase.perf.util.FirstDrawDoneListener;
 import com.google.firebase.perf.util.Timer;
 import com.google.firebase.perf.v1.ApplicationProcessState;
 import com.google.firebase.perf.v1.TraceMetric;
@@ -69,6 +74,7 @@ public class AppStartTrace implements ActivityLifecycleCallbacks {
   private boolean isRegisteredForLifecycleCallbacks = false;
   private final TransportManager transportManager;
   private final Clock clock;
+  private final ConfigResolver configResolver;
   private Context appContext;
   /**
    * The first time onCreate() of any activity is called, the activity is saved as launchActivity.
@@ -89,6 +95,7 @@ public class AppStartTrace implements ActivityLifecycleCallbacks {
   private Timer onCreateTime = null;
   private Timer onStartTime = null;
   private Timer onResumeTime = null;
+  private Timer firstDrawDone = null;
 
   private PerfSession startSession;
   private boolean isStartedFromBackground = false;
@@ -134,12 +141,13 @@ static AppStartTrace getInstance(TransportManager transportManager, Clock clock)
               new AppStartTrace(
                   transportManager,
                   clock,
+                  ConfigResolver.getInstance(),
                   new ThreadPoolExecutor(
                       CORE_POOL_SIZE,
                       MAX_POOL_SIZE,
                       /* keepAliveTime= */ MAX_LATENCY_BEFORE_UI_INIT + 10,
                       TimeUnit.SECONDS,
-                      new LinkedBlockingQueue<>(1)));
+                      new LinkedBlockingQueue<>()));
         }
       }
     }
@@ -149,9 +157,11 @@ static AppStartTrace getInstance(TransportManager transportManager, Clock clock)
   AppStartTrace(
       @NonNull TransportManager transportManager,
       @NonNull Clock clock,
+      @NonNull ConfigResolver configResolver,
       @NonNull ExecutorService executorService) {
     this.transportManager = transportManager;
     this.clock = clock;
+    this.configResolver = configResolver;
     this.executorService = executorService;
   }
 
@@ -178,6 +188,33 @@ public synchronized void unregisterActivityLifecycleCallbacks() {
     isRegisteredForLifecycleCallbacks = false;
   }
 
+  /**
+   * Gets the timetamp that marks the beginning of app start, currently defined as the beginning of
+   * BIND_APPLICATION. Fallback to class-load time of {@link FirebasePerfProvider} when API < 24.
+   *
+   * @return {@link Timer} at the beginning of app start by Fireperf definition.
+   */
+  private static Timer getStartTimer() {
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
+      return Timer.ofElapsedRealtime(Process.getStartElapsedRealtime());
+    }
+    return FirebasePerfProvider.getAppStartTime();
+  }
+
+  private void recordFirstDrawDone() {
+    if (firstDrawDone != null) {
+      return;
+    }
+    this.firstDrawDone = clock.getTime();
+    executorService.execute(
+        () -> this.logColdStart(getStartTimer(), this.firstDrawDone, this.startSession));
+
+    if (isRegisteredForLifecycleCallbacks) {
+      // After AppStart trace is queued to be logged, we can unregister this callback.
+      unregisterActivityLifecycleCallbacks();
+    }
+  }
+
   @Override
   public synchronized void onActivityCreated(Activity activity, Bundle savedInstanceState) {
     if (isStartedFromBackground || onCreateTime != null // An activity already called onCreate()
@@ -206,9 +243,18 @@ public synchronized void onActivityStarted(Activity activity) {
 
   @Override
   public synchronized void onActivityResumed(Activity activity) {
-    if (isStartedFromBackground
-        || onResumeTime != null // An activity already called onResume()
-        || isTooLateToInitUI) {
+    if (isStartedFromBackground || isTooLateToInitUI) {
+      return;
+    }
+
+    // Shadow-launch experiment of new app start time
+    final boolean isExperimentTTIDEnabled = configResolver.getIsExperimentTTIDEnabled();
+    if (isExperimentTTIDEnabled) {
+      View rootView = activity.findViewById(android.R.id.content);
+      FirstDrawDoneListener.registerForNextDraw(rootView, this::recordFirstDrawDone);
+    }
+
+    if (onResumeTime != null) { // An activity already called onResume()
       return;
     }
 
@@ -228,12 +274,30 @@ public synchronized void onActivityResumed(Activity activity) {
     // Log the app start trace in a non-main thread.
     executorService.execute(this::logAppStartTrace);
 
-    if (isRegisteredForLifecycleCallbacks) {
+    if (!isExperimentTTIDEnabled && isRegisteredForLifecycleCallbacks) {
       // After AppStart trace is logged, we can unregister this callback.
       unregisterActivityLifecycleCallbacks();
     }
   }
 
+  private void logColdStart(Timer start, Timer end, PerfSession session) {
+    TraceMetric.Builder metric =
+        TraceMetric.newBuilder()
+            .setName("_experiment_app_start_ttid")
+            .setClientStartTimeUs(start.getMicros())
+            .setDurationUs(start.getDurationMicros(end));
+
+    TraceMetric.Builder subtrace =
+        TraceMetric.newBuilder()
+            .setName("_experiment_classLoadTime")
+            .setClientStartTimeUs(FirebasePerfProvider.getAppStartTime().getMicros())
+            .setDurationUs(FirebasePerfProvider.getAppStartTime().getDurationMicros(end));
+
+    metric.addSubtraces(subtrace).addPerfSessions(this.startSession.build());
+
+    transportManager.log(metric.build(), ApplicationProcessState.FOREGROUND_BACKGROUND);
+  }
+
   private void logAppStartTrace() {
     TraceMetric.Builder metric =
         TraceMetric.newBuilder()