Merge changes from topics "ww_4_delete_data", "ww_3_checkconfig", "ww_2_uploadIntent", "ww_1_receiver"

* changes:
  Add JobService to delete obsolete anomaly data
  Add code to handle anomaly config update
  Add AnomalyConfigReceiver
  Add AnomalyDetectionReceiver
This commit is contained in:
Lei Yu
2018-02-22 20:27:00 +00:00
committed by Android (Google) Code Review
9 changed files with 373 additions and 2 deletions

View File

@@ -3294,6 +3294,21 @@
</intent-filter>
</receiver>
<!-- Couldn't be triggered from outside of settings. Statsd can trigger it because we send
PendingIntent to it-->
<receiver android:name=".fuelgauge.batterytip.AnomalyDetectionReceiver"
android:exported="false" />
<receiver android:name=".fuelgauge.batterytip.AnomalyConfigReceiver">
<intent-filter>
<action android:name="android.app.action.STATSD_STARTED"/>
<action android:name="android.intent.action.BOOT_COMPLETED"/>
</intent-filter>
</receiver>
<service android:name=".fuelgauge.batterytip.AnomalyCleanUpJobService"
android:permission="android.permission.BIND_JOB_SERVICE" />
<!-- This is the longest AndroidManifest.xml ever. -->
</application>
</manifest>

View File

@@ -18,6 +18,7 @@
-->
<resources>
<item type="id" name="preference_highlighted" />
<item type="id" name="job_anomaly_clean_up" />
<item type="id" name="lock_none" />
<item type="id" name="lock_pin" />

View File

@@ -0,0 +1,75 @@
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.fuelgauge.batterytip;
import android.app.job.JobInfo;
import android.app.job.JobParameters;
import android.app.job.JobScheduler;
import android.app.job.JobService;
import android.content.ComponentName;
import android.content.Context;
import android.os.AsyncTask;
import android.support.annotation.VisibleForTesting;
import android.util.Log;
import com.android.settings.R;
import com.android.settingslib.utils.ThreadUtils;
import java.util.concurrent.TimeUnit;
/** A JobService to clean up obsolete data in anomaly database */
public class AnomalyCleanUpJobService extends JobService {
private static final String TAG = "AnomalyCleanUpJobService";
@VisibleForTesting
static final long CLEAN_UP_FREQUENCY_MS = TimeUnit.DAYS.toMillis(1);
public static void scheduleCleanUp(Context context) {
final JobScheduler jobScheduler = context.getSystemService(JobScheduler.class);
final ComponentName component = new ComponentName(context, AnomalyCleanUpJobService.class);
final JobInfo.Builder jobBuilder =
new JobInfo.Builder(R.id.job_anomaly_clean_up, component)
.setMinimumLatency(CLEAN_UP_FREQUENCY_MS)
.setRequiresDeviceIdle(true)
.setPersisted(true);
if (jobScheduler.schedule(jobBuilder.build()) != JobScheduler.RESULT_SUCCESS) {
Log.i(TAG, "Anomaly clean up job service schedule failed.");
}
}
@Override
public boolean onStartJob(JobParameters params) {
final BatteryDatabaseManager batteryDatabaseManager = BatteryDatabaseManager
.getInstance(this);
final BatteryTipPolicy policy = new BatteryTipPolicy(this);
ThreadUtils.postOnBackgroundThread(() -> {
batteryDatabaseManager.deleteAllAnomaliesBeforeTimeStamp(
System.currentTimeMillis() - TimeUnit.HOURS.toMillis(
policy.dataHistoryRetainHour));
jobFinished(params, false /* wantsReschedule */);
});
return true;
}
@Override
public boolean onStopJob(JobParameters jobParameters) {
return true;
}
}

View File

@@ -0,0 +1,94 @@
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.fuelgauge.batterytip;
import android.app.PendingIntent;
import android.app.StatsManager;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.SharedPreferences;
import android.provider.Settings;
import android.util.Base64;
import android.util.Log;
import com.android.internal.annotations.VisibleForTesting;
/**
* Receive broadcast when {@link StatsManager} restart, then check the anomaly config and
* prepare info for {@link StatsManager}
*/
public class AnomalyConfigReceiver extends BroadcastReceiver {
private static final String TAG = "AnomalyConfigReceiver";
private static final int REQUEST_CODE = 0;
private static final String PREF_DB = "anomaly_pref";
private static final String KEY_ANOMALY_CONFIG_VERSION = "anomaly_config_version";
private static final int DEFAULT_VERSION = 0;
@Override
public void onReceive(Context context, Intent intent) {
if (StatsManager.ACTION_STATSD_STARTED.equals(intent.getAction())
|| Intent.ACTION_BOOT_COMPLETED.equals(intent.getAction())) {
final StatsManager statsManager = context.getSystemService(StatsManager.class);
// Check whether to update the config
checkAnomalyConfig(context, statsManager);
// Upload PendingIntent to StatsManager
final Intent extraIntent = new Intent(context, AnomalyDetectionReceiver.class);
final PendingIntent pendingIntent = PendingIntent.getBroadcast(context, REQUEST_CODE,
extraIntent, PendingIntent.FLAG_UPDATE_CURRENT);
uploadPendingIntent(statsManager, pendingIntent);
}
}
@VisibleForTesting
void uploadPendingIntent(StatsManager statsManager, PendingIntent pendingIntent) {
Log.i(TAG, "Upload PendingIntent to StatsManager. configKey: "
+ StatsManagerConfig.ANOMALY_CONFIG_KEY + " subId: "
+ StatsManagerConfig.SUBSCRIBER_ID);
statsManager.setBroadcastSubscriber(StatsManagerConfig.ANOMALY_CONFIG_KEY,
StatsManagerConfig.SUBSCRIBER_ID, pendingIntent);
}
private void checkAnomalyConfig(Context context, StatsManager statsManager) {
final SharedPreferences sharedPreferences = context.getSharedPreferences(PREF_DB,
Context.MODE_PRIVATE);
final int currentVersion = sharedPreferences.getInt(KEY_ANOMALY_CONFIG_VERSION,
DEFAULT_VERSION);
final int newVersion = Settings.Global.getInt(context.getContentResolver(),
Settings.Global.ANOMALY_CONFIG_VERSION, DEFAULT_VERSION);
Log.i(TAG, "CurrentVersion: " + currentVersion + " new version: " + newVersion);
if (newVersion > currentVersion) {
final byte[] config = Base64.decode(
Settings.Global.getString(context.getContentResolver(),
Settings.Global.ANOMALY_CONFIG), Base64.DEFAULT);
if (statsManager.addConfiguration(StatsManagerConfig.ANOMALY_CONFIG_KEY, config)) {
Log.i(TAG, "Upload the anomaly config. configKey: "
+ StatsManagerConfig.ANOMALY_CONFIG_KEY);
SharedPreferences.Editor editor = sharedPreferences.edit();
editor.putInt(KEY_ANOMALY_CONFIG_VERSION, newVersion);
editor.apply();
} else {
Log.i(TAG, "Upload the anomaly config failed. configKey: "
+ StatsManagerConfig.ANOMALY_CONFIG_KEY);
}
}
}
}

View File

@@ -0,0 +1,78 @@
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.fuelgauge.batterytip;
import android.app.StatsManager;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.os.StatsDimensionsValue;
import android.support.annotation.VisibleForTesting;
import android.util.Log;
import com.android.settings.fuelgauge.BatteryUtils;
import java.util.List;
/**
* Receive the anomaly info from {@link StatsManager}
*/
public class AnomalyDetectionReceiver extends BroadcastReceiver {
private static final String TAG = "SettingsAnomalyReceiver";
@Override
public void onReceive(Context context, Intent intent) {
final BatteryDatabaseManager databaseManager = BatteryDatabaseManager.getInstance(context);
final BatteryUtils batteryUtils = BatteryUtils.getInstance(context);
final long configUid = intent.getLongExtra(StatsManager.EXTRA_STATS_CONFIG_UID, -1);
final long configKey = intent.getLongExtra(StatsManager.EXTRA_STATS_CONFIG_KEY, -1);
final long subscriptionId = intent.getLongExtra(StatsManager.EXTRA_STATS_SUBSCRIPTION_ID,
-1);
Log.i(TAG, "Anomaly intent received. configUid = " + configUid + " configKey = "
+ configKey + " subscriptionId = " + subscriptionId);
saveAnomalyToDatabase(databaseManager, batteryUtils, intent);
AnomalyCleanUpJobService.scheduleCleanUp(context);
}
@VisibleForTesting
void saveAnomalyToDatabase(BatteryDatabaseManager databaseManager, BatteryUtils batteryUtils
, Intent intent) {
// The Example of intentDimsValue is: 35:{1:{1:{1:10013|}|}|}
StatsDimensionsValue intentDimsValue =
intent.getParcelableExtra(StatsManager.EXTRA_STATS_DIMENSIONS_VALUE);
Log.i(TAG, "Extra stats value: " + intentDimsValue.toString());
List<StatsDimensionsValue> intentTuple = intentDimsValue.getTupleValueList();
if (!intentTuple.isEmpty()) {
try {
// TODO(b/72385333): find more robust way to extract the uid.
final StatsDimensionsValue intentTupleValue = intentTuple.get(0)
.getTupleValueList().get(0).getTupleValueList().get(0);
final int uid = intentTupleValue.getIntValue();
// TODD(b/72385333): extract anomaly type
final int anomalyType = 0;
final String packageName = batteryUtils.getPackageName(uid);
final long timeMs = System.currentTimeMillis();
databaseManager.insertAnomaly(packageName, anomalyType, timeMs);
} catch (NullPointerException | IndexOutOfBoundsException e) {
Log.e(TAG, "Parse stats dimensions value error.", e);
}
}
}
}

View File

@@ -19,7 +19,6 @@ package com.android.settings.fuelgauge.batterytip;
import android.content.Context;
import android.provider.Settings;
import android.support.annotation.VisibleForTesting;
import android.text.format.DateUtils;
import android.util.KeyValueListParser;
import android.util.Log;
@@ -44,6 +43,7 @@ public class BatteryTipPolicy {
private static final String KEY_REDUCED_BATTERY_PERCENT = "reduced_battery_percent";
private static final String KEY_LOW_BATTERY_ENABLED = "low_battery_enabled";
private static final String KEY_LOW_BATTERY_HOUR = "low_battery_hour";
private static final String KEY_DATA_HISTORY_RETAIN_HOUR = "data_history_retain_hour";
/**
* {@code true} if general battery tip is enabled
@@ -143,6 +143,14 @@ public class BatteryTipPolicy {
*/
public final int lowBatteryHour;
/**
* TTL hour for anomaly data stored in database
*
* @see Settings.Global#BATTERY_TIP_CONSTANTS
* @see #KEY_DATA_HISTORY_RETAIN_HOUR
*/
public final int dataHistoryRetainHour;
private final KeyValueListParser mParser;
public BatteryTipPolicy(Context context) {
@@ -174,6 +182,7 @@ public class BatteryTipPolicy {
reducedBatteryPercent = mParser.getInt(KEY_REDUCED_BATTERY_PERCENT, 50);
lowBatteryEnabled = mParser.getBoolean(KEY_LOW_BATTERY_ENABLED, false);
lowBatteryHour = mParser.getInt(KEY_LOW_BATTERY_HOUR, 16);
dataHistoryRetainHour = mParser.getInt(KEY_DATA_HISTORY_RETAIN_HOUR, 72);
}
}

View File

@@ -0,0 +1,33 @@
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.fuelgauge.batterytip;
/**
* This class provides all the configs needed if we want to use {@link android.app.StatsManager}
*/
public class StatsManagerConfig {
/**
* The key that represents the anomaly config.
* This value is used in {@link android.app.StatsManager#addConfiguration(long, byte[])}
*/
public static final long ANOMALY_CONFIG_KEY = 1;
/**
* The key that represents subscriber, which is settings app.
*/
public static final long SUBSCRIBER_ID = 1;
}

View File

@@ -0,0 +1,63 @@
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.fuelgauge.batterytip;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertEquals;
import static org.robolectric.RuntimeEnvironment.application;
import android.app.job.JobInfo;
import android.app.job.JobScheduler;
import com.android.settings.R;
import com.android.settings.TestConfig;
import com.android.settings.testutils.SettingsRobolectricTestRunner;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.MockitoAnnotations;
import org.robolectric.Shadows;
import org.robolectric.annotation.Config;
import org.robolectric.shadows.ShadowJobScheduler;
import java.util.List;
import java.util.concurrent.TimeUnit;
@RunWith(SettingsRobolectricTestRunner.class)
@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
public class AnomalyCleanUpJobServiceTest {
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
}
@Test
public void testScheduleCleanUp() {
AnomalyCleanUpJobService.scheduleCleanUp(application);
ShadowJobScheduler shadowJobScheduler = Shadows.shadowOf(
application.getSystemService(JobScheduler.class));
List<JobInfo> pendingJobs = shadowJobScheduler.getAllPendingJobs();
assertEquals(1, pendingJobs.size());
JobInfo pendingJob = pendingJobs.get(0);
assertThat(pendingJob.getId()).isEqualTo(R.id.job_anomaly_clean_up);
assertThat(pendingJob.getMinLatencyMillis()).isEqualTo(TimeUnit.DAYS.toMillis(1));
assertThat(pendingJob.isRequireDeviceIdle()).isTrue();
}
}

View File

@@ -49,7 +49,8 @@ public class BatteryTipPolicyTest {
+ ",reduced_battery_enabled=true"
+ ",reduced_battery_percent=30"
+ ",low_battery_enabled=false"
+ ",low_battery_hour=10";
+ ",low_battery_hour=10"
+ ",data_history_retain_hour=24";
private Context mContext;
@Before
@@ -76,6 +77,7 @@ public class BatteryTipPolicyTest {
assertThat(batteryTipPolicy.reducedBatteryPercent).isEqualTo(30);
assertThat(batteryTipPolicy.lowBatteryEnabled).isFalse();
assertThat(batteryTipPolicy.lowBatteryHour).isEqualTo(10);
assertThat(batteryTipPolicy.dataHistoryRetainHour).isEqualTo(24);
}
@Test
@@ -97,6 +99,7 @@ public class BatteryTipPolicyTest {
assertThat(batteryTipPolicy.reducedBatteryPercent).isEqualTo(50);
assertThat(batteryTipPolicy.lowBatteryEnabled).isFalse();
assertThat(batteryTipPolicy.lowBatteryHour).isEqualTo(16);
assertThat(batteryTipPolicy.dataHistoryRetainHour).isEqualTo(72);
}
}