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
|
import * as _ from 'lodash';
import * as React from 'react';
import { Dispatch } from 'redux';
import { PROGRESS_STALL_AT_PERCENTAGE, PROGRESS_TICK_INTERVAL_MS } from '../constants';
import { Action, actions } from '../redux/actions';
import { ColorOption } from '../style/theme';
import { Container } from './ui/container';
import { Flex } from './ui/flex';
import { Text } from './ui/text';
const TICKS_PER_SECOND = 1000 / PROGRESS_TICK_INTERVAL_MS;
const curTimeUnix = () => {
return new Date().getTime();
};
export interface SimulatedProgressBarProps {
startTimeUnix: number;
expectedEndTimeUnix: number;
ended: boolean;
}
enum TickingRunState {
None = 'None',
Running = 'Running',
Finishing = 'Finishing',
}
interface TickingNoneStatus {
runState: TickingRunState.None;
}
interface TickingRunningStatus {
runState: TickingRunState.Running;
}
interface TickingFinishingStatus {
runState: TickingRunState.Finishing;
increasePercentageEveryTick: number;
}
type TickingStatus = TickingNoneStatus | TickingRunningStatus | TickingFinishingStatus;
export interface SimulatedProgressState {
percentageDone: number;
intervalId?: number;
tickingStatus: TickingStatus;
elapsedTimeMs: number;
}
export class SimulatedProgressBar extends React.Component<SimulatedProgressBarProps, SimulatedProgressState> {
public constructor(props: SimulatedProgressBarProps) {
super(props);
// TODO: look into using assert library here?
if (props.expectedEndTimeUnix <= props.startTimeUnix) {
throw new Error('End time before start time');
}
// TODO: use getFreshState here
const intervalId = window.setInterval(this._tick.bind(this), PROGRESS_TICK_INTERVAL_MS);
this.state = {
percentageDone: 0,
intervalId,
tickingStatus: { runState: TickingRunState.Running },
elapsedTimeMs: 0,
};
}
public componentDidUpdate(prevProps: SimulatedProgressBarProps, prevState: SimulatedProgressState): void {
const percentLeft = 100 - this.state.percentageDone;
const increasePercentageEveryTick = percentLeft / TICKS_PER_SECOND;
// if we just switched to ending, having animate to end
if (prevProps.ended === false && this.props.ended === true) {
this.setState({
tickingStatus: {
runState: TickingRunState.Finishing,
increasePercentageEveryTick,
},
});
return;
}
// later TODO: the new state could be for the wrong order, attach to order state or add concurrency checking
// if anything else changes, reset internal state
if (
prevProps.startTimeUnix !== this.props.startTimeUnix ||
prevProps.expectedEndTimeUnix !== this.props.expectedEndTimeUnix ||
prevProps.ended !== this.props.ended
) {
this.setState(this._getFreshState());
}
}
public componentWillUnmount(): void {
console.log('unmount');
this._clearTimer();
}
public render(): React.ReactNode {
// TODO: Consider moving to seperate component
const estimatedTimeSeconds = Math.ceil((this.props.expectedEndTimeUnix - this.props.startTimeUnix) / 1000);
const elapsedTimeSeconds = Math.floor(this.state.elapsedTimeMs / 1000);
return (
<Container padding="20px 20px 0px 20px" width="100%">
<Container marginBottom="5px">
{/* TODO: consider moving to separate component */}
<Flex justify="space-between">
{/* TODO: should do nice display of these (i.e. 'minutes' and 00:xx) */}
<Text>Est. Time ({estimatedTimeSeconds} seconds)</Text>
<Text>Time: {elapsedTimeSeconds}</Text>
</Flex>
</Container>
<Container width="100%" backgroundColor={ColorOption.lightGrey} borderRadius="6px">
<Container
width={`${this.state.percentageDone}%`}
backgroundColor={ColorOption.primaryColor}
borderRadius="6px"
height="6px"
/>
</Container>
</Container>
);
}
private _getFreshState(): SimulatedProgressState {
this._clearTimer();
const intervalId = window.setInterval(this._tick.bind(this), PROGRESS_TICK_INTERVAL_MS);
return {
percentageDone: 0,
intervalId,
tickingStatus: { runState: TickingRunState.Running },
elapsedTimeMs: 0,
};
}
private _tick(): void {
const rawPercentageDone =
this.state.tickingStatus.runState === TickingRunState.Finishing
? this._getNewPercentageFinishing(this.state.tickingStatus)
: this._getNewPercentageNormal();
const maxPercentage =
this.state.tickingStatus.runState === TickingRunState.Finishing ? 100 : PROGRESS_STALL_AT_PERCENTAGE;
const percentageDone = Math.min(rawPercentageDone, maxPercentage);
const elapsedTimeMs = Math.max(curTimeUnix() - this.props.startTimeUnix, 0);
this.setState({
percentageDone,
elapsedTimeMs,
});
if (percentageDone >= 100) {
this._clearTimer();
}
}
private _clearTimer(): void {
if (this.state.intervalId) {
window.clearTimeout(this.state.intervalId);
}
}
// TODO: consider not taking in a parameter here, might be confusing
private _getNewPercentageFinishing(tickingStatus: TickingFinishingStatus): number {
return this.state.percentageDone + tickingStatus.increasePercentageEveryTick;
}
private _getNewPercentageNormal(): number {
const elapsedTimeMs = curTimeUnix() - this.props.startTimeUnix;
const safeElapsedTimeMs = Math.max(elapsedTimeMs, 1);
const expectedAmountOfTimeMs = this.props.expectedEndTimeUnix - this.props.startTimeUnix;
const percentageDone = safeElapsedTimeMs / expectedAmountOfTimeMs * 100;
return percentageDone;
}
}
|
