log _experiment_as_ttid

Author: leotianlizhan

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

@@ -24,6 +24,7 @@
 import com.google.firebase.perf.config.ConfigurationConstants.CollectionDeactivated;
 import com.google.firebase.perf.config.ConfigurationConstants.CollectionEnabled;
 import com.google.firebase.perf.config.ConfigurationConstants.FragmentSamplingRate;
+import com.google.firebase.perf.config.ConfigurationConstants.ExperimentTTID;
 import com.google.firebase.perf.config.ConfigurationConstants.LogSourceName;
 import com.google.firebase.perf.config.ConfigurationConstants.NetworkEventCountBackground;
 import com.google.firebase.perf.config.ConfigurationConstants.NetworkEventCountForeground;
@@ -767,6 +768,38 @@ public float getFragmentSamplingRate() {
     return config.getDefault();
   }
 
+  /** Returns if _experiment_as_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_as_ttid";
+    }
+
+    @Override
+    protected String getDeviceCacheFlag() {
+      return "com.google.firebase.perf.ExperimentTTID";
+    }
+
+    @Override
+    protected String getMetadataFlag() {
+      return "experiment_as_ttid";
+    }
+  }
 }

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

@@ -18,23 +18,31 @@
 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;
 import java.lang.ref.WeakReference;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.LinkedBlockingQueue;
@@ -89,6 +97,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;
@@ -139,7 +148,7 @@ static AppStartTrace getInstance(TransportManager transportManager, Clock clock)
                       MAX_POOL_SIZE,
                       /* keepAliveTime= */ MAX_LATENCY_BEFORE_UI_INIT + 10,
                       TimeUnit.SECONDS,
-                      new LinkedBlockingQueue<>(1)));
+                      new LinkedBlockingQueue<>()));
         }
       }
     }
@@ -178,6 +187,32 @@ 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()
@@ -207,11 +242,20 @@ public synchronized void onActivityStarted(Activity activity) {
   @Override
   public synchronized void onActivityResumed(Activity activity) {
     if (isStartedFromBackground
-        || onResumeTime != null // An activity already called onResume()
         || isTooLateToInitUI) {
       return;
     }
 
+    // Shadow-launch experiment of new app start time
+    if (ConfigResolver.getInstance().getIsExperimentTTIDEnabled()) {
+      View rootView = activity.findViewById(android.R.id.content);
+      FirstDrawDoneListener.registerForNextDraw(rootView, this::recordFirstDrawDone);
+    }
+
+    if (onResumeTime != null) { // An activity already called onResume()
+      return;
+    }
+
     appStartActivity = new WeakReference<Activity>(activity);
 
     onResumeTime = clock.getTime();
@@ -227,11 +271,24 @@ public synchronized void onActivityResumed(Activity activity) {
 
     // Log the app start trace in a non-main thread.
     executorService.execute(this::logAppStartTrace);
+  }
 
-    if (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_as_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() {