-
-
Notifications
You must be signed in to change notification settings - Fork 73
/
saveArticles.ts
402 lines (353 loc) · 14.4 KB
/
saveArticles.ts
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
import * as logger from '../Logger.js'
import Downloader from '../Downloader.js'
import RedisStore from '../RedisStore.js'
import { ZimArticle, ZimCreator } from '@openzim/libzim'
import pmap from 'p-map'
import * as domino from 'domino'
import { Dump } from '../Dump.js'
import Timer from './Timer.js'
import { jsPath } from './index.js'
import { config } from '../config.js'
import { getSizeFromUrl, cleanupAxiosError } from './misc.js'
import { CONCURRENCY_LIMIT, DELETED_ARTICLE_ERROR, MAX_FILE_DOWNLOAD_RETRIES } from './const.js'
import urlHelper from './url.helper.js'
import { Renderer } from '../renderers/abstract.renderer.js'
import { RendererBuilder } from '../renderers/renderer.builder.js'
export async function downloadFiles(fileStore: RKVS<FileDetail>, retryStore: RKVS<FileDetail>, zimCreator: ZimCreator, dump: Dump, downloader: Downloader, retryCounter = 0) {
await retryStore.flush()
const filesForAttempt = await fileStore.len()
const filesTotal = filesForAttempt + dump.status.files.success + dump.status.files.fail
const doRetry = retryCounter < MAX_FILE_DOWNLOAD_RETRIES
logger.log(`${retryCounter ? 'RE-' : ''}Downloading a total of [${retryCounter ? filesForAttempt : filesTotal}] files...`)
let prevPercentProgress: string
await fileStore.iterateItems(downloader.speed, async (fileDownloadPairs, workerId) => {
logger.info(`Worker [${workerId}] processing batch of [${Object.keys(fileDownloadPairs).length}] files`)
// todo align fileDownloadPairs and listOfArguments
const listOfArguments = []
for (const [path, { url, namespace, mult, width }] of Object.entries(fileDownloadPairs)) {
listOfArguments.push({ path, url, namespace, mult, width })
}
const responses = await downloadBulk(listOfArguments, downloader)
for (const resp of responses) {
let isFailed = false
try {
if (resp.result && resp.result.content) {
const article = new ZimArticle({
url: resp.path,
data: resp.result.content,
ns: resp.namespace || 'I',
mimeType: resp.result.responseHeaders['content-type'],
})
zimCreator.addArticle(article)
dump.status.files.success += 1
} else {
isFailed = true
}
} catch (err) {
isFailed = true
} finally {
if (isFailed) {
if (doRetry && resp.status !== 404) {
await retryStore.set(resp.path, { url: resp.url, namespace: resp.namespace, mult: resp.mult, width: resp.width })
} else {
logger.warn(`Error downloading file [${urlHelper.deserializeUrl(resp.url)}], skipping`)
dump.status.files.fail += 1
}
}
}
if ((dump.status.files.success + dump.status.files.fail) % 10 === 0) {
const percentProgress = (((dump.status.files.success + dump.status.files.fail) / filesTotal) * 100).toFixed(1)
if (percentProgress !== prevPercentProgress) {
prevPercentProgress = percentProgress
logger.log(`Progress downloading files [${dump.status.files.success + dump.status.files.fail}/${filesTotal}] [${percentProgress}%]`)
}
}
}
})
logger.log(`Done with ${retryCounter ? 'RE-' : ''}Downloading [${retryCounter ? filesForAttempt : filesTotal}] files`)
if (doRetry) {
const amountToRetry = await retryStore.len()
if (amountToRetry > 0) {
const ts = (retryCounter + 1) * 10
logger.log(`Waiting ${ts} seconds before retrying ${amountToRetry} files`)
await new Promise((res) => setTimeout(res, ts * 1000))
await downloadFiles(retryStore, fileStore, zimCreator, dump, downloader, retryCounter + 1)
} else {
logger.log('No files to retry')
}
}
}
async function downloadBulk(listOfArguments: any[], downloader: Downloader): Promise<any> {
try {
// Enhance arguments array to have an index of the argument at hand
const argsCopy = [].concat(listOfArguments.map((val, ind) => ({ val, ind })))
const argList = []
while (argsCopy.length > 0) {
const arg = argsCopy.shift()
argList.push(arg)
}
return pmap(
argList,
async (arg) => {
const resp: any = {}
resp.path = arg.val.path
resp.url = arg.val.url
resp.namespace = arg.val.namespace
resp.mult = arg.val.mult
resp.width = arg.val.width
return downloader
.downloadContent(arg.val.url, false)
.then((r) => {
resp.result = r
resp.path += resp.result.responseHeaders.path_postfix || ''
return resp
})
.catch((err) => {
resp.status = err.response?.status
return resp
})
},
{ concurrency: CONCURRENCY_LIMIT },
)
} catch (err) {
logger.log(`Not able download in bulk due to ${err}`)
}
}
async function getAllArticlesToKeep(downloader: Downloader, articleDetailXId: RKVS<ArticleDetail>, dump: Dump, mainPageRenderer: Renderer, articlesRenderer: Renderer) {
await articleDetailXId.iterateItems(downloader.speed, async (articleKeyValuePairs) => {
for (const [articleId, articleDetail] of Object.entries(articleKeyValuePairs)) {
const _moduleDependencies = await downloader.getModuleDependencies(articleDetail.title)
let rets: any
try {
const isMainPage = dump.isMainPage(articleId)
const renderer = isMainPage ? mainPageRenderer : articlesRenderer
const articleUrl = isMainPage ? downloader.getMainPageUrl(articleId) : downloader.getArticleUrl(articleId)
rets = await downloader.getArticle(downloader.webp, _moduleDependencies, articleId, articleDetailXId, renderer, articleUrl, dump, articleDetail, isMainPage)
for (const { articleId, html } of rets) {
if (!html) {
continue
}
const doc = domino.createDocument(html)
if (!dump.isMainPage(articleId) && !(await dump.customProcessor.shouldKeepArticle(articleId, doc))) {
articleDetailXId.delete(articleId)
}
}
} catch (err) {
logger.warn(`Error downloading article [${articleId}], skipping`, err)
articleDetailXId.delete(articleId)
}
}
})
}
function flattenPromises(promisArr: [string, Promise<Error>][]): [string, Promise<Error>] {
return [
// first articleId
promisArr[0][0],
// promise resolving to first error or void
(async () => {
const resolved = await Promise.all(promisArr.map((p) => p[1]))
return resolved.find((err) => err)
})(),
]
}
/*
* Parse fetched article HTML, store files
* and dependencies and save in Zim
*/
async function saveArticle(
zimCreator: ZimCreator,
finalHTML: string,
mediaDependencies: any,
subtitles: any,
articleId: string,
articleTitle: string,
articleDetail: any,
): Promise<Error> {
try {
const filesToDownload: KVS<FileDetail> = {}
if (subtitles?.length > 0) {
subtitles.forEach((s) => {
filesToDownload[s.path] = { url: s.url, namespace: '-' }
})
}
if (mediaDependencies && mediaDependencies.length) {
const existingVals = await RedisStore.filesToDownloadXPath.getMany(mediaDependencies.map((dep) => dep.path))
for (const dep of mediaDependencies) {
const { mult, width } = getSizeFromUrl(dep.url)
const existingVal = existingVals[dep.path]
const currentDepIsHigherRes = !existingVal || existingVal.width < (width || 10e6) || existingVal.mult < (mult || 1)
if (currentDepIsHigherRes) {
filesToDownload[dep.path] = {
url: urlHelper.serializeUrl(dep.url),
mult,
width,
}
}
}
}
await RedisStore.filesToDownloadXPath.setMany(filesToDownload)
const zimArticle = new ZimArticle({
url: articleId,
data: finalHTML,
ns: articleDetail.ns === 14 ? 'U' : 'A',
mimeType: 'text/html',
title: articleTitle,
shouldIndex: true,
})
zimCreator.addArticle(zimArticle)
return null
} catch (err) {
return err
}
}
/*
* Fetch Articles
*/
export async function saveArticles(zimCreator: ZimCreator, downloader: Downloader, dump: Dump, hasWikimediaMobileApi: boolean, forceRender = null) {
const jsModuleDependencies = new Set<string>()
const cssModuleDependencies = new Set<string>()
const staticFilesList = new Set<string>()
let jsConfigVars = ''
let prevPercentProgress: string
const { articleDetailXId } = RedisStore
const articlesTotal = await articleDetailXId.len()
const rendererBuilder = new RendererBuilder()
let mainPageRenderer
let articlesRenderer
if (forceRender) {
// All articles and main page will use the same renderer if 'forceRender' is specified
const renderer = await rendererBuilder.createRenderer({
renderType: 'specific',
renderName: forceRender,
})
mainPageRenderer = renderer
articlesRenderer = renderer
} else {
mainPageRenderer = await rendererBuilder.createRenderer({ renderType: 'desktop' })
articlesRenderer = await rendererBuilder.createRenderer({
renderType: hasWikimediaMobileApi ? 'mobile' : 'auto',
})
}
downloader.setUrlsDirectors(mainPageRenderer, articlesRenderer)
if (dump.customProcessor?.shouldKeepArticle) {
await getAllArticlesToKeep(downloader, articleDetailXId, dump, mainPageRenderer, articlesRenderer)
}
const stages = ['Download Article', 'Get module dependencies', 'Parse and Save to ZIM', 'Await left-over promises']
const timeout = Math.max(downloader.requestTimeout * 2, 10 * 60 * 1000)
await articleDetailXId.iterateItems(downloader.speed, (articleKeyValuePairs, workerId) => {
return new Promise(async (resolve, reject) => {
/*
* timer to detect freezes
*/
let curStage = 0
let curArticle = ''
const timer = new Timer(() => {
const errorMessage = `Worker timed out at ${stages[curStage]} ${curArticle}`
logger.error(errorMessage)
reject(new Error(errorMessage))
}, timeout)
logger.info(`Worker [${workerId}] processing batch of article ids [${logger.logifyArray(Object.keys(articleKeyValuePairs))}]`)
const parsePromiseQueue: [string, Promise<Error>][] = []
for (const [articleId, articleDetail] of Object.entries(articleKeyValuePairs)) {
timer.reset()
curStage = 0
curArticle = articleId
const promises: [string, Promise<Error>][] = []
const _moduleDependencies = await downloader.getModuleDependencies(articleDetail.title)
let rets: any
try {
const isMainPage = dump.isMainPage(articleId)
const renderer = isMainPage ? mainPageRenderer : articlesRenderer
const articleUrl = isMainPage ? downloader.getMainPageUrl(articleId) : downloader.getArticleUrl(articleId)
rets = await downloader.getArticle(downloader.webp, _moduleDependencies, articleId, articleDetailXId, renderer, articleUrl, dump, articleDetail, isMainPage)
for (const { articleId, displayTitle: articleTitle, html: finalHTML, mediaDependencies, moduleDependencies, staticFiles, subtitles } of rets) {
if (!finalHTML) {
logger.warn(`No HTML returned for article [${articleId}], skipping`)
continue
}
curStage += 1
for (const dep of moduleDependencies.jsDependenciesList) {
jsModuleDependencies.add(dep)
}
for (const dep of moduleDependencies.styleDependenciesList) {
cssModuleDependencies.add(dep)
}
for (const file of staticFiles) {
staticFilesList.add(file)
}
jsConfigVars = moduleDependencies.jsConfigVars || ''
/*
* getModuleDependencies and downloader.getArticle are
* network heavy while parsing and saving is I/O.
* To parse and download simultaniously, we don't await on save,
* but instead cache the promise in a queue and check it later
*/
promises.push([articleId, saveArticle(zimCreator, finalHTML, mediaDependencies, subtitles, articleId, articleTitle, articleDetail)])
}
} catch (err) {
dump.status.articles.fail += 1
logger.error(`Error downloading article ${articleId}`)
if ((!err.response || err.response.status !== 404) && err.message !== DELETED_ARTICLE_ERROR) {
reject(cleanupAxiosError(err))
return
}
}
if (parsePromiseQueue.length) {
curStage += 1
const [articleId, parsePromise] = parsePromiseQueue.shift()
curArticle = articleId
/*
* in normal circumstances, where downloading is slower than
* saving, this promise will always be resolved here already
*/
const err = await parsePromise
if (err) {
console.log(err)
logger.error(`Error parsing article ${articleId}`)
timer.clear()
reject(err)
return
}
dump.status.articles.success += 1
}
if (promises.length) {
parsePromiseQueue.push(flattenPromises(promises))
}
if ((dump.status.articles.success + dump.status.articles.fail) % 10 === 0) {
const percentProgress = (((dump.status.articles.success + dump.status.articles.fail) / articlesTotal) * 100).toFixed(1)
if (percentProgress !== prevPercentProgress) {
prevPercentProgress = percentProgress
logger.log(`Progress downloading articles [${dump.status.articles.success + dump.status.articles.fail}/${articlesTotal}] [${percentProgress}%]`)
}
}
}
/*
* clear up potentially still pending promises
*/
curStage += 1
if (parsePromiseQueue.length) {
const [articleId, parsePromise] = flattenPromises(parsePromiseQueue)
curArticle = articleId
const err = await parsePromise
if (err) {
timer.clear()
reject(err)
return
}
dump.status.articles.success += parsePromiseQueue.length
}
timer.clear()
resolve()
})
})
logger.log(`Done with downloading a total of [${articlesTotal}] articles`)
if (jsConfigVars) {
const jsConfigVarArticle = new ZimArticle({ url: jsPath('jsConfigVars', config.output.dirs.mediawiki), data: jsConfigVars, ns: '-' })
zimCreator.addArticle(jsConfigVarArticle)
}
return {
staticFilesList,
jsModuleDependencies,
cssModuleDependencies,
}
}