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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
/*
* Copyright (C) 2008-2011, Google Inc. and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.lib;
import java.time.Duration;
import java.time.Instant;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import org.eclipse.jgit.lib.internal.WorkQueue;
import org.eclipse.jgit.util.SystemReader;
/**
* ProgressMonitor that batches update events.
*/
public abstract class BatchingProgressMonitor implements ProgressMonitor {
private static boolean performanceTrace = SystemReader.getInstance()
.isPerformanceTraceEnabled();
private long delayStartTime;
private TimeUnit delayStartUnit = TimeUnit.MILLISECONDS;
private Task task;
private Boolean showDuration;
/**
* Set an optional delay before the first output.
*
* @param time
* how long to wait before output. If 0 output begins on the
* first {@link #update(int)} call.
* @param unit
* time unit of {@code time}.
*/
public void setDelayStart(long time, TimeUnit unit) {
delayStartTime = time;
delayStartUnit = unit;
}
@Override
public void start(int totalTasks) {
// Ignore the number of tasks.
}
@Override
public void beginTask(String title, int work) {
endTask();
task = new Task(title, work);
if (delayStartTime != 0)
task.delay(delayStartTime, delayStartUnit);
}
@Override
public void update(int completed) {
if (task != null)
task.update(this, completed);
}
@Override
public void endTask() {
if (task != null) {
task.end(this);
task = null;
}
}
@Override
public boolean isCancelled() {
return false;
}
@Override
public void showDuration(boolean enabled) {
showDuration = Boolean.valueOf(enabled);
}
/**
* Update the progress monitor if the total work isn't known,
*
* @param taskName
* name of the task.
* @param workCurr
* number of units already completed.
* @param duration
* how long this task runs
* @since 6.5
*/
protected abstract void onUpdate(String taskName, int workCurr,
Duration duration);
/**
* Finish the progress monitor when the total wasn't known in advance.
*
* @param taskName
* name of the task.
* @param workCurr
* total number of units processed.
* @param duration
* how long this task runs
* @since 6.5
*/
protected abstract void onEndTask(String taskName, int workCurr,
Duration duration);
/**
* Update the progress monitor when the total is known in advance.
*
* @param taskName
* name of the task.
* @param workCurr
* number of units already completed.
* @param workTotal
* estimated number of units to process.
* @param percentDone
* {@code workCurr * 100 / workTotal}.
* @param duration
* how long this task runs
* @since 6.5
*/
protected abstract void onUpdate(String taskName, int workCurr,
int workTotal, int percentDone, Duration duration);
/**
* Finish the progress monitor when the total is known in advance.
*
* @param taskName
* name of the task.
* @param workCurr
* total number of units processed.
* @param workTotal
* estimated number of units to process.
* @param percentDone
* {@code workCurr * 100 / workTotal}.
* @param duration
* duration of the task
* @since 6.5
*/
protected abstract void onEndTask(String taskName, int workCurr,
int workTotal, int percentDone, Duration duration);
private boolean showDuration() {
return showDuration != null ? showDuration.booleanValue()
: performanceTrace;
}
/**
* Append formatted duration if system property or environment variable
* GIT_TRACE_PERFORMANCE is set to "true". If both are defined the system
* property takes precedence.
*
* @param s
* StringBuilder to append the formatted duration to
* @param duration
* duration to format
* @since 6.5
*/
@SuppressWarnings({ "boxing", "nls" })
protected void appendDuration(StringBuilder s, Duration duration) {
if (!showDuration()) {
return;
}
long hours = duration.toHours();
int minutes = duration.toMinutesPart();
int seconds = duration.toSecondsPart();
s.append(" [");
if (hours > 0) {
s.append(hours).append(':');
s.append(String.format("%02d", minutes)).append(':');
s.append(String.format("%02d", seconds));
} else if (minutes > 0) {
s.append(minutes).append(':');
s.append(String.format("%02d", seconds));
} else {
s.append(seconds);
}
s.append('.').append(String.format("%03d", duration.toMillisPart()));
if (hours > 0) {
s.append('h');
} else if (minutes > 0) {
s.append('m');
} else {
s.append('s');
}
s.append(']');
}
private static class Task implements Runnable {
/** Title of the current task. */
private final String taskName;
/** Number of work units, or {@link ProgressMonitor#UNKNOWN}. */
private final int totalWork;
/** True when timer expires and output should occur on next update. */
private volatile boolean display;
/** Scheduled timer, supporting cancellation if task ends early. */
private Future<?> timerFuture;
/** True if the task has displayed anything. */
private boolean output;
/** Number of work units already completed. */
private int lastWork;
/** Percentage of {@link #totalWork} that is done. */
private int lastPercent;
private final Instant startTime;
Task(String taskName, int totalWork) {
this.taskName = taskName;
this.totalWork = totalWork;
this.display = true;
this.startTime = Instant.now();
}
void delay(long time, TimeUnit unit) {
display = false;
timerFuture = WorkQueue.getExecutor().schedule(this, time, unit);
}
@Override
public void run() {
display = true;
}
void update(BatchingProgressMonitor pm, int completed) {
lastWork += completed;
if (totalWork == UNKNOWN) {
// Only display once per second, as the alarm fires.
if (display) {
pm.onUpdate(taskName, lastWork, elapsedTime());
output = true;
restartTimer();
}
} else {
// Display once per second or when 1% is done.
int currPercent = Math.round(lastWork * 100F / totalWork);
if (display) {
pm.onUpdate(taskName, lastWork, totalWork, currPercent,
elapsedTime());
output = true;
restartTimer();
lastPercent = currPercent;
} else if (currPercent != lastPercent) {
pm.onUpdate(taskName, lastWork, totalWork, currPercent,
elapsedTime());
output = true;
lastPercent = currPercent;
}
}
}
private void restartTimer() {
display = false;
timerFuture = WorkQueue.getExecutor().schedule(this, 1,
TimeUnit.SECONDS);
}
void end(BatchingProgressMonitor pm) {
if (output) {
if (totalWork == UNKNOWN) {
pm.onEndTask(taskName, lastWork, elapsedTime());
} else {
int currPercent = Math.round(lastWork * 100F / totalWork);
pm.onEndTask(taskName, lastWork, totalWork, currPercent, elapsedTime());
}
}
if (timerFuture != null)
timerFuture.cancel(false /* no interrupt */);
}
private Duration elapsedTime() {
return Duration.between(startTime, Instant.now());
}
}
}
|