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
|
import { closeToExpiry, hasExpired } from '../shared/account-expiry';
import { AccountToken, IAccountData, VoucherResponse } from '../shared/daemon-rpc-types';
import { DateComponent, dateByAddingComponent } from '../shared/date-helper';
import log from '../shared/logging';
import { Scheduler } from '../shared/scheduler';
import { InvalidAccountError } from './errors';
interface IAccountFetchWatcher {
onFinish: () => void;
onError: (error: Error) => void;
}
// Account data is valid for 1 minute unless the account has expired.
const ACCOUNT_DATA_VALIDITY_SECONDS = 60_000;
// Account data is valid for 10 seconds if the account has expired.
const ACCOUNT_DATA_EXPIRED_VALIDITY_SECONDS = 10_000;
// An account data cache that helps to throttle RPC requests to get_account_data and retain the
// cached value for 1 minute.
export default class AccountDataCache {
private currentAccount?: AccountToken;
private validUntil?: Date;
private performingFetch = false;
private waitStrategy = new WaitStrategy();
private fetchRetryScheduler = new Scheduler();
private watchers: IAccountFetchWatcher[] = [];
constructor(
private fetchHandler: (token: AccountToken) => Promise<IAccountData>,
private updateHandler: (data?: IAccountData) => void,
) {}
public fetch(accountToken: AccountToken, watcher?: IAccountFetchWatcher) {
// invalidate cache if account token has changed
if (accountToken !== this.currentAccount) {
this.invalidate();
this.currentAccount = accountToken;
}
// Only fetch if value has expired
if (!this.isValid()) {
if (watcher) {
this.watchers.push(watcher);
}
this.fetchRetryScheduler.cancel();
// If a scheduled retry is cancelled the fetchAttempt shouldn't be increased.
this.waitStrategy.decrease();
// Only fetch if there's no fetch for this account number in progress.
if (!this.performingFetch) {
void this.performFetch(accountToken);
}
} else if (watcher) {
watcher.onFinish();
}
}
public invalidate() {
this.fetchRetryScheduler.cancel();
this.waitStrategy.reset();
this.performingFetch = false;
this.validUntil = undefined;
this.updateHandler();
this.notifyWatchers((watcher) => {
watcher.onError(new Error('Cancelled'));
});
}
public handleVoucherResponse(accountToken: AccountToken, voucherResponse: VoucherResponse) {
if (accountToken === this.currentAccount && voucherResponse.type === 'success') {
this.setValue({ expiry: voucherResponse.newExpiry });
}
}
private setValue(accountData: IAccountData) {
this.validUntil = this.getValidUntil(accountData);
this.updateHandler(accountData);
this.notifyWatchers((watcher) => watcher.onFinish());
}
private isValid() {
return this.validUntil && this.validUntil > new Date();
}
private getValidUntil(accountData: IAccountData): Date {
if (hasExpired(accountData.expiry)) {
return new Date(Date.now() + ACCOUNT_DATA_EXPIRED_VALIDITY_SECONDS);
} else {
return new Date(Date.now() + ACCOUNT_DATA_VALIDITY_SECONDS);
}
}
private async performFetch(accountToken: AccountToken) {
this.performingFetch = true;
try {
// it's possible for invalidate() to be called or for a fetch for a different account token
// to start before this fetch completes, so checking if the current account token is the one
// used is necessary below.
const accountData = await this.fetchHandler(accountToken);
if (this.currentAccount === accountToken) {
this.setValue(accountData);
const refetchDelay = this.calculateRefetchDelay(accountData.expiry);
if (refetchDelay) {
this.scheduleFetch(accountToken, refetchDelay);
}
this.waitStrategy.reset();
this.performingFetch = false;
}
} catch (e) {
const error = e as Error;
if (this.currentAccount === accountToken) {
this.handleFetchError(accountToken, error);
this.performingFetch = false;
}
}
}
private calculateRefetchDelay(accountExpiry: string) {
const currentDate = new Date();
const oneMinuteBeforeExpiry = dateByAddingComponent(accountExpiry, DateComponent.minute, -1);
if (oneMinuteBeforeExpiry >= currentDate && closeToExpiry(accountExpiry)) {
return oneMinuteBeforeExpiry.getTime() - currentDate.getTime();
} else {
return undefined;
}
}
private handleFetchError(accountToken: AccountToken, error: Error) {
this.notifyWatchers((w) => w.onError(error));
if (!(error instanceof InvalidAccountError)) {
this.scheduleRetry(accountToken);
}
}
private scheduleRetry(accountToken: AccountToken) {
this.waitStrategy.increase();
const delay = this.waitStrategy.delay();
log.warn(`Failed to fetch account data. Retrying in ${delay} ms`);
this.scheduleFetch(accountToken, delay);
}
private scheduleFetch(accountToken: AccountToken, delay: number) {
this.fetchRetryScheduler.schedule(() => {
void this.performFetch(accountToken);
}, delay);
}
private notifyWatchers(notify: (watcher: IAccountFetchWatcher) => void) {
this.watchers.splice(0).forEach(notify);
}
}
const MAX_ATTEMPT = 9;
class WaitStrategy {
private counter = 0;
public increase() {
if (this.counter < MAX_ATTEMPT) {
this.counter += 1;
}
}
public decrease() {
if (this.counter > 0) {
this.counter -= 1;
}
}
public reset() {
this.counter = 0;
}
public delay(): number {
// Max delay: 2^11 = 2048
return Math.pow(2, this.counter + 2) * 1000;
}
}
|
