1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/*
* Copyright (C) 2016 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.core;
import static com.android.internal.jank.InteractionJankMonitor.CUJ_SETTINGS_PAGE_SCROLL;
import static com.android.internal.jank.InteractionJankMonitor.Configuration;
import android.content.Context;
import android.os.Bundle;
import android.text.TextUtils;
import android.util.Log;
import androidx.annotation.XmlRes;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;
import androidx.recyclerview.widget.RecyclerView;
import com.android.internal.jank.InteractionJankMonitor;
import com.android.settings.overlay.FeatureFactory;
import com.android.settings.survey.SurveyMixin;
import com.android.settingslib.core.instrumentation.Instrumentable;
import com.android.settingslib.core.instrumentation.MetricsFeatureProvider;
import com.android.settingslib.core.instrumentation.VisibilityLoggerMixin;
import com.android.settingslib.core.lifecycle.ObservablePreferenceFragment;
/**
* Instrumented fragment that logs visibility state.
*/
public abstract class InstrumentedPreferenceFragment extends ObservablePreferenceFragment
implements Instrumentable {
private static final String TAG = "InstrumentedPrefFrag";
protected MetricsFeatureProvider mMetricsFeatureProvider;
// metrics placeholder value. Only use this for development.
protected final int PLACEHOLDER_METRIC = 10000;
private VisibilityLoggerMixin mVisibilityLoggerMixin;
private RecyclerView.OnScrollListener mOnScrollListener;
@Override
public void onAttach(Context context) {
mMetricsFeatureProvider = FeatureFactory.getFactory(context).getMetricsFeatureProvider();
// Mixin that logs visibility change for activity.
mVisibilityLoggerMixin = new VisibilityLoggerMixin(getMetricsCategory(),
mMetricsFeatureProvider);
getSettingsLifecycle().addObserver(mVisibilityLoggerMixin);
getSettingsLifecycle().addObserver(new SurveyMixin(this, getClass().getSimpleName()));
super.onAttach(context);
}
@Override
public void onResume() {
mVisibilityLoggerMixin.setSourceMetricsCategory(getActivity());
// Add scroll listener to trace interaction jank.
final RecyclerView recyclerView = getListView();
if (recyclerView != null) {
mOnScrollListener = new OnScrollListener(getClass().getName());
recyclerView.addOnScrollListener(mOnScrollListener);
}
super.onResume();
}
@Override
public void onPause() {
final RecyclerView recyclerView = getListView();
if (mOnScrollListener != null) {
recyclerView.removeOnScrollListener(mOnScrollListener);
mOnScrollListener = null;
}
super.onPause();
}
@Override
public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
final int resId = getPreferenceScreenResId();
if (resId > 0) {
addPreferencesFromResource(resId);
}
}
@Override
public void addPreferencesFromResource(@XmlRes int preferencesResId) {
super.addPreferencesFromResource(preferencesResId);
updateActivityTitleWithScreenTitle(getPreferenceScreen());
}
@Override
public <T extends Preference> T findPreference(CharSequence key) {
if (key == null) {
return null;
}
return super.findPreference(key);
}
@Override
public boolean onPreferenceTreeClick(Preference preference) {
writePreferenceClickMetric(preference);
return super.onPreferenceTreeClick(preference);
}
protected final Context getPrefContext() {
return getPreferenceManager().getContext();
}
/**
* Get the res id for static preference xml for this fragment.
*/
protected int getPreferenceScreenResId() {
return -1;
}
protected void writeElapsedTimeMetric(int action, String key) {
mVisibilityLoggerMixin.writeElapsedTimeMetric(action, key);
}
protected void writePreferenceClickMetric(Preference preference) {
mMetricsFeatureProvider.logClickedPreference(preference, getMetricsCategory());
}
private void updateActivityTitleWithScreenTitle(PreferenceScreen screen) {
if (screen != null) {
final CharSequence title = screen.getTitle();
if (!TextUtils.isEmpty(title)) {
getActivity().setTitle(title);
} else {
Log.w(TAG, "Screen title missing for fragment " + this.getClass().getName());
}
}
}
private static final class OnScrollListener extends RecyclerView.OnScrollListener {
private final InteractionJankMonitor mMonitor = InteractionJankMonitor.getInstance();
private final String mClassName;
private OnScrollListener(String className) {
mClassName = className;
}
@Override
public void onScrollStateChanged(RecyclerView recyclerView, int newState) {
switch (newState) {
case RecyclerView.SCROLL_STATE_DRAGGING:
final Configuration.Builder builder =
new Configuration.Builder(CUJ_SETTINGS_PAGE_SCROLL)
.setView(recyclerView)
.setTag(mClassName);
mMonitor.begin(builder);
break;
case RecyclerView.SCROLL_STATE_IDLE:
mMonitor.end(CUJ_SETTINGS_PAGE_SCROLL);
break;
default:
}
}
}
}
|
