chrome/android/java/src/org/chromium/chrome/browser/tracing/TracingController.java - chromium/src - Git at Google

 // Copyright 2018 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 package org.chromium.chrome.browser.tracing;

 import android.content.Context;
 import android.content.Intent;
 import android.net.Uri;
 import android.support.annotation.IntDef;
 import android.text.TextUtils;

 import org.chromium.base.ContentUriUtils;
 import org.chromium.base.ContextUtils;
 import org.chromium.base.Log;
 import org.chromium.base.ObserverList;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.task.AsyncTask;
 import org.chromium.base.task.PostTask;
 import org.chromium.chrome.browser.preferences.developer.TracingPreferences;
 import org.chromium.content_public.browser.TracingControllerAndroid;
 import org.chromium.content_public.browser.UiThreadTaskTraits;
 import org.chromium.ui.widget.Toast;

 import java.io.File;
 import java.io.IOException;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.text.SimpleDateFormat;
 import java.util.Arrays;
 import java.util.Date;
 import java.util.HashSet;
 import java.util.Locale;
 import java.util.Set;
 import java.util.TimeZone;

 /**
  * Coordinates recording and saving/sharing Chrome performance traces.
  */
 public class TracingController {
     /**
      * Observer that is notified when the controller's tracing state changes.
      */
     public interface Observer {
         /**
          * Called by the TracingController when its state changes.
          *
          * @param state the new state of the Controller.
          */
         void onTracingStateChanged(@State int state);
     }

     /**
      * State of the controller. There can only be one active tracing session at the same time.
      */
     @IntDef({State.INITIALIZING, State.IDLE, State.STARTING, State.RECORDING, State.STOPPING,
             State.STOPPED})
     @Retention(RetentionPolicy.SOURCE)
     public @interface State {
         int INITIALIZING = 0;
         int IDLE = 1;
         int STARTING = 2;
         int RECORDING = 3;
         int STOPPING = 4;
         int STOPPED = 5;
     }

     private static final String TAG = "TracingController";
     private static final String TEMP_FILE_DIR = "/traces";
     private static final String TEMP_FILE_PREFIX = "chrome-trace-";
     private static final String TEMP_FILE_EXT = ".json.gz";
     private static final String TRACE_MIMETYPE = "application/gzip";

     // Delete shared trace files after 1 hour.
     private static final long DELETE_AFTER_SHARE_TIMEOUT_MILLIS = 60 * 60 * 1000;
     private static final long UPDATE_BUFFER_USAGE_INTERVAL_MILLIS = 1000;

     // Non-translated strings:
     private static final String MSG_ERROR_TOAST =
             "Error occurred while recording Chrome trace, see log for details.";
     private static final String MSG_SHARE = "Share trace";

     private static TracingController sInstance;

     // Only set while a trace is in progress to avoid leaking native resources.
     private TracingControllerAndroid mNativeController;

     private ObserverList<Observer> mObservers = new ObserverList<>();
     private @State int mState = State.INITIALIZING;
     private Set<String> mKnownCategories;
     private File mTracingTempFile;

     private TracingController() {
         // Check for old chrome-trace temp files and delete them.
         new DeleteOldTempFilesTask().executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
     }

     /**
      * @return the singleton instance of TracingController, creating and initializing it if needed.
      */
     public static TracingController getInstance() {
         if (sInstance == null) {
             sInstance = new TracingController();
             sInstance.initialize();
         }
         return sInstance;
     }

     /**
      * Query whether the TracingController instance has been created and initialized. Does not
      * create the controller instance if it has not been created yet.
      *
      * @return |true| if the controller was created and is initialized, |false| otherwise.
      */
     public static boolean isInitialized() {
         if (sInstance == null) return false;
         return getInstance().getState() != State.INITIALIZING;
     }

     private void initialize() {
         mNativeController = TracingControllerAndroid.create(ContextUtils.getApplicationContext());
         mNativeController.getKnownCategories(categories -> {
             mKnownCategories = new HashSet<>(Arrays.asList(categories));

             // Also cleans up the controller.
             setState(State.IDLE);
         });
     }

     /**
      * Add the given observer to the controller's observer list.
      *
      * @param obs the observer to add.
      */
     public void addObserver(Observer obs) {
         mObservers.addObserver(obs);
     }

     /**
      * Remove the given observer from the controller's observer list.
      *
      * @param obs the observer to add.
      */
     public void removeObserver(Observer obs) {
         mObservers.removeObserver(obs);
     }

     /**
      * @return the current state of the controller.
      */
     public @State int getState() {
         return mState;
     }

     /**
      * @return the temporary file that the trace is written into.
      */
     @VisibleForTesting
     public File getTracingTempFile() {
         return mTracingTempFile;
     }

     /**
      * Should only be called after the controller was initialized.
      * @see TracingController#getState()
      * @see Observer#onTracingStateChanged(int)
      *
      * @return the set of known tracing categories.
      */
     public Set<String> getKnownCategories() {
         assert mKnownCategories != null;
         return mKnownCategories;
     }

     /**
      * Starts recording a trace into a temporary file and shows a persistent tracing notification.
      * Should only be called when in IDLE state.
      */
     public void startRecording() {
         assert mState == State.IDLE;
         assert mNativeController == null;
         assert TracingNotificationManager.browserNotificationsEnabled();

         mNativeController = TracingControllerAndroid.create(ContextUtils.getApplicationContext());

         setState(State.STARTING);
         TracingNotificationManager.showTracingActiveNotification();

         new CreateTempFileAndStartTraceTask().executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
     }

     private class CreateTempFileAndStartTraceTask extends AsyncTask<File> {
         @Override
         protected File doInBackground() {
             File cacheDir =
                     new File(ContextUtils.getApplicationContext().getCacheDir() + TEMP_FILE_DIR);
             cacheDir.mkdir();
             File tracingTempFile;
             SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd-HHmmss", Locale.US);
             formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
             try {
                 tracingTempFile = new File(
                         cacheDir, TEMP_FILE_PREFIX + formatter.format(new Date()) + TEMP_FILE_EXT);
                 tracingTempFile.createNewFile();
             } catch (IOException e) {
                 Log.e(TAG, "Couldn't create chrome-trace temp file: %s", e.getMessage());
                 return null;
             }
             return tracingTempFile;
         }

         @Override
         protected void onPostExecute(File result) {
             if (result == null) {
                 showErrorToast();
                 setState(State.IDLE);
                 return;
             }
             mTracingTempFile = result;
             startNativeTrace();
         }
     }

     private void startNativeTrace() {
         assert mState == State.STARTING;

         // TODO(eseckler): TracingControllerAndroid currently doesn't support a json trace config.
         String categories = TextUtils.join(",", TracingPreferences.getEnabledCategories());
         String options = TracingPreferences.getSelectedTracingMode();

         if (!mNativeController.startTracing(
                     mTracingTempFile.getPath(), false, categories, options, true)) {
             Log.e(TAG, "Native error while trying to start tracing");
             showErrorToast();
             setState(State.IDLE);
             return;
         }

         setState(State.RECORDING);
         updateBufferUsage();
     }

     private void updateBufferUsage() {
         if (mState != State.RECORDING) return;

         mNativeController.getTraceBufferUsage(pair -> {
             if (mState != State.RECORDING) return;

             TracingNotificationManager.updateTracingActiveNotification(pair.first);

             PostTask.postDelayedTask(UiThreadTaskTraits.DEFAULT,
                     () -> { updateBufferUsage(); }, UPDATE_BUFFER_USAGE_INTERVAL_MILLIS);
         });
     }

     /**
      * Stops an active trace recording and updates the tracing notification with stopping status.
      * Should only be called when in RECORDING state.
      */
     public void stopRecording() {
         assert mState == State.RECORDING;

         setState(State.STOPPING);
         TracingNotificationManager.showTracingStoppingNotification();

         mNativeController.stopTracing((Void v) -> {
             assert mState == State.STOPPING;

             setState(State.STOPPED);
             TracingNotificationManager.showTracingCompleteNotification();
         });
     }

     /**
      * Discards a recorded trace and cleans up the temporary trace file.
      * Should only be called when in STOPPED state.
      */
     public void discardTrace() {
         assert mState == State.STOPPED;
         // Setting the state also cleans up the temp file.
         setState(State.IDLE);
     }

     /**
      * Share a recorded trace via an Android share intent.
      */
     public void shareTrace() {
         assert mState == State.STOPPED;

         Intent shareIntent = new Intent(Intent.ACTION_SEND);

         Uri fileUri = ContentUriUtils.getContentUriFromFile(mTracingTempFile);

         shareIntent.setType(TRACE_MIMETYPE);
         shareIntent.putExtra(Intent.EXTRA_STREAM, fileUri);
         shareIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);

         Context context = ContextUtils.getApplicationContext();
         Intent chooser = Intent.createChooser(shareIntent, MSG_SHARE);
         // We start this activity outside the main activity.
         chooser.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
         context.startActivity(chooser);

         // Delete the file after an hour. This won't work if the app quits in the meantime, so we
         // also check for old files when TraceController is created.
         File tracingTempFile = mTracingTempFile;
         PostTask.postDelayedTask(UiThreadTaskTraits.DEFAULT, () -> {
             new DeleteTempFileTask(tracingTempFile)
                     .executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
         }, DELETE_AFTER_SHARE_TIMEOUT_MILLIS);

         mTracingTempFile = null;
         setState(State.IDLE);
     }

     private void setState(@State int state) {
         Log.d(TAG, "State changing to %d", state);
         mState = state;
         if (mState == State.IDLE) {
             TracingNotificationManager.dismissNotification();
             if (mTracingTempFile != null) {
                 new DeleteTempFileTask(mTracingTempFile)
                         .executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
                 mTracingTempFile = null;
             }

             // Clean up the controller while idle to avoid leaking native resources.
             mNativeController.destroy();
             mNativeController = null;
         }
         for (Observer obs : mObservers) {
             obs.onTracingStateChanged(state);
         }
     }

     private class DeleteTempFileTask extends AsyncTask<Void> {
         private File mTracingTempFile;

         public DeleteTempFileTask(File tracingTempFile) {
             mTracingTempFile = tracingTempFile;
         }

         @Override
         protected Void doInBackground() {
             mTracingTempFile.delete();
             return null;
         }
     }

     private class DeleteOldTempFilesTask extends AsyncTask<Void> {
         @Override
         protected Void doInBackground() {
             File cacheDir =
                     new File(ContextUtils.getApplicationContext().getCacheDir() + TEMP_FILE_DIR);
             File[] files = cacheDir.listFiles();
             if (files != null) {
                 long maxTime = System.currentTimeMillis() - DELETE_AFTER_SHARE_TIMEOUT_MILLIS;
                 for (File f : files) {
                     if (f.lastModified() <= maxTime) {
                         f.delete();
                     }
                 }
             }
             return null;
         }
     }

     private void showErrorToast() {
         Context context = ContextUtils.getApplicationContext();
         Toast.makeText(context, MSG_ERROR_TOAST, Toast.LENGTH_SHORT).show();
     }
 }
	// Copyright 2018 The Chromium Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	package org.chromium.chrome.browser.tracing;

	import android.content.Context;
	import android.content.Intent;
	import android.net.Uri;
	import android.support.annotation.IntDef;
	import android.text.TextUtils;

	import org.chromium.base.ContentUriUtils;
	import org.chromium.base.ContextUtils;
	import org.chromium.base.Log;
	import org.chromium.base.ObserverList;
	import org.chromium.base.VisibleForTesting;
	import org.chromium.base.task.AsyncTask;
	import org.chromium.base.task.PostTask;
	import org.chromium.chrome.browser.preferences.developer.TracingPreferences;
	import org.chromium.content_public.browser.TracingControllerAndroid;
	import org.chromium.content_public.browser.UiThreadTaskTraits;
	import org.chromium.ui.widget.Toast;

	import java.io.File;
	import java.io.IOException;
	import java.lang.annotation.Retention;
	import java.lang.annotation.RetentionPolicy;
	import java.text.SimpleDateFormat;
	import java.util.Arrays;
	import java.util.Date;
	import java.util.HashSet;
	import java.util.Locale;
	import java.util.Set;
	import java.util.TimeZone;

	/**
	* Coordinates recording and saving/sharing Chrome performance traces.
	*/
	public class TracingController {
	/**
	* Observer that is notified when the controller's tracing state changes.
	*/
	public interface Observer {
	/**
	* Called by the TracingController when its state changes.
	*
	* @param state the new state of the Controller.
	*/
	void onTracingStateChanged(@State int state);
	}

	/**
	* State of the controller. There can only be one active tracing session at the same time.
	*/
	@IntDef({State.INITIALIZING, State.IDLE, State.STARTING, State.RECORDING, State.STOPPING,
	State.STOPPED})
	@Retention(RetentionPolicy.SOURCE)
	public @interface State {
	int INITIALIZING = 0;
	int IDLE = 1;
	int STARTING = 2;
	int RECORDING = 3;
	int STOPPING = 4;
	int STOPPED = 5;
	}

	private static final String TAG = "TracingController";
	private static final String TEMP_FILE_DIR = "/traces";
	private static final String TEMP_FILE_PREFIX = "chrome-trace-";
	private static final String TEMP_FILE_EXT = ".json.gz";
	private static final String TRACE_MIMETYPE = "application/gzip";

	// Delete shared trace files after 1 hour.
	private static final long DELETE_AFTER_SHARE_TIMEOUT_MILLIS = 60 * 60 * 1000;
	private static final long UPDATE_BUFFER_USAGE_INTERVAL_MILLIS = 1000;

	// Non-translated strings:
	private static final String MSG_ERROR_TOAST =
	"Error occurred while recording Chrome trace, see log for details.";
	private static final String MSG_SHARE = "Share trace";

	private static TracingController sInstance;

	// Only set while a trace is in progress to avoid leaking native resources.
	private TracingControllerAndroid mNativeController;

	private ObserverList<Observer> mObservers = new ObserverList<>();
	private @State int mState = State.INITIALIZING;
	private Set<String> mKnownCategories;
	private File mTracingTempFile;

	private TracingController() {
	// Check for old chrome-trace temp files and delete them.
	new DeleteOldTempFilesTask().executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
	}

	/**
	* @return the singleton instance of TracingController, creating and initializing it if needed.
	*/
	public static TracingController getInstance() {
	if (sInstance == null) {
	sInstance = new TracingController();
	sInstance.initialize();
	}
	return sInstance;
	}

	/**
	* Query whether the TracingController instance has been created and initialized. Does not
	* create the controller instance if it has not been created yet.
	*
	* @return \|true\| if the controller was created and is initialized, \|false\| otherwise.
	*/
	public static boolean isInitialized() {
	if (sInstance == null) return false;
	return getInstance().getState() != State.INITIALIZING;
	}

	private void initialize() {
	mNativeController = TracingControllerAndroid.create(ContextUtils.getApplicationContext());
	mNativeController.getKnownCategories(categories -> {
	mKnownCategories = new HashSet<>(Arrays.asList(categories));

	// Also cleans up the controller.
	setState(State.IDLE);
	});
	}

	/**
	* Add the given observer to the controller's observer list.
	*
	* @param obs the observer to add.
	*/
	public void addObserver(Observer obs) {
	mObservers.addObserver(obs);
	}

	/**
	* Remove the given observer from the controller's observer list.
	*
	* @param obs the observer to add.
	*/
	public void removeObserver(Observer obs) {
	mObservers.removeObserver(obs);
	}

	/**
	* @return the current state of the controller.
	*/
	public @State int getState() {
	return mState;
	}

	/**
	* @return the temporary file that the trace is written into.
	*/
	@VisibleForTesting
	public File getTracingTempFile() {
	return mTracingTempFile;
	}

	/**
	* Should only be called after the controller was initialized.
	* @see TracingController#getState()
	* @see Observer#onTracingStateChanged(int)
	*
	* @return the set of known tracing categories.
	*/
	public Set<String> getKnownCategories() {
	assert mKnownCategories != null;
	return mKnownCategories;
	}

	/**
	* Starts recording a trace into a temporary file and shows a persistent tracing notification.
	* Should only be called when in IDLE state.
	*/
	public void startRecording() {
	assert mState == State.IDLE;
	assert mNativeController == null;
	assert TracingNotificationManager.browserNotificationsEnabled();

	mNativeController = TracingControllerAndroid.create(ContextUtils.getApplicationContext());

	setState(State.STARTING);
	TracingNotificationManager.showTracingActiveNotification();

	new CreateTempFileAndStartTraceTask().executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
	}

	private class CreateTempFileAndStartTraceTask extends AsyncTask<File> {
	@Override
	protected File doInBackground() {
	File cacheDir =
	new File(ContextUtils.getApplicationContext().getCacheDir() + TEMP_FILE_DIR);
	cacheDir.mkdir();
	File tracingTempFile;
	SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd-HHmmss", Locale.US);
	formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
	try {
	tracingTempFile = new File(
	cacheDir, TEMP_FILE_PREFIX + formatter.format(new Date()) + TEMP_FILE_EXT);
	tracingTempFile.createNewFile();
	} catch (IOException e) {
	Log.e(TAG, "Couldn't create chrome-trace temp file: %s", e.getMessage());
	return null;
	}
	return tracingTempFile;
	}

	@Override
	protected void onPostExecute(File result) {
	if (result == null) {
	showErrorToast();
	setState(State.IDLE);
	return;
	}
	mTracingTempFile = result;
	startNativeTrace();
	}
	}

	private void startNativeTrace() {
	assert mState == State.STARTING;

	// TODO(eseckler): TracingControllerAndroid currently doesn't support a json trace config.
	String categories = TextUtils.join(",", TracingPreferences.getEnabledCategories());
	String options = TracingPreferences.getSelectedTracingMode();

	if (!mNativeController.startTracing(
	mTracingTempFile.getPath(), false, categories, options, true)) {
	Log.e(TAG, "Native error while trying to start tracing");
	showErrorToast();
	setState(State.IDLE);
	return;
	}

	setState(State.RECORDING);
	updateBufferUsage();
	}

	private void updateBufferUsage() {
	if (mState != State.RECORDING) return;

	mNativeController.getTraceBufferUsage(pair -> {
	if (mState != State.RECORDING) return;

	TracingNotificationManager.updateTracingActiveNotification(pair.first);

	PostTask.postDelayedTask(UiThreadTaskTraits.DEFAULT,
	() -> { updateBufferUsage(); }, UPDATE_BUFFER_USAGE_INTERVAL_MILLIS);
	});
	}

	/**
	* Stops an active trace recording and updates the tracing notification with stopping status.
	* Should only be called when in RECORDING state.
	*/
	public void stopRecording() {
	assert mState == State.RECORDING;

	setState(State.STOPPING);
	TracingNotificationManager.showTracingStoppingNotification();

	mNativeController.stopTracing((Void v) -> {
	assert mState == State.STOPPING;

	setState(State.STOPPED);
	TracingNotificationManager.showTracingCompleteNotification();
	});
	}

	/**
	* Discards a recorded trace and cleans up the temporary trace file.
	* Should only be called when in STOPPED state.
	*/
	public void discardTrace() {
	assert mState == State.STOPPED;
	// Setting the state also cleans up the temp file.
	setState(State.IDLE);
	}

	/**
	* Share a recorded trace via an Android share intent.
	*/
	public void shareTrace() {
	assert mState == State.STOPPED;

	Intent shareIntent = new Intent(Intent.ACTION_SEND);

	Uri fileUri = ContentUriUtils.getContentUriFromFile(mTracingTempFile);

	shareIntent.setType(TRACE_MIMETYPE);
	shareIntent.putExtra(Intent.EXTRA_STREAM, fileUri);
	shareIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);

	Context context = ContextUtils.getApplicationContext();
	Intent chooser = Intent.createChooser(shareIntent, MSG_SHARE);
	// We start this activity outside the main activity.
	chooser.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
	context.startActivity(chooser);

	// Delete the file after an hour. This won't work if the app quits in the meantime, so we
	// also check for old files when TraceController is created.
	File tracingTempFile = mTracingTempFile;
	PostTask.postDelayedTask(UiThreadTaskTraits.DEFAULT, () -> {
	new DeleteTempFileTask(tracingTempFile)
	.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
	}, DELETE_AFTER_SHARE_TIMEOUT_MILLIS);

	mTracingTempFile = null;
	setState(State.IDLE);
	}

	private void setState(@State int state) {
	Log.d(TAG, "State changing to %d", state);
	mState = state;
	if (mState == State.IDLE) {
	TracingNotificationManager.dismissNotification();
	if (mTracingTempFile != null) {
	new DeleteTempFileTask(mTracingTempFile)
	.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
	mTracingTempFile = null;
	}

	// Clean up the controller while idle to avoid leaking native resources.
	mNativeController.destroy();
	mNativeController = null;
	}
	for (Observer obs : mObservers) {
	obs.onTracingStateChanged(state);
	}
	}

	private class DeleteTempFileTask extends AsyncTask<Void> {
	private File mTracingTempFile;

	public DeleteTempFileTask(File tracingTempFile) {
	mTracingTempFile = tracingTempFile;
	}

	@Override
	protected Void doInBackground() {
	mTracingTempFile.delete();
	return null;
	}
	}

	private class DeleteOldTempFilesTask extends AsyncTask<Void> {
	@Override
	protected Void doInBackground() {
	File cacheDir =
	new File(ContextUtils.getApplicationContext().getCacheDir() + TEMP_FILE_DIR);
	File[] files = cacheDir.listFiles();
	if (files != null) {
	long maxTime = System.currentTimeMillis() - DELETE_AFTER_SHARE_TIMEOUT_MILLIS;
	for (File f : files) {
	if (f.lastModified() <= maxTime) {
	f.delete();
	}
	}
	}
	return null;
	}
	}

	private void showErrorToast() {
	Context context = ContextUtils.getApplicationContext();
	Toast.makeText(context, MSG_ERROR_TOAST, Toast.LENGTH_SHORT).show();
	}
	}