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
|
'use strict';
/**
* Caching of previously downloaded firmwares and release descriptions
*
* Depends on LRUMap for which the docs can be found here:
* https://github.com/rsms/js-lru
*/
/**
* @typedef {object} Descriptor Release descriptor object
* @property {string} releaseUrl
* @property {string} name
* @property {string} version
* @property {string} url
* @property {string} file
* @property {string} target
* @property {string} date
* @property {string} notes
* @property {string} status
* @see buildBoardOptions() in {@link release_checker.js}
*/
/**
* @typedef {object} CacheItem
* @property {Descriptor} release
* @property {string} hexdata
*/
/**
* Manages caching of downloaded firmware files
*/
let FirmwareCache = (function () {
let onPutToCacheCallback,
onRemoveFromCacheCallback;
let JournalStorage = (function () {
let CACHEKEY = "firmware-cache-journal";
/**
* @param {Array} data LRU key-value pairs
*/
function persist(data) {
let obj = {};
obj[CACHEKEY] = data;
ConfigStorage.set(obj);
}
/**
* @param {Function} callback
*/
function load(callback) {
const obj = ConfigStorage.get(CACHEKEY);
let entries = typeof obj === "object" && obj.hasOwnProperty(CACHEKEY)
? obj[CACHEKEY]
: [];
callback(entries);
}
return {
persist: persist,
load: load,
};
})();
let journal = new LRUMap(100),
journalLoaded = false;
journal.shift = function () {
// remove cached data for oldest release
let oldest = LRUMap.prototype.shift.call(this);
if (oldest === undefined) {
return undefined;
}
let key = oldest[0];
let cacheKey = withCachePrefix(key);
const obj = ConfigStorage.get(cacheKey);
/** @type {CacheItem} */
const cached = typeof obj === "object" && obj.hasOwnProperty(cacheKey) ? obj[cacheKey] : null;
if (cached === null) {
return undefined;
}
ConfigStorage.remove(cacheKey);
onRemoveFromCache(cached.release);
return oldest;
};
/**
* @param {Descriptor} release
* @returns {string} A key used to store a release in the journal
*/
function keyOf(release) {
return release.file;
}
/**
* @param {string} key
* @returns {string} A key for storing cached data for a release
*/
function withCachePrefix(key) {
return `cache:${key}`;
}
/**
* @param {Descriptor} release
* @returns {boolean}
*/
function has(release) {
if (!release) {
return false;
}
if (!journalLoaded) {
console.warn("Cache not yet loaded");
return false;
}
return journal.has(keyOf(release));
}
/**
* @param {Descriptor} release
* @param {string} hexdata
*/
function put(release, hexdata) {
if (!journalLoaded) {
console.warn("Cache journal not yet loaded");
return;
}
let key = keyOf(release);
if (has(release)) {
console.debug(`Firmware is already cached: ${key}`);
return;
}
journal.set(key, true);
JournalStorage.persist(journal.toJSON());
let obj = {};
obj[withCachePrefix(key)] = {
release: release,
hexdata: hexdata,
};
ConfigStorage.set(obj);
onPutToCache(release);
}
/**
* @param {Descriptor} release
* @param {Function} callback
*/
function get(release, callback) {
if (!journalLoaded) {
console.warn("Cache journal not yet loaded");
return undefined;
}
let key = keyOf(release);
if (!has(release)) {
console.debug(`Firmware is not cached: ${key}`);
return;
}
let cacheKey = withCachePrefix(key);
const obj = ConfigStorage.get(cacheKey);
const cached = typeof obj === "object" && obj.hasOwnProperty(cacheKey) ? obj[cacheKey] : null;
callback(cached);
}
/**
* Remove all cached data
*/
function invalidate() {
if (!journalLoaded) {
console.warn("Cache journal not yet loaded");
return undefined;
}
let cacheKeys = [];
for (let key of journal.keys()) {
cacheKeys.push(withCachePrefix(key));
}
const obj = ConfigStorage.get(cacheKeys);
if (typeof obj !== "object") {
return;
}
console.log(obj.entries());
for (let cacheKey of cacheKeys) {
if (obj.hasOwnProperty(cacheKey)) {
/** @type {CacheItem} */
let item = obj[cacheKey];
onRemoveFromCache(item.release);
}
}
ConfigStorage.remove(cacheKeys);
journal.clear();
JournalStorage.persist(journal.toJSON());
}
/**
* @param {Descriptor} release
*/
function onPutToCache(release) {
if (typeof onPutToCacheCallback === "function") {
onPutToCacheCallback(release);
}
console.info(`Release put to cache: ${keyOf(release)}`);
}
/**
* @param {Descriptor} release
*/
function onRemoveFromCache(release) {
if (typeof onRemoveFromCacheCallback === "function") {
onRemoveFromCacheCallback(release);
}
console.debug(`Cache data removed: ${keyOf(release)}`);
}
/**
* @param {Array} entries
*/
function onEntriesLoaded(entries) {
let pairs = [];
for (let entry of entries) {
pairs.push([entry.key, entry.value]);
}
journal.assign(pairs);
journalLoaded = true;
console.info(`Firmware cache journal loaded; number of entries: ${entries.length}`);
}
return {
has: has,
put: put,
get: get,
onPutToCache: callback => onPutToCacheCallback = callback,
onRemoveFromCache: callback => onRemoveFromCacheCallback = callback,
load: () => {
JournalStorage.load(onEntriesLoaded);
},
unload: () => {
JournalStorage.persist(journal.toJSON());
journal.clear();
},
invalidate: invalidate,
};
})();
|
