Merge pull request #78 from pavan142/performanceAnalytics

Added Performance Analytics

Author: pavan142

app/build.gradle

@@ -4,15 +4,16 @@ apply plugin: 'kotlin-android'
 // crash analytics
 apply plugin: 'com.google.gms.google-services'
 apply plugin: 'com.google.firebase.crashlytics'
+apply plugin: 'com.google.firebase.firebase-perf'
 
 android {
     compileSdkVersion 29
     defaultConfig {
         applicationId "com.frankenstein.screenx"
         minSdkVersion 21
         targetSdkVersion 29
-        versionCode 8
-        versionName "1.5.1"
+        versionCode 9
+        versionName "1.5.2-perf-baseline"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
     buildTypes {
@@ -78,6 +79,7 @@ dependencies {
     implementation platform('com.google.firebase:firebase-bom:26.7.0')
     implementation 'com.google.firebase:firebase-analytics'
     implementation 'com.google.firebase:firebase-crashlytics'
+    implementation 'com.google.firebase:firebase-perf'
 
     annotationProcessor 'com.github.bumptech.glide:compiler:4.11.0'
     testImplementation 'junit:junit:4.12'

app/src/main/AndroidManifest.xml

@@ -21,6 +21,9 @@
         <meta-data
             android:name="com.google.mlkit.vision.DEPENDENCIES"
             android:value="ocr" />
+        <meta-data
+            android:name="firebase_performance_logcat_enabled"
+            android:value="true" />
         <activity
             android:name="com.frankenstein.screenx.MainActivity"
             android:label="@string/app_name"

app/src/main/java/com/frankenstein/screenx/ScreenFactory.java

@@ -16,10 +16,10 @@
 
 import com.frankenstein.screenx.helper.Logger;
 import com.frankenstein.screenx.helper.PermissionHelper;
-import com.frankenstein.screenx.helper.TimeLogger;
 import com.frankenstein.screenx.models.AppGroup;
 import com.frankenstein.screenx.models.Screenshot;
 import com.frankenstein.screenx.multithreading.GetScreensAsyncTask;
+import com.google.firebase.perf.metrics.AddTrace;
 
 import androidx.lifecycle.MutableLiveData;
 
@@ -38,7 +38,6 @@ public class ScreenFactory {
 
     private boolean _initialized = false;
     private final Logger _logger = Logger.getInstance("ScreenFactory");
-    private static final Logger _mTimeLogger = TimeLogger.getInstance();
     private boolean _monitoring = false;
     private Handler _monitorHandler;
     private Handler _mainHandler;
@@ -66,9 +65,8 @@ private ScreenFactory(Context context) {
         startMonitor();
     }
 
+    @AddTrace(name = "analyze_all_screens")
     public void analyzeScreens(ArrayList<Screenshot> screens) {
-        Long start = System.currentTimeMillis();
-        _logger.log("Analyzing screens", Thread.currentThread().toString());
         ArrayList<Screenshot> newScreenshots = new ArrayList<>();
         for (AppGroup ag: appgroups.values())
             ag.screenshots.clear();
@@ -79,8 +77,6 @@ public void analyzeScreens(ArrayList<Screenshot> screens) {
                 newScreenshots.add(screen);
             }
             sort();
-            Long end = System.currentTimeMillis();
-            _mTimeLogger.log("Posting Screenshots value to livedata on UI Thread, Time taken for analyze Screens is", (end-start));
             screenshots.postValue(newScreenshots);
         } catch (Exception e) {
             _logger.log("got an error: ", e.getMessage());

app/src/main/java/com/frankenstein/screenx/SearchActivity.java

@@ -10,6 +10,8 @@
 
 import com.frankenstein.screenx.helper.Logger;
 import com.frankenstein.screenx.models.Screenshot;
+import com.google.firebase.perf.FirebasePerformance;
+import com.google.firebase.perf.metrics.Trace;
 
 import java.util.ArrayList;
 
@@ -24,6 +26,7 @@ public class SearchActivity extends MultipleSelectActivity {
     private LiveData<ArrayList<String>> _mLiveMatches = new LiveData<ArrayList<String>>() {};
     private ArrayList<String> _mMatches;
     private ImageButton _mClearSearch;
+    private Trace _mSearchTrace;
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
@@ -35,19 +38,18 @@ public void onCreate(Bundle savedInstanceState) {
             @Override
             public void beforeTextChanged(CharSequence s, int start, int count, int after) {
                 _mLiveMatches.removeObservers(SearchActivity.this);
-                _mLogger.log("beforeTextChagned", s, start, count, after);
             }
 
             @Override
             public void onTextChanged(CharSequence s, int start, int before, int count) {
-                _mLogger.log("onTextChagned", s, start, before, count);
+                _mSearchTrace = FirebasePerformance.getInstance().newTrace("search_time");
+                _mSearchTrace.start();
                 _mLiveMatches = ScreenXApplication.textHelper.searchScreenshots(s.toString());
                 checkAndToggleClear(count);
             }
 
             @Override
             public void afterTextChanged(Editable s) {
-                _mLogger.log("afterTextChagned", s.toString());
                 _mLiveMatches.observe(SearchActivity.this, SearchActivity.this::onLiveMatches);
             }
         });
@@ -66,6 +68,7 @@ public void checkAndToggleClear(int count) {
     }
 
     public void onLiveMatches(ArrayList<String> matches) {
+        _mSearchTrace.stop();
         _mLogger.log("number of matches", matches.size());
         updateAdapter(matches);
     }

app/src/main/java/com/frankenstein/screenx/helper/AppHelper.java

@@ -9,6 +9,7 @@
 import com.frankenstein.screenx.interfaces.TimeSortable;
 import com.frankenstein.screenx.models.Screenshot;
 import com.frankenstein.screenx.helper.UsageStatsHelper.Companion.*;
+import com.google.firebase.perf.metrics.AddTrace;
 
 import java.io.File;
 import java.util.ArrayList;
@@ -121,6 +122,7 @@ private static String getSourceApp(Context context, String filename) {
         return appName;
     }
 
+    @AddTrace(name="label_all_screens")
     public static ArrayList<Screenshot> LabelMultipleScreens(ArrayList<Screenshot> screens, Context context, ArrayList<File> files) {
         ArrayList <Screenshot> newlyLabelledScreens = new ArrayList<>();
         ArrayList <Screenshot> systemScreens = new ArrayList<>();

app/src/main/java/com/frankenstein/screenx/helper/FileHelper.java

@@ -3,6 +3,7 @@
 import android.os.Environment;
 
 import com.frankenstein.screenx.models.Screenshot;
+import com.google.firebase.perf.metrics.AddTrace;
 
 import java.io.File;
 import java.util.ArrayList;
@@ -51,6 +52,7 @@ public static void createIfNot(File dir) {
         }
     }
 
+    @AddTrace(name = "files_get_all")
     public static ArrayList<File> getAllScreenshotFiles() {
         _mLogger.log("Permissions for File Read", SYSTEM_SCREENSHOT_DIR1.canRead(), SYSTEM_SCREENSHOT_DIR2.canRead(), CUSTOM_SCREENSHOT_DIR.canRead());
 

app/src/main/java/com/frankenstein/screenx/helper/TextHelper.java

@@ -14,6 +14,7 @@
 import com.google.android.gms.tasks.OnFailureListener;
 import com.google.android.gms.tasks.OnSuccessListener;
 import com.google.android.gms.tasks.Task;
+import com.google.firebase.perf.metrics.AddTrace;
 import com.google.mlkit.vision.common.InputImage;
 import com.google.mlkit.vision.text.Text;
 import com.google.mlkit.vision.text.TextRecognition;
@@ -153,6 +154,7 @@ public String textByFilenameDB(String filename) {
     }
 
     // TO BE INVOKED ONLY ON A BACKGROUND THREAD
+    @AddTrace(name = "db_get_all_screens")
     public List<ScreenShotEntity> getAllScreenshotsInDatabase() {
         if (Looper.myLooper() == Looper.getMainLooper()) {
             _mLogger.log("This operation is not supported on main thread");

app/src/main/java/com/frankenstein/screenx/multithreading/GetScreensAsyncTask.java

@@ -9,6 +9,7 @@
 import com.frankenstein.screenx.helper.Logger;
 import com.frankenstein.screenx.helper.TimeLogger;
 import com.frankenstein.screenx.models.Screenshot;
+import com.google.firebase.perf.metrics.AddTrace;
 
 import java.io.File;
 import java.util.ArrayList;
@@ -22,25 +23,21 @@
 public class GetScreensAsyncTask extends AsyncTask<Object, Void, ArrayList<Screenshot>> {
 
     private Logger _mLogger = Logger.getInstance("GetScreensAsyncTask");;
-    private static final Logger _mTimeLogger = TimeLogger.getInstance();
 
     public GetScreensAsyncTask() {
         super();
     }
 
     @Override
     protected ArrayList<Screenshot> doInBackground(Object ...objects) {
-        Long start = System.currentTimeMillis();
-        _mTimeLogger.log("GetScreensAsyncTask: doInBackground");
+        _mLogger.log("GetScreensAsyncTask: doInBackground");
         final Context context = (Context) objects[0];
         ArrayList<Screenshot> screens = new ArrayList<>();
         try {
             ArrayList<File> files = getAllScreenshotFiles();
-            _mTimeLogger.d("Scanned all screenshot files");
 
             List<ScreenShotEntity> existingEntities = ScreenXApplication.textHelper.getAllScreenshotsInDatabase();
             Map<String, ScreenShotEntity> existingEntitiesMap = new HashMap<>();
-            _mTimeLogger.d("Fetched all the existing screenshots from database");
             for (ScreenShotEntity entity: existingEntities)
                 existingEntitiesMap.put(entity.filename, entity);
 
@@ -55,15 +52,12 @@ protected ArrayList<Screenshot> doInBackground(Object ...objects) {
                     screens.add(newSreen);
                 }
             }
-            _mTimeLogger.d("Sending unlabelled screens for labelling");
 
             ArrayList<Screenshot> newlyLabelledscreens = LabelMultipleScreens(screens, context, filesToBeLabeled);
-            _mTimeLogger.d("Finished labelling", Thread.currentThread().toString());
             Long end = System.currentTimeMillis();
-            _mTimeLogger.log("Total Screens", screens.size(), "Existing Screens",
+            _mLogger.log("Total Screens", screens.size(), "Existing Screens",
                     screens.size() - newlyLabelledscreens.size(),
                     "Newly Labelled Screens", newlyLabelledscreens.size());
-            _mTimeLogger.log("Time taken for processing screenshot files in background =", (end-start));
             ScreenXApplication.screenFactory.analyzeScreens(screens);
             ScreenXApplication.textHelper.updateAppNames(newlyLabelledscreens);
         } catch (Exception e) {

build.gradle

@@ -16,6 +16,7 @@ buildscript {
         // for analytics
         classpath 'com.google.gms:google-services:4.3.5'
         classpath 'com.google.firebase:firebase-crashlytics-gradle:2.5.1'
+        classpath 'com.google.firebase:perf-plugin:1.3.5'
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }